babylon.module.d.ts 5.7 MB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841178421784317844178451784617847178481784917850178511785217853178541785517856178571785817859178601786117862178631786417865178661786717868178691787017871178721787317874178751787617877178781787917880178811788217883178841788517886178871788817889178901789117892178931789417895178961789717898178991790017901179021790317904179051790617907179081790917910179111791217913179141791517916179171791817919179201792117922179231792417925179261792717928179291793017931179321793317934179351793617937179381793917940179411794217943179441794517946179471794817949179501795117952179531795417955179561795717958179591796017961179621796317964179651796617967179681796917970179711797217973179741797517976179771797817979179801798117982179831798417985179861798717988179891799017991179921799317994179951799617997179981799918000180011800218003180041800518006180071800818009180101801118012180131801418015180161801718018180191802018021180221802318024180251802618027180281802918030180311803218033180341803518036180371803818039180401804118042180431804418045180461804718048180491805018051180521805318054180551805618057180581805918060180611806218063180641806518066180671806818069180701807118072180731807418075180761807718078180791808018081180821808318084180851808618087180881808918090180911809218093180941809518096180971809818099181001810118102181031810418105181061810718108181091811018111181121811318114181151811618117181181811918120181211812218123181241812518126181271812818129181301813118132181331813418135181361813718138181391814018141181421814318144181451814618147181481814918150181511815218153181541815518156181571815818159181601816118162181631816418165181661816718168181691817018171181721817318174181751817618177181781817918180181811818218183181841818518186181871818818189181901819118192181931819418195181961819718198181991820018201182021820318204182051820618207182081820918210182111821218213182141821518216182171821818219182201822118222182231822418225182261822718228182291823018231182321823318234182351823618237182381823918240182411824218243182441824518246182471824818249182501825118252182531825418255182561825718258182591826018261182621826318264182651826618267182681826918270182711827218273182741827518276182771827818279182801828118282182831828418285182861828718288182891829018291182921829318294182951829618297182981829918300183011830218303183041830518306183071830818309183101831118312183131831418315183161831718318183191832018321183221832318324183251832618327183281832918330183311833218333183341833518336183371833818339183401834118342183431834418345183461834718348183491835018351183521835318354183551835618357183581835918360183611836218363183641836518366183671836818369183701837118372183731837418375183761837718378183791838018381183821838318384183851838618387183881838918390183911839218393183941839518396183971839818399184001840118402184031840418405184061840718408184091841018411184121841318414184151841618417184181841918420184211842218423184241842518426184271842818429184301843118432184331843418435184361843718438184391844018441184421844318444184451844618447184481844918450184511845218453184541845518456184571845818459184601846118462184631846418465184661846718468184691847018471184721847318474184751847618477184781847918480184811848218483184841848518486184871848818489184901849118492184931849418495184961849718498184991850018501185021850318504185051850618507185081850918510185111851218513185141851518516185171851818519185201852118522185231852418525185261852718528185291853018531185321853318534185351853618537185381853918540185411854218543185441854518546185471854818549185501855118552185531855418555185561855718558185591856018561185621856318564185651856618567185681856918570185711857218573185741857518576185771857818579185801858118582185831858418585185861858718588185891859018591185921859318594185951859618597185981859918600186011860218603186041860518606186071860818609186101861118612186131861418615186161861718618186191862018621186221862318624186251862618627186281862918630186311863218633186341863518636186371863818639186401864118642186431864418645186461864718648186491865018651186521865318654186551865618657186581865918660186611866218663186641866518666186671866818669186701867118672186731867418675186761867718678186791868018681186821868318684186851868618687186881868918690186911869218693186941869518696186971869818699187001870118702187031870418705187061870718708187091871018711187121871318714187151871618717187181871918720187211872218723187241872518726187271872818729187301873118732187331873418735187361873718738187391874018741187421874318744187451874618747187481874918750187511875218753187541875518756187571875818759187601876118762187631876418765187661876718768187691877018771187721877318774187751877618777187781877918780187811878218783187841878518786187871878818789187901879118792187931879418795187961879718798187991880018801188021880318804188051880618807188081880918810188111881218813188141881518816188171881818819188201882118822188231882418825188261882718828188291883018831188321883318834188351883618837188381883918840188411884218843188441884518846188471884818849188501885118852188531885418855188561885718858188591886018861188621886318864188651886618867188681886918870188711887218873188741887518876188771887818879188801888118882188831888418885188861888718888188891889018891188921889318894188951889618897188981889918900189011890218903189041890518906189071890818909189101891118912189131891418915189161891718918189191892018921189221892318924189251892618927189281892918930189311893218933189341893518936189371893818939189401894118942189431894418945189461894718948189491895018951189521895318954189551895618957189581895918960189611896218963189641896518966189671896818969189701897118972189731897418975189761897718978189791898018981189821898318984189851898618987189881898918990189911899218993189941899518996189971899818999190001900119002190031900419005190061900719008190091901019011190121901319014190151901619017190181901919020190211902219023190241902519026190271902819029190301903119032190331903419035190361903719038190391904019041190421904319044190451904619047190481904919050190511905219053190541905519056190571905819059190601906119062190631906419065190661906719068190691907019071190721907319074190751907619077190781907919080190811908219083190841908519086190871908819089190901909119092190931909419095190961909719098190991910019101191021910319104191051910619107191081910919110191111911219113191141911519116191171911819119191201912119122191231912419125191261912719128191291913019131191321913319134191351913619137191381913919140191411914219143191441914519146191471914819149191501915119152191531915419155191561915719158191591916019161191621916319164191651916619167191681916919170191711917219173191741917519176191771917819179191801918119182191831918419185191861918719188191891919019191191921919319194191951919619197191981919919200192011920219203192041920519206192071920819209192101921119212192131921419215192161921719218192191922019221192221922319224192251922619227192281922919230192311923219233192341923519236192371923819239192401924119242192431924419245192461924719248192491925019251192521925319254192551925619257192581925919260192611926219263192641926519266192671926819269192701927119272192731927419275192761927719278192791928019281192821928319284192851928619287192881928919290192911929219293192941929519296192971929819299193001930119302193031930419305193061930719308193091931019311193121931319314193151931619317193181931919320193211932219323193241932519326193271932819329193301933119332193331933419335193361933719338193391934019341193421934319344193451934619347193481934919350193511935219353193541935519356193571935819359193601936119362193631936419365193661936719368193691937019371193721937319374193751937619377193781937919380193811938219383193841938519386193871938819389193901939119392193931939419395193961939719398193991940019401194021940319404194051940619407194081940919410194111941219413194141941519416194171941819419194201942119422194231942419425194261942719428194291943019431194321943319434194351943619437194381943919440194411944219443194441944519446194471944819449194501945119452194531945419455194561945719458194591946019461194621946319464194651946619467194681946919470194711947219473194741947519476194771947819479194801948119482194831948419485194861948719488194891949019491194921949319494194951949619497194981949919500195011950219503195041950519506195071950819509195101951119512195131951419515195161951719518195191952019521195221952319524195251952619527195281952919530195311953219533195341953519536195371953819539195401954119542195431954419545195461954719548195491955019551195521955319554195551955619557195581955919560195611956219563195641956519566195671956819569195701957119572195731957419575195761957719578195791958019581195821958319584195851958619587195881958919590195911959219593195941959519596195971959819599196001960119602196031960419605196061960719608196091961019611196121961319614196151961619617196181961919620196211962219623196241962519626196271962819629196301963119632196331963419635196361963719638196391964019641196421964319644196451964619647196481964919650196511965219653196541965519656196571965819659196601966119662196631966419665196661966719668196691967019671196721967319674196751967619677196781967919680196811968219683196841968519686196871968819689196901969119692196931969419695196961969719698196991970019701197021970319704197051970619707197081970919710197111971219713197141971519716197171971819719197201972119722197231972419725197261972719728197291973019731197321973319734197351973619737197381973919740197411974219743197441974519746197471974819749197501975119752197531975419755197561975719758197591976019761197621976319764197651976619767197681976919770197711977219773197741977519776197771977819779197801978119782197831978419785197861978719788197891979019791197921979319794197951979619797197981979919800198011980219803198041980519806198071980819809198101981119812198131981419815198161981719818198191982019821198221982319824198251982619827198281982919830198311983219833198341983519836198371983819839198401984119842198431984419845198461984719848198491985019851198521985319854198551985619857198581985919860198611986219863198641986519866198671986819869198701987119872198731987419875198761987719878198791988019881198821988319884198851988619887198881988919890198911989219893198941989519896198971989819899199001990119902199031990419905199061990719908199091991019911199121991319914199151991619917199181991919920199211992219923199241992519926199271992819929199301993119932199331993419935199361993719938199391994019941199421994319944199451994619947199481994919950199511995219953199541995519956199571995819959199601996119962199631996419965199661996719968199691997019971199721997319974199751997619977199781997919980199811998219983199841998519986199871998819989199901999119992199931999419995199961999719998199992000020001200022000320004200052000620007200082000920010200112001220013200142001520016200172001820019200202002120022200232002420025200262002720028200292003020031200322003320034200352003620037200382003920040200412004220043200442004520046200472004820049200502005120052200532005420055200562005720058200592006020061200622006320064200652006620067200682006920070200712007220073200742007520076200772007820079200802008120082200832008420085200862008720088200892009020091200922009320094200952009620097200982009920100201012010220103201042010520106201072010820109201102011120112201132011420115201162011720118201192012020121201222012320124201252012620127201282012920130201312013220133201342013520136201372013820139201402014120142201432014420145201462014720148201492015020151201522015320154201552015620157201582015920160201612016220163201642016520166201672016820169201702017120172201732017420175201762017720178201792018020181201822018320184201852018620187201882018920190201912019220193201942019520196201972019820199202002020120202202032020420205202062020720208202092021020211202122021320214202152021620217202182021920220202212022220223202242022520226202272022820229202302023120232202332023420235202362023720238202392024020241202422024320244202452024620247202482024920250202512025220253202542025520256202572025820259202602026120262202632026420265202662026720268202692027020271202722027320274202752027620277202782027920280202812028220283202842028520286202872028820289202902029120292202932029420295202962029720298202992030020301203022030320304203052030620307203082030920310203112031220313203142031520316203172031820319203202032120322203232032420325203262032720328203292033020331203322033320334203352033620337203382033920340203412034220343203442034520346203472034820349203502035120352203532035420355203562035720358203592036020361203622036320364203652036620367203682036920370203712037220373203742037520376203772037820379203802038120382203832038420385203862038720388203892039020391203922039320394203952039620397203982039920400204012040220403204042040520406204072040820409204102041120412204132041420415204162041720418204192042020421204222042320424204252042620427204282042920430204312043220433204342043520436204372043820439204402044120442204432044420445204462044720448204492045020451204522045320454204552045620457204582045920460204612046220463204642046520466204672046820469204702047120472204732047420475204762047720478204792048020481204822048320484204852048620487204882048920490204912049220493204942049520496204972049820499205002050120502205032050420505205062050720508205092051020511205122051320514205152051620517205182051920520205212052220523205242052520526205272052820529205302053120532205332053420535205362053720538205392054020541205422054320544205452054620547205482054920550205512055220553205542055520556205572055820559205602056120562205632056420565205662056720568205692057020571205722057320574205752057620577205782057920580205812058220583205842058520586205872058820589205902059120592205932059420595205962059720598205992060020601206022060320604206052060620607206082060920610206112061220613206142061520616206172061820619206202062120622206232062420625206262062720628206292063020631206322063320634206352063620637206382063920640206412064220643206442064520646206472064820649206502065120652206532065420655206562065720658206592066020661206622066320664206652066620667206682066920670206712067220673206742067520676206772067820679206802068120682206832068420685206862068720688206892069020691206922069320694206952069620697206982069920700207012070220703207042070520706207072070820709207102071120712207132071420715207162071720718207192072020721207222072320724207252072620727207282072920730207312073220733207342073520736207372073820739207402074120742207432074420745207462074720748207492075020751207522075320754207552075620757207582075920760207612076220763207642076520766207672076820769207702077120772207732077420775207762077720778207792078020781207822078320784207852078620787207882078920790207912079220793207942079520796207972079820799208002080120802208032080420805208062080720808208092081020811208122081320814208152081620817208182081920820208212082220823208242082520826208272082820829208302083120832208332083420835208362083720838208392084020841208422084320844208452084620847208482084920850208512085220853208542085520856208572085820859208602086120862208632086420865208662086720868208692087020871208722087320874208752087620877208782087920880208812088220883208842088520886208872088820889208902089120892208932089420895208962089720898208992090020901209022090320904209052090620907209082090920910209112091220913209142091520916209172091820919209202092120922209232092420925209262092720928209292093020931209322093320934209352093620937209382093920940209412094220943209442094520946209472094820949209502095120952209532095420955209562095720958209592096020961209622096320964209652096620967209682096920970209712097220973209742097520976209772097820979209802098120982209832098420985209862098720988209892099020991209922099320994209952099620997209982099921000210012100221003210042100521006210072100821009210102101121012210132101421015210162101721018210192102021021210222102321024210252102621027210282102921030210312103221033210342103521036210372103821039210402104121042210432104421045210462104721048210492105021051210522105321054210552105621057210582105921060210612106221063210642106521066210672106821069210702107121072210732107421075210762107721078210792108021081210822108321084210852108621087210882108921090210912109221093210942109521096210972109821099211002110121102211032110421105211062110721108211092111021111211122111321114211152111621117211182111921120211212112221123211242112521126211272112821129211302113121132211332113421135211362113721138211392114021141211422114321144211452114621147211482114921150211512115221153211542115521156211572115821159211602116121162211632116421165211662116721168211692117021171211722117321174211752117621177211782117921180211812118221183211842118521186211872118821189211902119121192211932119421195211962119721198211992120021201212022120321204212052120621207212082120921210212112121221213212142121521216212172121821219212202122121222212232122421225212262122721228212292123021231212322123321234212352123621237212382123921240212412124221243212442124521246212472124821249212502125121252212532125421255212562125721258212592126021261212622126321264212652126621267212682126921270212712127221273212742127521276212772127821279212802128121282212832128421285212862128721288212892129021291212922129321294212952129621297212982129921300213012130221303213042130521306213072130821309213102131121312213132131421315213162131721318213192132021321213222132321324213252132621327213282132921330213312133221333213342133521336213372133821339213402134121342213432134421345213462134721348213492135021351213522135321354213552135621357213582135921360213612136221363213642136521366213672136821369213702137121372213732137421375213762137721378213792138021381213822138321384213852138621387213882138921390213912139221393213942139521396213972139821399214002140121402214032140421405214062140721408214092141021411214122141321414214152141621417214182141921420214212142221423214242142521426214272142821429214302143121432214332143421435214362143721438214392144021441214422144321444214452144621447214482144921450214512145221453214542145521456214572145821459214602146121462214632146421465214662146721468214692147021471214722147321474214752147621477214782147921480214812148221483214842148521486214872148821489214902149121492214932149421495214962149721498214992150021501215022150321504215052150621507215082150921510215112151221513215142151521516215172151821519215202152121522215232152421525215262152721528215292153021531215322153321534215352153621537215382153921540215412154221543215442154521546215472154821549215502155121552215532155421555215562155721558215592156021561215622156321564215652156621567215682156921570215712157221573215742157521576215772157821579215802158121582215832158421585215862158721588215892159021591215922159321594215952159621597215982159921600216012160221603216042160521606216072160821609216102161121612216132161421615216162161721618216192162021621216222162321624216252162621627216282162921630216312163221633216342163521636216372163821639216402164121642216432164421645216462164721648216492165021651216522165321654216552165621657216582165921660216612166221663216642166521666216672166821669216702167121672216732167421675216762167721678216792168021681216822168321684216852168621687216882168921690216912169221693216942169521696216972169821699217002170121702217032170421705217062170721708217092171021711217122171321714217152171621717217182171921720217212172221723217242172521726217272172821729217302173121732217332173421735217362173721738217392174021741217422174321744217452174621747217482174921750217512175221753217542175521756217572175821759217602176121762217632176421765217662176721768217692177021771217722177321774217752177621777217782177921780217812178221783217842178521786217872178821789217902179121792217932179421795217962179721798217992180021801218022180321804218052180621807218082180921810218112181221813218142181521816218172181821819218202182121822218232182421825218262182721828218292183021831218322183321834218352183621837218382183921840218412184221843218442184521846218472184821849218502185121852218532185421855218562185721858218592186021861218622186321864218652186621867218682186921870218712187221873218742187521876218772187821879218802188121882218832188421885218862188721888218892189021891218922189321894218952189621897218982189921900219012190221903219042190521906219072190821909219102191121912219132191421915219162191721918219192192021921219222192321924219252192621927219282192921930219312193221933219342193521936219372193821939219402194121942219432194421945219462194721948219492195021951219522195321954219552195621957219582195921960219612196221963219642196521966219672196821969219702197121972219732197421975219762197721978219792198021981219822198321984219852198621987219882198921990219912199221993219942199521996219972199821999220002200122002220032200422005220062200722008220092201022011220122201322014220152201622017220182201922020220212202222023220242202522026220272202822029220302203122032220332203422035220362203722038220392204022041220422204322044220452204622047220482204922050220512205222053220542205522056220572205822059220602206122062220632206422065220662206722068220692207022071220722207322074220752207622077220782207922080220812208222083220842208522086220872208822089220902209122092220932209422095220962209722098220992210022101221022210322104221052210622107221082210922110221112211222113221142211522116221172211822119221202212122122221232212422125221262212722128221292213022131221322213322134221352213622137221382213922140221412214222143221442214522146221472214822149221502215122152221532215422155221562215722158221592216022161221622216322164221652216622167221682216922170221712217222173221742217522176221772217822179221802218122182221832218422185221862218722188221892219022191221922219322194221952219622197221982219922200222012220222203222042220522206222072220822209222102221122212222132221422215222162221722218222192222022221222222222322224222252222622227222282222922230222312223222233222342223522236222372223822239222402224122242222432224422245222462224722248222492225022251222522225322254222552225622257222582225922260222612226222263222642226522266222672226822269222702227122272222732227422275222762227722278222792228022281222822228322284222852228622287222882228922290222912229222293222942229522296222972229822299223002230122302223032230422305223062230722308223092231022311223122231322314223152231622317223182231922320223212232222323223242232522326223272232822329223302233122332223332233422335223362233722338223392234022341223422234322344223452234622347223482234922350223512235222353223542235522356223572235822359223602236122362223632236422365223662236722368223692237022371223722237322374223752237622377223782237922380223812238222383223842238522386223872238822389223902239122392223932239422395223962239722398223992240022401224022240322404224052240622407224082240922410224112241222413224142241522416224172241822419224202242122422224232242422425224262242722428224292243022431224322243322434224352243622437224382243922440224412244222443224442244522446224472244822449224502245122452224532245422455224562245722458224592246022461224622246322464224652246622467224682246922470224712247222473224742247522476224772247822479224802248122482224832248422485224862248722488224892249022491224922249322494224952249622497224982249922500225012250222503225042250522506225072250822509225102251122512225132251422515225162251722518225192252022521225222252322524225252252622527225282252922530225312253222533225342253522536225372253822539225402254122542225432254422545225462254722548225492255022551225522255322554225552255622557225582255922560225612256222563225642256522566225672256822569225702257122572225732257422575225762257722578225792258022581225822258322584225852258622587225882258922590225912259222593225942259522596225972259822599226002260122602226032260422605226062260722608226092261022611226122261322614226152261622617226182261922620226212262222623226242262522626226272262822629226302263122632226332263422635226362263722638226392264022641226422264322644226452264622647226482264922650226512265222653226542265522656226572265822659226602266122662226632266422665226662266722668226692267022671226722267322674226752267622677226782267922680226812268222683226842268522686226872268822689226902269122692226932269422695226962269722698226992270022701227022270322704227052270622707227082270922710227112271222713227142271522716227172271822719227202272122722227232272422725227262272722728227292273022731227322273322734227352273622737227382273922740227412274222743227442274522746227472274822749227502275122752227532275422755227562275722758227592276022761227622276322764227652276622767227682276922770227712277222773227742277522776227772277822779227802278122782227832278422785227862278722788227892279022791227922279322794227952279622797227982279922800228012280222803228042280522806228072280822809228102281122812228132281422815228162281722818228192282022821228222282322824228252282622827228282282922830228312283222833228342283522836228372283822839228402284122842228432284422845228462284722848228492285022851228522285322854228552285622857228582285922860228612286222863228642286522866228672286822869228702287122872228732287422875228762287722878228792288022881228822288322884228852288622887228882288922890228912289222893228942289522896228972289822899229002290122902229032290422905229062290722908229092291022911229122291322914229152291622917229182291922920229212292222923229242292522926229272292822929229302293122932229332293422935229362293722938229392294022941229422294322944229452294622947229482294922950229512295222953229542295522956229572295822959229602296122962229632296422965229662296722968229692297022971229722297322974229752297622977229782297922980229812298222983229842298522986229872298822989229902299122992229932299422995229962299722998229992300023001230022300323004230052300623007230082300923010230112301223013230142301523016230172301823019230202302123022230232302423025230262302723028230292303023031230322303323034230352303623037230382303923040230412304223043230442304523046230472304823049230502305123052230532305423055230562305723058230592306023061230622306323064230652306623067230682306923070230712307223073230742307523076230772307823079230802308123082230832308423085230862308723088230892309023091230922309323094230952309623097230982309923100231012310223103231042310523106231072310823109231102311123112231132311423115231162311723118231192312023121231222312323124231252312623127231282312923130231312313223133231342313523136231372313823139231402314123142231432314423145231462314723148231492315023151231522315323154231552315623157231582315923160231612316223163231642316523166231672316823169231702317123172231732317423175231762317723178231792318023181231822318323184231852318623187231882318923190231912319223193231942319523196231972319823199232002320123202232032320423205232062320723208232092321023211232122321323214232152321623217232182321923220232212322223223232242322523226232272322823229232302323123232232332323423235232362323723238232392324023241232422324323244232452324623247232482324923250232512325223253232542325523256232572325823259232602326123262232632326423265232662326723268232692327023271232722327323274232752327623277232782327923280232812328223283232842328523286232872328823289232902329123292232932329423295232962329723298232992330023301233022330323304233052330623307233082330923310233112331223313233142331523316233172331823319233202332123322233232332423325233262332723328233292333023331233322333323334233352333623337233382333923340233412334223343233442334523346233472334823349233502335123352233532335423355233562335723358233592336023361233622336323364233652336623367233682336923370233712337223373233742337523376233772337823379233802338123382233832338423385233862338723388233892339023391233922339323394233952339623397233982339923400234012340223403234042340523406234072340823409234102341123412234132341423415234162341723418234192342023421234222342323424234252342623427234282342923430234312343223433234342343523436234372343823439234402344123442234432344423445234462344723448234492345023451234522345323454234552345623457234582345923460234612346223463234642346523466234672346823469234702347123472234732347423475234762347723478234792348023481234822348323484234852348623487234882348923490234912349223493234942349523496234972349823499235002350123502235032350423505235062350723508235092351023511235122351323514235152351623517235182351923520235212352223523235242352523526235272352823529235302353123532235332353423535235362353723538235392354023541235422354323544235452354623547235482354923550235512355223553235542355523556235572355823559235602356123562235632356423565235662356723568235692357023571235722357323574235752357623577235782357923580235812358223583235842358523586235872358823589235902359123592235932359423595235962359723598235992360023601236022360323604236052360623607236082360923610236112361223613236142361523616236172361823619236202362123622236232362423625236262362723628236292363023631236322363323634236352363623637236382363923640236412364223643236442364523646236472364823649236502365123652236532365423655236562365723658236592366023661236622366323664236652366623667236682366923670236712367223673236742367523676236772367823679236802368123682236832368423685236862368723688236892369023691236922369323694236952369623697236982369923700237012370223703237042370523706237072370823709237102371123712237132371423715237162371723718237192372023721237222372323724237252372623727237282372923730237312373223733237342373523736237372373823739237402374123742237432374423745237462374723748237492375023751237522375323754237552375623757237582375923760237612376223763237642376523766237672376823769237702377123772237732377423775237762377723778237792378023781237822378323784237852378623787237882378923790237912379223793237942379523796237972379823799238002380123802238032380423805238062380723808238092381023811238122381323814238152381623817238182381923820238212382223823238242382523826238272382823829238302383123832238332383423835238362383723838238392384023841238422384323844238452384623847238482384923850238512385223853238542385523856238572385823859238602386123862238632386423865238662386723868238692387023871238722387323874238752387623877238782387923880238812388223883238842388523886238872388823889238902389123892238932389423895238962389723898238992390023901239022390323904239052390623907239082390923910239112391223913239142391523916239172391823919239202392123922239232392423925239262392723928239292393023931239322393323934239352393623937239382393923940239412394223943239442394523946239472394823949239502395123952239532395423955239562395723958239592396023961239622396323964239652396623967239682396923970239712397223973239742397523976239772397823979239802398123982239832398423985239862398723988239892399023991239922399323994239952399623997239982399924000240012400224003240042400524006240072400824009240102401124012240132401424015240162401724018240192402024021240222402324024240252402624027240282402924030240312403224033240342403524036240372403824039240402404124042240432404424045240462404724048240492405024051240522405324054240552405624057240582405924060240612406224063240642406524066240672406824069240702407124072240732407424075240762407724078240792408024081240822408324084240852408624087240882408924090240912409224093240942409524096240972409824099241002410124102241032410424105241062410724108241092411024111241122411324114241152411624117241182411924120241212412224123241242412524126241272412824129241302413124132241332413424135241362413724138241392414024141241422414324144241452414624147241482414924150241512415224153241542415524156241572415824159241602416124162241632416424165241662416724168241692417024171241722417324174241752417624177241782417924180241812418224183241842418524186241872418824189241902419124192241932419424195241962419724198241992420024201242022420324204242052420624207242082420924210242112421224213242142421524216242172421824219242202422124222242232422424225242262422724228242292423024231242322423324234242352423624237242382423924240242412424224243242442424524246242472424824249242502425124252242532425424255242562425724258242592426024261242622426324264242652426624267242682426924270242712427224273242742427524276242772427824279242802428124282242832428424285242862428724288242892429024291242922429324294242952429624297242982429924300243012430224303243042430524306243072430824309243102431124312243132431424315243162431724318243192432024321243222432324324243252432624327243282432924330243312433224333243342433524336243372433824339243402434124342243432434424345243462434724348243492435024351243522435324354243552435624357243582435924360243612436224363243642436524366243672436824369243702437124372243732437424375243762437724378243792438024381243822438324384243852438624387243882438924390243912439224393243942439524396243972439824399244002440124402244032440424405244062440724408244092441024411244122441324414244152441624417244182441924420244212442224423244242442524426244272442824429244302443124432244332443424435244362443724438244392444024441244422444324444244452444624447244482444924450244512445224453244542445524456244572445824459244602446124462244632446424465244662446724468244692447024471244722447324474244752447624477244782447924480244812448224483244842448524486244872448824489244902449124492244932449424495244962449724498244992450024501245022450324504245052450624507245082450924510245112451224513245142451524516245172451824519245202452124522245232452424525245262452724528245292453024531245322453324534245352453624537245382453924540245412454224543245442454524546245472454824549245502455124552245532455424555245562455724558245592456024561245622456324564245652456624567245682456924570245712457224573245742457524576245772457824579245802458124582245832458424585245862458724588245892459024591245922459324594245952459624597245982459924600246012460224603246042460524606246072460824609246102461124612246132461424615246162461724618246192462024621246222462324624246252462624627246282462924630246312463224633246342463524636246372463824639246402464124642246432464424645246462464724648246492465024651246522465324654246552465624657246582465924660246612466224663246642466524666246672466824669246702467124672246732467424675246762467724678246792468024681246822468324684246852468624687246882468924690246912469224693246942469524696246972469824699247002470124702247032470424705247062470724708247092471024711247122471324714247152471624717247182471924720247212472224723247242472524726247272472824729247302473124732247332473424735247362473724738247392474024741247422474324744247452474624747247482474924750247512475224753247542475524756247572475824759247602476124762247632476424765247662476724768247692477024771247722477324774247752477624777247782477924780247812478224783247842478524786247872478824789247902479124792247932479424795247962479724798247992480024801248022480324804248052480624807248082480924810248112481224813248142481524816248172481824819248202482124822248232482424825248262482724828248292483024831248322483324834248352483624837248382483924840248412484224843248442484524846248472484824849248502485124852248532485424855248562485724858248592486024861248622486324864248652486624867248682486924870248712487224873248742487524876248772487824879248802488124882248832488424885248862488724888248892489024891248922489324894248952489624897248982489924900249012490224903249042490524906249072490824909249102491124912249132491424915249162491724918249192492024921249222492324924249252492624927249282492924930249312493224933249342493524936249372493824939249402494124942249432494424945249462494724948249492495024951249522495324954249552495624957249582495924960249612496224963249642496524966249672496824969249702497124972249732497424975249762497724978249792498024981249822498324984249852498624987249882498924990249912499224993249942499524996249972499824999250002500125002250032500425005250062500725008250092501025011250122501325014250152501625017250182501925020250212502225023250242502525026250272502825029250302503125032250332503425035250362503725038250392504025041250422504325044250452504625047250482504925050250512505225053250542505525056250572505825059250602506125062250632506425065250662506725068250692507025071250722507325074250752507625077250782507925080250812508225083250842508525086250872508825089250902509125092250932509425095250962509725098250992510025101251022510325104251052510625107251082510925110251112511225113251142511525116251172511825119251202512125122251232512425125251262512725128251292513025131251322513325134251352513625137251382513925140251412514225143251442514525146251472514825149251502515125152251532515425155251562515725158251592516025161251622516325164251652516625167251682516925170251712517225173251742517525176251772517825179251802518125182251832518425185251862518725188251892519025191251922519325194251952519625197251982519925200252012520225203252042520525206252072520825209252102521125212252132521425215252162521725218252192522025221252222522325224252252522625227252282522925230252312523225233252342523525236252372523825239252402524125242252432524425245252462524725248252492525025251252522525325254252552525625257252582525925260252612526225263252642526525266252672526825269252702527125272252732527425275252762527725278252792528025281252822528325284252852528625287252882528925290252912529225293252942529525296252972529825299253002530125302253032530425305253062530725308253092531025311253122531325314253152531625317253182531925320253212532225323253242532525326253272532825329253302533125332253332533425335253362533725338253392534025341253422534325344253452534625347253482534925350253512535225353253542535525356253572535825359253602536125362253632536425365253662536725368253692537025371253722537325374253752537625377253782537925380253812538225383253842538525386253872538825389253902539125392253932539425395253962539725398253992540025401254022540325404254052540625407254082540925410254112541225413254142541525416254172541825419254202542125422254232542425425254262542725428254292543025431254322543325434254352543625437254382543925440254412544225443254442544525446254472544825449254502545125452254532545425455254562545725458254592546025461254622546325464254652546625467254682546925470254712547225473254742547525476254772547825479254802548125482254832548425485254862548725488254892549025491254922549325494254952549625497254982549925500255012550225503255042550525506255072550825509255102551125512255132551425515255162551725518255192552025521255222552325524255252552625527255282552925530255312553225533255342553525536255372553825539255402554125542255432554425545255462554725548255492555025551255522555325554255552555625557255582555925560255612556225563255642556525566255672556825569255702557125572255732557425575255762557725578255792558025581255822558325584255852558625587255882558925590255912559225593255942559525596255972559825599256002560125602256032560425605256062560725608256092561025611256122561325614256152561625617256182561925620256212562225623256242562525626256272562825629256302563125632256332563425635256362563725638256392564025641256422564325644256452564625647256482564925650256512565225653256542565525656256572565825659256602566125662256632566425665256662566725668256692567025671256722567325674256752567625677256782567925680256812568225683256842568525686256872568825689256902569125692256932569425695256962569725698256992570025701257022570325704257052570625707257082570925710257112571225713257142571525716257172571825719257202572125722257232572425725257262572725728257292573025731257322573325734257352573625737257382573925740257412574225743257442574525746257472574825749257502575125752257532575425755257562575725758257592576025761257622576325764257652576625767257682576925770257712577225773257742577525776257772577825779257802578125782257832578425785257862578725788257892579025791257922579325794257952579625797257982579925800258012580225803258042580525806258072580825809258102581125812258132581425815258162581725818258192582025821258222582325824258252582625827258282582925830258312583225833258342583525836258372583825839258402584125842258432584425845258462584725848258492585025851258522585325854258552585625857258582585925860258612586225863258642586525866258672586825869258702587125872258732587425875258762587725878258792588025881258822588325884258852588625887258882588925890258912589225893258942589525896258972589825899259002590125902259032590425905259062590725908259092591025911259122591325914259152591625917259182591925920259212592225923259242592525926259272592825929259302593125932259332593425935259362593725938259392594025941259422594325944259452594625947259482594925950259512595225953259542595525956259572595825959259602596125962259632596425965259662596725968259692597025971259722597325974259752597625977259782597925980259812598225983259842598525986259872598825989259902599125992259932599425995259962599725998259992600026001260022600326004260052600626007260082600926010260112601226013260142601526016260172601826019260202602126022260232602426025260262602726028260292603026031260322603326034260352603626037260382603926040260412604226043260442604526046260472604826049260502605126052260532605426055260562605726058260592606026061260622606326064260652606626067260682606926070260712607226073260742607526076260772607826079260802608126082260832608426085260862608726088260892609026091260922609326094260952609626097260982609926100261012610226103261042610526106261072610826109261102611126112261132611426115261162611726118261192612026121261222612326124261252612626127261282612926130261312613226133261342613526136261372613826139261402614126142261432614426145261462614726148261492615026151261522615326154261552615626157261582615926160261612616226163261642616526166261672616826169261702617126172261732617426175261762617726178261792618026181261822618326184261852618626187261882618926190261912619226193261942619526196261972619826199262002620126202262032620426205262062620726208262092621026211262122621326214262152621626217262182621926220262212622226223262242622526226262272622826229262302623126232262332623426235262362623726238262392624026241262422624326244262452624626247262482624926250262512625226253262542625526256262572625826259262602626126262262632626426265262662626726268262692627026271262722627326274262752627626277262782627926280262812628226283262842628526286262872628826289262902629126292262932629426295262962629726298262992630026301263022630326304263052630626307263082630926310263112631226313263142631526316263172631826319263202632126322263232632426325263262632726328263292633026331263322633326334263352633626337263382633926340263412634226343263442634526346263472634826349263502635126352263532635426355263562635726358263592636026361263622636326364263652636626367263682636926370263712637226373263742637526376263772637826379263802638126382263832638426385263862638726388263892639026391263922639326394263952639626397263982639926400264012640226403264042640526406264072640826409264102641126412264132641426415264162641726418264192642026421264222642326424264252642626427264282642926430264312643226433264342643526436264372643826439264402644126442264432644426445264462644726448264492645026451264522645326454264552645626457264582645926460264612646226463264642646526466264672646826469264702647126472264732647426475264762647726478264792648026481264822648326484264852648626487264882648926490264912649226493264942649526496264972649826499265002650126502265032650426505265062650726508265092651026511265122651326514265152651626517265182651926520265212652226523265242652526526265272652826529265302653126532265332653426535265362653726538265392654026541265422654326544265452654626547265482654926550265512655226553265542655526556265572655826559265602656126562265632656426565265662656726568265692657026571265722657326574265752657626577265782657926580265812658226583265842658526586265872658826589265902659126592265932659426595265962659726598265992660026601266022660326604266052660626607266082660926610266112661226613266142661526616266172661826619266202662126622266232662426625266262662726628266292663026631266322663326634266352663626637266382663926640266412664226643266442664526646266472664826649266502665126652266532665426655266562665726658266592666026661266622666326664266652666626667266682666926670266712667226673266742667526676266772667826679266802668126682266832668426685266862668726688266892669026691266922669326694266952669626697266982669926700267012670226703267042670526706267072670826709267102671126712267132671426715267162671726718267192672026721267222672326724267252672626727267282672926730267312673226733267342673526736267372673826739267402674126742267432674426745267462674726748267492675026751267522675326754267552675626757267582675926760267612676226763267642676526766267672676826769267702677126772267732677426775267762677726778267792678026781267822678326784267852678626787267882678926790267912679226793267942679526796267972679826799268002680126802268032680426805268062680726808268092681026811268122681326814268152681626817268182681926820268212682226823268242682526826268272682826829268302683126832268332683426835268362683726838268392684026841268422684326844268452684626847268482684926850268512685226853268542685526856268572685826859268602686126862268632686426865268662686726868268692687026871268722687326874268752687626877268782687926880268812688226883268842688526886268872688826889268902689126892268932689426895268962689726898268992690026901269022690326904269052690626907269082690926910269112691226913269142691526916269172691826919269202692126922269232692426925269262692726928269292693026931269322693326934269352693626937269382693926940269412694226943269442694526946269472694826949269502695126952269532695426955269562695726958269592696026961269622696326964269652696626967269682696926970269712697226973269742697526976269772697826979269802698126982269832698426985269862698726988269892699026991269922699326994269952699626997269982699927000270012700227003270042700527006270072700827009270102701127012270132701427015270162701727018270192702027021270222702327024270252702627027270282702927030270312703227033270342703527036270372703827039270402704127042270432704427045270462704727048270492705027051270522705327054270552705627057270582705927060270612706227063270642706527066270672706827069270702707127072270732707427075270762707727078270792708027081270822708327084270852708627087270882708927090270912709227093270942709527096270972709827099271002710127102271032710427105271062710727108271092711027111271122711327114271152711627117271182711927120271212712227123271242712527126271272712827129271302713127132271332713427135271362713727138271392714027141271422714327144271452714627147271482714927150271512715227153271542715527156271572715827159271602716127162271632716427165271662716727168271692717027171271722717327174271752717627177271782717927180271812718227183271842718527186271872718827189271902719127192271932719427195271962719727198271992720027201272022720327204272052720627207272082720927210272112721227213272142721527216272172721827219272202722127222272232722427225272262722727228272292723027231272322723327234272352723627237272382723927240272412724227243272442724527246272472724827249272502725127252272532725427255272562725727258272592726027261272622726327264272652726627267272682726927270272712727227273272742727527276272772727827279272802728127282272832728427285272862728727288272892729027291272922729327294272952729627297272982729927300273012730227303273042730527306273072730827309273102731127312273132731427315273162731727318273192732027321273222732327324273252732627327273282732927330273312733227333273342733527336273372733827339273402734127342273432734427345273462734727348273492735027351273522735327354273552735627357273582735927360273612736227363273642736527366273672736827369273702737127372273732737427375273762737727378273792738027381273822738327384273852738627387273882738927390273912739227393273942739527396273972739827399274002740127402274032740427405274062740727408274092741027411274122741327414274152741627417274182741927420274212742227423274242742527426274272742827429274302743127432274332743427435274362743727438274392744027441274422744327444274452744627447274482744927450274512745227453274542745527456274572745827459274602746127462274632746427465274662746727468274692747027471274722747327474274752747627477274782747927480274812748227483274842748527486274872748827489274902749127492274932749427495274962749727498274992750027501275022750327504275052750627507275082750927510275112751227513275142751527516275172751827519275202752127522275232752427525275262752727528275292753027531275322753327534275352753627537275382753927540275412754227543275442754527546275472754827549275502755127552275532755427555275562755727558275592756027561275622756327564275652756627567275682756927570275712757227573275742757527576275772757827579275802758127582275832758427585275862758727588275892759027591275922759327594275952759627597275982759927600276012760227603276042760527606276072760827609276102761127612276132761427615276162761727618276192762027621276222762327624276252762627627276282762927630276312763227633276342763527636276372763827639276402764127642276432764427645276462764727648276492765027651276522765327654276552765627657276582765927660276612766227663276642766527666276672766827669276702767127672276732767427675276762767727678276792768027681276822768327684276852768627687276882768927690276912769227693276942769527696276972769827699277002770127702277032770427705277062770727708277092771027711277122771327714277152771627717277182771927720277212772227723277242772527726277272772827729277302773127732277332773427735277362773727738277392774027741277422774327744277452774627747277482774927750277512775227753277542775527756277572775827759277602776127762277632776427765277662776727768277692777027771277722777327774277752777627777277782777927780277812778227783277842778527786277872778827789277902779127792277932779427795277962779727798277992780027801278022780327804278052780627807278082780927810278112781227813278142781527816278172781827819278202782127822278232782427825278262782727828278292783027831278322783327834278352783627837278382783927840278412784227843278442784527846278472784827849278502785127852278532785427855278562785727858278592786027861278622786327864278652786627867278682786927870278712787227873278742787527876278772787827879278802788127882278832788427885278862788727888278892789027891278922789327894278952789627897278982789927900279012790227903279042790527906279072790827909279102791127912279132791427915279162791727918279192792027921279222792327924279252792627927279282792927930279312793227933279342793527936279372793827939279402794127942279432794427945279462794727948279492795027951279522795327954279552795627957279582795927960279612796227963279642796527966279672796827969279702797127972279732797427975279762797727978279792798027981279822798327984279852798627987279882798927990279912799227993279942799527996279972799827999280002800128002280032800428005280062800728008280092801028011280122801328014280152801628017280182801928020280212802228023280242802528026280272802828029280302803128032280332803428035280362803728038280392804028041280422804328044280452804628047280482804928050280512805228053280542805528056280572805828059280602806128062280632806428065280662806728068280692807028071280722807328074280752807628077280782807928080280812808228083280842808528086280872808828089280902809128092280932809428095280962809728098280992810028101281022810328104281052810628107281082810928110281112811228113281142811528116281172811828119281202812128122281232812428125281262812728128281292813028131281322813328134281352813628137281382813928140281412814228143281442814528146281472814828149281502815128152281532815428155281562815728158281592816028161281622816328164281652816628167281682816928170281712817228173281742817528176281772817828179281802818128182281832818428185281862818728188281892819028191281922819328194281952819628197281982819928200282012820228203282042820528206282072820828209282102821128212282132821428215282162821728218282192822028221282222822328224282252822628227282282822928230282312823228233282342823528236282372823828239282402824128242282432824428245282462824728248282492825028251282522825328254282552825628257282582825928260282612826228263282642826528266282672826828269282702827128272282732827428275282762827728278282792828028281282822828328284282852828628287282882828928290282912829228293282942829528296282972829828299283002830128302283032830428305283062830728308283092831028311283122831328314283152831628317283182831928320283212832228323283242832528326283272832828329283302833128332283332833428335283362833728338283392834028341283422834328344283452834628347283482834928350283512835228353283542835528356283572835828359283602836128362283632836428365283662836728368283692837028371283722837328374283752837628377283782837928380283812838228383283842838528386283872838828389283902839128392283932839428395283962839728398283992840028401284022840328404284052840628407284082840928410284112841228413284142841528416284172841828419284202842128422284232842428425284262842728428284292843028431284322843328434284352843628437284382843928440284412844228443284442844528446284472844828449284502845128452284532845428455284562845728458284592846028461284622846328464284652846628467284682846928470284712847228473284742847528476284772847828479284802848128482284832848428485284862848728488284892849028491284922849328494284952849628497284982849928500285012850228503285042850528506285072850828509285102851128512285132851428515285162851728518285192852028521285222852328524285252852628527285282852928530285312853228533285342853528536285372853828539285402854128542285432854428545285462854728548285492855028551285522855328554285552855628557285582855928560285612856228563285642856528566285672856828569285702857128572285732857428575285762857728578285792858028581285822858328584285852858628587285882858928590285912859228593285942859528596285972859828599286002860128602286032860428605286062860728608286092861028611286122861328614286152861628617286182861928620286212862228623286242862528626286272862828629286302863128632286332863428635286362863728638286392864028641286422864328644286452864628647286482864928650286512865228653286542865528656286572865828659286602866128662286632866428665286662866728668286692867028671286722867328674286752867628677286782867928680286812868228683286842868528686286872868828689286902869128692286932869428695286962869728698286992870028701287022870328704287052870628707287082870928710287112871228713287142871528716287172871828719287202872128722287232872428725287262872728728287292873028731287322873328734287352873628737287382873928740287412874228743287442874528746287472874828749287502875128752287532875428755287562875728758287592876028761287622876328764287652876628767287682876928770287712877228773287742877528776287772877828779287802878128782287832878428785287862878728788287892879028791287922879328794287952879628797287982879928800288012880228803288042880528806288072880828809288102881128812288132881428815288162881728818288192882028821288222882328824288252882628827288282882928830288312883228833288342883528836288372883828839288402884128842288432884428845288462884728848288492885028851288522885328854288552885628857288582885928860288612886228863288642886528866288672886828869288702887128872288732887428875288762887728878288792888028881288822888328884288852888628887288882888928890288912889228893288942889528896288972889828899289002890128902289032890428905289062890728908289092891028911289122891328914289152891628917289182891928920289212892228923289242892528926289272892828929289302893128932289332893428935289362893728938289392894028941289422894328944289452894628947289482894928950289512895228953289542895528956289572895828959289602896128962289632896428965289662896728968289692897028971289722897328974289752897628977289782897928980289812898228983289842898528986289872898828989289902899128992289932899428995289962899728998289992900029001290022900329004290052900629007290082900929010290112901229013290142901529016290172901829019290202902129022290232902429025290262902729028290292903029031290322903329034290352903629037290382903929040290412904229043290442904529046290472904829049290502905129052290532905429055290562905729058290592906029061290622906329064290652906629067290682906929070290712907229073290742907529076290772907829079290802908129082290832908429085290862908729088290892909029091290922909329094290952909629097290982909929100291012910229103291042910529106291072910829109291102911129112291132911429115291162911729118291192912029121291222912329124291252912629127291282912929130291312913229133291342913529136291372913829139291402914129142291432914429145291462914729148291492915029151291522915329154291552915629157291582915929160291612916229163291642916529166291672916829169291702917129172291732917429175291762917729178291792918029181291822918329184291852918629187291882918929190291912919229193291942919529196291972919829199292002920129202292032920429205292062920729208292092921029211292122921329214292152921629217292182921929220292212922229223292242922529226292272922829229292302923129232292332923429235292362923729238292392924029241292422924329244292452924629247292482924929250292512925229253292542925529256292572925829259292602926129262292632926429265292662926729268292692927029271292722927329274292752927629277292782927929280292812928229283292842928529286292872928829289292902929129292292932929429295292962929729298292992930029301293022930329304293052930629307293082930929310293112931229313293142931529316293172931829319293202932129322293232932429325293262932729328293292933029331293322933329334293352933629337293382933929340293412934229343293442934529346293472934829349293502935129352293532935429355293562935729358293592936029361293622936329364293652936629367293682936929370293712937229373293742937529376293772937829379293802938129382293832938429385293862938729388293892939029391293922939329394293952939629397293982939929400294012940229403294042940529406294072940829409294102941129412294132941429415294162941729418294192942029421294222942329424294252942629427294282942929430294312943229433294342943529436294372943829439294402944129442294432944429445294462944729448294492945029451294522945329454294552945629457294582945929460294612946229463294642946529466294672946829469294702947129472294732947429475294762947729478294792948029481294822948329484294852948629487294882948929490294912949229493294942949529496294972949829499295002950129502295032950429505295062950729508295092951029511295122951329514295152951629517295182951929520295212952229523295242952529526295272952829529295302953129532295332953429535295362953729538295392954029541295422954329544295452954629547295482954929550295512955229553295542955529556295572955829559295602956129562295632956429565295662956729568295692957029571295722957329574295752957629577295782957929580295812958229583295842958529586295872958829589295902959129592295932959429595295962959729598295992960029601296022960329604296052960629607296082960929610296112961229613296142961529616296172961829619296202962129622296232962429625296262962729628296292963029631296322963329634296352963629637296382963929640296412964229643296442964529646296472964829649296502965129652296532965429655296562965729658296592966029661296622966329664296652966629667296682966929670296712967229673296742967529676296772967829679296802968129682296832968429685296862968729688296892969029691296922969329694296952969629697296982969929700297012970229703297042970529706297072970829709297102971129712297132971429715297162971729718297192972029721297222972329724297252972629727297282972929730297312973229733297342973529736297372973829739297402974129742297432974429745297462974729748297492975029751297522975329754297552975629757297582975929760297612976229763297642976529766297672976829769297702977129772297732977429775297762977729778297792978029781297822978329784297852978629787297882978929790297912979229793297942979529796297972979829799298002980129802298032980429805298062980729808298092981029811298122981329814298152981629817298182981929820298212982229823298242982529826298272982829829298302983129832298332983429835298362983729838298392984029841298422984329844298452984629847298482984929850298512985229853298542985529856298572985829859298602986129862298632986429865298662986729868298692987029871298722987329874298752987629877298782987929880298812988229883298842988529886298872988829889298902989129892298932989429895298962989729898298992990029901299022990329904299052990629907299082990929910299112991229913299142991529916299172991829919299202992129922299232992429925299262992729928299292993029931299322993329934299352993629937299382993929940299412994229943299442994529946299472994829949299502995129952299532995429955299562995729958299592996029961299622996329964299652996629967299682996929970299712997229973299742997529976299772997829979299802998129982299832998429985299862998729988299892999029991299922999329994299952999629997299982999930000300013000230003300043000530006300073000830009300103001130012300133001430015300163001730018300193002030021300223002330024300253002630027300283002930030300313003230033300343003530036300373003830039300403004130042300433004430045300463004730048300493005030051300523005330054300553005630057300583005930060300613006230063300643006530066300673006830069300703007130072300733007430075300763007730078300793008030081300823008330084300853008630087300883008930090300913009230093300943009530096300973009830099301003010130102301033010430105301063010730108301093011030111301123011330114301153011630117301183011930120301213012230123301243012530126301273012830129301303013130132301333013430135301363013730138301393014030141301423014330144301453014630147301483014930150301513015230153301543015530156301573015830159301603016130162301633016430165301663016730168301693017030171301723017330174301753017630177301783017930180301813018230183301843018530186301873018830189301903019130192301933019430195301963019730198301993020030201302023020330204302053020630207302083020930210302113021230213302143021530216302173021830219302203022130222302233022430225302263022730228302293023030231302323023330234302353023630237302383023930240302413024230243302443024530246302473024830249302503025130252302533025430255302563025730258302593026030261302623026330264302653026630267302683026930270302713027230273302743027530276302773027830279302803028130282302833028430285302863028730288302893029030291302923029330294302953029630297302983029930300303013030230303303043030530306303073030830309303103031130312303133031430315303163031730318303193032030321303223032330324303253032630327303283032930330303313033230333303343033530336303373033830339303403034130342303433034430345303463034730348303493035030351303523035330354303553035630357303583035930360303613036230363303643036530366303673036830369303703037130372303733037430375303763037730378303793038030381303823038330384303853038630387303883038930390303913039230393303943039530396303973039830399304003040130402304033040430405304063040730408304093041030411304123041330414304153041630417304183041930420304213042230423304243042530426304273042830429304303043130432304333043430435304363043730438304393044030441304423044330444304453044630447304483044930450304513045230453304543045530456304573045830459304603046130462304633046430465304663046730468304693047030471304723047330474304753047630477304783047930480304813048230483304843048530486304873048830489304903049130492304933049430495304963049730498304993050030501305023050330504305053050630507305083050930510305113051230513305143051530516305173051830519305203052130522305233052430525305263052730528305293053030531305323053330534305353053630537305383053930540305413054230543305443054530546305473054830549305503055130552305533055430555305563055730558305593056030561305623056330564305653056630567305683056930570305713057230573305743057530576305773057830579305803058130582305833058430585305863058730588305893059030591305923059330594305953059630597305983059930600306013060230603306043060530606306073060830609306103061130612306133061430615306163061730618306193062030621306223062330624306253062630627306283062930630306313063230633306343063530636306373063830639306403064130642306433064430645306463064730648306493065030651306523065330654306553065630657306583065930660306613066230663306643066530666306673066830669306703067130672306733067430675306763067730678306793068030681306823068330684306853068630687306883068930690306913069230693306943069530696306973069830699307003070130702307033070430705307063070730708307093071030711307123071330714307153071630717307183071930720307213072230723307243072530726307273072830729307303073130732307333073430735307363073730738307393074030741307423074330744307453074630747307483074930750307513075230753307543075530756307573075830759307603076130762307633076430765307663076730768307693077030771307723077330774307753077630777307783077930780307813078230783307843078530786307873078830789307903079130792307933079430795307963079730798307993080030801308023080330804308053080630807308083080930810308113081230813308143081530816308173081830819308203082130822308233082430825308263082730828308293083030831308323083330834308353083630837308383083930840308413084230843308443084530846308473084830849308503085130852308533085430855308563085730858308593086030861308623086330864308653086630867308683086930870308713087230873308743087530876308773087830879308803088130882308833088430885308863088730888308893089030891308923089330894308953089630897308983089930900309013090230903309043090530906309073090830909309103091130912309133091430915309163091730918309193092030921309223092330924309253092630927309283092930930309313093230933309343093530936309373093830939309403094130942309433094430945309463094730948309493095030951309523095330954309553095630957309583095930960309613096230963309643096530966309673096830969309703097130972309733097430975309763097730978309793098030981309823098330984309853098630987309883098930990309913099230993309943099530996309973099830999310003100131002310033100431005310063100731008310093101031011310123101331014310153101631017310183101931020310213102231023310243102531026310273102831029310303103131032310333103431035310363103731038310393104031041310423104331044310453104631047310483104931050310513105231053310543105531056310573105831059310603106131062310633106431065310663106731068310693107031071310723107331074310753107631077310783107931080310813108231083310843108531086310873108831089310903109131092310933109431095310963109731098310993110031101311023110331104311053110631107311083110931110311113111231113311143111531116311173111831119311203112131122311233112431125311263112731128311293113031131311323113331134311353113631137311383113931140311413114231143311443114531146311473114831149311503115131152311533115431155311563115731158311593116031161311623116331164311653116631167311683116931170311713117231173311743117531176311773117831179311803118131182311833118431185311863118731188311893119031191311923119331194311953119631197311983119931200312013120231203312043120531206312073120831209312103121131212312133121431215312163121731218312193122031221312223122331224312253122631227312283122931230312313123231233312343123531236312373123831239312403124131242312433124431245312463124731248312493125031251312523125331254312553125631257312583125931260312613126231263312643126531266312673126831269312703127131272312733127431275312763127731278312793128031281312823128331284312853128631287312883128931290312913129231293312943129531296312973129831299313003130131302313033130431305313063130731308313093131031311313123131331314313153131631317313183131931320313213132231323313243132531326313273132831329313303133131332313333133431335313363133731338313393134031341313423134331344313453134631347313483134931350313513135231353313543135531356313573135831359313603136131362313633136431365313663136731368313693137031371313723137331374313753137631377313783137931380313813138231383313843138531386313873138831389313903139131392313933139431395313963139731398313993140031401314023140331404314053140631407314083140931410314113141231413314143141531416314173141831419314203142131422314233142431425314263142731428314293143031431314323143331434314353143631437314383143931440314413144231443314443144531446314473144831449314503145131452314533145431455314563145731458314593146031461314623146331464314653146631467314683146931470314713147231473314743147531476314773147831479314803148131482314833148431485314863148731488314893149031491314923149331494314953149631497314983149931500315013150231503315043150531506315073150831509315103151131512315133151431515315163151731518315193152031521315223152331524315253152631527315283152931530315313153231533315343153531536315373153831539315403154131542315433154431545315463154731548315493155031551315523155331554315553155631557315583155931560315613156231563315643156531566315673156831569315703157131572315733157431575315763157731578315793158031581315823158331584315853158631587315883158931590315913159231593315943159531596315973159831599316003160131602316033160431605316063160731608316093161031611316123161331614316153161631617316183161931620316213162231623316243162531626316273162831629316303163131632316333163431635316363163731638316393164031641316423164331644316453164631647316483164931650316513165231653316543165531656316573165831659316603166131662316633166431665316663166731668316693167031671316723167331674316753167631677316783167931680316813168231683316843168531686316873168831689316903169131692316933169431695316963169731698316993170031701317023170331704317053170631707317083170931710317113171231713317143171531716317173171831719317203172131722317233172431725317263172731728317293173031731317323173331734317353173631737317383173931740317413174231743317443174531746317473174831749317503175131752317533175431755317563175731758317593176031761317623176331764317653176631767317683176931770317713177231773317743177531776317773177831779317803178131782317833178431785317863178731788317893179031791317923179331794317953179631797317983179931800318013180231803318043180531806318073180831809318103181131812318133181431815318163181731818318193182031821318223182331824318253182631827318283182931830318313183231833318343183531836318373183831839318403184131842318433184431845318463184731848318493185031851318523185331854318553185631857318583185931860318613186231863318643186531866318673186831869318703187131872318733187431875318763187731878318793188031881318823188331884318853188631887318883188931890318913189231893318943189531896318973189831899319003190131902319033190431905319063190731908319093191031911319123191331914319153191631917319183191931920319213192231923319243192531926319273192831929319303193131932319333193431935319363193731938319393194031941319423194331944319453194631947319483194931950319513195231953319543195531956319573195831959319603196131962319633196431965319663196731968319693197031971319723197331974319753197631977319783197931980319813198231983319843198531986319873198831989319903199131992319933199431995319963199731998319993200032001320023200332004320053200632007320083200932010320113201232013320143201532016320173201832019320203202132022320233202432025320263202732028320293203032031320323203332034320353203632037320383203932040320413204232043320443204532046320473204832049320503205132052320533205432055320563205732058320593206032061320623206332064320653206632067320683206932070320713207232073320743207532076320773207832079320803208132082320833208432085320863208732088320893209032091320923209332094320953209632097320983209932100321013210232103321043210532106321073210832109321103211132112321133211432115321163211732118321193212032121321223212332124321253212632127321283212932130321313213232133321343213532136321373213832139321403214132142321433214432145321463214732148321493215032151321523215332154321553215632157321583215932160321613216232163321643216532166321673216832169321703217132172321733217432175321763217732178321793218032181321823218332184321853218632187321883218932190321913219232193321943219532196321973219832199322003220132202322033220432205322063220732208322093221032211322123221332214322153221632217322183221932220322213222232223322243222532226322273222832229322303223132232322333223432235322363223732238322393224032241322423224332244322453224632247322483224932250322513225232253322543225532256322573225832259322603226132262322633226432265322663226732268322693227032271322723227332274322753227632277322783227932280322813228232283322843228532286322873228832289322903229132292322933229432295322963229732298322993230032301323023230332304323053230632307323083230932310323113231232313323143231532316323173231832319323203232132322323233232432325323263232732328323293233032331323323233332334323353233632337323383233932340323413234232343323443234532346323473234832349323503235132352323533235432355323563235732358323593236032361323623236332364323653236632367323683236932370323713237232373323743237532376323773237832379323803238132382323833238432385323863238732388323893239032391323923239332394323953239632397323983239932400324013240232403324043240532406324073240832409324103241132412324133241432415324163241732418324193242032421324223242332424324253242632427324283242932430324313243232433324343243532436324373243832439324403244132442324433244432445324463244732448324493245032451324523245332454324553245632457324583245932460324613246232463324643246532466324673246832469324703247132472324733247432475324763247732478324793248032481324823248332484324853248632487324883248932490324913249232493324943249532496324973249832499325003250132502325033250432505325063250732508325093251032511325123251332514325153251632517325183251932520325213252232523325243252532526325273252832529325303253132532325333253432535325363253732538325393254032541325423254332544325453254632547325483254932550325513255232553325543255532556325573255832559325603256132562325633256432565325663256732568325693257032571325723257332574325753257632577325783257932580325813258232583325843258532586325873258832589325903259132592325933259432595325963259732598325993260032601326023260332604326053260632607326083260932610326113261232613326143261532616326173261832619326203262132622326233262432625326263262732628326293263032631326323263332634326353263632637326383263932640326413264232643326443264532646326473264832649326503265132652326533265432655326563265732658326593266032661326623266332664326653266632667326683266932670326713267232673326743267532676326773267832679326803268132682326833268432685326863268732688326893269032691326923269332694326953269632697326983269932700327013270232703327043270532706327073270832709327103271132712327133271432715327163271732718327193272032721327223272332724327253272632727327283272932730327313273232733327343273532736327373273832739327403274132742327433274432745327463274732748327493275032751327523275332754327553275632757327583275932760327613276232763327643276532766327673276832769327703277132772327733277432775327763277732778327793278032781327823278332784327853278632787327883278932790327913279232793327943279532796327973279832799328003280132802328033280432805328063280732808328093281032811328123281332814328153281632817328183281932820328213282232823328243282532826328273282832829328303283132832328333283432835328363283732838328393284032841328423284332844328453284632847328483284932850328513285232853328543285532856328573285832859328603286132862328633286432865328663286732868328693287032871328723287332874328753287632877328783287932880328813288232883328843288532886328873288832889328903289132892328933289432895328963289732898328993290032901329023290332904329053290632907329083290932910329113291232913329143291532916329173291832919329203292132922329233292432925329263292732928329293293032931329323293332934329353293632937329383293932940329413294232943329443294532946329473294832949329503295132952329533295432955329563295732958329593296032961329623296332964329653296632967329683296932970329713297232973329743297532976329773297832979329803298132982329833298432985329863298732988329893299032991329923299332994329953299632997329983299933000330013300233003330043300533006330073300833009330103301133012330133301433015330163301733018330193302033021330223302333024330253302633027330283302933030330313303233033330343303533036330373303833039330403304133042330433304433045330463304733048330493305033051330523305333054330553305633057330583305933060330613306233063330643306533066330673306833069330703307133072330733307433075330763307733078330793308033081330823308333084330853308633087330883308933090330913309233093330943309533096330973309833099331003310133102331033310433105331063310733108331093311033111331123311333114331153311633117331183311933120331213312233123331243312533126331273312833129331303313133132331333313433135331363313733138331393314033141331423314333144331453314633147331483314933150331513315233153331543315533156331573315833159331603316133162331633316433165331663316733168331693317033171331723317333174331753317633177331783317933180331813318233183331843318533186331873318833189331903319133192331933319433195331963319733198331993320033201332023320333204332053320633207332083320933210332113321233213332143321533216332173321833219332203322133222332233322433225332263322733228332293323033231332323323333234332353323633237332383323933240332413324233243332443324533246332473324833249332503325133252332533325433255332563325733258332593326033261332623326333264332653326633267332683326933270332713327233273332743327533276332773327833279332803328133282332833328433285332863328733288332893329033291332923329333294332953329633297332983329933300333013330233303333043330533306333073330833309333103331133312333133331433315333163331733318333193332033321333223332333324333253332633327333283332933330333313333233333333343333533336333373333833339333403334133342333433334433345333463334733348333493335033351333523335333354333553335633357333583335933360333613336233363333643336533366333673336833369333703337133372333733337433375333763337733378333793338033381333823338333384333853338633387333883338933390333913339233393333943339533396333973339833399334003340133402334033340433405334063340733408334093341033411334123341333414334153341633417334183341933420334213342233423334243342533426334273342833429334303343133432334333343433435334363343733438334393344033441334423344333444334453344633447334483344933450334513345233453334543345533456334573345833459334603346133462334633346433465334663346733468334693347033471334723347333474334753347633477334783347933480334813348233483334843348533486334873348833489334903349133492334933349433495334963349733498334993350033501335023350333504335053350633507335083350933510335113351233513335143351533516335173351833519335203352133522335233352433525335263352733528335293353033531335323353333534335353353633537335383353933540335413354233543335443354533546335473354833549335503355133552335533355433555335563355733558335593356033561335623356333564335653356633567335683356933570335713357233573335743357533576335773357833579335803358133582335833358433585335863358733588335893359033591335923359333594335953359633597335983359933600336013360233603336043360533606336073360833609336103361133612336133361433615336163361733618336193362033621336223362333624336253362633627336283362933630336313363233633336343363533636336373363833639336403364133642336433364433645336463364733648336493365033651336523365333654336553365633657336583365933660336613366233663336643366533666336673366833669336703367133672336733367433675336763367733678336793368033681336823368333684336853368633687336883368933690336913369233693336943369533696336973369833699337003370133702337033370433705337063370733708337093371033711337123371333714337153371633717337183371933720337213372233723337243372533726337273372833729337303373133732337333373433735337363373733738337393374033741337423374333744337453374633747337483374933750337513375233753337543375533756337573375833759337603376133762337633376433765337663376733768337693377033771337723377333774337753377633777337783377933780337813378233783337843378533786337873378833789337903379133792337933379433795337963379733798337993380033801338023380333804338053380633807338083380933810338113381233813338143381533816338173381833819338203382133822338233382433825338263382733828338293383033831338323383333834338353383633837338383383933840338413384233843338443384533846338473384833849338503385133852338533385433855338563385733858338593386033861338623386333864338653386633867338683386933870338713387233873338743387533876338773387833879338803388133882338833388433885338863388733888338893389033891338923389333894338953389633897338983389933900339013390233903339043390533906339073390833909339103391133912339133391433915339163391733918339193392033921339223392333924339253392633927339283392933930339313393233933339343393533936339373393833939339403394133942339433394433945339463394733948339493395033951339523395333954339553395633957339583395933960339613396233963339643396533966339673396833969339703397133972339733397433975339763397733978339793398033981339823398333984339853398633987339883398933990339913399233993339943399533996339973399833999340003400134002340033400434005340063400734008340093401034011340123401334014340153401634017340183401934020340213402234023340243402534026340273402834029340303403134032340333403434035340363403734038340393404034041340423404334044340453404634047340483404934050340513405234053340543405534056340573405834059340603406134062340633406434065340663406734068340693407034071340723407334074340753407634077340783407934080340813408234083340843408534086340873408834089340903409134092340933409434095340963409734098340993410034101341023410334104341053410634107341083410934110341113411234113341143411534116341173411834119341203412134122341233412434125341263412734128341293413034131341323413334134341353413634137341383413934140341413414234143341443414534146341473414834149341503415134152341533415434155341563415734158341593416034161341623416334164341653416634167341683416934170341713417234173341743417534176341773417834179341803418134182341833418434185341863418734188341893419034191341923419334194341953419634197341983419934200342013420234203342043420534206342073420834209342103421134212342133421434215342163421734218342193422034221342223422334224342253422634227342283422934230342313423234233342343423534236342373423834239342403424134242342433424434245342463424734248342493425034251342523425334254342553425634257342583425934260342613426234263342643426534266342673426834269342703427134272342733427434275342763427734278342793428034281342823428334284342853428634287342883428934290342913429234293342943429534296342973429834299343003430134302343033430434305343063430734308343093431034311343123431334314343153431634317343183431934320343213432234323343243432534326343273432834329343303433134332343333433434335343363433734338343393434034341343423434334344343453434634347343483434934350343513435234353343543435534356343573435834359343603436134362343633436434365343663436734368343693437034371343723437334374343753437634377343783437934380343813438234383343843438534386343873438834389343903439134392343933439434395343963439734398343993440034401344023440334404344053440634407344083440934410344113441234413344143441534416344173441834419344203442134422344233442434425344263442734428344293443034431344323443334434344353443634437344383443934440344413444234443344443444534446344473444834449344503445134452344533445434455344563445734458344593446034461344623446334464344653446634467344683446934470344713447234473344743447534476344773447834479344803448134482344833448434485344863448734488344893449034491344923449334494344953449634497344983449934500345013450234503345043450534506345073450834509345103451134512345133451434515345163451734518345193452034521345223452334524345253452634527345283452934530345313453234533345343453534536345373453834539345403454134542345433454434545345463454734548345493455034551345523455334554345553455634557345583455934560345613456234563345643456534566345673456834569345703457134572345733457434575345763457734578345793458034581345823458334584345853458634587345883458934590345913459234593345943459534596345973459834599346003460134602346033460434605346063460734608346093461034611346123461334614346153461634617346183461934620346213462234623346243462534626346273462834629346303463134632346333463434635346363463734638346393464034641346423464334644346453464634647346483464934650346513465234653346543465534656346573465834659346603466134662346633466434665346663466734668346693467034671346723467334674346753467634677346783467934680346813468234683346843468534686346873468834689346903469134692346933469434695346963469734698346993470034701347023470334704347053470634707347083470934710347113471234713347143471534716347173471834719347203472134722347233472434725347263472734728347293473034731347323473334734347353473634737347383473934740347413474234743347443474534746347473474834749347503475134752347533475434755347563475734758347593476034761347623476334764347653476634767347683476934770347713477234773347743477534776347773477834779347803478134782347833478434785347863478734788347893479034791347923479334794347953479634797347983479934800348013480234803348043480534806348073480834809348103481134812348133481434815348163481734818348193482034821348223482334824348253482634827348283482934830348313483234833348343483534836348373483834839348403484134842348433484434845348463484734848348493485034851348523485334854348553485634857348583485934860348613486234863348643486534866348673486834869348703487134872348733487434875348763487734878348793488034881348823488334884348853488634887348883488934890348913489234893348943489534896348973489834899349003490134902349033490434905349063490734908349093491034911349123491334914349153491634917349183491934920349213492234923349243492534926349273492834929349303493134932349333493434935349363493734938349393494034941349423494334944349453494634947349483494934950349513495234953349543495534956349573495834959349603496134962349633496434965349663496734968349693497034971349723497334974349753497634977349783497934980349813498234983349843498534986349873498834989349903499134992349933499434995349963499734998349993500035001350023500335004350053500635007350083500935010350113501235013350143501535016350173501835019350203502135022350233502435025350263502735028350293503035031350323503335034350353503635037350383503935040350413504235043350443504535046350473504835049350503505135052350533505435055350563505735058350593506035061350623506335064350653506635067350683506935070350713507235073350743507535076350773507835079350803508135082350833508435085350863508735088350893509035091350923509335094350953509635097350983509935100351013510235103351043510535106351073510835109351103511135112351133511435115351163511735118351193512035121351223512335124351253512635127351283512935130351313513235133351343513535136351373513835139351403514135142351433514435145351463514735148351493515035151351523515335154351553515635157351583515935160351613516235163351643516535166351673516835169351703517135172351733517435175351763517735178351793518035181351823518335184351853518635187351883518935190351913519235193351943519535196351973519835199352003520135202352033520435205352063520735208352093521035211352123521335214352153521635217352183521935220352213522235223352243522535226352273522835229352303523135232352333523435235352363523735238352393524035241352423524335244352453524635247352483524935250352513525235253352543525535256352573525835259352603526135262352633526435265352663526735268352693527035271352723527335274352753527635277352783527935280352813528235283352843528535286352873528835289352903529135292352933529435295352963529735298352993530035301353023530335304353053530635307353083530935310353113531235313353143531535316353173531835319353203532135322353233532435325353263532735328353293533035331353323533335334353353533635337353383533935340353413534235343353443534535346353473534835349353503535135352353533535435355353563535735358353593536035361353623536335364353653536635367353683536935370353713537235373353743537535376353773537835379353803538135382353833538435385353863538735388353893539035391353923539335394353953539635397353983539935400354013540235403354043540535406354073540835409354103541135412354133541435415354163541735418354193542035421354223542335424354253542635427354283542935430354313543235433354343543535436354373543835439354403544135442354433544435445354463544735448354493545035451354523545335454354553545635457354583545935460354613546235463354643546535466354673546835469354703547135472354733547435475354763547735478354793548035481354823548335484354853548635487354883548935490354913549235493354943549535496354973549835499355003550135502355033550435505355063550735508355093551035511355123551335514355153551635517355183551935520355213552235523355243552535526355273552835529355303553135532355333553435535355363553735538355393554035541355423554335544355453554635547355483554935550355513555235553355543555535556355573555835559355603556135562355633556435565355663556735568355693557035571355723557335574355753557635577355783557935580355813558235583355843558535586355873558835589355903559135592355933559435595355963559735598355993560035601356023560335604356053560635607356083560935610356113561235613356143561535616356173561835619356203562135622356233562435625356263562735628356293563035631356323563335634356353563635637356383563935640356413564235643356443564535646356473564835649356503565135652356533565435655356563565735658356593566035661356623566335664356653566635667356683566935670356713567235673356743567535676356773567835679356803568135682356833568435685356863568735688356893569035691356923569335694356953569635697356983569935700357013570235703357043570535706357073570835709357103571135712357133571435715357163571735718357193572035721357223572335724357253572635727357283572935730357313573235733357343573535736357373573835739357403574135742357433574435745357463574735748357493575035751357523575335754357553575635757357583575935760357613576235763357643576535766357673576835769357703577135772357733577435775357763577735778357793578035781357823578335784357853578635787357883578935790357913579235793357943579535796357973579835799358003580135802358033580435805358063580735808358093581035811358123581335814358153581635817358183581935820358213582235823358243582535826358273582835829358303583135832358333583435835358363583735838358393584035841358423584335844358453584635847358483584935850358513585235853358543585535856358573585835859358603586135862358633586435865358663586735868358693587035871358723587335874358753587635877358783587935880358813588235883358843588535886358873588835889358903589135892358933589435895358963589735898358993590035901359023590335904359053590635907359083590935910359113591235913359143591535916359173591835919359203592135922359233592435925359263592735928359293593035931359323593335934359353593635937359383593935940359413594235943359443594535946359473594835949359503595135952359533595435955359563595735958359593596035961359623596335964359653596635967359683596935970359713597235973359743597535976359773597835979359803598135982359833598435985359863598735988359893599035991359923599335994359953599635997359983599936000360013600236003360043600536006360073600836009360103601136012360133601436015360163601736018360193602036021360223602336024360253602636027360283602936030360313603236033360343603536036360373603836039360403604136042360433604436045360463604736048360493605036051360523605336054360553605636057360583605936060360613606236063360643606536066360673606836069360703607136072360733607436075360763607736078360793608036081360823608336084360853608636087360883608936090360913609236093360943609536096360973609836099361003610136102361033610436105361063610736108361093611036111361123611336114361153611636117361183611936120361213612236123361243612536126361273612836129361303613136132361333613436135361363613736138361393614036141361423614336144361453614636147361483614936150361513615236153361543615536156361573615836159361603616136162361633616436165361663616736168361693617036171361723617336174361753617636177361783617936180361813618236183361843618536186361873618836189361903619136192361933619436195361963619736198361993620036201362023620336204362053620636207362083620936210362113621236213362143621536216362173621836219362203622136222362233622436225362263622736228362293623036231362323623336234362353623636237362383623936240362413624236243362443624536246362473624836249362503625136252362533625436255362563625736258362593626036261362623626336264362653626636267362683626936270362713627236273362743627536276362773627836279362803628136282362833628436285362863628736288362893629036291362923629336294362953629636297362983629936300363013630236303363043630536306363073630836309363103631136312363133631436315363163631736318363193632036321363223632336324363253632636327363283632936330363313633236333363343633536336363373633836339363403634136342363433634436345363463634736348363493635036351363523635336354363553635636357363583635936360363613636236363363643636536366363673636836369363703637136372363733637436375363763637736378363793638036381363823638336384363853638636387363883638936390363913639236393363943639536396363973639836399364003640136402364033640436405364063640736408364093641036411364123641336414364153641636417364183641936420364213642236423364243642536426364273642836429364303643136432364333643436435364363643736438364393644036441364423644336444364453644636447364483644936450364513645236453364543645536456364573645836459364603646136462364633646436465364663646736468364693647036471364723647336474364753647636477364783647936480364813648236483364843648536486364873648836489364903649136492364933649436495364963649736498364993650036501365023650336504365053650636507365083650936510365113651236513365143651536516365173651836519365203652136522365233652436525365263652736528365293653036531365323653336534365353653636537365383653936540365413654236543365443654536546365473654836549365503655136552365533655436555365563655736558365593656036561365623656336564365653656636567365683656936570365713657236573365743657536576365773657836579365803658136582365833658436585365863658736588365893659036591365923659336594365953659636597365983659936600366013660236603366043660536606366073660836609366103661136612366133661436615366163661736618366193662036621366223662336624366253662636627366283662936630366313663236633366343663536636366373663836639366403664136642366433664436645366463664736648366493665036651366523665336654366553665636657366583665936660366613666236663366643666536666366673666836669366703667136672366733667436675366763667736678366793668036681366823668336684366853668636687366883668936690366913669236693366943669536696366973669836699367003670136702367033670436705367063670736708367093671036711367123671336714367153671636717367183671936720367213672236723367243672536726367273672836729367303673136732367333673436735367363673736738367393674036741367423674336744367453674636747367483674936750367513675236753367543675536756367573675836759367603676136762367633676436765367663676736768367693677036771367723677336774367753677636777367783677936780367813678236783367843678536786367873678836789367903679136792367933679436795367963679736798367993680036801368023680336804368053680636807368083680936810368113681236813368143681536816368173681836819368203682136822368233682436825368263682736828368293683036831368323683336834368353683636837368383683936840368413684236843368443684536846368473684836849368503685136852368533685436855368563685736858368593686036861368623686336864368653686636867368683686936870368713687236873368743687536876368773687836879368803688136882368833688436885368863688736888368893689036891368923689336894368953689636897368983689936900369013690236903369043690536906369073690836909369103691136912369133691436915369163691736918369193692036921369223692336924369253692636927369283692936930369313693236933369343693536936369373693836939369403694136942369433694436945369463694736948369493695036951369523695336954369553695636957369583695936960369613696236963369643696536966369673696836969369703697136972369733697436975369763697736978369793698036981369823698336984369853698636987369883698936990369913699236993369943699536996369973699836999370003700137002370033700437005370063700737008370093701037011370123701337014370153701637017370183701937020370213702237023370243702537026370273702837029370303703137032370333703437035370363703737038370393704037041370423704337044370453704637047370483704937050370513705237053370543705537056370573705837059370603706137062370633706437065370663706737068370693707037071370723707337074370753707637077370783707937080370813708237083370843708537086370873708837089370903709137092370933709437095370963709737098370993710037101371023710337104371053710637107371083710937110371113711237113371143711537116371173711837119371203712137122371233712437125371263712737128371293713037131371323713337134371353713637137371383713937140371413714237143371443714537146371473714837149371503715137152371533715437155371563715737158371593716037161371623716337164371653716637167371683716937170371713717237173371743717537176371773717837179371803718137182371833718437185371863718737188371893719037191371923719337194371953719637197371983719937200372013720237203372043720537206372073720837209372103721137212372133721437215372163721737218372193722037221372223722337224372253722637227372283722937230372313723237233372343723537236372373723837239372403724137242372433724437245372463724737248372493725037251372523725337254372553725637257372583725937260372613726237263372643726537266372673726837269372703727137272372733727437275372763727737278372793728037281372823728337284372853728637287372883728937290372913729237293372943729537296372973729837299373003730137302373033730437305373063730737308373093731037311373123731337314373153731637317373183731937320373213732237323373243732537326373273732837329373303733137332373333733437335373363733737338373393734037341373423734337344373453734637347373483734937350373513735237353373543735537356373573735837359373603736137362373633736437365373663736737368373693737037371373723737337374373753737637377373783737937380373813738237383373843738537386373873738837389373903739137392373933739437395373963739737398373993740037401374023740337404374053740637407374083740937410374113741237413374143741537416374173741837419374203742137422374233742437425374263742737428374293743037431374323743337434374353743637437374383743937440374413744237443374443744537446374473744837449374503745137452374533745437455374563745737458374593746037461374623746337464374653746637467374683746937470374713747237473374743747537476374773747837479374803748137482374833748437485374863748737488374893749037491374923749337494374953749637497374983749937500375013750237503375043750537506375073750837509375103751137512375133751437515375163751737518375193752037521375223752337524375253752637527375283752937530375313753237533375343753537536375373753837539375403754137542375433754437545375463754737548375493755037551375523755337554375553755637557375583755937560375613756237563375643756537566375673756837569375703757137572375733757437575375763757737578375793758037581375823758337584375853758637587375883758937590375913759237593375943759537596375973759837599376003760137602376033760437605376063760737608376093761037611376123761337614376153761637617376183761937620376213762237623376243762537626376273762837629376303763137632376333763437635376363763737638376393764037641376423764337644376453764637647376483764937650376513765237653376543765537656376573765837659376603766137662376633766437665376663766737668376693767037671376723767337674376753767637677376783767937680376813768237683376843768537686376873768837689376903769137692376933769437695376963769737698376993770037701377023770337704377053770637707377083770937710377113771237713377143771537716377173771837719377203772137722377233772437725377263772737728377293773037731377323773337734377353773637737377383773937740377413774237743377443774537746377473774837749377503775137752377533775437755377563775737758377593776037761377623776337764377653776637767377683776937770377713777237773377743777537776377773777837779377803778137782377833778437785377863778737788377893779037791377923779337794377953779637797377983779937800378013780237803378043780537806378073780837809378103781137812378133781437815378163781737818378193782037821378223782337824378253782637827378283782937830378313783237833378343783537836378373783837839378403784137842378433784437845378463784737848378493785037851378523785337854378553785637857378583785937860378613786237863378643786537866378673786837869378703787137872378733787437875378763787737878378793788037881378823788337884378853788637887378883788937890378913789237893378943789537896378973789837899379003790137902379033790437905379063790737908379093791037911379123791337914379153791637917379183791937920379213792237923379243792537926379273792837929379303793137932379333793437935379363793737938379393794037941379423794337944379453794637947379483794937950379513795237953379543795537956379573795837959379603796137962379633796437965379663796737968379693797037971379723797337974379753797637977379783797937980379813798237983379843798537986379873798837989379903799137992379933799437995379963799737998379993800038001380023800338004380053800638007380083800938010380113801238013380143801538016380173801838019380203802138022380233802438025380263802738028380293803038031380323803338034380353803638037380383803938040380413804238043380443804538046380473804838049380503805138052380533805438055380563805738058380593806038061380623806338064380653806638067380683806938070380713807238073380743807538076380773807838079380803808138082380833808438085380863808738088380893809038091380923809338094380953809638097380983809938100381013810238103381043810538106381073810838109381103811138112381133811438115381163811738118381193812038121381223812338124381253812638127381283812938130381313813238133381343813538136381373813838139381403814138142381433814438145381463814738148381493815038151381523815338154381553815638157381583815938160381613816238163381643816538166381673816838169381703817138172381733817438175381763817738178381793818038181381823818338184381853818638187381883818938190381913819238193381943819538196381973819838199382003820138202382033820438205382063820738208382093821038211382123821338214382153821638217382183821938220382213822238223382243822538226382273822838229382303823138232382333823438235382363823738238382393824038241382423824338244382453824638247382483824938250382513825238253382543825538256382573825838259382603826138262382633826438265382663826738268382693827038271382723827338274382753827638277382783827938280382813828238283382843828538286382873828838289382903829138292382933829438295382963829738298382993830038301383023830338304383053830638307383083830938310383113831238313383143831538316383173831838319383203832138322383233832438325383263832738328383293833038331383323833338334383353833638337383383833938340383413834238343383443834538346383473834838349383503835138352383533835438355383563835738358383593836038361383623836338364383653836638367383683836938370383713837238373383743837538376383773837838379383803838138382383833838438385383863838738388383893839038391383923839338394383953839638397383983839938400384013840238403384043840538406384073840838409384103841138412384133841438415384163841738418384193842038421384223842338424384253842638427384283842938430384313843238433384343843538436384373843838439384403844138442384433844438445384463844738448384493845038451384523845338454384553845638457384583845938460384613846238463384643846538466384673846838469384703847138472384733847438475384763847738478384793848038481384823848338484384853848638487384883848938490384913849238493384943849538496384973849838499385003850138502385033850438505385063850738508385093851038511385123851338514385153851638517385183851938520385213852238523385243852538526385273852838529385303853138532385333853438535385363853738538385393854038541385423854338544385453854638547385483854938550385513855238553385543855538556385573855838559385603856138562385633856438565385663856738568385693857038571385723857338574385753857638577385783857938580385813858238583385843858538586385873858838589385903859138592385933859438595385963859738598385993860038601386023860338604386053860638607386083860938610386113861238613386143861538616386173861838619386203862138622386233862438625386263862738628386293863038631386323863338634386353863638637386383863938640386413864238643386443864538646386473864838649386503865138652386533865438655386563865738658386593866038661386623866338664386653866638667386683866938670386713867238673386743867538676386773867838679386803868138682386833868438685386863868738688386893869038691386923869338694386953869638697386983869938700387013870238703387043870538706387073870838709387103871138712387133871438715387163871738718387193872038721387223872338724387253872638727387283872938730387313873238733387343873538736387373873838739387403874138742387433874438745387463874738748387493875038751387523875338754387553875638757387583875938760387613876238763387643876538766387673876838769387703877138772387733877438775387763877738778387793878038781387823878338784387853878638787387883878938790387913879238793387943879538796387973879838799388003880138802388033880438805388063880738808388093881038811388123881338814388153881638817388183881938820388213882238823388243882538826388273882838829388303883138832388333883438835388363883738838388393884038841388423884338844388453884638847388483884938850388513885238853388543885538856388573885838859388603886138862388633886438865388663886738868388693887038871388723887338874388753887638877388783887938880388813888238883388843888538886388873888838889388903889138892388933889438895388963889738898388993890038901389023890338904389053890638907389083890938910389113891238913389143891538916389173891838919389203892138922389233892438925389263892738928389293893038931389323893338934389353893638937389383893938940389413894238943389443894538946389473894838949389503895138952389533895438955389563895738958389593896038961389623896338964389653896638967389683896938970389713897238973389743897538976389773897838979389803898138982389833898438985389863898738988389893899038991389923899338994389953899638997389983899939000390013900239003390043900539006390073900839009390103901139012390133901439015390163901739018390193902039021390223902339024390253902639027390283902939030390313903239033390343903539036390373903839039390403904139042390433904439045390463904739048390493905039051390523905339054390553905639057390583905939060390613906239063390643906539066390673906839069390703907139072390733907439075390763907739078390793908039081390823908339084390853908639087390883908939090390913909239093390943909539096390973909839099391003910139102391033910439105391063910739108391093911039111391123911339114391153911639117391183911939120391213912239123391243912539126391273912839129391303913139132391333913439135391363913739138391393914039141391423914339144391453914639147391483914939150391513915239153391543915539156391573915839159391603916139162391633916439165391663916739168391693917039171391723917339174391753917639177391783917939180391813918239183391843918539186391873918839189391903919139192391933919439195391963919739198391993920039201392023920339204392053920639207392083920939210392113921239213392143921539216392173921839219392203922139222392233922439225392263922739228392293923039231392323923339234392353923639237392383923939240392413924239243392443924539246392473924839249392503925139252392533925439255392563925739258392593926039261392623926339264392653926639267392683926939270392713927239273392743927539276392773927839279392803928139282392833928439285392863928739288392893929039291392923929339294392953929639297392983929939300393013930239303393043930539306393073930839309393103931139312393133931439315393163931739318393193932039321393223932339324393253932639327393283932939330393313933239333393343933539336393373933839339393403934139342393433934439345393463934739348393493935039351393523935339354393553935639357393583935939360393613936239363393643936539366393673936839369393703937139372393733937439375393763937739378393793938039381393823938339384393853938639387393883938939390393913939239393393943939539396393973939839399394003940139402394033940439405394063940739408394093941039411394123941339414394153941639417394183941939420394213942239423394243942539426394273942839429394303943139432394333943439435394363943739438394393944039441394423944339444394453944639447394483944939450394513945239453394543945539456394573945839459394603946139462394633946439465394663946739468394693947039471394723947339474394753947639477394783947939480394813948239483394843948539486394873948839489394903949139492394933949439495394963949739498394993950039501395023950339504395053950639507395083950939510395113951239513395143951539516395173951839519395203952139522395233952439525395263952739528395293953039531395323953339534395353953639537395383953939540395413954239543395443954539546395473954839549395503955139552395533955439555395563955739558395593956039561395623956339564395653956639567395683956939570395713957239573395743957539576395773957839579395803958139582395833958439585395863958739588395893959039591395923959339594395953959639597395983959939600396013960239603396043960539606396073960839609396103961139612396133961439615396163961739618396193962039621396223962339624396253962639627396283962939630396313963239633396343963539636396373963839639396403964139642396433964439645396463964739648396493965039651396523965339654396553965639657396583965939660396613966239663396643966539666396673966839669396703967139672396733967439675396763967739678396793968039681396823968339684396853968639687396883968939690396913969239693396943969539696396973969839699397003970139702397033970439705397063970739708397093971039711397123971339714397153971639717397183971939720397213972239723397243972539726397273972839729397303973139732397333973439735397363973739738397393974039741397423974339744397453974639747397483974939750397513975239753397543975539756397573975839759397603976139762397633976439765397663976739768397693977039771397723977339774397753977639777397783977939780397813978239783397843978539786397873978839789397903979139792397933979439795397963979739798397993980039801398023980339804398053980639807398083980939810398113981239813398143981539816398173981839819398203982139822398233982439825398263982739828398293983039831398323983339834398353983639837398383983939840398413984239843398443984539846398473984839849398503985139852398533985439855398563985739858398593986039861398623986339864398653986639867398683986939870398713987239873398743987539876398773987839879398803988139882398833988439885398863988739888398893989039891398923989339894398953989639897398983989939900399013990239903399043990539906399073990839909399103991139912399133991439915399163991739918399193992039921399223992339924399253992639927399283992939930399313993239933399343993539936399373993839939399403994139942399433994439945399463994739948399493995039951399523995339954399553995639957399583995939960399613996239963399643996539966399673996839969399703997139972399733997439975399763997739978399793998039981399823998339984399853998639987399883998939990399913999239993399943999539996399973999839999400004000140002400034000440005400064000740008400094001040011400124001340014400154001640017400184001940020400214002240023400244002540026400274002840029400304003140032400334003440035400364003740038400394004040041400424004340044400454004640047400484004940050400514005240053400544005540056400574005840059400604006140062400634006440065400664006740068400694007040071400724007340074400754007640077400784007940080400814008240083400844008540086400874008840089400904009140092400934009440095400964009740098400994010040101401024010340104401054010640107401084010940110401114011240113401144011540116401174011840119401204012140122401234012440125401264012740128401294013040131401324013340134401354013640137401384013940140401414014240143401444014540146401474014840149401504015140152401534015440155401564015740158401594016040161401624016340164401654016640167401684016940170401714017240173401744017540176401774017840179401804018140182401834018440185401864018740188401894019040191401924019340194401954019640197401984019940200402014020240203402044020540206402074020840209402104021140212402134021440215402164021740218402194022040221402224022340224402254022640227402284022940230402314023240233402344023540236402374023840239402404024140242402434024440245402464024740248402494025040251402524025340254402554025640257402584025940260402614026240263402644026540266402674026840269402704027140272402734027440275402764027740278402794028040281402824028340284402854028640287402884028940290402914029240293402944029540296402974029840299403004030140302403034030440305403064030740308403094031040311403124031340314403154031640317403184031940320403214032240323403244032540326403274032840329403304033140332403334033440335403364033740338403394034040341403424034340344403454034640347403484034940350403514035240353403544035540356403574035840359403604036140362403634036440365403664036740368403694037040371403724037340374403754037640377403784037940380403814038240383403844038540386403874038840389403904039140392403934039440395403964039740398403994040040401404024040340404404054040640407404084040940410404114041240413404144041540416404174041840419404204042140422404234042440425404264042740428404294043040431404324043340434404354043640437404384043940440404414044240443404444044540446404474044840449404504045140452404534045440455404564045740458404594046040461404624046340464404654046640467404684046940470404714047240473404744047540476404774047840479404804048140482404834048440485404864048740488404894049040491404924049340494404954049640497404984049940500405014050240503405044050540506405074050840509405104051140512405134051440515405164051740518405194052040521405224052340524405254052640527405284052940530405314053240533405344053540536405374053840539405404054140542405434054440545405464054740548405494055040551405524055340554405554055640557405584055940560405614056240563405644056540566405674056840569405704057140572405734057440575405764057740578405794058040581405824058340584405854058640587405884058940590405914059240593405944059540596405974059840599406004060140602406034060440605406064060740608406094061040611406124061340614406154061640617406184061940620406214062240623406244062540626406274062840629406304063140632406334063440635406364063740638406394064040641406424064340644406454064640647406484064940650406514065240653406544065540656406574065840659406604066140662406634066440665406664066740668406694067040671406724067340674406754067640677406784067940680406814068240683406844068540686406874068840689406904069140692406934069440695406964069740698406994070040701407024070340704407054070640707407084070940710407114071240713407144071540716407174071840719407204072140722407234072440725407264072740728407294073040731407324073340734407354073640737407384073940740407414074240743407444074540746407474074840749407504075140752407534075440755407564075740758407594076040761407624076340764407654076640767407684076940770407714077240773407744077540776407774077840779407804078140782407834078440785407864078740788407894079040791407924079340794407954079640797407984079940800408014080240803408044080540806408074080840809408104081140812408134081440815408164081740818408194082040821408224082340824408254082640827408284082940830408314083240833408344083540836408374083840839408404084140842408434084440845408464084740848408494085040851408524085340854408554085640857408584085940860408614086240863408644086540866408674086840869408704087140872408734087440875408764087740878408794088040881408824088340884408854088640887408884088940890408914089240893408944089540896408974089840899409004090140902409034090440905409064090740908409094091040911409124091340914409154091640917409184091940920409214092240923409244092540926409274092840929409304093140932409334093440935409364093740938409394094040941409424094340944409454094640947409484094940950409514095240953409544095540956409574095840959409604096140962409634096440965409664096740968409694097040971409724097340974409754097640977409784097940980409814098240983409844098540986409874098840989409904099140992409934099440995409964099740998409994100041001410024100341004410054100641007410084100941010410114101241013410144101541016410174101841019410204102141022410234102441025410264102741028410294103041031410324103341034410354103641037410384103941040410414104241043410444104541046410474104841049410504105141052410534105441055410564105741058410594106041061410624106341064410654106641067410684106941070410714107241073410744107541076410774107841079410804108141082410834108441085410864108741088410894109041091410924109341094410954109641097410984109941100411014110241103411044110541106411074110841109411104111141112411134111441115411164111741118411194112041121411224112341124411254112641127411284112941130411314113241133411344113541136411374113841139411404114141142411434114441145411464114741148411494115041151411524115341154411554115641157411584115941160411614116241163411644116541166411674116841169411704117141172411734117441175411764117741178411794118041181411824118341184411854118641187411884118941190411914119241193411944119541196411974119841199412004120141202412034120441205412064120741208412094121041211412124121341214412154121641217412184121941220412214122241223412244122541226412274122841229412304123141232412334123441235412364123741238412394124041241412424124341244412454124641247412484124941250412514125241253412544125541256412574125841259412604126141262412634126441265412664126741268412694127041271412724127341274412754127641277412784127941280412814128241283412844128541286412874128841289412904129141292412934129441295412964129741298412994130041301413024130341304413054130641307413084130941310413114131241313413144131541316413174131841319413204132141322413234132441325413264132741328413294133041331413324133341334413354133641337413384133941340413414134241343413444134541346413474134841349413504135141352413534135441355413564135741358413594136041361413624136341364413654136641367413684136941370413714137241373413744137541376413774137841379413804138141382413834138441385413864138741388413894139041391413924139341394413954139641397413984139941400414014140241403414044140541406414074140841409414104141141412414134141441415414164141741418414194142041421414224142341424414254142641427414284142941430414314143241433414344143541436414374143841439414404144141442414434144441445414464144741448414494145041451414524145341454414554145641457414584145941460414614146241463414644146541466414674146841469414704147141472414734147441475414764147741478414794148041481414824148341484414854148641487414884148941490414914149241493414944149541496414974149841499415004150141502415034150441505415064150741508415094151041511415124151341514415154151641517415184151941520415214152241523415244152541526415274152841529415304153141532415334153441535415364153741538415394154041541415424154341544415454154641547415484154941550415514155241553415544155541556415574155841559415604156141562415634156441565415664156741568415694157041571415724157341574415754157641577415784157941580415814158241583415844158541586415874158841589415904159141592415934159441595415964159741598415994160041601416024160341604416054160641607416084160941610416114161241613416144161541616416174161841619416204162141622416234162441625416264162741628416294163041631416324163341634416354163641637416384163941640416414164241643416444164541646416474164841649416504165141652416534165441655416564165741658416594166041661416624166341664416654166641667416684166941670416714167241673416744167541676416774167841679416804168141682416834168441685416864168741688416894169041691416924169341694416954169641697416984169941700417014170241703417044170541706417074170841709417104171141712417134171441715417164171741718417194172041721417224172341724417254172641727417284172941730417314173241733417344173541736417374173841739417404174141742417434174441745417464174741748417494175041751417524175341754417554175641757417584175941760417614176241763417644176541766417674176841769417704177141772417734177441775417764177741778417794178041781417824178341784417854178641787417884178941790417914179241793417944179541796417974179841799418004180141802418034180441805418064180741808418094181041811418124181341814418154181641817418184181941820418214182241823418244182541826418274182841829418304183141832418334183441835418364183741838418394184041841418424184341844418454184641847418484184941850418514185241853418544185541856418574185841859418604186141862418634186441865418664186741868418694187041871418724187341874418754187641877418784187941880418814188241883418844188541886418874188841889418904189141892418934189441895418964189741898418994190041901419024190341904419054190641907419084190941910419114191241913419144191541916419174191841919419204192141922419234192441925419264192741928419294193041931419324193341934419354193641937419384193941940419414194241943419444194541946419474194841949419504195141952419534195441955419564195741958419594196041961419624196341964419654196641967419684196941970419714197241973419744197541976419774197841979419804198141982419834198441985419864198741988419894199041991419924199341994419954199641997419984199942000420014200242003420044200542006420074200842009420104201142012420134201442015420164201742018420194202042021420224202342024420254202642027420284202942030420314203242033420344203542036420374203842039420404204142042420434204442045420464204742048420494205042051420524205342054420554205642057420584205942060420614206242063420644206542066420674206842069420704207142072420734207442075420764207742078420794208042081420824208342084420854208642087420884208942090420914209242093420944209542096420974209842099421004210142102421034210442105421064210742108421094211042111421124211342114421154211642117421184211942120421214212242123421244212542126421274212842129421304213142132421334213442135421364213742138421394214042141421424214342144421454214642147421484214942150421514215242153421544215542156421574215842159421604216142162421634216442165421664216742168421694217042171421724217342174421754217642177421784217942180421814218242183421844218542186421874218842189421904219142192421934219442195421964219742198421994220042201422024220342204422054220642207422084220942210422114221242213422144221542216422174221842219422204222142222422234222442225422264222742228422294223042231422324223342234422354223642237422384223942240422414224242243422444224542246422474224842249422504225142252422534225442255422564225742258422594226042261422624226342264422654226642267422684226942270422714227242273422744227542276422774227842279422804228142282422834228442285422864228742288422894229042291422924229342294422954229642297422984229942300423014230242303423044230542306423074230842309423104231142312423134231442315423164231742318423194232042321423224232342324423254232642327423284232942330423314233242333423344233542336423374233842339423404234142342423434234442345423464234742348423494235042351423524235342354423554235642357423584235942360423614236242363423644236542366423674236842369423704237142372423734237442375423764237742378423794238042381423824238342384423854238642387423884238942390423914239242393423944239542396423974239842399424004240142402424034240442405424064240742408424094241042411424124241342414424154241642417424184241942420424214242242423424244242542426424274242842429424304243142432424334243442435424364243742438424394244042441424424244342444424454244642447424484244942450424514245242453424544245542456424574245842459424604246142462424634246442465424664246742468424694247042471424724247342474424754247642477424784247942480424814248242483424844248542486424874248842489424904249142492424934249442495424964249742498424994250042501425024250342504425054250642507425084250942510425114251242513425144251542516425174251842519425204252142522425234252442525425264252742528425294253042531425324253342534425354253642537425384253942540425414254242543425444254542546425474254842549425504255142552425534255442555425564255742558425594256042561425624256342564425654256642567425684256942570425714257242573425744257542576425774257842579425804258142582425834258442585425864258742588425894259042591425924259342594425954259642597425984259942600426014260242603426044260542606426074260842609426104261142612426134261442615426164261742618426194262042621426224262342624426254262642627426284262942630426314263242633426344263542636426374263842639426404264142642426434264442645426464264742648426494265042651426524265342654426554265642657426584265942660426614266242663426644266542666426674266842669426704267142672426734267442675426764267742678426794268042681426824268342684426854268642687426884268942690426914269242693426944269542696426974269842699427004270142702427034270442705427064270742708427094271042711427124271342714427154271642717427184271942720427214272242723427244272542726427274272842729427304273142732427334273442735427364273742738427394274042741427424274342744427454274642747427484274942750427514275242753427544275542756427574275842759427604276142762427634276442765427664276742768427694277042771427724277342774427754277642777427784277942780427814278242783427844278542786427874278842789427904279142792427934279442795427964279742798427994280042801428024280342804428054280642807428084280942810428114281242813428144281542816428174281842819428204282142822428234282442825428264282742828428294283042831428324283342834428354283642837428384283942840428414284242843428444284542846428474284842849428504285142852428534285442855428564285742858428594286042861428624286342864428654286642867428684286942870428714287242873428744287542876428774287842879428804288142882428834288442885428864288742888428894289042891428924289342894428954289642897428984289942900429014290242903429044290542906429074290842909429104291142912429134291442915429164291742918429194292042921429224292342924429254292642927429284292942930429314293242933429344293542936429374293842939429404294142942429434294442945429464294742948429494295042951429524295342954429554295642957429584295942960429614296242963429644296542966429674296842969429704297142972429734297442975429764297742978429794298042981429824298342984429854298642987429884298942990429914299242993429944299542996429974299842999430004300143002430034300443005430064300743008430094301043011430124301343014430154301643017430184301943020430214302243023430244302543026430274302843029430304303143032430334303443035430364303743038430394304043041430424304343044430454304643047430484304943050430514305243053430544305543056430574305843059430604306143062430634306443065430664306743068430694307043071430724307343074430754307643077430784307943080430814308243083430844308543086430874308843089430904309143092430934309443095430964309743098430994310043101431024310343104431054310643107431084310943110431114311243113431144311543116431174311843119431204312143122431234312443125431264312743128431294313043131431324313343134431354313643137431384313943140431414314243143431444314543146431474314843149431504315143152431534315443155431564315743158431594316043161431624316343164431654316643167431684316943170431714317243173431744317543176431774317843179431804318143182431834318443185431864318743188431894319043191431924319343194431954319643197431984319943200432014320243203432044320543206432074320843209432104321143212432134321443215432164321743218432194322043221432224322343224432254322643227432284322943230432314323243233432344323543236432374323843239432404324143242432434324443245432464324743248432494325043251432524325343254432554325643257432584325943260432614326243263432644326543266432674326843269432704327143272432734327443275432764327743278432794328043281432824328343284432854328643287432884328943290432914329243293432944329543296432974329843299433004330143302433034330443305433064330743308433094331043311433124331343314433154331643317433184331943320433214332243323433244332543326433274332843329433304333143332433334333443335433364333743338433394334043341433424334343344433454334643347433484334943350433514335243353433544335543356433574335843359433604336143362433634336443365433664336743368433694337043371433724337343374433754337643377433784337943380433814338243383433844338543386433874338843389433904339143392433934339443395433964339743398433994340043401434024340343404434054340643407434084340943410434114341243413434144341543416434174341843419434204342143422434234342443425434264342743428434294343043431434324343343434434354343643437434384343943440434414344243443434444344543446434474344843449434504345143452434534345443455434564345743458434594346043461434624346343464434654346643467434684346943470434714347243473434744347543476434774347843479434804348143482434834348443485434864348743488434894349043491434924349343494434954349643497434984349943500435014350243503435044350543506435074350843509435104351143512435134351443515435164351743518435194352043521435224352343524435254352643527435284352943530435314353243533435344353543536435374353843539435404354143542435434354443545435464354743548435494355043551435524355343554435554355643557435584355943560435614356243563435644356543566435674356843569435704357143572435734357443575435764357743578435794358043581435824358343584435854358643587435884358943590435914359243593435944359543596435974359843599436004360143602436034360443605436064360743608436094361043611436124361343614436154361643617436184361943620436214362243623436244362543626436274362843629436304363143632436334363443635436364363743638436394364043641436424364343644436454364643647436484364943650436514365243653436544365543656436574365843659436604366143662436634366443665436664366743668436694367043671436724367343674436754367643677436784367943680436814368243683436844368543686436874368843689436904369143692436934369443695436964369743698436994370043701437024370343704437054370643707437084370943710437114371243713437144371543716437174371843719437204372143722437234372443725437264372743728437294373043731437324373343734437354373643737437384373943740437414374243743437444374543746437474374843749437504375143752437534375443755437564375743758437594376043761437624376343764437654376643767437684376943770437714377243773437744377543776437774377843779437804378143782437834378443785437864378743788437894379043791437924379343794437954379643797437984379943800438014380243803438044380543806438074380843809438104381143812438134381443815438164381743818438194382043821438224382343824438254382643827438284382943830438314383243833438344383543836438374383843839438404384143842438434384443845438464384743848438494385043851438524385343854438554385643857438584385943860438614386243863438644386543866438674386843869438704387143872438734387443875438764387743878438794388043881438824388343884438854388643887438884388943890438914389243893438944389543896438974389843899439004390143902439034390443905439064390743908439094391043911439124391343914439154391643917439184391943920439214392243923439244392543926439274392843929439304393143932439334393443935439364393743938439394394043941439424394343944439454394643947439484394943950439514395243953439544395543956439574395843959439604396143962439634396443965439664396743968439694397043971439724397343974439754397643977439784397943980439814398243983439844398543986439874398843989439904399143992439934399443995439964399743998439994400044001440024400344004440054400644007440084400944010440114401244013440144401544016440174401844019440204402144022440234402444025440264402744028440294403044031440324403344034440354403644037440384403944040440414404244043440444404544046440474404844049440504405144052440534405444055440564405744058440594406044061440624406344064440654406644067440684406944070440714407244073440744407544076440774407844079440804408144082440834408444085440864408744088440894409044091440924409344094440954409644097440984409944100441014410244103441044410544106441074410844109441104411144112441134411444115441164411744118441194412044121441224412344124441254412644127441284412944130441314413244133441344413544136441374413844139441404414144142441434414444145441464414744148441494415044151441524415344154441554415644157441584415944160441614416244163441644416544166441674416844169441704417144172441734417444175441764417744178441794418044181441824418344184441854418644187441884418944190441914419244193441944419544196441974419844199442004420144202442034420444205442064420744208442094421044211442124421344214442154421644217442184421944220442214422244223442244422544226442274422844229442304423144232442334423444235442364423744238442394424044241442424424344244442454424644247442484424944250442514425244253442544425544256442574425844259442604426144262442634426444265442664426744268442694427044271442724427344274442754427644277442784427944280442814428244283442844428544286442874428844289442904429144292442934429444295442964429744298442994430044301443024430344304443054430644307443084430944310443114431244313443144431544316443174431844319443204432144322443234432444325443264432744328443294433044331443324433344334443354433644337443384433944340443414434244343443444434544346443474434844349443504435144352443534435444355443564435744358443594436044361443624436344364443654436644367443684436944370443714437244373443744437544376443774437844379443804438144382443834438444385443864438744388443894439044391443924439344394443954439644397443984439944400444014440244403444044440544406444074440844409444104441144412444134441444415444164441744418444194442044421444224442344424444254442644427444284442944430444314443244433444344443544436444374443844439444404444144442444434444444445444464444744448444494445044451444524445344454444554445644457444584445944460444614446244463444644446544466444674446844469444704447144472444734447444475444764447744478444794448044481444824448344484444854448644487444884448944490444914449244493444944449544496444974449844499445004450144502445034450444505445064450744508445094451044511445124451344514445154451644517445184451944520445214452244523445244452544526445274452844529445304453144532445334453444535445364453744538445394454044541445424454344544445454454644547445484454944550445514455244553445544455544556445574455844559445604456144562445634456444565445664456744568445694457044571445724457344574445754457644577445784457944580445814458244583445844458544586445874458844589445904459144592445934459444595445964459744598445994460044601446024460344604446054460644607446084460944610446114461244613446144461544616446174461844619446204462144622446234462444625446264462744628446294463044631446324463344634446354463644637446384463944640446414464244643446444464544646446474464844649446504465144652446534465444655446564465744658446594466044661446624466344664446654466644667446684466944670446714467244673446744467544676446774467844679446804468144682446834468444685446864468744688446894469044691446924469344694446954469644697446984469944700447014470244703447044470544706447074470844709447104471144712447134471444715447164471744718447194472044721447224472344724447254472644727447284472944730447314473244733447344473544736447374473844739447404474144742447434474444745447464474744748447494475044751447524475344754447554475644757447584475944760447614476244763447644476544766447674476844769447704477144772447734477444775447764477744778447794478044781447824478344784447854478644787447884478944790447914479244793447944479544796447974479844799448004480144802448034480444805448064480744808448094481044811448124481344814448154481644817448184481944820448214482244823448244482544826448274482844829448304483144832448334483444835448364483744838448394484044841448424484344844448454484644847448484484944850448514485244853448544485544856448574485844859448604486144862448634486444865448664486744868448694487044871448724487344874448754487644877448784487944880448814488244883448844488544886448874488844889448904489144892448934489444895448964489744898448994490044901449024490344904449054490644907449084490944910449114491244913449144491544916449174491844919449204492144922449234492444925449264492744928449294493044931449324493344934449354493644937449384493944940449414494244943449444494544946449474494844949449504495144952449534495444955449564495744958449594496044961449624496344964449654496644967449684496944970449714497244973449744497544976449774497844979449804498144982449834498444985449864498744988449894499044991449924499344994449954499644997449984499945000450014500245003450044500545006450074500845009450104501145012450134501445015450164501745018450194502045021450224502345024450254502645027450284502945030450314503245033450344503545036450374503845039450404504145042450434504445045450464504745048450494505045051450524505345054450554505645057450584505945060450614506245063450644506545066450674506845069450704507145072450734507445075450764507745078450794508045081450824508345084450854508645087450884508945090450914509245093450944509545096450974509845099451004510145102451034510445105451064510745108451094511045111451124511345114451154511645117451184511945120451214512245123451244512545126451274512845129451304513145132451334513445135451364513745138451394514045141451424514345144451454514645147451484514945150451514515245153451544515545156451574515845159451604516145162451634516445165451664516745168451694517045171451724517345174451754517645177451784517945180451814518245183451844518545186451874518845189451904519145192451934519445195451964519745198451994520045201452024520345204452054520645207452084520945210452114521245213452144521545216452174521845219452204522145222452234522445225452264522745228452294523045231452324523345234452354523645237452384523945240452414524245243452444524545246452474524845249452504525145252452534525445255452564525745258452594526045261452624526345264452654526645267452684526945270452714527245273452744527545276452774527845279452804528145282452834528445285452864528745288452894529045291452924529345294452954529645297452984529945300453014530245303453044530545306453074530845309453104531145312453134531445315453164531745318453194532045321453224532345324453254532645327453284532945330453314533245333453344533545336453374533845339453404534145342453434534445345453464534745348453494535045351453524535345354453554535645357453584535945360453614536245363453644536545366453674536845369453704537145372453734537445375453764537745378453794538045381453824538345384453854538645387453884538945390453914539245393453944539545396453974539845399454004540145402454034540445405454064540745408454094541045411454124541345414454154541645417454184541945420454214542245423454244542545426454274542845429454304543145432454334543445435454364543745438454394544045441454424544345444454454544645447454484544945450454514545245453454544545545456454574545845459454604546145462454634546445465454664546745468454694547045471454724547345474454754547645477454784547945480454814548245483454844548545486454874548845489454904549145492454934549445495454964549745498454994550045501455024550345504455054550645507455084550945510455114551245513455144551545516455174551845519455204552145522455234552445525455264552745528455294553045531455324553345534455354553645537455384553945540455414554245543455444554545546455474554845549455504555145552455534555445555455564555745558455594556045561455624556345564455654556645567455684556945570455714557245573455744557545576455774557845579455804558145582455834558445585455864558745588455894559045591455924559345594455954559645597455984559945600456014560245603456044560545606456074560845609456104561145612456134561445615456164561745618456194562045621456224562345624456254562645627456284562945630456314563245633456344563545636456374563845639456404564145642456434564445645456464564745648456494565045651456524565345654456554565645657456584565945660456614566245663456644566545666456674566845669456704567145672456734567445675456764567745678456794568045681456824568345684456854568645687456884568945690456914569245693456944569545696456974569845699457004570145702457034570445705457064570745708457094571045711457124571345714457154571645717457184571945720457214572245723457244572545726457274572845729457304573145732457334573445735457364573745738457394574045741457424574345744457454574645747457484574945750457514575245753457544575545756457574575845759457604576145762457634576445765457664576745768457694577045771457724577345774457754577645777457784577945780457814578245783457844578545786457874578845789457904579145792457934579445795457964579745798457994580045801458024580345804458054580645807458084580945810458114581245813458144581545816458174581845819458204582145822458234582445825458264582745828458294583045831458324583345834458354583645837458384583945840458414584245843458444584545846458474584845849458504585145852458534585445855458564585745858458594586045861458624586345864458654586645867458684586945870458714587245873458744587545876458774587845879458804588145882458834588445885458864588745888458894589045891458924589345894458954589645897458984589945900459014590245903459044590545906459074590845909459104591145912459134591445915459164591745918459194592045921459224592345924459254592645927459284592945930459314593245933459344593545936459374593845939459404594145942459434594445945459464594745948459494595045951459524595345954459554595645957459584595945960459614596245963459644596545966459674596845969459704597145972459734597445975459764597745978459794598045981459824598345984459854598645987459884598945990459914599245993459944599545996459974599845999460004600146002460034600446005460064600746008460094601046011460124601346014460154601646017460184601946020460214602246023460244602546026460274602846029460304603146032460334603446035460364603746038460394604046041460424604346044460454604646047460484604946050460514605246053460544605546056460574605846059460604606146062460634606446065460664606746068460694607046071460724607346074460754607646077460784607946080460814608246083460844608546086460874608846089460904609146092460934609446095460964609746098460994610046101461024610346104461054610646107461084610946110461114611246113461144611546116461174611846119461204612146122461234612446125461264612746128461294613046131461324613346134461354613646137461384613946140461414614246143461444614546146461474614846149461504615146152461534615446155461564615746158461594616046161461624616346164461654616646167461684616946170461714617246173461744617546176461774617846179461804618146182461834618446185461864618746188461894619046191461924619346194461954619646197461984619946200462014620246203462044620546206462074620846209462104621146212462134621446215462164621746218462194622046221462224622346224462254622646227462284622946230462314623246233462344623546236462374623846239462404624146242462434624446245462464624746248462494625046251462524625346254462554625646257462584625946260462614626246263462644626546266462674626846269462704627146272462734627446275462764627746278462794628046281462824628346284462854628646287462884628946290462914629246293462944629546296462974629846299463004630146302463034630446305463064630746308463094631046311463124631346314463154631646317463184631946320463214632246323463244632546326463274632846329463304633146332463334633446335463364633746338463394634046341463424634346344463454634646347463484634946350463514635246353463544635546356463574635846359463604636146362463634636446365463664636746368463694637046371463724637346374463754637646377463784637946380463814638246383463844638546386463874638846389463904639146392463934639446395463964639746398463994640046401464024640346404464054640646407464084640946410464114641246413464144641546416464174641846419464204642146422464234642446425464264642746428464294643046431464324643346434464354643646437464384643946440464414644246443464444644546446464474644846449464504645146452464534645446455464564645746458464594646046461464624646346464464654646646467464684646946470464714647246473464744647546476464774647846479464804648146482464834648446485464864648746488464894649046491464924649346494464954649646497464984649946500465014650246503465044650546506465074650846509465104651146512465134651446515465164651746518465194652046521465224652346524465254652646527465284652946530465314653246533465344653546536465374653846539465404654146542465434654446545465464654746548465494655046551465524655346554465554655646557465584655946560465614656246563465644656546566465674656846569465704657146572465734657446575465764657746578465794658046581465824658346584465854658646587465884658946590465914659246593465944659546596465974659846599466004660146602466034660446605466064660746608466094661046611466124661346614466154661646617466184661946620466214662246623466244662546626466274662846629466304663146632466334663446635466364663746638466394664046641466424664346644466454664646647466484664946650466514665246653466544665546656466574665846659466604666146662466634666446665466664666746668466694667046671466724667346674466754667646677466784667946680466814668246683466844668546686466874668846689466904669146692466934669446695466964669746698466994670046701467024670346704467054670646707467084670946710467114671246713467144671546716467174671846719467204672146722467234672446725467264672746728467294673046731467324673346734467354673646737467384673946740467414674246743467444674546746467474674846749467504675146752467534675446755467564675746758467594676046761467624676346764467654676646767467684676946770467714677246773467744677546776467774677846779467804678146782467834678446785467864678746788467894679046791467924679346794467954679646797467984679946800468014680246803468044680546806468074680846809468104681146812468134681446815468164681746818468194682046821468224682346824468254682646827468284682946830468314683246833468344683546836468374683846839468404684146842468434684446845468464684746848468494685046851468524685346854468554685646857468584685946860468614686246863468644686546866468674686846869468704687146872468734687446875468764687746878468794688046881468824688346884468854688646887468884688946890468914689246893468944689546896468974689846899469004690146902469034690446905469064690746908469094691046911469124691346914469154691646917469184691946920469214692246923469244692546926469274692846929469304693146932469334693446935469364693746938469394694046941469424694346944469454694646947469484694946950469514695246953469544695546956469574695846959469604696146962469634696446965469664696746968469694697046971469724697346974469754697646977469784697946980469814698246983469844698546986469874698846989469904699146992469934699446995469964699746998469994700047001470024700347004470054700647007470084700947010470114701247013470144701547016470174701847019470204702147022470234702447025470264702747028470294703047031470324703347034470354703647037470384703947040470414704247043470444704547046470474704847049470504705147052470534705447055470564705747058470594706047061470624706347064470654706647067470684706947070470714707247073470744707547076470774707847079470804708147082470834708447085470864708747088470894709047091470924709347094470954709647097470984709947100471014710247103471044710547106471074710847109471104711147112471134711447115471164711747118471194712047121471224712347124471254712647127471284712947130471314713247133471344713547136471374713847139471404714147142471434714447145471464714747148471494715047151471524715347154471554715647157471584715947160471614716247163471644716547166471674716847169471704717147172471734717447175471764717747178471794718047181471824718347184471854718647187471884718947190471914719247193471944719547196471974719847199472004720147202472034720447205472064720747208472094721047211472124721347214472154721647217472184721947220472214722247223472244722547226472274722847229472304723147232472334723447235472364723747238472394724047241472424724347244472454724647247472484724947250472514725247253472544725547256472574725847259472604726147262472634726447265472664726747268472694727047271472724727347274472754727647277472784727947280472814728247283472844728547286472874728847289472904729147292472934729447295472964729747298472994730047301473024730347304473054730647307473084730947310473114731247313473144731547316473174731847319473204732147322473234732447325473264732747328473294733047331473324733347334473354733647337473384733947340473414734247343473444734547346473474734847349473504735147352473534735447355473564735747358473594736047361473624736347364473654736647367473684736947370473714737247373473744737547376473774737847379473804738147382473834738447385473864738747388473894739047391473924739347394473954739647397473984739947400474014740247403474044740547406474074740847409474104741147412474134741447415474164741747418474194742047421474224742347424474254742647427474284742947430474314743247433474344743547436474374743847439474404744147442474434744447445474464744747448474494745047451474524745347454474554745647457474584745947460474614746247463474644746547466474674746847469474704747147472474734747447475474764747747478474794748047481474824748347484474854748647487474884748947490474914749247493474944749547496474974749847499475004750147502475034750447505475064750747508475094751047511475124751347514475154751647517475184751947520475214752247523475244752547526475274752847529475304753147532475334753447535475364753747538475394754047541475424754347544475454754647547475484754947550475514755247553475544755547556475574755847559475604756147562475634756447565475664756747568475694757047571475724757347574475754757647577475784757947580475814758247583475844758547586475874758847589475904759147592475934759447595475964759747598475994760047601476024760347604476054760647607476084760947610476114761247613476144761547616476174761847619476204762147622476234762447625476264762747628476294763047631476324763347634476354763647637476384763947640476414764247643476444764547646476474764847649476504765147652476534765447655476564765747658476594766047661476624766347664476654766647667476684766947670476714767247673476744767547676476774767847679476804768147682476834768447685476864768747688476894769047691476924769347694476954769647697476984769947700477014770247703477044770547706477074770847709477104771147712477134771447715477164771747718477194772047721477224772347724477254772647727477284772947730477314773247733477344773547736477374773847739477404774147742477434774447745477464774747748477494775047751477524775347754477554775647757477584775947760477614776247763477644776547766477674776847769477704777147772477734777447775477764777747778477794778047781477824778347784477854778647787477884778947790477914779247793477944779547796477974779847799478004780147802478034780447805478064780747808478094781047811478124781347814478154781647817478184781947820478214782247823478244782547826478274782847829478304783147832478334783447835478364783747838478394784047841478424784347844478454784647847478484784947850478514785247853478544785547856478574785847859478604786147862478634786447865478664786747868478694787047871478724787347874478754787647877478784787947880478814788247883478844788547886478874788847889478904789147892478934789447895478964789747898478994790047901479024790347904479054790647907479084790947910479114791247913479144791547916479174791847919479204792147922479234792447925479264792747928479294793047931479324793347934479354793647937479384793947940479414794247943479444794547946479474794847949479504795147952479534795447955479564795747958479594796047961479624796347964479654796647967479684796947970479714797247973479744797547976479774797847979479804798147982479834798447985479864798747988479894799047991479924799347994479954799647997479984799948000480014800248003480044800548006480074800848009480104801148012480134801448015480164801748018480194802048021480224802348024480254802648027480284802948030480314803248033480344803548036480374803848039480404804148042480434804448045480464804748048480494805048051480524805348054480554805648057480584805948060480614806248063480644806548066480674806848069480704807148072480734807448075480764807748078480794808048081480824808348084480854808648087480884808948090480914809248093480944809548096480974809848099481004810148102481034810448105481064810748108481094811048111481124811348114481154811648117481184811948120481214812248123481244812548126481274812848129481304813148132481334813448135481364813748138481394814048141481424814348144481454814648147481484814948150481514815248153481544815548156481574815848159481604816148162481634816448165481664816748168481694817048171481724817348174481754817648177481784817948180481814818248183481844818548186481874818848189481904819148192481934819448195481964819748198481994820048201482024820348204482054820648207482084820948210482114821248213482144821548216482174821848219482204822148222482234822448225482264822748228482294823048231482324823348234482354823648237482384823948240482414824248243482444824548246482474824848249482504825148252482534825448255482564825748258482594826048261482624826348264482654826648267482684826948270482714827248273482744827548276482774827848279482804828148282482834828448285482864828748288482894829048291482924829348294482954829648297482984829948300483014830248303483044830548306483074830848309483104831148312483134831448315483164831748318483194832048321483224832348324483254832648327483284832948330483314833248333483344833548336483374833848339483404834148342483434834448345483464834748348483494835048351483524835348354483554835648357483584835948360483614836248363483644836548366483674836848369483704837148372483734837448375483764837748378483794838048381483824838348384483854838648387483884838948390483914839248393483944839548396483974839848399484004840148402484034840448405484064840748408484094841048411484124841348414484154841648417484184841948420484214842248423484244842548426484274842848429484304843148432484334843448435484364843748438484394844048441484424844348444484454844648447484484844948450484514845248453484544845548456484574845848459484604846148462484634846448465484664846748468484694847048471484724847348474484754847648477484784847948480484814848248483484844848548486484874848848489484904849148492484934849448495484964849748498484994850048501485024850348504485054850648507485084850948510485114851248513485144851548516485174851848519485204852148522485234852448525485264852748528485294853048531485324853348534485354853648537485384853948540485414854248543485444854548546485474854848549485504855148552485534855448555485564855748558485594856048561485624856348564485654856648567485684856948570485714857248573485744857548576485774857848579485804858148582485834858448585485864858748588485894859048591485924859348594485954859648597485984859948600486014860248603486044860548606486074860848609486104861148612486134861448615486164861748618486194862048621486224862348624486254862648627486284862948630486314863248633486344863548636486374863848639486404864148642486434864448645486464864748648486494865048651486524865348654486554865648657486584865948660486614866248663486644866548666486674866848669486704867148672486734867448675486764867748678486794868048681486824868348684486854868648687486884868948690486914869248693486944869548696486974869848699487004870148702487034870448705487064870748708487094871048711487124871348714487154871648717487184871948720487214872248723487244872548726487274872848729487304873148732487334873448735487364873748738487394874048741487424874348744487454874648747487484874948750487514875248753487544875548756487574875848759487604876148762487634876448765487664876748768487694877048771487724877348774487754877648777487784877948780487814878248783487844878548786487874878848789487904879148792487934879448795487964879748798487994880048801488024880348804488054880648807488084880948810488114881248813488144881548816488174881848819488204882148822488234882448825488264882748828488294883048831488324883348834488354883648837488384883948840488414884248843488444884548846488474884848849488504885148852488534885448855488564885748858488594886048861488624886348864488654886648867488684886948870488714887248873488744887548876488774887848879488804888148882488834888448885488864888748888488894889048891488924889348894488954889648897488984889948900489014890248903489044890548906489074890848909489104891148912489134891448915489164891748918489194892048921489224892348924489254892648927489284892948930489314893248933489344893548936489374893848939489404894148942489434894448945489464894748948489494895048951489524895348954489554895648957489584895948960489614896248963489644896548966489674896848969489704897148972489734897448975489764897748978489794898048981489824898348984489854898648987489884898948990489914899248993489944899548996489974899848999490004900149002490034900449005490064900749008490094901049011490124901349014490154901649017490184901949020490214902249023490244902549026490274902849029490304903149032490334903449035490364903749038490394904049041490424904349044490454904649047490484904949050490514905249053490544905549056490574905849059490604906149062490634906449065490664906749068490694907049071490724907349074490754907649077490784907949080490814908249083490844908549086490874908849089490904909149092490934909449095490964909749098490994910049101491024910349104491054910649107491084910949110491114911249113491144911549116491174911849119491204912149122491234912449125491264912749128491294913049131491324913349134491354913649137491384913949140491414914249143491444914549146491474914849149491504915149152491534915449155491564915749158491594916049161491624916349164491654916649167491684916949170491714917249173491744917549176491774917849179491804918149182491834918449185491864918749188491894919049191491924919349194491954919649197491984919949200492014920249203492044920549206492074920849209492104921149212492134921449215492164921749218492194922049221492224922349224492254922649227492284922949230492314923249233492344923549236492374923849239492404924149242492434924449245492464924749248492494925049251492524925349254492554925649257492584925949260492614926249263492644926549266492674926849269492704927149272492734927449275492764927749278492794928049281492824928349284492854928649287492884928949290492914929249293492944929549296492974929849299493004930149302493034930449305493064930749308493094931049311493124931349314493154931649317493184931949320493214932249323493244932549326493274932849329493304933149332493334933449335493364933749338493394934049341493424934349344493454934649347493484934949350493514935249353493544935549356493574935849359493604936149362493634936449365493664936749368493694937049371493724937349374493754937649377493784937949380493814938249383493844938549386493874938849389493904939149392493934939449395493964939749398493994940049401494024940349404494054940649407494084940949410494114941249413494144941549416494174941849419494204942149422494234942449425494264942749428494294943049431494324943349434494354943649437494384943949440494414944249443494444944549446494474944849449494504945149452494534945449455494564945749458494594946049461494624946349464494654946649467494684946949470494714947249473494744947549476494774947849479494804948149482494834948449485494864948749488494894949049491494924949349494494954949649497494984949949500495014950249503495044950549506495074950849509495104951149512495134951449515495164951749518495194952049521495224952349524495254952649527495284952949530495314953249533495344953549536495374953849539495404954149542495434954449545495464954749548495494955049551495524955349554495554955649557495584955949560495614956249563495644956549566495674956849569495704957149572495734957449575495764957749578495794958049581495824958349584495854958649587495884958949590495914959249593495944959549596495974959849599496004960149602496034960449605496064960749608496094961049611496124961349614496154961649617496184961949620496214962249623496244962549626496274962849629496304963149632496334963449635496364963749638496394964049641496424964349644496454964649647496484964949650496514965249653496544965549656496574965849659496604966149662496634966449665496664966749668496694967049671496724967349674496754967649677496784967949680496814968249683496844968549686496874968849689496904969149692496934969449695496964969749698496994970049701497024970349704497054970649707497084970949710497114971249713497144971549716497174971849719497204972149722497234972449725497264972749728497294973049731497324973349734497354973649737497384973949740497414974249743497444974549746497474974849749497504975149752497534975449755497564975749758497594976049761497624976349764497654976649767497684976949770497714977249773497744977549776497774977849779497804978149782497834978449785497864978749788497894979049791497924979349794497954979649797497984979949800498014980249803498044980549806498074980849809498104981149812498134981449815498164981749818498194982049821498224982349824498254982649827498284982949830498314983249833498344983549836498374983849839498404984149842498434984449845498464984749848498494985049851498524985349854498554985649857498584985949860498614986249863498644986549866498674986849869498704987149872498734987449875498764987749878498794988049881498824988349884498854988649887498884988949890498914989249893498944989549896498974989849899499004990149902499034990449905499064990749908499094991049911499124991349914499154991649917499184991949920499214992249923499244992549926499274992849929499304993149932499334993449935499364993749938499394994049941499424994349944499454994649947499484994949950499514995249953499544995549956499574995849959499604996149962499634996449965499664996749968499694997049971499724997349974499754997649977499784997949980499814998249983499844998549986499874998849989499904999149992499934999449995499964999749998499995000050001500025000350004500055000650007500085000950010500115001250013500145001550016500175001850019500205002150022500235002450025500265002750028500295003050031500325003350034500355003650037500385003950040500415004250043500445004550046500475004850049500505005150052500535005450055500565005750058500595006050061500625006350064500655006650067500685006950070500715007250073500745007550076500775007850079500805008150082500835008450085500865008750088500895009050091500925009350094500955009650097500985009950100501015010250103501045010550106501075010850109501105011150112501135011450115501165011750118501195012050121501225012350124501255012650127501285012950130501315013250133501345013550136501375013850139501405014150142501435014450145501465014750148501495015050151501525015350154501555015650157501585015950160501615016250163501645016550166501675016850169501705017150172501735017450175501765017750178501795018050181501825018350184501855018650187501885018950190501915019250193501945019550196501975019850199502005020150202502035020450205502065020750208502095021050211502125021350214502155021650217502185021950220502215022250223502245022550226502275022850229502305023150232502335023450235502365023750238502395024050241502425024350244502455024650247502485024950250502515025250253502545025550256502575025850259502605026150262502635026450265502665026750268502695027050271502725027350274502755027650277502785027950280502815028250283502845028550286502875028850289502905029150292502935029450295502965029750298502995030050301503025030350304503055030650307503085030950310503115031250313503145031550316503175031850319503205032150322503235032450325503265032750328503295033050331503325033350334503355033650337503385033950340503415034250343503445034550346503475034850349503505035150352503535035450355503565035750358503595036050361503625036350364503655036650367503685036950370503715037250373503745037550376503775037850379503805038150382503835038450385503865038750388503895039050391503925039350394503955039650397503985039950400504015040250403504045040550406504075040850409504105041150412504135041450415504165041750418504195042050421504225042350424504255042650427504285042950430504315043250433504345043550436504375043850439504405044150442504435044450445504465044750448504495045050451504525045350454504555045650457504585045950460504615046250463504645046550466504675046850469504705047150472504735047450475504765047750478504795048050481504825048350484504855048650487504885048950490504915049250493504945049550496504975049850499505005050150502505035050450505505065050750508505095051050511505125051350514505155051650517505185051950520505215052250523505245052550526505275052850529505305053150532505335053450535505365053750538505395054050541505425054350544505455054650547505485054950550505515055250553505545055550556505575055850559505605056150562505635056450565505665056750568505695057050571505725057350574505755057650577505785057950580505815058250583505845058550586505875058850589505905059150592505935059450595505965059750598505995060050601506025060350604506055060650607506085060950610506115061250613506145061550616506175061850619506205062150622506235062450625506265062750628506295063050631506325063350634506355063650637506385063950640506415064250643506445064550646506475064850649506505065150652506535065450655506565065750658506595066050661506625066350664506655066650667506685066950670506715067250673506745067550676506775067850679506805068150682506835068450685506865068750688506895069050691506925069350694506955069650697506985069950700507015070250703507045070550706507075070850709507105071150712507135071450715507165071750718507195072050721507225072350724507255072650727507285072950730507315073250733507345073550736507375073850739507405074150742507435074450745507465074750748507495075050751507525075350754507555075650757507585075950760507615076250763507645076550766507675076850769507705077150772507735077450775507765077750778507795078050781507825078350784507855078650787507885078950790507915079250793507945079550796507975079850799508005080150802508035080450805508065080750808508095081050811508125081350814508155081650817508185081950820508215082250823508245082550826508275082850829508305083150832508335083450835508365083750838508395084050841508425084350844508455084650847508485084950850508515085250853508545085550856508575085850859508605086150862508635086450865508665086750868508695087050871508725087350874508755087650877508785087950880508815088250883508845088550886508875088850889508905089150892508935089450895508965089750898508995090050901509025090350904509055090650907509085090950910509115091250913509145091550916509175091850919509205092150922509235092450925509265092750928509295093050931509325093350934509355093650937509385093950940509415094250943509445094550946509475094850949509505095150952509535095450955509565095750958509595096050961509625096350964509655096650967509685096950970509715097250973509745097550976509775097850979509805098150982509835098450985509865098750988509895099050991509925099350994509955099650997509985099951000510015100251003510045100551006510075100851009510105101151012510135101451015510165101751018510195102051021510225102351024510255102651027510285102951030510315103251033510345103551036510375103851039510405104151042510435104451045510465104751048510495105051051510525105351054510555105651057510585105951060510615106251063510645106551066510675106851069510705107151072510735107451075510765107751078510795108051081510825108351084510855108651087510885108951090510915109251093510945109551096510975109851099511005110151102511035110451105511065110751108511095111051111511125111351114511155111651117511185111951120511215112251123511245112551126511275112851129511305113151132511335113451135511365113751138511395114051141511425114351144511455114651147511485114951150511515115251153511545115551156511575115851159511605116151162511635116451165511665116751168511695117051171511725117351174511755117651177511785117951180511815118251183511845118551186511875118851189511905119151192511935119451195511965119751198511995120051201512025120351204512055120651207512085120951210512115121251213512145121551216512175121851219512205122151222512235122451225512265122751228512295123051231512325123351234512355123651237512385123951240512415124251243512445124551246512475124851249512505125151252512535125451255512565125751258512595126051261512625126351264512655126651267512685126951270512715127251273512745127551276512775127851279512805128151282512835128451285512865128751288512895129051291512925129351294512955129651297512985129951300513015130251303513045130551306513075130851309513105131151312513135131451315513165131751318513195132051321513225132351324513255132651327513285132951330513315133251333513345133551336513375133851339513405134151342513435134451345513465134751348513495135051351513525135351354513555135651357513585135951360513615136251363513645136551366513675136851369513705137151372513735137451375513765137751378513795138051381513825138351384513855138651387513885138951390513915139251393513945139551396513975139851399514005140151402514035140451405514065140751408514095141051411514125141351414514155141651417514185141951420514215142251423514245142551426514275142851429514305143151432514335143451435514365143751438514395144051441514425144351444514455144651447514485144951450514515145251453514545145551456514575145851459514605146151462514635146451465514665146751468514695147051471514725147351474514755147651477514785147951480514815148251483514845148551486514875148851489514905149151492514935149451495514965149751498514995150051501515025150351504515055150651507515085150951510515115151251513515145151551516515175151851519515205152151522515235152451525515265152751528515295153051531515325153351534515355153651537515385153951540515415154251543515445154551546515475154851549515505155151552515535155451555515565155751558515595156051561515625156351564515655156651567515685156951570515715157251573515745157551576515775157851579515805158151582515835158451585515865158751588515895159051591515925159351594515955159651597515985159951600516015160251603516045160551606516075160851609516105161151612516135161451615516165161751618516195162051621516225162351624516255162651627516285162951630516315163251633516345163551636516375163851639516405164151642516435164451645516465164751648516495165051651516525165351654516555165651657516585165951660516615166251663516645166551666516675166851669516705167151672516735167451675516765167751678516795168051681516825168351684516855168651687516885168951690516915169251693516945169551696516975169851699517005170151702517035170451705517065170751708517095171051711517125171351714517155171651717517185171951720517215172251723517245172551726517275172851729517305173151732517335173451735517365173751738517395174051741517425174351744517455174651747517485174951750517515175251753517545175551756517575175851759517605176151762517635176451765517665176751768517695177051771517725177351774517755177651777517785177951780517815178251783517845178551786517875178851789517905179151792517935179451795517965179751798517995180051801518025180351804518055180651807518085180951810518115181251813518145181551816518175181851819518205182151822518235182451825518265182751828518295183051831518325183351834518355183651837518385183951840518415184251843518445184551846518475184851849518505185151852518535185451855518565185751858518595186051861518625186351864518655186651867518685186951870518715187251873518745187551876518775187851879518805188151882518835188451885518865188751888518895189051891518925189351894518955189651897518985189951900519015190251903519045190551906519075190851909519105191151912519135191451915519165191751918519195192051921519225192351924519255192651927519285192951930519315193251933519345193551936519375193851939519405194151942519435194451945519465194751948519495195051951519525195351954519555195651957519585195951960519615196251963519645196551966519675196851969519705197151972519735197451975519765197751978519795198051981519825198351984519855198651987519885198951990519915199251993519945199551996519975199851999520005200152002520035200452005520065200752008520095201052011520125201352014520155201652017520185201952020520215202252023520245202552026520275202852029520305203152032520335203452035520365203752038520395204052041520425204352044520455204652047520485204952050520515205252053520545205552056520575205852059520605206152062520635206452065520665206752068520695207052071520725207352074520755207652077520785207952080520815208252083520845208552086520875208852089520905209152092520935209452095520965209752098520995210052101521025210352104521055210652107521085210952110521115211252113521145211552116521175211852119521205212152122521235212452125521265212752128521295213052131521325213352134521355213652137521385213952140521415214252143521445214552146521475214852149521505215152152521535215452155521565215752158521595216052161521625216352164521655216652167521685216952170521715217252173521745217552176521775217852179521805218152182521835218452185521865218752188521895219052191521925219352194521955219652197521985219952200522015220252203522045220552206522075220852209522105221152212522135221452215522165221752218522195222052221522225222352224522255222652227522285222952230522315223252233522345223552236522375223852239522405224152242522435224452245522465224752248522495225052251522525225352254522555225652257522585225952260522615226252263522645226552266522675226852269522705227152272522735227452275522765227752278522795228052281522825228352284522855228652287522885228952290522915229252293522945229552296522975229852299523005230152302523035230452305523065230752308523095231052311523125231352314523155231652317523185231952320523215232252323523245232552326523275232852329523305233152332523335233452335523365233752338523395234052341523425234352344523455234652347523485234952350523515235252353523545235552356523575235852359523605236152362523635236452365523665236752368523695237052371523725237352374523755237652377523785237952380523815238252383523845238552386523875238852389523905239152392523935239452395523965239752398523995240052401524025240352404524055240652407524085240952410524115241252413524145241552416524175241852419524205242152422524235242452425524265242752428524295243052431524325243352434524355243652437524385243952440524415244252443524445244552446524475244852449524505245152452524535245452455524565245752458524595246052461524625246352464524655246652467524685246952470524715247252473524745247552476524775247852479524805248152482524835248452485524865248752488524895249052491524925249352494524955249652497524985249952500525015250252503525045250552506525075250852509525105251152512525135251452515525165251752518525195252052521525225252352524525255252652527525285252952530525315253252533525345253552536525375253852539525405254152542525435254452545525465254752548525495255052551525525255352554525555255652557525585255952560525615256252563525645256552566525675256852569525705257152572525735257452575525765257752578525795258052581525825258352584525855258652587525885258952590525915259252593525945259552596525975259852599526005260152602526035260452605526065260752608526095261052611526125261352614526155261652617526185261952620526215262252623526245262552626526275262852629526305263152632526335263452635526365263752638526395264052641526425264352644526455264652647526485264952650526515265252653526545265552656526575265852659526605266152662526635266452665526665266752668526695267052671526725267352674526755267652677526785267952680526815268252683526845268552686526875268852689526905269152692526935269452695526965269752698526995270052701527025270352704527055270652707527085270952710527115271252713527145271552716527175271852719527205272152722527235272452725527265272752728527295273052731527325273352734527355273652737527385273952740527415274252743527445274552746527475274852749527505275152752527535275452755527565275752758527595276052761527625276352764527655276652767527685276952770527715277252773527745277552776527775277852779527805278152782527835278452785527865278752788527895279052791527925279352794527955279652797527985279952800528015280252803528045280552806528075280852809528105281152812528135281452815528165281752818528195282052821528225282352824528255282652827528285282952830528315283252833528345283552836528375283852839528405284152842528435284452845528465284752848528495285052851528525285352854528555285652857528585285952860528615286252863528645286552866528675286852869528705287152872528735287452875528765287752878528795288052881528825288352884528855288652887528885288952890528915289252893528945289552896528975289852899529005290152902529035290452905529065290752908529095291052911529125291352914529155291652917529185291952920529215292252923529245292552926529275292852929529305293152932529335293452935529365293752938529395294052941529425294352944529455294652947529485294952950529515295252953529545295552956529575295852959529605296152962529635296452965529665296752968529695297052971529725297352974529755297652977529785297952980529815298252983529845298552986529875298852989529905299152992529935299452995529965299752998529995300053001530025300353004530055300653007530085300953010530115301253013530145301553016530175301853019530205302153022530235302453025530265302753028530295303053031530325303353034530355303653037530385303953040530415304253043530445304553046530475304853049530505305153052530535305453055530565305753058530595306053061530625306353064530655306653067530685306953070530715307253073530745307553076530775307853079530805308153082530835308453085530865308753088530895309053091530925309353094530955309653097530985309953100531015310253103531045310553106531075310853109531105311153112531135311453115531165311753118531195312053121531225312353124531255312653127531285312953130531315313253133531345313553136531375313853139531405314153142531435314453145531465314753148531495315053151531525315353154531555315653157531585315953160531615316253163531645316553166531675316853169531705317153172531735317453175531765317753178531795318053181531825318353184531855318653187531885318953190531915319253193531945319553196531975319853199532005320153202532035320453205532065320753208532095321053211532125321353214532155321653217532185321953220532215322253223532245322553226532275322853229532305323153232532335323453235532365323753238532395324053241532425324353244532455324653247532485324953250532515325253253532545325553256532575325853259532605326153262532635326453265532665326753268532695327053271532725327353274532755327653277532785327953280532815328253283532845328553286532875328853289532905329153292532935329453295532965329753298532995330053301533025330353304533055330653307533085330953310533115331253313533145331553316533175331853319533205332153322533235332453325533265332753328533295333053331533325333353334533355333653337533385333953340533415334253343533445334553346533475334853349533505335153352533535335453355533565335753358533595336053361533625336353364533655336653367533685336953370533715337253373533745337553376533775337853379533805338153382533835338453385533865338753388533895339053391533925339353394533955339653397533985339953400534015340253403534045340553406534075340853409534105341153412534135341453415534165341753418534195342053421534225342353424534255342653427534285342953430534315343253433534345343553436534375343853439534405344153442534435344453445534465344753448534495345053451534525345353454534555345653457534585345953460534615346253463534645346553466534675346853469534705347153472534735347453475534765347753478534795348053481534825348353484534855348653487534885348953490534915349253493534945349553496534975349853499535005350153502535035350453505535065350753508535095351053511535125351353514535155351653517535185351953520535215352253523535245352553526535275352853529535305353153532535335353453535535365353753538535395354053541535425354353544535455354653547535485354953550535515355253553535545355553556535575355853559535605356153562535635356453565535665356753568535695357053571535725357353574535755357653577535785357953580535815358253583535845358553586535875358853589535905359153592535935359453595535965359753598535995360053601536025360353604536055360653607536085360953610536115361253613536145361553616536175361853619536205362153622536235362453625536265362753628536295363053631536325363353634536355363653637536385363953640536415364253643536445364553646536475364853649536505365153652536535365453655536565365753658536595366053661536625366353664536655366653667536685366953670536715367253673536745367553676536775367853679536805368153682536835368453685536865368753688536895369053691536925369353694536955369653697536985369953700537015370253703537045370553706537075370853709537105371153712537135371453715537165371753718537195372053721537225372353724537255372653727537285372953730537315373253733537345373553736537375373853739537405374153742537435374453745537465374753748537495375053751537525375353754537555375653757537585375953760537615376253763537645376553766537675376853769537705377153772537735377453775537765377753778537795378053781537825378353784537855378653787537885378953790537915379253793537945379553796537975379853799538005380153802538035380453805538065380753808538095381053811538125381353814538155381653817538185381953820538215382253823538245382553826538275382853829538305383153832538335383453835538365383753838538395384053841538425384353844538455384653847538485384953850538515385253853538545385553856538575385853859538605386153862538635386453865538665386753868538695387053871538725387353874538755387653877538785387953880538815388253883538845388553886538875388853889538905389153892538935389453895538965389753898538995390053901539025390353904539055390653907539085390953910539115391253913539145391553916539175391853919539205392153922539235392453925539265392753928539295393053931539325393353934539355393653937539385393953940539415394253943539445394553946539475394853949539505395153952539535395453955539565395753958539595396053961539625396353964539655396653967539685396953970539715397253973539745397553976539775397853979539805398153982539835398453985539865398753988539895399053991539925399353994539955399653997539985399954000540015400254003540045400554006540075400854009540105401154012540135401454015540165401754018540195402054021540225402354024540255402654027540285402954030540315403254033540345403554036540375403854039540405404154042540435404454045540465404754048540495405054051540525405354054540555405654057540585405954060540615406254063540645406554066540675406854069540705407154072540735407454075540765407754078540795408054081540825408354084540855408654087540885408954090540915409254093540945409554096540975409854099541005410154102541035410454105541065410754108541095411054111541125411354114541155411654117541185411954120541215412254123541245412554126541275412854129541305413154132541335413454135541365413754138541395414054141541425414354144541455414654147541485414954150541515415254153541545415554156541575415854159541605416154162541635416454165541665416754168541695417054171541725417354174541755417654177541785417954180541815418254183541845418554186541875418854189541905419154192541935419454195541965419754198541995420054201542025420354204542055420654207542085420954210542115421254213542145421554216542175421854219542205422154222542235422454225542265422754228542295423054231542325423354234542355423654237542385423954240542415424254243542445424554246542475424854249542505425154252542535425454255542565425754258542595426054261542625426354264542655426654267542685426954270542715427254273542745427554276542775427854279542805428154282542835428454285542865428754288542895429054291542925429354294542955429654297542985429954300543015430254303543045430554306543075430854309543105431154312543135431454315543165431754318543195432054321543225432354324543255432654327543285432954330543315433254333543345433554336543375433854339543405434154342543435434454345543465434754348543495435054351543525435354354543555435654357543585435954360543615436254363543645436554366543675436854369543705437154372543735437454375543765437754378543795438054381543825438354384543855438654387543885438954390543915439254393543945439554396543975439854399544005440154402544035440454405544065440754408544095441054411544125441354414544155441654417544185441954420544215442254423544245442554426544275442854429544305443154432544335443454435544365443754438544395444054441544425444354444544455444654447544485444954450544515445254453544545445554456544575445854459544605446154462544635446454465544665446754468544695447054471544725447354474544755447654477544785447954480544815448254483544845448554486544875448854489544905449154492544935449454495544965449754498544995450054501545025450354504545055450654507545085450954510545115451254513545145451554516545175451854519545205452154522545235452454525545265452754528545295453054531545325453354534545355453654537545385453954540545415454254543545445454554546545475454854549545505455154552545535455454555545565455754558545595456054561545625456354564545655456654567545685456954570545715457254573545745457554576545775457854579545805458154582545835458454585545865458754588545895459054591545925459354594545955459654597545985459954600546015460254603546045460554606546075460854609546105461154612546135461454615546165461754618546195462054621546225462354624546255462654627546285462954630546315463254633546345463554636546375463854639546405464154642546435464454645546465464754648546495465054651546525465354654546555465654657546585465954660546615466254663546645466554666546675466854669546705467154672546735467454675546765467754678546795468054681546825468354684546855468654687546885468954690546915469254693546945469554696546975469854699547005470154702547035470454705547065470754708547095471054711547125471354714547155471654717547185471954720547215472254723547245472554726547275472854729547305473154732547335473454735547365473754738547395474054741547425474354744547455474654747547485474954750547515475254753547545475554756547575475854759547605476154762547635476454765547665476754768547695477054771547725477354774547755477654777547785477954780547815478254783547845478554786547875478854789547905479154792547935479454795547965479754798547995480054801548025480354804548055480654807548085480954810548115481254813548145481554816548175481854819548205482154822548235482454825548265482754828548295483054831548325483354834548355483654837548385483954840548415484254843548445484554846548475484854849548505485154852548535485454855548565485754858548595486054861548625486354864548655486654867548685486954870548715487254873548745487554876548775487854879548805488154882548835488454885548865488754888548895489054891548925489354894548955489654897548985489954900549015490254903549045490554906549075490854909549105491154912549135491454915549165491754918549195492054921549225492354924549255492654927549285492954930549315493254933549345493554936549375493854939549405494154942549435494454945549465494754948549495495054951549525495354954549555495654957549585495954960549615496254963549645496554966549675496854969549705497154972549735497454975549765497754978549795498054981549825498354984549855498654987549885498954990549915499254993549945499554996549975499854999550005500155002550035500455005550065500755008550095501055011550125501355014550155501655017550185501955020550215502255023550245502555026550275502855029550305503155032550335503455035550365503755038550395504055041550425504355044550455504655047550485504955050550515505255053550545505555056550575505855059550605506155062550635506455065550665506755068550695507055071550725507355074550755507655077550785507955080550815508255083550845508555086550875508855089550905509155092550935509455095550965509755098550995510055101551025510355104551055510655107551085510955110551115511255113551145511555116551175511855119551205512155122551235512455125551265512755128551295513055131551325513355134551355513655137551385513955140551415514255143551445514555146551475514855149551505515155152551535515455155551565515755158551595516055161551625516355164551655516655167551685516955170551715517255173551745517555176551775517855179551805518155182551835518455185551865518755188551895519055191551925519355194551955519655197551985519955200552015520255203552045520555206552075520855209552105521155212552135521455215552165521755218552195522055221552225522355224552255522655227552285522955230552315523255233552345523555236552375523855239552405524155242552435524455245552465524755248552495525055251552525525355254552555525655257552585525955260552615526255263552645526555266552675526855269552705527155272552735527455275552765527755278552795528055281552825528355284552855528655287552885528955290552915529255293552945529555296552975529855299553005530155302553035530455305553065530755308553095531055311553125531355314553155531655317553185531955320553215532255323553245532555326553275532855329553305533155332553335533455335553365533755338553395534055341553425534355344553455534655347553485534955350553515535255353553545535555356553575535855359553605536155362553635536455365553665536755368553695537055371553725537355374553755537655377553785537955380553815538255383553845538555386553875538855389553905539155392553935539455395553965539755398553995540055401554025540355404554055540655407554085540955410554115541255413554145541555416554175541855419554205542155422554235542455425554265542755428554295543055431554325543355434554355543655437554385543955440554415544255443554445544555446554475544855449554505545155452554535545455455554565545755458554595546055461554625546355464554655546655467554685546955470554715547255473554745547555476554775547855479554805548155482554835548455485554865548755488554895549055491554925549355494554955549655497554985549955500555015550255503555045550555506555075550855509555105551155512555135551455515555165551755518555195552055521555225552355524555255552655527555285552955530555315553255533555345553555536555375553855539555405554155542555435554455545555465554755548555495555055551555525555355554555555555655557555585555955560555615556255563555645556555566555675556855569555705557155572555735557455575555765557755578555795558055581555825558355584555855558655587555885558955590555915559255593555945559555596555975559855599556005560155602556035560455605556065560755608556095561055611556125561355614556155561655617556185561955620556215562255623556245562555626556275562855629556305563155632556335563455635556365563755638556395564055641556425564355644556455564655647556485564955650556515565255653556545565555656556575565855659556605566155662556635566455665556665566755668556695567055671556725567355674556755567655677556785567955680556815568255683556845568555686556875568855689556905569155692556935569455695556965569755698556995570055701557025570355704557055570655707557085570955710557115571255713557145571555716557175571855719557205572155722557235572455725557265572755728557295573055731557325573355734557355573655737557385573955740557415574255743557445574555746557475574855749557505575155752557535575455755557565575755758557595576055761557625576355764557655576655767557685576955770557715577255773557745577555776557775577855779557805578155782557835578455785557865578755788557895579055791557925579355794557955579655797557985579955800558015580255803558045580555806558075580855809558105581155812558135581455815558165581755818558195582055821558225582355824558255582655827558285582955830558315583255833558345583555836558375583855839558405584155842558435584455845558465584755848558495585055851558525585355854558555585655857558585585955860558615586255863558645586555866558675586855869558705587155872558735587455875558765587755878558795588055881558825588355884558855588655887558885588955890558915589255893558945589555896558975589855899559005590155902559035590455905559065590755908559095591055911559125591355914559155591655917559185591955920559215592255923559245592555926559275592855929559305593155932559335593455935559365593755938559395594055941559425594355944559455594655947559485594955950559515595255953559545595555956559575595855959559605596155962559635596455965559665596755968559695597055971559725597355974559755597655977559785597955980559815598255983559845598555986559875598855989559905599155992559935599455995559965599755998559995600056001560025600356004560055600656007560085600956010560115601256013560145601556016560175601856019560205602156022560235602456025560265602756028560295603056031560325603356034560355603656037560385603956040560415604256043560445604556046560475604856049560505605156052560535605456055560565605756058560595606056061560625606356064560655606656067560685606956070560715607256073560745607556076560775607856079560805608156082560835608456085560865608756088560895609056091560925609356094560955609656097560985609956100561015610256103561045610556106561075610856109561105611156112561135611456115561165611756118561195612056121561225612356124561255612656127561285612956130561315613256133561345613556136561375613856139561405614156142561435614456145561465614756148561495615056151561525615356154561555615656157561585615956160561615616256163561645616556166561675616856169561705617156172561735617456175561765617756178561795618056181561825618356184561855618656187561885618956190561915619256193561945619556196561975619856199562005620156202562035620456205562065620756208562095621056211562125621356214562155621656217562185621956220562215622256223562245622556226562275622856229562305623156232562335623456235562365623756238562395624056241562425624356244562455624656247562485624956250562515625256253562545625556256562575625856259562605626156262562635626456265562665626756268562695627056271562725627356274562755627656277562785627956280562815628256283562845628556286562875628856289562905629156292562935629456295562965629756298562995630056301563025630356304563055630656307563085630956310563115631256313563145631556316563175631856319563205632156322563235632456325563265632756328563295633056331563325633356334563355633656337563385633956340563415634256343563445634556346563475634856349563505635156352563535635456355563565635756358563595636056361563625636356364563655636656367563685636956370563715637256373563745637556376563775637856379563805638156382563835638456385563865638756388563895639056391563925639356394563955639656397563985639956400564015640256403564045640556406564075640856409564105641156412564135641456415564165641756418564195642056421564225642356424564255642656427564285642956430564315643256433564345643556436564375643856439564405644156442564435644456445564465644756448564495645056451564525645356454564555645656457564585645956460564615646256463564645646556466564675646856469564705647156472564735647456475564765647756478564795648056481564825648356484564855648656487564885648956490564915649256493564945649556496564975649856499565005650156502565035650456505565065650756508565095651056511565125651356514565155651656517565185651956520565215652256523565245652556526565275652856529565305653156532565335653456535565365653756538565395654056541565425654356544565455654656547565485654956550565515655256553565545655556556565575655856559565605656156562565635656456565565665656756568565695657056571565725657356574565755657656577565785657956580565815658256583565845658556586565875658856589565905659156592565935659456595565965659756598565995660056601566025660356604566055660656607566085660956610566115661256613566145661556616566175661856619566205662156622566235662456625566265662756628566295663056631566325663356634566355663656637566385663956640566415664256643566445664556646566475664856649566505665156652566535665456655566565665756658566595666056661566625666356664566655666656667566685666956670566715667256673566745667556676566775667856679566805668156682566835668456685566865668756688566895669056691566925669356694566955669656697566985669956700567015670256703567045670556706567075670856709567105671156712567135671456715567165671756718567195672056721567225672356724567255672656727567285672956730567315673256733567345673556736567375673856739567405674156742567435674456745567465674756748567495675056751567525675356754567555675656757567585675956760567615676256763567645676556766567675676856769567705677156772567735677456775567765677756778567795678056781567825678356784567855678656787567885678956790567915679256793567945679556796567975679856799568005680156802568035680456805568065680756808568095681056811568125681356814568155681656817568185681956820568215682256823568245682556826568275682856829568305683156832568335683456835568365683756838568395684056841568425684356844568455684656847568485684956850568515685256853568545685556856568575685856859568605686156862568635686456865568665686756868568695687056871568725687356874568755687656877568785687956880568815688256883568845688556886568875688856889568905689156892568935689456895568965689756898568995690056901569025690356904569055690656907569085690956910569115691256913569145691556916569175691856919569205692156922569235692456925569265692756928569295693056931569325693356934569355693656937569385693956940569415694256943569445694556946569475694856949569505695156952569535695456955569565695756958569595696056961569625696356964569655696656967569685696956970569715697256973569745697556976569775697856979569805698156982569835698456985569865698756988569895699056991569925699356994569955699656997569985699957000570015700257003570045700557006570075700857009570105701157012570135701457015570165701757018570195702057021570225702357024570255702657027570285702957030570315703257033570345703557036570375703857039570405704157042570435704457045570465704757048570495705057051570525705357054570555705657057570585705957060570615706257063570645706557066570675706857069570705707157072570735707457075570765707757078570795708057081570825708357084570855708657087570885708957090570915709257093570945709557096570975709857099571005710157102571035710457105571065710757108571095711057111571125711357114571155711657117571185711957120571215712257123571245712557126571275712857129571305713157132571335713457135571365713757138571395714057141571425714357144571455714657147571485714957150571515715257153571545715557156571575715857159571605716157162571635716457165571665716757168571695717057171571725717357174571755717657177571785717957180571815718257183571845718557186571875718857189571905719157192571935719457195571965719757198571995720057201572025720357204572055720657207572085720957210572115721257213572145721557216572175721857219572205722157222572235722457225572265722757228572295723057231572325723357234572355723657237572385723957240572415724257243572445724557246572475724857249572505725157252572535725457255572565725757258572595726057261572625726357264572655726657267572685726957270572715727257273572745727557276572775727857279572805728157282572835728457285572865728757288572895729057291572925729357294572955729657297572985729957300573015730257303573045730557306573075730857309573105731157312573135731457315573165731757318573195732057321573225732357324573255732657327573285732957330573315733257333573345733557336573375733857339573405734157342573435734457345573465734757348573495735057351573525735357354573555735657357573585735957360573615736257363573645736557366573675736857369573705737157372573735737457375573765737757378573795738057381573825738357384573855738657387573885738957390573915739257393573945739557396573975739857399574005740157402574035740457405574065740757408574095741057411574125741357414574155741657417574185741957420574215742257423574245742557426574275742857429574305743157432574335743457435574365743757438574395744057441574425744357444574455744657447574485744957450574515745257453574545745557456574575745857459574605746157462574635746457465574665746757468574695747057471574725747357474574755747657477574785747957480574815748257483574845748557486574875748857489574905749157492574935749457495574965749757498574995750057501575025750357504575055750657507575085750957510575115751257513575145751557516575175751857519575205752157522575235752457525575265752757528575295753057531575325753357534575355753657537575385753957540575415754257543575445754557546575475754857549575505755157552575535755457555575565755757558575595756057561575625756357564575655756657567575685756957570575715757257573575745757557576575775757857579575805758157582575835758457585575865758757588575895759057591575925759357594575955759657597575985759957600576015760257603576045760557606576075760857609576105761157612576135761457615576165761757618576195762057621576225762357624576255762657627576285762957630576315763257633576345763557636576375763857639576405764157642576435764457645576465764757648576495765057651576525765357654576555765657657576585765957660576615766257663576645766557666576675766857669576705767157672576735767457675576765767757678576795768057681576825768357684576855768657687576885768957690576915769257693576945769557696576975769857699577005770157702577035770457705577065770757708577095771057711577125771357714577155771657717577185771957720577215772257723577245772557726577275772857729577305773157732577335773457735577365773757738577395774057741577425774357744577455774657747577485774957750577515775257753577545775557756577575775857759577605776157762577635776457765577665776757768577695777057771577725777357774577755777657777577785777957780577815778257783577845778557786577875778857789577905779157792577935779457795577965779757798577995780057801578025780357804578055780657807578085780957810578115781257813578145781557816578175781857819578205782157822578235782457825578265782757828578295783057831578325783357834578355783657837578385783957840578415784257843578445784557846578475784857849578505785157852578535785457855578565785757858578595786057861578625786357864578655786657867578685786957870578715787257873578745787557876578775787857879578805788157882578835788457885578865788757888578895789057891578925789357894578955789657897578985789957900579015790257903579045790557906579075790857909579105791157912579135791457915579165791757918579195792057921579225792357924579255792657927579285792957930579315793257933579345793557936579375793857939579405794157942579435794457945579465794757948579495795057951579525795357954579555795657957579585795957960579615796257963579645796557966579675796857969579705797157972579735797457975579765797757978579795798057981579825798357984579855798657987579885798957990579915799257993579945799557996579975799857999580005800158002580035800458005580065800758008580095801058011580125801358014580155801658017580185801958020580215802258023580245802558026580275802858029580305803158032580335803458035580365803758038580395804058041580425804358044580455804658047580485804958050580515805258053580545805558056580575805858059580605806158062580635806458065580665806758068580695807058071580725807358074580755807658077580785807958080580815808258083580845808558086580875808858089580905809158092580935809458095580965809758098580995810058101581025810358104581055810658107581085810958110581115811258113581145811558116581175811858119581205812158122581235812458125581265812758128581295813058131581325813358134581355813658137581385813958140581415814258143581445814558146581475814858149581505815158152581535815458155581565815758158581595816058161581625816358164581655816658167581685816958170581715817258173581745817558176581775817858179581805818158182581835818458185581865818758188581895819058191581925819358194581955819658197581985819958200582015820258203582045820558206582075820858209582105821158212582135821458215582165821758218582195822058221582225822358224582255822658227582285822958230582315823258233582345823558236582375823858239582405824158242582435824458245582465824758248582495825058251582525825358254582555825658257582585825958260582615826258263582645826558266582675826858269582705827158272582735827458275582765827758278582795828058281582825828358284582855828658287582885828958290582915829258293582945829558296582975829858299583005830158302583035830458305583065830758308583095831058311583125831358314583155831658317583185831958320583215832258323583245832558326583275832858329583305833158332583335833458335583365833758338583395834058341583425834358344583455834658347583485834958350583515835258353583545835558356583575835858359583605836158362583635836458365583665836758368583695837058371583725837358374583755837658377583785837958380583815838258383583845838558386583875838858389583905839158392583935839458395583965839758398583995840058401584025840358404584055840658407584085840958410584115841258413584145841558416584175841858419584205842158422584235842458425584265842758428584295843058431584325843358434584355843658437584385843958440584415844258443584445844558446584475844858449584505845158452584535845458455584565845758458584595846058461584625846358464584655846658467584685846958470584715847258473584745847558476584775847858479584805848158482584835848458485584865848758488584895849058491584925849358494584955849658497584985849958500585015850258503585045850558506585075850858509585105851158512585135851458515585165851758518585195852058521585225852358524585255852658527585285852958530585315853258533585345853558536585375853858539585405854158542585435854458545585465854758548585495855058551585525855358554585555855658557585585855958560585615856258563585645856558566585675856858569585705857158572585735857458575585765857758578585795858058581585825858358584585855858658587585885858958590585915859258593585945859558596585975859858599586005860158602586035860458605586065860758608586095861058611586125861358614586155861658617586185861958620586215862258623586245862558626586275862858629586305863158632586335863458635586365863758638586395864058641586425864358644586455864658647586485864958650586515865258653586545865558656586575865858659586605866158662586635866458665586665866758668586695867058671586725867358674586755867658677586785867958680586815868258683586845868558686586875868858689586905869158692586935869458695586965869758698586995870058701587025870358704587055870658707587085870958710587115871258713587145871558716587175871858719587205872158722587235872458725587265872758728587295873058731587325873358734587355873658737587385873958740587415874258743587445874558746587475874858749587505875158752587535875458755587565875758758587595876058761587625876358764587655876658767587685876958770587715877258773587745877558776587775877858779587805878158782587835878458785587865878758788587895879058791587925879358794587955879658797587985879958800588015880258803588045880558806588075880858809588105881158812588135881458815588165881758818588195882058821588225882358824588255882658827588285882958830588315883258833588345883558836588375883858839588405884158842588435884458845588465884758848588495885058851588525885358854588555885658857588585885958860588615886258863588645886558866588675886858869588705887158872588735887458875588765887758878588795888058881588825888358884588855888658887588885888958890588915889258893588945889558896588975889858899589005890158902589035890458905589065890758908589095891058911589125891358914589155891658917589185891958920589215892258923589245892558926589275892858929589305893158932589335893458935589365893758938589395894058941589425894358944589455894658947589485894958950589515895258953589545895558956589575895858959589605896158962589635896458965589665896758968589695897058971589725897358974589755897658977589785897958980589815898258983589845898558986589875898858989589905899158992589935899458995589965899758998589995900059001590025900359004590055900659007590085900959010590115901259013590145901559016590175901859019590205902159022590235902459025590265902759028590295903059031590325903359034590355903659037590385903959040590415904259043590445904559046590475904859049590505905159052590535905459055590565905759058590595906059061590625906359064590655906659067590685906959070590715907259073590745907559076590775907859079590805908159082590835908459085590865908759088590895909059091590925909359094590955909659097590985909959100591015910259103591045910559106591075910859109591105911159112591135911459115591165911759118591195912059121591225912359124591255912659127591285912959130591315913259133591345913559136591375913859139591405914159142591435914459145591465914759148591495915059151591525915359154591555915659157591585915959160591615916259163591645916559166591675916859169591705917159172591735917459175591765917759178591795918059181591825918359184591855918659187591885918959190591915919259193591945919559196591975919859199592005920159202592035920459205592065920759208592095921059211592125921359214592155921659217592185921959220592215922259223592245922559226592275922859229592305923159232592335923459235592365923759238592395924059241592425924359244592455924659247592485924959250592515925259253592545925559256592575925859259592605926159262592635926459265592665926759268592695927059271592725927359274592755927659277592785927959280592815928259283592845928559286592875928859289592905929159292592935929459295592965929759298592995930059301593025930359304593055930659307593085930959310593115931259313593145931559316593175931859319593205932159322593235932459325593265932759328593295933059331593325933359334593355933659337593385933959340593415934259343593445934559346593475934859349593505935159352593535935459355593565935759358593595936059361593625936359364593655936659367593685936959370593715937259373593745937559376593775937859379593805938159382593835938459385593865938759388593895939059391593925939359394593955939659397593985939959400594015940259403594045940559406594075940859409594105941159412594135941459415594165941759418594195942059421594225942359424594255942659427594285942959430594315943259433594345943559436594375943859439594405944159442594435944459445594465944759448594495945059451594525945359454594555945659457594585945959460594615946259463594645946559466594675946859469594705947159472594735947459475594765947759478594795948059481594825948359484594855948659487594885948959490594915949259493594945949559496594975949859499595005950159502595035950459505595065950759508595095951059511595125951359514595155951659517595185951959520595215952259523595245952559526595275952859529595305953159532595335953459535595365953759538595395954059541595425954359544595455954659547595485954959550595515955259553595545955559556595575955859559595605956159562595635956459565595665956759568595695957059571595725957359574595755957659577595785957959580595815958259583595845958559586595875958859589595905959159592595935959459595595965959759598595995960059601596025960359604596055960659607596085960959610596115961259613596145961559616596175961859619596205962159622596235962459625596265962759628596295963059631596325963359634596355963659637596385963959640596415964259643596445964559646596475964859649596505965159652596535965459655596565965759658596595966059661596625966359664596655966659667596685966959670596715967259673596745967559676596775967859679596805968159682596835968459685596865968759688596895969059691596925969359694596955969659697596985969959700597015970259703597045970559706597075970859709597105971159712597135971459715597165971759718597195972059721597225972359724597255972659727597285972959730597315973259733597345973559736597375973859739597405974159742597435974459745597465974759748597495975059751597525975359754597555975659757597585975959760597615976259763597645976559766597675976859769597705977159772597735977459775597765977759778597795978059781597825978359784597855978659787597885978959790597915979259793597945979559796597975979859799598005980159802598035980459805598065980759808598095981059811598125981359814598155981659817598185981959820598215982259823598245982559826598275982859829598305983159832598335983459835598365983759838598395984059841598425984359844598455984659847598485984959850598515985259853598545985559856598575985859859598605986159862598635986459865598665986759868598695987059871598725987359874598755987659877598785987959880598815988259883598845988559886598875988859889598905989159892598935989459895598965989759898598995990059901599025990359904599055990659907599085990959910599115991259913599145991559916599175991859919599205992159922599235992459925599265992759928599295993059931599325993359934599355993659937599385993959940599415994259943599445994559946599475994859949599505995159952599535995459955599565995759958599595996059961599625996359964599655996659967599685996959970599715997259973599745997559976599775997859979599805998159982599835998459985599865998759988599895999059991599925999359994599955999659997599985999960000600016000260003600046000560006600076000860009600106001160012600136001460015600166001760018600196002060021600226002360024600256002660027600286002960030600316003260033600346003560036600376003860039600406004160042600436004460045600466004760048600496005060051600526005360054600556005660057600586005960060600616006260063600646006560066600676006860069600706007160072600736007460075600766007760078600796008060081600826008360084600856008660087600886008960090600916009260093600946009560096600976009860099601006010160102601036010460105601066010760108601096011060111601126011360114601156011660117601186011960120601216012260123601246012560126601276012860129601306013160132601336013460135601366013760138601396014060141601426014360144601456014660147601486014960150601516015260153601546015560156601576015860159601606016160162601636016460165601666016760168601696017060171601726017360174601756017660177601786017960180601816018260183601846018560186601876018860189601906019160192601936019460195601966019760198601996020060201602026020360204602056020660207602086020960210602116021260213602146021560216602176021860219602206022160222602236022460225602266022760228602296023060231602326023360234602356023660237602386023960240602416024260243602446024560246602476024860249602506025160252602536025460255602566025760258602596026060261602626026360264602656026660267602686026960270602716027260273602746027560276602776027860279602806028160282602836028460285602866028760288602896029060291602926029360294602956029660297602986029960300603016030260303603046030560306603076030860309603106031160312603136031460315603166031760318603196032060321603226032360324603256032660327603286032960330603316033260333603346033560336603376033860339603406034160342603436034460345603466034760348603496035060351603526035360354603556035660357603586035960360603616036260363603646036560366603676036860369603706037160372603736037460375603766037760378603796038060381603826038360384603856038660387603886038960390603916039260393603946039560396603976039860399604006040160402604036040460405604066040760408604096041060411604126041360414604156041660417604186041960420604216042260423604246042560426604276042860429604306043160432604336043460435604366043760438604396044060441604426044360444604456044660447604486044960450604516045260453604546045560456604576045860459604606046160462604636046460465604666046760468604696047060471604726047360474604756047660477604786047960480604816048260483604846048560486604876048860489604906049160492604936049460495604966049760498604996050060501605026050360504605056050660507605086050960510605116051260513605146051560516605176051860519605206052160522605236052460525605266052760528605296053060531605326053360534605356053660537605386053960540605416054260543605446054560546605476054860549605506055160552605536055460555605566055760558605596056060561605626056360564605656056660567605686056960570605716057260573605746057560576605776057860579605806058160582605836058460585605866058760588605896059060591605926059360594605956059660597605986059960600606016060260603606046060560606606076060860609606106061160612606136061460615606166061760618606196062060621606226062360624606256062660627606286062960630606316063260633606346063560636606376063860639606406064160642606436064460645606466064760648606496065060651606526065360654606556065660657606586065960660606616066260663606646066560666606676066860669606706067160672606736067460675606766067760678606796068060681606826068360684606856068660687606886068960690606916069260693606946069560696606976069860699607006070160702607036070460705607066070760708607096071060711607126071360714607156071660717607186071960720607216072260723607246072560726607276072860729607306073160732607336073460735607366073760738607396074060741607426074360744607456074660747607486074960750607516075260753607546075560756607576075860759607606076160762607636076460765607666076760768607696077060771607726077360774607756077660777607786077960780607816078260783607846078560786607876078860789607906079160792607936079460795607966079760798607996080060801608026080360804608056080660807608086080960810608116081260813608146081560816608176081860819608206082160822608236082460825608266082760828608296083060831608326083360834608356083660837608386083960840608416084260843608446084560846608476084860849608506085160852608536085460855608566085760858608596086060861608626086360864608656086660867608686086960870608716087260873608746087560876608776087860879608806088160882608836088460885608866088760888608896089060891608926089360894608956089660897608986089960900609016090260903609046090560906609076090860909609106091160912609136091460915609166091760918609196092060921609226092360924609256092660927609286092960930609316093260933609346093560936609376093860939609406094160942609436094460945609466094760948609496095060951609526095360954609556095660957609586095960960609616096260963609646096560966609676096860969609706097160972609736097460975609766097760978609796098060981609826098360984609856098660987609886098960990609916099260993609946099560996609976099860999610006100161002610036100461005610066100761008610096101061011610126101361014610156101661017610186101961020610216102261023610246102561026610276102861029610306103161032610336103461035610366103761038610396104061041610426104361044610456104661047610486104961050610516105261053610546105561056610576105861059610606106161062610636106461065610666106761068610696107061071610726107361074610756107661077610786107961080610816108261083610846108561086610876108861089610906109161092610936109461095610966109761098610996110061101611026110361104611056110661107611086110961110611116111261113611146111561116611176111861119611206112161122611236112461125611266112761128611296113061131611326113361134611356113661137611386113961140611416114261143611446114561146611476114861149611506115161152611536115461155611566115761158611596116061161611626116361164611656116661167611686116961170611716117261173611746117561176611776117861179611806118161182611836118461185611866118761188611896119061191611926119361194611956119661197611986119961200612016120261203612046120561206612076120861209612106121161212612136121461215612166121761218612196122061221612226122361224612256122661227612286122961230612316123261233612346123561236612376123861239612406124161242612436124461245612466124761248612496125061251612526125361254612556125661257612586125961260612616126261263612646126561266612676126861269612706127161272612736127461275612766127761278612796128061281612826128361284612856128661287612886128961290612916129261293612946129561296612976129861299613006130161302613036130461305613066130761308613096131061311613126131361314613156131661317613186131961320613216132261323613246132561326613276132861329613306133161332613336133461335613366133761338613396134061341613426134361344613456134661347613486134961350613516135261353613546135561356613576135861359613606136161362613636136461365613666136761368613696137061371613726137361374613756137661377613786137961380613816138261383613846138561386613876138861389613906139161392613936139461395613966139761398613996140061401614026140361404614056140661407614086140961410614116141261413614146141561416614176141861419614206142161422614236142461425614266142761428614296143061431614326143361434614356143661437614386143961440614416144261443614446144561446614476144861449614506145161452614536145461455614566145761458614596146061461614626146361464614656146661467614686146961470614716147261473614746147561476614776147861479614806148161482614836148461485614866148761488614896149061491614926149361494614956149661497614986149961500615016150261503615046150561506615076150861509615106151161512615136151461515615166151761518615196152061521615226152361524615256152661527615286152961530615316153261533615346153561536615376153861539615406154161542615436154461545615466154761548615496155061551615526155361554615556155661557615586155961560615616156261563615646156561566615676156861569615706157161572615736157461575615766157761578615796158061581615826158361584615856158661587615886158961590615916159261593615946159561596615976159861599616006160161602616036160461605616066160761608616096161061611616126161361614616156161661617616186161961620616216162261623616246162561626616276162861629616306163161632616336163461635616366163761638616396164061641616426164361644616456164661647616486164961650616516165261653616546165561656616576165861659616606166161662616636166461665616666166761668616696167061671616726167361674616756167661677616786167961680616816168261683616846168561686616876168861689616906169161692616936169461695616966169761698616996170061701617026170361704617056170661707617086170961710617116171261713617146171561716617176171861719617206172161722617236172461725617266172761728617296173061731617326173361734617356173661737617386173961740617416174261743617446174561746617476174861749617506175161752617536175461755617566175761758617596176061761617626176361764617656176661767617686176961770617716177261773617746177561776617776177861779617806178161782617836178461785617866178761788617896179061791617926179361794617956179661797617986179961800618016180261803618046180561806618076180861809618106181161812618136181461815618166181761818618196182061821618226182361824618256182661827618286182961830618316183261833618346183561836618376183861839618406184161842618436184461845618466184761848618496185061851618526185361854618556185661857618586185961860618616186261863618646186561866618676186861869618706187161872618736187461875618766187761878618796188061881618826188361884618856188661887618886188961890618916189261893618946189561896618976189861899619006190161902619036190461905619066190761908619096191061911619126191361914619156191661917619186191961920619216192261923619246192561926619276192861929619306193161932619336193461935619366193761938619396194061941619426194361944619456194661947619486194961950619516195261953619546195561956619576195861959619606196161962619636196461965619666196761968619696197061971619726197361974619756197661977619786197961980619816198261983619846198561986619876198861989619906199161992619936199461995619966199761998619996200062001620026200362004620056200662007620086200962010620116201262013620146201562016620176201862019620206202162022620236202462025620266202762028620296203062031620326203362034620356203662037620386203962040620416204262043620446204562046620476204862049620506205162052620536205462055620566205762058620596206062061620626206362064620656206662067620686206962070620716207262073620746207562076620776207862079620806208162082620836208462085620866208762088620896209062091620926209362094620956209662097620986209962100621016210262103621046210562106621076210862109621106211162112621136211462115621166211762118621196212062121621226212362124621256212662127621286212962130621316213262133621346213562136621376213862139621406214162142621436214462145621466214762148621496215062151621526215362154621556215662157621586215962160621616216262163621646216562166621676216862169621706217162172621736217462175621766217762178621796218062181621826218362184621856218662187621886218962190621916219262193621946219562196621976219862199622006220162202622036220462205622066220762208622096221062211622126221362214622156221662217622186221962220622216222262223622246222562226622276222862229622306223162232622336223462235622366223762238622396224062241622426224362244622456224662247622486224962250622516225262253622546225562256622576225862259622606226162262622636226462265622666226762268622696227062271622726227362274622756227662277622786227962280622816228262283622846228562286622876228862289622906229162292622936229462295622966229762298622996230062301623026230362304623056230662307623086230962310623116231262313623146231562316623176231862319623206232162322623236232462325623266232762328623296233062331623326233362334623356233662337623386233962340623416234262343623446234562346623476234862349623506235162352623536235462355623566235762358623596236062361623626236362364623656236662367623686236962370623716237262373623746237562376623776237862379623806238162382623836238462385623866238762388623896239062391623926239362394623956239662397623986239962400624016240262403624046240562406624076240862409624106241162412624136241462415624166241762418624196242062421624226242362424624256242662427624286242962430624316243262433624346243562436624376243862439624406244162442624436244462445624466244762448624496245062451624526245362454624556245662457624586245962460624616246262463624646246562466624676246862469624706247162472624736247462475624766247762478624796248062481624826248362484624856248662487624886248962490624916249262493624946249562496624976249862499625006250162502625036250462505625066250762508625096251062511625126251362514625156251662517625186251962520625216252262523625246252562526625276252862529625306253162532625336253462535625366253762538625396254062541625426254362544625456254662547625486254962550625516255262553625546255562556625576255862559625606256162562625636256462565625666256762568625696257062571625726257362574625756257662577625786257962580625816258262583625846258562586625876258862589625906259162592625936259462595625966259762598625996260062601626026260362604626056260662607626086260962610626116261262613626146261562616626176261862619626206262162622626236262462625626266262762628626296263062631626326263362634626356263662637626386263962640626416264262643626446264562646626476264862649626506265162652626536265462655626566265762658626596266062661626626266362664626656266662667626686266962670626716267262673626746267562676626776267862679626806268162682626836268462685626866268762688626896269062691626926269362694626956269662697626986269962700627016270262703627046270562706627076270862709627106271162712627136271462715627166271762718627196272062721627226272362724627256272662727627286272962730627316273262733627346273562736627376273862739627406274162742627436274462745627466274762748627496275062751627526275362754627556275662757627586275962760627616276262763627646276562766627676276862769627706277162772627736277462775627766277762778627796278062781627826278362784627856278662787627886278962790627916279262793627946279562796627976279862799628006280162802628036280462805628066280762808628096281062811628126281362814628156281662817628186281962820628216282262823628246282562826628276282862829628306283162832628336283462835628366283762838628396284062841628426284362844628456284662847628486284962850628516285262853628546285562856628576285862859628606286162862628636286462865628666286762868628696287062871628726287362874628756287662877628786287962880628816288262883628846288562886628876288862889628906289162892628936289462895628966289762898628996290062901629026290362904629056290662907629086290962910629116291262913629146291562916629176291862919629206292162922629236292462925629266292762928629296293062931629326293362934629356293662937629386293962940629416294262943629446294562946629476294862949629506295162952629536295462955629566295762958629596296062961629626296362964629656296662967629686296962970629716297262973629746297562976629776297862979629806298162982629836298462985629866298762988629896299062991629926299362994629956299662997629986299963000630016300263003630046300563006630076300863009630106301163012630136301463015630166301763018630196302063021630226302363024630256302663027630286302963030630316303263033630346303563036630376303863039630406304163042630436304463045630466304763048630496305063051630526305363054630556305663057630586305963060630616306263063630646306563066630676306863069630706307163072630736307463075630766307763078630796308063081630826308363084630856308663087630886308963090630916309263093630946309563096630976309863099631006310163102631036310463105631066310763108631096311063111631126311363114631156311663117631186311963120631216312263123631246312563126631276312863129631306313163132631336313463135631366313763138631396314063141631426314363144631456314663147631486314963150631516315263153631546315563156631576315863159631606316163162631636316463165631666316763168631696317063171631726317363174631756317663177631786317963180631816318263183631846318563186631876318863189631906319163192631936319463195631966319763198631996320063201632026320363204632056320663207632086320963210632116321263213632146321563216632176321863219632206322163222632236322463225632266322763228632296323063231632326323363234632356323663237632386323963240632416324263243632446324563246632476324863249632506325163252632536325463255632566325763258632596326063261632626326363264632656326663267632686326963270632716327263273632746327563276632776327863279632806328163282632836328463285632866328763288632896329063291632926329363294632956329663297632986329963300633016330263303633046330563306633076330863309633106331163312633136331463315633166331763318633196332063321633226332363324633256332663327633286332963330633316333263333633346333563336633376333863339633406334163342633436334463345633466334763348633496335063351633526335363354633556335663357633586335963360633616336263363633646336563366633676336863369633706337163372633736337463375633766337763378633796338063381633826338363384633856338663387633886338963390633916339263393633946339563396633976339863399634006340163402634036340463405634066340763408634096341063411634126341363414634156341663417634186341963420634216342263423634246342563426634276342863429634306343163432634336343463435634366343763438634396344063441634426344363444634456344663447634486344963450634516345263453634546345563456634576345863459634606346163462634636346463465634666346763468634696347063471634726347363474634756347663477634786347963480634816348263483634846348563486634876348863489634906349163492634936349463495634966349763498634996350063501635026350363504635056350663507635086350963510635116351263513635146351563516635176351863519635206352163522635236352463525635266352763528635296353063531635326353363534635356353663537635386353963540635416354263543635446354563546635476354863549635506355163552635536355463555635566355763558635596356063561635626356363564635656356663567635686356963570635716357263573635746357563576635776357863579635806358163582635836358463585635866358763588635896359063591635926359363594635956359663597635986359963600636016360263603636046360563606636076360863609636106361163612636136361463615636166361763618636196362063621636226362363624636256362663627636286362963630636316363263633636346363563636636376363863639636406364163642636436364463645636466364763648636496365063651636526365363654636556365663657636586365963660636616366263663636646366563666636676366863669636706367163672636736367463675636766367763678636796368063681636826368363684636856368663687636886368963690636916369263693636946369563696636976369863699637006370163702637036370463705637066370763708637096371063711637126371363714637156371663717637186371963720637216372263723637246372563726637276372863729637306373163732637336373463735637366373763738637396374063741637426374363744637456374663747637486374963750637516375263753637546375563756637576375863759637606376163762637636376463765637666376763768637696377063771637726377363774637756377663777637786377963780637816378263783637846378563786637876378863789637906379163792637936379463795637966379763798637996380063801638026380363804638056380663807638086380963810638116381263813638146381563816638176381863819638206382163822638236382463825638266382763828638296383063831638326383363834638356383663837638386383963840638416384263843638446384563846638476384863849638506385163852638536385463855638566385763858638596386063861638626386363864638656386663867638686386963870638716387263873638746387563876638776387863879638806388163882638836388463885638866388763888638896389063891638926389363894638956389663897638986389963900639016390263903639046390563906639076390863909639106391163912639136391463915639166391763918639196392063921639226392363924639256392663927639286392963930639316393263933639346393563936639376393863939639406394163942639436394463945639466394763948639496395063951639526395363954639556395663957639586395963960639616396263963639646396563966639676396863969639706397163972639736397463975639766397763978639796398063981639826398363984639856398663987639886398963990639916399263993639946399563996639976399863999640006400164002640036400464005640066400764008640096401064011640126401364014640156401664017640186401964020640216402264023640246402564026640276402864029640306403164032640336403464035640366403764038640396404064041640426404364044640456404664047640486404964050640516405264053640546405564056640576405864059640606406164062640636406464065640666406764068640696407064071640726407364074640756407664077640786407964080640816408264083640846408564086640876408864089640906409164092640936409464095640966409764098640996410064101641026410364104641056410664107641086410964110641116411264113641146411564116641176411864119641206412164122641236412464125641266412764128641296413064131641326413364134641356413664137641386413964140641416414264143641446414564146641476414864149641506415164152641536415464155641566415764158641596416064161641626416364164641656416664167641686416964170641716417264173641746417564176641776417864179641806418164182641836418464185641866418764188641896419064191641926419364194641956419664197641986419964200642016420264203642046420564206642076420864209642106421164212642136421464215642166421764218642196422064221642226422364224642256422664227642286422964230642316423264233642346423564236642376423864239642406424164242642436424464245642466424764248642496425064251642526425364254642556425664257642586425964260642616426264263642646426564266642676426864269642706427164272642736427464275642766427764278642796428064281642826428364284642856428664287642886428964290642916429264293642946429564296642976429864299643006430164302643036430464305643066430764308643096431064311643126431364314643156431664317643186431964320643216432264323643246432564326643276432864329643306433164332643336433464335643366433764338643396434064341643426434364344643456434664347643486434964350643516435264353643546435564356643576435864359643606436164362643636436464365643666436764368643696437064371643726437364374643756437664377643786437964380643816438264383643846438564386643876438864389643906439164392643936439464395643966439764398643996440064401644026440364404644056440664407644086440964410644116441264413644146441564416644176441864419644206442164422644236442464425644266442764428644296443064431644326443364434644356443664437644386443964440644416444264443644446444564446644476444864449644506445164452644536445464455644566445764458644596446064461644626446364464644656446664467644686446964470644716447264473644746447564476644776447864479644806448164482644836448464485644866448764488644896449064491644926449364494644956449664497644986449964500645016450264503645046450564506645076450864509645106451164512645136451464515645166451764518645196452064521645226452364524645256452664527645286452964530645316453264533645346453564536645376453864539645406454164542645436454464545645466454764548645496455064551645526455364554645556455664557645586455964560645616456264563645646456564566645676456864569645706457164572645736457464575645766457764578645796458064581645826458364584645856458664587645886458964590645916459264593645946459564596645976459864599646006460164602646036460464605646066460764608646096461064611646126461364614646156461664617646186461964620646216462264623646246462564626646276462864629646306463164632646336463464635646366463764638646396464064641646426464364644646456464664647646486464964650646516465264653646546465564656646576465864659646606466164662646636466464665646666466764668646696467064671646726467364674646756467664677646786467964680646816468264683646846468564686646876468864689646906469164692646936469464695646966469764698646996470064701647026470364704647056470664707647086470964710647116471264713647146471564716647176471864719647206472164722647236472464725647266472764728647296473064731647326473364734647356473664737647386473964740647416474264743647446474564746647476474864749647506475164752647536475464755647566475764758647596476064761647626476364764647656476664767647686476964770647716477264773647746477564776647776477864779647806478164782647836478464785647866478764788647896479064791647926479364794647956479664797647986479964800648016480264803648046480564806648076480864809648106481164812648136481464815648166481764818648196482064821648226482364824648256482664827648286482964830648316483264833648346483564836648376483864839648406484164842648436484464845648466484764848648496485064851648526485364854648556485664857648586485964860648616486264863648646486564866648676486864869648706487164872648736487464875648766487764878648796488064881648826488364884648856488664887648886488964890648916489264893648946489564896648976489864899649006490164902649036490464905649066490764908649096491064911649126491364914649156491664917649186491964920649216492264923649246492564926649276492864929649306493164932649336493464935649366493764938649396494064941649426494364944649456494664947649486494964950649516495264953649546495564956649576495864959649606496164962649636496464965649666496764968649696497064971649726497364974649756497664977649786497964980649816498264983649846498564986649876498864989649906499164992649936499464995649966499764998649996500065001650026500365004650056500665007650086500965010650116501265013650146501565016650176501865019650206502165022650236502465025650266502765028650296503065031650326503365034650356503665037650386503965040650416504265043650446504565046650476504865049650506505165052650536505465055650566505765058650596506065061650626506365064650656506665067650686506965070650716507265073650746507565076650776507865079650806508165082650836508465085650866508765088650896509065091650926509365094650956509665097650986509965100651016510265103651046510565106651076510865109651106511165112651136511465115651166511765118651196512065121651226512365124651256512665127651286512965130651316513265133651346513565136651376513865139651406514165142651436514465145651466514765148651496515065151651526515365154651556515665157651586515965160651616516265163651646516565166651676516865169651706517165172651736517465175651766517765178651796518065181651826518365184651856518665187651886518965190651916519265193651946519565196651976519865199652006520165202652036520465205652066520765208652096521065211652126521365214652156521665217652186521965220652216522265223652246522565226652276522865229652306523165232652336523465235652366523765238652396524065241652426524365244652456524665247652486524965250652516525265253652546525565256652576525865259652606526165262652636526465265652666526765268652696527065271652726527365274652756527665277652786527965280652816528265283652846528565286652876528865289652906529165292652936529465295652966529765298652996530065301653026530365304653056530665307653086530965310653116531265313653146531565316653176531865319653206532165322653236532465325653266532765328653296533065331653326533365334653356533665337653386533965340653416534265343653446534565346653476534865349653506535165352653536535465355653566535765358653596536065361653626536365364653656536665367653686536965370653716537265373653746537565376653776537865379653806538165382653836538465385653866538765388653896539065391653926539365394653956539665397653986539965400654016540265403654046540565406654076540865409654106541165412654136541465415654166541765418654196542065421654226542365424654256542665427654286542965430654316543265433654346543565436654376543865439654406544165442654436544465445654466544765448654496545065451654526545365454654556545665457654586545965460654616546265463654646546565466654676546865469654706547165472654736547465475654766547765478654796548065481654826548365484654856548665487654886548965490654916549265493654946549565496654976549865499655006550165502655036550465505655066550765508655096551065511655126551365514655156551665517655186551965520655216552265523655246552565526655276552865529655306553165532655336553465535655366553765538655396554065541655426554365544655456554665547655486554965550655516555265553655546555565556655576555865559655606556165562655636556465565655666556765568655696557065571655726557365574655756557665577655786557965580655816558265583655846558565586655876558865589655906559165592655936559465595655966559765598655996560065601656026560365604656056560665607656086560965610656116561265613656146561565616656176561865619656206562165622656236562465625656266562765628656296563065631656326563365634656356563665637656386563965640656416564265643656446564565646656476564865649656506565165652656536565465655656566565765658656596566065661656626566365664656656566665667656686566965670656716567265673656746567565676656776567865679656806568165682656836568465685656866568765688656896569065691656926569365694656956569665697656986569965700657016570265703657046570565706657076570865709657106571165712657136571465715657166571765718657196572065721657226572365724657256572665727657286572965730657316573265733657346573565736657376573865739657406574165742657436574465745657466574765748657496575065751657526575365754657556575665757657586575965760657616576265763657646576565766657676576865769657706577165772657736577465775657766577765778657796578065781657826578365784657856578665787657886578965790657916579265793657946579565796657976579865799658006580165802658036580465805658066580765808658096581065811658126581365814658156581665817658186581965820658216582265823658246582565826658276582865829658306583165832658336583465835658366583765838658396584065841658426584365844658456584665847658486584965850658516585265853658546585565856658576585865859658606586165862658636586465865658666586765868658696587065871658726587365874658756587665877658786587965880658816588265883658846588565886658876588865889658906589165892658936589465895658966589765898658996590065901659026590365904659056590665907659086590965910659116591265913659146591565916659176591865919659206592165922659236592465925659266592765928659296593065931659326593365934659356593665937659386593965940659416594265943659446594565946659476594865949659506595165952659536595465955659566595765958659596596065961659626596365964659656596665967659686596965970659716597265973659746597565976659776597865979659806598165982659836598465985659866598765988659896599065991659926599365994659956599665997659986599966000660016600266003660046600566006660076600866009660106601166012660136601466015660166601766018660196602066021660226602366024660256602666027660286602966030660316603266033660346603566036660376603866039660406604166042660436604466045660466604766048660496605066051660526605366054660556605666057660586605966060660616606266063660646606566066660676606866069660706607166072660736607466075660766607766078660796608066081660826608366084660856608666087660886608966090660916609266093660946609566096660976609866099661006610166102661036610466105661066610766108661096611066111661126611366114661156611666117661186611966120661216612266123661246612566126661276612866129661306613166132661336613466135661366613766138661396614066141661426614366144661456614666147661486614966150661516615266153661546615566156661576615866159661606616166162661636616466165661666616766168661696617066171661726617366174661756617666177661786617966180661816618266183661846618566186661876618866189661906619166192661936619466195661966619766198661996620066201662026620366204662056620666207662086620966210662116621266213662146621566216662176621866219662206622166222662236622466225662266622766228662296623066231662326623366234662356623666237662386623966240662416624266243662446624566246662476624866249662506625166252662536625466255662566625766258662596626066261662626626366264662656626666267662686626966270662716627266273662746627566276662776627866279662806628166282662836628466285662866628766288662896629066291662926629366294662956629666297662986629966300663016630266303663046630566306663076630866309663106631166312663136631466315663166631766318663196632066321663226632366324663256632666327663286632966330663316633266333663346633566336663376633866339663406634166342663436634466345663466634766348663496635066351663526635366354663556635666357663586635966360663616636266363663646636566366663676636866369663706637166372663736637466375663766637766378663796638066381663826638366384663856638666387663886638966390663916639266393663946639566396663976639866399664006640166402664036640466405664066640766408664096641066411664126641366414664156641666417664186641966420664216642266423664246642566426664276642866429664306643166432664336643466435664366643766438664396644066441664426644366444664456644666447664486644966450664516645266453664546645566456664576645866459664606646166462664636646466465664666646766468664696647066471664726647366474664756647666477664786647966480664816648266483664846648566486664876648866489664906649166492664936649466495664966649766498664996650066501665026650366504665056650666507665086650966510665116651266513665146651566516665176651866519665206652166522665236652466525665266652766528665296653066531665326653366534665356653666537665386653966540665416654266543665446654566546665476654866549665506655166552665536655466555665566655766558665596656066561665626656366564665656656666567665686656966570665716657266573665746657566576665776657866579665806658166582665836658466585665866658766588665896659066591665926659366594665956659666597665986659966600666016660266603666046660566606666076660866609666106661166612666136661466615666166661766618666196662066621666226662366624666256662666627666286662966630666316663266633666346663566636666376663866639666406664166642666436664466645666466664766648666496665066651666526665366654666556665666657666586665966660666616666266663666646666566666666676666866669666706667166672666736667466675666766667766678666796668066681666826668366684666856668666687666886668966690666916669266693666946669566696666976669866699667006670166702667036670466705667066670766708667096671066711667126671366714667156671666717667186671966720667216672266723667246672566726667276672866729667306673166732667336673466735667366673766738667396674066741667426674366744667456674666747667486674966750667516675266753667546675566756667576675866759667606676166762667636676466765667666676766768667696677066771667726677366774667756677666777667786677966780667816678266783667846678566786667876678866789667906679166792667936679466795667966679766798667996680066801668026680366804668056680666807668086680966810668116681266813668146681566816668176681866819668206682166822668236682466825668266682766828668296683066831668326683366834668356683666837668386683966840668416684266843668446684566846668476684866849668506685166852668536685466855668566685766858668596686066861668626686366864668656686666867668686686966870668716687266873668746687566876668776687866879668806688166882668836688466885668866688766888668896689066891668926689366894668956689666897668986689966900669016690266903669046690566906669076690866909669106691166912669136691466915669166691766918669196692066921669226692366924669256692666927669286692966930669316693266933669346693566936669376693866939669406694166942669436694466945669466694766948669496695066951669526695366954669556695666957669586695966960669616696266963669646696566966669676696866969669706697166972669736697466975669766697766978669796698066981669826698366984669856698666987669886698966990669916699266993669946699566996669976699866999670006700167002670036700467005670066700767008670096701067011670126701367014670156701667017670186701967020670216702267023670246702567026670276702867029670306703167032670336703467035670366703767038670396704067041670426704367044670456704667047670486704967050670516705267053670546705567056670576705867059670606706167062670636706467065670666706767068670696707067071670726707367074670756707667077670786707967080670816708267083670846708567086670876708867089670906709167092670936709467095670966709767098670996710067101671026710367104671056710667107671086710967110671116711267113671146711567116671176711867119671206712167122671236712467125671266712767128671296713067131671326713367134671356713667137671386713967140671416714267143671446714567146671476714867149671506715167152671536715467155671566715767158671596716067161671626716367164671656716667167671686716967170671716717267173671746717567176671776717867179671806718167182671836718467185671866718767188671896719067191671926719367194671956719667197671986719967200672016720267203672046720567206672076720867209672106721167212672136721467215672166721767218672196722067221672226722367224672256722667227672286722967230672316723267233672346723567236672376723867239672406724167242672436724467245672466724767248672496725067251672526725367254672556725667257672586725967260672616726267263672646726567266672676726867269672706727167272672736727467275672766727767278672796728067281672826728367284672856728667287672886728967290672916729267293672946729567296672976729867299673006730167302673036730467305673066730767308673096731067311673126731367314673156731667317673186731967320673216732267323673246732567326673276732867329673306733167332673336733467335673366733767338673396734067341673426734367344673456734667347673486734967350673516735267353673546735567356673576735867359673606736167362673636736467365673666736767368673696737067371673726737367374673756737667377673786737967380673816738267383673846738567386673876738867389673906739167392673936739467395673966739767398673996740067401674026740367404674056740667407674086740967410674116741267413674146741567416674176741867419674206742167422674236742467425674266742767428674296743067431674326743367434674356743667437674386743967440674416744267443674446744567446674476744867449674506745167452674536745467455674566745767458674596746067461674626746367464674656746667467674686746967470674716747267473674746747567476674776747867479674806748167482674836748467485674866748767488674896749067491674926749367494674956749667497674986749967500675016750267503675046750567506675076750867509675106751167512675136751467515675166751767518675196752067521675226752367524675256752667527675286752967530675316753267533675346753567536675376753867539675406754167542675436754467545675466754767548675496755067551675526755367554675556755667557675586755967560675616756267563675646756567566675676756867569675706757167572675736757467575675766757767578675796758067581675826758367584675856758667587675886758967590675916759267593675946759567596675976759867599676006760167602676036760467605676066760767608676096761067611676126761367614676156761667617676186761967620676216762267623676246762567626676276762867629676306763167632676336763467635676366763767638676396764067641676426764367644676456764667647676486764967650676516765267653676546765567656676576765867659676606766167662676636766467665676666766767668676696767067671676726767367674676756767667677676786767967680676816768267683676846768567686676876768867689676906769167692676936769467695676966769767698676996770067701677026770367704677056770667707677086770967710677116771267713677146771567716677176771867719677206772167722677236772467725677266772767728677296773067731677326773367734677356773667737677386773967740677416774267743677446774567746677476774867749677506775167752677536775467755677566775767758677596776067761677626776367764677656776667767677686776967770677716777267773677746777567776677776777867779677806778167782677836778467785677866778767788677896779067791677926779367794677956779667797677986779967800678016780267803678046780567806678076780867809678106781167812678136781467815678166781767818678196782067821678226782367824678256782667827678286782967830678316783267833678346783567836678376783867839678406784167842678436784467845678466784767848678496785067851678526785367854678556785667857678586785967860678616786267863678646786567866678676786867869678706787167872678736787467875678766787767878678796788067881678826788367884678856788667887678886788967890678916789267893678946789567896678976789867899679006790167902679036790467905679066790767908679096791067911679126791367914679156791667917679186791967920679216792267923679246792567926679276792867929679306793167932679336793467935679366793767938679396794067941679426794367944679456794667947679486794967950679516795267953679546795567956679576795867959679606796167962679636796467965679666796767968679696797067971679726797367974679756797667977679786797967980679816798267983679846798567986679876798867989679906799167992679936799467995679966799767998679996800068001680026800368004680056800668007680086800968010680116801268013680146801568016680176801868019680206802168022680236802468025680266802768028680296803068031680326803368034680356803668037680386803968040680416804268043680446804568046680476804868049680506805168052680536805468055680566805768058680596806068061680626806368064680656806668067680686806968070680716807268073680746807568076680776807868079680806808168082680836808468085680866808768088680896809068091680926809368094680956809668097680986809968100681016810268103681046810568106681076810868109681106811168112681136811468115681166811768118681196812068121681226812368124681256812668127681286812968130681316813268133681346813568136681376813868139681406814168142681436814468145681466814768148681496815068151681526815368154681556815668157681586815968160681616816268163681646816568166681676816868169681706817168172681736817468175681766817768178681796818068181681826818368184681856818668187681886818968190681916819268193681946819568196681976819868199682006820168202682036820468205682066820768208682096821068211682126821368214682156821668217682186821968220682216822268223682246822568226682276822868229682306823168232682336823468235682366823768238682396824068241682426824368244682456824668247682486824968250682516825268253682546825568256682576825868259682606826168262682636826468265682666826768268682696827068271682726827368274682756827668277682786827968280682816828268283682846828568286682876828868289682906829168292682936829468295682966829768298682996830068301683026830368304683056830668307683086830968310683116831268313683146831568316683176831868319683206832168322683236832468325683266832768328683296833068331683326833368334683356833668337683386833968340683416834268343683446834568346683476834868349683506835168352683536835468355683566835768358683596836068361683626836368364683656836668367683686836968370683716837268373683746837568376683776837868379683806838168382683836838468385683866838768388683896839068391683926839368394683956839668397683986839968400684016840268403684046840568406684076840868409684106841168412684136841468415684166841768418684196842068421684226842368424684256842668427684286842968430684316843268433684346843568436684376843868439684406844168442684436844468445684466844768448684496845068451684526845368454684556845668457684586845968460684616846268463684646846568466684676846868469684706847168472684736847468475684766847768478684796848068481684826848368484684856848668487684886848968490684916849268493684946849568496684976849868499685006850168502685036850468505685066850768508685096851068511685126851368514685156851668517685186851968520685216852268523685246852568526685276852868529685306853168532685336853468535685366853768538685396854068541685426854368544685456854668547685486854968550685516855268553685546855568556685576855868559685606856168562685636856468565685666856768568685696857068571685726857368574685756857668577685786857968580685816858268583685846858568586685876858868589685906859168592685936859468595685966859768598685996860068601686026860368604686056860668607686086860968610686116861268613686146861568616686176861868619686206862168622686236862468625686266862768628686296863068631686326863368634686356863668637686386863968640686416864268643686446864568646686476864868649686506865168652686536865468655686566865768658686596866068661686626866368664686656866668667686686866968670686716867268673686746867568676686776867868679686806868168682686836868468685686866868768688686896869068691686926869368694686956869668697686986869968700687016870268703687046870568706687076870868709687106871168712687136871468715687166871768718687196872068721687226872368724687256872668727687286872968730687316873268733687346873568736687376873868739687406874168742687436874468745687466874768748687496875068751687526875368754687556875668757687586875968760687616876268763687646876568766687676876868769687706877168772687736877468775687766877768778687796878068781687826878368784687856878668787687886878968790687916879268793687946879568796687976879868799688006880168802688036880468805688066880768808688096881068811688126881368814688156881668817688186881968820688216882268823688246882568826688276882868829688306883168832688336883468835688366883768838688396884068841688426884368844688456884668847688486884968850688516885268853688546885568856688576885868859688606886168862688636886468865688666886768868688696887068871688726887368874688756887668877688786887968880688816888268883688846888568886688876888868889688906889168892688936889468895688966889768898688996890068901689026890368904689056890668907689086890968910689116891268913689146891568916689176891868919689206892168922689236892468925689266892768928689296893068931689326893368934689356893668937689386893968940689416894268943689446894568946689476894868949689506895168952689536895468955689566895768958689596896068961689626896368964689656896668967689686896968970689716897268973689746897568976689776897868979689806898168982689836898468985689866898768988689896899068991689926899368994689956899668997689986899969000690016900269003690046900569006690076900869009690106901169012690136901469015690166901769018690196902069021690226902369024690256902669027690286902969030690316903269033690346903569036690376903869039690406904169042690436904469045690466904769048690496905069051690526905369054690556905669057690586905969060690616906269063690646906569066690676906869069690706907169072690736907469075690766907769078690796908069081690826908369084690856908669087690886908969090690916909269093690946909569096690976909869099691006910169102691036910469105691066910769108691096911069111691126911369114691156911669117691186911969120691216912269123691246912569126691276912869129691306913169132691336913469135691366913769138691396914069141691426914369144691456914669147691486914969150691516915269153691546915569156691576915869159691606916169162691636916469165691666916769168691696917069171691726917369174691756917669177691786917969180691816918269183691846918569186691876918869189691906919169192691936919469195691966919769198691996920069201692026920369204692056920669207692086920969210692116921269213692146921569216692176921869219692206922169222692236922469225692266922769228692296923069231692326923369234692356923669237692386923969240692416924269243692446924569246692476924869249692506925169252692536925469255692566925769258692596926069261692626926369264692656926669267692686926969270692716927269273692746927569276692776927869279692806928169282692836928469285692866928769288692896929069291692926929369294692956929669297692986929969300693016930269303693046930569306693076930869309693106931169312693136931469315693166931769318693196932069321693226932369324693256932669327693286932969330693316933269333693346933569336693376933869339693406934169342693436934469345693466934769348693496935069351693526935369354693556935669357693586935969360693616936269363693646936569366693676936869369693706937169372693736937469375693766937769378693796938069381693826938369384693856938669387693886938969390693916939269393693946939569396693976939869399694006940169402694036940469405694066940769408694096941069411694126941369414694156941669417694186941969420694216942269423694246942569426694276942869429694306943169432694336943469435694366943769438694396944069441694426944369444694456944669447694486944969450694516945269453694546945569456694576945869459694606946169462694636946469465694666946769468694696947069471694726947369474694756947669477694786947969480694816948269483694846948569486694876948869489694906949169492694936949469495694966949769498694996950069501695026950369504695056950669507695086950969510695116951269513695146951569516695176951869519695206952169522695236952469525695266952769528695296953069531695326953369534695356953669537695386953969540695416954269543695446954569546695476954869549695506955169552695536955469555695566955769558695596956069561695626956369564695656956669567695686956969570695716957269573695746957569576695776957869579695806958169582695836958469585695866958769588695896959069591695926959369594695956959669597695986959969600696016960269603696046960569606696076960869609696106961169612696136961469615696166961769618696196962069621696226962369624696256962669627696286962969630696316963269633696346963569636696376963869639696406964169642696436964469645696466964769648696496965069651696526965369654696556965669657696586965969660696616966269663696646966569666696676966869669696706967169672696736967469675696766967769678696796968069681696826968369684696856968669687696886968969690696916969269693696946969569696696976969869699697006970169702697036970469705697066970769708697096971069711697126971369714697156971669717697186971969720697216972269723697246972569726697276972869729697306973169732697336973469735697366973769738697396974069741697426974369744697456974669747697486974969750697516975269753697546975569756697576975869759697606976169762697636976469765697666976769768697696977069771697726977369774697756977669777697786977969780697816978269783697846978569786697876978869789697906979169792697936979469795697966979769798697996980069801698026980369804698056980669807698086980969810698116981269813698146981569816698176981869819698206982169822698236982469825698266982769828698296983069831698326983369834698356983669837698386983969840698416984269843698446984569846698476984869849698506985169852698536985469855698566985769858698596986069861698626986369864698656986669867698686986969870698716987269873698746987569876698776987869879698806988169882698836988469885698866988769888698896989069891698926989369894698956989669897698986989969900699016990269903699046990569906699076990869909699106991169912699136991469915699166991769918699196992069921699226992369924699256992669927699286992969930699316993269933699346993569936699376993869939699406994169942699436994469945699466994769948699496995069951699526995369954699556995669957699586995969960699616996269963699646996569966699676996869969699706997169972699736997469975699766997769978699796998069981699826998369984699856998669987699886998969990699916999269993699946999569996699976999869999700007000170002700037000470005700067000770008700097001070011700127001370014700157001670017700187001970020700217002270023700247002570026700277002870029700307003170032700337003470035700367003770038700397004070041700427004370044700457004670047700487004970050700517005270053700547005570056700577005870059700607006170062700637006470065700667006770068700697007070071700727007370074700757007670077700787007970080700817008270083700847008570086700877008870089700907009170092700937009470095700967009770098700997010070101701027010370104701057010670107701087010970110701117011270113701147011570116701177011870119701207012170122701237012470125701267012770128701297013070131701327013370134701357013670137701387013970140701417014270143701447014570146701477014870149701507015170152701537015470155701567015770158701597016070161701627016370164701657016670167701687016970170701717017270173701747017570176701777017870179701807018170182701837018470185701867018770188701897019070191701927019370194701957019670197701987019970200702017020270203702047020570206702077020870209702107021170212702137021470215702167021770218702197022070221702227022370224702257022670227702287022970230702317023270233702347023570236702377023870239702407024170242702437024470245702467024770248702497025070251702527025370254702557025670257702587025970260702617026270263702647026570266702677026870269702707027170272702737027470275702767027770278702797028070281702827028370284702857028670287702887028970290702917029270293702947029570296702977029870299703007030170302703037030470305703067030770308703097031070311703127031370314703157031670317703187031970320703217032270323703247032570326703277032870329703307033170332703337033470335703367033770338703397034070341703427034370344703457034670347703487034970350703517035270353703547035570356703577035870359703607036170362703637036470365703667036770368703697037070371703727037370374703757037670377703787037970380703817038270383703847038570386703877038870389703907039170392703937039470395703967039770398703997040070401704027040370404704057040670407704087040970410704117041270413704147041570416704177041870419704207042170422704237042470425704267042770428704297043070431704327043370434704357043670437704387043970440704417044270443704447044570446704477044870449704507045170452704537045470455704567045770458704597046070461704627046370464704657046670467704687046970470704717047270473704747047570476704777047870479704807048170482704837048470485704867048770488704897049070491704927049370494704957049670497704987049970500705017050270503705047050570506705077050870509705107051170512705137051470515705167051770518705197052070521705227052370524705257052670527705287052970530705317053270533705347053570536705377053870539705407054170542705437054470545705467054770548705497055070551705527055370554705557055670557705587055970560705617056270563705647056570566705677056870569705707057170572705737057470575705767057770578705797058070581705827058370584705857058670587705887058970590705917059270593705947059570596705977059870599706007060170602706037060470605706067060770608706097061070611706127061370614706157061670617706187061970620706217062270623706247062570626706277062870629706307063170632706337063470635706367063770638706397064070641706427064370644706457064670647706487064970650706517065270653706547065570656706577065870659706607066170662706637066470665706667066770668706697067070671706727067370674706757067670677706787067970680706817068270683706847068570686706877068870689706907069170692706937069470695706967069770698706997070070701707027070370704707057070670707707087070970710707117071270713707147071570716707177071870719707207072170722707237072470725707267072770728707297073070731707327073370734707357073670737707387073970740707417074270743707447074570746707477074870749707507075170752707537075470755707567075770758707597076070761707627076370764707657076670767707687076970770707717077270773707747077570776707777077870779707807078170782707837078470785707867078770788707897079070791707927079370794707957079670797707987079970800708017080270803708047080570806708077080870809708107081170812708137081470815708167081770818708197082070821708227082370824708257082670827708287082970830708317083270833708347083570836708377083870839708407084170842708437084470845708467084770848708497085070851708527085370854708557085670857708587085970860708617086270863708647086570866708677086870869708707087170872708737087470875708767087770878708797088070881708827088370884708857088670887708887088970890708917089270893708947089570896708977089870899709007090170902709037090470905709067090770908709097091070911709127091370914709157091670917709187091970920709217092270923709247092570926709277092870929709307093170932709337093470935709367093770938709397094070941709427094370944709457094670947709487094970950709517095270953709547095570956709577095870959709607096170962709637096470965709667096770968709697097070971709727097370974709757097670977709787097970980709817098270983709847098570986709877098870989709907099170992709937099470995709967099770998709997100071001710027100371004710057100671007710087100971010710117101271013710147101571016710177101871019710207102171022710237102471025710267102771028710297103071031710327103371034710357103671037710387103971040710417104271043710447104571046710477104871049710507105171052710537105471055710567105771058710597106071061710627106371064710657106671067710687106971070710717107271073710747107571076710777107871079710807108171082710837108471085710867108771088710897109071091710927109371094710957109671097710987109971100711017110271103711047110571106711077110871109711107111171112711137111471115711167111771118711197112071121711227112371124711257112671127711287112971130711317113271133711347113571136711377113871139711407114171142711437114471145711467114771148711497115071151711527115371154711557115671157711587115971160711617116271163711647116571166711677116871169711707117171172711737117471175711767117771178711797118071181711827118371184711857118671187711887118971190711917119271193711947119571196711977119871199712007120171202712037120471205712067120771208712097121071211712127121371214712157121671217712187121971220712217122271223712247122571226712277122871229712307123171232712337123471235712367123771238712397124071241712427124371244712457124671247712487124971250712517125271253712547125571256712577125871259712607126171262712637126471265712667126771268712697127071271712727127371274712757127671277712787127971280712817128271283712847128571286712877128871289712907129171292712937129471295712967129771298712997130071301713027130371304713057130671307713087130971310713117131271313713147131571316713177131871319713207132171322713237132471325713267132771328713297133071331713327133371334713357133671337713387133971340713417134271343713447134571346713477134871349713507135171352713537135471355713567135771358713597136071361713627136371364713657136671367713687136971370713717137271373713747137571376713777137871379713807138171382713837138471385713867138771388713897139071391713927139371394713957139671397713987139971400714017140271403714047140571406714077140871409714107141171412714137141471415714167141771418714197142071421714227142371424714257142671427714287142971430714317143271433714347143571436714377143871439714407144171442714437144471445714467144771448714497145071451714527145371454714557145671457714587145971460714617146271463714647146571466714677146871469714707147171472714737147471475714767147771478714797148071481714827148371484714857148671487714887148971490714917149271493714947149571496714977149871499715007150171502715037150471505715067150771508715097151071511715127151371514715157151671517715187151971520715217152271523715247152571526715277152871529715307153171532715337153471535715367153771538715397154071541715427154371544715457154671547715487154971550715517155271553715547155571556715577155871559715607156171562715637156471565715667156771568715697157071571715727157371574715757157671577715787157971580715817158271583715847158571586715877158871589715907159171592715937159471595715967159771598715997160071601716027160371604716057160671607716087160971610716117161271613716147161571616716177161871619716207162171622716237162471625716267162771628716297163071631716327163371634716357163671637716387163971640716417164271643716447164571646716477164871649716507165171652716537165471655716567165771658716597166071661716627166371664716657166671667716687166971670716717167271673716747167571676716777167871679716807168171682716837168471685716867168771688716897169071691716927169371694716957169671697716987169971700717017170271703717047170571706717077170871709717107171171712717137171471715717167171771718717197172071721717227172371724717257172671727717287172971730717317173271733717347173571736717377173871739717407174171742717437174471745717467174771748717497175071751717527175371754717557175671757717587175971760717617176271763717647176571766717677176871769717707177171772717737177471775717767177771778717797178071781717827178371784717857178671787717887178971790717917179271793717947179571796717977179871799718007180171802718037180471805718067180771808718097181071811718127181371814718157181671817718187181971820718217182271823718247182571826718277182871829718307183171832718337183471835718367183771838718397184071841718427184371844718457184671847718487184971850718517185271853718547185571856718577185871859718607186171862718637186471865718667186771868718697187071871718727187371874718757187671877718787187971880718817188271883718847188571886718877188871889718907189171892718937189471895718967189771898718997190071901719027190371904719057190671907719087190971910719117191271913719147191571916719177191871919719207192171922719237192471925719267192771928719297193071931719327193371934719357193671937719387193971940719417194271943719447194571946719477194871949719507195171952719537195471955719567195771958719597196071961719627196371964719657196671967719687196971970719717197271973719747197571976719777197871979719807198171982719837198471985719867198771988719897199071991719927199371994719957199671997719987199972000720017200272003720047200572006720077200872009720107201172012720137201472015720167201772018720197202072021720227202372024720257202672027720287202972030720317203272033720347203572036720377203872039720407204172042720437204472045720467204772048720497205072051720527205372054720557205672057720587205972060720617206272063720647206572066720677206872069720707207172072720737207472075720767207772078720797208072081720827208372084720857208672087720887208972090720917209272093720947209572096720977209872099721007210172102721037210472105721067210772108721097211072111721127211372114721157211672117721187211972120721217212272123721247212572126721277212872129721307213172132721337213472135721367213772138721397214072141721427214372144721457214672147721487214972150721517215272153721547215572156721577215872159721607216172162721637216472165721667216772168721697217072171721727217372174721757217672177721787217972180721817218272183721847218572186721877218872189721907219172192721937219472195721967219772198721997220072201722027220372204722057220672207722087220972210722117221272213722147221572216722177221872219722207222172222722237222472225722267222772228722297223072231722327223372234722357223672237722387223972240722417224272243722447224572246722477224872249722507225172252722537225472255722567225772258722597226072261722627226372264722657226672267722687226972270722717227272273722747227572276722777227872279722807228172282722837228472285722867228772288722897229072291722927229372294722957229672297722987229972300723017230272303723047230572306723077230872309723107231172312723137231472315723167231772318723197232072321723227232372324723257232672327723287232972330723317233272333723347233572336723377233872339723407234172342723437234472345723467234772348723497235072351723527235372354723557235672357723587235972360723617236272363723647236572366723677236872369723707237172372723737237472375723767237772378723797238072381723827238372384723857238672387723887238972390723917239272393723947239572396723977239872399724007240172402724037240472405724067240772408724097241072411724127241372414724157241672417724187241972420724217242272423724247242572426724277242872429724307243172432724337243472435724367243772438724397244072441724427244372444724457244672447724487244972450724517245272453724547245572456724577245872459724607246172462724637246472465724667246772468724697247072471724727247372474724757247672477724787247972480724817248272483724847248572486724877248872489724907249172492724937249472495724967249772498724997250072501725027250372504725057250672507725087250972510725117251272513725147251572516725177251872519725207252172522725237252472525725267252772528725297253072531725327253372534725357253672537725387253972540725417254272543725447254572546725477254872549725507255172552725537255472555725567255772558725597256072561725627256372564725657256672567725687256972570725717257272573725747257572576725777257872579725807258172582725837258472585725867258772588725897259072591725927259372594725957259672597725987259972600726017260272603726047260572606726077260872609726107261172612726137261472615726167261772618726197262072621726227262372624726257262672627726287262972630726317263272633726347263572636726377263872639726407264172642726437264472645726467264772648726497265072651726527265372654726557265672657726587265972660726617266272663726647266572666726677266872669726707267172672726737267472675726767267772678726797268072681726827268372684726857268672687726887268972690726917269272693726947269572696726977269872699727007270172702727037270472705727067270772708727097271072711727127271372714727157271672717727187271972720727217272272723727247272572726727277272872729727307273172732727337273472735727367273772738727397274072741727427274372744727457274672747727487274972750727517275272753727547275572756727577275872759727607276172762727637276472765727667276772768727697277072771727727277372774727757277672777727787277972780727817278272783727847278572786727877278872789727907279172792727937279472795727967279772798727997280072801728027280372804728057280672807728087280972810728117281272813728147281572816728177281872819728207282172822728237282472825728267282772828728297283072831728327283372834728357283672837728387283972840728417284272843728447284572846728477284872849728507285172852728537285472855728567285772858728597286072861728627286372864728657286672867728687286972870728717287272873728747287572876728777287872879728807288172882728837288472885728867288772888728897289072891728927289372894728957289672897728987289972900729017290272903729047290572906729077290872909729107291172912729137291472915729167291772918729197292072921729227292372924729257292672927729287292972930729317293272933729347293572936729377293872939729407294172942729437294472945729467294772948729497295072951729527295372954729557295672957729587295972960729617296272963729647296572966729677296872969729707297172972729737297472975729767297772978729797298072981729827298372984729857298672987729887298972990729917299272993729947299572996729977299872999730007300173002730037300473005730067300773008730097301073011730127301373014730157301673017730187301973020730217302273023730247302573026730277302873029730307303173032730337303473035730367303773038730397304073041730427304373044730457304673047730487304973050730517305273053730547305573056730577305873059730607306173062730637306473065730667306773068730697307073071730727307373074730757307673077730787307973080730817308273083730847308573086730877308873089730907309173092730937309473095730967309773098730997310073101731027310373104731057310673107731087310973110731117311273113731147311573116731177311873119731207312173122731237312473125731267312773128731297313073131731327313373134731357313673137731387313973140731417314273143731447314573146731477314873149731507315173152731537315473155731567315773158731597316073161731627316373164731657316673167731687316973170731717317273173731747317573176731777317873179731807318173182731837318473185731867318773188731897319073191731927319373194731957319673197731987319973200732017320273203732047320573206732077320873209732107321173212732137321473215732167321773218732197322073221732227322373224732257322673227732287322973230732317323273233732347323573236732377323873239732407324173242732437324473245732467324773248732497325073251732527325373254732557325673257732587325973260732617326273263732647326573266732677326873269732707327173272732737327473275732767327773278732797328073281732827328373284732857328673287732887328973290732917329273293732947329573296732977329873299733007330173302733037330473305733067330773308733097331073311733127331373314733157331673317733187331973320733217332273323733247332573326733277332873329733307333173332733337333473335733367333773338733397334073341733427334373344733457334673347733487334973350733517335273353733547335573356733577335873359733607336173362733637336473365733667336773368733697337073371733727337373374733757337673377733787337973380733817338273383733847338573386733877338873389733907339173392733937339473395733967339773398733997340073401734027340373404734057340673407734087340973410734117341273413734147341573416734177341873419734207342173422734237342473425734267342773428734297343073431734327343373434734357343673437734387343973440734417344273443734447344573446734477344873449734507345173452734537345473455734567345773458734597346073461734627346373464734657346673467734687346973470734717347273473734747347573476734777347873479734807348173482734837348473485734867348773488734897349073491734927349373494734957349673497734987349973500735017350273503735047350573506735077350873509735107351173512735137351473515735167351773518735197352073521735227352373524735257352673527735287352973530735317353273533735347353573536735377353873539735407354173542735437354473545735467354773548735497355073551735527355373554735557355673557735587355973560735617356273563735647356573566735677356873569735707357173572735737357473575735767357773578735797358073581735827358373584735857358673587735887358973590735917359273593735947359573596735977359873599736007360173602736037360473605736067360773608736097361073611736127361373614736157361673617736187361973620736217362273623736247362573626736277362873629736307363173632736337363473635736367363773638736397364073641736427364373644736457364673647736487364973650736517365273653736547365573656736577365873659736607366173662736637366473665736667366773668736697367073671736727367373674736757367673677736787367973680736817368273683736847368573686736877368873689736907369173692736937369473695736967369773698736997370073701737027370373704737057370673707737087370973710737117371273713737147371573716737177371873719737207372173722737237372473725737267372773728737297373073731737327373373734737357373673737737387373973740737417374273743737447374573746737477374873749737507375173752737537375473755737567375773758737597376073761737627376373764737657376673767737687376973770737717377273773737747377573776737777377873779737807378173782737837378473785737867378773788737897379073791737927379373794737957379673797737987379973800738017380273803738047380573806738077380873809738107381173812738137381473815738167381773818738197382073821738227382373824738257382673827738287382973830738317383273833738347383573836738377383873839738407384173842738437384473845738467384773848738497385073851738527385373854738557385673857738587385973860738617386273863738647386573866738677386873869738707387173872738737387473875738767387773878738797388073881738827388373884738857388673887738887388973890738917389273893738947389573896738977389873899739007390173902739037390473905739067390773908739097391073911739127391373914739157391673917739187391973920739217392273923739247392573926739277392873929739307393173932739337393473935739367393773938739397394073941739427394373944739457394673947739487394973950739517395273953739547395573956739577395873959739607396173962739637396473965739667396773968739697397073971739727397373974739757397673977739787397973980739817398273983739847398573986739877398873989739907399173992739937399473995739967399773998739997400074001740027400374004740057400674007740087400974010740117401274013740147401574016740177401874019740207402174022740237402474025740267402774028740297403074031740327403374034740357403674037740387403974040740417404274043740447404574046740477404874049740507405174052740537405474055740567405774058740597406074061740627406374064740657406674067740687406974070740717407274073740747407574076740777407874079740807408174082740837408474085740867408774088740897409074091740927409374094740957409674097740987409974100741017410274103741047410574106741077410874109741107411174112741137411474115741167411774118741197412074121741227412374124741257412674127741287412974130741317413274133741347413574136741377413874139741407414174142741437414474145741467414774148741497415074151741527415374154741557415674157741587415974160741617416274163741647416574166741677416874169741707417174172741737417474175741767417774178741797418074181741827418374184741857418674187741887418974190741917419274193741947419574196741977419874199742007420174202742037420474205742067420774208742097421074211742127421374214742157421674217742187421974220742217422274223742247422574226742277422874229742307423174232742337423474235742367423774238742397424074241742427424374244742457424674247742487424974250742517425274253742547425574256742577425874259742607426174262742637426474265742667426774268742697427074271742727427374274742757427674277742787427974280742817428274283742847428574286742877428874289742907429174292742937429474295742967429774298742997430074301743027430374304743057430674307743087430974310743117431274313743147431574316743177431874319743207432174322743237432474325743267432774328743297433074331743327433374334743357433674337743387433974340743417434274343743447434574346743477434874349743507435174352743537435474355743567435774358743597436074361743627436374364743657436674367743687436974370743717437274373743747437574376743777437874379743807438174382743837438474385743867438774388743897439074391743927439374394743957439674397743987439974400744017440274403744047440574406744077440874409744107441174412744137441474415744167441774418744197442074421744227442374424744257442674427744287442974430744317443274433744347443574436744377443874439744407444174442744437444474445744467444774448744497445074451744527445374454744557445674457744587445974460744617446274463744647446574466744677446874469744707447174472744737447474475744767447774478744797448074481744827448374484744857448674487744887448974490744917449274493744947449574496744977449874499745007450174502745037450474505745067450774508745097451074511745127451374514745157451674517745187451974520745217452274523745247452574526745277452874529745307453174532745337453474535745367453774538745397454074541745427454374544745457454674547745487454974550745517455274553745547455574556745577455874559745607456174562745637456474565745667456774568745697457074571745727457374574745757457674577745787457974580745817458274583745847458574586745877458874589745907459174592745937459474595745967459774598745997460074601746027460374604746057460674607746087460974610746117461274613746147461574616746177461874619746207462174622746237462474625746267462774628746297463074631746327463374634746357463674637746387463974640746417464274643746447464574646746477464874649746507465174652746537465474655746567465774658746597466074661746627466374664746657466674667746687466974670746717467274673746747467574676746777467874679746807468174682746837468474685746867468774688746897469074691746927469374694746957469674697746987469974700747017470274703747047470574706747077470874709747107471174712747137471474715747167471774718747197472074721747227472374724747257472674727747287472974730747317473274733747347473574736747377473874739747407474174742747437474474745747467474774748747497475074751747527475374754747557475674757747587475974760747617476274763747647476574766747677476874769747707477174772747737477474775747767477774778747797478074781747827478374784747857478674787747887478974790747917479274793747947479574796747977479874799748007480174802748037480474805748067480774808748097481074811748127481374814748157481674817748187481974820748217482274823748247482574826748277482874829748307483174832748337483474835748367483774838748397484074841748427484374844748457484674847748487484974850748517485274853748547485574856748577485874859748607486174862748637486474865748667486774868748697487074871748727487374874748757487674877748787487974880748817488274883748847488574886748877488874889748907489174892748937489474895748967489774898748997490074901749027490374904749057490674907749087490974910749117491274913749147491574916749177491874919749207492174922749237492474925749267492774928749297493074931749327493374934749357493674937749387493974940749417494274943749447494574946749477494874949749507495174952749537495474955749567495774958749597496074961749627496374964749657496674967749687496974970749717497274973749747497574976749777497874979749807498174982749837498474985749867498774988749897499074991749927499374994749957499674997749987499975000750017500275003750047500575006750077500875009750107501175012750137501475015750167501775018750197502075021750227502375024750257502675027750287502975030750317503275033750347503575036750377503875039750407504175042750437504475045750467504775048750497505075051750527505375054750557505675057750587505975060750617506275063750647506575066750677506875069750707507175072750737507475075750767507775078750797508075081750827508375084750857508675087750887508975090750917509275093750947509575096750977509875099751007510175102751037510475105751067510775108751097511075111751127511375114751157511675117751187511975120751217512275123751247512575126751277512875129751307513175132751337513475135751367513775138751397514075141751427514375144751457514675147751487514975150751517515275153751547515575156751577515875159751607516175162751637516475165751667516775168751697517075171751727517375174751757517675177751787517975180751817518275183751847518575186751877518875189751907519175192751937519475195751967519775198751997520075201752027520375204752057520675207752087520975210752117521275213752147521575216752177521875219752207522175222752237522475225752267522775228752297523075231752327523375234752357523675237752387523975240752417524275243752447524575246752477524875249752507525175252752537525475255752567525775258752597526075261752627526375264752657526675267752687526975270752717527275273752747527575276752777527875279752807528175282752837528475285752867528775288752897529075291752927529375294752957529675297752987529975300753017530275303753047530575306753077530875309753107531175312753137531475315753167531775318753197532075321753227532375324753257532675327753287532975330753317533275333753347533575336753377533875339753407534175342753437534475345753467534775348753497535075351753527535375354753557535675357753587535975360753617536275363753647536575366753677536875369753707537175372753737537475375753767537775378753797538075381753827538375384753857538675387753887538975390753917539275393753947539575396753977539875399754007540175402754037540475405754067540775408754097541075411754127541375414754157541675417754187541975420754217542275423754247542575426754277542875429754307543175432754337543475435754367543775438754397544075441754427544375444754457544675447754487544975450754517545275453754547545575456754577545875459754607546175462754637546475465754667546775468754697547075471754727547375474754757547675477754787547975480754817548275483754847548575486754877548875489754907549175492754937549475495754967549775498754997550075501755027550375504755057550675507755087550975510755117551275513755147551575516755177551875519755207552175522755237552475525755267552775528755297553075531755327553375534755357553675537755387553975540755417554275543755447554575546755477554875549755507555175552755537555475555755567555775558755597556075561755627556375564755657556675567755687556975570755717557275573755747557575576755777557875579755807558175582755837558475585755867558775588755897559075591755927559375594755957559675597755987559975600756017560275603756047560575606756077560875609756107561175612756137561475615756167561775618756197562075621756227562375624756257562675627756287562975630756317563275633756347563575636756377563875639756407564175642756437564475645756467564775648756497565075651756527565375654756557565675657756587565975660756617566275663756647566575666756677566875669756707567175672756737567475675756767567775678756797568075681756827568375684756857568675687756887568975690756917569275693756947569575696756977569875699757007570175702757037570475705757067570775708757097571075711757127571375714757157571675717757187571975720757217572275723757247572575726757277572875729757307573175732757337573475735757367573775738757397574075741757427574375744757457574675747757487574975750757517575275753757547575575756757577575875759757607576175762757637576475765757667576775768757697577075771757727577375774757757577675777757787577975780757817578275783757847578575786757877578875789757907579175792757937579475795757967579775798757997580075801758027580375804758057580675807758087580975810758117581275813758147581575816758177581875819758207582175822758237582475825758267582775828758297583075831758327583375834758357583675837758387583975840758417584275843758447584575846758477584875849758507585175852758537585475855758567585775858758597586075861758627586375864758657586675867758687586975870758717587275873758747587575876758777587875879758807588175882758837588475885758867588775888758897589075891758927589375894758957589675897758987589975900759017590275903759047590575906759077590875909759107591175912759137591475915759167591775918759197592075921759227592375924759257592675927759287592975930759317593275933759347593575936759377593875939759407594175942759437594475945759467594775948759497595075951759527595375954759557595675957759587595975960759617596275963759647596575966759677596875969759707597175972759737597475975759767597775978759797598075981759827598375984759857598675987759887598975990759917599275993759947599575996759977599875999760007600176002760037600476005760067600776008760097601076011760127601376014760157601676017760187601976020760217602276023760247602576026760277602876029760307603176032760337603476035760367603776038760397604076041760427604376044760457604676047760487604976050760517605276053760547605576056760577605876059760607606176062760637606476065760667606776068760697607076071760727607376074760757607676077760787607976080760817608276083760847608576086760877608876089760907609176092760937609476095760967609776098760997610076101761027610376104761057610676107761087610976110761117611276113761147611576116761177611876119761207612176122761237612476125761267612776128761297613076131761327613376134761357613676137761387613976140761417614276143761447614576146761477614876149761507615176152761537615476155761567615776158761597616076161761627616376164761657616676167761687616976170761717617276173761747617576176761777617876179761807618176182761837618476185761867618776188761897619076191761927619376194761957619676197761987619976200762017620276203762047620576206762077620876209762107621176212762137621476215762167621776218762197622076221762227622376224762257622676227762287622976230762317623276233762347623576236762377623876239762407624176242762437624476245762467624776248762497625076251762527625376254762557625676257762587625976260762617626276263762647626576266762677626876269762707627176272762737627476275762767627776278762797628076281762827628376284762857628676287762887628976290762917629276293762947629576296762977629876299763007630176302763037630476305763067630776308763097631076311763127631376314763157631676317763187631976320763217632276323763247632576326763277632876329763307633176332763337633476335763367633776338763397634076341763427634376344763457634676347763487634976350763517635276353763547635576356763577635876359763607636176362763637636476365763667636776368763697637076371763727637376374763757637676377763787637976380763817638276383763847638576386763877638876389763907639176392763937639476395763967639776398763997640076401764027640376404764057640676407764087640976410764117641276413764147641576416764177641876419764207642176422764237642476425764267642776428764297643076431764327643376434764357643676437764387643976440764417644276443764447644576446764477644876449764507645176452764537645476455764567645776458764597646076461764627646376464764657646676467764687646976470764717647276473764747647576476764777647876479764807648176482764837648476485764867648776488764897649076491764927649376494764957649676497764987649976500765017650276503765047650576506765077650876509765107651176512765137651476515765167651776518765197652076521765227652376524765257652676527765287652976530765317653276533765347653576536765377653876539765407654176542765437654476545765467654776548765497655076551765527655376554765557655676557765587655976560765617656276563765647656576566765677656876569765707657176572765737657476575765767657776578765797658076581765827658376584765857658676587765887658976590765917659276593765947659576596765977659876599766007660176602766037660476605766067660776608766097661076611766127661376614766157661676617766187661976620766217662276623766247662576626766277662876629766307663176632766337663476635766367663776638766397664076641766427664376644766457664676647766487664976650766517665276653766547665576656766577665876659766607666176662766637666476665766667666776668766697667076671766727667376674766757667676677766787667976680766817668276683766847668576686766877668876689766907669176692766937669476695766967669776698766997670076701767027670376704767057670676707767087670976710767117671276713767147671576716767177671876719767207672176722767237672476725767267672776728767297673076731767327673376734767357673676737767387673976740767417674276743767447674576746767477674876749767507675176752767537675476755767567675776758767597676076761767627676376764767657676676767767687676976770767717677276773767747677576776767777677876779767807678176782767837678476785767867678776788767897679076791767927679376794767957679676797767987679976800768017680276803768047680576806768077680876809768107681176812768137681476815768167681776818768197682076821768227682376824768257682676827768287682976830768317683276833768347683576836768377683876839768407684176842768437684476845768467684776848768497685076851768527685376854768557685676857768587685976860768617686276863768647686576866768677686876869768707687176872768737687476875768767687776878768797688076881768827688376884768857688676887768887688976890768917689276893768947689576896768977689876899769007690176902769037690476905769067690776908769097691076911769127691376914769157691676917769187691976920769217692276923769247692576926769277692876929769307693176932769337693476935769367693776938769397694076941769427694376944769457694676947769487694976950769517695276953769547695576956769577695876959769607696176962769637696476965769667696776968769697697076971769727697376974769757697676977769787697976980769817698276983769847698576986769877698876989769907699176992769937699476995769967699776998769997700077001770027700377004770057700677007770087700977010770117701277013770147701577016770177701877019770207702177022770237702477025770267702777028770297703077031770327703377034770357703677037770387703977040770417704277043770447704577046770477704877049770507705177052770537705477055770567705777058770597706077061770627706377064770657706677067770687706977070770717707277073770747707577076770777707877079770807708177082770837708477085770867708777088770897709077091770927709377094770957709677097770987709977100771017710277103771047710577106771077710877109771107711177112771137711477115771167711777118771197712077121771227712377124771257712677127771287712977130771317713277133771347713577136771377713877139771407714177142771437714477145771467714777148771497715077151771527715377154771557715677157771587715977160771617716277163771647716577166771677716877169771707717177172771737717477175771767717777178771797718077181771827718377184771857718677187771887718977190771917719277193771947719577196771977719877199772007720177202772037720477205772067720777208772097721077211772127721377214772157721677217772187721977220772217722277223772247722577226772277722877229772307723177232772337723477235772367723777238772397724077241772427724377244772457724677247772487724977250772517725277253772547725577256772577725877259772607726177262772637726477265772667726777268772697727077271772727727377274772757727677277772787727977280772817728277283772847728577286772877728877289772907729177292772937729477295772967729777298772997730077301773027730377304773057730677307773087730977310773117731277313773147731577316773177731877319773207732177322773237732477325773267732777328773297733077331773327733377334773357733677337773387733977340773417734277343773447734577346773477734877349773507735177352773537735477355773567735777358773597736077361773627736377364773657736677367773687736977370773717737277373773747737577376773777737877379773807738177382773837738477385773867738777388773897739077391773927739377394773957739677397773987739977400774017740277403774047740577406774077740877409774107741177412774137741477415774167741777418774197742077421774227742377424774257742677427774287742977430774317743277433774347743577436774377743877439774407744177442774437744477445774467744777448774497745077451774527745377454774557745677457774587745977460774617746277463774647746577466774677746877469774707747177472774737747477475774767747777478774797748077481774827748377484774857748677487774887748977490774917749277493774947749577496774977749877499775007750177502775037750477505775067750777508775097751077511775127751377514775157751677517775187751977520775217752277523775247752577526775277752877529775307753177532775337753477535775367753777538775397754077541775427754377544775457754677547775487754977550775517755277553775547755577556775577755877559775607756177562775637756477565775667756777568775697757077571775727757377574775757757677577775787757977580775817758277583775847758577586775877758877589775907759177592775937759477595775967759777598775997760077601776027760377604776057760677607776087760977610776117761277613776147761577616776177761877619776207762177622776237762477625776267762777628776297763077631776327763377634776357763677637776387763977640776417764277643776447764577646776477764877649776507765177652776537765477655776567765777658776597766077661776627766377664776657766677667776687766977670776717767277673776747767577676776777767877679776807768177682776837768477685776867768777688776897769077691776927769377694776957769677697776987769977700777017770277703777047770577706777077770877709777107771177712777137771477715777167771777718777197772077721777227772377724777257772677727777287772977730777317773277733777347773577736777377773877739777407774177742777437774477745777467774777748777497775077751777527775377754777557775677757777587775977760777617776277763777647776577766777677776877769777707777177772777737777477775777767777777778777797778077781777827778377784777857778677787777887778977790777917779277793777947779577796777977779877799778007780177802778037780477805778067780777808778097781077811778127781377814778157781677817778187781977820778217782277823778247782577826778277782877829778307783177832778337783477835778367783777838778397784077841778427784377844778457784677847778487784977850778517785277853778547785577856778577785877859778607786177862778637786477865778667786777868778697787077871778727787377874778757787677877778787787977880778817788277883778847788577886778877788877889778907789177892778937789477895778967789777898778997790077901779027790377904779057790677907779087790977910779117791277913779147791577916779177791877919779207792177922779237792477925779267792777928779297793077931779327793377934779357793677937779387793977940779417794277943779447794577946779477794877949779507795177952779537795477955779567795777958779597796077961779627796377964779657796677967779687796977970779717797277973779747797577976779777797877979779807798177982779837798477985779867798777988779897799077991779927799377994779957799677997779987799978000780017800278003780047800578006780077800878009780107801178012780137801478015780167801778018780197802078021780227802378024780257802678027780287802978030780317803278033780347803578036780377803878039780407804178042780437804478045780467804778048780497805078051780527805378054780557805678057780587805978060780617806278063780647806578066780677806878069780707807178072780737807478075780767807778078780797808078081780827808378084780857808678087780887808978090780917809278093780947809578096780977809878099781007810178102781037810478105781067810778108781097811078111781127811378114781157811678117781187811978120781217812278123781247812578126781277812878129781307813178132781337813478135781367813778138781397814078141781427814378144781457814678147781487814978150781517815278153781547815578156781577815878159781607816178162781637816478165781667816778168781697817078171781727817378174781757817678177781787817978180781817818278183781847818578186781877818878189781907819178192781937819478195781967819778198781997820078201782027820378204782057820678207782087820978210782117821278213782147821578216782177821878219782207822178222782237822478225782267822778228782297823078231782327823378234782357823678237782387823978240782417824278243782447824578246782477824878249782507825178252782537825478255782567825778258782597826078261782627826378264782657826678267782687826978270782717827278273782747827578276782777827878279782807828178282782837828478285782867828778288782897829078291782927829378294782957829678297782987829978300783017830278303783047830578306783077830878309783107831178312783137831478315783167831778318783197832078321783227832378324783257832678327783287832978330783317833278333783347833578336783377833878339783407834178342783437834478345783467834778348783497835078351783527835378354783557835678357783587835978360783617836278363783647836578366783677836878369783707837178372783737837478375783767837778378783797838078381783827838378384783857838678387783887838978390783917839278393783947839578396783977839878399784007840178402784037840478405784067840778408784097841078411784127841378414784157841678417784187841978420784217842278423784247842578426784277842878429784307843178432784337843478435784367843778438784397844078441784427844378444784457844678447784487844978450784517845278453784547845578456784577845878459784607846178462784637846478465784667846778468784697847078471784727847378474784757847678477784787847978480784817848278483784847848578486784877848878489784907849178492784937849478495784967849778498784997850078501785027850378504785057850678507785087850978510785117851278513785147851578516785177851878519785207852178522785237852478525785267852778528785297853078531785327853378534785357853678537785387853978540785417854278543785447854578546785477854878549785507855178552785537855478555785567855778558785597856078561785627856378564785657856678567785687856978570785717857278573785747857578576785777857878579785807858178582785837858478585785867858778588785897859078591785927859378594785957859678597785987859978600786017860278603786047860578606786077860878609786107861178612786137861478615786167861778618786197862078621786227862378624786257862678627786287862978630786317863278633786347863578636786377863878639786407864178642786437864478645786467864778648786497865078651786527865378654786557865678657786587865978660786617866278663786647866578666786677866878669786707867178672786737867478675786767867778678786797868078681786827868378684786857868678687786887868978690786917869278693786947869578696786977869878699787007870178702787037870478705787067870778708787097871078711787127871378714787157871678717787187871978720787217872278723787247872578726787277872878729787307873178732787337873478735787367873778738787397874078741787427874378744787457874678747787487874978750787517875278753787547875578756787577875878759787607876178762787637876478765787667876778768787697877078771787727877378774787757877678777787787877978780787817878278783787847878578786787877878878789787907879178792787937879478795787967879778798787997880078801788027880378804788057880678807788087880978810788117881278813788147881578816788177881878819788207882178822788237882478825788267882778828788297883078831788327883378834788357883678837788387883978840788417884278843788447884578846788477884878849788507885178852788537885478855788567885778858788597886078861788627886378864788657886678867788687886978870788717887278873788747887578876788777887878879788807888178882788837888478885788867888778888788897889078891788927889378894788957889678897788987889978900789017890278903789047890578906789077890878909789107891178912789137891478915789167891778918789197892078921789227892378924789257892678927789287892978930789317893278933789347893578936789377893878939789407894178942789437894478945789467894778948789497895078951789527895378954789557895678957789587895978960789617896278963789647896578966789677896878969789707897178972789737897478975789767897778978789797898078981789827898378984789857898678987789887898978990789917899278993789947899578996789977899878999790007900179002790037900479005790067900779008790097901079011790127901379014790157901679017790187901979020790217902279023790247902579026790277902879029790307903179032790337903479035790367903779038790397904079041790427904379044790457904679047790487904979050790517905279053790547905579056790577905879059790607906179062790637906479065790667906779068790697907079071790727907379074790757907679077790787907979080790817908279083790847908579086790877908879089790907909179092790937909479095790967909779098790997910079101791027910379104791057910679107791087910979110791117911279113791147911579116791177911879119791207912179122791237912479125791267912779128791297913079131791327913379134791357913679137791387913979140791417914279143791447914579146791477914879149791507915179152791537915479155791567915779158791597916079161791627916379164791657916679167791687916979170791717917279173791747917579176791777917879179791807918179182791837918479185791867918779188791897919079191791927919379194791957919679197791987919979200792017920279203792047920579206792077920879209792107921179212792137921479215792167921779218792197922079221792227922379224792257922679227792287922979230792317923279233792347923579236792377923879239792407924179242792437924479245792467924779248792497925079251792527925379254792557925679257792587925979260792617926279263792647926579266792677926879269792707927179272792737927479275792767927779278792797928079281792827928379284792857928679287792887928979290792917929279293792947929579296792977929879299793007930179302793037930479305793067930779308793097931079311793127931379314793157931679317793187931979320793217932279323793247932579326793277932879329793307933179332793337933479335793367933779338793397934079341793427934379344793457934679347793487934979350793517935279353793547935579356793577935879359793607936179362793637936479365793667936779368793697937079371793727937379374793757937679377793787937979380793817938279383793847938579386793877938879389793907939179392793937939479395793967939779398793997940079401794027940379404794057940679407794087940979410794117941279413794147941579416794177941879419794207942179422794237942479425794267942779428794297943079431794327943379434794357943679437794387943979440794417944279443794447944579446794477944879449794507945179452794537945479455794567945779458794597946079461794627946379464794657946679467794687946979470794717947279473794747947579476794777947879479794807948179482794837948479485794867948779488794897949079491794927949379494794957949679497794987949979500795017950279503795047950579506795077950879509795107951179512795137951479515795167951779518795197952079521795227952379524795257952679527795287952979530795317953279533795347953579536795377953879539795407954179542795437954479545795467954779548795497955079551795527955379554795557955679557795587955979560795617956279563795647956579566795677956879569795707957179572795737957479575795767957779578795797958079581795827958379584795857958679587795887958979590795917959279593795947959579596795977959879599796007960179602796037960479605796067960779608796097961079611796127961379614796157961679617796187961979620796217962279623796247962579626796277962879629796307963179632796337963479635796367963779638796397964079641796427964379644796457964679647796487964979650796517965279653796547965579656796577965879659796607966179662796637966479665796667966779668796697967079671796727967379674796757967679677796787967979680796817968279683796847968579686796877968879689796907969179692796937969479695796967969779698796997970079701797027970379704797057970679707797087970979710797117971279713797147971579716797177971879719797207972179722797237972479725797267972779728797297973079731797327973379734797357973679737797387973979740797417974279743797447974579746797477974879749797507975179752797537975479755797567975779758797597976079761797627976379764797657976679767797687976979770797717977279773797747977579776797777977879779797807978179782797837978479785797867978779788797897979079791797927979379794797957979679797797987979979800798017980279803798047980579806798077980879809798107981179812798137981479815798167981779818798197982079821798227982379824798257982679827798287982979830798317983279833798347983579836798377983879839798407984179842798437984479845798467984779848798497985079851798527985379854798557985679857798587985979860798617986279863798647986579866798677986879869798707987179872798737987479875798767987779878798797988079881798827988379884798857988679887798887988979890798917989279893798947989579896798977989879899799007990179902799037990479905799067990779908799097991079911799127991379914799157991679917799187991979920799217992279923799247992579926799277992879929799307993179932799337993479935799367993779938799397994079941799427994379944799457994679947799487994979950799517995279953799547995579956799577995879959799607996179962799637996479965799667996779968799697997079971799727997379974799757997679977799787997979980799817998279983799847998579986799877998879989799907999179992799937999479995799967999779998799998000080001800028000380004800058000680007800088000980010800118001280013800148001580016800178001880019800208002180022800238002480025800268002780028800298003080031800328003380034800358003680037800388003980040800418004280043800448004580046800478004880049800508005180052800538005480055800568005780058800598006080061800628006380064800658006680067800688006980070800718007280073800748007580076800778007880079800808008180082800838008480085800868008780088800898009080091800928009380094800958009680097800988009980100801018010280103801048010580106801078010880109801108011180112801138011480115801168011780118801198012080121801228012380124801258012680127801288012980130801318013280133801348013580136801378013880139801408014180142801438014480145801468014780148801498015080151801528015380154801558015680157801588015980160801618016280163801648016580166801678016880169801708017180172801738017480175801768017780178801798018080181801828018380184801858018680187801888018980190801918019280193801948019580196801978019880199802008020180202802038020480205802068020780208802098021080211802128021380214802158021680217802188021980220802218022280223802248022580226802278022880229802308023180232802338023480235802368023780238802398024080241802428024380244802458024680247802488024980250802518025280253802548025580256802578025880259802608026180262802638026480265802668026780268802698027080271802728027380274802758027680277802788027980280802818028280283802848028580286802878028880289802908029180292802938029480295802968029780298802998030080301803028030380304803058030680307803088030980310803118031280313803148031580316803178031880319803208032180322803238032480325803268032780328803298033080331803328033380334803358033680337803388033980340803418034280343803448034580346803478034880349803508035180352803538035480355803568035780358803598036080361803628036380364803658036680367803688036980370803718037280373803748037580376803778037880379803808038180382803838038480385803868038780388803898039080391803928039380394803958039680397803988039980400804018040280403804048040580406804078040880409804108041180412804138041480415804168041780418804198042080421804228042380424804258042680427804288042980430804318043280433804348043580436804378043880439804408044180442804438044480445804468044780448804498045080451804528045380454804558045680457804588045980460804618046280463804648046580466804678046880469804708047180472804738047480475804768047780478804798048080481804828048380484804858048680487804888048980490804918049280493804948049580496804978049880499805008050180502805038050480505805068050780508805098051080511805128051380514805158051680517805188051980520805218052280523805248052580526805278052880529805308053180532805338053480535805368053780538805398054080541805428054380544805458054680547805488054980550805518055280553805548055580556805578055880559805608056180562805638056480565805668056780568805698057080571805728057380574805758057680577805788057980580805818058280583805848058580586805878058880589805908059180592805938059480595805968059780598805998060080601806028060380604806058060680607806088060980610806118061280613806148061580616806178061880619806208062180622806238062480625806268062780628806298063080631806328063380634806358063680637806388063980640806418064280643806448064580646806478064880649806508065180652806538065480655806568065780658806598066080661806628066380664806658066680667806688066980670806718067280673806748067580676806778067880679806808068180682806838068480685806868068780688806898069080691806928069380694806958069680697806988069980700807018070280703807048070580706807078070880709807108071180712807138071480715807168071780718807198072080721807228072380724807258072680727807288072980730807318073280733807348073580736807378073880739807408074180742807438074480745807468074780748807498075080751807528075380754807558075680757807588075980760807618076280763807648076580766807678076880769807708077180772807738077480775807768077780778807798078080781807828078380784807858078680787807888078980790807918079280793807948079580796807978079880799808008080180802808038080480805808068080780808808098081080811808128081380814808158081680817808188081980820808218082280823808248082580826808278082880829808308083180832808338083480835808368083780838808398084080841808428084380844808458084680847808488084980850808518085280853808548085580856808578085880859808608086180862808638086480865808668086780868808698087080871808728087380874808758087680877808788087980880808818088280883808848088580886808878088880889808908089180892808938089480895808968089780898808998090080901809028090380904809058090680907809088090980910809118091280913809148091580916809178091880919809208092180922809238092480925809268092780928809298093080931809328093380934809358093680937809388093980940809418094280943809448094580946809478094880949809508095180952809538095480955809568095780958809598096080961809628096380964809658096680967809688096980970809718097280973809748097580976809778097880979809808098180982809838098480985809868098780988809898099080991809928099380994809958099680997809988099981000810018100281003810048100581006810078100881009810108101181012810138101481015810168101781018810198102081021810228102381024810258102681027810288102981030810318103281033810348103581036810378103881039810408104181042810438104481045810468104781048810498105081051810528105381054810558105681057810588105981060810618106281063810648106581066810678106881069810708107181072810738107481075810768107781078810798108081081810828108381084810858108681087810888108981090810918109281093810948109581096810978109881099811008110181102811038110481105811068110781108811098111081111811128111381114811158111681117811188111981120811218112281123811248112581126811278112881129811308113181132811338113481135811368113781138811398114081141811428114381144811458114681147811488114981150811518115281153811548115581156811578115881159811608116181162811638116481165811668116781168811698117081171811728117381174811758117681177811788117981180811818118281183811848118581186811878118881189811908119181192811938119481195811968119781198811998120081201812028120381204812058120681207812088120981210812118121281213812148121581216812178121881219812208122181222812238122481225812268122781228812298123081231812328123381234812358123681237812388123981240812418124281243812448124581246812478124881249812508125181252812538125481255812568125781258812598126081261812628126381264812658126681267812688126981270812718127281273812748127581276812778127881279812808128181282812838128481285812868128781288812898129081291812928129381294812958129681297812988129981300813018130281303813048130581306813078130881309813108131181312813138131481315813168131781318813198132081321813228132381324813258132681327813288132981330813318133281333813348133581336813378133881339813408134181342813438134481345813468134781348813498135081351813528135381354813558135681357813588135981360813618136281363813648136581366813678136881369813708137181372813738137481375813768137781378813798138081381813828138381384813858138681387813888138981390813918139281393813948139581396813978139881399814008140181402814038140481405814068140781408814098141081411814128141381414814158141681417814188141981420814218142281423814248142581426814278142881429814308143181432814338143481435814368143781438814398144081441814428144381444814458144681447814488144981450814518145281453814548145581456814578145881459814608146181462814638146481465814668146781468814698147081471814728147381474814758147681477814788147981480814818148281483814848148581486814878148881489814908149181492814938149481495814968149781498814998150081501815028150381504815058150681507815088150981510815118151281513815148151581516815178151881519815208152181522815238152481525815268152781528815298153081531815328153381534815358153681537815388153981540815418154281543815448154581546815478154881549815508155181552815538155481555815568155781558815598156081561815628156381564815658156681567815688156981570815718157281573815748157581576815778157881579815808158181582815838158481585815868158781588815898159081591815928159381594815958159681597815988159981600816018160281603816048160581606816078160881609816108161181612816138161481615816168161781618816198162081621816228162381624816258162681627816288162981630816318163281633816348163581636816378163881639816408164181642816438164481645816468164781648816498165081651816528165381654816558165681657816588165981660816618166281663816648166581666816678166881669816708167181672816738167481675816768167781678816798168081681816828168381684816858168681687816888168981690816918169281693816948169581696816978169881699817008170181702817038170481705817068170781708817098171081711817128171381714817158171681717817188171981720817218172281723817248172581726817278172881729817308173181732817338173481735817368173781738817398174081741817428174381744817458174681747817488174981750817518175281753817548175581756817578175881759817608176181762817638176481765817668176781768817698177081771817728177381774817758177681777817788177981780817818178281783817848178581786817878178881789817908179181792817938179481795817968179781798817998180081801818028180381804818058180681807818088180981810818118181281813818148181581816818178181881819818208182181822818238182481825818268182781828818298183081831818328183381834818358183681837818388183981840818418184281843818448184581846818478184881849818508185181852818538185481855818568185781858818598186081861818628186381864818658186681867818688186981870818718187281873818748187581876818778187881879818808188181882818838188481885818868188781888818898189081891818928189381894818958189681897818988189981900819018190281903819048190581906819078190881909819108191181912819138191481915819168191781918819198192081921819228192381924819258192681927819288192981930819318193281933819348193581936819378193881939819408194181942819438194481945819468194781948819498195081951819528195381954819558195681957819588195981960819618196281963819648196581966819678196881969819708197181972819738197481975819768197781978819798198081981819828198381984819858198681987819888198981990819918199281993819948199581996819978199881999820008200182002820038200482005820068200782008820098201082011820128201382014820158201682017820188201982020820218202282023820248202582026820278202882029820308203182032820338203482035820368203782038820398204082041820428204382044820458204682047820488204982050820518205282053820548205582056820578205882059820608206182062820638206482065820668206782068820698207082071820728207382074820758207682077820788207982080820818208282083820848208582086820878208882089820908209182092820938209482095820968209782098820998210082101821028210382104821058210682107821088210982110821118211282113821148211582116821178211882119821208212182122821238212482125821268212782128821298213082131821328213382134821358213682137821388213982140821418214282143821448214582146821478214882149821508215182152821538215482155821568215782158821598216082161821628216382164821658216682167821688216982170821718217282173821748217582176821778217882179821808218182182821838218482185821868218782188821898219082191821928219382194821958219682197821988219982200822018220282203822048220582206822078220882209822108221182212822138221482215822168221782218822198222082221822228222382224822258222682227822288222982230822318223282233822348223582236822378223882239822408224182242822438224482245822468224782248822498225082251822528225382254822558225682257822588225982260822618226282263822648226582266822678226882269822708227182272822738227482275822768227782278822798228082281822828228382284822858228682287822888228982290822918229282293822948229582296822978229882299823008230182302823038230482305823068230782308823098231082311823128231382314823158231682317823188231982320823218232282323823248232582326823278232882329823308233182332823338233482335823368233782338823398234082341823428234382344823458234682347823488234982350823518235282353823548235582356823578235882359823608236182362823638236482365823668236782368823698237082371823728237382374823758237682377823788237982380823818238282383823848238582386823878238882389823908239182392823938239482395823968239782398823998240082401824028240382404824058240682407824088240982410824118241282413824148241582416824178241882419824208242182422824238242482425824268242782428824298243082431824328243382434824358243682437824388243982440824418244282443824448244582446824478244882449824508245182452824538245482455824568245782458824598246082461824628246382464824658246682467824688246982470824718247282473824748247582476824778247882479824808248182482824838248482485824868248782488824898249082491824928249382494824958249682497824988249982500825018250282503825048250582506825078250882509825108251182512825138251482515825168251782518825198252082521825228252382524825258252682527825288252982530825318253282533825348253582536825378253882539825408254182542825438254482545825468254782548825498255082551825528255382554825558255682557825588255982560825618256282563825648256582566825678256882569825708257182572825738257482575825768257782578825798258082581825828258382584825858258682587825888258982590825918259282593825948259582596825978259882599826008260182602826038260482605826068260782608826098261082611826128261382614826158261682617826188261982620826218262282623826248262582626826278262882629826308263182632826338263482635826368263782638826398264082641826428264382644826458264682647826488264982650826518265282653826548265582656826578265882659826608266182662826638266482665826668266782668826698267082671826728267382674826758267682677826788267982680826818268282683826848268582686826878268882689826908269182692826938269482695826968269782698826998270082701827028270382704827058270682707827088270982710827118271282713827148271582716827178271882719827208272182722827238272482725827268272782728827298273082731827328273382734827358273682737827388273982740827418274282743827448274582746827478274882749827508275182752827538275482755827568275782758827598276082761827628276382764827658276682767827688276982770827718277282773827748277582776827778277882779827808278182782827838278482785827868278782788827898279082791827928279382794827958279682797827988279982800828018280282803828048280582806828078280882809828108281182812828138281482815828168281782818828198282082821828228282382824828258282682827828288282982830828318283282833828348283582836828378283882839828408284182842828438284482845828468284782848828498285082851828528285382854828558285682857828588285982860828618286282863828648286582866828678286882869828708287182872828738287482875828768287782878828798288082881828828288382884828858288682887828888288982890828918289282893828948289582896828978289882899829008290182902829038290482905829068290782908829098291082911829128291382914829158291682917829188291982920829218292282923829248292582926829278292882929829308293182932829338293482935829368293782938829398294082941829428294382944829458294682947829488294982950829518295282953829548295582956829578295882959829608296182962829638296482965829668296782968829698297082971829728297382974829758297682977829788297982980829818298282983829848298582986829878298882989829908299182992829938299482995829968299782998829998300083001830028300383004830058300683007830088300983010830118301283013830148301583016830178301883019830208302183022830238302483025830268302783028830298303083031830328303383034830358303683037830388303983040830418304283043830448304583046830478304883049830508305183052830538305483055830568305783058830598306083061830628306383064830658306683067830688306983070830718307283073830748307583076830778307883079830808308183082830838308483085830868308783088830898309083091830928309383094830958309683097830988309983100831018310283103831048310583106831078310883109831108311183112831138311483115831168311783118831198312083121831228312383124831258312683127831288312983130831318313283133831348313583136831378313883139831408314183142831438314483145831468314783148831498315083151831528315383154831558315683157831588315983160831618316283163831648316583166831678316883169831708317183172831738317483175831768317783178831798318083181831828318383184831858318683187831888318983190831918319283193831948319583196831978319883199832008320183202832038320483205832068320783208832098321083211832128321383214832158321683217832188321983220832218322283223832248322583226832278322883229832308323183232832338323483235832368323783238832398324083241832428324383244832458324683247832488324983250832518325283253832548325583256832578325883259832608326183262832638326483265832668326783268832698327083271832728327383274832758327683277832788327983280832818328283283832848328583286832878328883289832908329183292832938329483295832968329783298832998330083301833028330383304833058330683307833088330983310833118331283313833148331583316833178331883319833208332183322833238332483325833268332783328833298333083331833328333383334833358333683337833388333983340833418334283343833448334583346833478334883349833508335183352833538335483355833568335783358833598336083361833628336383364833658336683367833688336983370833718337283373833748337583376833778337883379833808338183382833838338483385833868338783388833898339083391833928339383394833958339683397833988339983400834018340283403834048340583406834078340883409834108341183412834138341483415834168341783418834198342083421834228342383424834258342683427834288342983430834318343283433834348343583436834378343883439834408344183442834438344483445834468344783448834498345083451834528345383454834558345683457834588345983460834618346283463834648346583466834678346883469834708347183472834738347483475834768347783478834798348083481834828348383484834858348683487834888348983490834918349283493834948349583496834978349883499835008350183502835038350483505835068350783508835098351083511835128351383514835158351683517835188351983520835218352283523835248352583526835278352883529835308353183532835338353483535835368353783538835398354083541835428354383544835458354683547835488354983550835518355283553835548355583556835578355883559835608356183562835638356483565835668356783568835698357083571835728357383574835758357683577835788357983580835818358283583835848358583586835878358883589835908359183592835938359483595835968359783598835998360083601836028360383604836058360683607836088360983610836118361283613836148361583616836178361883619836208362183622836238362483625836268362783628836298363083631836328363383634836358363683637836388363983640836418364283643836448364583646836478364883649836508365183652836538365483655836568365783658836598366083661836628366383664836658366683667836688366983670836718367283673836748367583676836778367883679836808368183682836838368483685836868368783688836898369083691836928369383694836958369683697836988369983700837018370283703837048370583706837078370883709837108371183712837138371483715837168371783718837198372083721837228372383724837258372683727837288372983730837318373283733837348373583736837378373883739837408374183742837438374483745837468374783748837498375083751837528375383754837558375683757837588375983760837618376283763837648376583766837678376883769837708377183772837738377483775837768377783778837798378083781837828378383784837858378683787837888378983790837918379283793837948379583796837978379883799838008380183802838038380483805838068380783808838098381083811838128381383814838158381683817838188381983820838218382283823838248382583826838278382883829838308383183832838338383483835838368383783838838398384083841838428384383844838458384683847838488384983850838518385283853838548385583856838578385883859838608386183862838638386483865838668386783868838698387083871838728387383874838758387683877838788387983880838818388283883838848388583886838878388883889838908389183892838938389483895838968389783898838998390083901839028390383904839058390683907839088390983910839118391283913839148391583916839178391883919839208392183922839238392483925839268392783928839298393083931839328393383934839358393683937839388393983940839418394283943839448394583946839478394883949839508395183952839538395483955839568395783958839598396083961839628396383964839658396683967839688396983970839718397283973839748397583976839778397883979839808398183982839838398483985839868398783988839898399083991839928399383994839958399683997839988399984000840018400284003840048400584006840078400884009840108401184012840138401484015840168401784018840198402084021840228402384024840258402684027840288402984030840318403284033840348403584036840378403884039840408404184042840438404484045840468404784048840498405084051840528405384054840558405684057840588405984060840618406284063840648406584066840678406884069840708407184072840738407484075840768407784078840798408084081840828408384084840858408684087840888408984090840918409284093840948409584096840978409884099841008410184102841038410484105841068410784108841098411084111841128411384114841158411684117841188411984120841218412284123841248412584126841278412884129841308413184132841338413484135841368413784138841398414084141841428414384144841458414684147841488414984150841518415284153841548415584156841578415884159841608416184162841638416484165841668416784168841698417084171841728417384174841758417684177841788417984180841818418284183841848418584186841878418884189841908419184192841938419484195841968419784198841998420084201842028420384204842058420684207842088420984210842118421284213842148421584216842178421884219842208422184222842238422484225842268422784228842298423084231842328423384234842358423684237842388423984240842418424284243842448424584246842478424884249842508425184252842538425484255842568425784258842598426084261842628426384264842658426684267842688426984270842718427284273842748427584276842778427884279842808428184282842838428484285842868428784288842898429084291842928429384294842958429684297842988429984300843018430284303843048430584306843078430884309843108431184312843138431484315843168431784318843198432084321843228432384324843258432684327843288432984330843318433284333843348433584336843378433884339843408434184342843438434484345843468434784348843498435084351843528435384354843558435684357843588435984360843618436284363843648436584366843678436884369843708437184372843738437484375843768437784378843798438084381843828438384384843858438684387843888438984390843918439284393843948439584396843978439884399844008440184402844038440484405844068440784408844098441084411844128441384414844158441684417844188441984420844218442284423844248442584426844278442884429844308443184432844338443484435844368443784438844398444084441844428444384444844458444684447844488444984450844518445284453844548445584456844578445884459844608446184462844638446484465844668446784468844698447084471844728447384474844758447684477844788447984480844818448284483844848448584486844878448884489844908449184492844938449484495844968449784498844998450084501845028450384504845058450684507845088450984510845118451284513845148451584516845178451884519845208452184522845238452484525845268452784528845298453084531845328453384534845358453684537845388453984540845418454284543845448454584546845478454884549845508455184552845538455484555845568455784558845598456084561845628456384564845658456684567845688456984570845718457284573845748457584576845778457884579845808458184582845838458484585845868458784588845898459084591845928459384594845958459684597845988459984600846018460284603846048460584606846078460884609846108461184612846138461484615846168461784618846198462084621846228462384624846258462684627846288462984630846318463284633846348463584636846378463884639846408464184642846438464484645846468464784648846498465084651846528465384654846558465684657846588465984660846618466284663846648466584666846678466884669846708467184672846738467484675846768467784678846798468084681846828468384684846858468684687846888468984690846918469284693846948469584696846978469884699847008470184702847038470484705847068470784708847098471084711847128471384714847158471684717847188471984720847218472284723847248472584726847278472884729847308473184732847338473484735847368473784738847398474084741847428474384744847458474684747847488474984750847518475284753847548475584756847578475884759847608476184762847638476484765847668476784768847698477084771847728477384774847758477684777847788477984780847818478284783847848478584786847878478884789847908479184792847938479484795847968479784798847998480084801848028480384804848058480684807848088480984810848118481284813848148481584816848178481884819848208482184822848238482484825848268482784828848298483084831848328483384834848358483684837848388483984840848418484284843848448484584846848478484884849848508485184852848538485484855848568485784858848598486084861848628486384864848658486684867848688486984870848718487284873848748487584876848778487884879848808488184882848838488484885848868488784888848898489084891848928489384894848958489684897848988489984900849018490284903849048490584906849078490884909849108491184912849138491484915849168491784918849198492084921849228492384924849258492684927849288492984930849318493284933849348493584936849378493884939849408494184942849438494484945849468494784948849498495084951849528495384954849558495684957849588495984960849618496284963849648496584966849678496884969849708497184972849738497484975849768497784978849798498084981849828498384984849858498684987849888498984990849918499284993849948499584996849978499884999850008500185002850038500485005850068500785008850098501085011850128501385014850158501685017850188501985020850218502285023850248502585026850278502885029850308503185032850338503485035850368503785038850398504085041850428504385044850458504685047850488504985050850518505285053850548505585056850578505885059850608506185062850638506485065850668506785068850698507085071850728507385074850758507685077850788507985080850818508285083850848508585086850878508885089850908509185092850938509485095850968509785098850998510085101851028510385104851058510685107851088510985110851118511285113851148511585116851178511885119851208512185122851238512485125851268512785128851298513085131851328513385134851358513685137851388513985140851418514285143851448514585146851478514885149851508515185152851538515485155851568515785158851598516085161851628516385164851658516685167851688516985170851718517285173851748517585176851778517885179851808518185182851838518485185851868518785188851898519085191851928519385194851958519685197851988519985200852018520285203852048520585206852078520885209852108521185212852138521485215852168521785218852198522085221852228522385224852258522685227852288522985230852318523285233852348523585236852378523885239852408524185242852438524485245852468524785248852498525085251852528525385254852558525685257852588525985260852618526285263852648526585266852678526885269852708527185272852738527485275852768527785278852798528085281852828528385284852858528685287852888528985290852918529285293852948529585296852978529885299853008530185302853038530485305853068530785308853098531085311853128531385314853158531685317853188531985320853218532285323853248532585326853278532885329853308533185332853338533485335853368533785338853398534085341853428534385344853458534685347853488534985350853518535285353853548535585356853578535885359853608536185362853638536485365853668536785368853698537085371853728537385374853758537685377853788537985380853818538285383853848538585386853878538885389853908539185392853938539485395853968539785398853998540085401854028540385404854058540685407854088540985410854118541285413854148541585416854178541885419854208542185422854238542485425854268542785428854298543085431854328543385434854358543685437854388543985440854418544285443854448544585446854478544885449854508545185452854538545485455854568545785458854598546085461854628546385464854658546685467854688546985470854718547285473854748547585476854778547885479854808548185482854838548485485854868548785488854898549085491854928549385494854958549685497854988549985500855018550285503855048550585506855078550885509855108551185512855138551485515855168551785518855198552085521855228552385524855258552685527855288552985530855318553285533855348553585536855378553885539855408554185542855438554485545855468554785548855498555085551855528555385554855558555685557855588555985560855618556285563855648556585566855678556885569855708557185572855738557485575855768557785578855798558085581855828558385584855858558685587855888558985590855918559285593855948559585596855978559885599856008560185602856038560485605856068560785608856098561085611856128561385614856158561685617856188561985620856218562285623856248562585626856278562885629856308563185632856338563485635856368563785638856398564085641856428564385644856458564685647856488564985650856518565285653856548565585656856578565885659856608566185662856638566485665856668566785668856698567085671856728567385674856758567685677856788567985680856818568285683856848568585686856878568885689856908569185692856938569485695856968569785698856998570085701857028570385704857058570685707857088570985710857118571285713857148571585716857178571885719857208572185722857238572485725857268572785728857298573085731857328573385734857358573685737857388573985740857418574285743857448574585746857478574885749857508575185752857538575485755857568575785758857598576085761857628576385764857658576685767857688576985770857718577285773857748577585776857778577885779857808578185782857838578485785857868578785788857898579085791857928579385794857958579685797857988579985800858018580285803858048580585806858078580885809858108581185812858138581485815858168581785818858198582085821858228582385824858258582685827858288582985830858318583285833858348583585836858378583885839858408584185842858438584485845858468584785848858498585085851858528585385854858558585685857858588585985860858618586285863858648586585866858678586885869858708587185872858738587485875858768587785878858798588085881858828588385884858858588685887858888588985890858918589285893858948589585896858978589885899859008590185902859038590485905859068590785908859098591085911859128591385914859158591685917859188591985920859218592285923859248592585926859278592885929859308593185932859338593485935859368593785938859398594085941859428594385944859458594685947859488594985950859518595285953859548595585956859578595885959859608596185962859638596485965859668596785968859698597085971859728597385974859758597685977859788597985980859818598285983859848598585986859878598885989859908599185992859938599485995859968599785998859998600086001860028600386004860058600686007860088600986010860118601286013860148601586016860178601886019860208602186022860238602486025860268602786028860298603086031860328603386034860358603686037860388603986040860418604286043860448604586046860478604886049860508605186052860538605486055860568605786058860598606086061860628606386064860658606686067860688606986070860718607286073860748607586076860778607886079860808608186082860838608486085860868608786088860898609086091860928609386094860958609686097860988609986100861018610286103861048610586106861078610886109861108611186112861138611486115861168611786118861198612086121861228612386124861258612686127861288612986130861318613286133861348613586136861378613886139861408614186142861438614486145861468614786148861498615086151861528615386154861558615686157861588615986160861618616286163861648616586166861678616886169861708617186172861738617486175861768617786178861798618086181861828618386184861858618686187861888618986190861918619286193861948619586196861978619886199862008620186202862038620486205862068620786208862098621086211862128621386214862158621686217862188621986220862218622286223862248622586226862278622886229862308623186232862338623486235862368623786238862398624086241862428624386244862458624686247862488624986250862518625286253862548625586256862578625886259862608626186262862638626486265862668626786268862698627086271862728627386274862758627686277862788627986280862818628286283862848628586286862878628886289862908629186292862938629486295862968629786298862998630086301863028630386304863058630686307863088630986310863118631286313863148631586316863178631886319863208632186322863238632486325863268632786328863298633086331863328633386334863358633686337863388633986340863418634286343863448634586346863478634886349863508635186352863538635486355863568635786358863598636086361863628636386364863658636686367863688636986370863718637286373863748637586376863778637886379863808638186382863838638486385863868638786388863898639086391863928639386394863958639686397863988639986400864018640286403864048640586406864078640886409864108641186412864138641486415864168641786418864198642086421864228642386424864258642686427864288642986430864318643286433864348643586436864378643886439864408644186442864438644486445864468644786448864498645086451864528645386454864558645686457864588645986460864618646286463864648646586466864678646886469864708647186472864738647486475864768647786478864798648086481864828648386484864858648686487864888648986490864918649286493864948649586496864978649886499865008650186502865038650486505865068650786508865098651086511865128651386514865158651686517865188651986520865218652286523865248652586526865278652886529865308653186532865338653486535865368653786538865398654086541865428654386544865458654686547865488654986550865518655286553865548655586556865578655886559865608656186562865638656486565865668656786568865698657086571865728657386574865758657686577865788657986580865818658286583865848658586586865878658886589865908659186592865938659486595865968659786598865998660086601866028660386604866058660686607866088660986610866118661286613866148661586616866178661886619866208662186622866238662486625866268662786628866298663086631866328663386634866358663686637866388663986640866418664286643866448664586646866478664886649866508665186652866538665486655866568665786658866598666086661866628666386664866658666686667866688666986670866718667286673866748667586676866778667886679866808668186682866838668486685866868668786688866898669086691866928669386694866958669686697866988669986700867018670286703867048670586706867078670886709867108671186712867138671486715867168671786718867198672086721867228672386724867258672686727867288672986730867318673286733867348673586736867378673886739867408674186742867438674486745867468674786748867498675086751867528675386754867558675686757867588675986760867618676286763867648676586766867678676886769867708677186772867738677486775867768677786778867798678086781867828678386784867858678686787867888678986790867918679286793867948679586796867978679886799868008680186802868038680486805868068680786808868098681086811868128681386814868158681686817868188681986820868218682286823868248682586826868278682886829868308683186832868338683486835868368683786838868398684086841868428684386844868458684686847868488684986850868518685286853868548685586856868578685886859868608686186862868638686486865868668686786868868698687086871868728687386874868758687686877868788687986880868818688286883868848688586886868878688886889868908689186892868938689486895868968689786898868998690086901869028690386904869058690686907869088690986910869118691286913869148691586916869178691886919869208692186922869238692486925869268692786928869298693086931869328693386934869358693686937869388693986940869418694286943869448694586946869478694886949869508695186952869538695486955869568695786958869598696086961869628696386964869658696686967869688696986970869718697286973869748697586976869778697886979869808698186982869838698486985869868698786988869898699086991869928699386994869958699686997869988699987000870018700287003870048700587006870078700887009870108701187012870138701487015870168701787018870198702087021870228702387024870258702687027870288702987030870318703287033870348703587036870378703887039870408704187042870438704487045870468704787048870498705087051870528705387054870558705687057870588705987060870618706287063870648706587066870678706887069870708707187072870738707487075870768707787078870798708087081870828708387084870858708687087870888708987090870918709287093870948709587096870978709887099871008710187102871038710487105871068710787108871098711087111871128711387114871158711687117871188711987120871218712287123871248712587126871278712887129871308713187132871338713487135871368713787138871398714087141871428714387144871458714687147871488714987150871518715287153871548715587156871578715887159871608716187162871638716487165871668716787168871698717087171871728717387174871758717687177871788717987180871818718287183871848718587186871878718887189871908719187192871938719487195871968719787198871998720087201872028720387204872058720687207872088720987210872118721287213872148721587216872178721887219872208722187222872238722487225872268722787228872298723087231872328723387234872358723687237872388723987240872418724287243872448724587246872478724887249872508725187252872538725487255872568725787258872598726087261872628726387264872658726687267872688726987270872718727287273872748727587276872778727887279872808728187282872838728487285872868728787288872898729087291872928729387294872958729687297872988729987300873018730287303873048730587306873078730887309873108731187312873138731487315873168731787318873198732087321873228732387324873258732687327873288732987330873318733287333873348733587336873378733887339873408734187342873438734487345873468734787348873498735087351873528735387354873558735687357873588735987360873618736287363873648736587366873678736887369873708737187372873738737487375873768737787378873798738087381873828738387384873858738687387873888738987390873918739287393873948739587396873978739887399874008740187402874038740487405874068740787408874098741087411874128741387414874158741687417874188741987420874218742287423874248742587426874278742887429874308743187432874338743487435874368743787438874398744087441874428744387444874458744687447874488744987450874518745287453874548745587456874578745887459874608746187462874638746487465874668746787468874698747087471874728747387474874758747687477874788747987480874818748287483874848748587486874878748887489874908749187492874938749487495874968749787498874998750087501875028750387504875058750687507875088750987510875118751287513875148751587516875178751887519875208752187522875238752487525875268752787528875298753087531875328753387534875358753687537875388753987540875418754287543875448754587546875478754887549875508755187552875538755487555875568755787558875598756087561875628756387564875658756687567875688756987570875718757287573875748757587576875778757887579875808758187582875838758487585875868758787588875898759087591875928759387594875958759687597875988759987600876018760287603876048760587606876078760887609876108761187612876138761487615876168761787618876198762087621876228762387624876258762687627876288762987630876318763287633876348763587636876378763887639876408764187642876438764487645876468764787648876498765087651876528765387654876558765687657876588765987660876618766287663876648766587666876678766887669876708767187672876738767487675876768767787678876798768087681876828768387684876858768687687876888768987690876918769287693876948769587696876978769887699877008770187702877038770487705877068770787708877098771087711877128771387714877158771687717877188771987720877218772287723877248772587726877278772887729877308773187732877338773487735877368773787738877398774087741877428774387744877458774687747877488774987750877518775287753877548775587756877578775887759877608776187762877638776487765877668776787768877698777087771877728777387774877758777687777877788777987780877818778287783877848778587786877878778887789877908779187792877938779487795877968779787798877998780087801878028780387804878058780687807878088780987810878118781287813878148781587816878178781887819878208782187822878238782487825878268782787828878298783087831878328783387834878358783687837878388783987840878418784287843878448784587846878478784887849878508785187852878538785487855878568785787858878598786087861878628786387864878658786687867878688786987870878718787287873878748787587876878778787887879878808788187882878838788487885878868788787888878898789087891878928789387894878958789687897878988789987900879018790287903879048790587906879078790887909879108791187912879138791487915879168791787918879198792087921879228792387924879258792687927879288792987930879318793287933879348793587936879378793887939879408794187942879438794487945879468794787948879498795087951879528795387954879558795687957879588795987960879618796287963879648796587966879678796887969879708797187972879738797487975879768797787978879798798087981879828798387984879858798687987879888798987990879918799287993879948799587996879978799887999880008800188002880038800488005880068800788008880098801088011880128801388014880158801688017880188801988020880218802288023880248802588026880278802888029880308803188032880338803488035880368803788038880398804088041880428804388044880458804688047880488804988050880518805288053880548805588056880578805888059880608806188062880638806488065880668806788068880698807088071880728807388074880758807688077880788807988080880818808288083880848808588086880878808888089880908809188092880938809488095880968809788098880998810088101881028810388104881058810688107881088810988110881118811288113881148811588116881178811888119881208812188122881238812488125881268812788128881298813088131881328813388134881358813688137881388813988140881418814288143881448814588146881478814888149881508815188152881538815488155881568815788158881598816088161881628816388164881658816688167881688816988170881718817288173881748817588176881778817888179881808818188182881838818488185881868818788188881898819088191881928819388194881958819688197881988819988200882018820288203882048820588206882078820888209882108821188212882138821488215882168821788218882198822088221882228822388224882258822688227882288822988230882318823288233882348823588236882378823888239882408824188242882438824488245882468824788248882498825088251882528825388254882558825688257882588825988260882618826288263882648826588266882678826888269882708827188272882738827488275882768827788278882798828088281882828828388284882858828688287882888828988290882918829288293882948829588296882978829888299883008830188302883038830488305883068830788308883098831088311883128831388314883158831688317883188831988320883218832288323883248832588326883278832888329883308833188332883338833488335883368833788338883398834088341883428834388344883458834688347883488834988350883518835288353883548835588356883578835888359883608836188362883638836488365883668836788368883698837088371883728837388374883758837688377883788837988380883818838288383883848838588386883878838888389883908839188392883938839488395883968839788398883998840088401884028840388404884058840688407884088840988410884118841288413884148841588416884178841888419884208842188422884238842488425884268842788428884298843088431884328843388434884358843688437884388843988440884418844288443884448844588446884478844888449884508845188452884538845488455884568845788458884598846088461884628846388464884658846688467884688846988470884718847288473884748847588476884778847888479884808848188482884838848488485884868848788488884898849088491884928849388494884958849688497884988849988500885018850288503885048850588506885078850888509885108851188512885138851488515885168851788518885198852088521885228852388524885258852688527885288852988530885318853288533885348853588536885378853888539885408854188542885438854488545885468854788548885498855088551885528855388554885558855688557885588855988560885618856288563885648856588566885678856888569885708857188572885738857488575885768857788578885798858088581885828858388584885858858688587885888858988590885918859288593885948859588596885978859888599886008860188602886038860488605886068860788608886098861088611886128861388614886158861688617886188861988620886218862288623886248862588626886278862888629886308863188632886338863488635886368863788638886398864088641886428864388644886458864688647886488864988650886518865288653886548865588656886578865888659886608866188662886638866488665886668866788668886698867088671886728867388674886758867688677886788867988680886818868288683886848868588686886878868888689886908869188692886938869488695886968869788698886998870088701887028870388704887058870688707887088870988710887118871288713887148871588716887178871888719887208872188722887238872488725887268872788728887298873088731887328873388734887358873688737887388873988740887418874288743887448874588746887478874888749887508875188752887538875488755887568875788758887598876088761887628876388764887658876688767887688876988770887718877288773887748877588776887778877888779887808878188782887838878488785887868878788788887898879088791887928879388794887958879688797887988879988800888018880288803888048880588806888078880888809888108881188812888138881488815888168881788818888198882088821888228882388824888258882688827888288882988830888318883288833888348883588836888378883888839888408884188842888438884488845888468884788848888498885088851888528885388854888558885688857888588885988860888618886288863888648886588866888678886888869888708887188872888738887488875888768887788878888798888088881888828888388884888858888688887888888888988890888918889288893888948889588896888978889888899889008890188902889038890488905889068890788908889098891088911889128891388914889158891688917889188891988920889218892288923889248892588926889278892888929889308893188932889338893488935889368893788938889398894088941889428894388944889458894688947889488894988950889518895288953889548895588956889578895888959889608896188962889638896488965889668896788968889698897088971889728897388974889758897688977889788897988980889818898288983889848898588986889878898888989889908899188992889938899488995889968899788998889998900089001890028900389004890058900689007890088900989010890118901289013890148901589016890178901889019890208902189022890238902489025890268902789028890298903089031890328903389034890358903689037890388903989040890418904289043890448904589046890478904889049890508905189052890538905489055890568905789058890598906089061890628906389064890658906689067890688906989070890718907289073890748907589076890778907889079890808908189082890838908489085890868908789088890898909089091890928909389094890958909689097890988909989100891018910289103891048910589106891078910889109891108911189112891138911489115891168911789118891198912089121891228912389124891258912689127891288912989130891318913289133891348913589136891378913889139891408914189142891438914489145891468914789148891498915089151891528915389154891558915689157891588915989160891618916289163891648916589166891678916889169891708917189172891738917489175891768917789178891798918089181891828918389184891858918689187891888918989190891918919289193891948919589196891978919889199892008920189202892038920489205892068920789208892098921089211892128921389214892158921689217892188921989220892218922289223892248922589226892278922889229892308923189232892338923489235892368923789238892398924089241892428924389244892458924689247892488924989250892518925289253892548925589256892578925889259892608926189262892638926489265892668926789268892698927089271892728927389274892758927689277892788927989280892818928289283892848928589286892878928889289892908929189292892938929489295892968929789298892998930089301893028930389304893058930689307893088930989310893118931289313893148931589316893178931889319893208932189322893238932489325893268932789328893298933089331893328933389334893358933689337893388933989340893418934289343893448934589346893478934889349893508935189352893538935489355893568935789358893598936089361893628936389364893658936689367893688936989370893718937289373893748937589376893778937889379893808938189382893838938489385893868938789388893898939089391893928939389394893958939689397893988939989400894018940289403894048940589406894078940889409894108941189412894138941489415894168941789418894198942089421894228942389424894258942689427894288942989430894318943289433894348943589436894378943889439894408944189442894438944489445894468944789448894498945089451894528945389454894558945689457894588945989460894618946289463894648946589466894678946889469894708947189472894738947489475894768947789478894798948089481894828948389484894858948689487894888948989490894918949289493894948949589496894978949889499895008950189502895038950489505895068950789508895098951089511895128951389514895158951689517895188951989520895218952289523895248952589526895278952889529895308953189532895338953489535895368953789538895398954089541895428954389544895458954689547895488954989550895518955289553895548955589556895578955889559895608956189562895638956489565895668956789568895698957089571895728957389574895758957689577895788957989580895818958289583895848958589586895878958889589895908959189592895938959489595895968959789598895998960089601896028960389604896058960689607896088960989610896118961289613896148961589616896178961889619896208962189622896238962489625896268962789628896298963089631896328963389634896358963689637896388963989640896418964289643896448964589646896478964889649896508965189652896538965489655896568965789658896598966089661896628966389664896658966689667896688966989670896718967289673896748967589676896778967889679896808968189682896838968489685896868968789688896898969089691896928969389694896958969689697896988969989700897018970289703897048970589706897078970889709897108971189712897138971489715897168971789718897198972089721897228972389724897258972689727897288972989730897318973289733897348973589736897378973889739897408974189742897438974489745897468974789748897498975089751897528975389754897558975689757897588975989760897618976289763897648976589766897678976889769897708977189772897738977489775897768977789778897798978089781897828978389784897858978689787897888978989790897918979289793897948979589796897978979889799898008980189802898038980489805898068980789808898098981089811898128981389814898158981689817898188981989820898218982289823898248982589826898278982889829898308983189832898338983489835898368983789838898398984089841898428984389844898458984689847898488984989850898518985289853898548985589856898578985889859898608986189862898638986489865898668986789868898698987089871898728987389874898758987689877898788987989880898818988289883898848988589886898878988889889898908989189892898938989489895898968989789898898998990089901899028990389904899058990689907899088990989910899118991289913899148991589916899178991889919899208992189922899238992489925899268992789928899298993089931899328993389934899358993689937899388993989940899418994289943899448994589946899478994889949899508995189952899538995489955899568995789958899598996089961899628996389964899658996689967899688996989970899718997289973899748997589976899778997889979899808998189982899838998489985899868998789988899898999089991899928999389994899958999689997899988999990000900019000290003900049000590006900079000890009900109001190012900139001490015900169001790018900199002090021900229002390024900259002690027900289002990030900319003290033900349003590036900379003890039900409004190042900439004490045900469004790048900499005090051900529005390054900559005690057900589005990060900619006290063900649006590066900679006890069900709007190072900739007490075900769007790078900799008090081900829008390084900859008690087900889008990090900919009290093900949009590096900979009890099901009010190102901039010490105901069010790108901099011090111901129011390114901159011690117901189011990120901219012290123901249012590126901279012890129901309013190132901339013490135901369013790138901399014090141901429014390144901459014690147901489014990150901519015290153901549015590156901579015890159901609016190162901639016490165901669016790168901699017090171901729017390174901759017690177901789017990180901819018290183901849018590186901879018890189901909019190192901939019490195901969019790198901999020090201902029020390204902059020690207902089020990210902119021290213902149021590216902179021890219902209022190222902239022490225902269022790228902299023090231902329023390234902359023690237902389023990240902419024290243902449024590246902479024890249902509025190252902539025490255902569025790258902599026090261902629026390264902659026690267902689026990270902719027290273902749027590276902779027890279902809028190282902839028490285902869028790288902899029090291902929029390294902959029690297902989029990300903019030290303903049030590306903079030890309903109031190312903139031490315903169031790318903199032090321903229032390324903259032690327903289032990330903319033290333903349033590336903379033890339903409034190342903439034490345903469034790348903499035090351903529035390354903559035690357903589035990360903619036290363903649036590366903679036890369903709037190372903739037490375903769037790378903799038090381903829038390384903859038690387903889038990390903919039290393903949039590396903979039890399904009040190402904039040490405904069040790408904099041090411904129041390414904159041690417904189041990420904219042290423904249042590426904279042890429904309043190432904339043490435904369043790438904399044090441904429044390444904459044690447904489044990450904519045290453904549045590456904579045890459904609046190462904639046490465904669046790468904699047090471904729047390474904759047690477904789047990480904819048290483904849048590486904879048890489904909049190492904939049490495904969049790498904999050090501905029050390504905059050690507905089050990510905119051290513905149051590516905179051890519905209052190522905239052490525905269052790528905299053090531905329053390534905359053690537905389053990540905419054290543905449054590546905479054890549905509055190552905539055490555905569055790558905599056090561905629056390564905659056690567905689056990570905719057290573905749057590576905779057890579905809058190582905839058490585905869058790588905899059090591905929059390594905959059690597905989059990600906019060290603906049060590606906079060890609906109061190612906139061490615906169061790618906199062090621906229062390624906259062690627906289062990630906319063290633906349063590636906379063890639906409064190642906439064490645906469064790648906499065090651906529065390654906559065690657906589065990660906619066290663906649066590666906679066890669906709067190672906739067490675906769067790678906799068090681906829068390684906859068690687906889068990690906919069290693906949069590696906979069890699907009070190702907039070490705907069070790708907099071090711907129071390714907159071690717907189071990720907219072290723907249072590726907279072890729907309073190732907339073490735907369073790738907399074090741907429074390744907459074690747907489074990750907519075290753907549075590756907579075890759907609076190762907639076490765907669076790768907699077090771907729077390774907759077690777907789077990780907819078290783907849078590786907879078890789907909079190792907939079490795907969079790798907999080090801908029080390804908059080690807908089080990810908119081290813908149081590816908179081890819908209082190822908239082490825908269082790828908299083090831908329083390834908359083690837908389083990840908419084290843908449084590846908479084890849908509085190852908539085490855908569085790858908599086090861908629086390864908659086690867908689086990870908719087290873908749087590876908779087890879908809088190882908839088490885908869088790888908899089090891908929089390894908959089690897908989089990900909019090290903909049090590906909079090890909909109091190912909139091490915909169091790918909199092090921909229092390924909259092690927909289092990930909319093290933909349093590936909379093890939909409094190942909439094490945909469094790948909499095090951909529095390954909559095690957909589095990960909619096290963909649096590966909679096890969909709097190972909739097490975909769097790978909799098090981909829098390984909859098690987909889098990990909919099290993909949099590996909979099890999910009100191002910039100491005910069100791008910099101091011910129101391014910159101691017910189101991020910219102291023910249102591026910279102891029910309103191032910339103491035910369103791038910399104091041910429104391044910459104691047910489104991050910519105291053910549105591056910579105891059910609106191062910639106491065910669106791068910699107091071910729107391074910759107691077910789107991080910819108291083910849108591086910879108891089910909109191092910939109491095910969109791098910999110091101911029110391104911059110691107911089110991110911119111291113911149111591116911179111891119911209112191122911239112491125911269112791128911299113091131911329113391134911359113691137911389113991140911419114291143911449114591146911479114891149911509115191152911539115491155911569115791158911599116091161911629116391164911659116691167911689116991170911719117291173911749117591176911779117891179911809118191182911839118491185911869118791188911899119091191911929119391194911959119691197911989119991200912019120291203912049120591206912079120891209912109121191212912139121491215912169121791218912199122091221912229122391224912259122691227912289122991230912319123291233912349123591236912379123891239912409124191242912439124491245912469124791248912499125091251912529125391254912559125691257912589125991260912619126291263912649126591266912679126891269912709127191272912739127491275912769127791278912799128091281912829128391284912859128691287912889128991290912919129291293912949129591296912979129891299913009130191302913039130491305913069130791308913099131091311913129131391314913159131691317913189131991320913219132291323913249132591326913279132891329913309133191332913339133491335913369133791338913399134091341913429134391344913459134691347913489134991350913519135291353913549135591356913579135891359913609136191362913639136491365913669136791368913699137091371913729137391374913759137691377913789137991380913819138291383913849138591386913879138891389913909139191392913939139491395913969139791398913999140091401914029140391404914059140691407914089140991410914119141291413914149141591416914179141891419914209142191422914239142491425914269142791428914299143091431914329143391434914359143691437914389143991440914419144291443914449144591446914479144891449914509145191452914539145491455914569145791458914599146091461914629146391464914659146691467914689146991470914719147291473914749147591476914779147891479914809148191482914839148491485914869148791488914899149091491914929149391494914959149691497914989149991500915019150291503915049150591506915079150891509915109151191512915139151491515915169151791518915199152091521915229152391524915259152691527915289152991530915319153291533915349153591536915379153891539915409154191542915439154491545915469154791548915499155091551915529155391554915559155691557915589155991560915619156291563915649156591566915679156891569915709157191572915739157491575915769157791578915799158091581915829158391584915859158691587915889158991590915919159291593915949159591596915979159891599916009160191602916039160491605916069160791608916099161091611916129161391614916159161691617916189161991620916219162291623916249162591626916279162891629916309163191632916339163491635916369163791638916399164091641916429164391644916459164691647916489164991650916519165291653916549165591656916579165891659916609166191662916639166491665916669166791668916699167091671916729167391674916759167691677916789167991680916819168291683916849168591686916879168891689916909169191692916939169491695916969169791698916999170091701917029170391704917059170691707917089170991710917119171291713917149171591716917179171891719917209172191722917239172491725917269172791728917299173091731917329173391734917359173691737917389173991740917419174291743917449174591746917479174891749917509175191752917539175491755917569175791758917599176091761917629176391764917659176691767917689176991770917719177291773917749177591776917779177891779917809178191782917839178491785917869178791788917899179091791917929179391794917959179691797917989179991800918019180291803918049180591806918079180891809918109181191812918139181491815918169181791818918199182091821918229182391824918259182691827918289182991830918319183291833918349183591836918379183891839918409184191842918439184491845918469184791848918499185091851918529185391854918559185691857918589185991860918619186291863918649186591866918679186891869918709187191872918739187491875918769187791878918799188091881918829188391884918859188691887918889188991890918919189291893918949189591896918979189891899919009190191902919039190491905919069190791908919099191091911919129191391914919159191691917919189191991920919219192291923919249192591926919279192891929919309193191932919339193491935919369193791938919399194091941919429194391944919459194691947919489194991950919519195291953919549195591956919579195891959919609196191962919639196491965919669196791968919699197091971919729197391974919759197691977919789197991980919819198291983919849198591986919879198891989919909199191992919939199491995919969199791998919999200092001920029200392004920059200692007920089200992010920119201292013920149201592016920179201892019920209202192022920239202492025920269202792028920299203092031920329203392034920359203692037920389203992040920419204292043920449204592046920479204892049920509205192052920539205492055920569205792058920599206092061920629206392064920659206692067920689206992070920719207292073920749207592076920779207892079920809208192082920839208492085920869208792088920899209092091920929209392094920959209692097920989209992100921019210292103921049210592106921079210892109921109211192112921139211492115921169211792118921199212092121921229212392124921259212692127921289212992130921319213292133921349213592136921379213892139921409214192142921439214492145921469214792148921499215092151921529215392154921559215692157921589215992160921619216292163921649216592166921679216892169921709217192172921739217492175921769217792178921799218092181921829218392184921859218692187921889218992190921919219292193921949219592196921979219892199922009220192202922039220492205922069220792208922099221092211922129221392214922159221692217922189221992220922219222292223922249222592226922279222892229922309223192232922339223492235922369223792238922399224092241922429224392244922459224692247922489224992250922519225292253922549225592256922579225892259922609226192262922639226492265922669226792268922699227092271922729227392274922759227692277922789227992280922819228292283922849228592286922879228892289922909229192292922939229492295922969229792298922999230092301923029230392304923059230692307923089230992310923119231292313923149231592316923179231892319923209232192322923239232492325923269232792328923299233092331923329233392334923359233692337923389233992340923419234292343923449234592346923479234892349923509235192352923539235492355923569235792358923599236092361923629236392364923659236692367923689236992370923719237292373923749237592376923779237892379923809238192382923839238492385923869238792388923899239092391923929239392394923959239692397923989239992400924019240292403924049240592406924079240892409924109241192412924139241492415924169241792418924199242092421924229242392424924259242692427924289242992430924319243292433924349243592436924379243892439924409244192442924439244492445924469244792448924499245092451924529245392454924559245692457924589245992460924619246292463924649246592466924679246892469924709247192472924739247492475924769247792478924799248092481924829248392484924859248692487924889248992490924919249292493924949249592496924979249892499925009250192502925039250492505925069250792508925099251092511925129251392514925159251692517925189251992520925219252292523925249252592526925279252892529925309253192532925339253492535925369253792538925399254092541925429254392544925459254692547925489254992550925519255292553925549255592556925579255892559925609256192562925639256492565925669256792568925699257092571925729257392574925759257692577925789257992580925819258292583925849258592586925879258892589925909259192592925939259492595925969259792598925999260092601926029260392604926059260692607926089260992610926119261292613926149261592616926179261892619926209262192622926239262492625926269262792628926299263092631926329263392634926359263692637926389263992640926419264292643926449264592646926479264892649926509265192652926539265492655926569265792658926599266092661926629266392664926659266692667926689266992670926719267292673926749267592676926779267892679926809268192682926839268492685926869268792688926899269092691926929269392694926959269692697926989269992700927019270292703927049270592706927079270892709927109271192712927139271492715927169271792718927199272092721927229272392724927259272692727927289272992730927319273292733927349273592736927379273892739927409274192742927439274492745927469274792748927499275092751927529275392754927559275692757927589275992760927619276292763927649276592766927679276892769927709277192772927739277492775927769277792778927799278092781927829278392784927859278692787927889278992790927919279292793927949279592796927979279892799928009280192802928039280492805928069280792808928099281092811928129281392814928159281692817928189281992820928219282292823928249282592826928279282892829928309283192832928339283492835928369283792838928399284092841928429284392844928459284692847928489284992850928519285292853928549285592856928579285892859928609286192862928639286492865928669286792868928699287092871928729287392874928759287692877928789287992880928819288292883928849288592886928879288892889928909289192892928939289492895928969289792898928999290092901929029290392904929059290692907929089290992910929119291292913929149291592916929179291892919929209292192922929239292492925929269292792928929299293092931929329293392934929359293692937929389293992940929419294292943929449294592946929479294892949929509295192952929539295492955929569295792958929599296092961929629296392964929659296692967929689296992970929719297292973929749297592976929779297892979929809298192982929839298492985929869298792988929899299092991929929299392994929959299692997929989299993000930019300293003930049300593006930079300893009930109301193012930139301493015930169301793018930199302093021930229302393024930259302693027930289302993030930319303293033930349303593036930379303893039930409304193042930439304493045930469304793048930499305093051930529305393054930559305693057930589305993060930619306293063930649306593066930679306893069930709307193072930739307493075930769307793078930799308093081930829308393084930859308693087930889308993090930919309293093930949309593096930979309893099931009310193102931039310493105931069310793108931099311093111931129311393114931159311693117931189311993120931219312293123931249312593126931279312893129931309313193132931339313493135931369313793138931399314093141931429314393144931459314693147931489314993150931519315293153931549315593156931579315893159931609316193162931639316493165931669316793168931699317093171931729317393174931759317693177931789317993180931819318293183931849318593186931879318893189931909319193192931939319493195931969319793198931999320093201932029320393204932059320693207932089320993210932119321293213932149321593216932179321893219932209322193222932239322493225932269322793228932299323093231932329323393234932359323693237932389323993240932419324293243932449324593246932479324893249932509325193252932539325493255932569325793258932599326093261932629326393264932659326693267932689326993270932719327293273932749327593276932779327893279932809328193282932839328493285932869328793288932899329093291932929329393294932959329693297932989329993300933019330293303933049330593306933079330893309933109331193312933139331493315933169331793318933199332093321933229332393324933259332693327933289332993330933319333293333933349333593336933379333893339933409334193342933439334493345933469334793348933499335093351933529335393354933559335693357933589335993360933619336293363933649336593366933679336893369933709337193372933739337493375933769337793378933799338093381933829338393384933859338693387933889338993390933919339293393933949339593396933979339893399934009340193402934039340493405934069340793408934099341093411934129341393414934159341693417934189341993420934219342293423934249342593426934279342893429934309343193432934339343493435934369343793438934399344093441934429344393444934459344693447934489344993450934519345293453934549345593456934579345893459934609346193462934639346493465934669346793468934699347093471934729347393474934759347693477934789347993480934819348293483934849348593486934879348893489934909349193492934939349493495934969349793498934999350093501935029350393504935059350693507935089350993510935119351293513935149351593516935179351893519935209352193522935239352493525935269352793528935299353093531935329353393534935359353693537935389353993540935419354293543935449354593546935479354893549935509355193552935539355493555935569355793558935599356093561935629356393564935659356693567935689356993570935719357293573935749357593576935779357893579935809358193582935839358493585935869358793588935899359093591935929359393594935959359693597935989359993600936019360293603936049360593606936079360893609936109361193612936139361493615936169361793618936199362093621936229362393624936259362693627936289362993630936319363293633936349363593636936379363893639936409364193642936439364493645936469364793648936499365093651936529365393654936559365693657936589365993660936619366293663936649366593666936679366893669936709367193672936739367493675936769367793678936799368093681936829368393684936859368693687936889368993690936919369293693936949369593696936979369893699937009370193702937039370493705937069370793708937099371093711937129371393714937159371693717937189371993720937219372293723937249372593726937279372893729937309373193732937339373493735937369373793738937399374093741937429374393744937459374693747937489374993750937519375293753937549375593756937579375893759937609376193762937639376493765937669376793768937699377093771937729377393774937759377693777937789377993780937819378293783937849378593786937879378893789937909379193792937939379493795937969379793798937999380093801938029380393804938059380693807938089380993810938119381293813938149381593816938179381893819938209382193822938239382493825938269382793828938299383093831938329383393834938359383693837938389383993840938419384293843938449384593846938479384893849938509385193852938539385493855938569385793858938599386093861938629386393864938659386693867938689386993870938719387293873938749387593876938779387893879938809388193882938839388493885938869388793888938899389093891938929389393894938959389693897938989389993900939019390293903939049390593906939079390893909939109391193912939139391493915939169391793918939199392093921939229392393924939259392693927939289392993930939319393293933939349393593936939379393893939939409394193942939439394493945939469394793948939499395093951939529395393954939559395693957939589395993960939619396293963939649396593966939679396893969939709397193972939739397493975939769397793978939799398093981939829398393984939859398693987939889398993990939919399293993939949399593996939979399893999940009400194002940039400494005940069400794008940099401094011940129401394014940159401694017940189401994020940219402294023940249402594026940279402894029940309403194032940339403494035940369403794038940399404094041940429404394044940459404694047940489404994050940519405294053940549405594056940579405894059940609406194062940639406494065940669406794068940699407094071940729407394074940759407694077940789407994080940819408294083940849408594086940879408894089940909409194092940939409494095940969409794098940999410094101941029410394104941059410694107941089410994110941119411294113941149411594116941179411894119941209412194122941239412494125941269412794128941299413094131941329413394134941359413694137941389413994140941419414294143941449414594146941479414894149941509415194152941539415494155941569415794158941599416094161941629416394164941659416694167941689416994170941719417294173941749417594176941779417894179941809418194182941839418494185941869418794188941899419094191941929419394194941959419694197941989419994200942019420294203942049420594206942079420894209942109421194212942139421494215942169421794218942199422094221942229422394224942259422694227942289422994230942319423294233942349423594236942379423894239942409424194242942439424494245942469424794248942499425094251942529425394254942559425694257942589425994260942619426294263942649426594266942679426894269942709427194272942739427494275942769427794278942799428094281942829428394284942859428694287942889428994290942919429294293942949429594296942979429894299943009430194302943039430494305943069430794308943099431094311943129431394314943159431694317943189431994320943219432294323943249432594326943279432894329943309433194332943339433494335943369433794338943399434094341943429434394344943459434694347943489434994350943519435294353943549435594356943579435894359943609436194362943639436494365943669436794368943699437094371943729437394374943759437694377943789437994380943819438294383943849438594386943879438894389943909439194392943939439494395943969439794398943999440094401944029440394404944059440694407944089440994410944119441294413944149441594416944179441894419944209442194422944239442494425944269442794428944299443094431944329443394434944359443694437944389443994440944419444294443944449444594446944479444894449944509445194452944539445494455944569445794458944599446094461944629446394464944659446694467944689446994470944719447294473944749447594476944779447894479944809448194482944839448494485944869448794488944899449094491944929449394494944959449694497944989449994500945019450294503945049450594506945079450894509945109451194512945139451494515945169451794518945199452094521945229452394524945259452694527945289452994530945319453294533945349453594536945379453894539945409454194542945439454494545945469454794548945499455094551945529455394554945559455694557945589455994560945619456294563945649456594566945679456894569945709457194572945739457494575945769457794578945799458094581945829458394584945859458694587945889458994590945919459294593945949459594596945979459894599946009460194602946039460494605946069460794608946099461094611946129461394614946159461694617946189461994620946219462294623946249462594626946279462894629946309463194632946339463494635946369463794638946399464094641946429464394644946459464694647946489464994650946519465294653946549465594656946579465894659946609466194662946639466494665946669466794668946699467094671946729467394674946759467694677946789467994680946819468294683946849468594686946879468894689946909469194692946939469494695946969469794698946999470094701947029470394704947059470694707947089470994710947119471294713947149471594716947179471894719947209472194722947239472494725947269472794728947299473094731947329473394734947359473694737947389473994740947419474294743947449474594746947479474894749947509475194752947539475494755947569475794758947599476094761947629476394764947659476694767947689476994770947719477294773947749477594776947779477894779947809478194782947839478494785947869478794788947899479094791947929479394794947959479694797947989479994800948019480294803948049480594806948079480894809948109481194812948139481494815948169481794818948199482094821948229482394824948259482694827948289482994830948319483294833948349483594836948379483894839948409484194842948439484494845948469484794848948499485094851948529485394854948559485694857948589485994860948619486294863948649486594866948679486894869948709487194872948739487494875948769487794878948799488094881948829488394884948859488694887948889488994890948919489294893948949489594896948979489894899949009490194902949039490494905949069490794908949099491094911949129491394914949159491694917949189491994920949219492294923949249492594926949279492894929949309493194932949339493494935949369493794938949399494094941949429494394944949459494694947949489494994950949519495294953949549495594956949579495894959949609496194962949639496494965949669496794968949699497094971949729497394974949759497694977949789497994980949819498294983949849498594986949879498894989949909499194992949939499494995949969499794998949999500095001950029500395004950059500695007950089500995010950119501295013950149501595016950179501895019950209502195022950239502495025950269502795028950299503095031950329503395034950359503695037950389503995040950419504295043950449504595046950479504895049950509505195052950539505495055950569505795058950599506095061950629506395064950659506695067950689506995070950719507295073950749507595076950779507895079950809508195082950839508495085950869508795088950899509095091950929509395094950959509695097950989509995100951019510295103951049510595106951079510895109951109511195112951139511495115951169511795118951199512095121951229512395124951259512695127951289512995130951319513295133951349513595136951379513895139951409514195142951439514495145951469514795148951499515095151951529515395154951559515695157951589515995160951619516295163951649516595166951679516895169951709517195172951739517495175951769517795178951799518095181951829518395184951859518695187951889518995190951919519295193951949519595196951979519895199952009520195202952039520495205952069520795208952099521095211952129521395214952159521695217952189521995220952219522295223952249522595226952279522895229952309523195232952339523495235952369523795238952399524095241952429524395244952459524695247952489524995250952519525295253952549525595256952579525895259952609526195262952639526495265952669526795268952699527095271952729527395274952759527695277952789527995280952819528295283952849528595286952879528895289952909529195292952939529495295952969529795298952999530095301953029530395304953059530695307953089530995310953119531295313953149531595316953179531895319953209532195322953239532495325953269532795328953299533095331953329533395334953359533695337953389533995340953419534295343953449534595346953479534895349953509535195352953539535495355953569535795358953599536095361953629536395364953659536695367953689536995370953719537295373953749537595376953779537895379953809538195382953839538495385953869538795388953899539095391953929539395394953959539695397953989539995400954019540295403954049540595406954079540895409954109541195412954139541495415954169541795418954199542095421954229542395424954259542695427954289542995430954319543295433954349543595436954379543895439954409544195442954439544495445954469544795448954499545095451954529545395454954559545695457954589545995460954619546295463954649546595466954679546895469954709547195472954739547495475954769547795478954799548095481954829548395484954859548695487954889548995490954919549295493954949549595496954979549895499955009550195502955039550495505955069550795508955099551095511955129551395514955159551695517955189551995520955219552295523955249552595526955279552895529955309553195532955339553495535955369553795538955399554095541955429554395544955459554695547955489554995550955519555295553955549555595556955579555895559955609556195562955639556495565955669556795568955699557095571955729557395574955759557695577955789557995580955819558295583955849558595586955879558895589955909559195592955939559495595955969559795598955999560095601956029560395604956059560695607956089560995610956119561295613956149561595616956179561895619956209562195622956239562495625956269562795628956299563095631956329563395634956359563695637956389563995640956419564295643956449564595646956479564895649956509565195652956539565495655956569565795658956599566095661956629566395664956659566695667956689566995670956719567295673956749567595676956779567895679956809568195682956839568495685956869568795688956899569095691956929569395694956959569695697956989569995700957019570295703957049570595706957079570895709957109571195712957139571495715957169571795718957199572095721957229572395724957259572695727957289572995730957319573295733957349573595736957379573895739957409574195742957439574495745957469574795748957499575095751957529575395754957559575695757957589575995760957619576295763957649576595766957679576895769957709577195772957739577495775957769577795778957799578095781957829578395784957859578695787957889578995790957919579295793957949579595796957979579895799958009580195802958039580495805958069580795808958099581095811958129581395814958159581695817958189581995820958219582295823958249582595826958279582895829958309583195832958339583495835958369583795838958399584095841958429584395844958459584695847958489584995850958519585295853958549585595856958579585895859958609586195862958639586495865958669586795868958699587095871958729587395874958759587695877958789587995880958819588295883958849588595886958879588895889958909589195892958939589495895958969589795898958999590095901959029590395904959059590695907959089590995910959119591295913959149591595916959179591895919959209592195922959239592495925959269592795928959299593095931959329593395934959359593695937959389593995940959419594295943959449594595946959479594895949959509595195952959539595495955959569595795958959599596095961959629596395964959659596695967959689596995970959719597295973959749597595976959779597895979959809598195982959839598495985959869598795988959899599095991959929599395994959959599695997959989599996000960019600296003960049600596006960079600896009960109601196012960139601496015960169601796018960199602096021960229602396024960259602696027960289602996030960319603296033960349603596036960379603896039960409604196042960439604496045960469604796048960499605096051960529605396054960559605696057960589605996060960619606296063960649606596066960679606896069960709607196072960739607496075960769607796078960799608096081960829608396084960859608696087960889608996090960919609296093960949609596096960979609896099961009610196102961039610496105961069610796108961099611096111961129611396114961159611696117961189611996120961219612296123961249612596126961279612896129961309613196132961339613496135961369613796138961399614096141961429614396144961459614696147961489614996150961519615296153961549615596156961579615896159961609616196162961639616496165961669616796168961699617096171961729617396174961759617696177961789617996180961819618296183961849618596186961879618896189961909619196192961939619496195961969619796198961999620096201962029620396204962059620696207962089620996210962119621296213962149621596216962179621896219962209622196222962239622496225962269622796228962299623096231962329623396234962359623696237962389623996240962419624296243962449624596246962479624896249962509625196252962539625496255962569625796258962599626096261962629626396264962659626696267962689626996270962719627296273962749627596276962779627896279962809628196282962839628496285962869628796288962899629096291962929629396294962959629696297962989629996300963019630296303963049630596306963079630896309963109631196312963139631496315963169631796318963199632096321963229632396324963259632696327963289632996330963319633296333963349633596336963379633896339963409634196342963439634496345963469634796348963499635096351963529635396354963559635696357963589635996360963619636296363963649636596366963679636896369963709637196372963739637496375963769637796378963799638096381963829638396384963859638696387963889638996390963919639296393963949639596396963979639896399964009640196402964039640496405964069640796408964099641096411964129641396414964159641696417964189641996420964219642296423964249642596426964279642896429964309643196432964339643496435964369643796438964399644096441964429644396444964459644696447964489644996450964519645296453964549645596456964579645896459964609646196462964639646496465964669646796468964699647096471964729647396474964759647696477964789647996480964819648296483964849648596486964879648896489964909649196492964939649496495964969649796498964999650096501965029650396504965059650696507965089650996510965119651296513965149651596516965179651896519965209652196522965239652496525965269652796528965299653096531965329653396534965359653696537965389653996540965419654296543965449654596546965479654896549965509655196552965539655496555965569655796558965599656096561965629656396564965659656696567965689656996570965719657296573965749657596576965779657896579965809658196582965839658496585965869658796588965899659096591965929659396594965959659696597965989659996600966019660296603966049660596606966079660896609966109661196612966139661496615966169661796618966199662096621966229662396624966259662696627966289662996630966319663296633966349663596636966379663896639966409664196642966439664496645966469664796648966499665096651966529665396654966559665696657966589665996660966619666296663966649666596666966679666896669966709667196672966739667496675966769667796678966799668096681966829668396684966859668696687966889668996690966919669296693966949669596696966979669896699967009670196702967039670496705967069670796708967099671096711967129671396714967159671696717967189671996720967219672296723967249672596726967279672896729967309673196732967339673496735967369673796738967399674096741967429674396744967459674696747967489674996750967519675296753967549675596756967579675896759967609676196762967639676496765967669676796768967699677096771967729677396774967759677696777967789677996780967819678296783967849678596786967879678896789967909679196792967939679496795967969679796798967999680096801968029680396804968059680696807968089680996810968119681296813968149681596816968179681896819968209682196822968239682496825968269682796828968299683096831968329683396834968359683696837968389683996840968419684296843968449684596846968479684896849968509685196852968539685496855968569685796858968599686096861968629686396864968659686696867968689686996870968719687296873968749687596876968779687896879968809688196882968839688496885968869688796888968899689096891968929689396894968959689696897968989689996900969019690296903969049690596906969079690896909969109691196912969139691496915969169691796918969199692096921969229692396924969259692696927969289692996930969319693296933969349693596936969379693896939969409694196942969439694496945969469694796948969499695096951969529695396954969559695696957969589695996960969619696296963969649696596966969679696896969969709697196972969739697496975969769697796978969799698096981969829698396984969859698696987969889698996990969919699296993969949699596996969979699896999970009700197002970039700497005970069700797008970099701097011970129701397014970159701697017970189701997020970219702297023970249702597026970279702897029970309703197032970339703497035970369703797038970399704097041970429704397044970459704697047970489704997050970519705297053970549705597056970579705897059970609706197062970639706497065970669706797068970699707097071970729707397074970759707697077970789707997080970819708297083970849708597086970879708897089970909709197092970939709497095970969709797098970999710097101971029710397104971059710697107971089710997110971119711297113971149711597116971179711897119971209712197122971239712497125971269712797128971299713097131971329713397134971359713697137971389713997140971419714297143971449714597146971479714897149971509715197152971539715497155971569715797158971599716097161971629716397164971659716697167971689716997170971719717297173971749717597176971779717897179971809718197182971839718497185971869718797188971899719097191971929719397194971959719697197971989719997200972019720297203972049720597206972079720897209972109721197212972139721497215972169721797218972199722097221972229722397224972259722697227972289722997230972319723297233972349723597236972379723897239972409724197242972439724497245972469724797248972499725097251972529725397254972559725697257972589725997260972619726297263972649726597266972679726897269972709727197272972739727497275972769727797278972799728097281972829728397284972859728697287972889728997290972919729297293972949729597296972979729897299973009730197302973039730497305973069730797308973099731097311973129731397314973159731697317973189731997320973219732297323973249732597326973279732897329973309733197332973339733497335973369733797338973399734097341973429734397344973459734697347973489734997350973519735297353973549735597356973579735897359973609736197362973639736497365973669736797368973699737097371973729737397374973759737697377973789737997380973819738297383973849738597386973879738897389973909739197392973939739497395973969739797398973999740097401974029740397404974059740697407974089740997410974119741297413974149741597416974179741897419974209742197422974239742497425974269742797428974299743097431974329743397434974359743697437974389743997440974419744297443974449744597446974479744897449974509745197452974539745497455974569745797458974599746097461974629746397464974659746697467974689746997470974719747297473974749747597476974779747897479974809748197482974839748497485974869748797488974899749097491974929749397494974959749697497974989749997500975019750297503975049750597506975079750897509975109751197512975139751497515975169751797518975199752097521975229752397524975259752697527975289752997530975319753297533975349753597536975379753897539975409754197542975439754497545975469754797548975499755097551975529755397554975559755697557975589755997560975619756297563975649756597566975679756897569975709757197572975739757497575975769757797578975799758097581975829758397584975859758697587975889758997590975919759297593975949759597596975979759897599976009760197602976039760497605976069760797608976099761097611976129761397614976159761697617976189761997620976219762297623976249762597626976279762897629976309763197632976339763497635976369763797638976399764097641976429764397644976459764697647976489764997650976519765297653976549765597656976579765897659976609766197662976639766497665976669766797668976699767097671976729767397674976759767697677976789767997680976819768297683976849768597686976879768897689976909769197692976939769497695976969769797698976999770097701977029770397704977059770697707977089770997710977119771297713977149771597716977179771897719977209772197722977239772497725977269772797728977299773097731977329773397734977359773697737977389773997740977419774297743977449774597746977479774897749977509775197752977539775497755977569775797758977599776097761977629776397764977659776697767977689776997770977719777297773977749777597776977779777897779977809778197782977839778497785977869778797788977899779097791977929779397794977959779697797977989779997800978019780297803978049780597806978079780897809978109781197812978139781497815978169781797818978199782097821978229782397824978259782697827978289782997830978319783297833978349783597836978379783897839978409784197842978439784497845978469784797848978499785097851978529785397854978559785697857978589785997860978619786297863978649786597866978679786897869978709787197872978739787497875978769787797878978799788097881978829788397884978859788697887978889788997890978919789297893978949789597896978979789897899979009790197902979039790497905979069790797908979099791097911979129791397914979159791697917979189791997920979219792297923979249792597926979279792897929979309793197932979339793497935979369793797938979399794097941979429794397944979459794697947979489794997950979519795297953979549795597956979579795897959979609796197962979639796497965979669796797968979699797097971979729797397974979759797697977979789797997980979819798297983979849798597986979879798897989979909799197992979939799497995979969799797998979999800098001980029800398004980059800698007980089800998010980119801298013980149801598016980179801898019980209802198022980239802498025980269802798028980299803098031980329803398034980359803698037980389803998040980419804298043980449804598046980479804898049980509805198052980539805498055980569805798058980599806098061980629806398064980659806698067980689806998070980719807298073980749807598076980779807898079980809808198082980839808498085980869808798088980899809098091980929809398094980959809698097980989809998100981019810298103981049810598106981079810898109981109811198112981139811498115981169811798118981199812098121981229812398124981259812698127981289812998130981319813298133981349813598136981379813898139981409814198142981439814498145981469814798148981499815098151981529815398154981559815698157981589815998160981619816298163981649816598166981679816898169981709817198172981739817498175981769817798178981799818098181981829818398184981859818698187981889818998190981919819298193981949819598196981979819898199982009820198202982039820498205982069820798208982099821098211982129821398214982159821698217982189821998220982219822298223982249822598226982279822898229982309823198232982339823498235982369823798238982399824098241982429824398244982459824698247982489824998250982519825298253982549825598256982579825898259982609826198262982639826498265982669826798268982699827098271982729827398274982759827698277982789827998280982819828298283982849828598286982879828898289982909829198292982939829498295982969829798298982999830098301983029830398304983059830698307983089830998310983119831298313983149831598316983179831898319983209832198322983239832498325983269832798328983299833098331983329833398334983359833698337983389833998340983419834298343983449834598346983479834898349983509835198352983539835498355983569835798358983599836098361983629836398364983659836698367983689836998370983719837298373983749837598376983779837898379983809838198382983839838498385983869838798388983899839098391983929839398394983959839698397983989839998400984019840298403984049840598406984079840898409984109841198412984139841498415984169841798418984199842098421984229842398424984259842698427984289842998430984319843298433984349843598436984379843898439984409844198442984439844498445984469844798448984499845098451984529845398454984559845698457984589845998460984619846298463984649846598466984679846898469984709847198472984739847498475984769847798478984799848098481984829848398484984859848698487984889848998490984919849298493984949849598496984979849898499985009850198502985039850498505985069850798508985099851098511985129851398514985159851698517985189851998520985219852298523985249852598526985279852898529985309853198532985339853498535985369853798538985399854098541985429854398544985459854698547985489854998550985519855298553985549855598556985579855898559985609856198562985639856498565985669856798568985699857098571985729857398574985759857698577985789857998580985819858298583985849858598586985879858898589985909859198592985939859498595985969859798598985999860098601986029860398604986059860698607986089860998610986119861298613986149861598616986179861898619986209862198622986239862498625986269862798628986299863098631986329863398634986359863698637986389863998640986419864298643986449864598646986479864898649986509865198652986539865498655986569865798658986599866098661986629866398664986659866698667986689866998670986719867298673986749867598676986779867898679986809868198682986839868498685986869868798688986899869098691986929869398694986959869698697986989869998700987019870298703987049870598706987079870898709987109871198712987139871498715987169871798718987199872098721987229872398724987259872698727987289872998730987319873298733987349873598736987379873898739987409874198742987439874498745987469874798748987499875098751987529875398754987559875698757987589875998760987619876298763987649876598766987679876898769987709877198772987739877498775987769877798778987799878098781987829878398784987859878698787987889878998790987919879298793987949879598796987979879898799988009880198802988039880498805988069880798808988099881098811988129881398814988159881698817988189881998820988219882298823988249882598826988279882898829988309883198832988339883498835988369883798838988399884098841988429884398844988459884698847988489884998850988519885298853988549885598856988579885898859988609886198862988639886498865988669886798868988699887098871988729887398874988759887698877988789887998880988819888298883988849888598886988879888898889988909889198892988939889498895988969889798898988999890098901989029890398904989059890698907989089890998910989119891298913989149891598916989179891898919989209892198922989239892498925989269892798928989299893098931989329893398934989359893698937989389893998940989419894298943989449894598946989479894898949989509895198952989539895498955989569895798958989599896098961989629896398964989659896698967989689896998970989719897298973989749897598976989779897898979989809898198982989839898498985989869898798988989899899098991989929899398994989959899698997989989899999000990019900299003990049900599006990079900899009990109901199012990139901499015990169901799018990199902099021990229902399024990259902699027990289902999030990319903299033990349903599036990379903899039990409904199042990439904499045990469904799048990499905099051990529905399054990559905699057990589905999060990619906299063990649906599066990679906899069990709907199072990739907499075990769907799078990799908099081990829908399084990859908699087990889908999090990919909299093990949909599096990979909899099991009910199102991039910499105991069910799108991099911099111991129911399114991159911699117991189911999120991219912299123991249912599126991279912899129991309913199132991339913499135991369913799138991399914099141991429914399144991459914699147991489914999150991519915299153991549915599156991579915899159991609916199162991639916499165991669916799168991699917099171991729917399174991759917699177991789917999180991819918299183991849918599186991879918899189991909919199192991939919499195991969919799198991999920099201992029920399204992059920699207992089920999210992119921299213992149921599216992179921899219992209922199222992239922499225992269922799228992299923099231992329923399234992359923699237992389923999240992419924299243992449924599246992479924899249992509925199252992539925499255992569925799258992599926099261992629926399264992659926699267992689926999270992719927299273992749927599276992779927899279992809928199282992839928499285992869928799288992899929099291992929929399294992959929699297992989929999300993019930299303993049930599306993079930899309993109931199312993139931499315993169931799318993199932099321993229932399324993259932699327993289932999330993319933299333993349933599336993379933899339993409934199342993439934499345993469934799348993499935099351993529935399354993559935699357993589935999360993619936299363993649936599366993679936899369993709937199372993739937499375993769937799378993799938099381993829938399384993859938699387993889938999390993919939299393993949939599396993979939899399994009940199402994039940499405994069940799408994099941099411994129941399414994159941699417994189941999420994219942299423994249942599426994279942899429994309943199432994339943499435994369943799438994399944099441994429944399444994459944699447994489944999450994519945299453994549945599456994579945899459994609946199462994639946499465994669946799468994699947099471994729947399474994759947699477994789947999480994819948299483994849948599486994879948899489994909949199492994939949499495994969949799498994999950099501995029950399504995059950699507995089950999510995119951299513995149951599516995179951899519995209952199522995239952499525995269952799528995299953099531995329953399534995359953699537995389953999540995419954299543995449954599546995479954899549995509955199552995539955499555995569955799558995599956099561995629956399564995659956699567995689956999570995719957299573995749957599576995779957899579995809958199582995839958499585995869958799588995899959099591995929959399594995959959699597995989959999600996019960299603996049960599606996079960899609996109961199612996139961499615996169961799618996199962099621996229962399624996259962699627996289962999630996319963299633996349963599636996379963899639996409964199642996439964499645996469964799648996499965099651996529965399654996559965699657996589965999660996619966299663996649966599666996679966899669996709967199672996739967499675996769967799678996799968099681996829968399684996859968699687996889968999690996919969299693996949969599696996979969899699997009970199702997039970499705997069970799708997099971099711997129971399714997159971699717997189971999720997219972299723997249972599726997279972899729997309973199732997339973499735997369973799738997399974099741997429974399744997459974699747997489974999750997519975299753997549975599756997579975899759997609976199762997639976499765997669976799768997699977099771997729977399774997759977699777997789977999780997819978299783997849978599786997879978899789997909979199792997939979499795997969979799798997999980099801998029980399804998059980699807998089980999810998119981299813998149981599816998179981899819998209982199822998239982499825998269982799828998299983099831998329983399834998359983699837998389983999840998419984299843998449984599846998479984899849998509985199852998539985499855998569985799858998599986099861998629986399864998659986699867998689986999870998719987299873998749987599876998779987899879998809988199882998839988499885998869988799888998899989099891998929989399894998959989699897998989989999900999019990299903999049990599906999079990899909999109991199912999139991499915999169991799918999199992099921999229992399924999259992699927999289992999930999319993299933999349993599936999379993899939999409994199942999439994499945999469994799948999499995099951999529995399954999559995699957999589995999960999619996299963999649996599966999679996899969999709997199972999739997499975999769997799978999799998099981999829998399984999859998699987999889998999990999919999299993999949999599996999979999899999100000100001100002100003100004100005100006100007100008100009100010100011100012100013100014100015100016100017100018100019100020100021100022100023100024100025100026100027100028100029100030100031100032100033100034100035100036100037100038100039100040100041100042100043100044100045100046100047100048100049100050100051100052100053100054100055100056100057100058100059100060100061100062100063100064100065100066100067100068100069100070100071100072100073100074100075100076100077100078100079100080100081100082100083100084100085100086100087100088100089100090100091100092100093100094100095100096100097100098100099100100100101100102100103100104100105100106100107100108100109100110100111100112100113100114100115100116100117100118100119100120100121100122100123100124100125100126100127100128100129100130100131100132100133100134100135100136100137100138100139100140100141100142100143100144100145100146100147100148100149100150100151100152100153100154100155100156100157100158100159100160100161100162100163100164100165100166100167100168100169100170100171100172100173100174100175100176100177100178100179100180100181100182100183100184100185100186100187100188100189100190100191100192100193100194100195100196100197100198100199100200100201100202100203100204100205100206100207100208100209100210100211100212100213100214100215100216100217100218100219100220100221100222100223100224100225100226100227100228100229100230100231100232100233100234100235100236100237100238100239100240100241100242100243100244100245100246100247100248100249100250100251100252100253100254100255100256100257100258100259100260100261100262100263100264100265100266100267100268100269100270100271100272100273100274100275100276100277100278100279100280100281100282100283100284100285100286100287100288100289100290100291100292100293100294100295100296100297100298100299100300100301100302100303100304100305100306100307100308100309100310100311100312100313100314100315100316100317100318100319100320100321100322100323100324100325100326100327100328100329100330100331100332100333100334100335100336100337100338100339100340100341100342100343100344100345100346100347100348100349100350100351100352100353100354100355100356100357100358100359100360100361100362100363100364100365100366100367100368100369100370100371100372100373100374100375100376100377100378100379100380100381100382100383100384100385100386100387100388100389100390100391100392100393100394100395100396100397100398100399100400100401100402100403100404100405100406100407100408100409100410100411100412100413100414100415100416100417100418100419100420100421100422100423100424100425100426100427100428100429100430100431100432100433100434100435100436100437100438100439100440100441100442100443100444100445100446100447100448100449100450100451100452100453100454100455100456100457100458100459100460100461100462100463100464100465100466100467100468100469100470100471100472100473100474100475100476100477100478100479100480100481100482100483100484100485100486100487100488100489100490100491100492100493100494100495100496100497100498100499100500100501100502100503100504100505100506100507100508100509100510100511100512100513100514100515100516100517100518100519100520100521100522100523100524100525100526100527100528100529100530100531100532100533100534100535100536100537100538100539100540100541100542100543100544100545100546100547100548100549100550100551100552100553100554100555100556100557100558100559100560100561100562100563100564100565100566100567100568100569100570100571100572100573100574100575100576100577100578100579100580100581100582100583100584100585100586100587100588100589100590100591100592100593100594100595100596100597100598100599100600100601100602100603100604100605100606100607100608100609100610100611100612100613100614100615100616100617100618100619100620100621100622100623100624100625100626100627100628100629100630100631100632100633100634100635100636100637100638100639100640100641100642100643100644100645100646100647100648100649100650100651100652100653100654100655100656100657100658100659100660100661100662100663100664100665100666100667100668100669100670100671100672100673100674100675100676100677100678100679100680100681100682100683100684100685100686100687100688100689100690100691100692100693100694100695100696100697100698100699100700100701100702100703100704100705100706100707100708100709100710100711100712100713100714100715100716100717100718100719100720100721100722100723100724100725100726100727100728100729100730100731100732100733100734100735100736100737100738100739100740100741100742100743100744100745100746100747100748100749100750100751100752100753100754100755100756100757100758100759100760100761100762100763100764100765100766100767100768100769100770100771100772100773100774100775100776100777100778100779100780100781100782100783100784100785100786100787100788100789100790100791100792100793100794100795100796100797100798100799100800100801100802100803100804100805100806100807100808100809100810100811100812100813100814100815100816100817100818100819100820100821100822100823100824100825100826100827100828100829100830100831100832100833100834100835100836100837100838100839100840100841100842100843100844100845100846100847100848100849100850100851100852100853100854100855100856100857100858100859100860100861100862100863100864100865100866100867100868100869100870100871100872100873100874100875100876100877100878100879100880100881100882100883100884100885100886100887100888100889100890100891100892100893100894100895100896100897100898100899100900100901100902100903100904100905100906100907100908100909100910100911100912100913100914100915100916100917100918100919100920100921100922100923100924100925100926100927100928100929100930100931100932100933100934100935100936100937100938100939100940100941100942100943100944100945100946100947100948100949100950100951100952100953100954100955100956100957100958100959100960100961100962100963100964100965100966100967100968100969100970100971100972100973100974100975100976100977100978100979100980100981100982100983100984100985100986100987100988100989100990100991100992100993100994100995100996100997100998100999101000101001101002101003101004101005101006101007101008101009101010101011101012101013101014101015101016101017101018101019101020101021101022101023101024101025101026101027101028101029101030101031101032101033101034101035101036101037101038101039101040101041101042101043101044101045101046101047101048101049101050101051101052101053101054101055101056101057101058101059101060101061101062101063101064101065101066101067101068101069101070101071101072101073101074101075101076101077101078101079101080101081101082101083101084101085101086101087101088101089101090101091101092101093101094101095101096101097101098101099101100101101101102101103101104101105101106101107101108101109101110101111101112101113101114101115101116101117101118101119101120101121101122101123101124101125101126101127101128101129101130101131101132101133101134101135101136101137101138101139101140101141101142101143101144101145101146101147101148101149101150101151101152101153101154101155101156101157101158101159101160101161101162101163101164101165101166101167101168101169101170101171101172101173101174101175101176101177101178101179101180101181101182101183101184101185101186101187101188101189101190101191101192101193101194101195101196101197101198101199101200101201101202101203101204101205101206101207101208101209101210101211101212101213101214101215101216101217101218101219101220101221101222101223101224101225101226101227101228101229101230101231101232101233101234101235101236101237101238101239101240101241101242101243101244101245101246101247101248101249101250101251101252101253101254101255101256101257101258101259101260101261101262101263101264101265101266101267101268101269101270101271101272101273101274101275101276101277101278101279101280101281101282101283101284101285101286101287101288101289101290101291101292101293101294101295101296101297101298101299101300101301101302101303101304101305101306101307101308101309101310101311101312101313101314101315101316101317101318101319101320101321101322101323101324101325101326101327101328101329101330101331101332101333101334101335101336101337101338101339101340101341101342101343101344101345101346101347101348101349101350101351101352101353101354101355101356101357101358101359101360101361101362101363101364101365101366101367101368101369101370101371101372101373101374101375101376101377101378101379101380101381101382101383101384101385101386101387101388101389101390101391101392101393101394101395101396101397101398101399101400101401101402101403101404101405101406101407101408101409101410101411101412101413101414101415101416101417101418101419101420101421101422101423101424101425101426101427101428101429101430101431101432101433101434101435101436101437101438101439101440101441101442101443101444101445101446101447101448101449101450101451101452101453101454101455101456101457101458101459101460101461101462101463101464101465101466101467101468101469101470101471101472101473101474101475101476101477101478101479101480101481101482101483101484101485101486101487101488101489101490101491101492101493101494101495101496101497101498101499101500101501101502101503101504101505101506101507101508101509101510101511101512101513101514101515101516101517101518101519101520101521101522101523101524101525101526101527101528101529101530101531101532101533101534101535101536101537101538101539101540101541101542101543101544101545101546101547101548101549101550101551101552101553101554101555101556101557101558101559101560101561101562101563101564101565101566101567101568101569101570101571101572101573101574101575101576101577101578101579101580101581101582101583101584101585101586101587101588101589101590101591101592101593101594101595101596101597101598101599101600101601101602101603101604101605101606101607101608101609101610101611101612101613101614101615101616101617101618101619101620101621101622101623101624101625101626101627101628101629101630101631101632101633101634101635101636101637101638101639101640101641101642101643101644101645101646101647101648101649101650101651101652101653101654101655101656101657101658101659101660101661101662101663101664101665101666101667101668101669101670101671101672101673101674101675101676101677101678101679101680101681101682101683101684101685101686101687101688101689101690101691101692101693101694101695101696101697101698101699101700101701101702101703101704101705101706101707101708101709101710101711101712101713101714101715101716101717101718101719101720101721101722101723101724101725101726101727101728101729101730101731101732101733101734101735101736101737101738101739101740101741101742101743101744101745101746101747101748101749101750101751101752101753101754101755101756101757101758101759101760101761101762101763101764101765101766101767101768101769101770101771101772101773101774101775101776101777101778101779101780101781101782101783101784101785101786101787101788101789101790101791101792101793101794101795101796101797101798101799101800101801101802101803101804101805101806101807101808101809101810101811101812101813101814101815101816101817101818101819101820101821101822101823101824101825101826101827101828101829101830101831101832101833101834101835101836101837101838101839101840101841101842101843101844101845101846101847101848101849101850101851101852101853101854101855101856101857101858101859101860101861101862101863101864101865101866101867101868101869101870101871101872101873101874101875101876101877101878101879101880101881101882101883101884101885101886101887101888101889101890101891101892101893101894101895101896101897101898101899101900101901101902101903101904101905101906101907101908101909101910101911101912101913101914101915101916101917101918101919101920101921101922101923101924101925101926101927101928101929101930101931101932101933101934101935101936101937101938101939101940101941101942101943101944101945101946101947101948101949101950101951101952101953101954101955101956101957101958101959101960101961101962101963101964101965101966101967101968101969101970101971101972101973101974101975101976101977101978101979101980101981101982101983101984101985101986101987101988101989101990101991101992101993101994101995101996101997101998101999102000102001102002102003102004102005102006102007102008102009102010102011102012102013102014102015102016102017102018102019102020102021102022102023102024102025102026102027102028102029102030102031102032102033102034102035102036102037102038102039102040102041102042102043102044102045102046102047102048102049102050102051102052102053102054102055102056102057102058102059102060102061102062102063102064102065102066102067102068102069102070102071102072102073102074102075102076102077102078102079102080102081102082102083102084102085102086102087102088102089102090102091102092102093102094102095102096102097102098102099102100102101102102102103102104102105102106102107102108102109102110102111102112102113102114102115102116102117102118102119102120102121102122102123102124102125102126102127102128102129102130102131102132102133102134102135102136102137102138102139102140102141102142102143102144102145102146102147102148102149102150102151102152102153102154102155102156102157102158102159102160102161102162102163102164102165102166102167102168102169102170102171102172102173102174102175102176102177102178102179102180102181102182102183102184102185102186102187102188102189102190102191102192102193102194102195102196102197102198102199102200102201102202102203102204102205102206102207102208102209102210102211102212102213102214102215102216102217102218102219102220102221102222102223102224102225102226102227102228102229102230102231102232102233102234102235102236102237102238102239102240102241102242102243102244102245102246102247102248102249102250102251102252102253102254102255102256102257102258102259102260102261102262102263102264102265102266102267102268102269102270102271102272102273102274102275102276102277102278102279102280102281102282102283102284102285102286102287102288102289102290102291102292102293102294102295102296102297102298102299102300102301102302102303102304102305102306102307102308102309102310102311102312102313102314102315102316102317102318102319102320102321102322102323102324102325102326102327102328102329102330102331102332102333102334102335102336102337102338102339102340102341102342102343102344102345102346102347102348102349102350102351102352102353102354102355102356102357102358102359102360102361102362102363102364102365102366102367102368102369102370102371102372102373102374102375102376102377102378102379102380102381102382102383102384102385102386102387102388102389102390102391102392102393102394102395102396102397102398102399102400102401102402102403102404102405102406102407102408102409102410102411102412102413102414102415102416102417102418102419102420102421102422102423102424102425102426102427102428102429102430102431102432102433102434102435102436102437102438102439102440102441102442102443102444102445102446102447102448102449102450102451102452102453102454102455102456102457102458102459102460102461102462102463102464102465102466102467102468102469102470102471102472102473102474102475102476102477102478102479102480102481102482102483102484102485102486102487102488102489102490102491102492102493102494102495102496102497102498102499102500102501102502102503102504102505102506102507102508102509102510102511102512102513102514102515102516102517102518102519102520102521102522102523102524102525102526102527102528102529102530102531102532102533102534102535102536102537102538102539102540102541102542102543102544102545102546102547102548102549102550102551102552102553102554102555102556102557102558102559102560102561102562102563102564102565102566102567102568102569102570102571102572102573102574102575102576102577102578102579102580102581102582102583102584102585102586102587102588102589102590102591102592102593102594102595102596102597102598102599102600102601102602102603102604102605102606102607102608102609102610102611102612102613102614102615102616102617102618102619102620102621102622102623102624102625102626102627102628102629102630102631102632102633102634102635102636102637102638102639102640102641102642102643102644102645102646102647102648102649102650102651102652102653102654102655102656102657102658102659102660102661102662102663102664102665102666102667102668102669102670102671102672102673102674102675102676102677102678102679102680102681102682102683102684102685102686102687102688102689102690102691102692102693102694102695102696102697102698102699102700102701102702102703102704102705102706102707102708102709102710102711102712102713102714102715102716102717102718102719102720102721102722102723102724102725102726102727102728102729102730102731102732102733102734102735102736102737102738102739102740102741102742102743102744102745102746102747102748102749102750102751102752102753102754102755102756102757102758102759102760102761102762102763102764102765102766102767102768102769102770102771102772102773102774102775102776102777102778102779102780102781102782102783102784102785102786102787102788102789102790102791102792102793102794102795102796102797102798102799102800102801102802102803102804102805102806102807102808102809102810102811102812102813102814102815102816102817102818102819102820102821102822102823102824102825102826102827102828102829102830102831102832102833102834102835102836102837102838102839102840102841102842102843102844102845102846102847102848102849102850102851102852102853102854102855102856102857102858102859102860102861102862102863102864102865102866102867102868102869102870102871102872102873102874102875102876102877102878102879102880102881102882102883102884102885102886102887102888102889102890102891102892102893102894102895102896102897102898102899102900102901102902102903102904102905102906102907102908102909102910102911102912102913102914102915102916102917102918102919102920102921102922102923102924102925102926102927102928102929102930102931102932102933102934102935102936102937102938102939102940102941102942102943102944102945102946102947102948102949102950102951102952102953102954102955102956102957102958102959102960102961102962102963102964102965102966102967102968102969102970102971102972102973102974102975102976102977102978102979102980102981102982102983102984102985102986102987102988102989102990102991102992102993102994102995102996102997102998102999103000103001103002103003103004103005103006103007103008103009103010103011103012103013103014103015103016103017103018103019103020103021103022103023103024103025103026103027103028103029103030103031103032103033103034103035103036103037103038103039103040103041103042103043103044103045103046103047103048103049103050103051103052103053103054103055103056103057103058103059103060103061103062103063103064103065103066103067103068103069103070103071103072103073103074103075103076103077103078103079103080103081103082103083103084103085103086103087103088103089103090103091103092103093103094103095103096103097103098103099103100103101103102103103103104103105103106103107103108103109103110103111103112103113103114103115103116103117103118103119103120103121103122103123103124103125103126103127103128103129103130103131103132103133103134103135103136103137103138103139103140103141103142103143103144103145103146103147103148103149103150103151103152103153103154103155103156103157103158103159103160103161103162103163103164103165103166103167103168103169103170103171103172103173103174103175103176103177103178103179103180103181103182103183103184103185103186103187103188103189103190103191103192103193103194103195103196103197103198103199103200103201103202103203103204103205103206103207103208103209103210103211103212103213103214103215103216103217103218103219103220103221103222103223103224103225103226103227103228103229103230103231103232103233103234103235103236103237103238103239103240103241103242103243103244103245103246103247103248103249103250103251103252103253103254103255103256103257103258103259103260103261103262103263103264103265103266103267103268103269103270103271103272103273103274103275103276103277103278103279103280103281103282103283103284103285103286103287103288103289103290103291103292103293103294103295103296103297103298103299103300103301103302103303103304103305103306103307103308103309103310103311103312103313103314103315103316103317103318103319103320103321103322103323103324103325103326103327103328103329103330103331103332103333103334103335103336103337103338103339103340103341103342103343103344103345103346103347103348103349103350103351103352103353103354103355103356103357103358103359103360103361103362103363103364103365103366103367103368103369103370103371103372103373103374103375103376103377103378103379103380103381103382103383103384103385103386103387103388103389103390103391103392103393103394103395103396103397103398103399103400103401103402103403103404103405103406103407103408103409103410103411103412103413103414103415103416103417103418103419103420103421103422103423103424103425103426103427103428103429103430103431103432103433103434103435103436103437103438103439103440103441103442103443103444103445103446103447103448103449103450103451103452103453103454103455103456103457103458103459103460103461103462103463103464103465103466103467103468103469103470103471103472103473103474103475103476103477103478103479103480103481103482103483103484103485103486103487103488103489103490103491103492103493103494103495103496103497103498103499103500103501103502103503103504103505103506103507103508103509103510103511103512103513103514103515103516103517103518103519103520103521103522103523103524103525103526103527103528103529103530103531103532103533103534103535103536103537103538103539103540103541103542103543103544103545103546103547103548103549103550103551103552103553103554103555103556103557103558103559103560103561103562103563103564103565103566103567103568103569103570103571103572103573103574103575103576103577103578103579103580103581103582103583103584103585103586103587103588103589103590103591103592103593103594103595103596103597103598103599103600103601103602103603103604103605103606103607103608103609103610103611103612103613103614103615103616103617103618103619103620103621103622103623103624103625103626103627103628103629103630103631103632103633103634103635103636103637103638103639103640103641103642103643103644103645103646103647103648103649103650103651103652103653103654103655103656103657103658103659103660103661103662103663103664103665103666103667103668103669103670103671103672103673103674103675103676103677103678103679103680103681103682103683103684103685103686103687103688103689103690103691103692103693103694103695103696103697103698103699103700103701103702103703103704103705103706103707103708103709103710103711103712103713103714103715103716103717103718103719103720103721103722103723103724103725103726103727103728103729103730103731103732103733103734103735103736103737103738103739103740103741103742103743103744103745103746103747103748103749103750103751103752103753103754103755103756103757103758103759103760103761103762103763103764103765103766103767103768103769103770103771103772103773103774103775103776103777103778103779103780103781103782103783103784103785103786103787103788103789103790103791103792103793103794103795103796103797103798103799103800103801103802103803103804103805103806103807103808103809103810103811103812103813103814103815103816103817103818103819103820103821103822103823103824103825103826103827103828103829103830103831103832103833103834103835103836103837103838103839103840103841103842103843103844103845103846103847103848103849103850103851103852103853103854103855103856103857103858103859103860103861103862103863103864103865103866103867103868103869103870103871103872103873103874103875103876103877103878103879103880103881103882103883103884103885103886103887103888103889103890103891103892103893103894103895103896103897103898103899103900103901103902103903103904103905103906103907103908103909103910103911103912103913103914103915103916103917103918103919103920103921103922103923103924103925103926103927103928103929103930103931103932103933103934103935103936103937103938103939103940103941103942103943103944103945103946103947103948103949103950103951103952103953103954103955103956103957103958103959103960103961103962103963103964103965103966103967103968103969103970103971103972103973103974103975103976103977103978103979103980103981103982103983103984103985103986103987103988103989103990103991103992103993103994103995103996103997103998103999104000104001104002104003104004104005104006104007104008104009104010104011104012104013104014104015104016104017104018104019104020104021104022104023104024104025104026104027104028104029104030104031104032104033104034104035104036104037104038104039104040104041104042104043104044104045104046104047104048104049104050104051104052104053104054104055104056104057104058104059104060104061104062104063104064104065104066104067104068104069104070104071104072104073104074104075104076104077104078104079104080104081104082104083104084104085104086104087104088104089104090104091104092104093104094104095104096104097104098104099104100104101104102104103104104104105104106104107104108104109104110104111104112104113104114104115104116104117104118104119104120104121104122104123104124104125104126104127104128104129104130104131104132104133104134104135104136104137104138104139104140104141104142104143104144104145104146104147104148104149104150104151104152104153104154104155104156104157104158104159104160104161104162104163104164104165104166104167104168104169104170104171104172104173104174104175104176104177104178104179104180104181104182104183104184104185104186104187104188104189104190104191104192104193104194104195104196104197104198104199104200104201104202104203104204104205104206104207104208104209104210104211104212104213104214104215104216104217104218104219104220104221104222104223104224104225104226104227104228104229104230104231104232104233104234104235104236104237104238104239104240104241104242104243104244104245104246104247104248104249104250104251104252104253104254104255104256104257104258104259104260104261104262104263104264104265104266104267104268104269104270104271104272104273104274104275104276104277104278104279104280104281104282104283104284104285104286104287104288104289104290104291104292104293104294104295104296104297104298104299104300104301104302104303104304104305104306104307104308104309104310104311104312104313104314104315104316104317104318104319104320104321104322104323104324104325104326104327104328104329104330104331104332104333104334104335104336104337104338104339104340104341104342104343104344104345104346104347104348104349104350104351104352104353104354104355104356104357104358104359104360104361104362104363104364104365104366104367104368104369104370104371104372104373104374104375104376104377104378104379104380104381104382104383104384104385104386104387104388104389104390104391104392104393104394104395104396104397104398104399104400104401104402104403104404104405104406104407104408104409104410104411104412104413104414104415104416104417104418104419104420104421104422104423104424104425104426104427104428104429104430104431104432104433104434104435104436104437104438104439104440104441104442104443104444104445104446104447104448104449104450104451104452104453104454104455104456104457104458104459104460104461104462104463104464104465104466104467104468104469104470104471104472104473104474104475104476104477104478104479104480104481104482104483104484104485104486104487104488104489104490104491104492104493104494104495104496104497104498104499104500104501104502104503104504104505104506104507104508104509104510104511104512104513104514104515104516104517104518104519104520104521104522104523104524104525104526104527104528104529104530104531104532104533104534104535104536104537104538104539104540104541104542104543104544104545104546104547104548104549104550104551104552104553104554104555104556104557104558104559104560104561104562104563104564104565104566104567104568104569104570104571104572104573104574104575104576104577104578104579104580104581104582104583104584104585104586104587104588104589104590104591104592104593104594104595104596104597104598104599104600104601104602104603104604104605104606104607104608104609104610104611104612104613104614104615104616104617104618104619104620104621104622104623104624104625104626104627104628104629104630104631104632104633104634104635104636104637104638104639104640104641104642104643104644104645104646104647104648104649104650104651104652104653104654104655104656104657104658104659104660104661104662104663104664104665104666104667104668104669104670104671104672104673104674104675104676104677104678104679104680104681104682104683104684104685104686104687104688104689104690104691104692104693104694104695104696104697104698104699104700104701104702104703104704104705104706104707104708104709104710104711104712104713104714104715104716104717104718104719104720104721104722104723104724104725104726104727104728104729104730104731104732104733104734104735104736104737104738104739104740104741104742104743104744104745104746104747104748104749104750104751104752104753104754104755104756104757104758104759104760104761104762104763104764104765104766104767104768104769104770104771104772104773104774104775104776104777104778104779104780104781104782104783104784104785104786104787104788104789104790104791104792104793104794104795104796104797104798104799104800104801104802104803104804104805104806104807104808104809104810104811104812104813104814104815104816104817104818104819104820104821104822104823104824104825104826104827104828104829104830104831104832104833104834104835104836104837104838104839104840104841104842104843104844104845104846104847104848104849104850104851104852104853104854104855104856104857104858104859104860104861104862104863104864104865104866104867104868104869104870104871104872104873104874104875104876104877104878104879104880104881104882104883104884104885104886104887104888104889104890104891104892104893104894104895104896104897104898104899104900104901104902104903104904104905104906104907104908104909104910104911104912104913104914104915104916104917104918104919104920104921104922104923104924104925104926104927104928104929104930104931104932104933104934104935104936104937104938104939104940104941104942104943104944104945104946104947104948104949104950104951104952104953104954104955104956104957104958104959104960104961104962104963104964104965104966104967104968104969104970104971104972104973104974104975104976104977104978104979104980104981104982104983104984104985104986104987104988104989104990104991104992104993104994104995104996104997104998104999105000105001105002105003105004105005105006105007105008105009105010105011105012105013105014105015105016105017105018105019105020105021105022105023105024105025105026105027105028105029105030105031105032105033105034105035105036105037105038105039105040105041105042105043105044105045105046105047105048105049105050105051105052105053105054105055105056105057105058105059105060105061105062105063105064105065105066105067105068105069105070105071105072105073105074105075105076105077105078105079105080105081105082105083105084105085105086105087105088105089105090105091105092105093105094105095105096105097105098105099105100105101105102105103105104105105105106105107105108105109105110105111105112105113105114105115105116105117105118105119105120105121105122105123105124105125105126105127105128105129105130105131105132105133105134105135105136105137105138105139105140105141105142105143105144105145105146105147105148105149105150105151105152105153105154105155105156105157105158105159105160105161105162105163105164105165105166105167105168105169105170105171105172105173105174105175105176105177105178105179105180105181105182105183105184105185105186105187105188105189105190105191105192105193105194105195105196105197105198105199105200105201105202105203105204105205105206105207105208105209105210105211105212105213105214105215105216105217105218105219105220105221105222105223105224105225105226105227105228105229105230105231105232105233105234105235105236105237105238105239105240105241105242105243105244105245105246105247105248105249105250105251105252105253105254105255105256105257105258105259105260105261105262105263105264105265105266105267105268105269105270105271105272105273105274105275105276105277105278105279105280105281105282105283105284105285105286105287105288105289105290105291105292105293105294105295105296105297105298105299105300105301105302105303105304105305105306105307105308105309105310105311105312105313105314105315105316105317105318105319105320105321105322105323105324105325105326105327105328105329105330105331105332105333105334105335105336105337105338105339105340105341105342105343105344105345105346105347105348105349105350105351105352105353105354105355105356105357105358105359105360105361105362105363105364105365105366105367105368105369105370105371105372105373105374105375105376105377105378105379105380105381105382105383105384105385105386105387105388105389105390105391105392105393105394105395105396105397105398105399105400105401105402105403105404105405105406105407105408105409105410105411105412105413105414105415105416105417105418105419105420105421105422105423105424105425105426105427105428105429105430105431105432105433105434105435105436105437105438105439105440105441105442105443105444105445105446105447105448105449105450105451105452105453105454105455105456105457105458105459105460105461105462105463105464105465105466105467105468105469105470105471105472105473105474105475105476105477105478105479105480105481105482105483105484105485105486105487105488105489105490105491105492105493105494105495105496105497105498105499105500105501105502105503105504105505105506105507105508105509105510105511105512105513105514105515105516105517105518105519105520105521105522105523105524105525105526105527105528105529105530105531105532105533105534105535105536105537105538105539105540105541105542105543105544105545105546105547105548105549105550105551105552105553105554105555105556105557105558105559105560105561105562105563105564105565105566105567105568105569105570105571105572105573105574105575105576105577105578105579105580105581105582105583105584105585105586105587105588105589105590105591105592105593105594105595105596105597105598105599105600105601105602105603105604105605105606105607105608105609105610105611105612105613105614105615105616105617105618105619105620105621105622105623105624105625105626105627105628105629105630105631105632105633105634105635105636105637105638105639105640105641105642105643105644105645105646105647105648105649105650105651105652105653105654105655105656105657105658105659105660105661105662105663105664105665105666105667105668105669105670105671105672105673105674105675105676105677105678105679105680105681105682105683105684105685105686105687105688105689105690105691105692105693105694105695105696105697105698105699105700105701105702105703105704105705105706105707105708105709105710105711105712105713105714105715105716105717105718105719105720105721105722105723105724105725105726105727105728105729105730105731105732105733105734105735105736105737105738105739105740105741105742105743105744105745105746105747105748105749105750105751105752105753105754105755105756105757105758105759105760105761105762105763105764105765105766105767105768105769105770105771105772105773105774105775105776105777105778105779105780105781105782105783105784105785105786105787105788105789105790105791105792105793105794105795105796105797105798105799105800105801105802105803105804105805105806105807105808105809105810105811105812105813105814105815105816105817105818105819105820105821105822105823105824105825105826105827105828105829105830105831105832105833105834105835105836105837105838105839105840105841105842105843105844105845105846105847105848105849105850105851105852105853105854105855105856105857105858105859105860105861105862105863105864105865105866105867105868105869105870105871105872105873105874105875105876105877105878105879105880105881105882105883105884105885105886105887105888105889105890105891105892105893105894105895105896105897105898105899105900105901105902105903105904105905105906105907105908105909105910105911105912105913105914105915105916105917105918105919105920105921105922105923105924105925105926105927105928105929105930105931105932105933105934105935105936105937105938105939105940105941105942105943105944105945105946105947105948105949105950105951105952105953105954105955105956105957105958105959105960105961105962105963105964105965105966105967105968105969105970105971105972105973105974105975105976105977105978105979105980105981105982105983105984105985105986105987105988105989105990105991105992105993105994105995105996105997105998105999106000106001106002106003106004106005106006106007106008106009106010106011106012106013106014106015106016106017106018106019106020106021106022106023106024106025106026106027106028106029106030106031106032106033106034106035106036106037106038106039106040106041106042106043106044106045106046106047106048106049106050106051106052106053106054106055106056106057106058106059106060106061106062106063106064106065106066106067106068106069106070106071106072106073106074106075106076106077106078106079106080106081106082106083106084106085106086106087106088106089106090106091106092106093106094106095106096106097106098106099106100106101106102106103106104106105106106106107106108106109106110106111106112106113106114106115106116106117106118106119106120106121106122106123106124106125106126106127106128106129106130106131106132106133106134106135106136106137106138106139106140106141106142106143106144106145106146106147106148106149106150106151106152106153106154106155106156106157106158106159106160106161106162106163106164106165106166106167106168106169106170106171106172106173106174106175106176106177106178106179106180106181106182106183106184106185106186106187106188106189106190106191106192106193106194106195106196106197106198106199106200106201106202106203106204106205106206106207106208106209106210106211106212106213106214106215106216106217106218106219106220106221106222106223106224106225106226106227106228106229106230106231106232106233106234106235106236106237106238106239106240106241106242106243106244106245106246106247106248106249106250106251106252106253106254106255106256106257106258106259106260106261106262106263106264106265106266106267106268106269106270106271106272106273106274106275106276106277106278106279106280106281106282106283106284106285106286106287106288106289106290106291106292106293106294106295106296106297106298106299106300106301106302106303106304106305106306106307106308106309106310106311106312106313106314106315106316106317106318106319106320106321106322106323106324106325106326106327106328106329106330106331106332106333106334106335106336106337106338106339106340106341106342106343106344106345106346106347106348106349106350106351106352106353106354106355106356106357106358106359106360106361106362106363106364106365106366106367106368106369106370106371106372106373106374106375106376106377106378106379106380106381106382106383106384106385106386106387106388106389106390106391106392106393106394106395106396106397106398106399106400106401106402106403106404106405106406106407106408106409106410106411106412106413106414106415106416106417106418106419106420106421106422106423106424106425106426106427106428106429106430106431106432106433106434106435106436106437106438106439106440106441106442106443106444106445106446106447106448106449106450106451106452106453106454106455106456106457106458106459106460106461106462106463106464106465106466106467106468106469106470106471106472106473106474106475106476106477106478106479106480106481106482106483106484106485106486106487106488106489106490106491106492106493106494106495106496106497106498106499106500106501106502106503106504106505106506106507106508106509106510106511106512106513106514106515106516106517106518106519106520106521106522106523106524106525106526106527106528106529106530106531106532106533106534106535106536106537106538106539106540106541106542106543106544106545106546106547106548106549106550106551106552106553106554106555106556106557106558106559106560106561106562106563106564106565106566106567106568106569106570106571106572106573106574106575106576106577106578106579106580106581106582106583106584106585106586106587106588106589106590106591106592106593106594106595106596106597106598106599106600106601106602106603106604106605106606106607106608106609106610106611106612106613106614106615106616106617106618106619106620106621106622106623106624106625106626106627106628106629106630106631106632106633106634106635106636106637106638106639106640106641106642106643106644106645106646106647106648106649106650106651106652106653106654106655106656106657106658106659106660106661106662106663106664106665106666106667106668106669106670106671106672106673106674106675106676106677106678106679106680106681106682106683106684106685106686106687106688106689106690106691106692106693106694106695106696106697106698106699106700106701106702106703106704106705106706106707106708106709106710106711106712106713106714106715106716106717106718106719106720106721106722106723106724106725106726106727106728106729106730106731106732106733106734106735106736106737106738106739106740106741106742106743106744106745106746106747106748106749106750106751106752106753106754106755106756106757106758106759106760106761106762106763106764106765106766106767106768106769106770106771106772106773106774106775106776106777106778106779106780106781106782106783106784106785106786106787106788106789106790106791106792106793106794106795106796106797106798106799106800106801106802106803106804106805106806106807106808106809106810106811106812106813106814106815106816106817106818106819106820106821106822106823106824106825106826106827106828106829106830106831106832106833106834106835106836106837106838106839106840106841106842106843106844106845106846106847106848106849106850106851106852106853106854106855106856106857106858106859106860106861106862106863106864106865106866106867106868106869106870106871106872106873106874106875106876106877106878106879106880106881106882106883106884106885106886106887106888106889106890106891106892106893106894106895106896106897106898106899106900106901106902106903106904106905106906106907106908106909106910106911106912106913106914106915106916106917106918106919106920106921106922106923106924106925106926106927106928106929106930106931106932106933106934106935106936106937106938106939106940106941106942106943106944106945106946106947106948106949106950106951106952106953106954106955106956106957106958106959106960106961106962106963106964106965106966106967106968106969106970106971106972106973106974106975106976106977106978106979106980106981106982106983106984106985106986106987106988106989106990106991106992106993106994106995106996106997106998106999107000107001107002107003107004107005107006107007107008107009107010107011107012107013107014107015107016107017107018107019107020107021107022107023107024107025107026107027107028107029107030107031107032107033107034107035107036107037107038107039107040107041107042107043107044107045107046107047107048107049107050107051107052107053107054107055107056107057107058107059107060107061107062107063107064107065107066107067107068107069107070107071107072107073107074107075107076107077107078107079107080107081107082107083107084107085107086107087107088107089107090107091107092107093107094107095107096107097107098107099107100107101107102107103107104107105107106107107107108107109107110107111107112107113107114107115107116107117107118107119107120107121107122107123107124107125107126107127107128107129107130107131107132107133107134107135107136107137107138107139107140107141107142107143107144107145107146107147107148107149107150107151107152107153107154107155107156107157107158107159107160107161107162107163107164107165107166107167107168107169107170107171107172107173107174107175107176107177107178107179107180107181107182107183107184107185107186107187107188107189107190107191107192107193107194107195107196107197107198107199107200107201107202107203107204107205107206107207107208107209107210107211107212107213107214107215107216107217107218107219107220107221107222107223107224107225107226107227107228107229107230107231107232107233107234107235107236107237107238107239107240107241107242107243107244107245107246107247107248107249107250107251107252107253107254107255107256107257107258107259107260107261107262107263107264107265107266107267107268107269107270107271107272107273107274107275107276107277107278107279107280107281107282107283107284107285107286107287107288107289107290107291107292107293107294107295107296107297107298107299107300107301107302107303107304107305107306107307107308107309107310107311107312107313107314107315107316107317107318107319107320107321107322107323107324107325107326107327107328107329107330107331107332107333107334107335107336107337107338107339107340107341107342107343107344107345107346107347107348107349107350107351107352107353107354107355107356107357107358107359107360107361107362107363107364107365107366107367107368107369107370107371107372107373107374107375107376107377107378107379107380107381107382107383107384107385107386107387107388107389107390107391107392107393107394107395107396107397107398107399107400107401107402107403107404107405107406107407107408107409107410107411107412107413107414107415107416107417107418107419107420107421107422107423107424107425107426107427107428107429107430107431107432107433107434107435107436107437107438107439107440107441107442107443107444107445107446107447107448107449107450107451107452107453107454107455107456107457107458107459107460107461107462107463107464107465107466107467107468107469107470107471107472107473107474107475107476107477107478107479107480107481107482107483107484107485107486107487107488107489107490107491107492107493107494107495107496107497107498107499107500107501107502107503107504107505107506107507107508107509107510107511107512107513107514107515107516107517107518107519107520107521107522107523107524107525107526107527107528107529107530107531107532107533107534107535107536107537107538107539107540107541107542107543107544107545107546107547107548107549107550107551107552107553107554107555107556107557107558107559107560107561107562107563107564107565107566107567107568107569107570107571107572107573107574107575107576107577107578107579107580107581107582107583107584107585107586107587107588107589107590107591107592107593107594107595107596107597107598107599107600107601107602107603107604107605107606107607107608107609107610107611107612107613107614107615107616107617107618107619107620107621107622107623107624107625107626107627107628107629107630107631107632107633107634107635107636107637107638107639107640107641107642107643107644107645107646107647107648107649107650107651107652107653107654107655107656107657107658107659107660107661107662107663107664107665107666107667107668107669107670107671107672107673107674107675107676107677107678107679107680107681107682107683107684107685107686107687107688107689107690107691107692107693107694107695107696107697107698107699107700107701107702107703107704107705107706107707107708107709107710107711107712107713107714107715107716107717107718107719107720107721107722107723107724107725107726107727107728107729107730107731107732107733107734107735107736107737107738107739107740107741107742107743107744107745107746107747107748107749107750107751107752107753107754107755107756107757107758107759107760107761107762107763107764107765107766107767107768107769107770107771107772107773107774107775107776107777107778107779107780107781107782107783107784107785107786107787107788107789107790107791107792107793107794107795107796107797107798107799107800107801107802107803107804107805107806107807107808107809107810107811107812107813107814107815107816107817107818107819107820107821107822107823107824107825107826107827107828107829107830107831107832107833107834107835107836107837107838107839107840107841107842107843107844107845107846107847107848107849107850107851107852107853107854107855107856107857107858107859107860107861107862107863107864107865107866107867107868107869107870107871107872107873107874107875107876107877107878107879107880107881107882107883107884107885107886107887107888107889107890107891107892107893107894107895107896107897107898107899107900107901107902107903107904107905107906107907107908107909107910107911107912107913107914107915107916107917107918107919107920107921107922107923107924107925107926107927107928107929107930107931107932107933107934107935107936107937107938107939107940107941107942107943107944107945107946107947107948107949107950107951107952107953107954107955107956107957107958107959107960107961107962107963107964107965107966107967107968107969107970107971107972107973107974107975107976107977107978107979107980107981107982107983107984107985107986107987107988107989107990107991107992107993107994107995107996107997107998107999108000108001108002108003108004108005108006108007108008108009108010108011108012108013108014108015108016108017108018108019108020108021108022108023108024108025108026108027108028108029108030108031108032108033108034108035108036108037108038108039108040108041108042108043108044108045108046108047108048108049108050108051108052108053108054108055108056108057108058108059108060108061108062108063108064108065108066108067108068108069108070108071108072108073108074108075108076108077108078108079108080108081108082108083108084108085108086108087108088108089108090108091108092108093108094108095108096108097108098108099108100108101108102108103108104108105108106108107108108108109108110108111108112108113108114108115108116108117108118108119108120108121108122108123108124108125108126108127108128108129108130108131108132108133108134108135108136108137108138108139108140108141108142108143108144108145108146108147108148108149108150108151108152108153108154108155108156108157108158108159108160108161108162108163108164108165108166108167108168108169108170108171108172108173108174108175108176108177108178108179108180108181108182108183108184108185108186108187108188108189108190108191108192108193108194108195108196108197108198108199108200108201108202108203108204108205108206108207108208108209108210108211108212108213108214108215108216108217108218108219108220108221108222108223108224108225108226108227108228108229108230108231108232108233108234108235108236108237108238108239108240108241108242108243108244108245108246108247108248108249108250108251108252108253108254108255108256108257108258108259108260108261108262108263108264108265108266108267108268108269108270108271108272108273108274108275108276108277108278108279108280108281108282108283108284108285108286108287108288108289108290108291108292108293108294108295108296108297108298108299108300108301108302108303108304108305108306108307108308108309108310108311108312108313108314108315108316108317108318108319108320108321108322108323108324108325108326108327108328108329108330108331108332108333108334108335108336108337108338108339108340108341108342108343108344108345108346108347108348108349108350108351108352108353108354108355108356108357108358108359108360108361108362108363108364108365108366108367108368108369108370108371108372108373108374108375108376108377108378108379108380108381108382108383108384108385108386108387108388108389108390108391108392108393108394108395108396108397108398108399108400108401108402108403108404108405108406108407108408108409108410108411108412108413108414108415108416108417108418108419108420108421108422108423108424108425108426108427108428108429108430108431108432108433108434108435108436108437108438108439108440108441108442108443108444108445108446108447108448108449108450108451108452108453108454108455108456108457108458108459108460108461108462108463108464108465108466108467108468108469108470108471108472108473108474108475108476108477108478108479108480108481108482108483108484108485108486108487108488108489108490108491108492108493108494108495108496108497108498108499108500108501108502108503108504108505108506108507108508108509108510108511108512108513108514108515108516108517108518108519108520108521108522108523108524108525108526108527108528108529108530108531108532108533108534108535108536108537108538108539108540108541108542108543108544108545108546108547108548108549108550108551108552108553108554108555108556108557108558108559108560108561108562108563108564108565108566108567108568108569108570108571108572108573108574108575108576108577108578108579108580108581108582108583108584108585108586108587108588108589108590108591108592108593108594108595108596108597108598108599108600108601108602108603108604108605108606108607108608108609108610108611108612108613108614108615108616108617108618108619108620108621108622108623108624108625108626108627108628108629108630108631108632108633108634108635108636108637108638108639108640108641108642108643108644108645108646108647108648108649108650108651108652108653108654108655108656108657108658108659108660108661108662108663108664108665108666108667108668108669108670108671108672108673108674108675108676108677108678108679108680108681108682108683108684108685108686108687108688108689108690108691108692108693108694108695108696108697108698108699108700108701108702108703108704108705108706108707108708108709108710108711108712108713108714108715108716108717108718108719108720108721108722108723108724108725108726108727108728108729108730108731108732108733108734108735108736108737108738108739108740108741108742108743108744108745108746108747108748108749108750108751108752108753108754108755108756108757108758108759108760108761108762108763108764108765108766108767108768108769108770108771108772108773108774108775108776108777108778108779108780108781108782108783108784108785108786108787108788108789108790108791108792108793108794108795108796108797108798108799108800108801108802108803108804108805108806108807108808108809108810108811108812108813108814108815108816108817108818108819108820108821108822108823108824108825108826108827108828108829108830108831108832108833108834108835108836108837108838108839108840108841108842108843108844108845108846108847108848108849108850108851108852108853108854108855108856108857108858108859108860108861108862108863108864108865108866108867108868108869108870108871108872108873108874108875108876108877108878108879108880108881108882108883108884108885108886108887108888108889108890108891108892108893108894108895108896108897108898108899108900108901108902108903108904108905108906108907108908108909108910108911108912108913108914108915108916108917108918108919108920108921108922108923108924108925108926108927108928108929108930108931108932108933108934108935108936108937108938108939108940108941108942108943108944108945108946108947108948108949108950108951108952108953108954108955108956108957108958108959108960108961108962108963108964108965108966108967108968108969108970108971108972108973108974108975108976108977108978108979108980108981108982108983108984108985108986108987108988108989108990108991108992108993108994108995108996108997108998108999109000109001109002109003109004109005109006109007109008109009109010109011109012109013109014109015109016109017109018109019109020109021109022109023109024109025109026109027109028109029109030109031109032109033109034109035109036109037109038109039109040109041109042109043109044109045109046109047109048109049109050109051109052109053109054109055109056109057109058109059109060109061109062109063109064109065109066109067109068109069109070109071109072109073109074109075109076109077109078109079109080109081109082109083109084109085109086109087109088109089109090109091109092109093109094109095109096109097109098109099109100109101109102109103109104109105109106109107109108109109109110109111109112109113109114109115109116109117109118109119109120109121109122109123109124109125109126109127109128109129109130109131109132109133109134109135109136109137109138109139109140109141109142109143109144109145109146109147109148109149109150109151109152109153109154109155109156109157109158109159109160109161109162109163109164109165109166109167109168109169109170109171109172109173109174109175109176109177109178109179109180109181109182109183109184109185109186109187109188109189109190109191109192109193109194109195109196109197109198109199109200109201109202109203109204109205109206109207109208109209109210109211109212109213109214109215109216109217109218109219109220109221109222109223109224109225109226109227109228109229109230109231109232109233109234109235109236109237109238109239109240109241109242109243109244109245109246109247109248109249109250109251109252109253109254109255109256109257109258109259109260109261109262109263109264109265109266109267109268109269109270109271109272109273109274109275109276109277109278109279109280109281109282109283109284109285109286109287109288109289109290109291109292109293109294109295109296109297109298109299109300109301109302109303109304109305109306109307109308109309109310109311109312109313109314109315109316109317109318109319109320109321109322109323109324109325109326109327109328109329109330109331109332109333109334109335109336109337109338109339109340109341109342109343109344109345109346109347109348109349109350109351109352109353109354109355109356109357109358109359109360109361109362109363109364109365109366109367109368109369109370109371109372109373109374109375109376109377109378109379109380109381109382109383109384109385109386109387109388109389109390109391109392109393109394109395109396109397109398109399109400109401109402109403109404109405109406109407109408109409109410109411109412109413109414109415109416109417109418109419109420109421109422109423109424109425109426109427109428109429109430109431109432109433109434109435109436109437109438109439109440109441109442109443109444109445109446109447109448109449109450109451109452109453109454109455109456109457109458109459109460109461109462109463109464109465109466109467109468109469109470109471109472109473109474109475109476109477109478109479109480109481109482109483109484109485109486109487109488109489109490109491109492109493109494109495109496109497109498109499109500109501109502109503109504109505109506109507109508109509109510109511109512109513109514109515109516109517109518109519109520109521109522109523109524109525109526109527109528109529109530109531109532109533109534109535109536109537109538109539109540109541109542109543109544109545109546109547109548109549109550109551109552109553109554109555109556109557109558109559109560109561109562109563109564109565109566109567109568109569109570109571109572109573109574109575109576109577109578109579109580109581109582109583109584109585109586109587109588109589109590109591109592109593109594109595109596109597109598109599109600109601109602109603109604109605109606109607109608109609109610109611109612109613109614109615109616109617109618109619109620109621109622109623109624109625109626109627109628109629109630109631109632109633109634109635109636109637109638109639109640109641109642109643109644109645109646109647109648109649109650109651109652109653109654109655109656109657109658109659109660109661109662109663109664109665109666109667109668109669109670109671109672109673109674109675109676109677109678109679109680109681109682109683109684109685109686109687109688109689109690109691109692109693109694109695109696109697109698109699109700109701109702109703109704109705109706109707109708109709109710109711109712109713109714109715109716109717109718109719109720109721109722109723109724109725109726109727109728109729109730109731109732109733109734109735109736109737109738109739109740109741109742109743109744109745109746109747109748109749109750109751109752109753109754109755109756109757109758109759109760109761109762109763109764109765109766109767109768109769109770109771109772109773109774109775109776109777109778109779109780109781109782109783109784109785109786109787109788109789109790109791109792109793109794109795109796109797109798109799109800109801109802109803109804109805109806109807109808109809109810109811109812109813109814109815109816109817109818109819109820109821109822109823109824109825109826109827109828109829109830109831109832109833109834109835109836109837109838109839109840109841109842109843109844109845109846109847109848109849109850109851109852109853109854109855109856109857109858109859109860109861109862109863109864109865109866109867109868109869109870109871109872109873109874109875109876109877109878109879109880109881109882109883109884109885109886109887109888109889109890109891109892109893109894109895109896109897109898109899109900109901109902109903109904109905109906109907109908109909109910109911109912109913109914109915109916109917109918109919109920109921109922109923109924109925109926109927109928109929109930109931109932109933109934109935109936109937109938109939109940109941109942109943109944109945109946109947109948109949109950109951109952109953109954109955109956109957109958109959109960109961109962109963109964109965109966109967109968109969109970109971109972109973109974109975109976109977109978109979109980109981109982109983109984109985109986109987109988109989109990109991109992109993109994109995109996109997109998109999110000110001110002110003110004110005110006110007110008110009110010110011110012110013110014110015110016110017110018110019110020110021110022110023110024110025110026110027110028110029110030110031110032110033110034110035110036110037110038110039110040110041110042110043110044110045110046110047110048110049110050110051110052110053110054110055110056110057110058110059110060110061110062110063110064110065110066110067110068110069110070110071110072110073110074110075110076110077110078110079110080110081110082110083110084110085110086110087110088110089110090110091110092110093110094110095110096110097110098110099110100110101110102110103110104110105110106110107110108110109110110110111110112110113110114110115110116110117110118110119110120110121110122110123110124110125110126110127110128110129110130110131110132110133110134110135110136110137110138110139110140110141110142110143110144110145110146110147110148110149110150110151110152110153110154110155110156110157110158110159110160110161110162110163110164110165110166110167110168110169110170110171110172110173110174110175110176110177110178110179110180110181110182110183110184110185110186110187110188110189110190110191110192110193110194110195110196110197110198110199110200110201110202110203110204110205110206110207110208110209110210110211110212110213110214110215110216110217110218110219110220110221110222110223110224110225110226110227110228110229110230110231110232110233110234110235110236110237110238110239110240110241110242110243110244110245110246110247110248110249110250110251110252110253110254110255110256110257110258110259110260110261110262110263110264110265110266110267110268110269110270110271110272110273110274110275110276110277110278110279110280110281110282110283110284110285110286110287110288110289110290110291110292110293110294110295110296110297110298110299110300110301110302110303110304110305110306110307110308110309110310110311110312110313110314110315110316110317110318110319110320110321110322110323110324110325110326110327110328110329110330110331110332110333110334110335110336110337110338110339110340110341110342110343110344110345110346110347110348110349110350110351110352110353110354110355110356110357110358110359110360110361110362110363110364110365110366110367110368110369110370110371110372110373110374110375110376110377110378110379110380110381110382110383110384110385110386110387110388110389110390110391110392110393110394110395110396110397110398110399110400110401110402110403110404110405110406110407110408110409110410110411110412110413110414110415110416110417110418110419110420110421110422110423110424110425110426110427110428110429110430110431110432110433110434110435110436110437110438110439110440110441110442110443110444110445110446110447110448110449110450110451110452110453110454110455110456110457110458110459110460110461110462110463110464110465110466110467110468110469110470110471110472110473110474110475110476110477110478110479110480110481110482110483110484110485110486110487110488110489110490110491110492110493110494110495110496110497110498110499110500110501110502110503110504110505110506110507110508110509110510110511110512110513110514110515110516110517110518110519110520110521110522110523110524110525110526110527110528110529110530110531110532110533110534110535110536110537110538110539110540110541110542110543110544110545110546110547110548110549110550110551110552110553110554110555110556110557110558110559110560110561110562110563110564110565110566110567110568110569110570110571110572110573110574110575110576110577110578110579110580110581110582110583110584110585110586110587110588110589110590110591110592110593110594110595110596110597110598110599110600110601110602110603110604110605110606110607110608110609110610110611110612110613110614110615110616110617110618110619110620110621110622110623110624110625110626110627110628110629110630110631110632110633110634110635110636110637110638110639110640110641110642110643110644110645110646110647110648110649110650110651110652110653110654110655110656110657110658110659110660110661110662110663110664110665110666110667110668110669110670110671110672110673110674110675110676110677110678110679110680110681110682110683110684110685110686110687110688110689110690110691110692110693110694110695110696110697110698110699110700110701110702110703110704110705110706110707110708110709110710110711110712110713110714110715110716110717110718110719110720110721110722110723110724110725110726110727110728110729110730110731110732110733110734110735110736110737110738110739110740110741110742110743110744110745110746110747110748110749110750110751110752110753110754110755110756110757110758110759110760110761110762110763110764110765110766110767110768110769110770110771110772110773110774110775110776110777110778110779110780110781110782110783110784110785110786110787110788110789110790110791110792110793110794110795110796110797110798110799110800110801110802110803110804110805110806110807110808110809110810110811110812110813110814110815110816110817110818110819110820110821110822110823110824110825110826110827110828110829110830110831110832110833110834110835110836110837110838110839110840110841110842110843110844110845110846110847110848110849110850110851110852110853110854110855110856110857110858110859110860110861110862110863110864110865110866110867110868110869110870110871110872110873110874110875110876110877110878110879110880110881110882110883110884110885110886110887110888110889110890110891110892110893110894110895110896110897110898110899110900110901110902110903110904110905110906110907110908110909110910110911110912110913110914110915110916110917110918110919110920110921110922110923110924110925110926110927110928110929110930110931110932110933110934110935110936110937110938110939110940110941110942110943110944110945110946110947110948110949110950110951110952110953110954110955110956110957110958110959110960110961110962110963110964110965110966110967110968110969110970110971110972110973110974110975110976110977110978110979110980110981110982110983110984110985110986110987110988110989110990110991110992110993110994110995110996110997110998110999111000111001111002111003111004111005111006111007111008111009111010111011111012111013111014111015111016111017111018111019111020111021111022111023111024111025111026111027111028111029111030111031111032111033111034111035111036111037111038111039111040111041111042111043111044111045111046111047111048111049111050111051111052111053111054111055111056111057111058111059111060111061111062111063111064111065111066111067111068111069111070111071111072111073111074111075111076111077111078111079111080111081111082111083111084111085111086111087111088111089111090111091111092111093111094111095111096111097111098111099111100111101111102111103111104111105111106111107111108111109111110111111111112111113111114111115111116111117111118111119111120111121111122111123111124111125111126111127111128111129111130111131111132111133111134111135111136111137111138111139111140111141111142111143111144111145111146111147111148111149111150111151111152111153111154111155111156111157111158111159111160111161111162111163111164111165111166111167111168111169111170111171111172111173111174111175111176111177111178111179111180111181111182111183111184111185111186111187111188111189111190111191111192111193111194111195111196111197111198111199111200111201111202111203111204111205111206111207111208111209111210111211111212111213111214111215111216111217111218111219111220111221111222111223111224111225111226111227111228111229111230111231111232111233111234111235111236111237111238111239111240111241111242111243111244111245111246111247111248111249111250111251111252111253111254111255111256111257111258111259111260111261111262111263111264111265111266111267111268111269111270111271111272111273111274111275111276111277111278111279111280111281111282111283111284111285111286111287111288111289111290111291111292111293111294111295111296111297111298111299111300111301111302111303111304111305111306111307111308111309111310111311111312111313111314111315111316111317111318111319111320111321111322111323111324111325111326111327111328111329111330111331111332111333111334111335111336111337111338111339111340111341111342111343111344111345111346111347111348111349111350111351111352111353111354111355111356111357111358111359111360111361111362111363111364111365111366111367111368111369111370111371111372111373111374111375111376111377111378111379111380111381111382111383111384111385111386111387111388111389111390111391111392111393111394111395111396111397111398111399111400111401111402111403111404111405111406111407111408111409111410111411111412111413111414111415111416111417111418111419111420111421111422111423111424111425111426111427111428111429111430111431111432111433111434111435111436111437111438111439111440111441111442111443111444111445111446111447111448111449111450111451111452111453111454111455111456111457111458111459111460111461111462111463111464111465111466111467111468111469111470111471111472111473111474111475111476111477111478111479111480111481111482111483111484111485111486111487111488111489111490111491111492111493111494111495111496111497111498111499111500111501111502111503111504111505111506111507111508111509111510111511111512111513111514111515111516111517111518111519111520111521111522111523111524111525111526111527111528111529111530111531111532111533111534111535111536111537111538111539111540111541111542111543111544111545111546111547111548111549111550111551111552111553111554111555111556111557111558111559111560111561111562111563111564111565111566111567111568111569111570111571111572111573111574111575111576111577111578111579111580111581111582111583111584111585111586111587111588111589111590111591111592111593111594111595111596111597111598111599111600111601111602111603111604111605111606111607111608111609111610111611111612111613111614111615111616111617111618111619111620111621111622111623111624111625111626111627111628111629111630111631111632111633111634111635111636111637111638111639111640111641111642111643111644111645111646111647111648111649111650111651111652111653111654111655111656111657111658111659111660111661111662111663111664111665111666111667111668111669111670111671111672111673111674111675111676111677111678111679111680111681111682111683111684111685111686111687111688111689111690111691111692111693111694111695111696111697111698111699111700111701111702111703111704111705111706111707111708111709111710111711111712111713111714111715111716111717111718111719111720111721111722111723111724111725111726111727111728111729111730111731111732111733111734111735111736111737111738111739111740111741111742111743111744111745111746111747111748111749111750111751111752111753111754111755111756111757111758111759111760111761111762111763111764111765111766111767111768111769111770111771111772111773111774111775111776111777111778111779111780111781111782111783111784111785111786111787111788111789111790111791111792111793111794111795111796111797111798111799111800111801111802111803111804111805111806111807111808111809111810111811111812111813111814111815111816111817111818111819111820111821111822111823111824111825111826111827111828111829111830111831111832111833111834111835111836111837111838111839111840111841111842111843111844111845111846111847111848111849111850111851111852111853111854111855111856111857111858111859111860111861111862111863111864111865111866111867111868111869111870111871111872111873111874111875111876111877111878111879111880111881111882111883111884111885111886111887111888111889111890111891111892111893111894111895111896111897111898111899111900111901111902111903111904111905111906111907111908111909111910111911111912111913111914111915111916111917111918111919111920111921111922111923111924111925111926111927111928111929111930111931111932111933111934111935111936111937111938111939111940111941111942111943111944111945111946111947111948111949111950111951111952111953111954111955111956111957111958111959111960111961111962111963111964111965111966111967111968111969111970111971111972111973111974111975111976111977111978111979111980111981111982111983111984111985111986111987111988111989111990111991111992111993111994111995111996111997111998111999112000112001112002112003112004112005112006112007112008112009112010112011112012112013112014112015112016112017112018112019112020112021112022112023112024112025112026112027112028112029112030112031112032112033112034112035112036112037112038112039112040112041112042112043112044112045112046112047112048112049112050112051112052112053112054112055112056112057112058112059112060112061112062112063112064112065112066112067112068112069112070112071112072112073112074112075112076112077112078112079112080112081112082112083112084112085112086112087112088112089112090112091112092112093112094112095112096112097112098112099112100112101112102112103112104112105112106112107112108112109112110112111112112112113112114112115112116112117112118112119112120112121112122112123112124112125112126112127112128112129112130112131112132112133112134112135112136112137112138112139112140112141112142112143112144112145112146112147112148112149112150112151112152112153112154112155112156112157112158112159112160112161112162112163112164112165112166112167112168112169112170112171112172112173112174112175112176112177112178112179112180112181112182112183112184112185112186112187112188112189112190112191112192112193112194112195112196112197112198112199112200112201112202112203112204112205112206112207112208112209112210112211112212112213112214112215112216112217112218112219112220112221112222112223112224112225112226112227112228112229112230112231112232112233112234112235112236112237112238112239112240112241112242112243112244112245112246112247112248112249112250112251112252112253112254112255112256112257112258112259112260112261112262112263112264112265112266112267112268112269112270112271112272112273112274112275112276112277112278112279112280112281112282112283112284112285112286112287112288112289112290112291112292112293112294112295112296112297112298112299112300112301112302112303112304112305112306112307112308112309112310112311112312112313112314112315112316112317112318112319112320112321112322112323112324112325112326112327112328112329112330112331112332112333112334112335112336112337112338112339112340112341112342112343112344112345112346112347112348112349112350112351112352112353112354112355112356112357112358112359112360112361112362112363112364112365112366112367112368112369112370112371112372112373112374112375112376112377112378112379112380112381112382112383112384112385112386112387112388112389112390112391112392112393112394112395112396112397112398112399112400112401112402112403112404112405112406112407112408112409112410112411112412112413112414112415112416112417112418112419112420112421112422112423112424112425112426112427112428112429112430112431112432112433112434112435112436112437112438112439112440112441112442112443112444112445112446112447112448112449112450112451112452112453112454112455112456112457112458112459112460112461112462112463112464112465112466112467112468112469112470112471112472112473112474112475112476112477112478112479112480112481112482112483112484112485112486112487112488112489112490112491112492112493112494112495112496112497112498112499112500112501112502112503112504112505112506112507112508112509112510112511112512112513112514112515112516112517112518112519112520112521112522112523112524112525112526112527112528112529112530112531112532112533112534112535112536112537112538112539112540112541112542112543112544112545112546112547112548112549112550112551112552112553112554112555112556112557112558112559112560112561112562112563112564112565112566112567112568112569112570112571112572112573112574112575112576112577112578112579112580112581112582112583112584112585112586112587112588112589112590112591112592112593112594112595112596112597112598112599112600112601112602112603112604112605112606112607112608112609112610112611112612112613112614112615112616112617112618112619112620112621112622112623112624112625112626112627112628112629112630112631112632112633112634112635112636112637112638112639112640112641112642112643112644112645112646112647112648112649112650112651112652112653112654112655112656112657112658112659112660112661112662112663112664112665112666112667112668112669112670112671112672112673112674112675112676112677112678112679112680112681112682112683112684112685112686112687112688112689112690112691112692112693112694112695112696112697112698112699112700112701112702112703112704112705112706112707112708112709112710112711112712112713112714112715112716112717112718112719112720112721112722112723112724112725112726112727112728112729112730112731112732112733112734112735112736112737112738112739112740112741112742112743112744112745112746112747112748112749112750112751112752112753112754112755112756112757112758112759112760112761112762112763112764112765112766112767112768112769112770112771112772112773112774112775112776112777112778112779112780112781112782112783112784112785112786112787112788112789112790112791112792112793112794112795112796112797112798112799112800112801112802112803112804112805112806112807112808112809112810112811112812112813112814112815112816112817112818112819112820112821112822112823112824112825112826112827112828112829112830112831112832112833112834112835112836112837112838112839112840112841112842112843112844112845112846112847112848112849112850112851112852112853112854112855112856112857112858112859112860112861112862112863112864112865112866112867112868112869112870112871112872112873112874112875112876112877112878112879112880112881112882112883112884112885112886112887112888112889112890112891112892112893112894112895112896112897112898112899112900112901112902112903112904112905112906112907112908112909112910112911112912112913112914112915112916112917112918112919112920112921112922112923112924112925112926112927112928112929112930112931112932112933112934112935112936112937112938112939112940112941112942112943112944112945112946112947112948112949112950112951112952112953112954112955112956112957112958112959112960112961112962112963112964112965112966112967112968112969112970112971112972112973112974112975112976112977112978112979112980112981112982112983112984112985112986112987112988112989112990112991112992112993112994112995112996112997112998112999113000113001113002113003113004113005113006113007113008113009113010113011113012113013113014113015113016113017113018113019113020113021113022113023113024113025113026113027113028113029113030113031113032113033113034113035113036113037113038113039113040113041113042113043113044113045113046113047113048113049113050113051113052113053113054113055113056113057113058113059113060113061113062113063113064113065113066113067113068113069113070113071113072113073113074113075113076113077113078113079113080113081113082113083113084113085113086113087113088113089113090113091113092113093113094113095113096113097113098113099113100113101113102113103113104113105113106113107113108113109113110113111113112113113113114113115113116113117113118113119113120113121113122113123113124113125113126113127113128113129113130113131113132113133113134113135113136113137113138113139113140113141113142113143113144113145113146113147113148113149113150113151113152113153113154113155113156113157113158113159113160113161113162113163113164113165113166113167113168113169113170113171113172113173113174113175113176113177113178113179113180113181113182113183113184113185113186113187113188113189113190113191113192113193113194113195113196113197113198113199113200113201113202113203113204113205113206113207113208113209113210113211113212113213113214113215113216113217113218113219113220113221113222113223113224113225113226113227113228113229113230113231113232113233113234113235113236113237113238113239113240113241113242113243113244113245113246113247113248113249113250113251113252113253113254113255113256113257113258113259113260113261113262113263113264113265113266113267113268113269113270113271113272113273113274113275113276113277113278113279113280113281113282113283113284113285113286113287113288113289113290113291113292113293113294113295113296113297113298113299113300113301113302113303113304113305113306113307113308113309113310113311113312113313113314113315113316113317113318113319113320113321113322113323113324113325113326113327113328113329113330113331113332113333113334113335113336113337113338113339113340113341113342113343113344113345113346113347113348113349113350113351113352113353113354113355113356113357113358113359113360113361113362113363113364113365113366113367113368113369113370113371113372113373113374113375113376113377113378113379113380113381113382113383113384113385113386113387113388113389113390113391113392113393113394113395113396113397113398113399113400113401113402113403113404113405113406113407113408113409113410113411113412113413113414113415113416113417113418113419113420113421113422113423113424113425113426113427113428113429113430113431113432113433113434113435113436113437113438113439113440113441113442113443113444113445113446113447113448113449113450113451113452113453113454113455113456113457113458113459113460113461113462113463113464113465113466113467113468113469113470113471113472113473113474113475113476113477113478113479113480113481113482113483113484113485113486113487113488113489113490113491113492113493113494113495113496113497113498113499113500113501113502113503113504113505113506113507113508113509113510113511113512113513113514113515113516113517113518113519113520113521113522113523113524113525113526113527113528113529113530113531113532113533113534113535113536113537113538113539113540113541113542113543113544113545113546113547113548113549113550113551113552113553113554113555113556113557113558113559113560113561113562113563113564113565113566113567113568113569113570113571113572113573113574113575113576113577113578113579113580113581113582113583113584113585113586113587113588113589113590113591113592113593113594113595113596113597113598113599113600113601113602113603113604113605113606113607113608113609113610113611113612113613113614113615113616113617113618113619113620113621113622113623113624113625113626113627113628113629113630113631113632113633113634113635113636113637113638113639113640113641113642113643113644113645113646113647113648113649113650113651113652113653113654113655113656113657113658113659113660113661113662113663113664113665113666113667113668113669113670113671113672113673113674113675113676113677113678113679113680113681113682113683113684113685113686113687113688113689113690113691113692113693113694113695113696113697113698113699113700113701113702113703113704113705113706113707113708113709113710113711113712113713113714113715113716113717113718113719113720113721113722113723113724113725113726113727113728113729113730113731113732113733113734113735113736113737113738113739113740113741113742113743113744113745113746113747113748113749113750113751113752113753113754113755113756113757113758113759113760113761113762113763113764113765113766113767113768113769113770113771113772113773113774113775113776113777113778113779113780113781113782113783113784113785113786113787113788113789113790113791113792113793113794113795113796113797113798113799113800113801113802113803113804113805113806113807113808113809113810113811113812113813113814113815113816113817113818113819113820113821113822113823113824113825113826113827113828113829113830113831113832113833113834113835113836113837113838113839113840113841113842113843113844113845113846113847113848113849113850113851113852113853113854113855113856113857113858113859113860113861113862113863113864113865113866113867113868113869113870113871113872113873113874113875113876113877113878113879113880113881113882113883113884113885113886113887113888113889113890113891113892113893113894113895113896113897113898113899113900113901113902113903113904113905113906113907113908113909113910113911113912113913113914113915113916113917113918113919113920113921113922113923113924113925113926113927113928113929113930113931113932113933113934113935113936113937113938113939113940113941113942113943113944113945113946113947113948113949113950113951113952113953113954113955113956113957113958113959113960113961113962113963113964113965113966113967113968113969113970113971113972113973113974113975113976113977113978113979113980113981113982113983113984113985113986113987113988113989113990113991113992113993113994113995113996113997113998113999114000114001114002114003114004114005114006114007114008114009114010114011114012114013114014114015114016114017114018114019114020114021114022114023114024114025114026114027114028114029114030114031114032114033114034114035114036114037114038114039114040114041114042114043114044114045114046114047114048114049114050114051114052114053114054114055114056114057114058114059114060114061114062114063114064114065114066114067114068114069114070114071114072114073114074114075114076114077114078114079114080114081114082114083114084114085114086114087114088114089114090114091114092114093114094114095114096114097114098114099114100114101114102114103114104114105114106114107114108114109114110114111114112114113114114114115114116114117114118114119114120114121114122114123114124114125114126114127114128114129114130114131114132114133114134114135114136114137114138114139114140114141114142114143114144114145114146114147114148114149114150114151114152114153114154114155114156114157114158114159114160114161114162114163114164114165114166114167114168114169114170114171114172114173114174114175114176114177114178114179114180114181114182114183114184114185114186114187114188114189114190114191114192114193114194114195114196114197114198114199114200114201114202114203114204114205114206114207114208114209114210114211114212114213114214114215114216114217114218114219114220114221114222114223114224114225114226114227114228114229114230114231114232114233114234114235114236114237114238114239114240114241114242114243114244114245114246114247114248114249114250114251114252114253114254114255114256114257114258114259114260114261114262114263114264114265114266114267114268114269114270114271114272114273114274114275114276114277114278114279114280114281114282114283114284114285114286114287114288114289114290114291114292114293114294114295114296114297114298114299114300114301114302114303114304114305114306114307114308114309114310114311114312114313114314114315114316114317114318114319114320114321114322114323114324114325114326114327114328114329114330114331114332114333114334114335114336114337114338114339114340114341114342114343114344114345114346114347114348114349114350114351114352114353114354114355114356114357114358114359114360114361114362114363114364114365114366114367114368114369114370114371114372114373114374114375114376114377114378114379114380114381114382114383114384114385114386114387114388114389114390114391114392114393114394114395114396114397114398114399114400114401114402114403114404114405114406114407114408114409114410114411114412114413114414114415114416114417114418114419114420114421114422114423114424114425114426114427114428114429114430114431114432114433114434114435114436114437114438114439114440114441114442114443114444114445114446114447114448114449114450114451114452114453114454114455114456114457114458114459114460114461114462114463114464114465114466114467114468114469114470114471114472114473114474114475114476114477114478114479114480114481114482114483114484114485114486114487114488114489114490114491114492114493114494114495114496114497114498114499114500114501114502114503114504114505114506114507114508114509114510114511114512114513114514114515114516114517114518114519114520114521114522114523114524114525114526114527114528114529114530114531114532114533114534114535114536114537114538114539114540114541114542114543114544114545114546114547114548114549114550114551114552114553114554114555114556114557114558114559114560114561114562114563114564114565114566114567114568114569114570114571114572114573114574114575114576114577114578114579114580114581114582114583114584114585114586114587114588114589114590114591114592114593114594114595114596114597114598114599114600114601114602114603114604114605114606114607114608114609114610114611114612114613114614114615114616114617114618114619114620114621114622114623114624114625114626114627114628114629114630114631114632114633114634114635114636114637114638114639114640114641114642114643114644114645114646114647114648114649114650114651114652114653114654114655114656114657114658114659114660114661114662114663114664114665114666114667114668114669114670114671114672114673114674114675114676114677114678114679114680114681114682114683114684114685114686114687114688114689114690114691114692114693114694114695114696114697114698114699114700114701114702114703114704114705114706114707114708114709114710114711114712114713114714114715114716114717114718114719114720114721114722114723114724114725114726114727114728114729114730114731114732114733114734114735114736114737114738114739114740114741114742114743114744114745114746114747114748114749114750114751114752114753114754114755114756114757114758114759114760114761114762114763114764114765114766114767114768114769114770114771114772114773114774114775114776114777114778114779114780114781114782114783114784114785114786114787114788114789114790114791114792114793114794114795114796114797114798114799114800114801114802114803114804114805114806114807114808114809114810114811114812114813114814114815114816114817114818114819114820114821114822114823114824114825114826114827114828114829114830114831114832114833114834114835114836114837114838114839114840114841114842114843114844114845114846114847114848114849114850114851114852114853114854114855114856114857114858114859114860114861114862114863114864114865114866114867114868114869114870114871114872114873114874114875114876114877114878114879114880114881114882114883114884114885114886114887114888114889114890114891114892114893114894114895114896114897114898114899114900114901114902114903114904114905114906114907114908114909114910114911114912114913114914114915114916114917114918114919114920114921114922114923114924114925114926114927114928114929114930114931114932114933114934114935114936114937114938114939114940114941114942114943114944114945114946114947114948114949114950114951114952114953114954114955114956114957114958114959114960114961114962114963114964114965114966114967114968114969114970114971114972114973114974114975114976114977114978114979114980114981114982114983114984114985114986114987114988114989114990114991114992114993114994114995114996114997114998114999115000115001115002115003115004115005115006115007115008115009115010115011115012115013115014115015115016115017115018115019115020115021115022115023115024115025115026115027115028115029115030115031115032115033115034115035115036115037115038115039115040115041115042115043115044115045115046115047115048115049115050115051115052115053115054115055115056115057115058115059115060115061115062115063115064115065115066115067115068115069115070115071115072115073115074115075115076115077115078115079115080115081115082115083115084115085115086115087115088115089115090115091115092115093115094115095115096115097115098115099115100115101115102115103115104115105115106115107115108115109115110115111115112115113115114115115115116115117115118115119115120115121115122115123115124115125115126115127115128115129115130115131115132115133115134115135115136115137115138115139115140115141115142115143115144115145115146115147115148115149115150115151115152115153115154115155115156115157115158115159115160115161115162115163115164115165115166115167115168115169115170115171115172115173115174115175115176115177115178115179115180115181115182115183115184115185115186115187115188115189115190115191115192115193115194115195115196115197115198115199115200115201115202115203115204115205115206115207115208115209115210115211115212115213115214115215115216115217115218115219115220115221115222115223115224115225115226115227115228115229115230115231115232115233115234115235115236115237115238115239115240115241115242115243115244115245115246115247115248115249115250115251115252115253115254115255115256115257115258115259115260115261115262115263115264115265115266115267115268115269115270115271115272115273115274115275115276115277115278115279115280115281115282115283115284115285115286115287115288115289115290115291115292115293115294115295115296115297115298115299115300115301115302115303115304115305115306115307115308115309115310115311115312115313115314115315115316115317115318115319115320115321115322115323115324115325115326115327115328115329115330115331115332115333115334115335115336115337115338115339115340115341115342115343115344115345115346115347115348115349115350115351115352115353115354115355115356115357115358115359115360115361115362115363115364115365115366115367115368115369115370115371115372115373115374115375115376115377115378115379115380115381115382115383115384115385115386115387115388115389115390115391115392115393115394115395115396115397115398115399115400115401115402115403115404115405115406115407115408115409115410115411115412115413115414115415115416115417115418115419115420115421115422115423115424115425115426115427115428115429115430115431115432115433115434115435115436115437115438115439115440115441115442115443115444115445115446115447115448115449115450115451115452115453115454115455115456115457115458115459115460115461115462115463115464115465115466115467115468115469115470115471115472115473115474115475115476115477115478115479115480115481115482115483115484115485115486115487115488115489115490115491115492115493115494115495115496115497115498115499115500115501115502115503115504115505115506115507115508115509115510115511115512115513115514115515115516115517115518115519115520115521115522115523115524115525115526115527115528115529115530115531115532115533115534115535115536115537115538115539115540115541115542115543115544115545115546115547115548115549115550115551115552115553115554115555115556115557115558115559115560115561115562115563115564115565115566115567115568115569115570115571115572115573115574115575115576115577115578115579115580115581115582115583115584115585115586115587115588115589115590115591115592115593115594115595115596115597115598115599115600115601115602115603115604115605115606115607115608115609115610115611115612115613115614115615115616115617115618115619115620115621115622115623115624115625115626115627115628115629115630115631115632115633115634115635115636115637115638115639115640115641115642115643115644115645115646115647115648115649115650115651115652115653115654115655115656115657115658115659115660115661115662115663115664115665115666115667115668115669115670115671115672115673115674115675115676115677115678115679115680115681115682115683115684115685115686115687115688115689115690115691115692115693115694115695115696115697115698115699115700115701115702115703115704115705115706115707115708115709115710115711115712115713115714115715115716115717115718115719115720115721115722115723115724115725115726115727115728115729115730115731115732115733115734115735115736115737115738115739115740115741115742115743115744115745115746115747115748115749115750115751115752115753115754115755115756115757115758115759115760115761115762115763115764115765115766115767115768115769115770115771115772115773115774115775115776115777115778115779115780115781115782115783115784115785115786115787115788115789115790115791115792115793115794115795115796115797115798115799115800115801115802115803115804115805115806115807115808115809115810115811115812115813115814115815115816115817115818115819115820115821115822115823115824115825115826115827115828115829115830115831115832115833115834115835115836115837115838115839115840115841115842115843115844115845115846115847115848115849115850115851115852115853115854115855115856115857115858115859115860115861115862115863115864115865115866115867115868115869115870115871115872115873115874115875115876115877115878115879115880115881115882115883115884115885115886115887115888115889115890115891115892115893115894115895115896115897115898115899115900115901115902115903115904115905115906115907115908115909115910115911115912115913115914115915115916115917115918115919115920115921115922115923115924115925115926115927115928115929115930115931115932115933115934115935115936115937115938115939115940115941115942115943115944115945115946115947115948115949115950115951115952115953115954115955115956115957115958115959115960115961115962115963115964115965115966115967115968115969115970115971115972115973115974115975115976115977115978115979115980115981115982115983115984115985115986115987115988115989115990115991115992115993115994115995115996115997115998115999116000116001116002116003116004116005116006116007116008116009116010116011116012116013116014116015116016116017116018116019116020116021116022116023116024116025116026116027116028116029116030116031116032116033116034116035116036116037116038116039116040116041116042116043116044116045116046116047116048116049116050116051116052116053116054116055116056116057116058116059116060116061116062116063116064116065116066116067116068116069116070116071116072116073116074116075116076116077116078116079116080116081116082116083116084116085116086116087116088116089116090116091116092116093116094116095116096116097116098116099116100116101116102116103116104116105116106116107116108116109116110116111116112116113116114116115116116116117116118116119116120116121116122116123116124116125116126116127116128116129116130116131116132116133116134116135116136116137116138116139116140116141116142116143116144116145116146116147116148116149116150116151116152116153116154116155116156116157116158116159116160116161116162116163116164116165116166116167116168116169116170116171116172116173116174116175116176116177116178116179116180116181116182116183116184116185116186116187116188116189116190116191116192116193116194116195116196116197116198116199116200116201116202116203116204116205116206116207116208116209116210116211116212116213116214116215116216116217116218116219116220116221116222116223116224116225116226116227116228116229116230116231116232116233116234116235116236116237116238116239116240116241116242116243116244116245116246116247116248116249116250116251116252116253116254116255116256116257116258116259116260116261116262116263116264116265116266116267116268116269116270116271116272116273116274116275116276116277116278116279116280116281116282116283116284116285116286116287116288116289116290116291116292116293116294116295116296116297116298116299116300116301116302116303116304116305116306116307116308116309116310116311116312116313116314116315116316116317116318116319116320116321116322116323116324116325116326116327116328116329116330116331116332116333116334116335116336116337116338116339116340116341116342116343116344116345116346116347116348116349116350116351116352116353116354116355116356116357116358116359116360116361116362116363116364116365116366116367116368116369116370116371116372116373116374116375116376116377116378116379116380116381116382116383116384116385116386116387116388116389116390116391116392116393116394116395116396116397116398116399116400116401116402116403116404116405116406116407116408116409116410116411116412116413116414116415116416116417116418116419116420116421116422116423116424116425116426116427116428116429116430116431116432116433116434116435116436116437116438116439116440116441116442116443116444116445116446116447116448116449116450116451116452116453116454116455116456116457116458116459116460116461116462116463116464116465116466116467116468116469116470116471116472116473116474116475116476116477116478116479116480116481116482116483116484116485116486116487116488116489116490116491116492116493116494116495116496116497116498116499116500116501116502116503116504116505116506116507116508116509116510116511116512116513116514116515116516116517116518116519116520116521116522116523116524116525116526116527116528116529116530116531116532116533116534116535116536116537116538116539116540116541116542116543116544116545116546116547116548116549116550116551116552116553116554116555116556116557116558116559116560116561116562116563116564116565116566116567116568116569116570116571116572116573116574116575116576116577116578116579116580116581116582116583116584116585116586116587116588116589116590116591116592116593116594116595116596116597116598116599116600116601116602116603116604116605116606116607116608116609116610116611116612116613116614116615116616116617116618116619116620116621116622116623116624116625116626116627116628116629116630116631116632116633116634116635116636116637116638116639116640116641116642116643116644116645116646116647116648116649116650116651116652116653116654116655116656116657116658116659116660116661116662116663116664116665116666116667116668116669116670116671116672116673116674116675116676116677116678116679116680116681116682116683116684116685116686116687116688116689116690116691116692116693116694116695116696116697116698116699116700116701116702116703116704116705116706116707116708116709116710116711116712116713116714116715116716116717116718116719116720116721116722116723116724116725116726116727116728116729116730116731116732116733116734116735116736116737116738116739116740116741116742116743116744116745116746116747116748116749116750116751116752116753116754116755116756116757116758116759116760116761116762116763116764116765116766116767116768116769116770116771116772116773116774116775116776116777116778116779116780116781116782116783116784116785116786116787116788116789116790116791116792116793116794116795116796116797116798116799116800116801116802116803116804116805116806116807116808116809116810116811116812116813116814116815116816116817116818116819116820116821116822116823116824116825116826116827116828116829116830116831116832116833116834116835116836116837116838116839116840116841116842116843116844116845116846116847116848116849116850116851116852116853116854116855116856116857116858116859116860116861116862116863116864116865116866116867116868116869116870116871116872116873116874116875116876116877116878116879116880116881116882116883116884116885116886116887116888116889116890116891116892116893116894116895116896116897116898116899116900116901116902116903116904116905116906116907116908116909116910116911116912116913116914116915116916116917116918116919116920116921116922116923116924116925116926116927116928116929116930116931116932116933116934116935116936116937116938116939116940116941116942116943116944116945116946116947116948116949116950116951116952116953116954116955116956116957116958116959116960116961116962116963116964116965116966116967116968116969116970116971116972116973116974116975116976116977116978116979116980116981116982116983116984116985116986116987116988116989116990116991116992116993116994116995116996116997116998116999117000117001117002117003117004117005117006117007117008117009117010117011117012117013117014117015117016117017117018117019117020117021117022117023117024117025117026117027117028117029117030117031117032117033117034117035117036117037117038117039117040117041117042117043117044117045117046117047117048117049117050117051117052117053117054117055117056117057117058117059117060117061117062117063117064117065117066117067117068117069117070117071117072117073117074117075117076117077117078117079117080117081117082117083117084117085117086117087117088117089117090117091117092117093117094117095117096117097117098117099117100117101117102117103117104117105117106117107117108117109117110117111117112117113117114117115117116117117117118117119117120117121117122117123117124117125117126117127117128117129117130117131117132117133117134117135117136117137117138117139117140117141117142117143117144117145117146117147117148117149117150117151117152117153117154117155117156117157117158117159117160117161117162117163117164117165117166117167117168117169117170117171117172117173117174117175117176117177117178117179117180117181117182117183117184117185117186117187117188117189117190117191117192117193117194117195117196117197117198117199117200117201117202117203117204117205117206117207117208117209117210117211117212117213117214117215117216117217117218117219117220117221117222117223117224117225117226117227117228117229117230117231117232117233117234117235117236117237117238117239117240117241117242117243117244117245117246117247117248117249117250117251117252117253117254117255117256117257117258117259117260117261117262117263117264117265117266117267117268117269117270117271117272117273117274117275117276117277117278117279117280117281117282117283117284117285117286117287117288117289117290117291117292117293117294117295117296117297117298117299117300117301117302117303117304117305117306117307117308117309117310117311117312117313117314117315117316117317117318117319117320117321117322117323117324117325117326117327117328117329117330117331117332117333117334117335117336117337117338117339117340117341117342117343117344117345117346117347117348117349117350117351117352117353117354117355117356117357117358117359117360117361117362117363117364117365117366117367117368117369117370117371117372117373117374117375117376117377117378117379117380117381117382117383117384117385117386117387117388117389117390117391117392117393117394117395117396117397117398117399117400117401117402117403117404117405117406117407117408117409117410117411117412117413117414117415117416117417117418117419117420117421117422117423117424117425117426117427117428117429117430117431117432117433117434117435117436117437117438117439117440117441117442117443117444117445117446117447117448117449117450117451117452117453117454117455117456117457117458117459117460117461117462117463117464117465117466117467117468117469117470117471117472117473117474117475117476117477117478117479117480117481117482117483117484117485117486117487117488117489117490117491117492117493117494117495117496117497117498117499117500117501117502117503117504117505117506117507117508117509117510117511117512117513117514117515117516117517117518117519117520117521117522117523117524117525117526117527117528117529117530117531117532117533117534117535117536117537117538117539117540117541117542117543117544117545117546117547117548117549117550117551117552117553117554117555117556117557117558117559117560117561117562117563117564117565117566117567117568117569117570117571117572117573117574117575117576117577117578117579117580117581117582117583117584117585117586117587117588117589117590117591117592117593117594117595117596117597117598117599117600117601117602117603117604117605117606117607117608117609117610117611117612117613117614117615117616117617117618117619117620117621117622117623117624117625117626117627117628117629117630117631117632117633117634117635117636117637117638117639117640117641117642117643117644117645117646117647117648117649117650117651117652117653117654117655117656117657117658117659117660117661117662117663117664117665117666117667117668117669117670117671117672117673117674117675117676117677117678117679117680117681117682117683117684117685117686117687117688117689117690117691117692117693117694117695117696117697117698117699117700117701117702117703117704117705117706117707117708117709117710117711117712117713117714117715117716117717117718117719117720117721117722117723117724117725117726117727117728117729117730117731117732117733117734117735117736117737117738117739117740117741117742117743117744117745117746117747117748117749117750117751117752117753117754117755117756117757117758117759117760117761117762117763117764117765117766117767117768117769117770117771117772117773117774117775117776117777117778117779117780117781117782117783117784117785117786117787117788117789117790117791117792117793117794117795117796117797117798117799117800117801117802117803117804117805117806117807117808117809117810117811117812117813117814117815117816117817117818117819117820117821117822117823117824117825117826117827117828117829117830117831117832117833117834117835117836117837117838117839117840117841117842117843117844117845117846117847117848117849117850117851117852117853117854117855117856117857117858117859117860117861117862117863117864117865117866117867117868117869117870117871117872117873117874117875117876117877117878117879117880117881117882117883117884117885117886117887117888117889117890117891117892117893117894117895117896117897117898117899117900117901117902117903117904117905117906117907117908117909117910117911117912117913117914117915117916117917117918117919117920117921117922117923117924117925117926117927117928117929117930117931117932117933117934117935117936117937117938117939117940117941117942117943117944117945117946117947117948117949117950117951117952117953117954117955117956117957117958117959117960117961117962117963117964117965117966117967117968117969117970117971117972117973117974117975117976117977117978117979117980117981117982117983117984117985117986117987117988117989117990117991117992117993117994117995117996117997117998117999118000118001118002118003118004118005118006118007118008118009118010118011118012118013118014118015118016118017118018118019118020118021118022118023118024118025118026118027118028118029118030118031118032118033118034118035118036118037118038118039118040118041118042118043118044118045118046118047118048118049118050118051118052118053118054118055118056118057118058118059118060118061118062118063118064118065118066118067118068118069118070118071118072118073118074118075118076118077118078118079118080118081118082118083118084118085118086118087118088118089118090118091118092118093118094118095118096118097118098118099118100118101118102118103118104118105118106118107118108118109118110118111118112118113118114118115118116118117118118118119118120118121118122118123118124118125118126118127118128118129118130118131118132118133118134118135118136118137118138118139118140118141118142118143118144118145118146118147118148118149118150118151118152118153118154118155118156118157118158118159118160118161118162118163118164118165118166118167118168118169118170118171118172118173118174118175118176118177118178118179118180118181118182118183118184118185118186118187118188118189118190118191118192118193118194118195118196118197118198118199118200118201118202118203118204118205118206118207118208118209118210118211118212118213118214118215118216118217118218118219118220118221118222118223118224118225118226118227118228118229118230118231118232118233118234118235118236118237118238118239118240118241118242118243118244118245118246118247118248118249118250118251118252118253118254118255118256118257118258118259118260118261118262118263118264118265118266118267118268118269118270118271118272118273118274118275118276118277118278118279118280118281118282118283118284118285118286118287118288118289118290118291118292118293118294118295118296118297118298118299118300118301118302118303118304118305118306118307118308118309118310118311118312118313118314118315118316118317118318118319118320118321118322118323118324118325118326118327118328118329118330118331118332118333118334118335118336118337118338118339118340118341118342118343118344118345118346118347118348118349118350118351118352118353118354118355118356118357118358118359118360118361118362118363118364118365118366118367118368118369118370118371118372118373118374118375118376118377118378118379118380118381118382118383118384118385118386118387118388118389118390118391118392118393118394118395118396118397118398118399118400118401118402118403118404118405118406118407118408118409118410118411118412118413118414118415118416118417118418118419118420118421118422118423118424118425118426118427118428118429118430118431118432118433118434118435118436118437118438118439118440118441118442118443118444118445118446118447118448118449118450118451118452118453118454118455118456118457118458118459118460118461118462118463118464118465118466118467118468118469118470118471118472118473118474118475118476118477118478118479118480118481118482118483118484118485118486118487118488118489118490118491118492118493118494118495118496118497118498118499118500118501118502118503118504118505118506118507118508118509118510118511118512118513118514118515118516118517118518118519118520118521118522118523118524118525118526118527118528118529118530118531118532118533118534118535118536118537118538118539118540118541118542118543118544118545118546118547118548118549118550118551118552118553118554118555118556118557118558118559118560118561118562118563118564118565118566118567118568118569118570118571118572118573118574118575118576118577118578118579118580118581118582118583118584118585118586118587118588118589118590118591118592118593118594118595118596118597118598118599118600118601118602118603118604118605118606118607118608118609118610118611118612118613118614118615118616118617118618118619118620118621118622118623118624118625118626118627118628118629118630118631118632118633118634118635118636118637118638118639118640118641118642118643118644118645118646118647118648118649118650118651118652118653118654118655118656118657118658118659118660118661118662118663118664118665118666118667118668118669118670118671118672118673118674118675118676118677118678118679118680118681118682118683118684118685118686118687118688118689118690118691118692118693118694118695118696118697118698118699118700118701118702118703118704118705118706118707118708118709118710118711118712118713118714118715118716118717118718118719118720118721118722118723118724118725118726118727118728118729118730118731118732118733118734118735118736118737118738118739118740118741118742118743118744118745118746118747118748118749118750118751118752118753118754118755118756118757118758118759118760118761118762118763118764118765118766118767118768118769118770118771118772118773118774118775118776118777118778118779118780118781118782118783118784118785118786118787118788118789118790118791118792118793118794118795118796118797118798118799118800118801118802118803118804118805118806118807118808118809118810118811118812118813118814118815118816118817118818118819118820118821118822118823118824118825118826118827118828118829118830118831118832118833118834118835118836118837118838118839118840118841118842118843118844118845118846118847118848118849118850118851118852118853118854118855118856118857118858118859118860118861118862118863118864118865118866118867118868118869118870118871118872118873118874118875118876118877118878118879118880118881118882118883118884118885118886118887118888118889118890118891118892118893118894118895118896118897118898118899118900118901118902118903118904118905118906118907118908118909118910118911118912118913118914118915118916118917118918118919118920118921118922118923118924118925118926118927118928118929118930118931118932118933118934118935118936118937118938118939118940118941118942118943118944118945118946118947118948118949118950118951118952118953118954118955118956118957118958118959118960118961118962118963118964118965118966118967118968118969118970118971118972118973118974118975118976118977118978118979118980118981118982118983118984118985118986118987118988118989118990118991118992118993118994118995118996118997118998118999119000119001119002119003119004119005119006119007119008119009119010119011119012119013119014119015119016119017119018119019119020119021119022119023119024119025119026119027119028119029119030119031119032119033119034119035119036119037119038119039119040119041119042119043119044119045119046119047119048119049119050119051119052119053119054119055119056119057119058119059119060119061119062119063119064119065119066119067119068119069119070119071119072119073119074119075119076119077119078119079119080119081119082119083119084119085119086119087119088119089119090119091119092119093119094119095119096119097119098119099119100119101119102119103119104119105119106119107119108119109119110119111119112119113119114119115119116119117119118119119119120119121119122119123119124119125119126119127119128119129119130119131119132119133119134119135119136119137119138119139119140119141119142119143119144119145119146119147119148119149119150119151119152119153119154119155119156119157119158119159119160119161119162119163119164119165119166119167119168119169119170119171119172119173119174119175119176119177119178119179119180119181119182119183119184119185119186119187119188119189119190119191119192119193119194119195119196119197119198119199119200119201119202119203119204119205119206119207119208119209119210119211119212119213119214119215119216119217119218119219119220119221119222119223119224119225119226119227119228119229119230119231119232119233119234119235119236119237119238119239119240119241119242119243119244119245119246119247119248119249119250119251119252119253119254119255119256119257119258119259119260119261119262119263119264119265119266119267119268119269119270119271119272119273119274119275119276119277119278119279119280119281119282119283119284119285119286119287119288119289119290119291119292119293119294119295119296119297119298119299119300119301119302119303119304119305119306119307119308119309119310119311119312119313119314119315119316119317119318119319119320119321119322119323119324119325119326119327119328119329119330119331119332119333119334119335119336119337119338119339119340119341119342119343119344119345119346119347119348119349119350119351119352119353119354119355119356119357119358119359119360119361119362119363119364119365119366119367119368119369119370119371119372119373119374119375119376119377119378119379119380119381119382119383119384119385119386119387119388119389119390119391119392119393119394119395119396119397119398119399119400119401119402119403119404119405119406119407119408119409119410119411119412119413119414119415119416119417119418119419119420119421119422119423119424119425119426119427119428119429119430119431119432119433119434119435119436119437119438119439119440119441119442119443119444119445119446119447119448119449119450119451119452119453119454119455119456119457119458119459119460119461119462119463119464119465119466119467119468119469119470119471119472119473119474119475119476119477119478119479119480119481119482119483119484119485119486119487119488119489119490119491119492119493119494119495119496119497119498119499119500119501119502119503119504119505119506119507119508119509119510119511119512119513119514119515119516119517119518119519119520119521119522119523119524119525119526119527119528119529119530119531119532119533119534119535119536119537119538119539119540119541119542119543119544119545119546119547119548119549119550119551119552119553119554119555119556119557119558119559119560119561119562119563119564119565119566119567119568119569119570119571119572119573119574119575119576119577119578119579119580119581119582119583119584119585119586119587119588119589119590119591119592119593119594119595119596119597119598119599119600119601119602119603119604119605119606119607119608119609119610119611119612119613119614119615119616119617119618119619119620119621119622119623119624119625119626119627119628119629119630119631119632119633119634119635119636119637119638119639119640119641119642119643119644119645119646119647119648119649119650119651119652119653119654119655119656119657119658119659119660119661119662119663119664119665119666119667119668119669119670119671119672119673119674119675119676119677119678119679119680119681119682119683119684119685119686119687119688119689119690119691119692119693119694119695119696119697119698119699119700119701119702119703119704119705119706119707119708119709119710119711119712119713119714119715119716119717119718119719119720119721119722119723119724119725119726119727119728119729119730119731119732119733119734119735119736119737119738119739119740119741119742119743119744119745119746119747119748119749119750119751119752119753119754119755119756119757119758119759119760119761119762119763119764119765119766119767119768119769119770119771119772119773119774119775119776119777119778119779119780119781119782119783119784119785119786119787119788119789119790119791119792119793119794119795119796119797119798119799119800119801119802119803119804119805119806119807119808119809119810119811119812119813119814119815119816119817119818119819119820119821119822119823119824119825119826119827119828119829119830119831119832119833119834119835119836119837119838119839119840119841119842119843119844119845119846119847119848119849119850119851119852119853119854119855119856119857119858119859119860119861119862119863119864119865119866119867119868119869119870119871119872119873119874119875119876119877119878119879119880119881119882119883119884119885119886119887119888119889119890119891119892119893119894119895119896119897119898119899119900119901119902119903119904119905119906119907119908119909119910119911119912119913119914119915119916119917119918119919119920119921119922119923119924119925119926119927119928119929119930119931119932119933119934119935119936119937119938119939119940119941119942119943119944119945119946119947119948119949119950119951119952119953119954119955119956119957119958119959119960119961119962119963119964119965119966119967119968119969119970119971119972119973119974119975119976119977119978119979119980119981119982119983119984119985119986119987119988119989119990119991119992119993119994119995119996119997119998119999120000120001120002120003120004120005120006120007120008120009120010120011120012120013120014120015120016120017120018120019120020120021120022120023120024120025120026120027120028120029120030120031120032120033120034120035120036120037120038120039120040120041120042120043120044120045120046120047120048120049120050120051120052120053120054120055120056120057120058120059120060120061120062120063120064120065120066120067120068120069120070120071120072120073120074120075120076120077120078120079120080120081120082120083120084120085120086120087120088120089120090120091120092120093120094120095120096120097120098120099120100120101120102120103120104120105120106120107120108120109120110120111120112120113120114120115120116120117120118120119120120120121120122120123120124120125120126120127120128120129120130120131120132120133120134120135120136120137120138120139120140120141120142120143120144120145120146120147120148120149120150120151120152120153120154120155120156120157120158120159120160120161120162120163120164120165120166120167120168120169120170120171120172120173120174120175120176120177120178120179120180120181120182120183120184120185120186120187120188120189120190120191120192120193120194120195120196120197120198120199120200120201120202120203120204120205120206120207120208120209120210120211120212120213120214120215120216120217120218120219120220120221120222120223120224120225120226120227120228120229120230120231120232120233120234120235120236120237120238120239120240120241120242120243120244120245120246120247120248120249120250120251120252120253120254120255120256120257120258120259120260120261120262120263120264120265120266120267120268120269120270120271120272120273120274120275120276120277120278120279120280120281120282120283120284120285120286120287120288120289120290120291120292120293120294120295120296120297120298120299120300120301120302120303120304120305120306120307120308120309120310120311120312120313120314120315120316120317120318120319120320120321120322120323120324120325120326120327120328120329120330120331120332120333120334120335120336120337120338120339120340120341120342120343120344120345120346120347120348120349120350120351120352120353120354120355120356120357120358120359120360120361120362120363120364120365120366120367120368120369120370120371120372120373120374120375120376120377120378120379120380120381120382120383120384120385120386120387120388120389120390120391120392120393120394120395120396120397120398120399120400120401120402120403120404120405120406120407120408120409120410120411120412120413120414120415120416120417120418120419120420120421120422120423120424120425120426120427120428120429120430120431120432120433120434120435120436120437120438120439120440120441120442120443120444120445120446120447120448120449120450120451120452120453120454120455120456120457120458120459120460120461120462120463120464120465120466120467120468120469120470120471120472120473120474120475120476120477120478120479120480120481120482120483120484120485120486120487120488120489120490120491120492120493120494120495120496120497120498120499120500120501120502120503120504120505120506120507120508120509120510120511120512120513120514120515120516120517120518120519120520120521120522120523120524120525120526120527120528120529120530120531120532120533120534120535120536120537120538120539120540120541120542120543120544120545120546120547120548120549120550120551120552120553120554120555120556120557120558120559120560120561120562120563120564120565120566120567120568120569120570120571120572120573120574120575120576120577120578120579120580120581120582120583120584120585120586120587120588120589120590120591120592120593120594120595120596120597120598120599120600120601120602120603120604120605120606120607120608120609120610120611120612120613120614120615120616120617120618120619120620120621120622120623120624120625120626120627120628120629120630120631120632120633120634120635120636120637120638120639120640120641120642120643120644120645120646120647120648120649120650120651120652120653120654120655120656120657120658120659120660120661120662120663120664120665120666120667120668120669120670120671120672120673120674120675120676120677120678120679120680120681120682120683120684120685120686120687120688120689120690120691120692120693120694120695120696120697120698120699120700120701120702120703120704120705120706120707120708120709120710120711120712120713120714120715120716120717120718120719120720120721120722120723120724120725120726120727120728120729120730120731120732120733120734120735120736120737120738120739120740120741120742120743120744120745120746120747120748120749120750120751120752120753120754120755120756120757120758120759120760120761120762120763120764120765120766120767120768120769120770120771120772120773120774120775120776120777120778120779120780120781120782120783120784120785120786120787120788120789120790120791120792120793120794120795120796120797120798120799120800120801120802120803120804120805120806120807120808120809120810120811120812120813120814120815120816120817120818120819120820120821120822120823120824120825120826120827120828120829120830120831120832120833120834120835120836120837120838120839120840120841120842120843120844120845120846120847120848120849120850120851120852120853120854120855120856120857120858120859120860120861120862120863120864120865120866120867120868120869120870120871120872120873120874120875120876120877120878120879120880120881120882120883120884120885120886120887120888120889120890120891120892120893120894120895120896120897120898120899120900120901120902120903120904120905120906120907120908120909120910120911120912120913120914120915120916120917120918120919120920120921120922120923120924120925120926120927120928120929120930120931120932120933120934120935120936120937120938120939120940120941120942120943120944120945120946120947120948120949120950120951120952120953120954120955120956120957120958120959120960120961120962120963120964120965120966120967120968120969120970120971120972120973120974120975120976120977120978120979120980120981120982120983120984120985120986120987120988120989120990120991120992120993120994120995120996120997120998120999121000121001121002121003121004121005121006121007121008121009121010121011121012121013121014121015121016121017121018121019121020121021121022121023121024121025121026121027121028121029121030121031121032121033121034121035121036121037121038121039121040121041121042121043121044121045121046121047121048121049121050121051121052121053121054121055121056121057121058121059121060121061121062121063121064121065121066121067121068121069121070121071121072121073121074121075121076121077121078121079121080121081121082121083121084121085121086121087121088121089121090121091121092121093121094121095121096121097121098121099121100121101121102121103121104121105121106121107121108121109121110121111121112121113121114121115121116121117121118121119121120121121121122121123121124121125121126121127121128121129121130121131121132121133121134121135121136121137121138121139121140121141121142121143121144121145121146121147121148121149121150121151121152121153121154121155121156121157121158121159121160121161121162121163121164121165121166121167121168121169121170121171121172121173121174121175121176121177121178121179121180121181121182121183121184121185121186121187121188121189121190121191121192121193121194121195121196121197121198121199121200121201121202121203121204121205121206121207121208121209121210121211121212121213121214121215121216121217121218121219121220121221121222121223121224121225121226121227121228121229121230121231121232121233121234121235121236121237121238121239121240121241121242121243121244121245121246121247121248121249121250121251121252121253121254121255121256121257121258121259121260121261121262121263121264121265121266121267121268121269121270121271121272121273121274121275121276121277121278121279121280121281121282121283121284121285121286121287121288121289121290121291121292121293121294121295121296121297121298121299121300121301121302121303121304121305121306121307121308121309121310121311121312121313121314121315121316121317121318121319121320121321121322121323121324121325121326121327121328121329121330121331121332121333121334121335121336121337121338121339121340121341121342121343121344121345121346121347121348121349121350121351121352121353121354121355121356121357121358121359121360121361121362121363121364121365121366121367121368121369121370121371121372121373121374121375121376121377121378121379121380121381121382121383121384121385121386121387121388121389121390121391121392121393121394121395121396121397121398121399121400121401121402121403121404121405121406121407121408121409121410121411121412121413121414121415121416121417121418121419121420121421121422121423121424121425121426121427121428121429121430121431121432121433121434121435121436121437121438121439121440121441121442121443121444121445121446121447121448121449121450121451121452121453121454121455121456121457121458121459121460121461121462121463121464121465121466121467121468121469121470121471121472121473121474121475121476121477121478121479121480121481121482121483121484121485121486121487121488121489121490121491121492121493121494121495121496121497121498121499121500121501121502121503121504121505121506121507121508121509121510121511121512121513121514121515121516121517121518121519121520121521121522121523121524121525121526121527121528121529121530121531121532121533121534121535121536121537121538121539121540121541121542121543121544121545121546121547121548121549121550121551121552121553121554121555121556121557121558121559121560121561121562121563121564121565121566121567121568121569121570121571121572121573121574121575121576121577121578121579121580121581121582121583121584121585121586121587121588121589121590121591121592121593121594121595121596121597121598121599121600121601121602121603121604121605121606121607121608121609121610121611121612121613121614121615121616121617121618121619121620121621121622121623121624121625121626121627121628121629121630121631121632121633121634121635121636121637121638121639121640121641121642121643121644121645121646121647121648121649121650121651121652121653121654121655121656121657121658121659121660121661121662121663121664121665121666121667121668121669121670121671121672121673121674121675121676121677121678121679121680121681121682121683121684121685121686121687121688121689121690121691121692121693121694121695121696121697121698121699121700121701121702121703121704121705121706121707121708121709121710121711121712121713121714121715121716121717121718121719121720121721121722121723121724121725121726121727121728121729121730121731121732121733121734121735121736121737121738121739121740121741121742121743121744121745121746121747121748121749121750121751121752121753121754121755121756121757121758121759121760121761121762121763121764121765121766121767121768121769121770121771121772121773121774121775121776121777121778121779121780121781121782121783121784121785121786121787121788121789121790121791121792121793121794121795121796121797121798121799121800121801121802121803121804121805121806121807121808121809121810121811121812121813121814121815121816121817121818121819121820121821121822121823121824121825121826121827121828121829121830121831121832121833121834121835121836121837121838121839121840121841121842121843121844121845121846121847121848121849121850121851121852121853121854121855121856121857121858121859121860121861121862121863121864121865121866121867121868121869121870121871121872121873121874121875121876121877121878121879121880121881121882121883121884121885121886121887121888121889121890121891121892121893121894121895121896121897121898121899121900121901121902121903121904121905121906121907121908121909121910121911121912121913121914121915121916121917121918121919121920121921121922121923121924121925121926121927121928121929121930121931121932121933121934121935121936121937121938121939121940121941121942121943121944121945121946121947121948121949121950121951121952121953121954121955121956121957121958121959121960121961121962121963121964121965121966121967121968121969121970121971121972121973121974121975121976121977121978121979121980121981121982121983121984121985121986121987121988121989121990121991121992121993121994121995121996121997121998121999122000122001122002122003122004122005122006122007122008122009122010122011122012122013122014122015122016122017122018122019122020122021122022122023122024122025122026122027122028122029122030122031122032122033122034122035122036122037122038122039122040122041122042122043122044122045122046122047122048122049122050122051122052122053122054122055122056122057122058122059122060122061122062122063122064122065122066122067122068122069122070122071122072122073122074122075122076122077122078122079122080122081122082122083122084122085122086122087122088122089122090122091122092122093122094122095122096122097122098122099122100122101122102122103122104122105122106122107122108122109122110122111122112122113122114122115122116122117122118122119122120122121122122122123122124122125122126122127122128122129122130122131122132122133122134122135122136122137122138122139122140122141122142122143122144122145122146122147122148122149122150122151122152122153122154122155122156122157122158122159122160122161122162122163122164122165122166122167122168122169122170122171122172122173122174122175122176122177122178122179122180122181122182122183122184122185122186122187122188122189122190122191122192122193122194122195122196122197122198122199122200122201122202122203122204122205122206122207122208122209122210122211122212122213122214122215122216122217122218122219122220122221122222122223122224122225122226122227122228122229122230122231122232122233122234122235122236122237122238122239122240122241122242122243122244122245122246122247122248122249122250122251122252122253122254122255122256122257122258122259122260122261122262122263122264122265122266122267122268122269122270122271122272122273122274122275122276122277122278122279122280122281122282122283122284122285122286122287122288122289122290122291122292122293122294122295122296122297122298122299122300122301122302122303122304122305122306122307122308122309122310122311122312122313122314122315122316122317122318122319122320122321122322122323122324122325122326122327122328122329122330122331122332122333122334122335122336122337122338122339122340122341122342122343122344122345122346122347122348122349122350122351122352122353122354122355122356122357122358122359122360122361122362122363122364122365122366122367122368122369122370122371122372122373122374122375122376122377122378122379122380122381122382122383122384122385122386122387122388122389122390122391122392122393122394122395122396122397122398122399122400122401122402122403122404122405122406122407122408122409122410122411122412122413122414122415122416122417122418122419122420122421122422122423122424122425122426122427122428122429122430122431122432122433122434122435122436122437122438122439122440122441122442122443122444122445122446122447122448122449122450122451122452122453122454122455122456122457122458122459122460122461122462122463122464122465122466122467122468122469122470122471122472122473122474122475122476122477122478122479122480122481122482122483122484122485122486122487122488122489122490122491122492122493122494122495122496122497122498122499122500122501122502122503122504122505122506122507122508122509122510122511122512122513122514122515122516122517122518122519122520122521122522122523122524122525122526122527122528122529122530122531122532122533122534122535122536122537122538122539122540122541122542122543122544122545122546122547122548122549122550122551122552122553122554122555122556122557122558122559122560122561122562122563122564122565122566122567122568122569122570122571122572122573122574122575122576122577122578122579122580122581122582122583122584122585122586122587122588122589122590122591122592122593122594122595122596122597122598122599122600122601122602122603122604122605122606122607122608122609122610122611122612122613122614122615122616122617122618122619122620122621122622122623122624122625122626122627122628122629122630122631122632122633122634122635122636122637122638122639122640122641122642122643122644122645122646122647122648122649122650122651122652122653122654122655122656122657122658122659122660122661122662122663122664122665122666122667122668122669122670122671122672122673122674122675122676122677122678122679122680122681122682122683122684122685122686122687122688122689122690122691122692122693122694122695122696122697122698122699122700122701122702122703122704122705122706122707122708122709122710122711122712122713122714122715122716122717122718122719122720122721122722122723122724122725122726122727122728122729122730122731122732122733122734122735122736122737122738122739122740122741122742122743122744122745122746122747122748122749122750122751122752122753122754122755122756122757122758122759122760122761122762122763122764122765122766122767122768122769122770122771122772122773122774122775122776122777122778122779122780122781122782122783122784122785122786122787122788122789122790122791122792122793122794122795122796122797122798122799122800122801122802122803122804122805122806122807122808122809122810122811122812122813122814122815122816122817122818122819122820122821122822122823122824122825122826122827122828122829122830122831122832122833122834122835122836122837122838122839122840122841122842122843122844122845122846122847122848122849122850122851122852122853122854122855122856122857122858122859122860122861122862122863122864122865122866122867122868122869122870122871122872122873122874122875122876122877122878122879122880122881122882122883122884122885122886122887122888122889122890122891122892122893122894122895122896122897122898122899122900122901122902122903122904122905122906122907122908122909122910122911122912122913122914122915122916122917122918122919122920122921122922122923122924122925122926122927122928122929122930122931122932122933122934122935122936122937122938122939122940122941122942122943122944122945122946122947122948122949122950122951122952122953122954122955122956122957122958122959122960122961122962122963122964122965122966122967122968122969122970122971122972122973122974122975122976122977122978122979122980122981122982122983122984122985122986122987122988122989122990122991122992122993122994122995122996122997122998122999123000123001123002123003123004123005123006123007123008123009123010123011123012123013123014123015123016123017123018123019123020123021123022123023123024123025123026123027123028123029123030123031123032123033123034123035123036123037123038123039123040123041123042123043123044123045123046123047123048123049123050123051123052123053123054123055123056123057123058123059123060123061123062123063123064123065123066123067123068123069123070123071123072123073123074123075123076123077123078123079123080123081123082123083123084123085123086123087123088123089123090123091123092123093123094123095123096123097123098123099123100123101123102123103123104123105123106123107123108123109123110123111123112123113123114123115123116123117123118123119123120123121123122123123123124123125123126123127123128123129123130123131123132123133123134123135123136123137123138123139123140123141123142123143123144123145123146123147123148123149123150123151123152123153123154123155123156123157123158123159123160123161123162123163123164123165123166123167123168123169123170123171123172123173123174123175123176123177123178123179123180123181123182123183123184123185123186123187123188123189123190123191123192123193123194123195123196123197123198123199123200123201123202123203123204123205123206123207123208123209123210123211123212123213123214123215123216123217123218123219123220123221123222123223123224123225123226123227123228123229123230123231123232123233123234123235123236123237123238123239123240123241123242123243123244123245123246123247123248123249123250123251123252123253123254123255123256123257123258123259123260123261123262123263123264123265123266123267123268123269123270123271123272123273123274123275123276123277123278123279123280123281123282123283123284123285123286123287123288123289123290123291123292123293123294123295123296123297123298123299123300123301123302123303123304123305123306123307123308123309123310123311123312123313123314123315123316123317123318123319123320123321123322123323123324123325123326123327123328123329123330123331123332123333123334123335123336123337123338123339123340123341123342123343123344123345123346123347123348123349123350123351123352123353123354123355123356123357123358123359123360123361123362123363123364123365123366123367123368123369123370123371123372123373123374123375123376123377123378123379123380123381123382123383123384123385123386123387123388123389123390123391123392123393123394123395123396123397123398123399123400123401123402123403123404123405123406123407123408123409123410123411123412123413123414123415123416123417123418123419123420123421123422123423123424123425123426123427123428123429123430123431123432123433123434123435123436123437123438123439123440123441123442123443123444123445123446123447123448123449123450123451123452123453123454123455123456123457123458123459123460123461123462123463123464123465123466123467123468123469123470123471123472123473123474123475123476123477123478123479123480123481123482123483123484123485123486123487123488123489123490123491123492123493123494123495123496123497123498123499123500123501123502123503123504123505123506123507123508123509123510123511123512123513123514123515123516123517123518123519123520123521123522123523123524123525123526123527123528123529123530123531123532123533123534123535123536123537123538123539123540123541123542123543123544123545123546123547123548123549123550123551123552123553123554123555123556123557123558123559123560123561123562123563123564123565123566123567123568123569123570123571123572123573123574123575123576123577123578123579123580123581123582123583123584123585123586123587123588123589123590123591123592123593123594123595123596123597123598123599123600123601123602123603123604123605123606123607123608123609123610123611123612123613123614123615123616123617123618123619123620123621123622123623123624123625123626123627123628123629123630123631123632123633123634123635123636123637123638123639123640123641123642123643123644123645123646123647123648123649123650123651123652123653123654123655123656123657123658123659123660123661123662123663123664123665123666123667123668123669123670123671123672123673123674123675123676123677123678123679123680123681123682123683123684123685123686123687123688123689123690123691123692123693123694123695123696123697123698123699123700123701123702123703123704123705123706123707123708123709123710123711123712123713123714123715123716123717123718123719123720123721123722123723123724123725123726123727123728123729123730123731123732123733123734123735123736123737123738123739123740123741123742123743123744123745123746123747123748123749123750123751123752123753123754123755123756123757123758123759123760123761123762123763123764123765123766123767123768123769123770123771123772123773123774123775123776123777123778123779123780123781123782123783123784123785123786123787123788123789123790123791123792123793123794123795123796123797123798123799123800123801123802123803123804123805123806123807123808123809123810123811123812123813123814123815123816123817123818123819123820123821123822123823123824123825123826123827123828123829123830123831123832123833123834123835123836123837123838123839123840123841123842123843123844123845123846123847123848123849123850123851123852123853123854123855123856123857123858123859123860123861123862123863123864123865123866123867123868123869123870123871123872123873123874123875123876123877123878123879123880123881123882123883123884123885123886123887123888123889123890123891123892123893123894123895123896123897123898123899123900123901123902123903123904123905123906123907123908123909123910123911123912123913123914123915123916123917123918123919123920123921123922123923123924123925123926123927123928123929123930123931123932123933123934123935123936123937123938123939123940123941123942123943123944123945123946123947123948123949123950123951123952123953123954123955123956123957123958123959123960123961123962123963123964123965123966123967123968123969123970123971123972123973123974123975123976123977123978123979123980123981123982123983123984123985123986123987123988123989123990123991123992123993123994123995123996123997123998123999124000124001124002124003124004124005124006124007124008124009124010124011124012124013124014124015124016124017124018124019124020124021124022124023124024124025124026124027124028124029124030124031124032124033124034124035124036124037124038124039124040124041124042124043124044124045124046124047124048124049124050124051124052124053124054124055124056124057124058124059124060124061124062124063124064124065124066124067124068124069124070124071124072124073124074124075124076124077124078124079124080124081124082124083124084124085124086124087124088124089124090124091124092124093124094124095124096124097124098124099124100124101124102124103124104124105124106124107124108124109124110124111124112124113124114124115124116124117124118124119124120124121124122124123124124124125124126124127124128124129124130124131124132124133124134124135124136124137124138124139124140124141124142124143124144124145124146124147124148124149124150124151124152124153124154124155124156124157124158124159124160124161124162124163124164124165124166124167124168124169124170124171124172124173124174124175124176124177124178124179124180124181124182124183124184124185124186124187124188124189124190124191124192124193124194124195124196124197124198124199124200124201124202124203124204124205124206124207124208124209124210124211124212124213124214124215124216124217124218124219124220124221124222124223124224124225124226124227124228124229124230124231124232124233124234124235124236124237124238124239124240124241124242124243124244124245124246124247124248124249124250124251124252124253124254124255124256124257124258124259124260124261124262124263124264124265124266124267124268124269124270124271124272124273124274124275124276124277124278124279124280124281124282124283124284124285124286124287124288124289124290124291124292124293124294124295124296124297124298124299124300124301124302124303124304124305124306124307124308124309124310124311124312124313124314124315124316124317124318124319124320124321124322124323124324124325124326124327124328124329124330124331124332124333124334124335124336124337124338124339124340124341124342124343124344124345124346124347124348124349124350124351124352124353124354124355124356124357124358124359124360124361124362124363124364124365124366124367124368124369124370124371124372124373124374124375124376124377124378124379124380124381124382124383124384124385124386124387124388124389124390124391124392124393124394124395124396124397124398124399124400124401124402124403124404124405124406124407124408124409124410124411124412124413124414124415124416124417124418124419124420124421124422124423124424124425124426124427124428124429124430124431124432124433124434124435124436124437124438124439124440124441124442124443124444124445124446124447124448124449124450124451124452124453124454124455124456124457124458124459124460124461124462124463124464124465124466124467124468124469124470124471124472124473124474124475124476124477124478124479124480124481124482124483124484124485124486124487124488124489124490124491124492124493124494124495124496124497124498124499124500124501124502124503124504124505124506124507124508124509124510124511124512124513124514124515124516124517124518124519124520124521124522124523124524124525124526124527124528124529124530124531124532124533124534124535124536124537124538124539124540124541124542124543124544124545124546124547124548124549124550124551124552124553124554124555124556124557124558124559124560124561124562124563124564124565124566124567124568124569124570124571124572124573124574124575124576124577124578124579124580124581124582124583124584124585124586124587124588124589124590124591124592124593124594124595124596124597124598124599124600124601124602124603124604124605124606124607124608124609124610124611124612124613124614124615124616124617124618124619124620124621124622124623124624124625124626124627124628124629124630124631124632124633124634124635124636124637124638124639124640124641124642124643124644124645124646124647124648124649124650124651124652124653124654124655124656124657124658124659124660124661124662124663124664124665124666124667124668124669124670124671124672124673124674124675124676124677124678124679124680124681124682124683124684124685124686124687124688124689124690124691124692124693124694124695124696124697124698124699124700124701124702124703124704124705124706124707124708124709124710124711124712124713124714124715124716124717124718124719124720124721124722124723124724124725124726124727124728124729124730124731124732124733124734124735124736124737124738124739124740124741124742124743124744124745124746124747124748124749124750124751124752124753124754124755124756124757124758124759124760124761124762124763124764124765124766124767124768124769124770124771124772124773124774124775124776124777124778124779124780124781124782124783124784124785124786124787124788124789124790124791124792124793124794124795124796124797124798124799124800124801124802124803124804124805124806124807124808124809124810124811124812124813124814124815124816124817124818124819124820124821124822124823124824124825124826124827124828124829124830124831124832124833124834124835124836124837124838124839124840124841124842124843124844124845124846124847124848124849124850124851124852124853124854124855124856124857124858124859124860124861124862124863124864124865124866124867124868124869124870124871124872124873124874124875124876124877124878124879124880124881124882124883124884124885124886124887124888124889124890124891124892124893124894124895124896124897124898124899124900124901124902124903124904124905124906124907124908124909124910124911124912124913124914124915124916124917124918124919124920124921124922124923124924124925124926124927124928124929124930124931124932124933124934124935124936124937124938124939124940124941124942124943124944124945124946124947124948124949124950124951124952124953124954124955124956124957124958124959124960124961124962124963124964124965124966124967124968124969124970124971124972124973124974124975124976124977124978124979124980124981124982124983124984124985124986124987124988124989124990124991124992124993124994124995124996124997124998124999125000125001125002125003125004125005125006125007125008125009125010125011125012125013125014125015125016125017125018125019125020125021125022125023125024125025125026125027125028125029125030125031125032125033125034125035125036125037125038125039125040125041125042125043125044125045125046125047125048125049125050125051125052125053125054125055125056125057125058125059125060125061125062125063125064125065125066125067125068125069125070125071125072125073125074125075125076125077125078125079125080125081125082125083125084125085125086125087125088125089125090125091125092125093125094125095125096125097125098125099125100125101125102125103125104125105125106125107125108125109125110125111125112125113125114125115125116125117125118125119125120125121125122125123125124125125125126125127125128125129125130125131125132125133125134125135125136125137125138125139125140125141125142125143125144125145125146125147125148125149125150125151125152125153125154125155125156125157125158125159125160125161125162125163125164125165125166125167125168125169125170125171125172125173125174125175125176125177125178125179125180125181125182125183125184125185125186125187125188125189125190125191125192125193125194125195125196125197125198125199125200125201125202125203125204125205125206125207125208125209125210125211125212125213125214125215125216125217125218125219125220125221125222125223125224125225125226125227125228125229125230125231125232125233125234125235125236125237125238125239125240125241125242125243125244125245125246125247125248125249125250125251125252125253125254125255125256125257125258125259125260125261125262125263125264125265125266125267125268125269125270125271125272125273125274125275125276125277125278125279125280125281125282125283125284125285125286125287125288125289125290125291125292125293125294125295125296125297125298125299125300125301125302125303125304125305125306125307125308125309125310125311125312125313125314125315125316125317125318125319125320125321125322125323125324125325125326125327125328125329125330125331125332125333125334125335125336125337125338125339125340125341125342125343125344125345125346125347125348125349125350125351125352125353125354125355125356125357125358125359125360125361125362125363125364125365125366125367125368125369125370125371125372125373125374125375125376125377125378125379125380125381125382125383125384125385125386125387125388125389125390125391125392125393125394125395125396125397125398125399125400125401125402125403125404125405125406125407125408125409125410125411125412125413125414125415125416125417125418125419125420125421125422125423125424125425125426125427125428125429125430125431125432125433125434125435125436125437125438125439125440125441125442125443125444125445125446125447125448125449125450125451125452125453125454125455125456125457125458125459125460125461125462125463125464125465125466125467125468125469125470125471125472125473125474125475125476125477125478125479125480125481125482125483125484125485125486125487125488125489125490125491125492125493125494125495125496125497125498125499125500125501125502125503125504125505125506125507125508125509125510125511125512125513125514125515125516125517125518125519125520125521125522125523125524125525125526125527125528125529125530125531125532125533125534125535125536125537125538125539125540125541125542125543125544125545125546125547125548125549125550125551125552125553125554125555125556125557125558125559125560125561125562125563125564125565125566125567125568125569125570125571125572125573125574125575125576125577125578125579125580125581125582125583125584125585125586125587125588125589125590125591125592125593125594125595125596125597125598125599125600125601125602125603125604125605125606125607125608125609125610125611125612125613125614125615125616125617125618125619125620125621125622125623125624125625125626125627125628125629125630125631125632125633125634125635125636125637125638125639125640125641125642125643125644125645125646125647125648125649125650125651125652125653125654125655125656125657125658125659125660125661125662125663125664125665125666125667125668125669125670125671125672125673125674125675125676125677125678125679125680125681125682125683125684125685125686125687125688125689125690125691125692125693125694125695125696125697125698125699125700125701125702125703125704125705125706125707125708125709125710125711125712125713125714125715125716125717125718125719125720125721125722125723125724125725125726125727125728125729125730125731125732125733125734125735125736125737125738125739125740125741125742125743125744125745125746125747125748125749125750125751125752125753125754125755125756125757125758125759125760125761125762125763125764125765125766125767125768125769125770125771125772125773125774125775125776125777125778125779125780125781125782125783125784125785125786125787125788125789125790125791125792125793125794125795125796125797125798125799125800125801125802125803125804125805125806125807125808125809125810125811125812125813125814125815125816125817125818125819125820125821125822125823125824125825125826125827125828125829125830125831125832125833125834125835125836125837125838125839125840125841125842125843125844125845125846125847125848125849125850125851125852125853125854125855125856125857125858125859125860125861125862125863125864125865125866125867125868125869125870125871125872125873125874125875125876125877125878125879125880125881125882125883125884125885125886125887125888125889125890125891125892125893125894125895125896125897125898125899125900125901125902125903125904125905125906125907125908125909125910125911125912125913125914125915125916125917125918125919125920125921125922125923125924125925125926125927125928125929125930125931125932125933125934125935125936125937125938125939125940125941125942125943125944125945125946125947125948125949125950125951125952125953125954125955125956125957125958125959125960125961125962125963125964125965125966125967125968125969125970125971125972125973125974125975125976125977125978125979125980125981125982125983125984125985125986125987125988125989125990125991125992125993125994125995125996125997125998125999126000126001126002126003126004126005126006126007126008126009126010126011126012126013126014126015126016126017126018126019126020126021126022126023126024126025126026126027126028126029126030126031126032126033126034126035126036126037126038126039126040126041126042126043126044126045126046126047126048126049126050126051126052126053126054126055126056126057126058126059126060126061126062126063126064126065126066126067126068126069126070126071126072126073126074126075126076126077126078126079126080126081126082126083126084126085126086126087126088126089126090126091126092126093126094126095126096126097126098126099126100126101126102126103126104126105126106126107126108126109126110126111126112126113126114126115126116126117126118126119126120126121126122126123126124126125126126126127126128126129126130126131126132126133126134126135126136126137126138126139126140126141126142126143126144126145126146126147126148126149126150126151126152126153126154126155126156126157126158126159126160126161126162126163126164126165126166126167126168126169126170126171126172126173126174126175126176126177126178126179126180126181126182126183126184126185126186126187126188126189126190126191126192126193126194126195126196126197126198126199126200126201126202126203126204126205126206126207126208126209126210126211126212126213126214126215126216126217126218126219126220126221126222126223126224126225126226126227126228126229126230126231126232126233126234126235126236126237126238126239126240126241126242126243126244126245126246126247126248126249126250126251126252126253126254126255126256126257126258126259126260126261126262126263126264126265126266126267126268126269126270126271126272126273126274126275126276126277126278126279126280126281126282126283126284126285126286126287126288126289126290126291126292126293126294126295126296126297126298126299126300126301126302126303126304126305126306126307126308126309126310126311126312126313126314126315126316126317126318126319126320126321126322126323126324126325126326126327126328126329126330126331126332126333126334126335126336126337126338126339126340126341126342126343126344126345126346126347126348126349126350126351126352126353126354126355126356126357126358126359126360126361126362126363126364126365126366126367126368126369126370126371126372126373126374126375126376126377126378126379126380126381126382126383126384126385126386126387126388126389126390126391126392126393126394126395126396126397126398126399126400126401126402126403126404126405126406126407126408126409126410126411126412126413126414126415126416126417126418126419126420126421126422126423126424126425126426126427126428126429126430126431126432126433126434126435126436126437126438126439126440126441126442126443126444126445126446126447126448126449126450126451126452126453126454126455126456126457126458126459126460126461126462126463126464126465126466126467126468126469126470126471126472126473126474126475126476126477126478126479126480126481126482126483126484126485126486126487126488126489126490126491126492126493126494126495126496126497126498126499126500126501126502126503126504126505126506126507126508126509126510126511126512126513126514126515126516126517126518126519126520126521126522126523126524126525126526126527126528126529126530126531126532126533126534126535126536126537126538126539126540126541126542126543126544126545126546126547126548126549126550126551126552126553126554126555126556126557126558126559126560126561126562126563126564126565126566126567126568126569126570126571126572126573126574126575126576126577126578126579126580126581126582126583126584126585126586126587126588126589126590126591126592126593126594126595126596126597126598126599126600126601126602126603126604126605126606126607126608126609126610126611126612126613126614126615126616126617126618126619126620126621126622126623126624126625126626126627126628126629126630126631126632126633126634126635126636126637126638126639126640126641126642126643126644126645126646126647126648126649126650126651126652126653126654126655126656126657126658126659126660126661126662126663126664126665126666126667126668126669126670126671126672126673126674126675126676126677126678126679126680126681126682126683126684126685126686126687126688126689126690126691126692126693126694126695126696126697126698126699126700126701126702126703126704126705126706126707126708126709126710126711126712126713126714126715126716126717126718126719126720126721126722126723126724126725126726126727126728126729126730126731126732126733126734126735126736126737126738126739126740126741126742126743126744126745126746126747126748126749126750126751126752126753126754126755126756126757126758126759126760126761126762126763126764126765126766126767126768126769126770126771126772126773126774126775126776126777126778126779126780126781126782126783126784126785126786126787126788126789126790126791126792126793126794126795126796126797126798126799126800126801126802126803126804126805126806126807126808126809126810126811126812126813126814126815126816126817126818126819126820126821126822126823126824126825126826126827126828126829126830126831126832126833126834126835126836126837126838126839126840126841126842126843126844126845126846126847126848126849126850126851126852126853126854126855126856126857126858126859126860126861126862126863126864126865126866126867126868126869126870126871126872126873126874126875126876126877126878126879126880126881126882126883126884126885126886126887126888126889126890126891126892126893126894126895126896126897126898126899126900126901126902126903126904126905126906126907126908126909126910126911126912126913126914126915126916126917126918126919126920126921126922126923126924126925126926126927126928126929126930126931126932126933126934126935126936126937126938126939126940126941126942126943126944126945126946126947126948126949126950126951126952126953126954126955126956126957126958126959126960126961126962126963126964126965126966126967126968126969126970126971126972126973126974126975126976126977126978126979126980126981126982126983126984126985126986126987126988126989126990126991126992126993126994126995126996126997126998126999127000127001127002127003127004127005127006127007127008127009127010127011127012127013127014127015127016127017127018127019127020127021127022127023127024127025127026127027127028127029127030127031127032127033127034127035127036127037127038127039127040127041127042127043127044127045127046127047127048127049127050127051127052127053127054127055127056127057127058127059127060127061127062127063127064127065127066127067127068127069127070127071127072127073127074127075127076127077127078127079127080127081127082127083127084127085127086127087127088127089127090127091127092127093127094127095127096127097127098127099127100127101127102127103127104127105127106127107127108127109127110127111127112127113127114127115127116127117127118127119127120127121127122127123127124127125127126127127127128127129127130127131127132127133127134127135127136127137127138127139127140127141127142127143127144127145127146127147127148127149127150127151127152127153127154127155127156127157127158127159127160127161127162127163127164127165127166127167127168127169127170127171127172127173127174127175127176127177127178127179127180127181127182127183127184127185127186127187127188127189127190127191127192127193127194127195127196127197127198127199127200127201127202127203127204127205127206127207127208127209127210127211127212127213127214127215127216127217127218127219127220127221127222127223127224127225127226127227127228127229127230127231127232127233127234127235127236127237127238127239127240127241127242127243127244127245127246127247127248127249127250127251127252127253127254127255127256127257127258127259127260127261127262127263127264127265127266127267127268127269127270127271127272127273127274127275127276127277127278127279127280127281127282127283127284127285127286127287127288127289127290127291127292127293127294127295127296127297127298127299127300127301127302127303127304127305127306127307127308127309127310127311127312127313127314127315127316127317127318127319127320127321127322127323127324127325127326127327127328127329127330127331127332127333127334127335127336127337127338127339127340127341127342127343127344127345127346127347127348127349127350127351127352127353127354127355127356127357127358127359127360127361127362127363127364127365127366127367127368127369127370127371127372127373127374127375127376127377127378127379127380127381127382127383127384127385127386127387127388127389127390127391127392127393127394127395127396127397127398127399127400127401127402127403127404127405127406127407127408127409127410127411127412127413127414127415127416127417127418127419127420127421127422127423127424127425127426127427127428127429127430127431127432127433127434127435127436127437127438127439127440127441127442127443127444127445127446127447127448127449127450127451127452127453127454127455127456127457127458127459127460127461127462127463127464127465127466127467127468127469127470127471127472127473127474127475127476127477127478127479127480127481127482127483127484127485127486127487127488127489127490127491127492127493127494127495127496127497127498127499127500127501127502127503127504127505127506127507127508127509127510127511127512127513127514127515127516127517127518127519127520127521127522127523127524127525127526127527127528127529127530127531127532127533127534127535127536127537127538127539127540127541127542127543127544127545127546127547127548127549127550127551127552127553127554127555127556127557127558127559127560127561127562127563127564127565127566127567127568127569127570127571127572127573127574127575127576127577127578127579127580127581127582127583127584127585127586127587127588127589127590127591127592127593127594127595127596127597127598127599127600127601127602127603127604127605127606127607127608127609127610127611127612127613127614127615127616127617127618127619127620127621127622127623127624127625127626127627127628127629127630127631127632127633127634127635127636127637127638127639127640127641127642127643127644127645127646127647127648127649127650127651127652127653127654127655127656127657127658127659127660127661127662127663127664127665127666127667127668127669127670127671127672127673127674127675127676127677127678127679127680127681127682127683127684127685127686127687127688127689127690127691127692127693127694127695127696127697127698127699127700127701127702127703127704127705127706127707127708127709127710127711127712127713127714127715127716127717127718127719127720127721127722127723127724127725127726127727127728127729127730127731127732127733127734127735127736127737127738127739127740127741127742127743127744127745127746127747127748127749127750127751127752127753127754127755127756127757127758127759127760127761127762127763127764127765127766127767127768127769127770127771127772127773127774127775127776127777127778127779127780127781127782127783127784127785127786127787127788127789127790127791127792127793127794127795127796127797127798127799127800127801127802127803127804127805127806127807127808127809127810127811127812127813127814127815127816127817127818127819127820127821127822127823127824127825127826127827127828127829127830127831127832127833127834127835127836127837127838127839127840127841127842127843127844127845127846127847127848127849127850127851127852127853127854127855127856127857127858127859127860127861127862127863127864127865127866127867127868127869127870127871127872127873127874127875127876127877127878127879127880127881127882127883127884127885127886127887127888127889127890127891127892127893127894127895127896127897127898127899127900127901127902127903127904127905127906127907127908127909127910127911127912127913127914127915127916127917127918127919127920127921127922127923127924127925127926127927127928127929127930127931127932127933127934127935127936127937127938127939127940127941127942127943127944127945127946127947127948127949127950127951127952127953127954127955127956127957127958127959127960127961127962127963127964127965127966127967127968127969127970127971127972127973127974127975127976127977127978127979127980127981127982127983127984127985127986127987127988127989127990127991127992127993127994127995127996127997127998127999128000128001128002128003128004128005128006128007128008128009128010128011128012128013128014128015128016128017128018128019128020128021128022128023128024128025128026128027128028128029128030128031128032128033128034128035128036128037128038128039128040128041128042128043128044128045128046128047128048128049128050128051128052128053128054128055128056128057128058128059128060128061128062128063128064128065128066128067128068128069128070128071128072128073128074128075128076128077128078128079128080128081128082128083128084128085128086128087128088128089128090128091128092128093128094128095128096128097128098128099128100128101128102128103128104128105128106128107128108128109128110128111128112128113128114128115128116128117128118128119128120128121128122128123128124128125128126128127128128128129128130128131128132128133128134128135128136128137128138128139128140128141128142128143128144128145128146128147128148128149128150128151128152128153128154128155128156128157128158128159128160128161128162128163128164128165128166128167128168128169128170128171128172128173128174128175128176128177128178128179128180128181128182128183128184128185128186128187128188128189128190128191128192128193128194128195128196128197128198128199128200128201128202128203128204128205128206128207128208128209128210128211128212128213128214128215128216128217128218128219128220128221128222128223128224128225128226128227128228128229128230128231128232128233128234128235128236128237128238128239128240128241128242128243128244128245128246128247128248128249128250128251128252128253128254128255128256128257128258128259128260128261128262128263128264128265128266128267128268128269128270128271128272128273128274128275128276128277128278128279128280128281128282128283128284128285128286128287128288128289128290128291128292128293128294128295128296128297128298128299128300128301128302128303128304128305128306128307128308128309128310128311128312128313128314128315128316128317128318128319128320128321128322128323128324128325128326128327128328128329128330128331128332128333128334128335128336128337128338128339128340128341128342128343128344128345128346128347128348128349128350128351128352128353128354128355128356128357128358128359128360128361128362128363128364128365128366128367128368128369128370128371128372128373128374128375128376128377128378128379128380128381128382128383128384128385128386128387128388128389128390128391128392128393128394128395128396128397128398128399128400128401128402128403128404128405128406128407128408128409128410128411128412128413128414128415128416128417128418128419128420128421128422128423128424128425128426128427128428128429128430128431128432128433128434128435128436128437128438128439128440128441128442128443128444128445128446128447128448128449128450128451128452128453128454128455128456128457128458128459128460128461128462128463128464128465128466128467128468128469128470128471128472128473128474128475128476128477128478128479128480128481128482128483128484128485128486128487128488128489128490128491128492128493128494128495128496128497128498128499128500128501128502128503128504128505128506128507128508128509128510128511128512128513128514128515128516128517128518128519128520128521128522128523128524128525128526128527128528128529128530128531128532128533128534128535128536128537128538128539128540128541128542128543128544128545128546128547128548128549128550128551128552128553128554128555128556128557128558128559128560128561128562128563128564128565128566128567128568128569128570128571128572128573128574128575128576128577128578128579128580128581128582128583128584128585128586128587128588128589128590128591128592128593128594128595128596128597128598128599128600128601128602128603128604128605128606128607128608128609128610128611128612128613128614128615128616128617128618128619128620128621128622128623128624128625128626128627128628128629128630128631128632128633128634128635128636128637128638128639128640128641128642128643128644128645128646128647128648128649128650128651128652128653128654128655128656128657128658128659128660128661128662128663128664128665128666128667128668128669128670128671128672128673128674128675128676128677128678128679128680128681128682128683128684128685128686128687128688128689128690128691128692128693128694128695128696128697128698128699128700128701128702128703128704128705128706128707128708128709128710128711128712128713128714128715128716128717128718128719128720128721128722128723128724128725128726128727128728128729128730128731128732128733128734128735128736128737128738128739128740128741128742128743128744128745128746128747128748128749128750128751128752128753128754128755128756128757128758128759128760128761128762128763128764128765128766128767128768128769128770128771128772128773128774128775128776128777128778128779128780128781128782128783128784128785128786128787128788128789128790128791128792128793128794128795128796128797128798128799128800128801128802128803128804128805128806128807128808128809128810128811128812128813128814128815128816128817128818128819128820128821128822128823128824128825128826128827128828128829128830128831128832128833128834128835128836128837128838128839128840128841128842128843128844128845128846128847128848128849128850128851128852128853128854128855128856128857128858128859128860128861128862128863128864128865128866128867128868128869128870128871128872128873128874128875128876128877128878128879128880128881128882128883128884128885128886128887128888128889128890128891128892128893128894128895128896128897128898128899128900128901128902128903128904128905128906128907128908128909128910128911128912128913128914128915128916128917128918128919128920128921128922128923128924128925128926128927128928128929128930128931128932128933128934128935128936128937128938128939128940128941128942128943128944128945128946128947128948128949128950128951128952128953128954128955128956128957128958128959128960128961128962128963128964128965128966128967128968128969128970128971128972128973128974128975128976128977128978128979128980128981128982128983128984128985128986128987128988128989128990128991128992128993128994128995128996128997128998128999129000129001129002129003129004129005129006129007129008129009129010129011129012129013129014129015129016129017129018129019129020129021129022129023129024129025129026129027129028129029129030129031129032129033129034129035129036129037129038129039129040129041129042129043129044129045129046129047129048129049129050129051129052129053129054129055129056129057129058129059129060129061129062129063129064129065129066129067129068129069129070129071129072129073129074129075129076129077129078129079129080129081129082129083129084129085129086129087129088129089129090129091129092129093129094129095129096129097129098129099129100129101129102129103129104129105129106129107129108129109129110129111129112129113129114129115129116129117129118129119129120129121129122129123129124129125129126129127129128129129129130129131129132129133129134129135129136129137129138129139129140129141129142129143129144129145129146129147129148129149129150129151129152129153129154129155129156129157129158129159129160129161129162129163129164129165129166129167129168129169129170129171129172129173129174129175129176129177129178129179129180129181129182129183129184129185129186129187129188129189129190129191129192129193129194129195129196129197129198129199129200129201129202129203129204129205129206129207129208129209129210129211129212129213129214129215129216129217129218129219129220129221129222129223129224129225129226129227129228129229129230129231129232129233129234129235129236129237129238129239129240129241129242129243129244129245129246129247129248129249129250129251129252129253129254129255129256129257129258129259129260129261129262129263129264129265129266129267129268129269129270129271129272129273129274129275129276129277129278129279129280129281129282129283129284129285129286129287129288129289129290129291129292129293129294129295129296129297129298129299129300129301129302129303129304129305129306129307129308129309129310129311129312129313129314129315129316129317129318129319129320129321129322129323129324129325129326129327129328129329129330129331129332129333129334129335129336129337129338129339129340129341129342129343129344129345129346129347129348129349129350129351129352129353129354129355129356129357129358129359129360129361129362129363129364129365129366129367129368129369129370129371129372129373129374129375129376129377129378129379129380129381129382129383129384129385129386129387129388129389129390129391129392129393129394129395129396129397129398129399129400129401129402129403129404129405129406129407129408129409129410129411129412129413129414129415129416129417129418129419129420129421129422129423129424129425129426129427129428129429129430129431129432129433129434129435129436129437129438129439129440129441129442129443129444129445129446129447129448129449129450129451129452129453129454129455129456129457129458129459129460129461129462129463129464129465129466129467129468129469129470129471129472129473129474129475129476129477129478129479129480129481129482129483129484129485129486129487129488129489129490129491129492129493129494129495129496129497129498129499129500129501129502129503129504129505129506129507129508129509129510129511129512129513129514129515129516129517129518129519129520129521129522129523129524129525129526129527129528129529129530129531129532129533129534129535129536129537129538129539129540129541129542129543129544129545129546129547129548129549129550129551129552129553129554129555129556129557129558129559129560129561129562129563129564129565129566129567129568129569129570129571129572129573129574129575129576129577129578129579129580129581129582129583129584129585129586129587129588129589129590129591129592129593129594129595129596129597129598129599129600129601129602129603129604129605129606129607129608129609129610129611129612129613129614129615129616129617129618129619129620129621129622129623129624129625129626129627129628129629129630129631129632129633129634129635129636129637129638129639129640129641129642129643129644129645129646129647129648129649129650129651129652129653129654129655129656129657129658129659129660129661129662129663129664129665129666129667129668129669129670129671129672129673129674129675129676129677129678129679129680129681129682129683129684129685129686129687129688129689129690129691129692129693129694129695129696129697129698129699129700129701129702129703129704129705129706129707129708129709129710129711129712129713129714129715129716129717129718129719129720129721129722129723129724129725129726129727129728129729129730129731129732129733129734129735129736129737129738129739129740129741129742129743129744129745129746129747129748129749129750129751129752129753129754129755129756129757129758129759129760129761129762129763129764129765129766129767129768129769129770129771129772129773129774129775129776129777129778129779129780129781129782129783129784129785129786129787129788129789129790129791129792129793129794129795129796129797129798129799129800129801129802129803129804129805129806129807129808129809129810129811129812129813129814129815129816129817129818129819129820129821129822129823129824129825129826129827129828129829129830129831129832129833129834129835129836129837129838129839129840129841129842129843129844129845129846129847129848129849129850129851129852129853129854129855129856129857129858129859129860129861129862129863129864129865129866129867129868129869129870129871129872129873129874129875129876129877129878129879129880129881129882129883129884129885129886129887129888129889129890129891129892129893129894129895129896129897129898129899129900129901129902129903129904129905129906129907129908129909129910129911129912129913129914129915129916129917129918129919129920129921129922129923129924129925129926129927129928129929129930129931129932129933129934129935129936129937129938129939129940129941129942129943129944129945129946129947129948129949129950129951129952129953129954129955129956129957129958129959129960129961129962129963129964129965129966129967129968129969129970129971129972129973129974129975129976129977129978129979129980129981129982129983129984129985129986129987129988129989129990129991129992129993129994129995129996129997129998129999130000130001130002130003130004130005130006130007130008130009130010130011130012130013130014130015130016130017130018130019130020130021130022130023130024130025130026130027130028130029130030130031130032130033130034130035130036130037130038130039130040130041130042130043130044130045130046130047130048130049130050130051130052130053130054130055130056130057130058130059130060130061130062130063130064130065130066130067130068130069130070130071130072130073130074130075130076130077130078130079130080130081130082130083130084130085130086130087130088130089130090130091130092130093130094130095130096130097130098130099130100130101130102130103130104130105130106130107130108130109130110130111130112130113130114130115130116130117130118130119130120130121130122130123130124130125130126130127130128130129130130130131130132130133130134130135130136130137130138130139130140130141130142130143130144130145130146130147130148130149130150130151130152130153130154130155130156130157130158130159130160130161130162130163130164130165130166130167130168130169130170130171130172130173130174130175130176130177130178130179130180130181130182130183130184130185130186130187130188130189130190130191130192130193130194130195130196130197130198130199130200130201130202130203130204130205130206130207130208130209130210130211130212130213130214130215130216130217130218130219130220130221130222130223130224130225130226130227130228130229130230130231130232130233130234130235130236130237130238130239130240130241130242130243130244130245130246130247130248130249130250130251130252130253130254130255130256130257130258130259130260130261130262130263130264130265130266130267130268130269130270130271130272130273130274130275130276130277130278130279130280130281130282130283130284130285130286130287130288130289130290130291130292130293130294130295130296130297130298130299130300130301130302130303130304130305130306130307130308130309130310130311130312130313130314130315130316130317130318130319130320130321130322130323130324130325130326130327130328130329130330130331130332130333130334130335130336130337130338130339130340130341130342130343130344130345130346130347130348130349130350130351130352130353130354130355130356130357130358130359130360130361130362130363130364130365130366130367130368130369130370130371130372130373130374130375130376130377130378130379130380130381130382130383130384130385130386130387130388130389130390130391130392130393130394130395130396130397130398130399130400130401130402130403130404130405130406130407130408130409130410130411130412130413130414130415130416130417130418130419130420130421130422130423130424130425130426130427130428130429130430130431130432130433130434130435130436130437130438130439130440130441130442130443130444130445130446130447130448130449130450130451130452130453130454130455130456130457130458130459130460130461130462130463130464130465130466130467130468130469130470130471130472130473130474130475130476130477130478130479130480130481130482130483130484130485130486130487130488130489130490130491130492130493130494130495130496130497130498130499130500130501130502130503130504130505130506130507130508130509130510130511130512130513130514130515130516130517130518130519130520130521130522130523130524130525130526130527130528130529130530130531130532130533130534130535130536130537130538130539130540130541130542130543130544130545130546130547130548130549130550130551130552130553130554130555130556130557130558130559130560130561130562130563130564130565130566130567130568130569130570130571130572130573130574130575130576130577130578130579130580130581130582130583130584130585130586130587130588130589130590130591130592130593130594130595130596130597130598130599130600130601130602130603130604130605130606130607130608130609130610130611130612130613130614130615130616130617130618130619130620130621130622130623130624130625130626130627130628130629130630130631130632130633130634130635130636130637130638130639130640130641130642130643130644130645130646130647130648130649130650130651130652130653130654130655130656130657130658130659130660130661130662130663130664130665130666130667130668130669130670130671130672130673130674130675130676130677130678130679130680130681130682130683130684130685130686130687130688130689130690130691130692130693130694130695130696130697130698130699130700130701130702130703130704130705130706130707130708130709130710130711130712130713130714130715130716130717130718130719130720130721130722130723130724130725130726130727130728130729130730130731130732130733130734130735130736130737130738130739130740130741130742130743130744130745130746130747130748130749130750130751130752130753130754130755130756130757130758130759130760130761130762130763130764130765130766130767130768130769130770130771130772130773130774130775130776130777130778130779130780130781130782130783130784130785130786130787130788130789130790130791130792130793130794130795130796130797130798130799130800130801130802130803130804130805130806130807130808130809130810130811130812130813130814130815130816130817130818130819130820130821130822130823130824130825130826130827130828130829130830130831130832130833130834130835130836130837130838130839130840130841130842130843130844130845130846130847130848130849130850130851130852130853130854130855130856130857130858130859130860130861130862130863130864130865130866130867130868130869130870130871130872130873130874130875130876130877130878130879130880130881130882130883130884130885130886130887130888130889130890130891130892130893130894130895130896130897130898130899130900130901130902130903130904130905130906130907130908130909130910130911130912130913130914130915130916130917130918130919130920130921130922130923130924130925130926130927130928130929130930130931130932130933130934130935130936130937130938130939130940130941130942130943130944130945130946130947130948130949130950130951130952130953130954130955130956130957130958130959130960130961130962130963130964130965130966130967130968130969130970130971130972130973130974130975130976130977130978130979130980130981130982130983130984130985130986130987130988130989130990130991130992130993130994130995130996130997130998130999131000131001131002131003131004131005131006131007131008131009131010131011131012131013131014131015131016131017131018131019131020131021131022131023131024131025131026131027131028131029131030131031131032131033131034131035131036131037131038131039131040131041131042131043131044131045131046131047131048131049131050131051131052131053131054131055131056131057131058131059131060131061131062131063131064131065131066131067131068131069131070131071131072131073131074131075131076131077131078131079131080131081131082131083131084131085131086131087131088131089131090131091131092131093131094131095131096131097131098131099131100131101131102131103131104131105131106131107131108131109131110131111131112131113131114131115131116131117131118131119131120131121131122131123131124131125131126131127131128131129131130131131131132131133131134131135131136131137131138131139131140131141131142131143131144131145131146131147131148131149131150131151131152131153131154131155131156131157131158131159131160131161131162131163131164131165131166131167131168131169131170131171131172131173131174131175131176131177131178131179131180131181131182131183131184131185131186131187131188131189131190131191131192131193131194131195131196131197131198131199131200131201131202131203131204131205131206131207131208131209131210131211131212131213131214131215131216131217131218131219131220131221131222131223131224131225131226131227131228131229131230131231131232131233131234131235131236131237131238131239131240131241131242131243131244131245131246131247131248131249131250131251131252131253131254131255131256131257131258131259131260131261131262131263131264131265131266131267131268131269131270131271131272131273131274131275131276131277131278131279131280131281131282131283131284131285131286131287131288131289131290131291131292131293131294131295131296131297131298131299131300131301131302131303131304131305131306131307131308131309131310131311131312131313131314131315131316131317131318131319131320131321131322131323131324131325131326131327131328131329131330131331131332131333131334131335131336131337131338131339131340131341131342131343131344131345131346131347131348131349131350131351131352131353131354131355131356131357131358131359131360131361131362131363131364131365131366131367131368131369131370131371131372131373131374131375131376131377131378131379131380131381131382131383131384131385131386131387131388131389131390131391131392131393131394131395131396131397131398131399131400131401131402131403131404131405131406131407131408131409131410131411131412131413131414131415131416131417131418131419131420131421131422131423131424131425131426131427131428131429131430131431131432131433131434131435131436131437131438131439131440131441131442131443131444131445131446131447131448131449131450131451131452131453131454131455131456131457131458131459131460131461131462131463131464131465131466131467131468131469131470131471131472131473131474131475131476131477131478131479131480131481131482131483131484131485131486131487131488131489131490131491131492131493131494131495131496131497131498131499131500131501131502131503131504131505131506131507131508131509131510131511131512131513131514131515131516131517131518131519131520131521131522131523131524131525131526131527131528131529131530131531131532131533131534131535131536131537131538131539131540131541131542131543131544131545131546131547131548131549131550131551131552131553131554131555131556131557131558131559131560131561131562131563131564131565131566131567131568131569131570131571131572131573131574131575131576131577131578131579131580131581131582131583131584131585131586131587131588131589131590131591131592131593131594131595131596131597131598131599131600131601131602131603131604131605131606131607131608131609131610131611131612131613131614131615131616131617131618131619131620131621131622131623131624131625131626131627131628131629131630131631131632131633131634131635131636131637131638131639131640131641131642131643131644131645131646131647131648131649131650131651131652131653131654131655131656131657131658131659131660131661131662131663131664131665131666131667131668131669131670131671131672131673131674131675131676131677131678131679131680131681131682131683131684131685131686131687131688131689131690131691131692131693131694131695131696131697131698131699131700131701131702131703131704131705131706131707131708131709131710131711131712131713131714131715131716131717131718131719131720131721131722131723131724131725131726131727131728131729131730131731131732131733131734131735131736131737131738131739131740131741131742131743131744131745131746131747131748131749131750131751131752131753131754131755131756131757131758131759131760131761131762131763131764131765131766131767131768131769131770131771131772131773131774131775131776131777131778131779131780131781131782131783131784131785131786131787131788131789131790131791131792131793131794131795131796131797131798131799131800131801131802131803131804131805131806131807131808131809131810131811131812131813131814131815131816131817131818131819131820131821131822131823131824131825131826131827131828131829131830131831131832131833131834131835131836131837131838131839131840131841131842131843131844131845131846131847131848131849131850131851131852131853131854131855131856131857131858131859131860131861131862131863131864131865131866131867131868131869131870131871131872131873131874131875131876131877131878131879131880131881131882131883131884131885131886131887131888131889131890131891131892131893131894131895131896131897131898131899131900131901131902131903131904131905131906131907131908131909131910131911131912131913131914131915131916131917131918131919131920131921131922131923131924131925131926131927131928131929131930131931131932131933131934131935131936131937131938131939131940131941131942131943131944131945131946131947131948131949131950131951131952131953131954131955131956131957131958131959131960131961131962131963131964131965131966131967131968131969131970131971131972131973131974131975131976131977131978131979131980131981131982131983131984131985131986131987131988131989131990131991131992131993131994131995131996131997131998131999132000132001132002132003132004132005132006132007132008132009132010132011132012132013132014132015132016132017132018132019132020132021132022132023132024132025132026132027132028132029132030132031132032132033132034132035132036132037132038132039132040132041132042132043132044132045132046132047132048132049132050132051132052132053132054132055132056132057132058132059132060132061132062132063132064132065132066132067132068132069132070132071132072132073132074132075132076132077132078132079132080132081132082132083132084132085132086132087132088132089132090132091132092132093132094132095132096132097132098132099132100132101132102132103132104132105132106132107132108132109132110132111132112132113132114132115132116132117132118132119132120132121132122132123132124132125132126132127132128132129132130132131132132132133132134132135132136132137132138132139132140132141132142132143132144132145132146132147132148132149132150132151132152132153132154132155132156132157132158132159132160132161132162132163132164132165132166132167132168132169132170132171132172132173132174132175132176132177132178132179132180132181132182132183132184132185132186132187132188132189132190132191132192132193132194132195132196132197132198132199132200132201132202132203132204132205132206132207132208132209132210132211132212132213132214132215132216132217132218132219132220132221132222132223132224132225132226132227132228132229132230132231132232132233132234132235132236132237132238132239132240132241132242132243132244132245132246132247132248132249132250132251132252132253132254132255132256132257132258132259132260132261132262132263132264132265132266132267132268132269132270132271132272132273132274132275132276132277132278132279132280132281132282132283132284132285132286132287132288132289132290132291132292132293132294132295132296132297132298132299132300132301132302132303132304132305132306132307132308132309132310132311132312132313132314132315132316132317132318132319132320132321132322132323132324132325132326132327132328132329132330132331132332132333132334132335132336132337132338132339132340132341132342132343132344132345132346132347132348132349132350132351132352132353132354132355132356132357132358132359132360132361132362132363132364132365132366132367132368132369132370132371132372132373132374132375132376132377132378132379132380132381132382132383132384132385132386132387132388132389132390132391132392132393132394132395132396132397132398132399132400132401132402132403132404132405132406132407132408132409132410132411132412132413132414132415132416132417132418132419132420132421132422132423132424132425132426132427132428132429132430132431132432132433132434132435132436132437132438132439132440132441132442132443132444132445132446132447132448132449132450132451132452132453132454132455132456132457132458132459132460132461132462132463132464132465132466132467132468132469132470132471132472132473132474132475132476132477132478132479132480132481132482132483132484132485132486132487132488132489132490132491132492132493132494132495132496132497132498132499132500132501132502132503132504132505132506132507132508132509132510132511132512132513132514132515132516132517132518132519132520132521132522132523132524132525132526132527132528132529132530132531132532132533132534132535132536132537132538132539132540132541132542132543132544132545132546132547132548132549132550132551132552132553132554132555132556132557132558132559132560132561132562132563132564132565132566132567132568132569132570132571132572132573132574132575132576132577132578132579132580132581132582132583132584132585132586132587132588132589132590132591132592132593132594132595132596132597132598132599132600132601132602132603132604132605132606132607132608132609132610132611132612132613132614132615132616132617132618132619132620132621132622132623132624132625132626132627132628132629132630132631132632132633132634132635132636132637132638132639132640132641132642132643132644132645132646132647132648132649132650132651132652132653132654132655132656132657132658132659132660132661132662132663132664132665132666132667132668132669132670132671132672132673132674132675132676132677132678132679132680132681132682132683132684132685132686132687132688132689132690132691132692132693132694132695132696132697132698132699132700132701132702132703132704132705132706132707132708132709132710132711132712132713132714132715132716132717132718132719132720132721132722132723132724132725132726132727132728132729132730132731132732132733132734132735132736132737132738132739132740132741132742132743132744132745132746132747132748132749132750132751132752132753132754132755132756132757132758132759132760132761132762132763132764132765132766132767132768132769132770132771132772132773132774132775132776132777132778132779132780132781132782132783132784132785132786132787132788132789132790132791132792132793132794132795132796132797132798132799132800132801132802132803132804132805132806132807132808132809132810132811132812132813132814132815132816132817132818132819132820132821132822132823132824132825132826132827132828132829132830132831132832132833132834132835132836132837132838132839132840132841132842132843132844132845132846132847132848132849132850132851132852132853132854132855132856132857132858132859132860132861132862132863132864132865132866132867132868132869132870132871132872132873132874132875132876132877132878132879132880132881132882132883132884132885132886132887132888132889132890132891132892132893132894132895132896132897132898132899132900132901132902132903132904132905132906132907132908132909132910132911132912132913132914132915132916132917132918132919132920132921132922132923132924132925132926132927132928132929132930132931132932132933132934132935132936132937132938132939132940132941132942132943132944132945132946132947132948132949132950132951132952132953132954132955132956132957132958132959132960132961132962132963132964132965132966132967132968132969132970132971132972132973132974132975132976132977132978132979132980132981132982132983132984132985132986132987132988132989132990132991132992132993132994132995132996132997132998132999133000133001133002133003133004133005133006133007133008133009133010133011133012133013133014133015133016133017133018133019133020133021133022133023133024133025133026133027133028133029133030133031133032133033133034133035133036133037133038133039133040133041133042133043133044133045133046133047133048133049133050133051133052133053133054133055133056133057133058133059133060133061133062133063133064133065133066133067133068133069133070133071133072133073133074133075133076133077133078133079133080133081133082133083133084133085133086133087133088133089133090133091133092133093133094133095133096133097133098133099133100133101133102133103133104133105133106133107133108133109133110133111133112133113133114133115133116133117133118133119133120133121133122133123133124133125133126133127133128133129133130133131133132133133133134133135133136133137133138133139133140133141133142133143133144133145133146133147133148133149133150133151133152133153133154133155133156133157133158133159133160133161133162133163133164133165133166133167133168133169133170133171133172133173133174133175133176133177133178133179133180133181133182133183133184133185133186133187133188133189133190133191133192133193133194133195133196133197133198133199133200133201133202133203133204133205133206133207133208133209133210133211133212133213133214133215133216133217133218133219133220133221133222133223133224133225133226133227133228133229133230133231133232133233133234133235133236133237133238133239133240133241133242133243133244133245133246133247133248133249133250133251133252133253133254133255133256133257133258133259133260133261133262133263133264133265133266133267133268133269133270133271133272133273133274133275133276133277133278133279133280133281133282133283133284133285133286133287133288133289133290133291133292133293133294133295133296133297133298133299133300133301133302133303133304133305133306133307133308133309133310133311133312133313133314133315133316133317133318133319133320133321133322133323133324133325133326133327133328133329133330133331133332133333133334133335133336133337133338133339133340133341133342133343133344133345133346133347133348133349133350133351133352133353133354133355133356133357133358133359133360133361133362133363133364133365133366133367133368133369133370133371133372133373133374133375133376133377133378133379133380133381133382133383133384133385133386133387133388133389133390133391133392133393133394133395133396133397133398133399133400133401133402133403133404133405133406133407133408133409133410133411133412133413133414133415133416133417133418133419133420133421133422133423133424133425133426133427133428133429133430133431133432133433133434133435133436133437133438133439133440133441133442133443133444133445133446133447133448133449133450133451133452133453133454133455133456133457133458133459133460133461133462133463133464133465133466133467133468133469133470133471133472133473133474133475133476133477133478133479133480133481133482133483133484133485133486133487133488133489133490133491133492133493133494133495133496133497133498133499133500133501133502133503133504133505133506133507133508133509133510133511133512133513133514133515133516133517133518133519133520133521133522133523133524133525133526133527133528133529133530133531133532133533133534133535133536133537133538133539133540133541133542133543133544133545133546133547133548133549133550133551133552133553133554133555133556133557133558133559133560133561133562133563133564133565133566133567133568133569133570133571133572133573133574133575133576133577133578133579133580133581133582133583133584133585133586133587133588133589133590133591133592133593133594133595133596133597133598133599133600133601133602133603133604133605133606133607133608
  1. declare module "babylonjs/types" {
  2. /** Alias type for value that can be null */
  3. export type Nullable<T> = T | null;
  4. /**
  5. * Alias type for number that are floats
  6. * @ignorenaming
  7. */
  8. export type float = number;
  9. /**
  10. * Alias type for number that are doubles.
  11. * @ignorenaming
  12. */
  13. export type double = number;
  14. /**
  15. * Alias type for number that are integer
  16. * @ignorenaming
  17. */
  18. export type int = number;
  19. /** Alias type for number array or Float32Array */
  20. export type FloatArray = number[] | Float32Array;
  21. /** Alias type for number array or Float32Array or Int32Array or Uint32Array or Uint16Array */
  22. export type IndicesArray = number[] | Int32Array | Uint32Array | Uint16Array;
  23. /**
  24. * Alias for types that can be used by a Buffer or VertexBuffer.
  25. */
  26. export type DataArray = number[] | ArrayBuffer | ArrayBufferView;
  27. /**
  28. * Alias type for primitive types
  29. * @ignorenaming
  30. */
  31. type Primitive = undefined | null | boolean | string | number | Function;
  32. /**
  33. * Type modifier to make all the properties of an object Readonly
  34. */
  35. export type Immutable<T> = T extends Primitive ? T : T extends Array<infer U> ? ReadonlyArray<U> : DeepImmutable<T>;
  36. /**
  37. * Type modifier to make all the properties of an object Readonly recursively
  38. */
  39. export type DeepImmutable<T> = T extends Primitive ? T : T extends Array<infer U> ? DeepImmutableArray<U> : DeepImmutableObject<T>;
  40. /**
  41. * Type modifier to make object properties readonly.
  42. */
  43. export type DeepImmutableObject<T> = {
  44. readonly [K in keyof T]: DeepImmutable<T[K]>;
  45. };
  46. /** @hidden */
  47. interface DeepImmutableArray<T> extends ReadonlyArray<DeepImmutable<T>> {
  48. }
  49. }
  50. declare module "babylonjs/Misc/observable" {
  51. import { Nullable } from "babylonjs/types";
  52. /**
  53. * A class serves as a medium between the observable and its observers
  54. */
  55. export class EventState {
  56. /**
  57. * Create a new EventState
  58. * @param mask defines the mask associated with this state
  59. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  60. * @param target defines the original target of the state
  61. * @param currentTarget defines the current target of the state
  62. */
  63. constructor(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any);
  64. /**
  65. * Initialize the current event state
  66. * @param mask defines the mask associated with this state
  67. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  68. * @param target defines the original target of the state
  69. * @param currentTarget defines the current target of the state
  70. * @returns the current event state
  71. */
  72. initalize(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any): EventState;
  73. /**
  74. * An Observer can set this property to true to prevent subsequent observers of being notified
  75. */
  76. skipNextObservers: boolean;
  77. /**
  78. * Get the mask value that were used to trigger the event corresponding to this EventState object
  79. */
  80. mask: number;
  81. /**
  82. * The object that originally notified the event
  83. */
  84. target?: any;
  85. /**
  86. * The current object in the bubbling phase
  87. */
  88. currentTarget?: any;
  89. /**
  90. * This will be populated with the return value of the last function that was executed.
  91. * If it is the first function in the callback chain it will be the event data.
  92. */
  93. lastReturnValue?: any;
  94. }
  95. /**
  96. * Represent an Observer registered to a given Observable object.
  97. */
  98. export class Observer<T> {
  99. /**
  100. * Defines the callback to call when the observer is notified
  101. */
  102. callback: (eventData: T, eventState: EventState) => void;
  103. /**
  104. * Defines the mask of the observer (used to filter notifications)
  105. */
  106. mask: number;
  107. /**
  108. * Defines the current scope used to restore the JS context
  109. */
  110. scope: any;
  111. /** @hidden */
  112. _willBeUnregistered: boolean;
  113. /**
  114. * Gets or sets a property defining that the observer as to be unregistered after the next notification
  115. */
  116. unregisterOnNextCall: boolean;
  117. /**
  118. * Creates a new observer
  119. * @param callback defines the callback to call when the observer is notified
  120. * @param mask defines the mask of the observer (used to filter notifications)
  121. * @param scope defines the current scope used to restore the JS context
  122. */
  123. constructor(
  124. /**
  125. * Defines the callback to call when the observer is notified
  126. */
  127. callback: (eventData: T, eventState: EventState) => void,
  128. /**
  129. * Defines the mask of the observer (used to filter notifications)
  130. */
  131. mask: number,
  132. /**
  133. * Defines the current scope used to restore the JS context
  134. */
  135. scope?: any);
  136. }
  137. /**
  138. * Represent a list of observers registered to multiple Observables object.
  139. */
  140. export class MultiObserver<T> {
  141. private _observers;
  142. private _observables;
  143. /**
  144. * Release associated resources
  145. */
  146. dispose(): void;
  147. /**
  148. * Raise a callback when one of the observable will notify
  149. * @param observables defines a list of observables to watch
  150. * @param callback defines the callback to call on notification
  151. * @param mask defines the mask used to filter notifications
  152. * @param scope defines the current scope used to restore the JS context
  153. * @returns the new MultiObserver
  154. */
  155. static Watch<T>(observables: Observable<T>[], callback: (eventData: T, eventState: EventState) => void, mask?: number, scope?: any): MultiObserver<T>;
  156. }
  157. /**
  158. * The Observable class is a simple implementation of the Observable pattern.
  159. *
  160. * There's one slight particularity though: a given Observable can notify its observer using a particular mask value, only the Observers registered with this mask value will be notified.
  161. * This enable a more fine grained execution without having to rely on multiple different Observable objects.
  162. * For instance you may have a given Observable that have four different types of notifications: Move (mask = 0x01), Stop (mask = 0x02), Turn Right (mask = 0X04), Turn Left (mask = 0X08).
  163. * A given observer can register itself with only Move and Stop (mask = 0x03), then it will only be notified when one of these two occurs and will never be for Turn Left/Right.
  164. */
  165. export class Observable<T> {
  166. private _observers;
  167. private _eventState;
  168. private _onObserverAdded;
  169. /**
  170. * Gets the list of observers
  171. */
  172. readonly observers: Array<Observer<T>>;
  173. /**
  174. * Creates a new observable
  175. * @param onObserverAdded defines a callback to call when a new observer is added
  176. */
  177. constructor(onObserverAdded?: (observer: Observer<T>) => void);
  178. /**
  179. * Create a new Observer with the specified callback
  180. * @param callback the callback that will be executed for that Observer
  181. * @param mask the mask used to filter observers
  182. * @param insertFirst if true the callback will be inserted at the first position, hence executed before the others ones. If false (default behavior) the callback will be inserted at the last position, executed after all the others already present.
  183. * @param scope optional scope for the callback to be called from
  184. * @param unregisterOnFirstCall defines if the observer as to be unregistered after the next notification
  185. * @returns the new observer created for the callback
  186. */
  187. add(callback: (eventData: T, eventState: EventState) => void, mask?: number, insertFirst?: boolean, scope?: any, unregisterOnFirstCall?: boolean): Nullable<Observer<T>>;
  188. /**
  189. * Create a new Observer with the specified callback and unregisters after the next notification
  190. * @param callback the callback that will be executed for that Observer
  191. * @returns the new observer created for the callback
  192. */
  193. addOnce(callback: (eventData: T, eventState: EventState) => void): Nullable<Observer<T>>;
  194. /**
  195. * Remove an Observer from the Observable object
  196. * @param observer the instance of the Observer to remove
  197. * @returns false if it doesn't belong to this Observable
  198. */
  199. remove(observer: Nullable<Observer<T>>): boolean;
  200. /**
  201. * Remove a callback from the Observable object
  202. * @param callback the callback to remove
  203. * @param scope optional scope. If used only the callbacks with this scope will be removed
  204. * @returns false if it doesn't belong to this Observable
  205. */
  206. removeCallback(callback: (eventData: T, eventState: EventState) => void, scope?: any): boolean;
  207. private _deferUnregister;
  208. private _remove;
  209. /**
  210. * Moves the observable to the top of the observer list making it get called first when notified
  211. * @param observer the observer to move
  212. */
  213. makeObserverTopPriority(observer: Observer<T>): void;
  214. /**
  215. * Moves the observable to the bottom of the observer list making it get called last when notified
  216. * @param observer the observer to move
  217. */
  218. makeObserverBottomPriority(observer: Observer<T>): void;
  219. /**
  220. * Notify all Observers by calling their respective callback with the given data
  221. * Will return true if all observers were executed, false if an observer set skipNextObservers to true, then prevent the subsequent ones to execute
  222. * @param eventData defines the data to send to all observers
  223. * @param mask defines the mask of the current notification (observers with incompatible mask (ie mask & observer.mask === 0) will not be notified)
  224. * @param target defines the original target of the state
  225. * @param currentTarget defines the current target of the state
  226. * @returns false if the complete observer chain was not processed (because one observer set the skipNextObservers to true)
  227. */
  228. notifyObservers(eventData: T, mask?: number, target?: any, currentTarget?: any): boolean;
  229. /**
  230. * Calling this will execute each callback, expecting it to be a promise or return a value.
  231. * If at any point in the chain one function fails, the promise will fail and the execution will not continue.
  232. * This is useful when a chain of events (sometimes async events) is needed to initialize a certain object
  233. * and it is crucial that all callbacks will be executed.
  234. * The order of the callbacks is kept, callbacks are not executed parallel.
  235. *
  236. * @param eventData The data to be sent to each callback
  237. * @param mask is used to filter observers defaults to -1
  238. * @param target defines the callback target (see EventState)
  239. * @param currentTarget defines he current object in the bubbling phase
  240. * @returns {Promise<T>} will return a Promise than resolves when all callbacks executed successfully.
  241. */
  242. notifyObserversWithPromise(eventData: T, mask?: number, target?: any, currentTarget?: any): Promise<T>;
  243. /**
  244. * Notify a specific observer
  245. * @param observer defines the observer to notify
  246. * @param eventData defines the data to be sent to each callback
  247. * @param mask is used to filter observers defaults to -1
  248. */
  249. notifyObserver(observer: Observer<T>, eventData: T, mask?: number): void;
  250. /**
  251. * Gets a boolean indicating if the observable has at least one observer
  252. * @returns true is the Observable has at least one Observer registered
  253. */
  254. hasObservers(): boolean;
  255. /**
  256. * Clear the list of observers
  257. */
  258. clear(): void;
  259. /**
  260. * Clone the current observable
  261. * @returns a new observable
  262. */
  263. clone(): Observable<T>;
  264. /**
  265. * Does this observable handles observer registered with a given mask
  266. * @param mask defines the mask to be tested
  267. * @return whether or not one observer registered with the given mask is handeled
  268. **/
  269. hasSpecificMask(mask?: number): boolean;
  270. }
  271. }
  272. declare module "babylonjs/Misc/domManagement" {
  273. /**
  274. * Sets of helpers dealing with the DOM and some of the recurrent functions needed in
  275. * Babylon.js
  276. */
  277. export class DomManagement {
  278. /**
  279. * Checks if the window object exists
  280. * @returns true if the window object exists
  281. */
  282. static IsWindowObjectExist(): boolean;
  283. /**
  284. * Checks if the navigator object exists
  285. * @returns true if the navigator object exists
  286. */
  287. static IsNavigatorAvailable(): boolean;
  288. /**
  289. * Extracts text content from a DOM element hierarchy
  290. * @param element defines the root element
  291. * @returns a string
  292. */
  293. static GetDOMTextContent(element: HTMLElement): string;
  294. }
  295. }
  296. declare module "babylonjs/Misc/logger" {
  297. /**
  298. * Logger used througouht the application to allow configuration of
  299. * the log level required for the messages.
  300. */
  301. export class Logger {
  302. /**
  303. * No log
  304. */
  305. static readonly NoneLogLevel: number;
  306. /**
  307. * Only message logs
  308. */
  309. static readonly MessageLogLevel: number;
  310. /**
  311. * Only warning logs
  312. */
  313. static readonly WarningLogLevel: number;
  314. /**
  315. * Only error logs
  316. */
  317. static readonly ErrorLogLevel: number;
  318. /**
  319. * All logs
  320. */
  321. static readonly AllLogLevel: number;
  322. private static _LogCache;
  323. /**
  324. * Gets a value indicating the number of loading errors
  325. * @ignorenaming
  326. */
  327. static errorsCount: number;
  328. /**
  329. * Callback called when a new log is added
  330. */
  331. static OnNewCacheEntry: (entry: string) => void;
  332. private static _AddLogEntry;
  333. private static _FormatMessage;
  334. private static _LogDisabled;
  335. private static _LogEnabled;
  336. private static _WarnDisabled;
  337. private static _WarnEnabled;
  338. private static _ErrorDisabled;
  339. private static _ErrorEnabled;
  340. /**
  341. * Log a message to the console
  342. */
  343. static Log: (message: string) => void;
  344. /**
  345. * Write a warning message to the console
  346. */
  347. static Warn: (message: string) => void;
  348. /**
  349. * Write an error message to the console
  350. */
  351. static Error: (message: string) => void;
  352. /**
  353. * Gets current log cache (list of logs)
  354. */
  355. static readonly LogCache: string;
  356. /**
  357. * Clears the log cache
  358. */
  359. static ClearLogCache(): void;
  360. /**
  361. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  362. */
  363. static LogLevels: number;
  364. }
  365. }
  366. declare module "babylonjs/Misc/typeStore" {
  367. /** @hidden */
  368. export class _TypeStore {
  369. /** @hidden */
  370. static RegisteredTypes: {
  371. [key: string]: Object;
  372. };
  373. /** @hidden */
  374. static GetClass(fqdn: string): any;
  375. }
  376. }
  377. declare module "babylonjs/Misc/stringTools" {
  378. /**
  379. * Helper to manipulate strings
  380. */
  381. export class StringTools {
  382. /**
  383. * Checks for a matching suffix at the end of a string (for ES5 and lower)
  384. * @param str Source string
  385. * @param suffix Suffix to search for in the source string
  386. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  387. */
  388. static EndsWith(str: string, suffix: string): boolean;
  389. /**
  390. * Checks for a matching suffix at the beginning of a string (for ES5 and lower)
  391. * @param str Source string
  392. * @param suffix Suffix to search for in the source string
  393. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  394. */
  395. static StartsWith(str: string, suffix: string): boolean;
  396. /**
  397. * Decodes a buffer into a string
  398. * @param buffer The buffer to decode
  399. * @returns The decoded string
  400. */
  401. static Decode(buffer: Uint8Array | Uint16Array): string;
  402. /**
  403. * Encode a buffer to a base64 string
  404. * @param buffer defines the buffer to encode
  405. * @returns the encoded string
  406. */
  407. static EncodeArrayBufferToBase64(buffer: ArrayBuffer | ArrayBufferView): string;
  408. }
  409. }
  410. declare module "babylonjs/Misc/deepCopier" {
  411. /**
  412. * Class containing a set of static utilities functions for deep copy.
  413. */
  414. export class DeepCopier {
  415. /**
  416. * Tries to copy an object by duplicating every property
  417. * @param source defines the source object
  418. * @param destination defines the target object
  419. * @param doNotCopyList defines a list of properties to avoid
  420. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  421. */
  422. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  423. }
  424. }
  425. declare module "babylonjs/Misc/precisionDate" {
  426. /**
  427. * Class containing a set of static utilities functions for precision date
  428. */
  429. export class PrecisionDate {
  430. /**
  431. * Gets either window.performance.now() if supported or Date.now() else
  432. */
  433. static readonly Now: number;
  434. }
  435. }
  436. declare module "babylonjs/Misc/devTools" {
  437. /** @hidden */
  438. export class _DevTools {
  439. static WarnImport(name: string): string;
  440. }
  441. }
  442. declare module "babylonjs/Misc/interfaces/iWebRequest" {
  443. /**
  444. * Interface used to define the mechanism to get data from the network
  445. */
  446. export interface IWebRequest {
  447. /**
  448. * Returns client's response url
  449. */
  450. responseURL: string;
  451. /**
  452. * Returns client's status
  453. */
  454. status: number;
  455. /**
  456. * Returns client's status as a text
  457. */
  458. statusText: string;
  459. }
  460. }
  461. declare module "babylonjs/Misc/webRequest" {
  462. import { IWebRequest } from "babylonjs/Misc/interfaces/iWebRequest";
  463. import { Nullable } from "babylonjs/types";
  464. /**
  465. * Extended version of XMLHttpRequest with support for customizations (headers, ...)
  466. */
  467. export class WebRequest implements IWebRequest {
  468. private _xhr;
  469. /**
  470. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  471. * i.e. when loading files, where the server/service expects an Authorization header
  472. */
  473. static CustomRequestHeaders: {
  474. [key: string]: string;
  475. };
  476. /**
  477. * Add callback functions in this array to update all the requests before they get sent to the network
  478. */
  479. static CustomRequestModifiers: ((request: XMLHttpRequest, url: string) => void)[];
  480. private _injectCustomRequestHeaders;
  481. /**
  482. * Gets or sets a function to be called when loading progress changes
  483. */
  484. onprogress: ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null;
  485. /**
  486. * Returns client's state
  487. */
  488. readonly readyState: number;
  489. /**
  490. * Returns client's status
  491. */
  492. readonly status: number;
  493. /**
  494. * Returns client's status as a text
  495. */
  496. readonly statusText: string;
  497. /**
  498. * Returns client's response
  499. */
  500. readonly response: any;
  501. /**
  502. * Returns client's response url
  503. */
  504. readonly responseURL: string;
  505. /**
  506. * Returns client's response as text
  507. */
  508. readonly responseText: string;
  509. /**
  510. * Gets or sets the expected response type
  511. */
  512. responseType: XMLHttpRequestResponseType;
  513. /** @hidden */
  514. addEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
  515. /** @hidden */
  516. removeEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
  517. /**
  518. * Cancels any network activity
  519. */
  520. abort(): void;
  521. /**
  522. * Initiates the request. The optional argument provides the request body. The argument is ignored if request method is GET or HEAD
  523. * @param body defines an optional request body
  524. */
  525. send(body?: Document | BodyInit | null): void;
  526. /**
  527. * Sets the request method, request URL
  528. * @param method defines the method to use (GET, POST, etc..)
  529. * @param url defines the url to connect with
  530. */
  531. open(method: string, url: string): void;
  532. /**
  533. * Sets the value of a request header.
  534. * @param name The name of the header whose value is to be set
  535. * @param value The value to set as the body of the header
  536. */
  537. setRequestHeader(name: string, value: string): void;
  538. /**
  539. * Get the string containing the text of a particular header's value.
  540. * @param name The name of the header
  541. * @returns The string containing the text of the given header name
  542. */
  543. getResponseHeader(name: string): Nullable<string>;
  544. }
  545. }
  546. declare module "babylonjs/Misc/fileRequest" {
  547. import { Observable } from "babylonjs/Misc/observable";
  548. /**
  549. * File request interface
  550. */
  551. export interface IFileRequest {
  552. /**
  553. * Raised when the request is complete (success or error).
  554. */
  555. onCompleteObservable: Observable<IFileRequest>;
  556. /**
  557. * Aborts the request for a file.
  558. */
  559. abort: () => void;
  560. }
  561. }
  562. declare module "babylonjs/Materials/Textures/renderTargetCreationOptions" {
  563. /**
  564. * Define options used to create a render target texture
  565. */
  566. export class RenderTargetCreationOptions {
  567. /**
  568. * Specifies is mipmaps must be generated
  569. */
  570. generateMipMaps?: boolean;
  571. /** Specifies whether or not a depth should be allocated in the texture (true by default) */
  572. generateDepthBuffer?: boolean;
  573. /** Specifies whether or not a stencil should be allocated in the texture (false by default)*/
  574. generateStencilBuffer?: boolean;
  575. /** Defines texture type (int by default) */
  576. type?: number;
  577. /** Defines sampling mode (trilinear by default) */
  578. samplingMode?: number;
  579. /** Defines format (RGBA by default) */
  580. format?: number;
  581. }
  582. }
  583. declare module "babylonjs/Instrumentation/timeToken" {
  584. import { Nullable } from "babylonjs/types";
  585. /**
  586. * @hidden
  587. **/
  588. export class _TimeToken {
  589. _startTimeQuery: Nullable<WebGLQuery>;
  590. _endTimeQuery: Nullable<WebGLQuery>;
  591. _timeElapsedQuery: Nullable<WebGLQuery>;
  592. _timeElapsedQueryEnded: boolean;
  593. }
  594. }
  595. declare module "babylonjs/Engines/constants" {
  596. /** Defines the cross module used constants to avoid circular dependncies */
  597. export class Constants {
  598. /** Defines that alpha blending is disabled */
  599. static readonly ALPHA_DISABLE: number;
  600. /** Defines that alpha blending to SRC ALPHA * SRC + DEST */
  601. static readonly ALPHA_ADD: number;
  602. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  603. static readonly ALPHA_COMBINE: number;
  604. /** Defines that alpha blending to DEST - SRC * DEST */
  605. static readonly ALPHA_SUBTRACT: number;
  606. /** Defines that alpha blending to SRC * DEST */
  607. static readonly ALPHA_MULTIPLY: number;
  608. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC) * DEST */
  609. static readonly ALPHA_MAXIMIZED: number;
  610. /** Defines that alpha blending to SRC + DEST */
  611. static readonly ALPHA_ONEONE: number;
  612. /** Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST */
  613. static readonly ALPHA_PREMULTIPLIED: number;
  614. /**
  615. * Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST
  616. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  617. */
  618. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  619. /** Defines that alpha blending to CST * SRC + (1 - CST) * DEST */
  620. static readonly ALPHA_INTERPOLATE: number;
  621. /**
  622. * Defines that alpha blending to SRC + (1 - SRC) * DEST
  623. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  624. */
  625. static readonly ALPHA_SCREENMODE: number;
  626. /**
  627. * Defines that alpha blending to SRC + DST
  628. * Alpha will be set to SRC ALPHA + DST ALPHA
  629. */
  630. static readonly ALPHA_ONEONE_ONEONE: number;
  631. /**
  632. * Defines that alpha blending to SRC * DST ALPHA + DST
  633. * Alpha will be set to 0
  634. */
  635. static readonly ALPHA_ALPHATOCOLOR: number;
  636. /**
  637. * Defines that alpha blending to SRC * (1 - DST) + DST * (1 - SRC)
  638. */
  639. static readonly ALPHA_REVERSEONEMINUS: number;
  640. /**
  641. * Defines that alpha blending to SRC + DST * (1 - SRC ALPHA)
  642. * Alpha will be set to SRC ALPHA + DST ALPHA * (1 - SRC ALPHA)
  643. */
  644. static readonly ALPHA_SRC_DSTONEMINUSSRCALPHA: number;
  645. /**
  646. * Defines that alpha blending to SRC + DST
  647. * Alpha will be set to SRC ALPHA
  648. */
  649. static readonly ALPHA_ONEONE_ONEZERO: number;
  650. /** Defines that alpha blending equation a SUM */
  651. static readonly ALPHA_EQUATION_ADD: number;
  652. /** Defines that alpha blending equation a SUBSTRACTION */
  653. static readonly ALPHA_EQUATION_SUBSTRACT: number;
  654. /** Defines that alpha blending equation a REVERSE SUBSTRACTION */
  655. static readonly ALPHA_EQUATION_REVERSE_SUBTRACT: number;
  656. /** Defines that alpha blending equation a MAX operation */
  657. static readonly ALPHA_EQUATION_MAX: number;
  658. /** Defines that alpha blending equation a MIN operation */
  659. static readonly ALPHA_EQUATION_MIN: number;
  660. /**
  661. * Defines that alpha blending equation a DARKEN operation:
  662. * It takes the min of the src and sums the alpha channels.
  663. */
  664. static readonly ALPHA_EQUATION_DARKEN: number;
  665. /** Defines that the ressource is not delayed*/
  666. static readonly DELAYLOADSTATE_NONE: number;
  667. /** Defines that the ressource was successfully delay loaded */
  668. static readonly DELAYLOADSTATE_LOADED: number;
  669. /** Defines that the ressource is currently delay loading */
  670. static readonly DELAYLOADSTATE_LOADING: number;
  671. /** Defines that the ressource is delayed and has not started loading */
  672. static readonly DELAYLOADSTATE_NOTLOADED: number;
  673. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  674. static readonly NEVER: number;
  675. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will always pass. i.e. Pixels will be drawn in the order they are drawn */
  676. static readonly ALWAYS: number;
  677. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  678. static readonly LESS: number;
  679. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  680. static readonly EQUAL: number;
  681. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than or equal to the stored value */
  682. static readonly LEQUAL: number;
  683. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  684. static readonly GREATER: number;
  685. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than or equal to the stored value */
  686. static readonly GEQUAL: number;
  687. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is not equal to the stored value */
  688. static readonly NOTEQUAL: number;
  689. /** Passed to stencilOperation to specify that stencil value must be kept */
  690. static readonly KEEP: number;
  691. /** Passed to stencilOperation to specify that stencil value must be replaced */
  692. static readonly REPLACE: number;
  693. /** Passed to stencilOperation to specify that stencil value must be incremented */
  694. static readonly INCR: number;
  695. /** Passed to stencilOperation to specify that stencil value must be decremented */
  696. static readonly DECR: number;
  697. /** Passed to stencilOperation to specify that stencil value must be inverted */
  698. static readonly INVERT: number;
  699. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  700. static readonly INCR_WRAP: number;
  701. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  702. static readonly DECR_WRAP: number;
  703. /** Texture is not repeating outside of 0..1 UVs */
  704. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  705. /** Texture is repeating outside of 0..1 UVs */
  706. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  707. /** Texture is repeating and mirrored */
  708. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  709. /** ALPHA */
  710. static readonly TEXTUREFORMAT_ALPHA: number;
  711. /** LUMINANCE */
  712. static readonly TEXTUREFORMAT_LUMINANCE: number;
  713. /** LUMINANCE_ALPHA */
  714. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  715. /** RGB */
  716. static readonly TEXTUREFORMAT_RGB: number;
  717. /** RGBA */
  718. static readonly TEXTUREFORMAT_RGBA: number;
  719. /** RED */
  720. static readonly TEXTUREFORMAT_RED: number;
  721. /** RED (2nd reference) */
  722. static readonly TEXTUREFORMAT_R: number;
  723. /** RG */
  724. static readonly TEXTUREFORMAT_RG: number;
  725. /** RED_INTEGER */
  726. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  727. /** RED_INTEGER (2nd reference) */
  728. static readonly TEXTUREFORMAT_R_INTEGER: number;
  729. /** RG_INTEGER */
  730. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  731. /** RGB_INTEGER */
  732. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  733. /** RGBA_INTEGER */
  734. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  735. /** UNSIGNED_BYTE */
  736. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  737. /** UNSIGNED_BYTE (2nd reference) */
  738. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  739. /** FLOAT */
  740. static readonly TEXTURETYPE_FLOAT: number;
  741. /** HALF_FLOAT */
  742. static readonly TEXTURETYPE_HALF_FLOAT: number;
  743. /** BYTE */
  744. static readonly TEXTURETYPE_BYTE: number;
  745. /** SHORT */
  746. static readonly TEXTURETYPE_SHORT: number;
  747. /** UNSIGNED_SHORT */
  748. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  749. /** INT */
  750. static readonly TEXTURETYPE_INT: number;
  751. /** UNSIGNED_INT */
  752. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  753. /** UNSIGNED_SHORT_4_4_4_4 */
  754. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  755. /** UNSIGNED_SHORT_5_5_5_1 */
  756. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  757. /** UNSIGNED_SHORT_5_6_5 */
  758. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  759. /** UNSIGNED_INT_2_10_10_10_REV */
  760. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  761. /** UNSIGNED_INT_24_8 */
  762. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  763. /** UNSIGNED_INT_10F_11F_11F_REV */
  764. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  765. /** UNSIGNED_INT_5_9_9_9_REV */
  766. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  767. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  768. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  769. /** nearest is mag = nearest and min = nearest and mip = nearest */
  770. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  771. /** Bilinear is mag = linear and min = linear and mip = nearest */
  772. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  773. /** Trilinear is mag = linear and min = linear and mip = linear */
  774. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  775. /** nearest is mag = nearest and min = nearest and mip = linear */
  776. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  777. /** Bilinear is mag = linear and min = linear and mip = nearest */
  778. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  779. /** Trilinear is mag = linear and min = linear and mip = linear */
  780. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  781. /** mag = nearest and min = nearest and mip = nearest */
  782. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  783. /** mag = nearest and min = linear and mip = nearest */
  784. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  785. /** mag = nearest and min = linear and mip = linear */
  786. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  787. /** mag = nearest and min = linear and mip = none */
  788. static readonly TEXTURE_NEAREST_LINEAR: number;
  789. /** mag = nearest and min = nearest and mip = none */
  790. static readonly TEXTURE_NEAREST_NEAREST: number;
  791. /** mag = linear and min = nearest and mip = nearest */
  792. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  793. /** mag = linear and min = nearest and mip = linear */
  794. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  795. /** mag = linear and min = linear and mip = none */
  796. static readonly TEXTURE_LINEAR_LINEAR: number;
  797. /** mag = linear and min = nearest and mip = none */
  798. static readonly TEXTURE_LINEAR_NEAREST: number;
  799. /** Explicit coordinates mode */
  800. static readonly TEXTURE_EXPLICIT_MODE: number;
  801. /** Spherical coordinates mode */
  802. static readonly TEXTURE_SPHERICAL_MODE: number;
  803. /** Planar coordinates mode */
  804. static readonly TEXTURE_PLANAR_MODE: number;
  805. /** Cubic coordinates mode */
  806. static readonly TEXTURE_CUBIC_MODE: number;
  807. /** Projection coordinates mode */
  808. static readonly TEXTURE_PROJECTION_MODE: number;
  809. /** Skybox coordinates mode */
  810. static readonly TEXTURE_SKYBOX_MODE: number;
  811. /** Inverse Cubic coordinates mode */
  812. static readonly TEXTURE_INVCUBIC_MODE: number;
  813. /** Equirectangular coordinates mode */
  814. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  815. /** Equirectangular Fixed coordinates mode */
  816. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  817. /** Equirectangular Fixed Mirrored coordinates mode */
  818. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  819. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  820. static readonly SCALEMODE_FLOOR: number;
  821. /** Defines that texture rescaling will look for the nearest power of 2 size */
  822. static readonly SCALEMODE_NEAREST: number;
  823. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  824. static readonly SCALEMODE_CEILING: number;
  825. /**
  826. * The dirty texture flag value
  827. */
  828. static readonly MATERIAL_TextureDirtyFlag: number;
  829. /**
  830. * The dirty light flag value
  831. */
  832. static readonly MATERIAL_LightDirtyFlag: number;
  833. /**
  834. * The dirty fresnel flag value
  835. */
  836. static readonly MATERIAL_FresnelDirtyFlag: number;
  837. /**
  838. * The dirty attribute flag value
  839. */
  840. static readonly MATERIAL_AttributesDirtyFlag: number;
  841. /**
  842. * The dirty misc flag value
  843. */
  844. static readonly MATERIAL_MiscDirtyFlag: number;
  845. /**
  846. * The all dirty flag value
  847. */
  848. static readonly MATERIAL_AllDirtyFlag: number;
  849. /**
  850. * Returns the triangle fill mode
  851. */
  852. static readonly MATERIAL_TriangleFillMode: number;
  853. /**
  854. * Returns the wireframe mode
  855. */
  856. static readonly MATERIAL_WireFrameFillMode: number;
  857. /**
  858. * Returns the point fill mode
  859. */
  860. static readonly MATERIAL_PointFillMode: number;
  861. /**
  862. * Returns the point list draw mode
  863. */
  864. static readonly MATERIAL_PointListDrawMode: number;
  865. /**
  866. * Returns the line list draw mode
  867. */
  868. static readonly MATERIAL_LineListDrawMode: number;
  869. /**
  870. * Returns the line loop draw mode
  871. */
  872. static readonly MATERIAL_LineLoopDrawMode: number;
  873. /**
  874. * Returns the line strip draw mode
  875. */
  876. static readonly MATERIAL_LineStripDrawMode: number;
  877. /**
  878. * Returns the triangle strip draw mode
  879. */
  880. static readonly MATERIAL_TriangleStripDrawMode: number;
  881. /**
  882. * Returns the triangle fan draw mode
  883. */
  884. static readonly MATERIAL_TriangleFanDrawMode: number;
  885. /**
  886. * Stores the clock-wise side orientation
  887. */
  888. static readonly MATERIAL_ClockWiseSideOrientation: number;
  889. /**
  890. * Stores the counter clock-wise side orientation
  891. */
  892. static readonly MATERIAL_CounterClockWiseSideOrientation: number;
  893. /**
  894. * Nothing
  895. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  896. */
  897. static readonly ACTION_NothingTrigger: number;
  898. /**
  899. * On pick
  900. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  901. */
  902. static readonly ACTION_OnPickTrigger: number;
  903. /**
  904. * On left pick
  905. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  906. */
  907. static readonly ACTION_OnLeftPickTrigger: number;
  908. /**
  909. * On right pick
  910. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  911. */
  912. static readonly ACTION_OnRightPickTrigger: number;
  913. /**
  914. * On center pick
  915. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  916. */
  917. static readonly ACTION_OnCenterPickTrigger: number;
  918. /**
  919. * On pick down
  920. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  921. */
  922. static readonly ACTION_OnPickDownTrigger: number;
  923. /**
  924. * On double pick
  925. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  926. */
  927. static readonly ACTION_OnDoublePickTrigger: number;
  928. /**
  929. * On pick up
  930. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  931. */
  932. static readonly ACTION_OnPickUpTrigger: number;
  933. /**
  934. * On pick out.
  935. * This trigger will only be raised if you also declared a OnPickDown
  936. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  937. */
  938. static readonly ACTION_OnPickOutTrigger: number;
  939. /**
  940. * On long press
  941. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  942. */
  943. static readonly ACTION_OnLongPressTrigger: number;
  944. /**
  945. * On pointer over
  946. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  947. */
  948. static readonly ACTION_OnPointerOverTrigger: number;
  949. /**
  950. * On pointer out
  951. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  952. */
  953. static readonly ACTION_OnPointerOutTrigger: number;
  954. /**
  955. * On every frame
  956. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  957. */
  958. static readonly ACTION_OnEveryFrameTrigger: number;
  959. /**
  960. * On intersection enter
  961. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  962. */
  963. static readonly ACTION_OnIntersectionEnterTrigger: number;
  964. /**
  965. * On intersection exit
  966. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  967. */
  968. static readonly ACTION_OnIntersectionExitTrigger: number;
  969. /**
  970. * On key down
  971. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  972. */
  973. static readonly ACTION_OnKeyDownTrigger: number;
  974. /**
  975. * On key up
  976. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  977. */
  978. static readonly ACTION_OnKeyUpTrigger: number;
  979. /**
  980. * Billboard mode will only apply to Y axis
  981. */
  982. static readonly PARTICLES_BILLBOARDMODE_Y: number;
  983. /**
  984. * Billboard mode will apply to all axes
  985. */
  986. static readonly PARTICLES_BILLBOARDMODE_ALL: number;
  987. /**
  988. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  989. */
  990. static readonly PARTICLES_BILLBOARDMODE_STRETCHED: number;
  991. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  992. * Test order :
  993. * Is the bounding sphere outside the frustum ?
  994. * If not, are the bounding box vertices outside the frustum ?
  995. * It not, then the cullable object is in the frustum.
  996. */
  997. static readonly MESHES_CULLINGSTRATEGY_STANDARD: number;
  998. /** Culling strategy : Bounding Sphere Only.
  999. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  1000. * It's also less accurate than the standard because some not visible objects can still be selected.
  1001. * Test : is the bounding sphere outside the frustum ?
  1002. * If not, then the cullable object is in the frustum.
  1003. */
  1004. static readonly MESHES_CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  1005. /** Culling strategy : Optimistic Inclusion.
  1006. * This in an inclusion test first, then the standard exclusion test.
  1007. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  1008. * This could also be a little slower than the standard test when the tested object center is not the frustum but one of its bounding box vertex is still inside.
  1009. * Anyway, it's as accurate as the standard strategy.
  1010. * Test :
  1011. * Is the cullable object bounding sphere center in the frustum ?
  1012. * If not, apply the default culling strategy.
  1013. */
  1014. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  1015. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  1016. * This in an inclusion test first, then the bounding sphere only exclusion test.
  1017. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  1018. * This could also be a little slower than the BoundingSphereOnly strategy when the tested object center is not in the frustum but its bounding sphere still intersects it.
  1019. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  1020. * Test :
  1021. * Is the cullable object bounding sphere center in the frustum ?
  1022. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  1023. */
  1024. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  1025. /**
  1026. * No logging while loading
  1027. */
  1028. static readonly SCENELOADER_NO_LOGGING: number;
  1029. /**
  1030. * Minimal logging while loading
  1031. */
  1032. static readonly SCENELOADER_MINIMAL_LOGGING: number;
  1033. /**
  1034. * Summary logging while loading
  1035. */
  1036. static readonly SCENELOADER_SUMMARY_LOGGING: number;
  1037. /**
  1038. * Detailled logging while loading
  1039. */
  1040. static readonly SCENELOADER_DETAILED_LOGGING: number;
  1041. }
  1042. }
  1043. declare module "babylonjs/Materials/Textures/internalTextureLoader" {
  1044. import { Nullable } from "babylonjs/types";
  1045. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  1046. /**
  1047. * This represents the required contract to create a new type of texture loader.
  1048. */
  1049. export interface IInternalTextureLoader {
  1050. /**
  1051. * Defines wether the loader supports cascade loading the different faces.
  1052. */
  1053. supportCascades: boolean;
  1054. /**
  1055. * This returns if the loader support the current file information.
  1056. * @param extension defines the file extension of the file being loaded
  1057. * @param textureFormatInUse defines the current compressed format in use iun the engine
  1058. * @param fallback defines the fallback internal texture if any
  1059. * @param isBase64 defines whether the texture is encoded as a base64
  1060. * @param isBuffer defines whether the texture data are stored as a buffer
  1061. * @returns true if the loader can load the specified file
  1062. */
  1063. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  1064. /**
  1065. * Transform the url before loading if required.
  1066. * @param rootUrl the url of the texture
  1067. * @param textureFormatInUse defines the current compressed format in use iun the engine
  1068. * @returns the transformed texture
  1069. */
  1070. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  1071. /**
  1072. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  1073. * @param rootUrl the url of the texture
  1074. * @param textureFormatInUse defines the current compressed format in use iun the engine
  1075. * @returns the fallback texture
  1076. */
  1077. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  1078. /**
  1079. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  1080. * @param data contains the texture data
  1081. * @param texture defines the BabylonJS internal texture
  1082. * @param createPolynomials will be true if polynomials have been requested
  1083. * @param onLoad defines the callback to trigger once the texture is ready
  1084. * @param onError defines the callback to trigger in case of error
  1085. */
  1086. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  1087. /**
  1088. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  1089. * @param data contains the texture data
  1090. * @param texture defines the BabylonJS internal texture
  1091. * @param callback defines the method to call once ready to upload
  1092. */
  1093. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed?: boolean) => void): void;
  1094. }
  1095. }
  1096. declare module "babylonjs/Engines/IPipelineContext" {
  1097. /**
  1098. * Class used to store and describe the pipeline context associated with an effect
  1099. */
  1100. export interface IPipelineContext {
  1101. /**
  1102. * Gets a boolean indicating that this pipeline context is supporting asynchronous creating
  1103. */
  1104. isAsync: boolean;
  1105. /**
  1106. * Gets a boolean indicating that the context is ready to be used (like shaders / pipelines are compiled and ready for instance)
  1107. */
  1108. isReady: boolean;
  1109. /** @hidden */
  1110. _handlesSpectorRebuildCallback(onCompiled: (compiledObject: any) => void): void;
  1111. }
  1112. }
  1113. declare module "babylonjs/Meshes/dataBuffer" {
  1114. /**
  1115. * Class used to store gfx data (like WebGLBuffer)
  1116. */
  1117. export class DataBuffer {
  1118. /**
  1119. * Gets or sets the number of objects referencing this buffer
  1120. */
  1121. references: number;
  1122. /** Gets or sets the size of the underlying buffer */
  1123. capacity: number;
  1124. /**
  1125. * Gets or sets a boolean indicating if the buffer contains 32bits indices
  1126. */
  1127. is32Bits: boolean;
  1128. /**
  1129. * Gets the underlying buffer
  1130. */
  1131. readonly underlyingResource: any;
  1132. }
  1133. }
  1134. declare module "babylonjs/Engines/Processors/iShaderProcessor" {
  1135. /** @hidden */
  1136. export interface IShaderProcessor {
  1137. attributeProcessor?: (attribute: string) => string;
  1138. varyingProcessor?: (varying: string, isFragment: boolean) => string;
  1139. uniformProcessor?: (uniform: string, isFragment: boolean) => string;
  1140. uniformBufferProcessor?: (uniformBuffer: string, isFragment: boolean) => string;
  1141. endOfUniformBufferProcessor?: (closingBracketLine: string, isFragment: boolean) => string;
  1142. lineProcessor?: (line: string, isFragment: boolean) => string;
  1143. preProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  1144. postProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  1145. }
  1146. }
  1147. declare module "babylonjs/Engines/Processors/shaderProcessingOptions" {
  1148. import { IShaderProcessor } from "babylonjs/Engines/Processors/iShaderProcessor";
  1149. /** @hidden */
  1150. export interface ProcessingOptions {
  1151. defines: string[];
  1152. indexParameters: any;
  1153. isFragment: boolean;
  1154. shouldUseHighPrecisionShader: boolean;
  1155. supportsUniformBuffers: boolean;
  1156. shadersRepository: string;
  1157. includesShadersStore: {
  1158. [key: string]: string;
  1159. };
  1160. processor?: IShaderProcessor;
  1161. version: string;
  1162. platformName: string;
  1163. lookForClosingBracketForUniformBuffer?: boolean;
  1164. }
  1165. }
  1166. declare module "babylonjs/Engines/Processors/shaderCodeNode" {
  1167. import { ProcessingOptions } from "babylonjs/Engines/Processors/shaderProcessingOptions";
  1168. /** @hidden */
  1169. export class ShaderCodeNode {
  1170. line: string;
  1171. children: ShaderCodeNode[];
  1172. additionalDefineKey?: string;
  1173. additionalDefineValue?: string;
  1174. isValid(preprocessors: {
  1175. [key: string]: string;
  1176. }): boolean;
  1177. process(preprocessors: {
  1178. [key: string]: string;
  1179. }, options: ProcessingOptions): string;
  1180. }
  1181. }
  1182. declare module "babylonjs/Engines/Processors/shaderCodeCursor" {
  1183. /** @hidden */
  1184. export class ShaderCodeCursor {
  1185. private _lines;
  1186. lineIndex: number;
  1187. readonly currentLine: string;
  1188. readonly canRead: boolean;
  1189. lines: string[];
  1190. }
  1191. }
  1192. declare module "babylonjs/Engines/Processors/shaderCodeConditionNode" {
  1193. import { ShaderCodeNode } from "babylonjs/Engines/Processors/shaderCodeNode";
  1194. import { ProcessingOptions } from "babylonjs/Engines/Processors/shaderProcessingOptions";
  1195. /** @hidden */
  1196. export class ShaderCodeConditionNode extends ShaderCodeNode {
  1197. process(preprocessors: {
  1198. [key: string]: string;
  1199. }, options: ProcessingOptions): string;
  1200. }
  1201. }
  1202. declare module "babylonjs/Engines/Processors/Expressions/shaderDefineExpression" {
  1203. /** @hidden */
  1204. export class ShaderDefineExpression {
  1205. isTrue(preprocessors: {
  1206. [key: string]: string;
  1207. }): boolean;
  1208. }
  1209. }
  1210. declare module "babylonjs/Engines/Processors/shaderCodeTestNode" {
  1211. import { ShaderCodeNode } from "babylonjs/Engines/Processors/shaderCodeNode";
  1212. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1213. /** @hidden */
  1214. export class ShaderCodeTestNode extends ShaderCodeNode {
  1215. testExpression: ShaderDefineExpression;
  1216. isValid(preprocessors: {
  1217. [key: string]: string;
  1218. }): boolean;
  1219. }
  1220. }
  1221. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineIsDefinedOperator" {
  1222. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1223. /** @hidden */
  1224. export class ShaderDefineIsDefinedOperator extends ShaderDefineExpression {
  1225. define: string;
  1226. not: boolean;
  1227. constructor(define: string, not?: boolean);
  1228. isTrue(preprocessors: {
  1229. [key: string]: string;
  1230. }): boolean;
  1231. }
  1232. }
  1233. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineOrOperator" {
  1234. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1235. /** @hidden */
  1236. export class ShaderDefineOrOperator extends ShaderDefineExpression {
  1237. leftOperand: ShaderDefineExpression;
  1238. rightOperand: ShaderDefineExpression;
  1239. isTrue(preprocessors: {
  1240. [key: string]: string;
  1241. }): boolean;
  1242. }
  1243. }
  1244. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineAndOperator" {
  1245. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1246. /** @hidden */
  1247. export class ShaderDefineAndOperator extends ShaderDefineExpression {
  1248. leftOperand: ShaderDefineExpression;
  1249. rightOperand: ShaderDefineExpression;
  1250. isTrue(preprocessors: {
  1251. [key: string]: string;
  1252. }): boolean;
  1253. }
  1254. }
  1255. declare module "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineArithmeticOperator" {
  1256. import { ShaderDefineExpression } from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  1257. /** @hidden */
  1258. export class ShaderDefineArithmeticOperator extends ShaderDefineExpression {
  1259. define: string;
  1260. operand: string;
  1261. testValue: string;
  1262. constructor(define: string, operand: string, testValue: string);
  1263. isTrue(preprocessors: {
  1264. [key: string]: string;
  1265. }): boolean;
  1266. }
  1267. }
  1268. declare module "babylonjs/Offline/IOfflineProvider" {
  1269. /**
  1270. * Class used to enable access to offline support
  1271. * @see http://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  1272. */
  1273. export interface IOfflineProvider {
  1274. /**
  1275. * Gets a boolean indicating if scene must be saved in the database
  1276. */
  1277. enableSceneOffline: boolean;
  1278. /**
  1279. * Gets a boolean indicating if textures must be saved in the database
  1280. */
  1281. enableTexturesOffline: boolean;
  1282. /**
  1283. * Open the offline support and make it available
  1284. * @param successCallback defines the callback to call on success
  1285. * @param errorCallback defines the callback to call on error
  1286. */
  1287. open(successCallback: () => void, errorCallback: () => void): void;
  1288. /**
  1289. * Loads an image from the offline support
  1290. * @param url defines the url to load from
  1291. * @param image defines the target DOM image
  1292. */
  1293. loadImage(url: string, image: HTMLImageElement): void;
  1294. /**
  1295. * Loads a file from offline support
  1296. * @param url defines the URL to load from
  1297. * @param sceneLoaded defines a callback to call on success
  1298. * @param progressCallBack defines a callback to call when progress changed
  1299. * @param errorCallback defines a callback to call on error
  1300. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  1301. */
  1302. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  1303. }
  1304. }
  1305. declare module "babylonjs/Misc/filesInputStore" {
  1306. /**
  1307. * Class used to help managing file picking and drag'n'drop
  1308. * File Storage
  1309. */
  1310. export class FilesInputStore {
  1311. /**
  1312. * List of files ready to be loaded
  1313. */
  1314. static FilesToLoad: {
  1315. [key: string]: File;
  1316. };
  1317. }
  1318. }
  1319. declare module "babylonjs/Misc/retryStrategy" {
  1320. import { WebRequest } from "babylonjs/Misc/webRequest";
  1321. /**
  1322. * Class used to define a retry strategy when error happens while loading assets
  1323. */
  1324. export class RetryStrategy {
  1325. /**
  1326. * Function used to defines an exponential back off strategy
  1327. * @param maxRetries defines the maximum number of retries (3 by default)
  1328. * @param baseInterval defines the interval between retries
  1329. * @returns the strategy function to use
  1330. */
  1331. static ExponentialBackoff(maxRetries?: number, baseInterval?: number): (url: string, request: WebRequest, retryIndex: number) => number;
  1332. }
  1333. }
  1334. declare module "babylonjs/Misc/baseError" {
  1335. /**
  1336. * @ignore
  1337. * Application error to support additional information when loading a file
  1338. */
  1339. export abstract class BaseError extends Error {
  1340. protected static _setPrototypeOf: (o: any, proto: object | null) => any;
  1341. }
  1342. }
  1343. declare module "babylonjs/Misc/fileTools" {
  1344. import { WebRequest } from "babylonjs/Misc/webRequest";
  1345. import { Nullable } from "babylonjs/types";
  1346. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  1347. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  1348. import { BaseError } from "babylonjs/Misc/baseError";
  1349. /** @ignore */
  1350. export class LoadFileError extends BaseError {
  1351. request?: WebRequest;
  1352. file?: File;
  1353. /**
  1354. * Creates a new LoadFileError
  1355. * @param message defines the message of the error
  1356. * @param request defines the optional web request
  1357. * @param file defines the optional file
  1358. */
  1359. constructor(message: string, object?: WebRequest | File);
  1360. }
  1361. /** @ignore */
  1362. export class RequestFileError extends BaseError {
  1363. request: WebRequest;
  1364. /**
  1365. * Creates a new LoadFileError
  1366. * @param message defines the message of the error
  1367. * @param request defines the optional web request
  1368. */
  1369. constructor(message: string, request: WebRequest);
  1370. }
  1371. /** @ignore */
  1372. export class ReadFileError extends BaseError {
  1373. file: File;
  1374. /**
  1375. * Creates a new ReadFileError
  1376. * @param message defines the message of the error
  1377. * @param file defines the optional file
  1378. */
  1379. constructor(message: string, file: File);
  1380. }
  1381. /**
  1382. * @hidden
  1383. */
  1384. export class FileTools {
  1385. /**
  1386. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  1387. */
  1388. static DefaultRetryStrategy: (url: string, request: WebRequest, retryIndex: number) => number;
  1389. /**
  1390. * Gets or sets the base URL to use to load assets
  1391. */
  1392. static BaseUrl: string;
  1393. /**
  1394. * Default behaviour for cors in the application.
  1395. * It can be a string if the expected behavior is identical in the entire app.
  1396. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  1397. */
  1398. static CorsBehavior: string | ((url: string | string[]) => string);
  1399. /**
  1400. * Gets or sets a function used to pre-process url before using them to load assets
  1401. */
  1402. static PreprocessUrl: (url: string) => string;
  1403. /**
  1404. * Removes unwanted characters from an url
  1405. * @param url defines the url to clean
  1406. * @returns the cleaned url
  1407. */
  1408. private static _CleanUrl;
  1409. /**
  1410. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  1411. * @param url define the url we are trying
  1412. * @param element define the dom element where to configure the cors policy
  1413. */
  1414. static SetCorsBehavior(url: string | string[], element: {
  1415. crossOrigin: string | null;
  1416. }): void;
  1417. /**
  1418. * Loads an image as an HTMLImageElement.
  1419. * @param input url string, ArrayBuffer, or Blob to load
  1420. * @param onLoad callback called when the image successfully loads
  1421. * @param onError callback called when the image fails to load
  1422. * @param offlineProvider offline provider for caching
  1423. * @param mimeType optional mime type
  1424. * @returns the HTMLImageElement of the loaded image
  1425. */
  1426. static LoadImage(input: string | ArrayBuffer | ArrayBufferView | Blob, onLoad: (img: HTMLImageElement | ImageBitmap) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>, mimeType?: string): Nullable<HTMLImageElement>;
  1427. /**
  1428. * Reads a file from a File object
  1429. * @param file defines the file to load
  1430. * @param onSuccess defines the callback to call when data is loaded
  1431. * @param onProgress defines the callback to call during loading process
  1432. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  1433. * @param onError defines the callback to call when an error occurs
  1434. * @returns a file request object
  1435. */
  1436. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  1437. /**
  1438. * Loads a file from a url
  1439. * @param url url to load
  1440. * @param onSuccess callback called when the file successfully loads
  1441. * @param onProgress callback called while file is loading (if the server supports this mode)
  1442. * @param offlineProvider defines the offline provider for caching
  1443. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  1444. * @param onError callback called when the file fails to load
  1445. * @returns a file request object
  1446. */
  1447. static LoadFile(url: string, onSuccess: (data: string | ArrayBuffer, responseURL?: string) => void, onProgress?: (ev: ProgressEvent) => void, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean, onError?: (request?: WebRequest, exception?: LoadFileError) => void): IFileRequest;
  1448. /**
  1449. * Loads a file
  1450. * @param url url to load
  1451. * @param onSuccess callback called when the file successfully loads
  1452. * @param onProgress callback called while file is loading (if the server supports this mode)
  1453. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  1454. * @param onError callback called when the file fails to load
  1455. * @param onOpened callback called when the web request is opened
  1456. * @returns a file request object
  1457. */
  1458. static RequestFile(url: string, onSuccess: (data: string | ArrayBuffer, request?: WebRequest) => void, onProgress?: (event: ProgressEvent) => void, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean, onError?: (error: RequestFileError) => void, onOpened?: (request: WebRequest) => void): IFileRequest;
  1459. /**
  1460. * Checks if the loaded document was accessed via `file:`-Protocol.
  1461. * @returns boolean
  1462. */
  1463. static IsFileURL(): boolean;
  1464. }
  1465. }
  1466. declare module "babylonjs/Engines/Processors/shaderProcessor" {
  1467. import { ProcessingOptions } from "babylonjs/Engines/Processors/shaderProcessingOptions";
  1468. /** @hidden */
  1469. export class ShaderProcessor {
  1470. static Process(sourceCode: string, options: ProcessingOptions, callback: (migratedCode: string) => void): void;
  1471. private static _ProcessPrecision;
  1472. private static _ExtractOperation;
  1473. private static _BuildSubExpression;
  1474. private static _BuildExpression;
  1475. private static _MoveCursorWithinIf;
  1476. private static _MoveCursor;
  1477. private static _EvaluatePreProcessors;
  1478. private static _PreparePreProcessors;
  1479. private static _ProcessShaderConversion;
  1480. private static _ProcessIncludes;
  1481. }
  1482. }
  1483. declare module "babylonjs/Maths/math.like" {
  1484. import { float, int, DeepImmutable } from "babylonjs/types";
  1485. /**
  1486. * @hidden
  1487. */
  1488. export interface IColor4Like {
  1489. r: float;
  1490. g: float;
  1491. b: float;
  1492. a: float;
  1493. }
  1494. /**
  1495. * @hidden
  1496. */
  1497. export interface IColor3Like {
  1498. r: float;
  1499. g: float;
  1500. b: float;
  1501. }
  1502. /**
  1503. * @hidden
  1504. */
  1505. export interface IVector4Like {
  1506. x: float;
  1507. y: float;
  1508. z: float;
  1509. w: float;
  1510. }
  1511. /**
  1512. * @hidden
  1513. */
  1514. export interface IVector3Like {
  1515. x: float;
  1516. y: float;
  1517. z: float;
  1518. }
  1519. /**
  1520. * @hidden
  1521. */
  1522. export interface IVector2Like {
  1523. x: float;
  1524. y: float;
  1525. }
  1526. /**
  1527. * @hidden
  1528. */
  1529. export interface IMatrixLike {
  1530. toArray(): DeepImmutable<Float32Array>;
  1531. updateFlag: int;
  1532. }
  1533. /**
  1534. * @hidden
  1535. */
  1536. export interface IViewportLike {
  1537. x: float;
  1538. y: float;
  1539. width: float;
  1540. height: float;
  1541. }
  1542. /**
  1543. * @hidden
  1544. */
  1545. export interface IPlaneLike {
  1546. normal: IVector3Like;
  1547. d: float;
  1548. normalize(): void;
  1549. }
  1550. }
  1551. declare module "babylonjs/Materials/iEffectFallbacks" {
  1552. import { Effect } from "babylonjs/Materials/effect";
  1553. /**
  1554. * Interface used to define common properties for effect fallbacks
  1555. */
  1556. export interface IEffectFallbacks {
  1557. /**
  1558. * Removes the defines that should be removed when falling back.
  1559. * @param currentDefines defines the current define statements for the shader.
  1560. * @param effect defines the current effect we try to compile
  1561. * @returns The resulting defines with defines of the current rank removed.
  1562. */
  1563. reduce(currentDefines: string, effect: Effect): string;
  1564. /**
  1565. * Removes the fallback from the bound mesh.
  1566. */
  1567. unBindMesh(): void;
  1568. /**
  1569. * Checks to see if more fallbacks are still availible.
  1570. */
  1571. hasMoreFallbacks: boolean;
  1572. }
  1573. }
  1574. declare module "babylonjs/Misc/andOrNotEvaluator" {
  1575. /**
  1576. * Class used to evalaute queries containing `and` and `or` operators
  1577. */
  1578. export class AndOrNotEvaluator {
  1579. /**
  1580. * Evaluate a query
  1581. * @param query defines the query to evaluate
  1582. * @param evaluateCallback defines the callback used to filter result
  1583. * @returns true if the query matches
  1584. */
  1585. static Eval(query: string, evaluateCallback: (val: any) => boolean): boolean;
  1586. private static _HandleParenthesisContent;
  1587. private static _SimplifyNegation;
  1588. }
  1589. }
  1590. declare module "babylonjs/Misc/tags" {
  1591. /**
  1592. * Class used to store custom tags
  1593. */
  1594. export class Tags {
  1595. /**
  1596. * Adds support for tags on the given object
  1597. * @param obj defines the object to use
  1598. */
  1599. static EnableFor(obj: any): void;
  1600. /**
  1601. * Removes tags support
  1602. * @param obj defines the object to use
  1603. */
  1604. static DisableFor(obj: any): void;
  1605. /**
  1606. * Gets a boolean indicating if the given object has tags
  1607. * @param obj defines the object to use
  1608. * @returns a boolean
  1609. */
  1610. static HasTags(obj: any): boolean;
  1611. /**
  1612. * Gets the tags available on a given object
  1613. * @param obj defines the object to use
  1614. * @param asString defines if the tags must be returned as a string instead of an array of strings
  1615. * @returns the tags
  1616. */
  1617. static GetTags(obj: any, asString?: boolean): any;
  1618. /**
  1619. * Adds tags to an object
  1620. * @param obj defines the object to use
  1621. * @param tagsString defines the tag string. The tags 'true' and 'false' are reserved and cannot be used as tags.
  1622. * A tag cannot start with '||', '&&', and '!'. It cannot contain whitespaces
  1623. */
  1624. static AddTagsTo(obj: any, tagsString: string): void;
  1625. /**
  1626. * @hidden
  1627. */
  1628. static _AddTagTo(obj: any, tag: string): void;
  1629. /**
  1630. * Removes specific tags from a specific object
  1631. * @param obj defines the object to use
  1632. * @param tagsString defines the tags to remove
  1633. */
  1634. static RemoveTagsFrom(obj: any, tagsString: string): void;
  1635. /**
  1636. * @hidden
  1637. */
  1638. static _RemoveTagFrom(obj: any, tag: string): void;
  1639. /**
  1640. * Defines if tags hosted on an object match a given query
  1641. * @param obj defines the object to use
  1642. * @param tagsQuery defines the tag query
  1643. * @returns a boolean
  1644. */
  1645. static MatchesQuery(obj: any, tagsQuery: string): boolean;
  1646. }
  1647. }
  1648. declare module "babylonjs/Maths/math.scalar" {
  1649. /**
  1650. * Scalar computation library
  1651. */
  1652. export class Scalar {
  1653. /**
  1654. * Two pi constants convenient for computation.
  1655. */
  1656. static TwoPi: number;
  1657. /**
  1658. * Boolean : true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  1659. * @param a number
  1660. * @param b number
  1661. * @param epsilon (default = 1.401298E-45)
  1662. * @returns true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  1663. */
  1664. static WithinEpsilon(a: number, b: number, epsilon?: number): boolean;
  1665. /**
  1666. * Returns a string : the upper case translation of the number i to hexadecimal.
  1667. * @param i number
  1668. * @returns the upper case translation of the number i to hexadecimal.
  1669. */
  1670. static ToHex(i: number): string;
  1671. /**
  1672. * Returns -1 if value is negative and +1 is value is positive.
  1673. * @param value the value
  1674. * @returns the value itself if it's equal to zero.
  1675. */
  1676. static Sign(value: number): number;
  1677. /**
  1678. * Returns the value itself if it's between min and max.
  1679. * Returns min if the value is lower than min.
  1680. * Returns max if the value is greater than max.
  1681. * @param value the value to clmap
  1682. * @param min the min value to clamp to (default: 0)
  1683. * @param max the max value to clamp to (default: 1)
  1684. * @returns the clamped value
  1685. */
  1686. static Clamp(value: number, min?: number, max?: number): number;
  1687. /**
  1688. * the log2 of value.
  1689. * @param value the value to compute log2 of
  1690. * @returns the log2 of value.
  1691. */
  1692. static Log2(value: number): number;
  1693. /**
  1694. * Loops the value, so that it is never larger than length and never smaller than 0.
  1695. *
  1696. * This is similar to the modulo operator but it works with floating point numbers.
  1697. * For example, using 3.0 for t and 2.5 for length, the result would be 0.5.
  1698. * With t = 5 and length = 2.5, the result would be 0.0.
  1699. * Note, however, that the behaviour is not defined for negative numbers as it is for the modulo operator
  1700. * @param value the value
  1701. * @param length the length
  1702. * @returns the looped value
  1703. */
  1704. static Repeat(value: number, length: number): number;
  1705. /**
  1706. * Normalize the value between 0.0 and 1.0 using min and max values
  1707. * @param value value to normalize
  1708. * @param min max to normalize between
  1709. * @param max min to normalize between
  1710. * @returns the normalized value
  1711. */
  1712. static Normalize(value: number, min: number, max: number): number;
  1713. /**
  1714. * Denormalize the value from 0.0 and 1.0 using min and max values
  1715. * @param normalized value to denormalize
  1716. * @param min max to denormalize between
  1717. * @param max min to denormalize between
  1718. * @returns the denormalized value
  1719. */
  1720. static Denormalize(normalized: number, min: number, max: number): number;
  1721. /**
  1722. * Calculates the shortest difference between two given angles given in degrees.
  1723. * @param current current angle in degrees
  1724. * @param target target angle in degrees
  1725. * @returns the delta
  1726. */
  1727. static DeltaAngle(current: number, target: number): number;
  1728. /**
  1729. * PingPongs the value t, so that it is never larger than length and never smaller than 0.
  1730. * @param tx value
  1731. * @param length length
  1732. * @returns The returned value will move back and forth between 0 and length
  1733. */
  1734. static PingPong(tx: number, length: number): number;
  1735. /**
  1736. * Interpolates between min and max with smoothing at the limits.
  1737. *
  1738. * This function interpolates between min and max in a similar way to Lerp. However, the interpolation will gradually speed up
  1739. * from the start and slow down toward the end. This is useful for creating natural-looking animation, fading and other transitions.
  1740. * @param from from
  1741. * @param to to
  1742. * @param tx value
  1743. * @returns the smooth stepped value
  1744. */
  1745. static SmoothStep(from: number, to: number, tx: number): number;
  1746. /**
  1747. * Moves a value current towards target.
  1748. *
  1749. * This is essentially the same as Mathf.Lerp but instead the function will ensure that the speed never exceeds maxDelta.
  1750. * Negative values of maxDelta pushes the value away from target.
  1751. * @param current current value
  1752. * @param target target value
  1753. * @param maxDelta max distance to move
  1754. * @returns resulting value
  1755. */
  1756. static MoveTowards(current: number, target: number, maxDelta: number): number;
  1757. /**
  1758. * Same as MoveTowards but makes sure the values interpolate correctly when they wrap around 360 degrees.
  1759. *
  1760. * Variables current and target are assumed to be in degrees. For optimization reasons, negative values of maxDelta
  1761. * are not supported and may cause oscillation. To push current away from a target angle, add 180 to that angle instead.
  1762. * @param current current value
  1763. * @param target target value
  1764. * @param maxDelta max distance to move
  1765. * @returns resulting angle
  1766. */
  1767. static MoveTowardsAngle(current: number, target: number, maxDelta: number): number;
  1768. /**
  1769. * Creates a new scalar with values linearly interpolated of "amount" between the start scalar and the end scalar.
  1770. * @param start start value
  1771. * @param end target value
  1772. * @param amount amount to lerp between
  1773. * @returns the lerped value
  1774. */
  1775. static Lerp(start: number, end: number, amount: number): number;
  1776. /**
  1777. * Same as Lerp but makes sure the values interpolate correctly when they wrap around 360 degrees.
  1778. * The parameter t is clamped to the range [0, 1]. Variables a and b are assumed to be in degrees.
  1779. * @param start start value
  1780. * @param end target value
  1781. * @param amount amount to lerp between
  1782. * @returns the lerped value
  1783. */
  1784. static LerpAngle(start: number, end: number, amount: number): number;
  1785. /**
  1786. * Calculates the linear parameter t that produces the interpolant value within the range [a, b].
  1787. * @param a start value
  1788. * @param b target value
  1789. * @param value value between a and b
  1790. * @returns the inverseLerp value
  1791. */
  1792. static InverseLerp(a: number, b: number, value: number): number;
  1793. /**
  1794. * Returns a new scalar located for "amount" (float) on the Hermite spline defined by the scalars "value1", "value3", "tangent1", "tangent2".
  1795. * @see http://mathworld.wolfram.com/HermitePolynomial.html
  1796. * @param value1 spline value
  1797. * @param tangent1 spline value
  1798. * @param value2 spline value
  1799. * @param tangent2 spline value
  1800. * @param amount input value
  1801. * @returns hermite result
  1802. */
  1803. static Hermite(value1: number, tangent1: number, value2: number, tangent2: number, amount: number): number;
  1804. /**
  1805. * Returns a random float number between and min and max values
  1806. * @param min min value of random
  1807. * @param max max value of random
  1808. * @returns random value
  1809. */
  1810. static RandomRange(min: number, max: number): number;
  1811. /**
  1812. * This function returns percentage of a number in a given range.
  1813. *
  1814. * RangeToPercent(40,20,60) will return 0.5 (50%)
  1815. * RangeToPercent(34,0,100) will return 0.34 (34%)
  1816. * @param number to convert to percentage
  1817. * @param min min range
  1818. * @param max max range
  1819. * @returns the percentage
  1820. */
  1821. static RangeToPercent(number: number, min: number, max: number): number;
  1822. /**
  1823. * This function returns number that corresponds to the percentage in a given range.
  1824. *
  1825. * PercentToRange(0.34,0,100) will return 34.
  1826. * @param percent to convert to number
  1827. * @param min min range
  1828. * @param max max range
  1829. * @returns the number
  1830. */
  1831. static PercentToRange(percent: number, min: number, max: number): number;
  1832. /**
  1833. * Returns the angle converted to equivalent value between -Math.PI and Math.PI radians.
  1834. * @param angle The angle to normalize in radian.
  1835. * @return The converted angle.
  1836. */
  1837. static NormalizeRadians(angle: number): number;
  1838. }
  1839. }
  1840. declare module "babylonjs/Maths/math.constants" {
  1841. /**
  1842. * Constant used to convert a value to gamma space
  1843. * @ignorenaming
  1844. */
  1845. export const ToGammaSpace: number;
  1846. /**
  1847. * Constant used to convert a value to linear space
  1848. * @ignorenaming
  1849. */
  1850. export const ToLinearSpace = 2.2;
  1851. /**
  1852. * Constant used to define the minimal number value in Babylon.js
  1853. * @ignorenaming
  1854. */
  1855. let Epsilon: number;
  1856. export { Epsilon };
  1857. }
  1858. declare module "babylonjs/Maths/math.viewport" {
  1859. /**
  1860. * Class used to represent a viewport on screen
  1861. */
  1862. export class Viewport {
  1863. /** viewport left coordinate */
  1864. x: number;
  1865. /** viewport top coordinate */
  1866. y: number;
  1867. /**viewport width */
  1868. width: number;
  1869. /** viewport height */
  1870. height: number;
  1871. /**
  1872. * Creates a Viewport object located at (x, y) and sized (width, height)
  1873. * @param x defines viewport left coordinate
  1874. * @param y defines viewport top coordinate
  1875. * @param width defines the viewport width
  1876. * @param height defines the viewport height
  1877. */
  1878. constructor(
  1879. /** viewport left coordinate */
  1880. x: number,
  1881. /** viewport top coordinate */
  1882. y: number,
  1883. /**viewport width */
  1884. width: number,
  1885. /** viewport height */
  1886. height: number);
  1887. /**
  1888. * Creates a new viewport using absolute sizing (from 0-> width, 0-> height instead of 0->1)
  1889. * @param renderWidth defines the rendering width
  1890. * @param renderHeight defines the rendering height
  1891. * @returns a new Viewport
  1892. */
  1893. toGlobal(renderWidth: number, renderHeight: number): Viewport;
  1894. /**
  1895. * Stores absolute viewport value into a target viewport (from 0-> width, 0-> height instead of 0->1)
  1896. * @param renderWidth defines the rendering width
  1897. * @param renderHeight defines the rendering height
  1898. * @param ref defines the target viewport
  1899. * @returns the current viewport
  1900. */
  1901. toGlobalToRef(renderWidth: number, renderHeight: number, ref: Viewport): Viewport;
  1902. /**
  1903. * Returns a new Viewport copied from the current one
  1904. * @returns a new Viewport
  1905. */
  1906. clone(): Viewport;
  1907. }
  1908. }
  1909. declare module "babylonjs/Misc/arrayTools" {
  1910. /**
  1911. * Class containing a set of static utilities functions for arrays.
  1912. */
  1913. export class ArrayTools {
  1914. /**
  1915. * Returns an array of the given size filled with element built from the given constructor and the paramters
  1916. * @param size the number of element to construct and put in the array
  1917. * @param itemBuilder a callback responsible for creating new instance of item. Called once per array entry.
  1918. * @returns a new array filled with new objects
  1919. */
  1920. static BuildArray<T>(size: number, itemBuilder: () => T): Array<T>;
  1921. }
  1922. }
  1923. declare module "babylonjs/Maths/math.vector" {
  1924. import { Viewport } from "babylonjs/Maths/math.viewport";
  1925. import { DeepImmutable, Nullable, FloatArray, float } from "babylonjs/types";
  1926. import { IPlaneLike } from "babylonjs/Maths/math.like";
  1927. /**
  1928. * Class representing a vector containing 2 coordinates
  1929. */
  1930. export class Vector2 {
  1931. /** defines the first coordinate */
  1932. x: number;
  1933. /** defines the second coordinate */
  1934. y: number;
  1935. /**
  1936. * Creates a new Vector2 from the given x and y coordinates
  1937. * @param x defines the first coordinate
  1938. * @param y defines the second coordinate
  1939. */
  1940. constructor(
  1941. /** defines the first coordinate */
  1942. x?: number,
  1943. /** defines the second coordinate */
  1944. y?: number);
  1945. /**
  1946. * Gets a string with the Vector2 coordinates
  1947. * @returns a string with the Vector2 coordinates
  1948. */
  1949. toString(): string;
  1950. /**
  1951. * Gets class name
  1952. * @returns the string "Vector2"
  1953. */
  1954. getClassName(): string;
  1955. /**
  1956. * Gets current vector hash code
  1957. * @returns the Vector2 hash code as a number
  1958. */
  1959. getHashCode(): number;
  1960. /**
  1961. * Sets the Vector2 coordinates in the given array or Float32Array from the given index.
  1962. * @param array defines the source array
  1963. * @param index defines the offset in source array
  1964. * @returns the current Vector2
  1965. */
  1966. toArray(array: FloatArray, index?: number): Vector2;
  1967. /**
  1968. * Copy the current vector to an array
  1969. * @returns a new array with 2 elements: the Vector2 coordinates.
  1970. */
  1971. asArray(): number[];
  1972. /**
  1973. * Sets the Vector2 coordinates with the given Vector2 coordinates
  1974. * @param source defines the source Vector2
  1975. * @returns the current updated Vector2
  1976. */
  1977. copyFrom(source: DeepImmutable<Vector2>): Vector2;
  1978. /**
  1979. * Sets the Vector2 coordinates with the given floats
  1980. * @param x defines the first coordinate
  1981. * @param y defines the second coordinate
  1982. * @returns the current updated Vector2
  1983. */
  1984. copyFromFloats(x: number, y: number): Vector2;
  1985. /**
  1986. * Sets the Vector2 coordinates with the given floats
  1987. * @param x defines the first coordinate
  1988. * @param y defines the second coordinate
  1989. * @returns the current updated Vector2
  1990. */
  1991. set(x: number, y: number): Vector2;
  1992. /**
  1993. * Add another vector with the current one
  1994. * @param otherVector defines the other vector
  1995. * @returns a new Vector2 set with the addition of the current Vector2 and the given one coordinates
  1996. */
  1997. add(otherVector: DeepImmutable<Vector2>): Vector2;
  1998. /**
  1999. * Sets the "result" coordinates with the addition of the current Vector2 and the given one coordinates
  2000. * @param otherVector defines the other vector
  2001. * @param result defines the target vector
  2002. * @returns the unmodified current Vector2
  2003. */
  2004. addToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2005. /**
  2006. * Set the Vector2 coordinates by adding the given Vector2 coordinates
  2007. * @param otherVector defines the other vector
  2008. * @returns the current updated Vector2
  2009. */
  2010. addInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2011. /**
  2012. * Gets a new Vector2 by adding the current Vector2 coordinates to the given Vector3 x, y coordinates
  2013. * @param otherVector defines the other vector
  2014. * @returns a new Vector2
  2015. */
  2016. addVector3(otherVector: Vector3): Vector2;
  2017. /**
  2018. * Gets a new Vector2 set with the subtracted coordinates of the given one from the current Vector2
  2019. * @param otherVector defines the other vector
  2020. * @returns a new Vector2
  2021. */
  2022. subtract(otherVector: Vector2): Vector2;
  2023. /**
  2024. * Sets the "result" coordinates with the subtraction of the given one from the current Vector2 coordinates.
  2025. * @param otherVector defines the other vector
  2026. * @param result defines the target vector
  2027. * @returns the unmodified current Vector2
  2028. */
  2029. subtractToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2030. /**
  2031. * Sets the current Vector2 coordinates by subtracting from it the given one coordinates
  2032. * @param otherVector defines the other vector
  2033. * @returns the current updated Vector2
  2034. */
  2035. subtractInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2036. /**
  2037. * Multiplies in place the current Vector2 coordinates by the given ones
  2038. * @param otherVector defines the other vector
  2039. * @returns the current updated Vector2
  2040. */
  2041. multiplyInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2042. /**
  2043. * Returns a new Vector2 set with the multiplication of the current Vector2 and the given one coordinates
  2044. * @param otherVector defines the other vector
  2045. * @returns a new Vector2
  2046. */
  2047. multiply(otherVector: DeepImmutable<Vector2>): Vector2;
  2048. /**
  2049. * Sets "result" coordinates with the multiplication of the current Vector2 and the given one coordinates
  2050. * @param otherVector defines the other vector
  2051. * @param result defines the target vector
  2052. * @returns the unmodified current Vector2
  2053. */
  2054. multiplyToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2055. /**
  2056. * Gets a new Vector2 set with the Vector2 coordinates multiplied by the given floats
  2057. * @param x defines the first coordinate
  2058. * @param y defines the second coordinate
  2059. * @returns a new Vector2
  2060. */
  2061. multiplyByFloats(x: number, y: number): Vector2;
  2062. /**
  2063. * Returns a new Vector2 set with the Vector2 coordinates divided by the given one coordinates
  2064. * @param otherVector defines the other vector
  2065. * @returns a new Vector2
  2066. */
  2067. divide(otherVector: Vector2): Vector2;
  2068. /**
  2069. * Sets the "result" coordinates with the Vector2 divided by the given one coordinates
  2070. * @param otherVector defines the other vector
  2071. * @param result defines the target vector
  2072. * @returns the unmodified current Vector2
  2073. */
  2074. divideToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  2075. /**
  2076. * Divides the current Vector2 coordinates by the given ones
  2077. * @param otherVector defines the other vector
  2078. * @returns the current updated Vector2
  2079. */
  2080. divideInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  2081. /**
  2082. * Gets a new Vector2 with current Vector2 negated coordinates
  2083. * @returns a new Vector2
  2084. */
  2085. negate(): Vector2;
  2086. /**
  2087. * Multiply the Vector2 coordinates by scale
  2088. * @param scale defines the scaling factor
  2089. * @returns the current updated Vector2
  2090. */
  2091. scaleInPlace(scale: number): Vector2;
  2092. /**
  2093. * Returns a new Vector2 scaled by "scale" from the current Vector2
  2094. * @param scale defines the scaling factor
  2095. * @returns a new Vector2
  2096. */
  2097. scale(scale: number): Vector2;
  2098. /**
  2099. * Scale the current Vector2 values by a factor to a given Vector2
  2100. * @param scale defines the scale factor
  2101. * @param result defines the Vector2 object where to store the result
  2102. * @returns the unmodified current Vector2
  2103. */
  2104. scaleToRef(scale: number, result: Vector2): Vector2;
  2105. /**
  2106. * Scale the current Vector2 values by a factor and add the result to a given Vector2
  2107. * @param scale defines the scale factor
  2108. * @param result defines the Vector2 object where to store the result
  2109. * @returns the unmodified current Vector2
  2110. */
  2111. scaleAndAddToRef(scale: number, result: Vector2): Vector2;
  2112. /**
  2113. * Gets a boolean if two vectors are equals
  2114. * @param otherVector defines the other vector
  2115. * @returns true if the given vector coordinates strictly equal the current Vector2 ones
  2116. */
  2117. equals(otherVector: DeepImmutable<Vector2>): boolean;
  2118. /**
  2119. * Gets a boolean if two vectors are equals (using an epsilon value)
  2120. * @param otherVector defines the other vector
  2121. * @param epsilon defines the minimal distance to consider equality
  2122. * @returns true if the given vector coordinates are close to the current ones by a distance of epsilon.
  2123. */
  2124. equalsWithEpsilon(otherVector: DeepImmutable<Vector2>, epsilon?: number): boolean;
  2125. /**
  2126. * Gets a new Vector2 from current Vector2 floored values
  2127. * @returns a new Vector2
  2128. */
  2129. floor(): Vector2;
  2130. /**
  2131. * Gets a new Vector2 from current Vector2 floored values
  2132. * @returns a new Vector2
  2133. */
  2134. fract(): Vector2;
  2135. /**
  2136. * Gets the length of the vector
  2137. * @returns the vector length (float)
  2138. */
  2139. length(): number;
  2140. /**
  2141. * Gets the vector squared length
  2142. * @returns the vector squared length (float)
  2143. */
  2144. lengthSquared(): number;
  2145. /**
  2146. * Normalize the vector
  2147. * @returns the current updated Vector2
  2148. */
  2149. normalize(): Vector2;
  2150. /**
  2151. * Gets a new Vector2 copied from the Vector2
  2152. * @returns a new Vector2
  2153. */
  2154. clone(): Vector2;
  2155. /**
  2156. * Gets a new Vector2(0, 0)
  2157. * @returns a new Vector2
  2158. */
  2159. static Zero(): Vector2;
  2160. /**
  2161. * Gets a new Vector2(1, 1)
  2162. * @returns a new Vector2
  2163. */
  2164. static One(): Vector2;
  2165. /**
  2166. * Gets a new Vector2 set from the given index element of the given array
  2167. * @param array defines the data source
  2168. * @param offset defines the offset in the data source
  2169. * @returns a new Vector2
  2170. */
  2171. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector2;
  2172. /**
  2173. * Sets "result" from the given index element of the given array
  2174. * @param array defines the data source
  2175. * @param offset defines the offset in the data source
  2176. * @param result defines the target vector
  2177. */
  2178. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector2): void;
  2179. /**
  2180. * Gets a new Vector2 located for "amount" (float) on the CatmullRom spline defined by the given four Vector2
  2181. * @param value1 defines 1st point of control
  2182. * @param value2 defines 2nd point of control
  2183. * @param value3 defines 3rd point of control
  2184. * @param value4 defines 4th point of control
  2185. * @param amount defines the interpolation factor
  2186. * @returns a new Vector2
  2187. */
  2188. static CatmullRom(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, value3: DeepImmutable<Vector2>, value4: DeepImmutable<Vector2>, amount: number): Vector2;
  2189. /**
  2190. * Returns a new Vector2 set with same the coordinates than "value" ones if the vector "value" is in the square defined by "min" and "max".
  2191. * If a coordinate of "value" is lower than "min" coordinates, the returned Vector2 is given this "min" coordinate.
  2192. * If a coordinate of "value" is greater than "max" coordinates, the returned Vector2 is given this "max" coordinate
  2193. * @param value defines the value to clamp
  2194. * @param min defines the lower limit
  2195. * @param max defines the upper limit
  2196. * @returns a new Vector2
  2197. */
  2198. static Clamp(value: DeepImmutable<Vector2>, min: DeepImmutable<Vector2>, max: DeepImmutable<Vector2>): Vector2;
  2199. /**
  2200. * Returns a new Vector2 located for "amount" (float) on the Hermite spline defined by the vectors "value1", "value3", "tangent1", "tangent2"
  2201. * @param value1 defines the 1st control point
  2202. * @param tangent1 defines the outgoing tangent
  2203. * @param value2 defines the 2nd control point
  2204. * @param tangent2 defines the incoming tangent
  2205. * @param amount defines the interpolation factor
  2206. * @returns a new Vector2
  2207. */
  2208. static Hermite(value1: DeepImmutable<Vector2>, tangent1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, tangent2: DeepImmutable<Vector2>, amount: number): Vector2;
  2209. /**
  2210. * Returns a new Vector2 located for "amount" (float) on the linear interpolation between the vector "start" adn the vector "end".
  2211. * @param start defines the start vector
  2212. * @param end defines the end vector
  2213. * @param amount defines the interpolation factor
  2214. * @returns a new Vector2
  2215. */
  2216. static Lerp(start: DeepImmutable<Vector2>, end: DeepImmutable<Vector2>, amount: number): Vector2;
  2217. /**
  2218. * Gets the dot product of the vector "left" and the vector "right"
  2219. * @param left defines first vector
  2220. * @param right defines second vector
  2221. * @returns the dot product (float)
  2222. */
  2223. static Dot(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): number;
  2224. /**
  2225. * Returns a new Vector2 equal to the normalized given vector
  2226. * @param vector defines the vector to normalize
  2227. * @returns a new Vector2
  2228. */
  2229. static Normalize(vector: DeepImmutable<Vector2>): Vector2;
  2230. /**
  2231. * Gets a new Vector2 set with the minimal coordinate values from the "left" and "right" vectors
  2232. * @param left defines 1st vector
  2233. * @param right defines 2nd vector
  2234. * @returns a new Vector2
  2235. */
  2236. static Minimize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  2237. /**
  2238. * Gets a new Vecto2 set with the maximal coordinate values from the "left" and "right" vectors
  2239. * @param left defines 1st vector
  2240. * @param right defines 2nd vector
  2241. * @returns a new Vector2
  2242. */
  2243. static Maximize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  2244. /**
  2245. * Gets a new Vector2 set with the transformed coordinates of the given vector by the given transformation matrix
  2246. * @param vector defines the vector to transform
  2247. * @param transformation defines the matrix to apply
  2248. * @returns a new Vector2
  2249. */
  2250. static Transform(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>): Vector2;
  2251. /**
  2252. * Transforms the given vector coordinates by the given transformation matrix and stores the result in the vector "result" coordinates
  2253. * @param vector defines the vector to transform
  2254. * @param transformation defines the matrix to apply
  2255. * @param result defines the target vector
  2256. */
  2257. static TransformToRef(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>, result: Vector2): void;
  2258. /**
  2259. * Determines if a given vector is included in a triangle
  2260. * @param p defines the vector to test
  2261. * @param p0 defines 1st triangle point
  2262. * @param p1 defines 2nd triangle point
  2263. * @param p2 defines 3rd triangle point
  2264. * @returns true if the point "p" is in the triangle defined by the vertors "p0", "p1", "p2"
  2265. */
  2266. static PointInTriangle(p: DeepImmutable<Vector2>, p0: DeepImmutable<Vector2>, p1: DeepImmutable<Vector2>, p2: DeepImmutable<Vector2>): boolean;
  2267. /**
  2268. * Gets the distance between the vectors "value1" and "value2"
  2269. * @param value1 defines first vector
  2270. * @param value2 defines second vector
  2271. * @returns the distance between vectors
  2272. */
  2273. static Distance(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  2274. /**
  2275. * Returns the squared distance between the vectors "value1" and "value2"
  2276. * @param value1 defines first vector
  2277. * @param value2 defines second vector
  2278. * @returns the squared distance between vectors
  2279. */
  2280. static DistanceSquared(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  2281. /**
  2282. * Gets a new Vector2 located at the center of the vectors "value1" and "value2"
  2283. * @param value1 defines first vector
  2284. * @param value2 defines second vector
  2285. * @returns a new Vector2
  2286. */
  2287. static Center(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): Vector2;
  2288. /**
  2289. * Gets the shortest distance (float) between the point "p" and the segment defined by the two points "segA" and "segB".
  2290. * @param p defines the middle point
  2291. * @param segA defines one point of the segment
  2292. * @param segB defines the other point of the segment
  2293. * @returns the shortest distance
  2294. */
  2295. static DistanceOfPointFromSegment(p: DeepImmutable<Vector2>, segA: DeepImmutable<Vector2>, segB: DeepImmutable<Vector2>): number;
  2296. }
  2297. /**
  2298. * Classed used to store (x,y,z) vector representation
  2299. * A Vector3 is the main object used in 3D geometry
  2300. * It can represent etiher the coordinates of a point the space, either a direction
  2301. * Reminder: js uses a left handed forward facing system
  2302. */
  2303. export class Vector3 {
  2304. /**
  2305. * Defines the first coordinates (on X axis)
  2306. */
  2307. x: number;
  2308. /**
  2309. * Defines the second coordinates (on Y axis)
  2310. */
  2311. y: number;
  2312. /**
  2313. * Defines the third coordinates (on Z axis)
  2314. */
  2315. z: number;
  2316. private static _UpReadOnly;
  2317. private static _ZeroReadOnly;
  2318. /**
  2319. * Creates a new Vector3 object from the given x, y, z (floats) coordinates.
  2320. * @param x defines the first coordinates (on X axis)
  2321. * @param y defines the second coordinates (on Y axis)
  2322. * @param z defines the third coordinates (on Z axis)
  2323. */
  2324. constructor(
  2325. /**
  2326. * Defines the first coordinates (on X axis)
  2327. */
  2328. x?: number,
  2329. /**
  2330. * Defines the second coordinates (on Y axis)
  2331. */
  2332. y?: number,
  2333. /**
  2334. * Defines the third coordinates (on Z axis)
  2335. */
  2336. z?: number);
  2337. /**
  2338. * Creates a string representation of the Vector3
  2339. * @returns a string with the Vector3 coordinates.
  2340. */
  2341. toString(): string;
  2342. /**
  2343. * Gets the class name
  2344. * @returns the string "Vector3"
  2345. */
  2346. getClassName(): string;
  2347. /**
  2348. * Creates the Vector3 hash code
  2349. * @returns a number which tends to be unique between Vector3 instances
  2350. */
  2351. getHashCode(): number;
  2352. /**
  2353. * Creates an array containing three elements : the coordinates of the Vector3
  2354. * @returns a new array of numbers
  2355. */
  2356. asArray(): number[];
  2357. /**
  2358. * Populates the given array or Float32Array from the given index with the successive coordinates of the Vector3
  2359. * @param array defines the destination array
  2360. * @param index defines the offset in the destination array
  2361. * @returns the current Vector3
  2362. */
  2363. toArray(array: FloatArray, index?: number): Vector3;
  2364. /**
  2365. * Converts the current Vector3 into a quaternion (considering that the Vector3 contains Euler angles representation of a rotation)
  2366. * @returns a new Quaternion object, computed from the Vector3 coordinates
  2367. */
  2368. toQuaternion(): Quaternion;
  2369. /**
  2370. * Adds the given vector to the current Vector3
  2371. * @param otherVector defines the second operand
  2372. * @returns the current updated Vector3
  2373. */
  2374. addInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  2375. /**
  2376. * Adds the given coordinates to the current Vector3
  2377. * @param x defines the x coordinate of the operand
  2378. * @param y defines the y coordinate of the operand
  2379. * @param z defines the z coordinate of the operand
  2380. * @returns the current updated Vector3
  2381. */
  2382. addInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  2383. /**
  2384. * Gets a new Vector3, result of the addition the current Vector3 and the given vector
  2385. * @param otherVector defines the second operand
  2386. * @returns the resulting Vector3
  2387. */
  2388. add(otherVector: DeepImmutable<Vector3>): Vector3;
  2389. /**
  2390. * Adds the current Vector3 to the given one and stores the result in the vector "result"
  2391. * @param otherVector defines the second operand
  2392. * @param result defines the Vector3 object where to store the result
  2393. * @returns the current Vector3
  2394. */
  2395. addToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2396. /**
  2397. * Subtract the given vector from the current Vector3
  2398. * @param otherVector defines the second operand
  2399. * @returns the current updated Vector3
  2400. */
  2401. subtractInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  2402. /**
  2403. * Returns a new Vector3, result of the subtraction of the given vector from the current Vector3
  2404. * @param otherVector defines the second operand
  2405. * @returns the resulting Vector3
  2406. */
  2407. subtract(otherVector: DeepImmutable<Vector3>): Vector3;
  2408. /**
  2409. * Subtracts the given vector from the current Vector3 and stores the result in the vector "result".
  2410. * @param otherVector defines the second operand
  2411. * @param result defines the Vector3 object where to store the result
  2412. * @returns the current Vector3
  2413. */
  2414. subtractToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2415. /**
  2416. * Returns a new Vector3 set with the subtraction of the given floats from the current Vector3 coordinates
  2417. * @param x defines the x coordinate of the operand
  2418. * @param y defines the y coordinate of the operand
  2419. * @param z defines the z coordinate of the operand
  2420. * @returns the resulting Vector3
  2421. */
  2422. subtractFromFloats(x: number, y: number, z: number): Vector3;
  2423. /**
  2424. * Subtracts the given floats from the current Vector3 coordinates and set the given vector "result" with this result
  2425. * @param x defines the x coordinate of the operand
  2426. * @param y defines the y coordinate of the operand
  2427. * @param z defines the z coordinate of the operand
  2428. * @param result defines the Vector3 object where to store the result
  2429. * @returns the current Vector3
  2430. */
  2431. subtractFromFloatsToRef(x: number, y: number, z: number, result: Vector3): Vector3;
  2432. /**
  2433. * Gets a new Vector3 set with the current Vector3 negated coordinates
  2434. * @returns a new Vector3
  2435. */
  2436. negate(): Vector3;
  2437. /**
  2438. * Multiplies the Vector3 coordinates by the float "scale"
  2439. * @param scale defines the multiplier factor
  2440. * @returns the current updated Vector3
  2441. */
  2442. scaleInPlace(scale: number): Vector3;
  2443. /**
  2444. * Returns a new Vector3 set with the current Vector3 coordinates multiplied by the float "scale"
  2445. * @param scale defines the multiplier factor
  2446. * @returns a new Vector3
  2447. */
  2448. scale(scale: number): Vector3;
  2449. /**
  2450. * Multiplies the current Vector3 coordinates by the float "scale" and stores the result in the given vector "result" coordinates
  2451. * @param scale defines the multiplier factor
  2452. * @param result defines the Vector3 object where to store the result
  2453. * @returns the current Vector3
  2454. */
  2455. scaleToRef(scale: number, result: Vector3): Vector3;
  2456. /**
  2457. * Scale the current Vector3 values by a factor and add the result to a given Vector3
  2458. * @param scale defines the scale factor
  2459. * @param result defines the Vector3 object where to store the result
  2460. * @returns the unmodified current Vector3
  2461. */
  2462. scaleAndAddToRef(scale: number, result: Vector3): Vector3;
  2463. /**
  2464. * Returns true if the current Vector3 and the given vector coordinates are strictly equal
  2465. * @param otherVector defines the second operand
  2466. * @returns true if both vectors are equals
  2467. */
  2468. equals(otherVector: DeepImmutable<Vector3>): boolean;
  2469. /**
  2470. * Returns true if the current Vector3 and the given vector coordinates are distant less than epsilon
  2471. * @param otherVector defines the second operand
  2472. * @param epsilon defines the minimal distance to define values as equals
  2473. * @returns true if both vectors are distant less than epsilon
  2474. */
  2475. equalsWithEpsilon(otherVector: DeepImmutable<Vector3>, epsilon?: number): boolean;
  2476. /**
  2477. * Returns true if the current Vector3 coordinates equals the given floats
  2478. * @param x defines the x coordinate of the operand
  2479. * @param y defines the y coordinate of the operand
  2480. * @param z defines the z coordinate of the operand
  2481. * @returns true if both vectors are equals
  2482. */
  2483. equalsToFloats(x: number, y: number, z: number): boolean;
  2484. /**
  2485. * Multiplies the current Vector3 coordinates by the given ones
  2486. * @param otherVector defines the second operand
  2487. * @returns the current updated Vector3
  2488. */
  2489. multiplyInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  2490. /**
  2491. * Returns a new Vector3, result of the multiplication of the current Vector3 by the given vector
  2492. * @param otherVector defines the second operand
  2493. * @returns the new Vector3
  2494. */
  2495. multiply(otherVector: DeepImmutable<Vector3>): Vector3;
  2496. /**
  2497. * Multiplies the current Vector3 by the given one and stores the result in the given vector "result"
  2498. * @param otherVector defines the second operand
  2499. * @param result defines the Vector3 object where to store the result
  2500. * @returns the current Vector3
  2501. */
  2502. multiplyToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2503. /**
  2504. * Returns a new Vector3 set with the result of the mulliplication of the current Vector3 coordinates by the given floats
  2505. * @param x defines the x coordinate of the operand
  2506. * @param y defines the y coordinate of the operand
  2507. * @param z defines the z coordinate of the operand
  2508. * @returns the new Vector3
  2509. */
  2510. multiplyByFloats(x: number, y: number, z: number): Vector3;
  2511. /**
  2512. * Returns a new Vector3 set with the result of the division of the current Vector3 coordinates by the given ones
  2513. * @param otherVector defines the second operand
  2514. * @returns the new Vector3
  2515. */
  2516. divide(otherVector: DeepImmutable<Vector3>): Vector3;
  2517. /**
  2518. * Divides the current Vector3 coordinates by the given ones and stores the result in the given vector "result"
  2519. * @param otherVector defines the second operand
  2520. * @param result defines the Vector3 object where to store the result
  2521. * @returns the current Vector3
  2522. */
  2523. divideToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  2524. /**
  2525. * Divides the current Vector3 coordinates by the given ones.
  2526. * @param otherVector defines the second operand
  2527. * @returns the current updated Vector3
  2528. */
  2529. divideInPlace(otherVector: Vector3): Vector3;
  2530. /**
  2531. * Updates the current Vector3 with the minimal coordinate values between its and the given vector ones
  2532. * @param other defines the second operand
  2533. * @returns the current updated Vector3
  2534. */
  2535. minimizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  2536. /**
  2537. * Updates the current Vector3 with the maximal coordinate values between its and the given vector ones.
  2538. * @param other defines the second operand
  2539. * @returns the current updated Vector3
  2540. */
  2541. maximizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  2542. /**
  2543. * Updates the current Vector3 with the minimal coordinate values between its and the given coordinates
  2544. * @param x defines the x coordinate of the operand
  2545. * @param y defines the y coordinate of the operand
  2546. * @param z defines the z coordinate of the operand
  2547. * @returns the current updated Vector3
  2548. */
  2549. minimizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  2550. /**
  2551. * Updates the current Vector3 with the maximal coordinate values between its and the given coordinates.
  2552. * @param x defines the x coordinate of the operand
  2553. * @param y defines the y coordinate of the operand
  2554. * @param z defines the z coordinate of the operand
  2555. * @returns the current updated Vector3
  2556. */
  2557. maximizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  2558. /**
  2559. * Due to float precision, scale of a mesh could be uniform but float values are off by a small fraction
  2560. * Check if is non uniform within a certain amount of decimal places to account for this
  2561. * @param epsilon the amount the values can differ
  2562. * @returns if the the vector is non uniform to a certain number of decimal places
  2563. */
  2564. isNonUniformWithinEpsilon(epsilon: number): boolean;
  2565. /**
  2566. * Gets a boolean indicating that the vector is non uniform meaning x, y or z are not all the same
  2567. */
  2568. readonly isNonUniform: boolean;
  2569. /**
  2570. * Gets a new Vector3 from current Vector3 floored values
  2571. * @returns a new Vector3
  2572. */
  2573. floor(): Vector3;
  2574. /**
  2575. * Gets a new Vector3 from current Vector3 floored values
  2576. * @returns a new Vector3
  2577. */
  2578. fract(): Vector3;
  2579. /**
  2580. * Gets the length of the Vector3
  2581. * @returns the length of the Vector3
  2582. */
  2583. length(): number;
  2584. /**
  2585. * Gets the squared length of the Vector3
  2586. * @returns squared length of the Vector3
  2587. */
  2588. lengthSquared(): number;
  2589. /**
  2590. * Normalize the current Vector3.
  2591. * Please note that this is an in place operation.
  2592. * @returns the current updated Vector3
  2593. */
  2594. normalize(): Vector3;
  2595. /**
  2596. * Reorders the x y z properties of the vector in place
  2597. * @param order new ordering of the properties (eg. for vector 1,2,3 with "ZYX" will produce 3,2,1)
  2598. * @returns the current updated vector
  2599. */
  2600. reorderInPlace(order: string): this;
  2601. /**
  2602. * Rotates the vector around 0,0,0 by a quaternion
  2603. * @param quaternion the rotation quaternion
  2604. * @param result vector to store the result
  2605. * @returns the resulting vector
  2606. */
  2607. rotateByQuaternionToRef(quaternion: Quaternion, result: Vector3): Vector3;
  2608. /**
  2609. * Rotates a vector around a given point
  2610. * @param quaternion the rotation quaternion
  2611. * @param point the point to rotate around
  2612. * @param result vector to store the result
  2613. * @returns the resulting vector
  2614. */
  2615. rotateByQuaternionAroundPointToRef(quaternion: Quaternion, point: Vector3, result: Vector3): Vector3;
  2616. /**
  2617. * Returns a new Vector3 as the cross product of the current vector and the "other" one
  2618. * The cross product is then orthogonal to both current and "other"
  2619. * @param other defines the right operand
  2620. * @returns the cross product
  2621. */
  2622. cross(other: Vector3): Vector3;
  2623. /**
  2624. * Normalize the current Vector3 with the given input length.
  2625. * Please note that this is an in place operation.
  2626. * @param len the length of the vector
  2627. * @returns the current updated Vector3
  2628. */
  2629. normalizeFromLength(len: number): Vector3;
  2630. /**
  2631. * Normalize the current Vector3 to a new vector
  2632. * @returns the new Vector3
  2633. */
  2634. normalizeToNew(): Vector3;
  2635. /**
  2636. * Normalize the current Vector3 to the reference
  2637. * @param reference define the Vector3 to update
  2638. * @returns the updated Vector3
  2639. */
  2640. normalizeToRef(reference: DeepImmutable<Vector3>): Vector3;
  2641. /**
  2642. * Creates a new Vector3 copied from the current Vector3
  2643. * @returns the new Vector3
  2644. */
  2645. clone(): Vector3;
  2646. /**
  2647. * Copies the given vector coordinates to the current Vector3 ones
  2648. * @param source defines the source Vector3
  2649. * @returns the current updated Vector3
  2650. */
  2651. copyFrom(source: DeepImmutable<Vector3>): Vector3;
  2652. /**
  2653. * Copies the given floats to the current Vector3 coordinates
  2654. * @param x defines the x coordinate of the operand
  2655. * @param y defines the y coordinate of the operand
  2656. * @param z defines the z coordinate of the operand
  2657. * @returns the current updated Vector3
  2658. */
  2659. copyFromFloats(x: number, y: number, z: number): Vector3;
  2660. /**
  2661. * Copies the given floats to the current Vector3 coordinates
  2662. * @param x defines the x coordinate of the operand
  2663. * @param y defines the y coordinate of the operand
  2664. * @param z defines the z coordinate of the operand
  2665. * @returns the current updated Vector3
  2666. */
  2667. set(x: number, y: number, z: number): Vector3;
  2668. /**
  2669. * Copies the given float to the current Vector3 coordinates
  2670. * @param v defines the x, y and z coordinates of the operand
  2671. * @returns the current updated Vector3
  2672. */
  2673. setAll(v: number): Vector3;
  2674. /**
  2675. * Get the clip factor between two vectors
  2676. * @param vector0 defines the first operand
  2677. * @param vector1 defines the second operand
  2678. * @param axis defines the axis to use
  2679. * @param size defines the size along the axis
  2680. * @returns the clip factor
  2681. */
  2682. static GetClipFactor(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, axis: DeepImmutable<Vector3>, size: number): number;
  2683. /**
  2684. * Get angle between two vectors
  2685. * @param vector0 angle between vector0 and vector1
  2686. * @param vector1 angle between vector0 and vector1
  2687. * @param normal direction of the normal
  2688. * @return the angle between vector0 and vector1
  2689. */
  2690. static GetAngleBetweenVectors(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>): number;
  2691. /**
  2692. * Returns a new Vector3 set from the index "offset" of the given array
  2693. * @param array defines the source array
  2694. * @param offset defines the offset in the source array
  2695. * @returns the new Vector3
  2696. */
  2697. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector3;
  2698. /**
  2699. * Returns a new Vector3 set from the index "offset" of the given Float32Array
  2700. * This function is deprecated. Use FromArray instead
  2701. * @param array defines the source array
  2702. * @param offset defines the offset in the source array
  2703. * @returns the new Vector3
  2704. */
  2705. static FromFloatArray(array: DeepImmutable<Float32Array>, offset?: number): Vector3;
  2706. /**
  2707. * Sets the given vector "result" with the element values from the index "offset" of the given array
  2708. * @param array defines the source array
  2709. * @param offset defines the offset in the source array
  2710. * @param result defines the Vector3 where to store the result
  2711. */
  2712. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector3): void;
  2713. /**
  2714. * Sets the given vector "result" with the element values from the index "offset" of the given Float32Array
  2715. * This function is deprecated. Use FromArrayToRef instead.
  2716. * @param array defines the source array
  2717. * @param offset defines the offset in the source array
  2718. * @param result defines the Vector3 where to store the result
  2719. */
  2720. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector3): void;
  2721. /**
  2722. * Sets the given vector "result" with the given floats.
  2723. * @param x defines the x coordinate of the source
  2724. * @param y defines the y coordinate of the source
  2725. * @param z defines the z coordinate of the source
  2726. * @param result defines the Vector3 where to store the result
  2727. */
  2728. static FromFloatsToRef(x: number, y: number, z: number, result: Vector3): void;
  2729. /**
  2730. * Returns a new Vector3 set to (0.0, 0.0, 0.0)
  2731. * @returns a new empty Vector3
  2732. */
  2733. static Zero(): Vector3;
  2734. /**
  2735. * Returns a new Vector3 set to (1.0, 1.0, 1.0)
  2736. * @returns a new unit Vector3
  2737. */
  2738. static One(): Vector3;
  2739. /**
  2740. * Returns a new Vector3 set to (0.0, 1.0, 0.0)
  2741. * @returns a new up Vector3
  2742. */
  2743. static Up(): Vector3;
  2744. /**
  2745. * Gets a up Vector3 that must not be updated
  2746. */
  2747. static readonly UpReadOnly: DeepImmutable<Vector3>;
  2748. /**
  2749. * Gets a zero Vector3 that must not be updated
  2750. */
  2751. static readonly ZeroReadOnly: DeepImmutable<Vector3>;
  2752. /**
  2753. * Returns a new Vector3 set to (0.0, -1.0, 0.0)
  2754. * @returns a new down Vector3
  2755. */
  2756. static Down(): Vector3;
  2757. /**
  2758. * Returns a new Vector3 set to (0.0, 0.0, 1.0)
  2759. * @returns a new forward Vector3
  2760. */
  2761. static Forward(): Vector3;
  2762. /**
  2763. * Returns a new Vector3 set to (0.0, 0.0, -1.0)
  2764. * @returns a new forward Vector3
  2765. */
  2766. static Backward(): Vector3;
  2767. /**
  2768. * Returns a new Vector3 set to (1.0, 0.0, 0.0)
  2769. * @returns a new right Vector3
  2770. */
  2771. static Right(): Vector3;
  2772. /**
  2773. * Returns a new Vector3 set to (-1.0, 0.0, 0.0)
  2774. * @returns a new left Vector3
  2775. */
  2776. static Left(): Vector3;
  2777. /**
  2778. * Returns a new Vector3 set with the result of the transformation by the given matrix of the given vector.
  2779. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  2780. * @param vector defines the Vector3 to transform
  2781. * @param transformation defines the transformation matrix
  2782. * @returns the transformed Vector3
  2783. */
  2784. static TransformCoordinates(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  2785. /**
  2786. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given vector
  2787. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  2788. * @param vector defines the Vector3 to transform
  2789. * @param transformation defines the transformation matrix
  2790. * @param result defines the Vector3 where to store the result
  2791. */
  2792. static TransformCoordinatesToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  2793. /**
  2794. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given floats (x, y, z)
  2795. * This method computes tranformed coordinates only, not transformed direction vectors
  2796. * @param x define the x coordinate of the source vector
  2797. * @param y define the y coordinate of the source vector
  2798. * @param z define the z coordinate of the source vector
  2799. * @param transformation defines the transformation matrix
  2800. * @param result defines the Vector3 where to store the result
  2801. */
  2802. static TransformCoordinatesFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  2803. /**
  2804. * Returns a new Vector3 set with the result of the normal transformation by the given matrix of the given vector
  2805. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  2806. * @param vector defines the Vector3 to transform
  2807. * @param transformation defines the transformation matrix
  2808. * @returns the new Vector3
  2809. */
  2810. static TransformNormal(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  2811. /**
  2812. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector
  2813. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  2814. * @param vector defines the Vector3 to transform
  2815. * @param transformation defines the transformation matrix
  2816. * @param result defines the Vector3 where to store the result
  2817. */
  2818. static TransformNormalToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  2819. /**
  2820. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z)
  2821. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  2822. * @param x define the x coordinate of the source vector
  2823. * @param y define the y coordinate of the source vector
  2824. * @param z define the z coordinate of the source vector
  2825. * @param transformation defines the transformation matrix
  2826. * @param result defines the Vector3 where to store the result
  2827. */
  2828. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  2829. /**
  2830. * Returns a new Vector3 located for "amount" on the CatmullRom interpolation spline defined by the vectors "value1", "value2", "value3", "value4"
  2831. * @param value1 defines the first control point
  2832. * @param value2 defines the second control point
  2833. * @param value3 defines the third control point
  2834. * @param value4 defines the fourth control point
  2835. * @param amount defines the amount on the spline to use
  2836. * @returns the new Vector3
  2837. */
  2838. static CatmullRom(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, value3: DeepImmutable<Vector3>, value4: DeepImmutable<Vector3>, amount: number): Vector3;
  2839. /**
  2840. * Returns a new Vector3 set with the coordinates of "value", if the vector "value" is in the cube defined by the vectors "min" and "max"
  2841. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  2842. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  2843. * @param value defines the current value
  2844. * @param min defines the lower range value
  2845. * @param max defines the upper range value
  2846. * @returns the new Vector3
  2847. */
  2848. static Clamp(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): Vector3;
  2849. /**
  2850. * Sets the given vector "result" with the coordinates of "value", if the vector "value" is in the cube defined by the vectors "min" and "max"
  2851. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  2852. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  2853. * @param value defines the current value
  2854. * @param min defines the lower range value
  2855. * @param max defines the upper range value
  2856. * @param result defines the Vector3 where to store the result
  2857. */
  2858. static ClampToRef(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, result: Vector3): void;
  2859. /**
  2860. * Checks if a given vector is inside a specific range
  2861. * @param v defines the vector to test
  2862. * @param min defines the minimum range
  2863. * @param max defines the maximum range
  2864. */
  2865. static CheckExtends(v: Vector3, min: Vector3, max: Vector3): void;
  2866. /**
  2867. * Returns a new Vector3 located for "amount" (float) on the Hermite interpolation spline defined by the vectors "value1", "tangent1", "value2", "tangent2"
  2868. * @param value1 defines the first control point
  2869. * @param tangent1 defines the first tangent vector
  2870. * @param value2 defines the second control point
  2871. * @param tangent2 defines the second tangent vector
  2872. * @param amount defines the amount on the interpolation spline (between 0 and 1)
  2873. * @returns the new Vector3
  2874. */
  2875. static Hermite(value1: DeepImmutable<Vector3>, tangent1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, tangent2: DeepImmutable<Vector3>, amount: number): Vector3;
  2876. /**
  2877. * Returns a new Vector3 located for "amount" (float) on the linear interpolation between the vectors "start" and "end"
  2878. * @param start defines the start value
  2879. * @param end defines the end value
  2880. * @param amount max defines amount between both (between 0 and 1)
  2881. * @returns the new Vector3
  2882. */
  2883. static Lerp(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number): Vector3;
  2884. /**
  2885. * Sets the given vector "result" with the result of the linear interpolation from the vector "start" for "amount" to the vector "end"
  2886. * @param start defines the start value
  2887. * @param end defines the end value
  2888. * @param amount max defines amount between both (between 0 and 1)
  2889. * @param result defines the Vector3 where to store the result
  2890. */
  2891. static LerpToRef(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number, result: Vector3): void;
  2892. /**
  2893. * Returns the dot product (float) between the vectors "left" and "right"
  2894. * @param left defines the left operand
  2895. * @param right defines the right operand
  2896. * @returns the dot product
  2897. */
  2898. static Dot(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): number;
  2899. /**
  2900. * Returns a new Vector3 as the cross product of the vectors "left" and "right"
  2901. * The cross product is then orthogonal to both "left" and "right"
  2902. * @param left defines the left operand
  2903. * @param right defines the right operand
  2904. * @returns the cross product
  2905. */
  2906. static Cross(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  2907. /**
  2908. * Sets the given vector "result" with the cross product of "left" and "right"
  2909. * The cross product is then orthogonal to both "left" and "right"
  2910. * @param left defines the left operand
  2911. * @param right defines the right operand
  2912. * @param result defines the Vector3 where to store the result
  2913. */
  2914. static CrossToRef(left: Vector3, right: Vector3, result: Vector3): void;
  2915. /**
  2916. * Returns a new Vector3 as the normalization of the given vector
  2917. * @param vector defines the Vector3 to normalize
  2918. * @returns the new Vector3
  2919. */
  2920. static Normalize(vector: DeepImmutable<Vector3>): Vector3;
  2921. /**
  2922. * Sets the given vector "result" with the normalization of the given first vector
  2923. * @param vector defines the Vector3 to normalize
  2924. * @param result defines the Vector3 where to store the result
  2925. */
  2926. static NormalizeToRef(vector: DeepImmutable<Vector3>, result: Vector3): void;
  2927. /**
  2928. * Project a Vector3 onto screen space
  2929. * @param vector defines the Vector3 to project
  2930. * @param world defines the world matrix to use
  2931. * @param transform defines the transform (view x projection) matrix to use
  2932. * @param viewport defines the screen viewport to use
  2933. * @returns the new Vector3
  2934. */
  2935. static Project(vector: DeepImmutable<Vector3>, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>, viewport: DeepImmutable<Viewport>): Vector3;
  2936. /** @hidden */
  2937. static _UnprojectFromInvertedMatrixToRef(source: DeepImmutable<Vector3>, matrix: DeepImmutable<Matrix>, result: Vector3): void;
  2938. /**
  2939. * Unproject from screen space to object space
  2940. * @param source defines the screen space Vector3 to use
  2941. * @param viewportWidth defines the current width of the viewport
  2942. * @param viewportHeight defines the current height of the viewport
  2943. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  2944. * @param transform defines the transform (view x projection) matrix to use
  2945. * @returns the new Vector3
  2946. */
  2947. static UnprojectFromTransform(source: Vector3, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>): Vector3;
  2948. /**
  2949. * Unproject from screen space to object space
  2950. * @param source defines the screen space Vector3 to use
  2951. * @param viewportWidth defines the current width of the viewport
  2952. * @param viewportHeight defines the current height of the viewport
  2953. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  2954. * @param view defines the view matrix to use
  2955. * @param projection defines the projection matrix to use
  2956. * @returns the new Vector3
  2957. */
  2958. static Unproject(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Vector3;
  2959. /**
  2960. * Unproject from screen space to object space
  2961. * @param source defines the screen space Vector3 to use
  2962. * @param viewportWidth defines the current width of the viewport
  2963. * @param viewportHeight defines the current height of the viewport
  2964. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  2965. * @param view defines the view matrix to use
  2966. * @param projection defines the projection matrix to use
  2967. * @param result defines the Vector3 where to store the result
  2968. */
  2969. static UnprojectToRef(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  2970. /**
  2971. * Unproject from screen space to object space
  2972. * @param sourceX defines the screen space x coordinate to use
  2973. * @param sourceY defines the screen space y coordinate to use
  2974. * @param sourceZ defines the screen space z coordinate to use
  2975. * @param viewportWidth defines the current width of the viewport
  2976. * @param viewportHeight defines the current height of the viewport
  2977. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  2978. * @param view defines the view matrix to use
  2979. * @param projection defines the projection matrix to use
  2980. * @param result defines the Vector3 where to store the result
  2981. */
  2982. static UnprojectFloatsToRef(sourceX: float, sourceY: float, sourceZ: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  2983. /**
  2984. * Gets the minimal coordinate values between two Vector3
  2985. * @param left defines the first operand
  2986. * @param right defines the second operand
  2987. * @returns the new Vector3
  2988. */
  2989. static Minimize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  2990. /**
  2991. * Gets the maximal coordinate values between two Vector3
  2992. * @param left defines the first operand
  2993. * @param right defines the second operand
  2994. * @returns the new Vector3
  2995. */
  2996. static Maximize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  2997. /**
  2998. * Returns the distance between the vectors "value1" and "value2"
  2999. * @param value1 defines the first operand
  3000. * @param value2 defines the second operand
  3001. * @returns the distance
  3002. */
  3003. static Distance(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  3004. /**
  3005. * Returns the squared distance between the vectors "value1" and "value2"
  3006. * @param value1 defines the first operand
  3007. * @param value2 defines the second operand
  3008. * @returns the squared distance
  3009. */
  3010. static DistanceSquared(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  3011. /**
  3012. * Returns a new Vector3 located at the center between "value1" and "value2"
  3013. * @param value1 defines the first operand
  3014. * @param value2 defines the second operand
  3015. * @returns the new Vector3
  3016. */
  3017. static Center(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): Vector3;
  3018. /**
  3019. * Given three orthogonal normalized left-handed oriented Vector3 axis in space (target system),
  3020. * RotationFromAxis() returns the rotation Euler angles (ex : rotation.x, rotation.y, rotation.z) to apply
  3021. * to something in order to rotate it from its local system to the given target system
  3022. * Note: axis1, axis2 and axis3 are normalized during this operation
  3023. * @param axis1 defines the first axis
  3024. * @param axis2 defines the second axis
  3025. * @param axis3 defines the third axis
  3026. * @returns a new Vector3
  3027. */
  3028. static RotationFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Vector3;
  3029. /**
  3030. * The same than RotationFromAxis but updates the given ref Vector3 parameter instead of returning a new Vector3
  3031. * @param axis1 defines the first axis
  3032. * @param axis2 defines the second axis
  3033. * @param axis3 defines the third axis
  3034. * @param ref defines the Vector3 where to store the result
  3035. */
  3036. static RotationFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Vector3): void;
  3037. }
  3038. /**
  3039. * Vector4 class created for EulerAngle class conversion to Quaternion
  3040. */
  3041. export class Vector4 {
  3042. /** x value of the vector */
  3043. x: number;
  3044. /** y value of the vector */
  3045. y: number;
  3046. /** z value of the vector */
  3047. z: number;
  3048. /** w value of the vector */
  3049. w: number;
  3050. /**
  3051. * Creates a Vector4 object from the given floats.
  3052. * @param x x value of the vector
  3053. * @param y y value of the vector
  3054. * @param z z value of the vector
  3055. * @param w w value of the vector
  3056. */
  3057. constructor(
  3058. /** x value of the vector */
  3059. x: number,
  3060. /** y value of the vector */
  3061. y: number,
  3062. /** z value of the vector */
  3063. z: number,
  3064. /** w value of the vector */
  3065. w: number);
  3066. /**
  3067. * Returns the string with the Vector4 coordinates.
  3068. * @returns a string containing all the vector values
  3069. */
  3070. toString(): string;
  3071. /**
  3072. * Returns the string "Vector4".
  3073. * @returns "Vector4"
  3074. */
  3075. getClassName(): string;
  3076. /**
  3077. * Returns the Vector4 hash code.
  3078. * @returns a unique hash code
  3079. */
  3080. getHashCode(): number;
  3081. /**
  3082. * Returns a new array populated with 4 elements : the Vector4 coordinates.
  3083. * @returns the resulting array
  3084. */
  3085. asArray(): number[];
  3086. /**
  3087. * Populates the given array from the given index with the Vector4 coordinates.
  3088. * @param array array to populate
  3089. * @param index index of the array to start at (default: 0)
  3090. * @returns the Vector4.
  3091. */
  3092. toArray(array: FloatArray, index?: number): Vector4;
  3093. /**
  3094. * Adds the given vector to the current Vector4.
  3095. * @param otherVector the vector to add
  3096. * @returns the updated Vector4.
  3097. */
  3098. addInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  3099. /**
  3100. * Returns a new Vector4 as the result of the addition of the current Vector4 and the given one.
  3101. * @param otherVector the vector to add
  3102. * @returns the resulting vector
  3103. */
  3104. add(otherVector: DeepImmutable<Vector4>): Vector4;
  3105. /**
  3106. * Updates the given vector "result" with the result of the addition of the current Vector4 and the given one.
  3107. * @param otherVector the vector to add
  3108. * @param result the vector to store the result
  3109. * @returns the current Vector4.
  3110. */
  3111. addToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3112. /**
  3113. * Subtract in place the given vector from the current Vector4.
  3114. * @param otherVector the vector to subtract
  3115. * @returns the updated Vector4.
  3116. */
  3117. subtractInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  3118. /**
  3119. * Returns a new Vector4 with the result of the subtraction of the given vector from the current Vector4.
  3120. * @param otherVector the vector to add
  3121. * @returns the new vector with the result
  3122. */
  3123. subtract(otherVector: DeepImmutable<Vector4>): Vector4;
  3124. /**
  3125. * Sets the given vector "result" with the result of the subtraction of the given vector from the current Vector4.
  3126. * @param otherVector the vector to subtract
  3127. * @param result the vector to store the result
  3128. * @returns the current Vector4.
  3129. */
  3130. subtractToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3131. /**
  3132. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  3133. */
  3134. /**
  3135. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  3136. * @param x value to subtract
  3137. * @param y value to subtract
  3138. * @param z value to subtract
  3139. * @param w value to subtract
  3140. * @returns new vector containing the result
  3141. */
  3142. subtractFromFloats(x: number, y: number, z: number, w: number): Vector4;
  3143. /**
  3144. * Sets the given vector "result" set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  3145. * @param x value to subtract
  3146. * @param y value to subtract
  3147. * @param z value to subtract
  3148. * @param w value to subtract
  3149. * @param result the vector to store the result in
  3150. * @returns the current Vector4.
  3151. */
  3152. subtractFromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): Vector4;
  3153. /**
  3154. * Returns a new Vector4 set with the current Vector4 negated coordinates.
  3155. * @returns a new vector with the negated values
  3156. */
  3157. negate(): Vector4;
  3158. /**
  3159. * Multiplies the current Vector4 coordinates by scale (float).
  3160. * @param scale the number to scale with
  3161. * @returns the updated Vector4.
  3162. */
  3163. scaleInPlace(scale: number): Vector4;
  3164. /**
  3165. * Returns a new Vector4 set with the current Vector4 coordinates multiplied by scale (float).
  3166. * @param scale the number to scale with
  3167. * @returns a new vector with the result
  3168. */
  3169. scale(scale: number): Vector4;
  3170. /**
  3171. * Sets the given vector "result" with the current Vector4 coordinates multiplied by scale (float).
  3172. * @param scale the number to scale with
  3173. * @param result a vector to store the result in
  3174. * @returns the current Vector4.
  3175. */
  3176. scaleToRef(scale: number, result: Vector4): Vector4;
  3177. /**
  3178. * Scale the current Vector4 values by a factor and add the result to a given Vector4
  3179. * @param scale defines the scale factor
  3180. * @param result defines the Vector4 object where to store the result
  3181. * @returns the unmodified current Vector4
  3182. */
  3183. scaleAndAddToRef(scale: number, result: Vector4): Vector4;
  3184. /**
  3185. * Boolean : True if the current Vector4 coordinates are stricly equal to the given ones.
  3186. * @param otherVector the vector to compare against
  3187. * @returns true if they are equal
  3188. */
  3189. equals(otherVector: DeepImmutable<Vector4>): boolean;
  3190. /**
  3191. * Boolean : True if the current Vector4 coordinates are each beneath the distance "epsilon" from the given vector ones.
  3192. * @param otherVector vector to compare against
  3193. * @param epsilon (Default: very small number)
  3194. * @returns true if they are equal
  3195. */
  3196. equalsWithEpsilon(otherVector: DeepImmutable<Vector4>, epsilon?: number): boolean;
  3197. /**
  3198. * Boolean : True if the given floats are strictly equal to the current Vector4 coordinates.
  3199. * @param x x value to compare against
  3200. * @param y y value to compare against
  3201. * @param z z value to compare against
  3202. * @param w w value to compare against
  3203. * @returns true if equal
  3204. */
  3205. equalsToFloats(x: number, y: number, z: number, w: number): boolean;
  3206. /**
  3207. * Multiplies in place the current Vector4 by the given one.
  3208. * @param otherVector vector to multiple with
  3209. * @returns the updated Vector4.
  3210. */
  3211. multiplyInPlace(otherVector: Vector4): Vector4;
  3212. /**
  3213. * Returns a new Vector4 set with the multiplication result of the current Vector4 and the given one.
  3214. * @param otherVector vector to multiple with
  3215. * @returns resulting new vector
  3216. */
  3217. multiply(otherVector: DeepImmutable<Vector4>): Vector4;
  3218. /**
  3219. * Updates the given vector "result" with the multiplication result of the current Vector4 and the given one.
  3220. * @param otherVector vector to multiple with
  3221. * @param result vector to store the result
  3222. * @returns the current Vector4.
  3223. */
  3224. multiplyToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3225. /**
  3226. * Returns a new Vector4 set with the multiplication result of the given floats and the current Vector4 coordinates.
  3227. * @param x x value multiply with
  3228. * @param y y value multiply with
  3229. * @param z z value multiply with
  3230. * @param w w value multiply with
  3231. * @returns resulting new vector
  3232. */
  3233. multiplyByFloats(x: number, y: number, z: number, w: number): Vector4;
  3234. /**
  3235. * Returns a new Vector4 set with the division result of the current Vector4 by the given one.
  3236. * @param otherVector vector to devide with
  3237. * @returns resulting new vector
  3238. */
  3239. divide(otherVector: DeepImmutable<Vector4>): Vector4;
  3240. /**
  3241. * Updates the given vector "result" with the division result of the current Vector4 by the given one.
  3242. * @param otherVector vector to devide with
  3243. * @param result vector to store the result
  3244. * @returns the current Vector4.
  3245. */
  3246. divideToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  3247. /**
  3248. * Divides the current Vector3 coordinates by the given ones.
  3249. * @param otherVector vector to devide with
  3250. * @returns the updated Vector3.
  3251. */
  3252. divideInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  3253. /**
  3254. * Updates the Vector4 coordinates with the minimum values between its own and the given vector ones
  3255. * @param other defines the second operand
  3256. * @returns the current updated Vector4
  3257. */
  3258. minimizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  3259. /**
  3260. * Updates the Vector4 coordinates with the maximum values between its own and the given vector ones
  3261. * @param other defines the second operand
  3262. * @returns the current updated Vector4
  3263. */
  3264. maximizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  3265. /**
  3266. * Gets a new Vector4 from current Vector4 floored values
  3267. * @returns a new Vector4
  3268. */
  3269. floor(): Vector4;
  3270. /**
  3271. * Gets a new Vector4 from current Vector3 floored values
  3272. * @returns a new Vector4
  3273. */
  3274. fract(): Vector4;
  3275. /**
  3276. * Returns the Vector4 length (float).
  3277. * @returns the length
  3278. */
  3279. length(): number;
  3280. /**
  3281. * Returns the Vector4 squared length (float).
  3282. * @returns the length squared
  3283. */
  3284. lengthSquared(): number;
  3285. /**
  3286. * Normalizes in place the Vector4.
  3287. * @returns the updated Vector4.
  3288. */
  3289. normalize(): Vector4;
  3290. /**
  3291. * Returns a new Vector3 from the Vector4 (x, y, z) coordinates.
  3292. * @returns this converted to a new vector3
  3293. */
  3294. toVector3(): Vector3;
  3295. /**
  3296. * Returns a new Vector4 copied from the current one.
  3297. * @returns the new cloned vector
  3298. */
  3299. clone(): Vector4;
  3300. /**
  3301. * Updates the current Vector4 with the given one coordinates.
  3302. * @param source the source vector to copy from
  3303. * @returns the updated Vector4.
  3304. */
  3305. copyFrom(source: DeepImmutable<Vector4>): Vector4;
  3306. /**
  3307. * Updates the current Vector4 coordinates with the given floats.
  3308. * @param x float to copy from
  3309. * @param y float to copy from
  3310. * @param z float to copy from
  3311. * @param w float to copy from
  3312. * @returns the updated Vector4.
  3313. */
  3314. copyFromFloats(x: number, y: number, z: number, w: number): Vector4;
  3315. /**
  3316. * Updates the current Vector4 coordinates with the given floats.
  3317. * @param x float to set from
  3318. * @param y float to set from
  3319. * @param z float to set from
  3320. * @param w float to set from
  3321. * @returns the updated Vector4.
  3322. */
  3323. set(x: number, y: number, z: number, w: number): Vector4;
  3324. /**
  3325. * Copies the given float to the current Vector3 coordinates
  3326. * @param v defines the x, y, z and w coordinates of the operand
  3327. * @returns the current updated Vector3
  3328. */
  3329. setAll(v: number): Vector4;
  3330. /**
  3331. * Returns a new Vector4 set from the starting index of the given array.
  3332. * @param array the array to pull values from
  3333. * @param offset the offset into the array to start at
  3334. * @returns the new vector
  3335. */
  3336. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector4;
  3337. /**
  3338. * Updates the given vector "result" from the starting index of the given array.
  3339. * @param array the array to pull values from
  3340. * @param offset the offset into the array to start at
  3341. * @param result the vector to store the result in
  3342. */
  3343. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector4): void;
  3344. /**
  3345. * Updates the given vector "result" from the starting index of the given Float32Array.
  3346. * @param array the array to pull values from
  3347. * @param offset the offset into the array to start at
  3348. * @param result the vector to store the result in
  3349. */
  3350. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector4): void;
  3351. /**
  3352. * Updates the given vector "result" coordinates from the given floats.
  3353. * @param x float to set from
  3354. * @param y float to set from
  3355. * @param z float to set from
  3356. * @param w float to set from
  3357. * @param result the vector to the floats in
  3358. */
  3359. static FromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): void;
  3360. /**
  3361. * Returns a new Vector4 set to (0.0, 0.0, 0.0, 0.0)
  3362. * @returns the new vector
  3363. */
  3364. static Zero(): Vector4;
  3365. /**
  3366. * Returns a new Vector4 set to (1.0, 1.0, 1.0, 1.0)
  3367. * @returns the new vector
  3368. */
  3369. static One(): Vector4;
  3370. /**
  3371. * Returns a new normalized Vector4 from the given one.
  3372. * @param vector the vector to normalize
  3373. * @returns the vector
  3374. */
  3375. static Normalize(vector: DeepImmutable<Vector4>): Vector4;
  3376. /**
  3377. * Updates the given vector "result" from the normalization of the given one.
  3378. * @param vector the vector to normalize
  3379. * @param result the vector to store the result in
  3380. */
  3381. static NormalizeToRef(vector: DeepImmutable<Vector4>, result: Vector4): void;
  3382. /**
  3383. * Returns a vector with the minimum values from the left and right vectors
  3384. * @param left left vector to minimize
  3385. * @param right right vector to minimize
  3386. * @returns a new vector with the minimum of the left and right vector values
  3387. */
  3388. static Minimize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  3389. /**
  3390. * Returns a vector with the maximum values from the left and right vectors
  3391. * @param left left vector to maximize
  3392. * @param right right vector to maximize
  3393. * @returns a new vector with the maximum of the left and right vector values
  3394. */
  3395. static Maximize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  3396. /**
  3397. * Returns the distance (float) between the vectors "value1" and "value2".
  3398. * @param value1 value to calulate the distance between
  3399. * @param value2 value to calulate the distance between
  3400. * @return the distance between the two vectors
  3401. */
  3402. static Distance(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  3403. /**
  3404. * Returns the squared distance (float) between the vectors "value1" and "value2".
  3405. * @param value1 value to calulate the distance between
  3406. * @param value2 value to calulate the distance between
  3407. * @return the distance between the two vectors squared
  3408. */
  3409. static DistanceSquared(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  3410. /**
  3411. * Returns a new Vector4 located at the center between the vectors "value1" and "value2".
  3412. * @param value1 value to calulate the center between
  3413. * @param value2 value to calulate the center between
  3414. * @return the center between the two vectors
  3415. */
  3416. static Center(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): Vector4;
  3417. /**
  3418. * Returns a new Vector4 set with the result of the normal transformation by the given matrix of the given vector.
  3419. * This methods computes transformed normalized direction vectors only.
  3420. * @param vector the vector to transform
  3421. * @param transformation the transformation matrix to apply
  3422. * @returns the new vector
  3423. */
  3424. static TransformNormal(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>): Vector4;
  3425. /**
  3426. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector.
  3427. * This methods computes transformed normalized direction vectors only.
  3428. * @param vector the vector to transform
  3429. * @param transformation the transformation matrix to apply
  3430. * @param result the vector to store the result in
  3431. */
  3432. static TransformNormalToRef(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  3433. /**
  3434. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z, w).
  3435. * This methods computes transformed normalized direction vectors only.
  3436. * @param x value to transform
  3437. * @param y value to transform
  3438. * @param z value to transform
  3439. * @param w value to transform
  3440. * @param transformation the transformation matrix to apply
  3441. * @param result the vector to store the results in
  3442. */
  3443. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, w: number, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  3444. /**
  3445. * Creates a new Vector4 from a Vector3
  3446. * @param source defines the source data
  3447. * @param w defines the 4th component (default is 0)
  3448. * @returns a new Vector4
  3449. */
  3450. static FromVector3(source: Vector3, w?: number): Vector4;
  3451. }
  3452. /**
  3453. * Class used to store quaternion data
  3454. * @see https://en.wikipedia.org/wiki/Quaternion
  3455. * @see http://doc.babylonjs.com/features/position,_rotation,_scaling
  3456. */
  3457. export class Quaternion {
  3458. /** defines the first component (0 by default) */
  3459. x: number;
  3460. /** defines the second component (0 by default) */
  3461. y: number;
  3462. /** defines the third component (0 by default) */
  3463. z: number;
  3464. /** defines the fourth component (1.0 by default) */
  3465. w: number;
  3466. /**
  3467. * Creates a new Quaternion from the given floats
  3468. * @param x defines the first component (0 by default)
  3469. * @param y defines the second component (0 by default)
  3470. * @param z defines the third component (0 by default)
  3471. * @param w defines the fourth component (1.0 by default)
  3472. */
  3473. constructor(
  3474. /** defines the first component (0 by default) */
  3475. x?: number,
  3476. /** defines the second component (0 by default) */
  3477. y?: number,
  3478. /** defines the third component (0 by default) */
  3479. z?: number,
  3480. /** defines the fourth component (1.0 by default) */
  3481. w?: number);
  3482. /**
  3483. * Gets a string representation for the current quaternion
  3484. * @returns a string with the Quaternion coordinates
  3485. */
  3486. toString(): string;
  3487. /**
  3488. * Gets the class name of the quaternion
  3489. * @returns the string "Quaternion"
  3490. */
  3491. getClassName(): string;
  3492. /**
  3493. * Gets a hash code for this quaternion
  3494. * @returns the quaternion hash code
  3495. */
  3496. getHashCode(): number;
  3497. /**
  3498. * Copy the quaternion to an array
  3499. * @returns a new array populated with 4 elements from the quaternion coordinates
  3500. */
  3501. asArray(): number[];
  3502. /**
  3503. * Check if two quaternions are equals
  3504. * @param otherQuaternion defines the second operand
  3505. * @return true if the current quaternion and the given one coordinates are strictly equals
  3506. */
  3507. equals(otherQuaternion: DeepImmutable<Quaternion>): boolean;
  3508. /**
  3509. * Clone the current quaternion
  3510. * @returns a new quaternion copied from the current one
  3511. */
  3512. clone(): Quaternion;
  3513. /**
  3514. * Copy a quaternion to the current one
  3515. * @param other defines the other quaternion
  3516. * @returns the updated current quaternion
  3517. */
  3518. copyFrom(other: DeepImmutable<Quaternion>): Quaternion;
  3519. /**
  3520. * Updates the current quaternion with the given float coordinates
  3521. * @param x defines the x coordinate
  3522. * @param y defines the y coordinate
  3523. * @param z defines the z coordinate
  3524. * @param w defines the w coordinate
  3525. * @returns the updated current quaternion
  3526. */
  3527. copyFromFloats(x: number, y: number, z: number, w: number): Quaternion;
  3528. /**
  3529. * Updates the current quaternion from the given float coordinates
  3530. * @param x defines the x coordinate
  3531. * @param y defines the y coordinate
  3532. * @param z defines the z coordinate
  3533. * @param w defines the w coordinate
  3534. * @returns the updated current quaternion
  3535. */
  3536. set(x: number, y: number, z: number, w: number): Quaternion;
  3537. /**
  3538. * Adds two quaternions
  3539. * @param other defines the second operand
  3540. * @returns a new quaternion as the addition result of the given one and the current quaternion
  3541. */
  3542. add(other: DeepImmutable<Quaternion>): Quaternion;
  3543. /**
  3544. * Add a quaternion to the current one
  3545. * @param other defines the quaternion to add
  3546. * @returns the current quaternion
  3547. */
  3548. addInPlace(other: DeepImmutable<Quaternion>): Quaternion;
  3549. /**
  3550. * Subtract two quaternions
  3551. * @param other defines the second operand
  3552. * @returns a new quaternion as the subtraction result of the given one from the current one
  3553. */
  3554. subtract(other: Quaternion): Quaternion;
  3555. /**
  3556. * Multiplies the current quaternion by a scale factor
  3557. * @param value defines the scale factor
  3558. * @returns a new quaternion set by multiplying the current quaternion coordinates by the float "scale"
  3559. */
  3560. scale(value: number): Quaternion;
  3561. /**
  3562. * Scale the current quaternion values by a factor and stores the result to a given quaternion
  3563. * @param scale defines the scale factor
  3564. * @param result defines the Quaternion object where to store the result
  3565. * @returns the unmodified current quaternion
  3566. */
  3567. scaleToRef(scale: number, result: Quaternion): Quaternion;
  3568. /**
  3569. * Multiplies in place the current quaternion by a scale factor
  3570. * @param value defines the scale factor
  3571. * @returns the current modified quaternion
  3572. */
  3573. scaleInPlace(value: number): Quaternion;
  3574. /**
  3575. * Scale the current quaternion values by a factor and add the result to a given quaternion
  3576. * @param scale defines the scale factor
  3577. * @param result defines the Quaternion object where to store the result
  3578. * @returns the unmodified current quaternion
  3579. */
  3580. scaleAndAddToRef(scale: number, result: Quaternion): Quaternion;
  3581. /**
  3582. * Multiplies two quaternions
  3583. * @param q1 defines the second operand
  3584. * @returns a new quaternion set as the multiplication result of the current one with the given one "q1"
  3585. */
  3586. multiply(q1: DeepImmutable<Quaternion>): Quaternion;
  3587. /**
  3588. * Sets the given "result" as the the multiplication result of the current one with the given one "q1"
  3589. * @param q1 defines the second operand
  3590. * @param result defines the target quaternion
  3591. * @returns the current quaternion
  3592. */
  3593. multiplyToRef(q1: DeepImmutable<Quaternion>, result: Quaternion): Quaternion;
  3594. /**
  3595. * Updates the current quaternion with the multiplication of itself with the given one "q1"
  3596. * @param q1 defines the second operand
  3597. * @returns the currentupdated quaternion
  3598. */
  3599. multiplyInPlace(q1: DeepImmutable<Quaternion>): Quaternion;
  3600. /**
  3601. * Conjugates (1-q) the current quaternion and stores the result in the given quaternion
  3602. * @param ref defines the target quaternion
  3603. * @returns the current quaternion
  3604. */
  3605. conjugateToRef(ref: Quaternion): Quaternion;
  3606. /**
  3607. * Conjugates in place (1-q) the current quaternion
  3608. * @returns the current updated quaternion
  3609. */
  3610. conjugateInPlace(): Quaternion;
  3611. /**
  3612. * Conjugates in place (1-q) the current quaternion
  3613. * @returns a new quaternion
  3614. */
  3615. conjugate(): Quaternion;
  3616. /**
  3617. * Gets length of current quaternion
  3618. * @returns the quaternion length (float)
  3619. */
  3620. length(): number;
  3621. /**
  3622. * Normalize in place the current quaternion
  3623. * @returns the current updated quaternion
  3624. */
  3625. normalize(): Quaternion;
  3626. /**
  3627. * Returns a new Vector3 set with the Euler angles translated from the current quaternion
  3628. * @param order is a reserved parameter and is ignore for now
  3629. * @returns a new Vector3 containing the Euler angles
  3630. */
  3631. toEulerAngles(order?: string): Vector3;
  3632. /**
  3633. * Sets the given vector3 "result" with the Euler angles translated from the current quaternion
  3634. * @param result defines the vector which will be filled with the Euler angles
  3635. * @param order is a reserved parameter and is ignore for now
  3636. * @returns the current unchanged quaternion
  3637. */
  3638. toEulerAnglesToRef(result: Vector3): Quaternion;
  3639. /**
  3640. * Updates the given rotation matrix with the current quaternion values
  3641. * @param result defines the target matrix
  3642. * @returns the current unchanged quaternion
  3643. */
  3644. toRotationMatrix(result: Matrix): Quaternion;
  3645. /**
  3646. * Updates the current quaternion from the given rotation matrix values
  3647. * @param matrix defines the source matrix
  3648. * @returns the current updated quaternion
  3649. */
  3650. fromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  3651. /**
  3652. * Creates a new quaternion from a rotation matrix
  3653. * @param matrix defines the source matrix
  3654. * @returns a new quaternion created from the given rotation matrix values
  3655. */
  3656. static FromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  3657. /**
  3658. * Updates the given quaternion with the given rotation matrix values
  3659. * @param matrix defines the source matrix
  3660. * @param result defines the target quaternion
  3661. */
  3662. static FromRotationMatrixToRef(matrix: DeepImmutable<Matrix>, result: Quaternion): void;
  3663. /**
  3664. * Returns the dot product (float) between the quaternions "left" and "right"
  3665. * @param left defines the left operand
  3666. * @param right defines the right operand
  3667. * @returns the dot product
  3668. */
  3669. static Dot(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>): number;
  3670. /**
  3671. * Checks if the two quaternions are close to each other
  3672. * @param quat0 defines the first quaternion to check
  3673. * @param quat1 defines the second quaternion to check
  3674. * @returns true if the two quaternions are close to each other
  3675. */
  3676. static AreClose(quat0: DeepImmutable<Quaternion>, quat1: DeepImmutable<Quaternion>): boolean;
  3677. /**
  3678. * Creates an empty quaternion
  3679. * @returns a new quaternion set to (0.0, 0.0, 0.0)
  3680. */
  3681. static Zero(): Quaternion;
  3682. /**
  3683. * Inverse a given quaternion
  3684. * @param q defines the source quaternion
  3685. * @returns a new quaternion as the inverted current quaternion
  3686. */
  3687. static Inverse(q: DeepImmutable<Quaternion>): Quaternion;
  3688. /**
  3689. * Inverse a given quaternion
  3690. * @param q defines the source quaternion
  3691. * @param result the quaternion the result will be stored in
  3692. * @returns the result quaternion
  3693. */
  3694. static InverseToRef(q: Quaternion, result: Quaternion): Quaternion;
  3695. /**
  3696. * Creates an identity quaternion
  3697. * @returns the identity quaternion
  3698. */
  3699. static Identity(): Quaternion;
  3700. /**
  3701. * Gets a boolean indicating if the given quaternion is identity
  3702. * @param quaternion defines the quaternion to check
  3703. * @returns true if the quaternion is identity
  3704. */
  3705. static IsIdentity(quaternion: DeepImmutable<Quaternion>): boolean;
  3706. /**
  3707. * Creates a quaternion from a rotation around an axis
  3708. * @param axis defines the axis to use
  3709. * @param angle defines the angle to use
  3710. * @returns a new quaternion created from the given axis (Vector3) and angle in radians (float)
  3711. */
  3712. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Quaternion;
  3713. /**
  3714. * Creates a rotation around an axis and stores it into the given quaternion
  3715. * @param axis defines the axis to use
  3716. * @param angle defines the angle to use
  3717. * @param result defines the target quaternion
  3718. * @returns the target quaternion
  3719. */
  3720. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Quaternion): Quaternion;
  3721. /**
  3722. * Creates a new quaternion from data stored into an array
  3723. * @param array defines the data source
  3724. * @param offset defines the offset in the source array where the data starts
  3725. * @returns a new quaternion
  3726. */
  3727. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Quaternion;
  3728. /**
  3729. * Create a quaternion from Euler rotation angles
  3730. * @param x Pitch
  3731. * @param y Yaw
  3732. * @param z Roll
  3733. * @returns the new Quaternion
  3734. */
  3735. static FromEulerAngles(x: number, y: number, z: number): Quaternion;
  3736. /**
  3737. * Updates a quaternion from Euler rotation angles
  3738. * @param x Pitch
  3739. * @param y Yaw
  3740. * @param z Roll
  3741. * @param result the quaternion to store the result
  3742. * @returns the updated quaternion
  3743. */
  3744. static FromEulerAnglesToRef(x: number, y: number, z: number, result: Quaternion): Quaternion;
  3745. /**
  3746. * Create a quaternion from Euler rotation vector
  3747. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  3748. * @returns the new Quaternion
  3749. */
  3750. static FromEulerVector(vec: DeepImmutable<Vector3>): Quaternion;
  3751. /**
  3752. * Updates a quaternion from Euler rotation vector
  3753. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  3754. * @param result the quaternion to store the result
  3755. * @returns the updated quaternion
  3756. */
  3757. static FromEulerVectorToRef(vec: DeepImmutable<Vector3>, result: Quaternion): Quaternion;
  3758. /**
  3759. * Creates a new quaternion from the given Euler float angles (y, x, z)
  3760. * @param yaw defines the rotation around Y axis
  3761. * @param pitch defines the rotation around X axis
  3762. * @param roll defines the rotation around Z axis
  3763. * @returns the new quaternion
  3764. */
  3765. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Quaternion;
  3766. /**
  3767. * Creates a new rotation from the given Euler float angles (y, x, z) and stores it in the target quaternion
  3768. * @param yaw defines the rotation around Y axis
  3769. * @param pitch defines the rotation around X axis
  3770. * @param roll defines the rotation around Z axis
  3771. * @param result defines the target quaternion
  3772. */
  3773. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Quaternion): void;
  3774. /**
  3775. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation
  3776. * @param alpha defines the rotation around first axis
  3777. * @param beta defines the rotation around second axis
  3778. * @param gamma defines the rotation around third axis
  3779. * @returns the new quaternion
  3780. */
  3781. static RotationAlphaBetaGamma(alpha: number, beta: number, gamma: number): Quaternion;
  3782. /**
  3783. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation and stores it in the target quaternion
  3784. * @param alpha defines the rotation around first axis
  3785. * @param beta defines the rotation around second axis
  3786. * @param gamma defines the rotation around third axis
  3787. * @param result defines the target quaternion
  3788. */
  3789. static RotationAlphaBetaGammaToRef(alpha: number, beta: number, gamma: number, result: Quaternion): void;
  3790. /**
  3791. * Creates a new quaternion containing the rotation value to reach the target (axis1, axis2, axis3) orientation as a rotated XYZ system (axis1, axis2 and axis3 are normalized during this operation)
  3792. * @param axis1 defines the first axis
  3793. * @param axis2 defines the second axis
  3794. * @param axis3 defines the third axis
  3795. * @returns the new quaternion
  3796. */
  3797. static RotationQuaternionFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Quaternion;
  3798. /**
  3799. * Creates a rotation value to reach the target (axis1, axis2, axis3) orientation as a rotated XYZ system (axis1, axis2 and axis3 are normalized during this operation) and stores it in the target quaternion
  3800. * @param axis1 defines the first axis
  3801. * @param axis2 defines the second axis
  3802. * @param axis3 defines the third axis
  3803. * @param ref defines the target quaternion
  3804. */
  3805. static RotationQuaternionFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Quaternion): void;
  3806. /**
  3807. * Interpolates between two quaternions
  3808. * @param left defines first quaternion
  3809. * @param right defines second quaternion
  3810. * @param amount defines the gradient to use
  3811. * @returns the new interpolated quaternion
  3812. */
  3813. static Slerp(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number): Quaternion;
  3814. /**
  3815. * Interpolates between two quaternions and stores it into a target quaternion
  3816. * @param left defines first quaternion
  3817. * @param right defines second quaternion
  3818. * @param amount defines the gradient to use
  3819. * @param result defines the target quaternion
  3820. */
  3821. static SlerpToRef(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number, result: Quaternion): void;
  3822. /**
  3823. * Interpolate between two quaternions using Hermite interpolation
  3824. * @param value1 defines first quaternion
  3825. * @param tangent1 defines the incoming tangent
  3826. * @param value2 defines second quaternion
  3827. * @param tangent2 defines the outgoing tangent
  3828. * @param amount defines the target quaternion
  3829. * @returns the new interpolated quaternion
  3830. */
  3831. static Hermite(value1: DeepImmutable<Quaternion>, tangent1: DeepImmutable<Quaternion>, value2: DeepImmutable<Quaternion>, tangent2: DeepImmutable<Quaternion>, amount: number): Quaternion;
  3832. }
  3833. /**
  3834. * Class used to store matrix data (4x4)
  3835. */
  3836. export class Matrix {
  3837. private static _updateFlagSeed;
  3838. private static _identityReadOnly;
  3839. private _isIdentity;
  3840. private _isIdentityDirty;
  3841. private _isIdentity3x2;
  3842. private _isIdentity3x2Dirty;
  3843. /**
  3844. * Gets the update flag of the matrix which is an unique number for the matrix.
  3845. * It will be incremented every time the matrix data change.
  3846. * You can use it to speed the comparison between two versions of the same matrix.
  3847. */
  3848. updateFlag: number;
  3849. private readonly _m;
  3850. /**
  3851. * Gets the internal data of the matrix
  3852. */
  3853. readonly m: DeepImmutable<Float32Array>;
  3854. /** @hidden */
  3855. _markAsUpdated(): void;
  3856. /** @hidden */
  3857. private _updateIdentityStatus;
  3858. /**
  3859. * Creates an empty matrix (filled with zeros)
  3860. */
  3861. constructor();
  3862. /**
  3863. * Check if the current matrix is identity
  3864. * @returns true is the matrix is the identity matrix
  3865. */
  3866. isIdentity(): boolean;
  3867. /**
  3868. * Check if the current matrix is identity as a texture matrix (3x2 store in 4x4)
  3869. * @returns true is the matrix is the identity matrix
  3870. */
  3871. isIdentityAs3x2(): boolean;
  3872. /**
  3873. * Gets the determinant of the matrix
  3874. * @returns the matrix determinant
  3875. */
  3876. determinant(): number;
  3877. /**
  3878. * Returns the matrix as a Float32Array
  3879. * @returns the matrix underlying array
  3880. */
  3881. toArray(): DeepImmutable<Float32Array>;
  3882. /**
  3883. * Returns the matrix as a Float32Array
  3884. * @returns the matrix underlying array.
  3885. */
  3886. asArray(): DeepImmutable<Float32Array>;
  3887. /**
  3888. * Inverts the current matrix in place
  3889. * @returns the current inverted matrix
  3890. */
  3891. invert(): Matrix;
  3892. /**
  3893. * Sets all the matrix elements to zero
  3894. * @returns the current matrix
  3895. */
  3896. reset(): Matrix;
  3897. /**
  3898. * Adds the current matrix with a second one
  3899. * @param other defines the matrix to add
  3900. * @returns a new matrix as the addition of the current matrix and the given one
  3901. */
  3902. add(other: DeepImmutable<Matrix>): Matrix;
  3903. /**
  3904. * Sets the given matrix "result" to the addition of the current matrix and the given one
  3905. * @param other defines the matrix to add
  3906. * @param result defines the target matrix
  3907. * @returns the current matrix
  3908. */
  3909. addToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  3910. /**
  3911. * Adds in place the given matrix to the current matrix
  3912. * @param other defines the second operand
  3913. * @returns the current updated matrix
  3914. */
  3915. addToSelf(other: DeepImmutable<Matrix>): Matrix;
  3916. /**
  3917. * Sets the given matrix to the current inverted Matrix
  3918. * @param other defines the target matrix
  3919. * @returns the unmodified current matrix
  3920. */
  3921. invertToRef(other: Matrix): Matrix;
  3922. /**
  3923. * add a value at the specified position in the current Matrix
  3924. * @param index the index of the value within the matrix. between 0 and 15.
  3925. * @param value the value to be added
  3926. * @returns the current updated matrix
  3927. */
  3928. addAtIndex(index: number, value: number): Matrix;
  3929. /**
  3930. * mutiply the specified position in the current Matrix by a value
  3931. * @param index the index of the value within the matrix. between 0 and 15.
  3932. * @param value the value to be added
  3933. * @returns the current updated matrix
  3934. */
  3935. multiplyAtIndex(index: number, value: number): Matrix;
  3936. /**
  3937. * Inserts the translation vector (using 3 floats) in the current matrix
  3938. * @param x defines the 1st component of the translation
  3939. * @param y defines the 2nd component of the translation
  3940. * @param z defines the 3rd component of the translation
  3941. * @returns the current updated matrix
  3942. */
  3943. setTranslationFromFloats(x: number, y: number, z: number): Matrix;
  3944. /**
  3945. * Adds the translation vector (using 3 floats) in the current matrix
  3946. * @param x defines the 1st component of the translation
  3947. * @param y defines the 2nd component of the translation
  3948. * @param z defines the 3rd component of the translation
  3949. * @returns the current updated matrix
  3950. */
  3951. addTranslationFromFloats(x: number, y: number, z: number): Matrix;
  3952. /**
  3953. * Inserts the translation vector in the current matrix
  3954. * @param vector3 defines the translation to insert
  3955. * @returns the current updated matrix
  3956. */
  3957. setTranslation(vector3: DeepImmutable<Vector3>): Matrix;
  3958. /**
  3959. * Gets the translation value of the current matrix
  3960. * @returns a new Vector3 as the extracted translation from the matrix
  3961. */
  3962. getTranslation(): Vector3;
  3963. /**
  3964. * Fill a Vector3 with the extracted translation from the matrix
  3965. * @param result defines the Vector3 where to store the translation
  3966. * @returns the current matrix
  3967. */
  3968. getTranslationToRef(result: Vector3): Matrix;
  3969. /**
  3970. * Remove rotation and scaling part from the matrix
  3971. * @returns the updated matrix
  3972. */
  3973. removeRotationAndScaling(): Matrix;
  3974. /**
  3975. * Multiply two matrices
  3976. * @param other defines the second operand
  3977. * @returns a new matrix set with the multiplication result of the current Matrix and the given one
  3978. */
  3979. multiply(other: DeepImmutable<Matrix>): Matrix;
  3980. /**
  3981. * Copy the current matrix from the given one
  3982. * @param other defines the source matrix
  3983. * @returns the current updated matrix
  3984. */
  3985. copyFrom(other: DeepImmutable<Matrix>): Matrix;
  3986. /**
  3987. * Populates the given array from the starting index with the current matrix values
  3988. * @param array defines the target array
  3989. * @param offset defines the offset in the target array where to start storing values
  3990. * @returns the current matrix
  3991. */
  3992. copyToArray(array: Float32Array, offset?: number): Matrix;
  3993. /**
  3994. * Sets the given matrix "result" with the multiplication result of the current Matrix and the given one
  3995. * @param other defines the second operand
  3996. * @param result defines the matrix where to store the multiplication
  3997. * @returns the current matrix
  3998. */
  3999. multiplyToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  4000. /**
  4001. * Sets the Float32Array "result" from the given index "offset" with the multiplication of the current matrix and the given one
  4002. * @param other defines the second operand
  4003. * @param result defines the array where to store the multiplication
  4004. * @param offset defines the offset in the target array where to start storing values
  4005. * @returns the current matrix
  4006. */
  4007. multiplyToArray(other: DeepImmutable<Matrix>, result: Float32Array, offset: number): Matrix;
  4008. /**
  4009. * Check equality between this matrix and a second one
  4010. * @param value defines the second matrix to compare
  4011. * @returns true is the current matrix and the given one values are strictly equal
  4012. */
  4013. equals(value: DeepImmutable<Matrix>): boolean;
  4014. /**
  4015. * Clone the current matrix
  4016. * @returns a new matrix from the current matrix
  4017. */
  4018. clone(): Matrix;
  4019. /**
  4020. * Returns the name of the current matrix class
  4021. * @returns the string "Matrix"
  4022. */
  4023. getClassName(): string;
  4024. /**
  4025. * Gets the hash code of the current matrix
  4026. * @returns the hash code
  4027. */
  4028. getHashCode(): number;
  4029. /**
  4030. * Decomposes the current Matrix into a translation, rotation and scaling components
  4031. * @param scale defines the scale vector3 given as a reference to update
  4032. * @param rotation defines the rotation quaternion given as a reference to update
  4033. * @param translation defines the translation vector3 given as a reference to update
  4034. * @returns true if operation was successful
  4035. */
  4036. decompose(scale?: Vector3, rotation?: Quaternion, translation?: Vector3): boolean;
  4037. /**
  4038. * Gets specific row of the matrix
  4039. * @param index defines the number of the row to get
  4040. * @returns the index-th row of the current matrix as a new Vector4
  4041. */
  4042. getRow(index: number): Nullable<Vector4>;
  4043. /**
  4044. * Sets the index-th row of the current matrix to the vector4 values
  4045. * @param index defines the number of the row to set
  4046. * @param row defines the target vector4
  4047. * @returns the updated current matrix
  4048. */
  4049. setRow(index: number, row: Vector4): Matrix;
  4050. /**
  4051. * Compute the transpose of the matrix
  4052. * @returns the new transposed matrix
  4053. */
  4054. transpose(): Matrix;
  4055. /**
  4056. * Compute the transpose of the matrix and store it in a given matrix
  4057. * @param result defines the target matrix
  4058. * @returns the current matrix
  4059. */
  4060. transposeToRef(result: Matrix): Matrix;
  4061. /**
  4062. * Sets the index-th row of the current matrix with the given 4 x float values
  4063. * @param index defines the row index
  4064. * @param x defines the x component to set
  4065. * @param y defines the y component to set
  4066. * @param z defines the z component to set
  4067. * @param w defines the w component to set
  4068. * @returns the updated current matrix
  4069. */
  4070. setRowFromFloats(index: number, x: number, y: number, z: number, w: number): Matrix;
  4071. /**
  4072. * Compute a new matrix set with the current matrix values multiplied by scale (float)
  4073. * @param scale defines the scale factor
  4074. * @returns a new matrix
  4075. */
  4076. scale(scale: number): Matrix;
  4077. /**
  4078. * Scale the current matrix values by a factor to a given result matrix
  4079. * @param scale defines the scale factor
  4080. * @param result defines the matrix to store the result
  4081. * @returns the current matrix
  4082. */
  4083. scaleToRef(scale: number, result: Matrix): Matrix;
  4084. /**
  4085. * Scale the current matrix values by a factor and add the result to a given matrix
  4086. * @param scale defines the scale factor
  4087. * @param result defines the Matrix to store the result
  4088. * @returns the current matrix
  4089. */
  4090. scaleAndAddToRef(scale: number, result: Matrix): Matrix;
  4091. /**
  4092. * Writes to the given matrix a normal matrix, computed from this one (using values from identity matrix for fourth row and column).
  4093. * @param ref matrix to store the result
  4094. */
  4095. toNormalMatrix(ref: Matrix): void;
  4096. /**
  4097. * Gets only rotation part of the current matrix
  4098. * @returns a new matrix sets to the extracted rotation matrix from the current one
  4099. */
  4100. getRotationMatrix(): Matrix;
  4101. /**
  4102. * Extracts the rotation matrix from the current one and sets it as the given "result"
  4103. * @param result defines the target matrix to store data to
  4104. * @returns the current matrix
  4105. */
  4106. getRotationMatrixToRef(result: Matrix): Matrix;
  4107. /**
  4108. * Toggles model matrix from being right handed to left handed in place and vice versa
  4109. */
  4110. toggleModelMatrixHandInPlace(): void;
  4111. /**
  4112. * Toggles projection matrix from being right handed to left handed in place and vice versa
  4113. */
  4114. toggleProjectionMatrixHandInPlace(): void;
  4115. /**
  4116. * Creates a matrix from an array
  4117. * @param array defines the source array
  4118. * @param offset defines an offset in the source array
  4119. * @returns a new Matrix set from the starting index of the given array
  4120. */
  4121. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Matrix;
  4122. /**
  4123. * Copy the content of an array into a given matrix
  4124. * @param array defines the source array
  4125. * @param offset defines an offset in the source array
  4126. * @param result defines the target matrix
  4127. */
  4128. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Matrix): void;
  4129. /**
  4130. * Stores an array into a matrix after having multiplied each component by a given factor
  4131. * @param array defines the source array
  4132. * @param offset defines the offset in the source array
  4133. * @param scale defines the scaling factor
  4134. * @param result defines the target matrix
  4135. */
  4136. static FromFloat32ArrayToRefScaled(array: DeepImmutable<Float32Array>, offset: number, scale: number, result: Matrix): void;
  4137. /**
  4138. * Gets an identity matrix that must not be updated
  4139. */
  4140. static readonly IdentityReadOnly: DeepImmutable<Matrix>;
  4141. /**
  4142. * Stores a list of values (16) inside a given matrix
  4143. * @param initialM11 defines 1st value of 1st row
  4144. * @param initialM12 defines 2nd value of 1st row
  4145. * @param initialM13 defines 3rd value of 1st row
  4146. * @param initialM14 defines 4th value of 1st row
  4147. * @param initialM21 defines 1st value of 2nd row
  4148. * @param initialM22 defines 2nd value of 2nd row
  4149. * @param initialM23 defines 3rd value of 2nd row
  4150. * @param initialM24 defines 4th value of 2nd row
  4151. * @param initialM31 defines 1st value of 3rd row
  4152. * @param initialM32 defines 2nd value of 3rd row
  4153. * @param initialM33 defines 3rd value of 3rd row
  4154. * @param initialM34 defines 4th value of 3rd row
  4155. * @param initialM41 defines 1st value of 4th row
  4156. * @param initialM42 defines 2nd value of 4th row
  4157. * @param initialM43 defines 3rd value of 4th row
  4158. * @param initialM44 defines 4th value of 4th row
  4159. * @param result defines the target matrix
  4160. */
  4161. static FromValuesToRef(initialM11: number, initialM12: number, initialM13: number, initialM14: number, initialM21: number, initialM22: number, initialM23: number, initialM24: number, initialM31: number, initialM32: number, initialM33: number, initialM34: number, initialM41: number, initialM42: number, initialM43: number, initialM44: number, result: Matrix): void;
  4162. /**
  4163. * Creates new matrix from a list of values (16)
  4164. * @param initialM11 defines 1st value of 1st row
  4165. * @param initialM12 defines 2nd value of 1st row
  4166. * @param initialM13 defines 3rd value of 1st row
  4167. * @param initialM14 defines 4th value of 1st row
  4168. * @param initialM21 defines 1st value of 2nd row
  4169. * @param initialM22 defines 2nd value of 2nd row
  4170. * @param initialM23 defines 3rd value of 2nd row
  4171. * @param initialM24 defines 4th value of 2nd row
  4172. * @param initialM31 defines 1st value of 3rd row
  4173. * @param initialM32 defines 2nd value of 3rd row
  4174. * @param initialM33 defines 3rd value of 3rd row
  4175. * @param initialM34 defines 4th value of 3rd row
  4176. * @param initialM41 defines 1st value of 4th row
  4177. * @param initialM42 defines 2nd value of 4th row
  4178. * @param initialM43 defines 3rd value of 4th row
  4179. * @param initialM44 defines 4th value of 4th row
  4180. * @returns the new matrix
  4181. */
  4182. static FromValues(initialM11: number, initialM12: number, initialM13: number, initialM14: number, initialM21: number, initialM22: number, initialM23: number, initialM24: number, initialM31: number, initialM32: number, initialM33: number, initialM34: number, initialM41: number, initialM42: number, initialM43: number, initialM44: number): Matrix;
  4183. /**
  4184. * Creates a new matrix composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  4185. * @param scale defines the scale vector3
  4186. * @param rotation defines the rotation quaternion
  4187. * @param translation defines the translation vector3
  4188. * @returns a new matrix
  4189. */
  4190. static Compose(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>): Matrix;
  4191. /**
  4192. * Sets a matrix to a value composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  4193. * @param scale defines the scale vector3
  4194. * @param rotation defines the rotation quaternion
  4195. * @param translation defines the translation vector3
  4196. * @param result defines the target matrix
  4197. */
  4198. static ComposeToRef(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>, result: Matrix): void;
  4199. /**
  4200. * Creates a new identity matrix
  4201. * @returns a new identity matrix
  4202. */
  4203. static Identity(): Matrix;
  4204. /**
  4205. * Creates a new identity matrix and stores the result in a given matrix
  4206. * @param result defines the target matrix
  4207. */
  4208. static IdentityToRef(result: Matrix): void;
  4209. /**
  4210. * Creates a new zero matrix
  4211. * @returns a new zero matrix
  4212. */
  4213. static Zero(): Matrix;
  4214. /**
  4215. * Creates a new rotation matrix for "angle" radians around the X axis
  4216. * @param angle defines the angle (in radians) to use
  4217. * @return the new matrix
  4218. */
  4219. static RotationX(angle: number): Matrix;
  4220. /**
  4221. * Creates a new matrix as the invert of a given matrix
  4222. * @param source defines the source matrix
  4223. * @returns the new matrix
  4224. */
  4225. static Invert(source: DeepImmutable<Matrix>): Matrix;
  4226. /**
  4227. * Creates a new rotation matrix for "angle" radians around the X axis and stores it in a given matrix
  4228. * @param angle defines the angle (in radians) to use
  4229. * @param result defines the target matrix
  4230. */
  4231. static RotationXToRef(angle: number, result: Matrix): void;
  4232. /**
  4233. * Creates a new rotation matrix for "angle" radians around the Y axis
  4234. * @param angle defines the angle (in radians) to use
  4235. * @return the new matrix
  4236. */
  4237. static RotationY(angle: number): Matrix;
  4238. /**
  4239. * Creates a new rotation matrix for "angle" radians around the Y axis and stores it in a given matrix
  4240. * @param angle defines the angle (in radians) to use
  4241. * @param result defines the target matrix
  4242. */
  4243. static RotationYToRef(angle: number, result: Matrix): void;
  4244. /**
  4245. * Creates a new rotation matrix for "angle" radians around the Z axis
  4246. * @param angle defines the angle (in radians) to use
  4247. * @return the new matrix
  4248. */
  4249. static RotationZ(angle: number): Matrix;
  4250. /**
  4251. * Creates a new rotation matrix for "angle" radians around the Z axis and stores it in a given matrix
  4252. * @param angle defines the angle (in radians) to use
  4253. * @param result defines the target matrix
  4254. */
  4255. static RotationZToRef(angle: number, result: Matrix): void;
  4256. /**
  4257. * Creates a new rotation matrix for "angle" radians around the given axis
  4258. * @param axis defines the axis to use
  4259. * @param angle defines the angle (in radians) to use
  4260. * @return the new matrix
  4261. */
  4262. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Matrix;
  4263. /**
  4264. * Creates a new rotation matrix for "angle" radians around the given axis and stores it in a given matrix
  4265. * @param axis defines the axis to use
  4266. * @param angle defines the angle (in radians) to use
  4267. * @param result defines the target matrix
  4268. */
  4269. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Matrix): void;
  4270. /**
  4271. * Takes normalised vectors and returns a rotation matrix to align "from" with "to".
  4272. * Taken from http://www.iquilezles.org/www/articles/noacos/noacos.htm
  4273. * @param from defines the vector to align
  4274. * @param to defines the vector to align to
  4275. * @param result defines the target matrix
  4276. */
  4277. static RotationAlignToRef(from: DeepImmutable<Vector3>, to: DeepImmutable<Vector3>, result: Matrix): void;
  4278. /**
  4279. * Creates a rotation matrix
  4280. * @param yaw defines the yaw angle in radians (Y axis)
  4281. * @param pitch defines the pitch angle in radians (X axis)
  4282. * @param roll defines the roll angle in radians (X axis)
  4283. * @returns the new rotation matrix
  4284. */
  4285. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Matrix;
  4286. /**
  4287. * Creates a rotation matrix and stores it in a given matrix
  4288. * @param yaw defines the yaw angle in radians (Y axis)
  4289. * @param pitch defines the pitch angle in radians (X axis)
  4290. * @param roll defines the roll angle in radians (X axis)
  4291. * @param result defines the target matrix
  4292. */
  4293. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Matrix): void;
  4294. /**
  4295. * Creates a scaling matrix
  4296. * @param x defines the scale factor on X axis
  4297. * @param y defines the scale factor on Y axis
  4298. * @param z defines the scale factor on Z axis
  4299. * @returns the new matrix
  4300. */
  4301. static Scaling(x: number, y: number, z: number): Matrix;
  4302. /**
  4303. * Creates a scaling matrix and stores it in a given matrix
  4304. * @param x defines the scale factor on X axis
  4305. * @param y defines the scale factor on Y axis
  4306. * @param z defines the scale factor on Z axis
  4307. * @param result defines the target matrix
  4308. */
  4309. static ScalingToRef(x: number, y: number, z: number, result: Matrix): void;
  4310. /**
  4311. * Creates a translation matrix
  4312. * @param x defines the translation on X axis
  4313. * @param y defines the translation on Y axis
  4314. * @param z defines the translationon Z axis
  4315. * @returns the new matrix
  4316. */
  4317. static Translation(x: number, y: number, z: number): Matrix;
  4318. /**
  4319. * Creates a translation matrix and stores it in a given matrix
  4320. * @param x defines the translation on X axis
  4321. * @param y defines the translation on Y axis
  4322. * @param z defines the translationon Z axis
  4323. * @param result defines the target matrix
  4324. */
  4325. static TranslationToRef(x: number, y: number, z: number, result: Matrix): void;
  4326. /**
  4327. * Returns a new Matrix whose values are the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  4328. * @param startValue defines the start value
  4329. * @param endValue defines the end value
  4330. * @param gradient defines the gradient factor
  4331. * @returns the new matrix
  4332. */
  4333. static Lerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  4334. /**
  4335. * Set the given matrix "result" as the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  4336. * @param startValue defines the start value
  4337. * @param endValue defines the end value
  4338. * @param gradient defines the gradient factor
  4339. * @param result defines the Matrix object where to store data
  4340. */
  4341. static LerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  4342. /**
  4343. * Builds a new matrix whose values are computed by:
  4344. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  4345. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  4346. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  4347. * @param startValue defines the first matrix
  4348. * @param endValue defines the second matrix
  4349. * @param gradient defines the gradient between the two matrices
  4350. * @returns the new matrix
  4351. */
  4352. static DecomposeLerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  4353. /**
  4354. * Update a matrix to values which are computed by:
  4355. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  4356. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  4357. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  4358. * @param startValue defines the first matrix
  4359. * @param endValue defines the second matrix
  4360. * @param gradient defines the gradient between the two matrices
  4361. * @param result defines the target matrix
  4362. */
  4363. static DecomposeLerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  4364. /**
  4365. * Gets a new rotation matrix used to rotate an entity so as it looks at the target vector3, from the eye vector3 position, the up vector3 being oriented like "up"
  4366. * This function works in left handed mode
  4367. * @param eye defines the final position of the entity
  4368. * @param target defines where the entity should look at
  4369. * @param up defines the up vector for the entity
  4370. * @returns the new matrix
  4371. */
  4372. static LookAtLH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  4373. /**
  4374. * Sets the given "result" Matrix to a rotation matrix used to rotate an entity so that it looks at the target vector3, from the eye vector3 position, the up vector3 being oriented like "up".
  4375. * This function works in left handed mode
  4376. * @param eye defines the final position of the entity
  4377. * @param target defines where the entity should look at
  4378. * @param up defines the up vector for the entity
  4379. * @param result defines the target matrix
  4380. */
  4381. static LookAtLHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  4382. /**
  4383. * Gets a new rotation matrix used to rotate an entity so as it looks at the target vector3, from the eye vector3 position, the up vector3 being oriented like "up"
  4384. * This function works in right handed mode
  4385. * @param eye defines the final position of the entity
  4386. * @param target defines where the entity should look at
  4387. * @param up defines the up vector for the entity
  4388. * @returns the new matrix
  4389. */
  4390. static LookAtRH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  4391. /**
  4392. * Sets the given "result" Matrix to a rotation matrix used to rotate an entity so that it looks at the target vector3, from the eye vector3 position, the up vector3 being oriented like "up".
  4393. * This function works in right handed mode
  4394. * @param eye defines the final position of the entity
  4395. * @param target defines where the entity should look at
  4396. * @param up defines the up vector for the entity
  4397. * @param result defines the target matrix
  4398. */
  4399. static LookAtRHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  4400. /**
  4401. * Create a left-handed orthographic projection matrix
  4402. * @param width defines the viewport width
  4403. * @param height defines the viewport height
  4404. * @param znear defines the near clip plane
  4405. * @param zfar defines the far clip plane
  4406. * @returns a new matrix as a left-handed orthographic projection matrix
  4407. */
  4408. static OrthoLH(width: number, height: number, znear: number, zfar: number): Matrix;
  4409. /**
  4410. * Store a left-handed orthographic projection to a given matrix
  4411. * @param width defines the viewport width
  4412. * @param height defines the viewport height
  4413. * @param znear defines the near clip plane
  4414. * @param zfar defines the far clip plane
  4415. * @param result defines the target matrix
  4416. */
  4417. static OrthoLHToRef(width: number, height: number, znear: number, zfar: number, result: Matrix): void;
  4418. /**
  4419. * Create a left-handed orthographic projection matrix
  4420. * @param left defines the viewport left coordinate
  4421. * @param right defines the viewport right coordinate
  4422. * @param bottom defines the viewport bottom coordinate
  4423. * @param top defines the viewport top coordinate
  4424. * @param znear defines the near clip plane
  4425. * @param zfar defines the far clip plane
  4426. * @returns a new matrix as a left-handed orthographic projection matrix
  4427. */
  4428. static OrthoOffCenterLH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  4429. /**
  4430. * Stores a left-handed orthographic projection into a given matrix
  4431. * @param left defines the viewport left coordinate
  4432. * @param right defines the viewport right coordinate
  4433. * @param bottom defines the viewport bottom coordinate
  4434. * @param top defines the viewport top coordinate
  4435. * @param znear defines the near clip plane
  4436. * @param zfar defines the far clip plane
  4437. * @param result defines the target matrix
  4438. */
  4439. static OrthoOffCenterLHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  4440. /**
  4441. * Creates a right-handed orthographic projection matrix
  4442. * @param left defines the viewport left coordinate
  4443. * @param right defines the viewport right coordinate
  4444. * @param bottom defines the viewport bottom coordinate
  4445. * @param top defines the viewport top coordinate
  4446. * @param znear defines the near clip plane
  4447. * @param zfar defines the far clip plane
  4448. * @returns a new matrix as a right-handed orthographic projection matrix
  4449. */
  4450. static OrthoOffCenterRH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  4451. /**
  4452. * Stores a right-handed orthographic projection into a given matrix
  4453. * @param left defines the viewport left coordinate
  4454. * @param right defines the viewport right coordinate
  4455. * @param bottom defines the viewport bottom coordinate
  4456. * @param top defines the viewport top coordinate
  4457. * @param znear defines the near clip plane
  4458. * @param zfar defines the far clip plane
  4459. * @param result defines the target matrix
  4460. */
  4461. static OrthoOffCenterRHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  4462. /**
  4463. * Creates a left-handed perspective projection matrix
  4464. * @param width defines the viewport width
  4465. * @param height defines the viewport height
  4466. * @param znear defines the near clip plane
  4467. * @param zfar defines the far clip plane
  4468. * @returns a new matrix as a left-handed perspective projection matrix
  4469. */
  4470. static PerspectiveLH(width: number, height: number, znear: number, zfar: number): Matrix;
  4471. /**
  4472. * Creates a left-handed perspective projection matrix
  4473. * @param fov defines the horizontal field of view
  4474. * @param aspect defines the aspect ratio
  4475. * @param znear defines the near clip plane
  4476. * @param zfar defines the far clip plane
  4477. * @returns a new matrix as a left-handed perspective projection matrix
  4478. */
  4479. static PerspectiveFovLH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  4480. /**
  4481. * Stores a left-handed perspective projection into a given matrix
  4482. * @param fov defines the horizontal field of view
  4483. * @param aspect defines the aspect ratio
  4484. * @param znear defines the near clip plane
  4485. * @param zfar defines the far clip plane
  4486. * @param result defines the target matrix
  4487. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  4488. */
  4489. static PerspectiveFovLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  4490. /**
  4491. * 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. private _alignTangentsWithPath;
  4784. private readonly _pointAtData;
  4785. /**
  4786. * new Path3D(path, normal, raw)
  4787. * Creates a Path3D. A Path3D is a logical math object, so not a mesh.
  4788. * please read the description in the tutorial : https://doc.babylonjs.com/how_to/how_to_use_path3d
  4789. * @param path an array of Vector3, the curve axis of the Path3D
  4790. * @param firstNormal (options) Vector3, the first wanted normal to the curve. Ex (0, 1, 0) for a vertical normal.
  4791. * @param raw (optional, default false) : boolean, if true the returned Path3D isn't normalized. Useful to depict path acceleration or speed.
  4792. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path.
  4793. */
  4794. constructor(
  4795. /**
  4796. * an array of Vector3, the curve axis of the Path3D
  4797. */
  4798. path: Vector3[], firstNormal?: Nullable<Vector3>, raw?: boolean, alignTangentsWithPath?: boolean);
  4799. /**
  4800. * Returns the Path3D array of successive Vector3 designing its curve.
  4801. * @returns the Path3D array of successive Vector3 designing its curve.
  4802. */
  4803. getCurve(): Vector3[];
  4804. /**
  4805. * Returns the Path3D array of successive Vector3 designing its curve.
  4806. * @returns the Path3D array of successive Vector3 designing its curve.
  4807. */
  4808. getPoints(): Vector3[];
  4809. /**
  4810. * @returns the computed length (float) of the path.
  4811. */
  4812. length(): number;
  4813. /**
  4814. * Returns an array populated with tangent vectors on each Path3D curve point.
  4815. * @returns an array populated with tangent vectors on each Path3D curve point.
  4816. */
  4817. getTangents(): Vector3[];
  4818. /**
  4819. * Returns an array populated with normal vectors on each Path3D curve point.
  4820. * @returns an array populated with normal vectors on each Path3D curve point.
  4821. */
  4822. getNormals(): Vector3[];
  4823. /**
  4824. * Returns an array populated with binormal vectors on each Path3D curve point.
  4825. * @returns an array populated with binormal vectors on each Path3D curve point.
  4826. */
  4827. getBinormals(): Vector3[];
  4828. /**
  4829. * Returns an array populated with distances (float) of the i-th point from the first curve point.
  4830. * @returns an array populated with distances (float) of the i-th point from the first curve point.
  4831. */
  4832. getDistances(): number[];
  4833. /**
  4834. * Returns an interpolated point along this path
  4835. * @param position the position of the point along this path, from 0.0 to 1.0
  4836. * @returns a new Vector3 as the point
  4837. */
  4838. getPointAt(position: number): Vector3;
  4839. /**
  4840. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  4841. * @param position the position of the point along this path, from 0.0 to 1.0
  4842. * @param interpolated (optional, default false) : boolean, if true returns an interpolated tangent instead of the tangent of the previous path point.
  4843. * @returns a tangent vector corresponding to the interpolated Path3D curve point, if not interpolated, the tangent is taken from the precomputed tangents array.
  4844. */
  4845. getTangentAt(position: number, interpolated?: boolean): Vector3;
  4846. /**
  4847. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  4848. * @param position the position of the point along this path, from 0.0 to 1.0
  4849. * @param interpolated (optional, default false) : boolean, if true returns an interpolated normal instead of the normal of the previous path point.
  4850. * @returns a normal vector corresponding to the interpolated Path3D curve point, if not interpolated, the normal is taken from the precomputed normals array.
  4851. */
  4852. getNormalAt(position: number, interpolated?: boolean): Vector3;
  4853. /**
  4854. * Returns the binormal vector of an interpolated Path3D curve point at the specified position along this path.
  4855. * @param position the position of the point along this path, from 0.0 to 1.0
  4856. * @param interpolated (optional, default false) : boolean, if true returns an interpolated binormal instead of the binormal of the previous path point.
  4857. * @returns a binormal vector corresponding to the interpolated Path3D curve point, if not interpolated, the binormal is taken from the precomputed binormals array.
  4858. */
  4859. getBinormalAt(position: number, interpolated?: boolean): Vector3;
  4860. /**
  4861. * Returns the distance (float) of an interpolated Path3D curve point at the specified position along this path.
  4862. * @param position the position of the point along this path, from 0.0 to 1.0
  4863. * @returns the distance of the interpolated Path3D curve point at the specified position along this path.
  4864. */
  4865. getDistanceAt(position: number): number;
  4866. /**
  4867. * Returns the array index of the previous point of an interpolated point along this path
  4868. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  4869. * @returns the array index
  4870. */
  4871. getPreviousPointIndexAt(position: number): number;
  4872. /**
  4873. * Returns the position of an interpolated point relative to the two path points it lies between, from 0.0 (point A) to 1.0 (point B)
  4874. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  4875. * @returns the sub position
  4876. */
  4877. getSubPositionAt(position: number): number;
  4878. /**
  4879. * Returns the position of the closest virtual point on this path to an arbitrary Vector3, from 0.0 to 1.0
  4880. * @param target the vector of which to get the closest position to
  4881. * @returns the position of the closest virtual point on this path to the target vector
  4882. */
  4883. getClosestPositionTo(target: Vector3): number;
  4884. /**
  4885. * Returns a sub path (slice) of this path
  4886. * @param start the position of the fist path point, from 0.0 to 1.0, or a negative value, which will get wrapped around from the end of the path to 0.0 to 1.0 values
  4887. * @param end the position of the last path point, from 0.0 to 1.0, or a negative value, which will get wrapped around from the end of the path to 0.0 to 1.0 values
  4888. * @returns a sub path (slice) of this path
  4889. */
  4890. slice(start?: number, end?: number): Path3D;
  4891. /**
  4892. * Forces the Path3D tangent, normal, binormal and distance recomputation.
  4893. * @param path path which all values are copied into the curves points
  4894. * @param firstNormal which should be projected onto the curve
  4895. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path
  4896. * @returns the same object updated.
  4897. */
  4898. update(path: Vector3[], firstNormal?: Nullable<Vector3>, alignTangentsWithPath?: boolean): Path3D;
  4899. private _compute;
  4900. private _getFirstNonNullVector;
  4901. private _getLastNonNullVector;
  4902. private _normalVector;
  4903. /**
  4904. * Updates the point at data for an interpolated point along this curve
  4905. * @param position the position of the point along this curve, from 0.0 to 1.0
  4906. * @interpolateTNB wether to compute the interpolated tangent, normal and binormal
  4907. * @returns the (updated) point at data
  4908. */
  4909. private _updatePointAtData;
  4910. /**
  4911. * Updates the point at data from the specified parameters
  4912. * @param position where along the path the interpolated point is, from 0.0 to 1.0
  4913. * @param point the interpolated point
  4914. * @param parentIndex the index of an existing curve point that is on, or else positionally the first behind, the interpolated point
  4915. */
  4916. private _setPointAtData;
  4917. /**
  4918. * Updates the point at interpolation matrix for the tangents, normals and binormals
  4919. */
  4920. private _updateInterpolationMatrix;
  4921. }
  4922. /**
  4923. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  4924. * A Curve3 is designed from a series of successive Vector3.
  4925. * @see https://doc.babylonjs.com/how_to/how_to_use_curve3
  4926. */
  4927. export class Curve3 {
  4928. private _points;
  4929. private _length;
  4930. /**
  4931. * Returns a Curve3 object along a Quadratic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#quadratic-bezier-curve
  4932. * @param v0 (Vector3) the origin point of the Quadratic Bezier
  4933. * @param v1 (Vector3) the control point
  4934. * @param v2 (Vector3) the end point of the Quadratic Bezier
  4935. * @param nbPoints (integer) the wanted number of points in the curve
  4936. * @returns the created Curve3
  4937. */
  4938. static CreateQuadraticBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  4939. /**
  4940. * Returns a Curve3 object along a Cubic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#cubic-bezier-curve
  4941. * @param v0 (Vector3) the origin point of the Cubic Bezier
  4942. * @param v1 (Vector3) the first control point
  4943. * @param v2 (Vector3) the second control point
  4944. * @param v3 (Vector3) the end point of the Cubic Bezier
  4945. * @param nbPoints (integer) the wanted number of points in the curve
  4946. * @returns the created Curve3
  4947. */
  4948. static CreateCubicBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, v3: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  4949. /**
  4950. * Returns a Curve3 object along a Hermite Spline curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#hermite-spline
  4951. * @param p1 (Vector3) the origin point of the Hermite Spline
  4952. * @param t1 (Vector3) the tangent vector at the origin point
  4953. * @param p2 (Vector3) the end point of the Hermite Spline
  4954. * @param t2 (Vector3) the tangent vector at the end point
  4955. * @param nbPoints (integer) the wanted number of points in the curve
  4956. * @returns the created Curve3
  4957. */
  4958. static CreateHermiteSpline(p1: DeepImmutable<Vector3>, t1: DeepImmutable<Vector3>, p2: DeepImmutable<Vector3>, t2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  4959. /**
  4960. * Returns a Curve3 object along a CatmullRom Spline curve :
  4961. * @param points (array of Vector3) the points the spline must pass through. At least, four points required
  4962. * @param nbPoints (integer) the wanted number of points between each curve control points
  4963. * @param closed (boolean) optional with default false, when true forms a closed loop from the points
  4964. * @returns the created Curve3
  4965. */
  4966. static CreateCatmullRomSpline(points: DeepImmutable<Vector3[]>, nbPoints: number, closed?: boolean): Curve3;
  4967. /**
  4968. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  4969. * A Curve3 is designed from a series of successive Vector3.
  4970. * Tuto : https://doc.babylonjs.com/how_to/how_to_use_curve3#curve3-object
  4971. * @param points points which make up the curve
  4972. */
  4973. constructor(points: Vector3[]);
  4974. /**
  4975. * @returns the Curve3 stored array of successive Vector3
  4976. */
  4977. getPoints(): Vector3[];
  4978. /**
  4979. * @returns the computed length (float) of the curve.
  4980. */
  4981. length(): number;
  4982. /**
  4983. * Returns a new instance of Curve3 object : var curve = curveA.continue(curveB);
  4984. * This new Curve3 is built by translating and sticking the curveB at the end of the curveA.
  4985. * curveA and curveB keep unchanged.
  4986. * @param curve the curve to continue from this curve
  4987. * @returns the newly constructed curve
  4988. */
  4989. continue(curve: DeepImmutable<Curve3>): Curve3;
  4990. private _computeLength;
  4991. }
  4992. }
  4993. declare module "babylonjs/Animations/easing" {
  4994. /**
  4995. * This represents the main contract an easing function should follow.
  4996. * Easing functions are used throughout the animation system.
  4997. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  4998. */
  4999. export interface IEasingFunction {
  5000. /**
  5001. * Given an input gradient between 0 and 1, this returns the corrseponding value
  5002. * of the easing function.
  5003. * The link below provides some of the most common examples of easing functions.
  5004. * @see https://easings.net/
  5005. * @param gradient Defines the value between 0 and 1 we want the easing value for
  5006. * @returns the corresponding value on the curve defined by the easing function
  5007. */
  5008. ease(gradient: number): number;
  5009. }
  5010. /**
  5011. * Base class used for every default easing function.
  5012. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5013. */
  5014. export class EasingFunction implements IEasingFunction {
  5015. /**
  5016. * Interpolation follows the mathematical formula associated with the easing function.
  5017. */
  5018. static readonly EASINGMODE_EASEIN: number;
  5019. /**
  5020. * Interpolation follows 100% interpolation minus the output of the formula associated with the easing function.
  5021. */
  5022. static readonly EASINGMODE_EASEOUT: number;
  5023. /**
  5024. * Interpolation uses EaseIn for the first half of the animation and EaseOut for the second half.
  5025. */
  5026. static readonly EASINGMODE_EASEINOUT: number;
  5027. private _easingMode;
  5028. /**
  5029. * Sets the easing mode of the current function.
  5030. * @param easingMode Defines the willing mode (EASINGMODE_EASEIN, EASINGMODE_EASEOUT or EASINGMODE_EASEINOUT)
  5031. */
  5032. setEasingMode(easingMode: number): void;
  5033. /**
  5034. * Gets the current easing mode.
  5035. * @returns the easing mode
  5036. */
  5037. getEasingMode(): number;
  5038. /**
  5039. * @hidden
  5040. */
  5041. easeInCore(gradient: number): number;
  5042. /**
  5043. * Given an input gradient between 0 and 1, this returns the corresponding value
  5044. * of the easing function.
  5045. * @param gradient Defines the value between 0 and 1 we want the easing value for
  5046. * @returns the corresponding value on the curve defined by the easing function
  5047. */
  5048. ease(gradient: number): number;
  5049. }
  5050. /**
  5051. * Easing function with a circle shape (see link below).
  5052. * @see https://easings.net/#easeInCirc
  5053. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5054. */
  5055. export class CircleEase extends EasingFunction implements IEasingFunction {
  5056. /** @hidden */
  5057. easeInCore(gradient: number): number;
  5058. }
  5059. /**
  5060. * Easing function with a ease back shape (see link below).
  5061. * @see https://easings.net/#easeInBack
  5062. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5063. */
  5064. export class BackEase extends EasingFunction implements IEasingFunction {
  5065. /** Defines the amplitude of the function */
  5066. amplitude: number;
  5067. /**
  5068. * Instantiates a back ease easing
  5069. * @see https://easings.net/#easeInBack
  5070. * @param amplitude Defines the amplitude of the function
  5071. */
  5072. constructor(
  5073. /** Defines the amplitude of the function */
  5074. amplitude?: number);
  5075. /** @hidden */
  5076. easeInCore(gradient: number): number;
  5077. }
  5078. /**
  5079. * Easing function with a bouncing shape (see link below).
  5080. * @see https://easings.net/#easeInBounce
  5081. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5082. */
  5083. export class BounceEase extends EasingFunction implements IEasingFunction {
  5084. /** Defines the number of bounces */
  5085. bounces: number;
  5086. /** Defines the amplitude of the bounce */
  5087. bounciness: number;
  5088. /**
  5089. * Instantiates a bounce easing
  5090. * @see https://easings.net/#easeInBounce
  5091. * @param bounces Defines the number of bounces
  5092. * @param bounciness Defines the amplitude of the bounce
  5093. */
  5094. constructor(
  5095. /** Defines the number of bounces */
  5096. bounces?: number,
  5097. /** Defines the amplitude of the bounce */
  5098. bounciness?: number);
  5099. /** @hidden */
  5100. easeInCore(gradient: number): number;
  5101. }
  5102. /**
  5103. * Easing function with a power of 3 shape (see link below).
  5104. * @see https://easings.net/#easeInCubic
  5105. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5106. */
  5107. export class CubicEase extends EasingFunction implements IEasingFunction {
  5108. /** @hidden */
  5109. easeInCore(gradient: number): number;
  5110. }
  5111. /**
  5112. * Easing function with an elastic shape (see link below).
  5113. * @see https://easings.net/#easeInElastic
  5114. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5115. */
  5116. export class ElasticEase extends EasingFunction implements IEasingFunction {
  5117. /** Defines the number of oscillations*/
  5118. oscillations: number;
  5119. /** Defines the amplitude of the oscillations*/
  5120. springiness: number;
  5121. /**
  5122. * Instantiates an elastic easing function
  5123. * @see https://easings.net/#easeInElastic
  5124. * @param oscillations Defines the number of oscillations
  5125. * @param springiness Defines the amplitude of the oscillations
  5126. */
  5127. constructor(
  5128. /** Defines the number of oscillations*/
  5129. oscillations?: number,
  5130. /** Defines the amplitude of the oscillations*/
  5131. springiness?: number);
  5132. /** @hidden */
  5133. easeInCore(gradient: number): number;
  5134. }
  5135. /**
  5136. * Easing function with an exponential shape (see link below).
  5137. * @see https://easings.net/#easeInExpo
  5138. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5139. */
  5140. export class ExponentialEase extends EasingFunction implements IEasingFunction {
  5141. /** Defines the exponent of the function */
  5142. exponent: number;
  5143. /**
  5144. * Instantiates an exponential easing function
  5145. * @see https://easings.net/#easeInExpo
  5146. * @param exponent Defines the exponent of the function
  5147. */
  5148. constructor(
  5149. /** Defines the exponent of the function */
  5150. exponent?: number);
  5151. /** @hidden */
  5152. easeInCore(gradient: number): number;
  5153. }
  5154. /**
  5155. * Easing function with a power shape (see link below).
  5156. * @see https://easings.net/#easeInQuad
  5157. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5158. */
  5159. export class PowerEase extends EasingFunction implements IEasingFunction {
  5160. /** Defines the power of the function */
  5161. power: number;
  5162. /**
  5163. * Instantiates an power base easing function
  5164. * @see https://easings.net/#easeInQuad
  5165. * @param power Defines the power of the function
  5166. */
  5167. constructor(
  5168. /** Defines the power of the function */
  5169. power?: number);
  5170. /** @hidden */
  5171. easeInCore(gradient: number): number;
  5172. }
  5173. /**
  5174. * Easing function with a power of 2 shape (see link below).
  5175. * @see https://easings.net/#easeInQuad
  5176. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5177. */
  5178. export class QuadraticEase extends EasingFunction implements IEasingFunction {
  5179. /** @hidden */
  5180. easeInCore(gradient: number): number;
  5181. }
  5182. /**
  5183. * Easing function with a power of 4 shape (see link below).
  5184. * @see https://easings.net/#easeInQuart
  5185. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5186. */
  5187. export class QuarticEase extends EasingFunction implements IEasingFunction {
  5188. /** @hidden */
  5189. easeInCore(gradient: number): number;
  5190. }
  5191. /**
  5192. * Easing function with a power of 5 shape (see link below).
  5193. * @see https://easings.net/#easeInQuint
  5194. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5195. */
  5196. export class QuinticEase extends EasingFunction implements IEasingFunction {
  5197. /** @hidden */
  5198. easeInCore(gradient: number): number;
  5199. }
  5200. /**
  5201. * Easing function with a sin shape (see link below).
  5202. * @see https://easings.net/#easeInSine
  5203. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5204. */
  5205. export class SineEase extends EasingFunction implements IEasingFunction {
  5206. /** @hidden */
  5207. easeInCore(gradient: number): number;
  5208. }
  5209. /**
  5210. * Easing function with a bezier shape (see link below).
  5211. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  5212. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  5213. */
  5214. export class BezierCurveEase extends EasingFunction implements IEasingFunction {
  5215. /** Defines the x component of the start tangent in the bezier curve */
  5216. x1: number;
  5217. /** Defines the y component of the start tangent in the bezier curve */
  5218. y1: number;
  5219. /** Defines the x component of the end tangent in the bezier curve */
  5220. x2: number;
  5221. /** Defines the y component of the end tangent in the bezier curve */
  5222. y2: number;
  5223. /**
  5224. * Instantiates a bezier function
  5225. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  5226. * @param x1 Defines the x component of the start tangent in the bezier curve
  5227. * @param y1 Defines the y component of the start tangent in the bezier curve
  5228. * @param x2 Defines the x component of the end tangent in the bezier curve
  5229. * @param y2 Defines the y component of the end tangent in the bezier curve
  5230. */
  5231. constructor(
  5232. /** Defines the x component of the start tangent in the bezier curve */
  5233. x1?: number,
  5234. /** Defines the y component of the start tangent in the bezier curve */
  5235. y1?: number,
  5236. /** Defines the x component of the end tangent in the bezier curve */
  5237. x2?: number,
  5238. /** Defines the y component of the end tangent in the bezier curve */
  5239. y2?: number);
  5240. /** @hidden */
  5241. easeInCore(gradient: number): number;
  5242. }
  5243. }
  5244. declare module "babylonjs/Maths/math.color" {
  5245. import { DeepImmutable, FloatArray } from "babylonjs/types";
  5246. /**
  5247. * Class used to hold a RBG color
  5248. */
  5249. export class Color3 {
  5250. /**
  5251. * Defines the red component (between 0 and 1, default is 0)
  5252. */
  5253. r: number;
  5254. /**
  5255. * Defines the green component (between 0 and 1, default is 0)
  5256. */
  5257. g: number;
  5258. /**
  5259. * Defines the blue component (between 0 and 1, default is 0)
  5260. */
  5261. b: number;
  5262. /**
  5263. * Creates a new Color3 object from red, green, blue values, all between 0 and 1
  5264. * @param r defines the red component (between 0 and 1, default is 0)
  5265. * @param g defines the green component (between 0 and 1, default is 0)
  5266. * @param b defines the blue component (between 0 and 1, default is 0)
  5267. */
  5268. constructor(
  5269. /**
  5270. * Defines the red component (between 0 and 1, default is 0)
  5271. */
  5272. r?: number,
  5273. /**
  5274. * Defines the green component (between 0 and 1, default is 0)
  5275. */
  5276. g?: number,
  5277. /**
  5278. * Defines the blue component (between 0 and 1, default is 0)
  5279. */
  5280. b?: number);
  5281. /**
  5282. * Creates a string with the Color3 current values
  5283. * @returns the string representation of the Color3 object
  5284. */
  5285. toString(): string;
  5286. /**
  5287. * Returns the string "Color3"
  5288. * @returns "Color3"
  5289. */
  5290. getClassName(): string;
  5291. /**
  5292. * Compute the Color3 hash code
  5293. * @returns an unique number that can be used to hash Color3 objects
  5294. */
  5295. getHashCode(): number;
  5296. /**
  5297. * Stores in the given array from the given starting index the red, green, blue values as successive elements
  5298. * @param array defines the array where to store the r,g,b components
  5299. * @param index defines an optional index in the target array to define where to start storing values
  5300. * @returns the current Color3 object
  5301. */
  5302. toArray(array: FloatArray, index?: number): Color3;
  5303. /**
  5304. * Returns a new Color4 object from the current Color3 and the given alpha
  5305. * @param alpha defines the alpha component on the new Color4 object (default is 1)
  5306. * @returns a new Color4 object
  5307. */
  5308. toColor4(alpha?: number): Color4;
  5309. /**
  5310. * Returns a new array populated with 3 numeric elements : red, green and blue values
  5311. * @returns the new array
  5312. */
  5313. asArray(): number[];
  5314. /**
  5315. * Returns the luminance value
  5316. * @returns a float value
  5317. */
  5318. toLuminance(): number;
  5319. /**
  5320. * Multiply each Color3 rgb values by the given Color3 rgb values in a new Color3 object
  5321. * @param otherColor defines the second operand
  5322. * @returns the new Color3 object
  5323. */
  5324. multiply(otherColor: DeepImmutable<Color3>): Color3;
  5325. /**
  5326. * Multiply the rgb values of the Color3 and the given Color3 and stores the result in the object "result"
  5327. * @param otherColor defines the second operand
  5328. * @param result defines the Color3 object where to store the result
  5329. * @returns the current Color3
  5330. */
  5331. multiplyToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  5332. /**
  5333. * Determines equality between Color3 objects
  5334. * @param otherColor defines the second operand
  5335. * @returns true if the rgb values are equal to the given ones
  5336. */
  5337. equals(otherColor: DeepImmutable<Color3>): boolean;
  5338. /**
  5339. * Determines equality between the current Color3 object and a set of r,b,g values
  5340. * @param r defines the red component to check
  5341. * @param g defines the green component to check
  5342. * @param b defines the blue component to check
  5343. * @returns true if the rgb values are equal to the given ones
  5344. */
  5345. equalsFloats(r: number, g: number, b: number): boolean;
  5346. /**
  5347. * Multiplies in place each rgb value by scale
  5348. * @param scale defines the scaling factor
  5349. * @returns the updated Color3
  5350. */
  5351. scale(scale: number): Color3;
  5352. /**
  5353. * Multiplies the rgb values by scale and stores the result into "result"
  5354. * @param scale defines the scaling factor
  5355. * @param result defines the Color3 object where to store the result
  5356. * @returns the unmodified current Color3
  5357. */
  5358. scaleToRef(scale: number, result: Color3): Color3;
  5359. /**
  5360. * Scale the current Color3 values by a factor and add the result to a given Color3
  5361. * @param scale defines the scale factor
  5362. * @param result defines color to store the result into
  5363. * @returns the unmodified current Color3
  5364. */
  5365. scaleAndAddToRef(scale: number, result: Color3): Color3;
  5366. /**
  5367. * Clamps the rgb values by the min and max values and stores the result into "result"
  5368. * @param min defines minimum clamping value (default is 0)
  5369. * @param max defines maximum clamping value (default is 1)
  5370. * @param result defines color to store the result into
  5371. * @returns the original Color3
  5372. */
  5373. clampToRef(min: number | undefined, max: number | undefined, result: Color3): Color3;
  5374. /**
  5375. * Creates a new Color3 set with the added values of the current Color3 and of the given one
  5376. * @param otherColor defines the second operand
  5377. * @returns the new Color3
  5378. */
  5379. add(otherColor: DeepImmutable<Color3>): Color3;
  5380. /**
  5381. * Stores the result of the addition of the current Color3 and given one rgb values into "result"
  5382. * @param otherColor defines the second operand
  5383. * @param result defines Color3 object to store the result into
  5384. * @returns the unmodified current Color3
  5385. */
  5386. addToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  5387. /**
  5388. * Returns a new Color3 set with the subtracted values of the given one from the current Color3
  5389. * @param otherColor defines the second operand
  5390. * @returns the new Color3
  5391. */
  5392. subtract(otherColor: DeepImmutable<Color3>): Color3;
  5393. /**
  5394. * Stores the result of the subtraction of given one from the current Color3 rgb values into "result"
  5395. * @param otherColor defines the second operand
  5396. * @param result defines Color3 object to store the result into
  5397. * @returns the unmodified current Color3
  5398. */
  5399. subtractToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  5400. /**
  5401. * Copy the current object
  5402. * @returns a new Color3 copied the current one
  5403. */
  5404. clone(): Color3;
  5405. /**
  5406. * Copies the rgb values from the source in the current Color3
  5407. * @param source defines the source Color3 object
  5408. * @returns the updated Color3 object
  5409. */
  5410. copyFrom(source: DeepImmutable<Color3>): Color3;
  5411. /**
  5412. * Updates the Color3 rgb values from the given floats
  5413. * @param r defines the red component to read from
  5414. * @param g defines the green component to read from
  5415. * @param b defines the blue component to read from
  5416. * @returns the current Color3 object
  5417. */
  5418. copyFromFloats(r: number, g: number, b: number): Color3;
  5419. /**
  5420. * Updates the Color3 rgb values from the given floats
  5421. * @param r defines the red component to read from
  5422. * @param g defines the green component to read from
  5423. * @param b defines the blue component to read from
  5424. * @returns the current Color3 object
  5425. */
  5426. set(r: number, g: number, b: number): Color3;
  5427. /**
  5428. * Compute the Color3 hexadecimal code as a string
  5429. * @returns a string containing the hexadecimal representation of the Color3 object
  5430. */
  5431. toHexString(): string;
  5432. /**
  5433. * Computes a new Color3 converted from the current one to linear space
  5434. * @returns a new Color3 object
  5435. */
  5436. toLinearSpace(): Color3;
  5437. /**
  5438. * Converts current color in rgb space to HSV values
  5439. * @returns a new color3 representing the HSV values
  5440. */
  5441. toHSV(): Color3;
  5442. /**
  5443. * Converts current color in rgb space to HSV values
  5444. * @param result defines the Color3 where to store the HSV values
  5445. */
  5446. toHSVToRef(result: Color3): void;
  5447. /**
  5448. * Converts the Color3 values to linear space and stores the result in "convertedColor"
  5449. * @param convertedColor defines the Color3 object where to store the linear space version
  5450. * @returns the unmodified Color3
  5451. */
  5452. toLinearSpaceToRef(convertedColor: Color3): Color3;
  5453. /**
  5454. * Computes a new Color3 converted from the current one to gamma space
  5455. * @returns a new Color3 object
  5456. */
  5457. toGammaSpace(): Color3;
  5458. /**
  5459. * Converts the Color3 values to gamma space and stores the result in "convertedColor"
  5460. * @param convertedColor defines the Color3 object where to store the gamma space version
  5461. * @returns the unmodified Color3
  5462. */
  5463. toGammaSpaceToRef(convertedColor: Color3): Color3;
  5464. private static _BlackReadOnly;
  5465. /**
  5466. * Convert Hue, saturation and value to a Color3 (RGB)
  5467. * @param hue defines the hue
  5468. * @param saturation defines the saturation
  5469. * @param value defines the value
  5470. * @param result defines the Color3 where to store the RGB values
  5471. */
  5472. static HSVtoRGBToRef(hue: number, saturation: number, value: number, result: Color3): void;
  5473. /**
  5474. * Creates a new Color3 from the string containing valid hexadecimal values
  5475. * @param hex defines a string containing valid hexadecimal values
  5476. * @returns a new Color3 object
  5477. */
  5478. static FromHexString(hex: string): Color3;
  5479. /**
  5480. * Creates a new Color3 from the starting index of the given array
  5481. * @param array defines the source array
  5482. * @param offset defines an offset in the source array
  5483. * @returns a new Color3 object
  5484. */
  5485. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  5486. /**
  5487. * Creates a new Color3 from integer values (< 256)
  5488. * @param r defines the red component to read from (value between 0 and 255)
  5489. * @param g defines the green component to read from (value between 0 and 255)
  5490. * @param b defines the blue component to read from (value between 0 and 255)
  5491. * @returns a new Color3 object
  5492. */
  5493. static FromInts(r: number, g: number, b: number): Color3;
  5494. /**
  5495. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  5496. * @param start defines the start Color3 value
  5497. * @param end defines the end Color3 value
  5498. * @param amount defines the gradient value between start and end
  5499. * @returns a new Color3 object
  5500. */
  5501. static Lerp(start: DeepImmutable<Color3>, end: DeepImmutable<Color3>, amount: number): Color3;
  5502. /**
  5503. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  5504. * @param left defines the start value
  5505. * @param right defines the end value
  5506. * @param amount defines the gradient factor
  5507. * @param result defines the Color3 object where to store the result
  5508. */
  5509. static LerpToRef(left: DeepImmutable<Color3>, right: DeepImmutable<Color3>, amount: number, result: Color3): void;
  5510. /**
  5511. * Returns a Color3 value containing a red color
  5512. * @returns a new Color3 object
  5513. */
  5514. static Red(): Color3;
  5515. /**
  5516. * Returns a Color3 value containing a green color
  5517. * @returns a new Color3 object
  5518. */
  5519. static Green(): Color3;
  5520. /**
  5521. * Returns a Color3 value containing a blue color
  5522. * @returns a new Color3 object
  5523. */
  5524. static Blue(): Color3;
  5525. /**
  5526. * Returns a Color3 value containing a black color
  5527. * @returns a new Color3 object
  5528. */
  5529. static Black(): Color3;
  5530. /**
  5531. * Gets a Color3 value containing a black color that must not be updated
  5532. */
  5533. static readonly BlackReadOnly: DeepImmutable<Color3>;
  5534. /**
  5535. * Returns a Color3 value containing a white color
  5536. * @returns a new Color3 object
  5537. */
  5538. static White(): Color3;
  5539. /**
  5540. * Returns a Color3 value containing a purple color
  5541. * @returns a new Color3 object
  5542. */
  5543. static Purple(): Color3;
  5544. /**
  5545. * Returns a Color3 value containing a magenta color
  5546. * @returns a new Color3 object
  5547. */
  5548. static Magenta(): Color3;
  5549. /**
  5550. * Returns a Color3 value containing a yellow color
  5551. * @returns a new Color3 object
  5552. */
  5553. static Yellow(): Color3;
  5554. /**
  5555. * Returns a Color3 value containing a gray color
  5556. * @returns a new Color3 object
  5557. */
  5558. static Gray(): Color3;
  5559. /**
  5560. * Returns a Color3 value containing a teal color
  5561. * @returns a new Color3 object
  5562. */
  5563. static Teal(): Color3;
  5564. /**
  5565. * Returns a Color3 value containing a random color
  5566. * @returns a new Color3 object
  5567. */
  5568. static Random(): Color3;
  5569. }
  5570. /**
  5571. * Class used to hold a RBGA color
  5572. */
  5573. export class Color4 {
  5574. /**
  5575. * Defines the red component (between 0 and 1, default is 0)
  5576. */
  5577. r: number;
  5578. /**
  5579. * Defines the green component (between 0 and 1, default is 0)
  5580. */
  5581. g: number;
  5582. /**
  5583. * Defines the blue component (between 0 and 1, default is 0)
  5584. */
  5585. b: number;
  5586. /**
  5587. * Defines the alpha component (between 0 and 1, default is 1)
  5588. */
  5589. a: number;
  5590. /**
  5591. * Creates a new Color4 object from red, green, blue values, all between 0 and 1
  5592. * @param r defines the red component (between 0 and 1, default is 0)
  5593. * @param g defines the green component (between 0 and 1, default is 0)
  5594. * @param b defines the blue component (between 0 and 1, default is 0)
  5595. * @param a defines the alpha component (between 0 and 1, default is 1)
  5596. */
  5597. constructor(
  5598. /**
  5599. * Defines the red component (between 0 and 1, default is 0)
  5600. */
  5601. r?: number,
  5602. /**
  5603. * Defines the green component (between 0 and 1, default is 0)
  5604. */
  5605. g?: number,
  5606. /**
  5607. * Defines the blue component (between 0 and 1, default is 0)
  5608. */
  5609. b?: number,
  5610. /**
  5611. * Defines the alpha component (between 0 and 1, default is 1)
  5612. */
  5613. a?: number);
  5614. /**
  5615. * Adds in place the given Color4 values to the current Color4 object
  5616. * @param right defines the second operand
  5617. * @returns the current updated Color4 object
  5618. */
  5619. addInPlace(right: DeepImmutable<Color4>): Color4;
  5620. /**
  5621. * Creates a new array populated with 4 numeric elements : red, green, blue, alpha values
  5622. * @returns the new array
  5623. */
  5624. asArray(): number[];
  5625. /**
  5626. * Stores from the starting index in the given array the Color4 successive values
  5627. * @param array defines the array where to store the r,g,b components
  5628. * @param index defines an optional index in the target array to define where to start storing values
  5629. * @returns the current Color4 object
  5630. */
  5631. toArray(array: number[], index?: number): Color4;
  5632. /**
  5633. * Determines equality between Color4 objects
  5634. * @param otherColor defines the second operand
  5635. * @returns true if the rgba values are equal to the given ones
  5636. */
  5637. equals(otherColor: DeepImmutable<Color4>): boolean;
  5638. /**
  5639. * Creates a new Color4 set with the added values of the current Color4 and of the given one
  5640. * @param right defines the second operand
  5641. * @returns a new Color4 object
  5642. */
  5643. add(right: DeepImmutable<Color4>): Color4;
  5644. /**
  5645. * Creates a new Color4 set with the subtracted values of the given one from the current Color4
  5646. * @param right defines the second operand
  5647. * @returns a new Color4 object
  5648. */
  5649. subtract(right: DeepImmutable<Color4>): Color4;
  5650. /**
  5651. * Subtracts the given ones from the current Color4 values and stores the results in "result"
  5652. * @param right defines the second operand
  5653. * @param result defines the Color4 object where to store the result
  5654. * @returns the current Color4 object
  5655. */
  5656. subtractToRef(right: DeepImmutable<Color4>, result: Color4): Color4;
  5657. /**
  5658. * Creates a new Color4 with the current Color4 values multiplied by scale
  5659. * @param scale defines the scaling factor to apply
  5660. * @returns a new Color4 object
  5661. */
  5662. scale(scale: number): Color4;
  5663. /**
  5664. * Multiplies the current Color4 values by scale and stores the result in "result"
  5665. * @param scale defines the scaling factor to apply
  5666. * @param result defines the Color4 object where to store the result
  5667. * @returns the current unmodified Color4
  5668. */
  5669. scaleToRef(scale: number, result: Color4): Color4;
  5670. /**
  5671. * Scale the current Color4 values by a factor and add the result to a given Color4
  5672. * @param scale defines the scale factor
  5673. * @param result defines the Color4 object where to store the result
  5674. * @returns the unmodified current Color4
  5675. */
  5676. scaleAndAddToRef(scale: number, result: Color4): Color4;
  5677. /**
  5678. * Clamps the rgb values by the min and max values and stores the result into "result"
  5679. * @param min defines minimum clamping value (default is 0)
  5680. * @param max defines maximum clamping value (default is 1)
  5681. * @param result defines color to store the result into.
  5682. * @returns the cuurent Color4
  5683. */
  5684. clampToRef(min: number | undefined, max: number | undefined, result: Color4): Color4;
  5685. /**
  5686. * Multipy an Color4 value by another and return a new Color4 object
  5687. * @param color defines the Color4 value to multiply by
  5688. * @returns a new Color4 object
  5689. */
  5690. multiply(color: Color4): Color4;
  5691. /**
  5692. * Multipy a Color4 value by another and push the result in a reference value
  5693. * @param color defines the Color4 value to multiply by
  5694. * @param result defines the Color4 to fill the result in
  5695. * @returns the result Color4
  5696. */
  5697. multiplyToRef(color: Color4, result: Color4): Color4;
  5698. /**
  5699. * Creates a string with the Color4 current values
  5700. * @returns the string representation of the Color4 object
  5701. */
  5702. toString(): string;
  5703. /**
  5704. * Returns the string "Color4"
  5705. * @returns "Color4"
  5706. */
  5707. getClassName(): string;
  5708. /**
  5709. * Compute the Color4 hash code
  5710. * @returns an unique number that can be used to hash Color4 objects
  5711. */
  5712. getHashCode(): number;
  5713. /**
  5714. * Creates a new Color4 copied from the current one
  5715. * @returns a new Color4 object
  5716. */
  5717. clone(): Color4;
  5718. /**
  5719. * Copies the given Color4 values into the current one
  5720. * @param source defines the source Color4 object
  5721. * @returns the current updated Color4 object
  5722. */
  5723. copyFrom(source: Color4): Color4;
  5724. /**
  5725. * Copies the given float values into the current one
  5726. * @param r defines the red component to read from
  5727. * @param g defines the green component to read from
  5728. * @param b defines the blue component to read from
  5729. * @param a defines the alpha component to read from
  5730. * @returns the current updated Color4 object
  5731. */
  5732. copyFromFloats(r: number, g: number, b: number, a: number): Color4;
  5733. /**
  5734. * Copies the given float values into the current one
  5735. * @param r defines the red component to read from
  5736. * @param g defines the green component to read from
  5737. * @param b defines the blue component to read from
  5738. * @param a defines the alpha component to read from
  5739. * @returns the current updated Color4 object
  5740. */
  5741. set(r: number, g: number, b: number, a: number): Color4;
  5742. /**
  5743. * Compute the Color4 hexadecimal code as a string
  5744. * @returns a string containing the hexadecimal representation of the Color4 object
  5745. */
  5746. toHexString(): string;
  5747. /**
  5748. * Computes a new Color4 converted from the current one to linear space
  5749. * @returns a new Color4 object
  5750. */
  5751. toLinearSpace(): Color4;
  5752. /**
  5753. * Converts the Color4 values to linear space and stores the result in "convertedColor"
  5754. * @param convertedColor defines the Color4 object where to store the linear space version
  5755. * @returns the unmodified Color4
  5756. */
  5757. toLinearSpaceToRef(convertedColor: Color4): Color4;
  5758. /**
  5759. * Computes a new Color4 converted from the current one to gamma space
  5760. * @returns a new Color4 object
  5761. */
  5762. toGammaSpace(): Color4;
  5763. /**
  5764. * Converts the Color4 values to gamma space and stores the result in "convertedColor"
  5765. * @param convertedColor defines the Color4 object where to store the gamma space version
  5766. * @returns the unmodified Color4
  5767. */
  5768. toGammaSpaceToRef(convertedColor: Color4): Color4;
  5769. /**
  5770. * Creates a new Color4 from the string containing valid hexadecimal values
  5771. * @param hex defines a string containing valid hexadecimal values
  5772. * @returns a new Color4 object
  5773. */
  5774. static FromHexString(hex: string): Color4;
  5775. /**
  5776. * Creates a new Color4 object set with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  5777. * @param left defines the start value
  5778. * @param right defines the end value
  5779. * @param amount defines the gradient factor
  5780. * @returns a new Color4 object
  5781. */
  5782. static Lerp(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number): Color4;
  5783. /**
  5784. * Set the given "result" with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  5785. * @param left defines the start value
  5786. * @param right defines the end value
  5787. * @param amount defines the gradient factor
  5788. * @param result defines the Color4 object where to store data
  5789. */
  5790. static LerpToRef(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number, result: Color4): void;
  5791. /**
  5792. * Creates a new Color4 from a Color3 and an alpha value
  5793. * @param color3 defines the source Color3 to read from
  5794. * @param alpha defines the alpha component (1.0 by default)
  5795. * @returns a new Color4 object
  5796. */
  5797. static FromColor3(color3: DeepImmutable<Color3>, alpha?: number): Color4;
  5798. /**
  5799. * Creates a new Color4 from the starting index element of the given array
  5800. * @param array defines the source array to read from
  5801. * @param offset defines the offset in the source array
  5802. * @returns a new Color4 object
  5803. */
  5804. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  5805. /**
  5806. * Creates a new Color3 from integer values (< 256)
  5807. * @param r defines the red component to read from (value between 0 and 255)
  5808. * @param g defines the green component to read from (value between 0 and 255)
  5809. * @param b defines the blue component to read from (value between 0 and 255)
  5810. * @param a defines the alpha component to read from (value between 0 and 255)
  5811. * @returns a new Color3 object
  5812. */
  5813. static FromInts(r: number, g: number, b: number, a: number): Color4;
  5814. /**
  5815. * Check the content of a given array and convert it to an array containing RGBA data
  5816. * If the original array was already containing count * 4 values then it is returned directly
  5817. * @param colors defines the array to check
  5818. * @param count defines the number of RGBA data to expect
  5819. * @returns an array containing count * 4 values (RGBA)
  5820. */
  5821. static CheckColors4(colors: number[], count: number): number[];
  5822. }
  5823. /**
  5824. * @hidden
  5825. */
  5826. export class TmpColors {
  5827. static Color3: Color3[];
  5828. static Color4: Color4[];
  5829. }
  5830. }
  5831. declare module "babylonjs/Animations/animationKey" {
  5832. /**
  5833. * Defines an interface which represents an animation key frame
  5834. */
  5835. export interface IAnimationKey {
  5836. /**
  5837. * Frame of the key frame
  5838. */
  5839. frame: number;
  5840. /**
  5841. * Value at the specifies key frame
  5842. */
  5843. value: any;
  5844. /**
  5845. * The input tangent for the cubic hermite spline
  5846. */
  5847. inTangent?: any;
  5848. /**
  5849. * The output tangent for the cubic hermite spline
  5850. */
  5851. outTangent?: any;
  5852. /**
  5853. * The animation interpolation type
  5854. */
  5855. interpolation?: AnimationKeyInterpolation;
  5856. }
  5857. /**
  5858. * Enum for the animation key frame interpolation type
  5859. */
  5860. export enum AnimationKeyInterpolation {
  5861. /**
  5862. * Do not interpolate between keys and use the start key value only. Tangents are ignored
  5863. */
  5864. STEP = 1
  5865. }
  5866. }
  5867. declare module "babylonjs/Animations/animationRange" {
  5868. /**
  5869. * Represents the range of an animation
  5870. */
  5871. export class AnimationRange {
  5872. /**The name of the animation range**/
  5873. name: string;
  5874. /**The starting frame of the animation */
  5875. from: number;
  5876. /**The ending frame of the animation*/
  5877. to: number;
  5878. /**
  5879. * Initializes the range of an animation
  5880. * @param name The name of the animation range
  5881. * @param from The starting frame of the animation
  5882. * @param to The ending frame of the animation
  5883. */
  5884. constructor(
  5885. /**The name of the animation range**/
  5886. name: string,
  5887. /**The starting frame of the animation */
  5888. from: number,
  5889. /**The ending frame of the animation*/
  5890. to: number);
  5891. /**
  5892. * Makes a copy of the animation range
  5893. * @returns A copy of the animation range
  5894. */
  5895. clone(): AnimationRange;
  5896. }
  5897. }
  5898. declare module "babylonjs/Animations/animationEvent" {
  5899. /**
  5900. * Composed of a frame, and an action function
  5901. */
  5902. export class AnimationEvent {
  5903. /** The frame for which the event is triggered **/
  5904. frame: number;
  5905. /** The event to perform when triggered **/
  5906. action: (currentFrame: number) => void;
  5907. /** Specifies if the event should be triggered only once**/
  5908. onlyOnce?: boolean | undefined;
  5909. /**
  5910. * Specifies if the animation event is done
  5911. */
  5912. isDone: boolean;
  5913. /**
  5914. * Initializes the animation event
  5915. * @param frame The frame for which the event is triggered
  5916. * @param action The event to perform when triggered
  5917. * @param onlyOnce Specifies if the event should be triggered only once
  5918. */
  5919. constructor(
  5920. /** The frame for which the event is triggered **/
  5921. frame: number,
  5922. /** The event to perform when triggered **/
  5923. action: (currentFrame: number) => void,
  5924. /** Specifies if the event should be triggered only once**/
  5925. onlyOnce?: boolean | undefined);
  5926. /** @hidden */
  5927. _clone(): AnimationEvent;
  5928. }
  5929. }
  5930. declare module "babylonjs/Behaviors/behavior" {
  5931. import { Nullable } from "babylonjs/types";
  5932. /**
  5933. * Interface used to define a behavior
  5934. */
  5935. export interface Behavior<T> {
  5936. /** gets or sets behavior's name */
  5937. name: string;
  5938. /**
  5939. * Function called when the behavior needs to be initialized (after attaching it to a target)
  5940. */
  5941. init(): void;
  5942. /**
  5943. * Called when the behavior is attached to a target
  5944. * @param target defines the target where the behavior is attached to
  5945. */
  5946. attach(target: T): void;
  5947. /**
  5948. * Called when the behavior is detached from its target
  5949. */
  5950. detach(): void;
  5951. }
  5952. /**
  5953. * Interface implemented by classes supporting behaviors
  5954. */
  5955. export interface IBehaviorAware<T> {
  5956. /**
  5957. * Attach a behavior
  5958. * @param behavior defines the behavior to attach
  5959. * @returns the current host
  5960. */
  5961. addBehavior(behavior: Behavior<T>): T;
  5962. /**
  5963. * Remove a behavior from the current object
  5964. * @param behavior defines the behavior to detach
  5965. * @returns the current host
  5966. */
  5967. removeBehavior(behavior: Behavior<T>): T;
  5968. /**
  5969. * Gets a behavior using its name to search
  5970. * @param name defines the name to search
  5971. * @returns the behavior or null if not found
  5972. */
  5973. getBehaviorByName(name: string): Nullable<Behavior<T>>;
  5974. }
  5975. }
  5976. declare module "babylonjs/Misc/smartArray" {
  5977. /**
  5978. * Defines an array and its length.
  5979. * It can be helpfull to group result from both Arrays and smart arrays in one structure.
  5980. */
  5981. export interface ISmartArrayLike<T> {
  5982. /**
  5983. * The data of the array.
  5984. */
  5985. data: Array<T>;
  5986. /**
  5987. * The active length of the array.
  5988. */
  5989. length: number;
  5990. }
  5991. /**
  5992. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  5993. */
  5994. export class SmartArray<T> implements ISmartArrayLike<T> {
  5995. /**
  5996. * The full set of data from the array.
  5997. */
  5998. data: Array<T>;
  5999. /**
  6000. * The active length of the array.
  6001. */
  6002. length: number;
  6003. protected _id: number;
  6004. /**
  6005. * Instantiates a Smart Array.
  6006. * @param capacity defines the default capacity of the array.
  6007. */
  6008. constructor(capacity: number);
  6009. /**
  6010. * Pushes a value at the end of the active data.
  6011. * @param value defines the object to push in the array.
  6012. */
  6013. push(value: T): void;
  6014. /**
  6015. * Iterates over the active data and apply the lambda to them.
  6016. * @param func defines the action to apply on each value.
  6017. */
  6018. forEach(func: (content: T) => void): void;
  6019. /**
  6020. * Sorts the full sets of data.
  6021. * @param compareFn defines the comparison function to apply.
  6022. */
  6023. sort(compareFn: (a: T, b: T) => number): void;
  6024. /**
  6025. * Resets the active data to an empty array.
  6026. */
  6027. reset(): void;
  6028. /**
  6029. * Releases all the data from the array as well as the array.
  6030. */
  6031. dispose(): void;
  6032. /**
  6033. * Concats the active data with a given array.
  6034. * @param array defines the data to concatenate with.
  6035. */
  6036. concat(array: any): void;
  6037. /**
  6038. * Returns the position of a value in the active data.
  6039. * @param value defines the value to find the index for
  6040. * @returns the index if found in the active data otherwise -1
  6041. */
  6042. indexOf(value: T): number;
  6043. /**
  6044. * Returns whether an element is part of the active data.
  6045. * @param value defines the value to look for
  6046. * @returns true if found in the active data otherwise false
  6047. */
  6048. contains(value: T): boolean;
  6049. private static _GlobalId;
  6050. }
  6051. /**
  6052. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  6053. * The data in this array can only be present once
  6054. */
  6055. export class SmartArrayNoDuplicate<T> extends SmartArray<T> {
  6056. private _duplicateId;
  6057. /**
  6058. * Pushes a value at the end of the active data.
  6059. * THIS DOES NOT PREVENT DUPPLICATE DATA
  6060. * @param value defines the object to push in the array.
  6061. */
  6062. push(value: T): void;
  6063. /**
  6064. * Pushes a value at the end of the active data.
  6065. * If the data is already present, it won t be added again
  6066. * @param value defines the object to push in the array.
  6067. * @returns true if added false if it was already present
  6068. */
  6069. pushNoDuplicate(value: T): boolean;
  6070. /**
  6071. * Resets the active data to an empty array.
  6072. */
  6073. reset(): void;
  6074. /**
  6075. * Concats the active data with a given array.
  6076. * This ensures no dupplicate will be present in the result.
  6077. * @param array defines the data to concatenate with.
  6078. */
  6079. concatWithNoDuplicate(array: any): void;
  6080. }
  6081. }
  6082. declare module "babylonjs/Cameras/cameraInputsManager" {
  6083. import { Nullable } from "babylonjs/types";
  6084. import { Camera } from "babylonjs/Cameras/camera";
  6085. /**
  6086. * @ignore
  6087. * This is a list of all the different input types that are available in the application.
  6088. * Fo instance: ArcRotateCameraGamepadInput...
  6089. */
  6090. export var CameraInputTypes: {};
  6091. /**
  6092. * This is the contract to implement in order to create a new input class.
  6093. * Inputs are dealing with listening to user actions and moving the camera accordingly.
  6094. */
  6095. export interface ICameraInput<TCamera extends Camera> {
  6096. /**
  6097. * Defines the camera the input is attached to.
  6098. */
  6099. camera: Nullable<TCamera>;
  6100. /**
  6101. * Gets the class name of the current intput.
  6102. * @returns the class name
  6103. */
  6104. getClassName(): string;
  6105. /**
  6106. * Get the friendly name associated with the input class.
  6107. * @returns the input friendly name
  6108. */
  6109. getSimpleName(): string;
  6110. /**
  6111. * Attach the input controls to a specific dom element to get the input from.
  6112. * @param element Defines the element the controls should be listened from
  6113. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  6114. */
  6115. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  6116. /**
  6117. * Detach the current controls from the specified dom element.
  6118. * @param element Defines the element to stop listening the inputs from
  6119. */
  6120. detachControl(element: Nullable<HTMLElement>): void;
  6121. /**
  6122. * Update the current camera state depending on the inputs that have been used this frame.
  6123. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  6124. */
  6125. checkInputs?: () => void;
  6126. }
  6127. /**
  6128. * Represents a map of input types to input instance or input index to input instance.
  6129. */
  6130. export interface CameraInputsMap<TCamera extends Camera> {
  6131. /**
  6132. * Accessor to the input by input type.
  6133. */
  6134. [name: string]: ICameraInput<TCamera>;
  6135. /**
  6136. * Accessor to the input by input index.
  6137. */
  6138. [idx: number]: ICameraInput<TCamera>;
  6139. }
  6140. /**
  6141. * This represents the input manager used within a camera.
  6142. * It helps dealing with all the different kind of input attached to a camera.
  6143. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  6144. */
  6145. export class CameraInputsManager<TCamera extends Camera> {
  6146. /**
  6147. * Defines the list of inputs attahed to the camera.
  6148. */
  6149. attached: CameraInputsMap<TCamera>;
  6150. /**
  6151. * Defines the dom element the camera is collecting inputs from.
  6152. * This is null if the controls have not been attached.
  6153. */
  6154. attachedElement: Nullable<HTMLElement>;
  6155. /**
  6156. * Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  6157. */
  6158. noPreventDefault: boolean;
  6159. /**
  6160. * Defined the camera the input manager belongs to.
  6161. */
  6162. camera: TCamera;
  6163. /**
  6164. * Update the current camera state depending on the inputs that have been used this frame.
  6165. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  6166. */
  6167. checkInputs: () => void;
  6168. /**
  6169. * Instantiate a new Camera Input Manager.
  6170. * @param camera Defines the camera the input manager blongs to
  6171. */
  6172. constructor(camera: TCamera);
  6173. /**
  6174. * Add an input method to a camera
  6175. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  6176. * @param input camera input method
  6177. */
  6178. add(input: ICameraInput<TCamera>): void;
  6179. /**
  6180. * Remove a specific input method from a camera
  6181. * example: camera.inputs.remove(camera.inputs.attached.mouse);
  6182. * @param inputToRemove camera input method
  6183. */
  6184. remove(inputToRemove: ICameraInput<TCamera>): void;
  6185. /**
  6186. * Remove a specific input type from a camera
  6187. * example: camera.inputs.remove("ArcRotateCameraGamepadInput");
  6188. * @param inputType the type of the input to remove
  6189. */
  6190. removeByType(inputType: string): void;
  6191. private _addCheckInputs;
  6192. /**
  6193. * Attach the input controls to the currently attached dom element to listen the events from.
  6194. * @param input Defines the input to attach
  6195. */
  6196. attachInput(input: ICameraInput<TCamera>): void;
  6197. /**
  6198. * Attach the current manager inputs controls to a specific dom element to listen the events from.
  6199. * @param element Defines the dom element to collect the events from
  6200. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  6201. */
  6202. attachElement(element: HTMLElement, noPreventDefault?: boolean): void;
  6203. /**
  6204. * Detach the current manager inputs controls from a specific dom element.
  6205. * @param element Defines the dom element to collect the events from
  6206. * @param disconnect Defines whether the input should be removed from the current list of attached inputs
  6207. */
  6208. detachElement(element: HTMLElement, disconnect?: boolean): void;
  6209. /**
  6210. * Rebuild the dynamic inputCheck function from the current list of
  6211. * defined inputs in the manager.
  6212. */
  6213. rebuildInputCheck(): void;
  6214. /**
  6215. * Remove all attached input methods from a camera
  6216. */
  6217. clear(): void;
  6218. /**
  6219. * Serialize the current input manager attached to a camera.
  6220. * This ensures than once parsed,
  6221. * the input associated to the camera will be identical to the current ones
  6222. * @param serializedCamera Defines the camera serialization JSON the input serialization should write to
  6223. */
  6224. serialize(serializedCamera: any): void;
  6225. /**
  6226. * Parses an input manager serialized JSON to restore the previous list of inputs
  6227. * and states associated to a camera.
  6228. * @param parsedCamera Defines the JSON to parse
  6229. */
  6230. parse(parsedCamera: any): void;
  6231. }
  6232. }
  6233. declare module "babylonjs/Meshes/buffer" {
  6234. import { Nullable, DataArray } from "babylonjs/types";
  6235. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  6236. /**
  6237. * Class used to store data that will be store in GPU memory
  6238. */
  6239. export class Buffer {
  6240. private _engine;
  6241. private _buffer;
  6242. /** @hidden */
  6243. _data: Nullable<DataArray>;
  6244. private _updatable;
  6245. private _instanced;
  6246. private _divisor;
  6247. /**
  6248. * Gets the byte stride.
  6249. */
  6250. readonly byteStride: number;
  6251. /**
  6252. * Constructor
  6253. * @param engine the engine
  6254. * @param data the data to use for this buffer
  6255. * @param updatable whether the data is updatable
  6256. * @param stride the stride (optional)
  6257. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  6258. * @param instanced whether the buffer is instanced (optional)
  6259. * @param useBytes set to true if the stride in in bytes (optional)
  6260. * @param divisor sets an optional divisor for instances (1 by default)
  6261. */
  6262. constructor(engine: any, data: DataArray, updatable: boolean, stride?: number, postponeInternalCreation?: boolean, instanced?: boolean, useBytes?: boolean, divisor?: number);
  6263. /**
  6264. * Create a new VertexBuffer based on the current buffer
  6265. * @param kind defines the vertex buffer kind (position, normal, etc.)
  6266. * @param offset defines offset in the buffer (0 by default)
  6267. * @param size defines the size in floats of attributes (position is 3 for instance)
  6268. * @param stride defines the stride size in floats in the buffer (the offset to apply to reach next value when data is interleaved)
  6269. * @param instanced defines if the vertex buffer contains indexed data
  6270. * @param useBytes defines if the offset and stride are in bytes *
  6271. * @param divisor sets an optional divisor for instances (1 by default)
  6272. * @returns the new vertex buffer
  6273. */
  6274. createVertexBuffer(kind: string, offset: number, size: number, stride?: number, instanced?: boolean, useBytes?: boolean, divisor?: number): VertexBuffer;
  6275. /**
  6276. * Gets a boolean indicating if the Buffer is updatable?
  6277. * @returns true if the buffer is updatable
  6278. */
  6279. isUpdatable(): boolean;
  6280. /**
  6281. * Gets current buffer's data
  6282. * @returns a DataArray or null
  6283. */
  6284. getData(): Nullable<DataArray>;
  6285. /**
  6286. * Gets underlying native buffer
  6287. * @returns underlying native buffer
  6288. */
  6289. getBuffer(): Nullable<DataBuffer>;
  6290. /**
  6291. * Gets the stride in float32 units (i.e. byte stride / 4).
  6292. * May not be an integer if the byte stride is not divisible by 4.
  6293. * DEPRECATED. Use byteStride instead.
  6294. * @returns the stride in float32 units
  6295. */
  6296. getStrideSize(): number;
  6297. /**
  6298. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  6299. * @param data defines the data to store
  6300. */
  6301. create(data?: Nullable<DataArray>): void;
  6302. /** @hidden */
  6303. _rebuild(): void;
  6304. /**
  6305. * Update current buffer data
  6306. * @param data defines the data to store
  6307. */
  6308. update(data: DataArray): void;
  6309. /**
  6310. * Updates the data directly.
  6311. * @param data the new data
  6312. * @param offset the new offset
  6313. * @param vertexCount the vertex count (optional)
  6314. * @param useBytes set to true if the offset is in bytes
  6315. */
  6316. updateDirectly(data: DataArray, offset: number, vertexCount?: number, useBytes?: boolean): void;
  6317. /**
  6318. * Release all resources
  6319. */
  6320. dispose(): void;
  6321. }
  6322. /**
  6323. * Specialized buffer used to store vertex data
  6324. */
  6325. export class VertexBuffer {
  6326. /** @hidden */
  6327. _buffer: Buffer;
  6328. private _kind;
  6329. private _size;
  6330. private _ownsBuffer;
  6331. private _instanced;
  6332. private _instanceDivisor;
  6333. /**
  6334. * The byte type.
  6335. */
  6336. static readonly BYTE: number;
  6337. /**
  6338. * The unsigned byte type.
  6339. */
  6340. static readonly UNSIGNED_BYTE: number;
  6341. /**
  6342. * The short type.
  6343. */
  6344. static readonly SHORT: number;
  6345. /**
  6346. * The unsigned short type.
  6347. */
  6348. static readonly UNSIGNED_SHORT: number;
  6349. /**
  6350. * The integer type.
  6351. */
  6352. static readonly INT: number;
  6353. /**
  6354. * The unsigned integer type.
  6355. */
  6356. static readonly UNSIGNED_INT: number;
  6357. /**
  6358. * The float type.
  6359. */
  6360. static readonly FLOAT: number;
  6361. /**
  6362. * Gets or sets the instance divisor when in instanced mode
  6363. */
  6364. instanceDivisor: number;
  6365. /**
  6366. * Gets the byte stride.
  6367. */
  6368. readonly byteStride: number;
  6369. /**
  6370. * Gets the byte offset.
  6371. */
  6372. readonly byteOffset: number;
  6373. /**
  6374. * Gets whether integer data values should be normalized into a certain range when being casted to a float.
  6375. */
  6376. readonly normalized: boolean;
  6377. /**
  6378. * Gets the data type of each component in the array.
  6379. */
  6380. readonly type: number;
  6381. /**
  6382. * Constructor
  6383. * @param engine the engine
  6384. * @param data the data to use for this vertex buffer
  6385. * @param kind the vertex buffer kind
  6386. * @param updatable whether the data is updatable
  6387. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  6388. * @param stride the stride (optional)
  6389. * @param instanced whether the buffer is instanced (optional)
  6390. * @param offset the offset of the data (optional)
  6391. * @param size the number of components (optional)
  6392. * @param type the type of the component (optional)
  6393. * @param normalized whether the data contains normalized data (optional)
  6394. * @param useBytes set to true if stride and offset are in bytes (optional)
  6395. * @param divisor defines the instance divisor to use (1 by default)
  6396. */
  6397. 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);
  6398. /** @hidden */
  6399. _rebuild(): void;
  6400. /**
  6401. * Returns the kind of the VertexBuffer (string)
  6402. * @returns a string
  6403. */
  6404. getKind(): string;
  6405. /**
  6406. * Gets a boolean indicating if the VertexBuffer is updatable?
  6407. * @returns true if the buffer is updatable
  6408. */
  6409. isUpdatable(): boolean;
  6410. /**
  6411. * Gets current buffer's data
  6412. * @returns a DataArray or null
  6413. */
  6414. getData(): Nullable<DataArray>;
  6415. /**
  6416. * Gets underlying native buffer
  6417. * @returns underlying native buffer
  6418. */
  6419. getBuffer(): Nullable<DataBuffer>;
  6420. /**
  6421. * Gets the stride in float32 units (i.e. byte stride / 4).
  6422. * May not be an integer if the byte stride is not divisible by 4.
  6423. * DEPRECATED. Use byteStride instead.
  6424. * @returns the stride in float32 units
  6425. */
  6426. getStrideSize(): number;
  6427. /**
  6428. * Returns the offset as a multiple of the type byte length.
  6429. * DEPRECATED. Use byteOffset instead.
  6430. * @returns the offset in bytes
  6431. */
  6432. getOffset(): number;
  6433. /**
  6434. * Returns the number of components per vertex attribute (integer)
  6435. * @returns the size in float
  6436. */
  6437. getSize(): number;
  6438. /**
  6439. * Gets a boolean indicating is the internal buffer of the VertexBuffer is instanced
  6440. * @returns true if this buffer is instanced
  6441. */
  6442. getIsInstanced(): boolean;
  6443. /**
  6444. * Returns the instancing divisor, zero for non-instanced (integer).
  6445. * @returns a number
  6446. */
  6447. getInstanceDivisor(): number;
  6448. /**
  6449. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  6450. * @param data defines the data to store
  6451. */
  6452. create(data?: DataArray): void;
  6453. /**
  6454. * Updates the underlying buffer according to the passed numeric array or Float32Array.
  6455. * This function will create a new buffer if the current one is not updatable
  6456. * @param data defines the data to store
  6457. */
  6458. update(data: DataArray): void;
  6459. /**
  6460. * Updates directly the underlying WebGLBuffer according to the passed numeric array or Float32Array.
  6461. * Returns the directly updated WebGLBuffer.
  6462. * @param data the new data
  6463. * @param offset the new offset
  6464. * @param useBytes set to true if the offset is in bytes
  6465. */
  6466. updateDirectly(data: DataArray, offset: number, useBytes?: boolean): void;
  6467. /**
  6468. * Disposes the VertexBuffer and the underlying WebGLBuffer.
  6469. */
  6470. dispose(): void;
  6471. /**
  6472. * Enumerates each value of this vertex buffer as numbers.
  6473. * @param count the number of values to enumerate
  6474. * @param callback the callback function called for each value
  6475. */
  6476. forEach(count: number, callback: (value: number, index: number) => void): void;
  6477. /**
  6478. * Positions
  6479. */
  6480. static readonly PositionKind: string;
  6481. /**
  6482. * Normals
  6483. */
  6484. static readonly NormalKind: string;
  6485. /**
  6486. * Tangents
  6487. */
  6488. static readonly TangentKind: string;
  6489. /**
  6490. * Texture coordinates
  6491. */
  6492. static readonly UVKind: string;
  6493. /**
  6494. * Texture coordinates 2
  6495. */
  6496. static readonly UV2Kind: string;
  6497. /**
  6498. * Texture coordinates 3
  6499. */
  6500. static readonly UV3Kind: string;
  6501. /**
  6502. * Texture coordinates 4
  6503. */
  6504. static readonly UV4Kind: string;
  6505. /**
  6506. * Texture coordinates 5
  6507. */
  6508. static readonly UV5Kind: string;
  6509. /**
  6510. * Texture coordinates 6
  6511. */
  6512. static readonly UV6Kind: string;
  6513. /**
  6514. * Colors
  6515. */
  6516. static readonly ColorKind: string;
  6517. /**
  6518. * Matrix indices (for bones)
  6519. */
  6520. static readonly MatricesIndicesKind: string;
  6521. /**
  6522. * Matrix weights (for bones)
  6523. */
  6524. static readonly MatricesWeightsKind: string;
  6525. /**
  6526. * Additional matrix indices (for bones)
  6527. */
  6528. static readonly MatricesIndicesExtraKind: string;
  6529. /**
  6530. * Additional matrix weights (for bones)
  6531. */
  6532. static readonly MatricesWeightsExtraKind: string;
  6533. /**
  6534. * Deduces the stride given a kind.
  6535. * @param kind The kind string to deduce
  6536. * @returns The deduced stride
  6537. */
  6538. static DeduceStride(kind: string): number;
  6539. /**
  6540. * Gets the byte length of the given type.
  6541. * @param type the type
  6542. * @returns the number of bytes
  6543. */
  6544. static GetTypeByteLength(type: number): number;
  6545. /**
  6546. * Enumerates each value of the given parameters as numbers.
  6547. * @param data the data to enumerate
  6548. * @param byteOffset the byte offset of the data
  6549. * @param byteStride the byte stride of the data
  6550. * @param componentCount the number of components per element
  6551. * @param componentType the type of the component
  6552. * @param count the number of values to enumerate
  6553. * @param normalized whether the data is normalized
  6554. * @param callback the callback function called for each value
  6555. */
  6556. static ForEach(data: DataArray, byteOffset: number, byteStride: number, componentCount: number, componentType: number, count: number, normalized: boolean, callback: (value: number, index: number) => void): void;
  6557. private static _GetFloatValue;
  6558. }
  6559. }
  6560. declare module "babylonjs/Collisions/intersectionInfo" {
  6561. import { Nullable } from "babylonjs/types";
  6562. /**
  6563. * @hidden
  6564. */
  6565. export class IntersectionInfo {
  6566. bu: Nullable<number>;
  6567. bv: Nullable<number>;
  6568. distance: number;
  6569. faceId: number;
  6570. subMeshId: number;
  6571. constructor(bu: Nullable<number>, bv: Nullable<number>, distance: number);
  6572. }
  6573. }
  6574. declare module "babylonjs/Maths/math.plane" {
  6575. import { DeepImmutable } from "babylonjs/types";
  6576. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  6577. /**
  6578. * Represens a plane by the equation ax + by + cz + d = 0
  6579. */
  6580. export class Plane {
  6581. private static _TmpMatrix;
  6582. /**
  6583. * Normal of the plane (a,b,c)
  6584. */
  6585. normal: Vector3;
  6586. /**
  6587. * d component of the plane
  6588. */
  6589. d: number;
  6590. /**
  6591. * Creates a Plane object according to the given floats a, b, c, d and the plane equation : ax + by + cz + d = 0
  6592. * @param a a component of the plane
  6593. * @param b b component of the plane
  6594. * @param c c component of the plane
  6595. * @param d d component of the plane
  6596. */
  6597. constructor(a: number, b: number, c: number, d: number);
  6598. /**
  6599. * @returns the plane coordinates as a new array of 4 elements [a, b, c, d].
  6600. */
  6601. asArray(): number[];
  6602. /**
  6603. * @returns a new plane copied from the current Plane.
  6604. */
  6605. clone(): Plane;
  6606. /**
  6607. * @returns the string "Plane".
  6608. */
  6609. getClassName(): string;
  6610. /**
  6611. * @returns the Plane hash code.
  6612. */
  6613. getHashCode(): number;
  6614. /**
  6615. * Normalize the current Plane in place.
  6616. * @returns the updated Plane.
  6617. */
  6618. normalize(): Plane;
  6619. /**
  6620. * Applies a transformation the plane and returns the result
  6621. * @param transformation the transformation matrix to be applied to the plane
  6622. * @returns a new Plane as the result of the transformation of the current Plane by the given matrix.
  6623. */
  6624. transform(transformation: DeepImmutable<Matrix>): Plane;
  6625. /**
  6626. * Calcualtte the dot product between the point and the plane normal
  6627. * @param point point to calculate the dot product with
  6628. * @returns the dot product (float) of the point coordinates and the plane normal.
  6629. */
  6630. dotCoordinate(point: DeepImmutable<Vector3>): number;
  6631. /**
  6632. * Updates the current Plane from the plane defined by the three given points.
  6633. * @param point1 one of the points used to contruct the plane
  6634. * @param point2 one of the points used to contruct the plane
  6635. * @param point3 one of the points used to contruct the plane
  6636. * @returns the updated Plane.
  6637. */
  6638. copyFromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  6639. /**
  6640. * Checks if the plane is facing a given direction
  6641. * @param direction the direction to check if the plane is facing
  6642. * @param epsilon value the dot product is compared against (returns true if dot <= epsilon)
  6643. * @returns True is the vector "direction" is the same side than the plane normal.
  6644. */
  6645. isFrontFacingTo(direction: DeepImmutable<Vector3>, epsilon: number): boolean;
  6646. /**
  6647. * Calculates the distance to a point
  6648. * @param point point to calculate distance to
  6649. * @returns the signed distance (float) from the given point to the Plane.
  6650. */
  6651. signedDistanceTo(point: DeepImmutable<Vector3>): number;
  6652. /**
  6653. * Creates a plane from an array
  6654. * @param array the array to create a plane from
  6655. * @returns a new Plane from the given array.
  6656. */
  6657. static FromArray(array: DeepImmutable<ArrayLike<number>>): Plane;
  6658. /**
  6659. * Creates a plane from three points
  6660. * @param point1 point used to create the plane
  6661. * @param point2 point used to create the plane
  6662. * @param point3 point used to create the plane
  6663. * @returns a new Plane defined by the three given points.
  6664. */
  6665. static FromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  6666. /**
  6667. * Creates a plane from an origin point and a normal
  6668. * @param origin origin of the plane to be constructed
  6669. * @param normal normal of the plane to be constructed
  6670. * @returns a new Plane the normal vector to this plane at the given origin point.
  6671. * Note : the vector "normal" is updated because normalized.
  6672. */
  6673. static FromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>): Plane;
  6674. /**
  6675. * Calculates the distance from a plane and a point
  6676. * @param origin origin of the plane to be constructed
  6677. * @param normal normal of the plane to be constructed
  6678. * @param point point to calculate distance to
  6679. * @returns the signed distance between the plane defined by the normal vector at the "origin"" point and the given other point.
  6680. */
  6681. static SignedDistanceToPlaneFromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>, point: DeepImmutable<Vector3>): number;
  6682. }
  6683. }
  6684. declare module "babylonjs/Culling/boundingSphere" {
  6685. import { DeepImmutable } from "babylonjs/types";
  6686. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  6687. import { Plane } from "babylonjs/Maths/math.plane";
  6688. /**
  6689. * Class used to store bounding sphere information
  6690. */
  6691. export class BoundingSphere {
  6692. /**
  6693. * Gets the center of the bounding sphere in local space
  6694. */
  6695. readonly center: Vector3;
  6696. /**
  6697. * Radius of the bounding sphere in local space
  6698. */
  6699. radius: number;
  6700. /**
  6701. * Gets the center of the bounding sphere in world space
  6702. */
  6703. readonly centerWorld: Vector3;
  6704. /**
  6705. * Radius of the bounding sphere in world space
  6706. */
  6707. radiusWorld: number;
  6708. /**
  6709. * Gets the minimum vector in local space
  6710. */
  6711. readonly minimum: Vector3;
  6712. /**
  6713. * Gets the maximum vector in local space
  6714. */
  6715. readonly maximum: Vector3;
  6716. private _worldMatrix;
  6717. private static readonly TmpVector3;
  6718. /**
  6719. * Creates a new bounding sphere
  6720. * @param min defines the minimum vector (in local space)
  6721. * @param max defines the maximum vector (in local space)
  6722. * @param worldMatrix defines the new world matrix
  6723. */
  6724. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  6725. /**
  6726. * Recreates the entire bounding sphere from scratch as if we call the constructor in place
  6727. * @param min defines the new minimum vector (in local space)
  6728. * @param max defines the new maximum vector (in local space)
  6729. * @param worldMatrix defines the new world matrix
  6730. */
  6731. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  6732. /**
  6733. * Scale the current bounding sphere by applying a scale factor
  6734. * @param factor defines the scale factor to apply
  6735. * @returns the current bounding box
  6736. */
  6737. scale(factor: number): BoundingSphere;
  6738. /**
  6739. * Gets the world matrix of the bounding box
  6740. * @returns a matrix
  6741. */
  6742. getWorldMatrix(): DeepImmutable<Matrix>;
  6743. /** @hidden */
  6744. _update(worldMatrix: DeepImmutable<Matrix>): void;
  6745. /**
  6746. * Tests if the bounding sphere is intersecting the frustum planes
  6747. * @param frustumPlanes defines the frustum planes to test
  6748. * @returns true if there is an intersection
  6749. */
  6750. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  6751. /**
  6752. * Tests if the bounding sphere center is in between the frustum planes.
  6753. * Used for optimistic fast inclusion.
  6754. * @param frustumPlanes defines the frustum planes to test
  6755. * @returns true if the sphere center is in between the frustum planes
  6756. */
  6757. isCenterInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  6758. /**
  6759. * Tests if a point is inside the bounding sphere
  6760. * @param point defines the point to test
  6761. * @returns true if the point is inside the bounding sphere
  6762. */
  6763. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  6764. /**
  6765. * Checks if two sphere intersct
  6766. * @param sphere0 sphere 0
  6767. * @param sphere1 sphere 1
  6768. * @returns true if the speres intersect
  6769. */
  6770. static Intersects(sphere0: DeepImmutable<BoundingSphere>, sphere1: DeepImmutable<BoundingSphere>): boolean;
  6771. }
  6772. }
  6773. declare module "babylonjs/Culling/boundingBox" {
  6774. import { DeepImmutable } from "babylonjs/types";
  6775. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  6776. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  6777. import { ICullable } from "babylonjs/Culling/boundingInfo";
  6778. import { Plane } from "babylonjs/Maths/math.plane";
  6779. /**
  6780. * Class used to store bounding box information
  6781. */
  6782. export class BoundingBox implements ICullable {
  6783. /**
  6784. * Gets the 8 vectors representing the bounding box in local space
  6785. */
  6786. readonly vectors: Vector3[];
  6787. /**
  6788. * Gets the center of the bounding box in local space
  6789. */
  6790. readonly center: Vector3;
  6791. /**
  6792. * Gets the center of the bounding box in world space
  6793. */
  6794. readonly centerWorld: Vector3;
  6795. /**
  6796. * Gets the extend size in local space
  6797. */
  6798. readonly extendSize: Vector3;
  6799. /**
  6800. * Gets the extend size in world space
  6801. */
  6802. readonly extendSizeWorld: Vector3;
  6803. /**
  6804. * Gets the OBB (object bounding box) directions
  6805. */
  6806. readonly directions: Vector3[];
  6807. /**
  6808. * Gets the 8 vectors representing the bounding box in world space
  6809. */
  6810. readonly vectorsWorld: Vector3[];
  6811. /**
  6812. * Gets the minimum vector in world space
  6813. */
  6814. readonly minimumWorld: Vector3;
  6815. /**
  6816. * Gets the maximum vector in world space
  6817. */
  6818. readonly maximumWorld: Vector3;
  6819. /**
  6820. * Gets the minimum vector in local space
  6821. */
  6822. readonly minimum: Vector3;
  6823. /**
  6824. * Gets the maximum vector in local space
  6825. */
  6826. readonly maximum: Vector3;
  6827. private _worldMatrix;
  6828. private static readonly TmpVector3;
  6829. /**
  6830. * @hidden
  6831. */
  6832. _tag: number;
  6833. /**
  6834. * Creates a new bounding box
  6835. * @param min defines the minimum vector (in local space)
  6836. * @param max defines the maximum vector (in local space)
  6837. * @param worldMatrix defines the new world matrix
  6838. */
  6839. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  6840. /**
  6841. * Recreates the entire bounding box from scratch as if we call the constructor in place
  6842. * @param min defines the new minimum vector (in local space)
  6843. * @param max defines the new maximum vector (in local space)
  6844. * @param worldMatrix defines the new world matrix
  6845. */
  6846. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  6847. /**
  6848. * Scale the current bounding box by applying a scale factor
  6849. * @param factor defines the scale factor to apply
  6850. * @returns the current bounding box
  6851. */
  6852. scale(factor: number): BoundingBox;
  6853. /**
  6854. * Gets the world matrix of the bounding box
  6855. * @returns a matrix
  6856. */
  6857. getWorldMatrix(): DeepImmutable<Matrix>;
  6858. /** @hidden */
  6859. _update(world: DeepImmutable<Matrix>): void;
  6860. /**
  6861. * Tests if the bounding box is intersecting the frustum planes
  6862. * @param frustumPlanes defines the frustum planes to test
  6863. * @returns true if there is an intersection
  6864. */
  6865. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  6866. /**
  6867. * Tests if the bounding box is entirely inside the frustum planes
  6868. * @param frustumPlanes defines the frustum planes to test
  6869. * @returns true if there is an inclusion
  6870. */
  6871. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  6872. /**
  6873. * Tests if a point is inside the bounding box
  6874. * @param point defines the point to test
  6875. * @returns true if the point is inside the bounding box
  6876. */
  6877. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  6878. /**
  6879. * Tests if the bounding box intersects with a bounding sphere
  6880. * @param sphere defines the sphere to test
  6881. * @returns true if there is an intersection
  6882. */
  6883. intersectsSphere(sphere: DeepImmutable<BoundingSphere>): boolean;
  6884. /**
  6885. * Tests if the bounding box intersects with a box defined by a min and max vectors
  6886. * @param min defines the min vector to use
  6887. * @param max defines the max vector to use
  6888. * @returns true if there is an intersection
  6889. */
  6890. intersectsMinMax(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): boolean;
  6891. /**
  6892. * Tests if two bounding boxes are intersections
  6893. * @param box0 defines the first box to test
  6894. * @param box1 defines the second box to test
  6895. * @returns true if there is an intersection
  6896. */
  6897. static Intersects(box0: DeepImmutable<BoundingBox>, box1: DeepImmutable<BoundingBox>): boolean;
  6898. /**
  6899. * Tests if a bounding box defines by a min/max vectors intersects a sphere
  6900. * @param minPoint defines the minimum vector of the bounding box
  6901. * @param maxPoint defines the maximum vector of the bounding box
  6902. * @param sphereCenter defines the sphere center
  6903. * @param sphereRadius defines the sphere radius
  6904. * @returns true if there is an intersection
  6905. */
  6906. static IntersectsSphere(minPoint: DeepImmutable<Vector3>, maxPoint: DeepImmutable<Vector3>, sphereCenter: DeepImmutable<Vector3>, sphereRadius: number): boolean;
  6907. /**
  6908. * Tests if a bounding box defined with 8 vectors is entirely inside frustum planes
  6909. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  6910. * @param frustumPlanes defines the frustum planes to test
  6911. * @return true if there is an inclusion
  6912. */
  6913. static IsCompletelyInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  6914. /**
  6915. * Tests if a bounding box defined with 8 vectors intersects frustum planes
  6916. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  6917. * @param frustumPlanes defines the frustum planes to test
  6918. * @return true if there is an intersection
  6919. */
  6920. static IsInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  6921. }
  6922. }
  6923. declare module "babylonjs/Collisions/collider" {
  6924. import { Nullable, IndicesArray } from "babylonjs/types";
  6925. import { Vector3 } from "babylonjs/Maths/math.vector";
  6926. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  6927. import { Plane } from "babylonjs/Maths/math.plane";
  6928. /** @hidden */
  6929. export class Collider {
  6930. /** Define if a collision was found */
  6931. collisionFound: boolean;
  6932. /**
  6933. * Define last intersection point in local space
  6934. */
  6935. intersectionPoint: Vector3;
  6936. /**
  6937. * Define last collided mesh
  6938. */
  6939. collidedMesh: Nullable<AbstractMesh>;
  6940. private _collisionPoint;
  6941. private _planeIntersectionPoint;
  6942. private _tempVector;
  6943. private _tempVector2;
  6944. private _tempVector3;
  6945. private _tempVector4;
  6946. private _edge;
  6947. private _baseToVertex;
  6948. private _destinationPoint;
  6949. private _slidePlaneNormal;
  6950. private _displacementVector;
  6951. /** @hidden */
  6952. _radius: Vector3;
  6953. /** @hidden */
  6954. _retry: number;
  6955. private _velocity;
  6956. private _basePoint;
  6957. private _epsilon;
  6958. /** @hidden */
  6959. _velocityWorldLength: number;
  6960. /** @hidden */
  6961. _basePointWorld: Vector3;
  6962. private _velocityWorld;
  6963. private _normalizedVelocity;
  6964. /** @hidden */
  6965. _initialVelocity: Vector3;
  6966. /** @hidden */
  6967. _initialPosition: Vector3;
  6968. private _nearestDistance;
  6969. private _collisionMask;
  6970. collisionMask: number;
  6971. /**
  6972. * Gets the plane normal used to compute the sliding response (in local space)
  6973. */
  6974. readonly slidePlaneNormal: Vector3;
  6975. /** @hidden */
  6976. _initialize(source: Vector3, dir: Vector3, e: number): void;
  6977. /** @hidden */
  6978. _checkPointInTriangle(point: Vector3, pa: Vector3, pb: Vector3, pc: Vector3, n: Vector3): boolean;
  6979. /** @hidden */
  6980. _canDoCollision(sphereCenter: Vector3, sphereRadius: number, vecMin: Vector3, vecMax: Vector3): boolean;
  6981. /** @hidden */
  6982. _testTriangle(faceIndex: number, trianglePlaneArray: Array<Plane>, p1: Vector3, p2: Vector3, p3: Vector3, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  6983. /** @hidden */
  6984. _collide(trianglePlaneArray: Array<Plane>, pts: Vector3[], indices: IndicesArray, indexStart: number, indexEnd: number, decal: number, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  6985. /** @hidden */
  6986. _getResponse(pos: Vector3, vel: Vector3): void;
  6987. }
  6988. }
  6989. declare module "babylonjs/Culling/boundingInfo" {
  6990. import { DeepImmutable } from "babylonjs/types";
  6991. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  6992. import { BoundingBox } from "babylonjs/Culling/boundingBox";
  6993. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  6994. import { Plane } from "babylonjs/Maths/math.plane";
  6995. import { Collider } from "babylonjs/Collisions/collider";
  6996. /**
  6997. * Interface for cullable objects
  6998. * @see https://doc.babylonjs.com/babylon101/materials#back-face-culling
  6999. */
  7000. export interface ICullable {
  7001. /**
  7002. * Checks if the object or part of the object is in the frustum
  7003. * @param frustumPlanes Camera near/planes
  7004. * @returns true if the object is in frustum otherwise false
  7005. */
  7006. isInFrustum(frustumPlanes: Plane[]): boolean;
  7007. /**
  7008. * Checks if a cullable object (mesh...) is in the camera frustum
  7009. * Unlike isInFrustum this cheks the full bounding box
  7010. * @param frustumPlanes Camera near/planes
  7011. * @returns true if the object is in frustum otherwise false
  7012. */
  7013. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  7014. }
  7015. /**
  7016. * Info for a bounding data of a mesh
  7017. */
  7018. export class BoundingInfo implements ICullable {
  7019. /**
  7020. * Bounding box for the mesh
  7021. */
  7022. readonly boundingBox: BoundingBox;
  7023. /**
  7024. * Bounding sphere for the mesh
  7025. */
  7026. readonly boundingSphere: BoundingSphere;
  7027. private _isLocked;
  7028. private static readonly TmpVector3;
  7029. /**
  7030. * Constructs bounding info
  7031. * @param minimum min vector of the bounding box/sphere
  7032. * @param maximum max vector of the bounding box/sphere
  7033. * @param worldMatrix defines the new world matrix
  7034. */
  7035. constructor(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  7036. /**
  7037. * Recreates the entire bounding info from scratch as if we call the constructor in place
  7038. * @param min defines the new minimum vector (in local space)
  7039. * @param max defines the new maximum vector (in local space)
  7040. * @param worldMatrix defines the new world matrix
  7041. */
  7042. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  7043. /**
  7044. * min vector of the bounding box/sphere
  7045. */
  7046. readonly minimum: Vector3;
  7047. /**
  7048. * max vector of the bounding box/sphere
  7049. */
  7050. readonly maximum: Vector3;
  7051. /**
  7052. * If the info is locked and won't be updated to avoid perf overhead
  7053. */
  7054. isLocked: boolean;
  7055. /**
  7056. * Updates the bounding sphere and box
  7057. * @param world world matrix to be used to update
  7058. */
  7059. update(world: DeepImmutable<Matrix>): void;
  7060. /**
  7061. * Recreate the bounding info to be centered around a specific point given a specific extend.
  7062. * @param center New center of the bounding info
  7063. * @param extend New extend of the bounding info
  7064. * @returns the current bounding info
  7065. */
  7066. centerOn(center: DeepImmutable<Vector3>, extend: DeepImmutable<Vector3>): BoundingInfo;
  7067. /**
  7068. * Scale the current bounding info by applying a scale factor
  7069. * @param factor defines the scale factor to apply
  7070. * @returns the current bounding info
  7071. */
  7072. scale(factor: number): BoundingInfo;
  7073. /**
  7074. * Returns `true` if the bounding info is within the frustum defined by the passed array of planes.
  7075. * @param frustumPlanes defines the frustum to test
  7076. * @param strategy defines the strategy to use for the culling (default is BABYLON.AbstractMesh.CULLINGSTRATEGY_STANDARD)
  7077. * @returns true if the bounding info is in the frustum planes
  7078. */
  7079. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>, strategy?: number): boolean;
  7080. /**
  7081. * Gets the world distance between the min and max points of the bounding box
  7082. */
  7083. readonly diagonalLength: number;
  7084. /**
  7085. * Checks if a cullable object (mesh...) is in the camera frustum
  7086. * Unlike isInFrustum this cheks the full bounding box
  7087. * @param frustumPlanes Camera near/planes
  7088. * @returns true if the object is in frustum otherwise false
  7089. */
  7090. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  7091. /** @hidden */
  7092. _checkCollision(collider: Collider): boolean;
  7093. /**
  7094. * Checks if a point is inside the bounding box and bounding sphere or the mesh
  7095. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  7096. * @param point the point to check intersection with
  7097. * @returns if the point intersects
  7098. */
  7099. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  7100. /**
  7101. * Checks if another bounding info intersects the bounding box and bounding sphere or the mesh
  7102. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  7103. * @param boundingInfo the bounding info to check intersection with
  7104. * @param precise if the intersection should be done using OBB
  7105. * @returns if the bounding info intersects
  7106. */
  7107. intersects(boundingInfo: DeepImmutable<BoundingInfo>, precise: boolean): boolean;
  7108. }
  7109. }
  7110. declare module "babylonjs/Maths/math.functions" {
  7111. import { FloatArray, Nullable, IndicesArray } from "babylonjs/types";
  7112. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  7113. /**
  7114. * Extracts minimum and maximum values from a list of indexed positions
  7115. * @param positions defines the positions to use
  7116. * @param indices defines the indices to the positions
  7117. * @param indexStart defines the start index
  7118. * @param indexCount defines the end index
  7119. * @param bias defines bias value to add to the result
  7120. * @return minimum and maximum values
  7121. */
  7122. export function extractMinAndMaxIndexed(positions: FloatArray, indices: IndicesArray, indexStart: number, indexCount: number, bias?: Nullable<Vector2>): {
  7123. minimum: Vector3;
  7124. maximum: Vector3;
  7125. };
  7126. /**
  7127. * Extracts minimum and maximum values from a list of positions
  7128. * @param positions defines the positions to use
  7129. * @param start defines the start index in the positions array
  7130. * @param count defines the number of positions to handle
  7131. * @param bias defines bias value to add to the result
  7132. * @param stride defines the stride size to use (distance between two positions in the positions array)
  7133. * @return minimum and maximum values
  7134. */
  7135. export function extractMinAndMax(positions: FloatArray, start: number, count: number, bias?: Nullable<Vector2>, stride?: number): {
  7136. minimum: Vector3;
  7137. maximum: Vector3;
  7138. };
  7139. }
  7140. declare module "babylonjs/Meshes/WebGL/webGLDataBuffer" {
  7141. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  7142. /** @hidden */
  7143. export class WebGLDataBuffer extends DataBuffer {
  7144. private _buffer;
  7145. constructor(resource: WebGLBuffer);
  7146. readonly underlyingResource: any;
  7147. }
  7148. }
  7149. declare module "babylonjs/Engines/WebGL/webGLPipelineContext" {
  7150. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  7151. import { Nullable } from "babylonjs/types";
  7152. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  7153. /** @hidden */
  7154. export class WebGLPipelineContext implements IPipelineContext {
  7155. engine: ThinEngine;
  7156. program: Nullable<WebGLProgram>;
  7157. context?: WebGLRenderingContext;
  7158. vertexShader?: WebGLShader;
  7159. fragmentShader?: WebGLShader;
  7160. isParallelCompiled: boolean;
  7161. onCompiled?: () => void;
  7162. transformFeedback?: WebGLTransformFeedback | null;
  7163. readonly isAsync: boolean;
  7164. readonly isReady: boolean;
  7165. _handlesSpectorRebuildCallback(onCompiled: (program: WebGLProgram) => void): void;
  7166. }
  7167. }
  7168. declare module "babylonjs/Engines/Extensions/engine.uniformBuffer" {
  7169. import { FloatArray, Nullable } from "babylonjs/types";
  7170. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  7171. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  7172. module "babylonjs/Engines/thinEngine" {
  7173. interface ThinEngine {
  7174. /**
  7175. * Create an uniform buffer
  7176. * @see http://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  7177. * @param elements defines the content of the uniform buffer
  7178. * @returns the webGL uniform buffer
  7179. */
  7180. createUniformBuffer(elements: FloatArray): DataBuffer;
  7181. /**
  7182. * Create a dynamic uniform buffer
  7183. * @see http://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  7184. * @param elements defines the content of the uniform buffer
  7185. * @returns the webGL uniform buffer
  7186. */
  7187. createDynamicUniformBuffer(elements: FloatArray): DataBuffer;
  7188. /**
  7189. * Update an existing uniform buffer
  7190. * @see http://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  7191. * @param uniformBuffer defines the target uniform buffer
  7192. * @param elements defines the content to update
  7193. * @param offset defines the offset in the uniform buffer where update should start
  7194. * @param count defines the size of the data to update
  7195. */
  7196. updateUniformBuffer(uniformBuffer: DataBuffer, elements: FloatArray, offset?: number, count?: number): void;
  7197. /**
  7198. * Bind an uniform buffer to the current webGL context
  7199. * @param buffer defines the buffer to bind
  7200. */
  7201. bindUniformBuffer(buffer: Nullable<DataBuffer>): void;
  7202. /**
  7203. * Bind a buffer to the current webGL context at a given location
  7204. * @param buffer defines the buffer to bind
  7205. * @param location defines the index where to bind the buffer
  7206. */
  7207. bindUniformBufferBase(buffer: DataBuffer, location: number): void;
  7208. /**
  7209. * Bind a specific block at a given index in a specific shader program
  7210. * @param pipelineContext defines the pipeline context to use
  7211. * @param blockName defines the block name
  7212. * @param index defines the index where to bind the block
  7213. */
  7214. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  7215. }
  7216. }
  7217. }
  7218. declare module "babylonjs/Materials/uniformBuffer" {
  7219. import { Nullable, FloatArray } from "babylonjs/types";
  7220. import { Matrix, Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  7221. import { Engine } from "babylonjs/Engines/engine";
  7222. import { Effect } from "babylonjs/Materials/effect";
  7223. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  7224. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  7225. import { Color3 } from "babylonjs/Maths/math.color";
  7226. import "babylonjs/Engines/Extensions/engine.uniformBuffer";
  7227. /**
  7228. * Uniform buffer objects.
  7229. *
  7230. * Handles blocks of uniform on the GPU.
  7231. *
  7232. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  7233. *
  7234. * For more information, please refer to :
  7235. * https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  7236. */
  7237. export class UniformBuffer {
  7238. private _engine;
  7239. private _buffer;
  7240. private _data;
  7241. private _bufferData;
  7242. private _dynamic?;
  7243. private _uniformLocations;
  7244. private _uniformSizes;
  7245. private _uniformLocationPointer;
  7246. private _needSync;
  7247. private _noUBO;
  7248. private _currentEffect;
  7249. /** @hidden */
  7250. _alreadyBound: boolean;
  7251. private static _MAX_UNIFORM_SIZE;
  7252. private static _tempBuffer;
  7253. /**
  7254. * Lambda to Update a 3x3 Matrix in a uniform buffer.
  7255. * This is dynamic to allow compat with webgl 1 and 2.
  7256. * You will need to pass the name of the uniform as well as the value.
  7257. */
  7258. updateMatrix3x3: (name: string, matrix: Float32Array) => void;
  7259. /**
  7260. * Lambda to Update a 2x2 Matrix in a uniform buffer.
  7261. * This is dynamic to allow compat with webgl 1 and 2.
  7262. * You will need to pass the name of the uniform as well as the value.
  7263. */
  7264. updateMatrix2x2: (name: string, matrix: Float32Array) => void;
  7265. /**
  7266. * Lambda to Update a single float in a uniform buffer.
  7267. * This is dynamic to allow compat with webgl 1 and 2.
  7268. * You will need to pass the name of the uniform as well as the value.
  7269. */
  7270. updateFloat: (name: string, x: number) => void;
  7271. /**
  7272. * Lambda to Update a vec2 of float in a uniform buffer.
  7273. * This is dynamic to allow compat with webgl 1 and 2.
  7274. * You will need to pass the name of the uniform as well as the value.
  7275. */
  7276. updateFloat2: (name: string, x: number, y: number, suffix?: string) => void;
  7277. /**
  7278. * Lambda to Update a vec3 of float in a uniform buffer.
  7279. * This is dynamic to allow compat with webgl 1 and 2.
  7280. * You will need to pass the name of the uniform as well as the value.
  7281. */
  7282. updateFloat3: (name: string, x: number, y: number, z: number, suffix?: string) => void;
  7283. /**
  7284. * Lambda to Update a vec4 of float in a uniform buffer.
  7285. * This is dynamic to allow compat with webgl 1 and 2.
  7286. * You will need to pass the name of the uniform as well as the value.
  7287. */
  7288. updateFloat4: (name: string, x: number, y: number, z: number, w: number, suffix?: string) => void;
  7289. /**
  7290. * Lambda to Update a 4x4 Matrix in a uniform buffer.
  7291. * This is dynamic to allow compat with webgl 1 and 2.
  7292. * You will need to pass the name of the uniform as well as the value.
  7293. */
  7294. updateMatrix: (name: string, mat: Matrix) => void;
  7295. /**
  7296. * Lambda to Update vec3 of float from a Vector in a uniform buffer.
  7297. * This is dynamic to allow compat with webgl 1 and 2.
  7298. * You will need to pass the name of the uniform as well as the value.
  7299. */
  7300. updateVector3: (name: string, vector: Vector3) => void;
  7301. /**
  7302. * Lambda to Update vec4 of float from a Vector in a uniform buffer.
  7303. * This is dynamic to allow compat with webgl 1 and 2.
  7304. * You will need to pass the name of the uniform as well as the value.
  7305. */
  7306. updateVector4: (name: string, vector: Vector4) => void;
  7307. /**
  7308. * Lambda to Update vec3 of float from a Color in a uniform buffer.
  7309. * This is dynamic to allow compat with webgl 1 and 2.
  7310. * You will need to pass the name of the uniform as well as the value.
  7311. */
  7312. updateColor3: (name: string, color: Color3, suffix?: string) => void;
  7313. /**
  7314. * Lambda to Update vec4 of float from a Color in a uniform buffer.
  7315. * This is dynamic to allow compat with webgl 1 and 2.
  7316. * You will need to pass the name of the uniform as well as the value.
  7317. */
  7318. updateColor4: (name: string, color: Color3, alpha: number, suffix?: string) => void;
  7319. /**
  7320. * Instantiates a new Uniform buffer objects.
  7321. *
  7322. * Handles blocks of uniform on the GPU.
  7323. *
  7324. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  7325. *
  7326. * For more information, please refer to :
  7327. * @see https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  7328. * @param engine Define the engine the buffer is associated with
  7329. * @param data Define the data contained in the buffer
  7330. * @param dynamic Define if the buffer is updatable
  7331. */
  7332. constructor(engine: Engine, data?: number[], dynamic?: boolean);
  7333. /**
  7334. * Indicates if the buffer is using the WebGL2 UBO implementation,
  7335. * or just falling back on setUniformXXX calls.
  7336. */
  7337. readonly useUbo: boolean;
  7338. /**
  7339. * Indicates if the WebGL underlying uniform buffer is in sync
  7340. * with the javascript cache data.
  7341. */
  7342. readonly isSync: boolean;
  7343. /**
  7344. * Indicates if the WebGL underlying uniform buffer is dynamic.
  7345. * Also, a dynamic UniformBuffer will disable cache verification and always
  7346. * update the underlying WebGL uniform buffer to the GPU.
  7347. * @returns if Dynamic, otherwise false
  7348. */
  7349. isDynamic(): boolean;
  7350. /**
  7351. * The data cache on JS side.
  7352. * @returns the underlying data as a float array
  7353. */
  7354. getData(): Float32Array;
  7355. /**
  7356. * The underlying WebGL Uniform buffer.
  7357. * @returns the webgl buffer
  7358. */
  7359. getBuffer(): Nullable<DataBuffer>;
  7360. /**
  7361. * std140 layout specifies how to align data within an UBO structure.
  7362. * See https://khronos.org/registry/OpenGL/specs/gl/glspec45.core.pdf#page=159
  7363. * for specs.
  7364. */
  7365. private _fillAlignment;
  7366. /**
  7367. * Adds an uniform in the buffer.
  7368. * Warning : the subsequents calls of this function must be in the same order as declared in the shader
  7369. * for the layout to be correct !
  7370. * @param name Name of the uniform, as used in the uniform block in the shader.
  7371. * @param size Data size, or data directly.
  7372. */
  7373. addUniform(name: string, size: number | number[]): void;
  7374. /**
  7375. * Adds a Matrix 4x4 to the uniform buffer.
  7376. * @param name Name of the uniform, as used in the uniform block in the shader.
  7377. * @param mat A 4x4 matrix.
  7378. */
  7379. addMatrix(name: string, mat: Matrix): void;
  7380. /**
  7381. * Adds a vec2 to the uniform buffer.
  7382. * @param name Name of the uniform, as used in the uniform block in the shader.
  7383. * @param x Define the x component value of the vec2
  7384. * @param y Define the y component value of the vec2
  7385. */
  7386. addFloat2(name: string, x: number, y: number): void;
  7387. /**
  7388. * Adds a vec3 to the uniform buffer.
  7389. * @param name Name of the uniform, as used in the uniform block in the shader.
  7390. * @param x Define the x component value of the vec3
  7391. * @param y Define the y component value of the vec3
  7392. * @param z Define the z component value of the vec3
  7393. */
  7394. addFloat3(name: string, x: number, y: number, z: number): void;
  7395. /**
  7396. * Adds a vec3 to the uniform buffer.
  7397. * @param name Name of the uniform, as used in the uniform block in the shader.
  7398. * @param color Define the vec3 from a Color
  7399. */
  7400. addColor3(name: string, color: Color3): void;
  7401. /**
  7402. * Adds a vec4 to the uniform buffer.
  7403. * @param name Name of the uniform, as used in the uniform block in the shader.
  7404. * @param color Define the rgb components from a Color
  7405. * @param alpha Define the a component of the vec4
  7406. */
  7407. addColor4(name: string, color: Color3, alpha: number): void;
  7408. /**
  7409. * Adds a vec3 to the uniform buffer.
  7410. * @param name Name of the uniform, as used in the uniform block in the shader.
  7411. * @param vector Define the vec3 components from a Vector
  7412. */
  7413. addVector3(name: string, vector: Vector3): void;
  7414. /**
  7415. * Adds a Matrix 3x3 to the uniform buffer.
  7416. * @param name Name of the uniform, as used in the uniform block in the shader.
  7417. */
  7418. addMatrix3x3(name: string): void;
  7419. /**
  7420. * Adds a Matrix 2x2 to the uniform buffer.
  7421. * @param name Name of the uniform, as used in the uniform block in the shader.
  7422. */
  7423. addMatrix2x2(name: string): void;
  7424. /**
  7425. * Effectively creates the WebGL Uniform Buffer, once layout is completed with `addUniform`.
  7426. */
  7427. create(): void;
  7428. /** @hidden */
  7429. _rebuild(): void;
  7430. /**
  7431. * Updates the WebGL Uniform Buffer on the GPU.
  7432. * If the `dynamic` flag is set to true, no cache comparison is done.
  7433. * Otherwise, the buffer will be updated only if the cache differs.
  7434. */
  7435. update(): void;
  7436. /**
  7437. * Updates the value of an uniform. The `update` method must be called afterwards to make it effective in the GPU.
  7438. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  7439. * @param data Define the flattened data
  7440. * @param size Define the size of the data.
  7441. */
  7442. updateUniform(uniformName: string, data: FloatArray, size: number): void;
  7443. private _valueCache;
  7444. private _cacheMatrix;
  7445. private _updateMatrix3x3ForUniform;
  7446. private _updateMatrix3x3ForEffect;
  7447. private _updateMatrix2x2ForEffect;
  7448. private _updateMatrix2x2ForUniform;
  7449. private _updateFloatForEffect;
  7450. private _updateFloatForUniform;
  7451. private _updateFloat2ForEffect;
  7452. private _updateFloat2ForUniform;
  7453. private _updateFloat3ForEffect;
  7454. private _updateFloat3ForUniform;
  7455. private _updateFloat4ForEffect;
  7456. private _updateFloat4ForUniform;
  7457. private _updateMatrixForEffect;
  7458. private _updateMatrixForUniform;
  7459. private _updateVector3ForEffect;
  7460. private _updateVector3ForUniform;
  7461. private _updateVector4ForEffect;
  7462. private _updateVector4ForUniform;
  7463. private _updateColor3ForEffect;
  7464. private _updateColor3ForUniform;
  7465. private _updateColor4ForEffect;
  7466. private _updateColor4ForUniform;
  7467. /**
  7468. * Sets a sampler uniform on the effect.
  7469. * @param name Define the name of the sampler.
  7470. * @param texture Define the texture to set in the sampler
  7471. */
  7472. setTexture(name: string, texture: Nullable<BaseTexture>): void;
  7473. /**
  7474. * Directly updates the value of the uniform in the cache AND on the GPU.
  7475. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  7476. * @param data Define the flattened data
  7477. */
  7478. updateUniformDirectly(uniformName: string, data: FloatArray): void;
  7479. /**
  7480. * Binds this uniform buffer to an effect.
  7481. * @param effect Define the effect to bind the buffer to
  7482. * @param name Name of the uniform block in the shader.
  7483. */
  7484. bindToEffect(effect: Effect, name: string): void;
  7485. /**
  7486. * Disposes the uniform buffer.
  7487. */
  7488. dispose(): void;
  7489. }
  7490. }
  7491. declare module "babylonjs/Misc/iInspectable" {
  7492. /**
  7493. * Enum that determines the text-wrapping mode to use.
  7494. */
  7495. export enum InspectableType {
  7496. /**
  7497. * Checkbox for booleans
  7498. */
  7499. Checkbox = 0,
  7500. /**
  7501. * Sliders for numbers
  7502. */
  7503. Slider = 1,
  7504. /**
  7505. * Vector3
  7506. */
  7507. Vector3 = 2,
  7508. /**
  7509. * Quaternions
  7510. */
  7511. Quaternion = 3,
  7512. /**
  7513. * Color3
  7514. */
  7515. Color3 = 4,
  7516. /**
  7517. * String
  7518. */
  7519. String = 5
  7520. }
  7521. /**
  7522. * Interface used to define custom inspectable properties.
  7523. * This interface is used by the inspector to display custom property grids
  7524. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  7525. */
  7526. export interface IInspectable {
  7527. /**
  7528. * Gets the label to display
  7529. */
  7530. label: string;
  7531. /**
  7532. * Gets the name of the property to edit
  7533. */
  7534. propertyName: string;
  7535. /**
  7536. * Gets the type of the editor to use
  7537. */
  7538. type: InspectableType;
  7539. /**
  7540. * Gets the minimum value of the property when using in "slider" mode
  7541. */
  7542. min?: number;
  7543. /**
  7544. * Gets the maximum value of the property when using in "slider" mode
  7545. */
  7546. max?: number;
  7547. /**
  7548. * Gets the setp to use when using in "slider" mode
  7549. */
  7550. step?: number;
  7551. }
  7552. }
  7553. declare module "babylonjs/Misc/timingTools" {
  7554. /**
  7555. * Class used to provide helper for timing
  7556. */
  7557. export class TimingTools {
  7558. /**
  7559. * Polyfill for setImmediate
  7560. * @param action defines the action to execute after the current execution block
  7561. */
  7562. static SetImmediate(action: () => void): void;
  7563. }
  7564. }
  7565. declare module "babylonjs/Misc/instantiationTools" {
  7566. /**
  7567. * Class used to enable instatition of objects by class name
  7568. */
  7569. export class InstantiationTools {
  7570. /**
  7571. * Use this object to register external classes like custom textures or material
  7572. * to allow the laoders to instantiate them
  7573. */
  7574. static RegisteredExternalClasses: {
  7575. [key: string]: Object;
  7576. };
  7577. /**
  7578. * Tries to instantiate a new object from a given class name
  7579. * @param className defines the class name to instantiate
  7580. * @returns the new object or null if the system was not able to do the instantiation
  7581. */
  7582. static Instantiate(className: string): any;
  7583. }
  7584. }
  7585. declare module "babylonjs/Engines/depthTextureCreationOptions" {
  7586. /**
  7587. * Define options used to create a depth texture
  7588. */
  7589. export class DepthTextureCreationOptions {
  7590. /** Specifies whether or not a stencil should be allocated in the texture */
  7591. generateStencil?: boolean;
  7592. /** Specifies whether or not bilinear filtering is enable on the texture */
  7593. bilinearFiltering?: boolean;
  7594. /** Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode */
  7595. comparisonFunction?: number;
  7596. /** Specifies if the created texture is a cube texture */
  7597. isCube?: boolean;
  7598. }
  7599. }
  7600. declare module "babylonjs/Engines/Extensions/engine.cubeTexture" {
  7601. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  7602. import { Nullable } from "babylonjs/types";
  7603. import { Scene } from "babylonjs/scene";
  7604. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  7605. import { DepthTextureCreationOptions } from "babylonjs/Engines/depthTextureCreationOptions";
  7606. module "babylonjs/Engines/thinEngine" {
  7607. interface ThinEngine {
  7608. /**
  7609. * Creates a depth stencil cube texture.
  7610. * This is only available in WebGL 2.
  7611. * @param size The size of face edge in the cube texture.
  7612. * @param options The options defining the cube texture.
  7613. * @returns The cube texture
  7614. */
  7615. _createDepthStencilCubeTexture(size: number, options: DepthTextureCreationOptions): InternalTexture;
  7616. /**
  7617. * Creates a cube texture
  7618. * @param rootUrl defines the url where the files to load is located
  7619. * @param scene defines the current scene
  7620. * @param files defines the list of files to load (1 per face)
  7621. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  7622. * @param onLoad defines an optional callback raised when the texture is loaded
  7623. * @param onError defines an optional callback raised if there is an issue to load the texture
  7624. * @param format defines the format of the data
  7625. * @param forcedExtension defines the extension to use to pick the right loader
  7626. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  7627. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  7628. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  7629. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  7630. * @param excludeLoaders array of texture loaders that should be excluded when picking a loader for the texture (defualt: empty array)
  7631. * @returns the cube texture as an InternalTexture
  7632. */
  7633. 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;
  7634. /**
  7635. * Creates a cube texture
  7636. * @param rootUrl defines the url where the files to load is located
  7637. * @param scene defines the current scene
  7638. * @param files defines the list of files to load (1 per face)
  7639. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  7640. * @param onLoad defines an optional callback raised when the texture is loaded
  7641. * @param onError defines an optional callback raised if there is an issue to load the texture
  7642. * @param format defines the format of the data
  7643. * @param forcedExtension defines the extension to use to pick the right loader
  7644. * @returns the cube texture as an InternalTexture
  7645. */
  7646. 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;
  7647. /**
  7648. * Creates a cube texture
  7649. * @param rootUrl defines the url where the files to load is located
  7650. * @param scene defines the current scene
  7651. * @param files defines the list of files to load (1 per face)
  7652. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  7653. * @param onLoad defines an optional callback raised when the texture is loaded
  7654. * @param onError defines an optional callback raised if there is an issue to load the texture
  7655. * @param format defines the format of the data
  7656. * @param forcedExtension defines the extension to use to pick the right loader
  7657. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  7658. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  7659. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  7660. * @returns the cube texture as an InternalTexture
  7661. */
  7662. 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;
  7663. /** @hidden */
  7664. _partialLoadFile(url: string, index: number, loadedFiles: (string | ArrayBuffer)[], onfinish: (files: (string | ArrayBuffer)[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>): void;
  7665. /** @hidden */
  7666. _cascadeLoadFiles(scene: Nullable<Scene>, onfinish: (images: (string | ArrayBuffer)[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>): void;
  7667. /** @hidden */
  7668. _cascadeLoadImgs(scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  7669. /** @hidden */
  7670. _partialLoadImg(url: string, index: number, loadedImages: HTMLImageElement[], scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  7671. /**
  7672. * @hidden
  7673. */
  7674. _setCubeMapTextureParams(loadMipmap: boolean): void;
  7675. }
  7676. }
  7677. }
  7678. declare module "babylonjs/Materials/Textures/cubeTexture" {
  7679. import { Nullable } from "babylonjs/types";
  7680. import { Scene } from "babylonjs/scene";
  7681. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  7682. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  7683. import "babylonjs/Engines/Extensions/engine.cubeTexture";
  7684. /**
  7685. * Class for creating a cube texture
  7686. */
  7687. export class CubeTexture extends BaseTexture {
  7688. private _delayedOnLoad;
  7689. /**
  7690. * The url of the texture
  7691. */
  7692. url: string;
  7693. /**
  7694. * Gets or sets the center of the bounding box associated with the cube texture.
  7695. * It must define where the camera used to render the texture was set
  7696. * @see http://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  7697. */
  7698. boundingBoxPosition: Vector3;
  7699. private _boundingBoxSize;
  7700. /**
  7701. * Gets or sets the size of the bounding box associated with the cube texture
  7702. * When defined, the cubemap will switch to local mode
  7703. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  7704. * @example https://www.babylonjs-playground.com/#RNASML
  7705. */
  7706. /**
  7707. * Returns the bounding box size
  7708. * @see http://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  7709. */
  7710. boundingBoxSize: Vector3;
  7711. protected _rotationY: number;
  7712. /**
  7713. * Sets texture matrix rotation angle around Y axis in radians.
  7714. */
  7715. /**
  7716. * Gets texture matrix rotation angle around Y axis radians.
  7717. */
  7718. rotationY: number;
  7719. /**
  7720. * Are mip maps generated for this texture or not.
  7721. */
  7722. readonly noMipmap: boolean;
  7723. private _noMipmap;
  7724. private _files;
  7725. protected _forcedExtension: Nullable<string>;
  7726. private _extensions;
  7727. private _textureMatrix;
  7728. private _format;
  7729. private _createPolynomials;
  7730. /** @hidden */
  7731. _prefiltered: boolean;
  7732. /**
  7733. * Creates a cube texture from an array of image urls
  7734. * @param files defines an array of image urls
  7735. * @param scene defines the hosting scene
  7736. * @param noMipmap specifies if mip maps are not used
  7737. * @returns a cube texture
  7738. */
  7739. static CreateFromImages(files: string[], scene: Scene, noMipmap?: boolean): CubeTexture;
  7740. /**
  7741. * Creates and return a texture created from prefilterd data by tools like IBL Baker or Lys.
  7742. * @param url defines the url of the prefiltered texture
  7743. * @param scene defines the scene the texture is attached to
  7744. * @param forcedExtension defines the extension of the file if different from the url
  7745. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  7746. * @return the prefiltered texture
  7747. */
  7748. static CreateFromPrefilteredData(url: string, scene: Scene, forcedExtension?: any, createPolynomials?: boolean): CubeTexture;
  7749. /**
  7750. * Creates a cube texture to use with reflection for instance. It can be based upon dds or six images as well
  7751. * as prefiltered data.
  7752. * @param rootUrl defines the url of the texture or the root name of the six images
  7753. * @param scene defines the scene the texture is attached to
  7754. * @param extensions defines the suffixes add to the picture name in case six images are in use like _px.jpg...
  7755. * @param noMipmap defines if mipmaps should be created or not
  7756. * @param files defines the six files to load for the different faces in that order: px, py, pz, nx, ny, nz
  7757. * @param onLoad defines a callback triggered at the end of the file load if no errors occured
  7758. * @param onError defines a callback triggered in case of error during load
  7759. * @param format defines the internal format to use for the texture once loaded
  7760. * @param prefiltered defines whether or not the texture is created from prefiltered data
  7761. * @param forcedExtension defines the extensions to use (force a special type of file to load) in case it is different from the file name
  7762. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  7763. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  7764. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  7765. * @return the cube texture
  7766. */
  7767. 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);
  7768. /**
  7769. * Gets a boolean indicating if the cube texture contains prefiltered mips (used to simulate roughness with PBR)
  7770. */
  7771. readonly isPrefiltered: boolean;
  7772. /**
  7773. * Get the current class name of the texture useful for serialization or dynamic coding.
  7774. * @returns "CubeTexture"
  7775. */
  7776. getClassName(): string;
  7777. /**
  7778. * Update the url (and optional buffer) of this texture if url was null during construction.
  7779. * @param url the url of the texture
  7780. * @param forcedExtension defines the extension to use
  7781. * @param onLoad callback called when the texture is loaded (defaults to null)
  7782. */
  7783. updateURL(url: string, forcedExtension?: string, onLoad?: () => void): void;
  7784. /**
  7785. * Delays loading of the cube texture
  7786. * @param forcedExtension defines the extension to use
  7787. */
  7788. delayLoad(forcedExtension?: string): void;
  7789. /**
  7790. * Returns the reflection texture matrix
  7791. * @returns the reflection texture matrix
  7792. */
  7793. getReflectionTextureMatrix(): Matrix;
  7794. /**
  7795. * Sets the reflection texture matrix
  7796. * @param value Reflection texture matrix
  7797. */
  7798. setReflectionTextureMatrix(value: Matrix): void;
  7799. /**
  7800. * Parses text to create a cube texture
  7801. * @param parsedTexture define the serialized text to read from
  7802. * @param scene defines the hosting scene
  7803. * @param rootUrl defines the root url of the cube texture
  7804. * @returns a cube texture
  7805. */
  7806. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): CubeTexture;
  7807. /**
  7808. * Makes a clone, or deep copy, of the cube texture
  7809. * @returns a new cube texture
  7810. */
  7811. clone(): CubeTexture;
  7812. }
  7813. }
  7814. declare module "babylonjs/Materials/materialDefines" {
  7815. /**
  7816. * Manages the defines for the Material
  7817. */
  7818. export class MaterialDefines {
  7819. /** @hidden */
  7820. protected _keys: string[];
  7821. private _isDirty;
  7822. /** @hidden */
  7823. _renderId: number;
  7824. /** @hidden */
  7825. _areLightsDirty: boolean;
  7826. /** @hidden */
  7827. _areLightsDisposed: boolean;
  7828. /** @hidden */
  7829. _areAttributesDirty: boolean;
  7830. /** @hidden */
  7831. _areTexturesDirty: boolean;
  7832. /** @hidden */
  7833. _areFresnelDirty: boolean;
  7834. /** @hidden */
  7835. _areMiscDirty: boolean;
  7836. /** @hidden */
  7837. _areImageProcessingDirty: boolean;
  7838. /** @hidden */
  7839. _normals: boolean;
  7840. /** @hidden */
  7841. _uvs: boolean;
  7842. /** @hidden */
  7843. _needNormals: boolean;
  7844. /** @hidden */
  7845. _needUVs: boolean;
  7846. [id: string]: any;
  7847. /**
  7848. * Specifies if the material needs to be re-calculated
  7849. */
  7850. readonly isDirty: boolean;
  7851. /**
  7852. * Marks the material to indicate that it has been re-calculated
  7853. */
  7854. markAsProcessed(): void;
  7855. /**
  7856. * Marks the material to indicate that it needs to be re-calculated
  7857. */
  7858. markAsUnprocessed(): void;
  7859. /**
  7860. * Marks the material to indicate all of its defines need to be re-calculated
  7861. */
  7862. markAllAsDirty(): void;
  7863. /**
  7864. * Marks the material to indicate that image processing needs to be re-calculated
  7865. */
  7866. markAsImageProcessingDirty(): void;
  7867. /**
  7868. * Marks the material to indicate the lights need to be re-calculated
  7869. * @param disposed Defines whether the light is dirty due to dispose or not
  7870. */
  7871. markAsLightDirty(disposed?: boolean): void;
  7872. /**
  7873. * Marks the attribute state as changed
  7874. */
  7875. markAsAttributesDirty(): void;
  7876. /**
  7877. * Marks the texture state as changed
  7878. */
  7879. markAsTexturesDirty(): void;
  7880. /**
  7881. * Marks the fresnel state as changed
  7882. */
  7883. markAsFresnelDirty(): void;
  7884. /**
  7885. * Marks the misc state as changed
  7886. */
  7887. markAsMiscDirty(): void;
  7888. /**
  7889. * Rebuilds the material defines
  7890. */
  7891. rebuild(): void;
  7892. /**
  7893. * Specifies if two material defines are equal
  7894. * @param other - A material define instance to compare to
  7895. * @returns - Boolean indicating if the material defines are equal (true) or not (false)
  7896. */
  7897. isEqual(other: MaterialDefines): boolean;
  7898. /**
  7899. * Clones this instance's defines to another instance
  7900. * @param other - material defines to clone values to
  7901. */
  7902. cloneTo(other: MaterialDefines): void;
  7903. /**
  7904. * Resets the material define values
  7905. */
  7906. reset(): void;
  7907. /**
  7908. * Converts the material define values to a string
  7909. * @returns - String of material define information
  7910. */
  7911. toString(): string;
  7912. }
  7913. }
  7914. declare module "babylonjs/Materials/colorCurves" {
  7915. import { Effect } from "babylonjs/Materials/effect";
  7916. /**
  7917. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  7918. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  7919. * 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;
  7920. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  7921. */
  7922. export class ColorCurves {
  7923. private _dirty;
  7924. private _tempColor;
  7925. private _globalCurve;
  7926. private _highlightsCurve;
  7927. private _midtonesCurve;
  7928. private _shadowsCurve;
  7929. private _positiveCurve;
  7930. private _negativeCurve;
  7931. private _globalHue;
  7932. private _globalDensity;
  7933. private _globalSaturation;
  7934. private _globalExposure;
  7935. /**
  7936. * Gets the global Hue value.
  7937. * 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).
  7938. */
  7939. /**
  7940. * Sets the global Hue value.
  7941. * 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).
  7942. */
  7943. globalHue: number;
  7944. /**
  7945. * Gets the global 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. /**
  7950. * Sets the global Density value.
  7951. * 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.
  7952. * Values less than zero provide a filter of opposite hue.
  7953. */
  7954. globalDensity: number;
  7955. /**
  7956. * Gets the global Saturation value.
  7957. * This is an adjustment value in the range [-100,+100], where the default value of 0.0 makes no adjustment, positive values increase saturation and negative values decrease saturation.
  7958. */
  7959. /**
  7960. * Sets the global Saturation 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 saturation and negative values decrease saturation.
  7962. */
  7963. globalSaturation: number;
  7964. /**
  7965. * Gets the global Exposure value.
  7966. * 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.
  7967. */
  7968. /**
  7969. * Sets the global Exposure value.
  7970. * 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.
  7971. */
  7972. globalExposure: number;
  7973. private _highlightsHue;
  7974. private _highlightsDensity;
  7975. private _highlightsSaturation;
  7976. private _highlightsExposure;
  7977. /**
  7978. * Gets the highlights Hue value.
  7979. * 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).
  7980. */
  7981. /**
  7982. * Sets the highlights Hue value.
  7983. * 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).
  7984. */
  7985. highlightsHue: number;
  7986. /**
  7987. * Gets the highlights 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. /**
  7992. * Sets the highlights Density value.
  7993. * 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.
  7994. * Values less than zero provide a filter of opposite hue.
  7995. */
  7996. highlightsDensity: number;
  7997. /**
  7998. * Gets the highlights Saturation value.
  7999. * 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.
  8000. */
  8001. /**
  8002. * Sets the highlights Saturation 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 saturation and negative values decrease saturation.
  8004. */
  8005. highlightsSaturation: number;
  8006. /**
  8007. * Gets the highlights Exposure value.
  8008. * 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.
  8009. */
  8010. /**
  8011. * Sets the highlights Exposure value.
  8012. * 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.
  8013. */
  8014. highlightsExposure: number;
  8015. private _midtonesHue;
  8016. private _midtonesDensity;
  8017. private _midtonesSaturation;
  8018. private _midtonesExposure;
  8019. /**
  8020. * Gets the midtones Hue value.
  8021. * 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).
  8022. */
  8023. /**
  8024. * Sets the midtones Hue value.
  8025. * 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).
  8026. */
  8027. midtonesHue: number;
  8028. /**
  8029. * Gets the midtones Density value.
  8030. * 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.
  8031. * Values less than zero provide a filter of opposite hue.
  8032. */
  8033. /**
  8034. * Sets the midtones Density value.
  8035. * 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.
  8036. * Values less than zero provide a filter of opposite hue.
  8037. */
  8038. midtonesDensity: number;
  8039. /**
  8040. * Gets the midtones Saturation value.
  8041. * 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.
  8042. */
  8043. /**
  8044. * Sets the midtones Saturation value.
  8045. * 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.
  8046. */
  8047. midtonesSaturation: number;
  8048. /**
  8049. * Gets the midtones Exposure value.
  8050. * 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.
  8051. */
  8052. /**
  8053. * Sets the midtones Exposure value.
  8054. * 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.
  8055. */
  8056. midtonesExposure: number;
  8057. private _shadowsHue;
  8058. private _shadowsDensity;
  8059. private _shadowsSaturation;
  8060. private _shadowsExposure;
  8061. /**
  8062. * Gets the shadows Hue value.
  8063. * 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).
  8064. */
  8065. /**
  8066. * Sets the shadows Hue value.
  8067. * 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).
  8068. */
  8069. shadowsHue: number;
  8070. /**
  8071. * Gets the shadows Density value.
  8072. * 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.
  8073. * Values less than zero provide a filter of opposite hue.
  8074. */
  8075. /**
  8076. * Sets the shadows Density value.
  8077. * 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.
  8078. * Values less than zero provide a filter of opposite hue.
  8079. */
  8080. shadowsDensity: number;
  8081. /**
  8082. * Gets the shadows Saturation value.
  8083. * 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.
  8084. */
  8085. /**
  8086. * Sets the shadows Saturation value.
  8087. * 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.
  8088. */
  8089. shadowsSaturation: number;
  8090. /**
  8091. * Gets the shadows Exposure value.
  8092. * 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.
  8093. */
  8094. /**
  8095. * Sets the shadows Exposure value.
  8096. * 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.
  8097. */
  8098. shadowsExposure: number;
  8099. /**
  8100. * Returns the class name
  8101. * @returns The class name
  8102. */
  8103. getClassName(): string;
  8104. /**
  8105. * Binds the color curves to the shader.
  8106. * @param colorCurves The color curve to bind
  8107. * @param effect The effect to bind to
  8108. * @param positiveUniform The positive uniform shader parameter
  8109. * @param neutralUniform The neutral uniform shader parameter
  8110. * @param negativeUniform The negative uniform shader parameter
  8111. */
  8112. static Bind(colorCurves: ColorCurves, effect: Effect, positiveUniform?: string, neutralUniform?: string, negativeUniform?: string): void;
  8113. /**
  8114. * Prepare the list of uniforms associated with the ColorCurves effects.
  8115. * @param uniformsList The list of uniforms used in the effect
  8116. */
  8117. static PrepareUniforms(uniformsList: string[]): void;
  8118. /**
  8119. * Returns color grading data based on a hue, density, saturation and exposure value.
  8120. * @param filterHue The hue of the color filter.
  8121. * @param filterDensity The density of the color filter.
  8122. * @param saturation The saturation.
  8123. * @param exposure The exposure.
  8124. * @param result The result data container.
  8125. */
  8126. private getColorGradingDataToRef;
  8127. /**
  8128. * Takes an input slider value and returns an adjusted value that provides extra control near the centre.
  8129. * @param value The input slider value in range [-100,100].
  8130. * @returns Adjusted value.
  8131. */
  8132. private static applyColorGradingSliderNonlinear;
  8133. /**
  8134. * Returns an RGBA Color4 based on Hue, Saturation and Brightness (also referred to as value, HSV).
  8135. * @param hue The hue (H) input.
  8136. * @param saturation The saturation (S) input.
  8137. * @param brightness The brightness (B) input.
  8138. * @result An RGBA color represented as Vector4.
  8139. */
  8140. private static fromHSBToRef;
  8141. /**
  8142. * Returns a value clamped between min and max
  8143. * @param value The value to clamp
  8144. * @param min The minimum of value
  8145. * @param max The maximum of value
  8146. * @returns The clamped value.
  8147. */
  8148. private static clamp;
  8149. /**
  8150. * Clones the current color curve instance.
  8151. * @return The cloned curves
  8152. */
  8153. clone(): ColorCurves;
  8154. /**
  8155. * Serializes the current color curve instance to a json representation.
  8156. * @return a JSON representation
  8157. */
  8158. serialize(): any;
  8159. /**
  8160. * Parses the color curve from a json representation.
  8161. * @param source the JSON source to parse
  8162. * @return The parsed curves
  8163. */
  8164. static Parse(source: any): ColorCurves;
  8165. }
  8166. }
  8167. declare module "babylonjs/Materials/imageProcessingConfiguration" {
  8168. import { Observable } from "babylonjs/Misc/observable";
  8169. import { Nullable } from "babylonjs/types";
  8170. import { Color4 } from "babylonjs/Maths/math.color";
  8171. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  8172. import { Effect } from "babylonjs/Materials/effect";
  8173. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  8174. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  8175. /**
  8176. * Interface to follow in your material defines to integrate easily the
  8177. * Image proccessing functions.
  8178. * @hidden
  8179. */
  8180. export interface IImageProcessingConfigurationDefines {
  8181. IMAGEPROCESSING: boolean;
  8182. VIGNETTE: boolean;
  8183. VIGNETTEBLENDMODEMULTIPLY: boolean;
  8184. VIGNETTEBLENDMODEOPAQUE: boolean;
  8185. TONEMAPPING: boolean;
  8186. TONEMAPPING_ACES: boolean;
  8187. CONTRAST: boolean;
  8188. EXPOSURE: boolean;
  8189. COLORCURVES: boolean;
  8190. COLORGRADING: boolean;
  8191. COLORGRADING3D: boolean;
  8192. SAMPLER3DGREENDEPTH: boolean;
  8193. SAMPLER3DBGRMAP: boolean;
  8194. IMAGEPROCESSINGPOSTPROCESS: boolean;
  8195. }
  8196. /**
  8197. * @hidden
  8198. */
  8199. export class ImageProcessingConfigurationDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  8200. IMAGEPROCESSING: boolean;
  8201. VIGNETTE: boolean;
  8202. VIGNETTEBLENDMODEMULTIPLY: boolean;
  8203. VIGNETTEBLENDMODEOPAQUE: boolean;
  8204. TONEMAPPING: boolean;
  8205. TONEMAPPING_ACES: boolean;
  8206. CONTRAST: boolean;
  8207. COLORCURVES: boolean;
  8208. COLORGRADING: boolean;
  8209. COLORGRADING3D: boolean;
  8210. SAMPLER3DGREENDEPTH: boolean;
  8211. SAMPLER3DBGRMAP: boolean;
  8212. IMAGEPROCESSINGPOSTPROCESS: boolean;
  8213. EXPOSURE: boolean;
  8214. constructor();
  8215. }
  8216. /**
  8217. * This groups together the common properties used for image processing either in direct forward pass
  8218. * or through post processing effect depending on the use of the image processing pipeline in your scene
  8219. * or not.
  8220. */
  8221. export class ImageProcessingConfiguration {
  8222. /**
  8223. * Default tone mapping applied in BabylonJS.
  8224. */
  8225. static readonly TONEMAPPING_STANDARD: number;
  8226. /**
  8227. * ACES Tone mapping (used by default in unreal and unity). This can help getting closer
  8228. * to other engines rendering to increase portability.
  8229. */
  8230. static readonly TONEMAPPING_ACES: number;
  8231. /**
  8232. * Color curves setup used in the effect if colorCurvesEnabled is set to true
  8233. */
  8234. colorCurves: Nullable<ColorCurves>;
  8235. private _colorCurvesEnabled;
  8236. /**
  8237. * Gets wether the color curves effect is enabled.
  8238. */
  8239. /**
  8240. * Sets wether the color curves effect is enabled.
  8241. */
  8242. colorCurvesEnabled: boolean;
  8243. private _colorGradingTexture;
  8244. /**
  8245. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  8246. */
  8247. /**
  8248. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  8249. */
  8250. colorGradingTexture: Nullable<BaseTexture>;
  8251. private _colorGradingEnabled;
  8252. /**
  8253. * Gets wether the color grading effect is enabled.
  8254. */
  8255. /**
  8256. * Sets wether the color grading effect is enabled.
  8257. */
  8258. colorGradingEnabled: boolean;
  8259. private _colorGradingWithGreenDepth;
  8260. /**
  8261. * Gets wether the color grading effect is using a green depth for the 3d Texture.
  8262. */
  8263. /**
  8264. * Sets wether the color grading effect is using a green depth for the 3d Texture.
  8265. */
  8266. colorGradingWithGreenDepth: boolean;
  8267. private _colorGradingBGR;
  8268. /**
  8269. * Gets wether the color grading texture contains BGR values.
  8270. */
  8271. /**
  8272. * Sets wether the color grading texture contains BGR values.
  8273. */
  8274. colorGradingBGR: boolean;
  8275. /** @hidden */
  8276. _exposure: number;
  8277. /**
  8278. * Gets the Exposure used in the effect.
  8279. */
  8280. /**
  8281. * Sets the Exposure used in the effect.
  8282. */
  8283. exposure: number;
  8284. private _toneMappingEnabled;
  8285. /**
  8286. * Gets wether the tone mapping effect is enabled.
  8287. */
  8288. /**
  8289. * Sets wether the tone mapping effect is enabled.
  8290. */
  8291. toneMappingEnabled: boolean;
  8292. private _toneMappingType;
  8293. /**
  8294. * Gets the type of tone mapping effect.
  8295. */
  8296. /**
  8297. * Sets the type of tone mapping effect used in BabylonJS.
  8298. */
  8299. toneMappingType: number;
  8300. protected _contrast: number;
  8301. /**
  8302. * Gets the contrast used in the effect.
  8303. */
  8304. /**
  8305. * Sets the contrast used in the effect.
  8306. */
  8307. contrast: number;
  8308. /**
  8309. * Vignette stretch size.
  8310. */
  8311. vignetteStretch: number;
  8312. /**
  8313. * Vignette centre X Offset.
  8314. */
  8315. vignetteCentreX: number;
  8316. /**
  8317. * Vignette centre Y Offset.
  8318. */
  8319. vignetteCentreY: number;
  8320. /**
  8321. * Vignette weight or intensity of the vignette effect.
  8322. */
  8323. vignetteWeight: number;
  8324. /**
  8325. * Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  8326. * if vignetteEnabled is set to true.
  8327. */
  8328. vignetteColor: Color4;
  8329. /**
  8330. * Camera field of view used by the Vignette effect.
  8331. */
  8332. vignetteCameraFov: number;
  8333. private _vignetteBlendMode;
  8334. /**
  8335. * Gets the vignette blend mode allowing different kind of effect.
  8336. */
  8337. /**
  8338. * Sets the vignette blend mode allowing different kind of effect.
  8339. */
  8340. vignetteBlendMode: number;
  8341. private _vignetteEnabled;
  8342. /**
  8343. * Gets wether the vignette effect is enabled.
  8344. */
  8345. /**
  8346. * Sets wether the vignette effect is enabled.
  8347. */
  8348. vignetteEnabled: boolean;
  8349. private _applyByPostProcess;
  8350. /**
  8351. * Gets wether the image processing is applied through a post process or not.
  8352. */
  8353. /**
  8354. * Sets wether the image processing is applied through a post process or not.
  8355. */
  8356. applyByPostProcess: boolean;
  8357. private _isEnabled;
  8358. /**
  8359. * Gets wether the image processing is enabled or not.
  8360. */
  8361. /**
  8362. * Sets wether the image processing is enabled or not.
  8363. */
  8364. isEnabled: boolean;
  8365. /**
  8366. * An event triggered when the configuration changes and requires Shader to Update some parameters.
  8367. */
  8368. onUpdateParameters: Observable<ImageProcessingConfiguration>;
  8369. /**
  8370. * Method called each time the image processing information changes requires to recompile the effect.
  8371. */
  8372. protected _updateParameters(): void;
  8373. /**
  8374. * Gets the current class name.
  8375. * @return "ImageProcessingConfiguration"
  8376. */
  8377. getClassName(): string;
  8378. /**
  8379. * Prepare the list of uniforms associated with the Image Processing effects.
  8380. * @param uniforms The list of uniforms used in the effect
  8381. * @param defines the list of defines currently in use
  8382. */
  8383. static PrepareUniforms(uniforms: string[], defines: IImageProcessingConfigurationDefines): void;
  8384. /**
  8385. * Prepare the list of samplers associated with the Image Processing effects.
  8386. * @param samplersList The list of uniforms used in the effect
  8387. * @param defines the list of defines currently in use
  8388. */
  8389. static PrepareSamplers(samplersList: string[], defines: IImageProcessingConfigurationDefines): void;
  8390. /**
  8391. * Prepare the list of defines associated to the shader.
  8392. * @param defines the list of defines to complete
  8393. * @param forPostProcess Define if we are currently in post process mode or not
  8394. */
  8395. prepareDefines(defines: IImageProcessingConfigurationDefines, forPostProcess?: boolean): void;
  8396. /**
  8397. * Returns true if all the image processing information are ready.
  8398. * @returns True if ready, otherwise, false
  8399. */
  8400. isReady(): boolean;
  8401. /**
  8402. * Binds the image processing to the shader.
  8403. * @param effect The effect to bind to
  8404. * @param overrideAspectRatio Override the aspect ratio of the effect
  8405. */
  8406. bind(effect: Effect, overrideAspectRatio?: number): void;
  8407. /**
  8408. * Clones the current image processing instance.
  8409. * @return The cloned image processing
  8410. */
  8411. clone(): ImageProcessingConfiguration;
  8412. /**
  8413. * Serializes the current image processing instance to a json representation.
  8414. * @return a JSON representation
  8415. */
  8416. serialize(): any;
  8417. /**
  8418. * Parses the image processing from a json representation.
  8419. * @param source the JSON source to parse
  8420. * @return The parsed image processing
  8421. */
  8422. static Parse(source: any): ImageProcessingConfiguration;
  8423. private static _VIGNETTEMODE_MULTIPLY;
  8424. private static _VIGNETTEMODE_OPAQUE;
  8425. /**
  8426. * Used to apply the vignette as a mix with the pixel color.
  8427. */
  8428. static readonly VIGNETTEMODE_MULTIPLY: number;
  8429. /**
  8430. * Used to apply the vignette as a replacement of the pixel color.
  8431. */
  8432. static readonly VIGNETTEMODE_OPAQUE: number;
  8433. }
  8434. }
  8435. declare module "babylonjs/Shaders/postprocess.vertex" {
  8436. /** @hidden */
  8437. export var postprocessVertexShader: {
  8438. name: string;
  8439. shader: string;
  8440. };
  8441. }
  8442. declare module "babylonjs/Engines/Extensions/engine.renderTarget" {
  8443. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  8444. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  8445. import { DepthTextureCreationOptions } from "babylonjs/Engines/depthTextureCreationOptions";
  8446. module "babylonjs/Engines/thinEngine" {
  8447. interface ThinEngine {
  8448. /**
  8449. * Creates a new render target texture
  8450. * @param size defines the size of the texture
  8451. * @param options defines the options used to create the texture
  8452. * @returns a new render target texture stored in an InternalTexture
  8453. */
  8454. createRenderTargetTexture(size: number | {
  8455. width: number;
  8456. height: number;
  8457. }, options: boolean | RenderTargetCreationOptions): InternalTexture;
  8458. /**
  8459. * Creates a depth stencil texture.
  8460. * This is only available in WebGL 2 or with the depth texture extension available.
  8461. * @param size The size of face edge in the texture.
  8462. * @param options The options defining the texture.
  8463. * @returns The texture
  8464. */
  8465. createDepthStencilTexture(size: number | {
  8466. width: number;
  8467. height: number;
  8468. }, options: DepthTextureCreationOptions): InternalTexture;
  8469. /** @hidden */
  8470. _createDepthStencilTexture(size: number | {
  8471. width: number;
  8472. height: number;
  8473. }, options: DepthTextureCreationOptions): InternalTexture;
  8474. }
  8475. }
  8476. }
  8477. declare module "babylonjs/Maths/math.axis" {
  8478. import { Vector3 } from "babylonjs/Maths/math.vector";
  8479. /** Defines supported spaces */
  8480. export enum Space {
  8481. /** Local (object) space */
  8482. LOCAL = 0,
  8483. /** World space */
  8484. WORLD = 1,
  8485. /** Bone space */
  8486. BONE = 2
  8487. }
  8488. /** Defines the 3 main axes */
  8489. export class Axis {
  8490. /** X axis */
  8491. static X: Vector3;
  8492. /** Y axis */
  8493. static Y: Vector3;
  8494. /** Z axis */
  8495. static Z: Vector3;
  8496. }
  8497. }
  8498. declare module "babylonjs/Cameras/targetCamera" {
  8499. import { Nullable } from "babylonjs/types";
  8500. import { Camera } from "babylonjs/Cameras/camera";
  8501. import { Scene } from "babylonjs/scene";
  8502. import { Quaternion, Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  8503. /**
  8504. * A target camera takes a mesh or position as a target and continues to look at it while it moves.
  8505. * This is the base of the follow, arc rotate cameras and Free camera
  8506. * @see http://doc.babylonjs.com/features/cameras
  8507. */
  8508. export class TargetCamera extends Camera {
  8509. private static _RigCamTransformMatrix;
  8510. private static _TargetTransformMatrix;
  8511. private static _TargetFocalPoint;
  8512. /**
  8513. * Define the current direction the camera is moving to
  8514. */
  8515. cameraDirection: Vector3;
  8516. /**
  8517. * Define the current rotation the camera is rotating to
  8518. */
  8519. cameraRotation: Vector2;
  8520. /**
  8521. * When set, the up vector of the camera will be updated by the rotation of the camera
  8522. */
  8523. updateUpVectorFromRotation: boolean;
  8524. private _tmpQuaternion;
  8525. /**
  8526. * Define the current rotation of the camera
  8527. */
  8528. rotation: Vector3;
  8529. /**
  8530. * Define the current rotation of the camera as a quaternion to prevent Gimbal lock
  8531. */
  8532. rotationQuaternion: Quaternion;
  8533. /**
  8534. * Define the current speed of the camera
  8535. */
  8536. speed: number;
  8537. /**
  8538. * Add constraint to the camera to prevent it to move freely in all directions and
  8539. * around all axis.
  8540. */
  8541. noRotationConstraint: boolean;
  8542. /**
  8543. * Define the current target of the camera as an object or a position.
  8544. */
  8545. lockedTarget: any;
  8546. /** @hidden */
  8547. _currentTarget: Vector3;
  8548. /** @hidden */
  8549. _initialFocalDistance: number;
  8550. /** @hidden */
  8551. _viewMatrix: Matrix;
  8552. /** @hidden */
  8553. _camMatrix: Matrix;
  8554. /** @hidden */
  8555. _cameraTransformMatrix: Matrix;
  8556. /** @hidden */
  8557. _cameraRotationMatrix: Matrix;
  8558. /** @hidden */
  8559. _referencePoint: Vector3;
  8560. /** @hidden */
  8561. _transformedReferencePoint: Vector3;
  8562. protected _globalCurrentTarget: Vector3;
  8563. protected _globalCurrentUpVector: Vector3;
  8564. /** @hidden */
  8565. _reset: () => void;
  8566. private _defaultUp;
  8567. /**
  8568. * Instantiates a target camera that takes a mesh or position as a target and continues to look at it while it moves.
  8569. * This is the base of the follow, arc rotate cameras and Free camera
  8570. * @see http://doc.babylonjs.com/features/cameras
  8571. * @param name Defines the name of the camera in the scene
  8572. * @param position Defines the start position of the camera in the scene
  8573. * @param scene Defines the scene the camera belongs to
  8574. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  8575. */
  8576. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  8577. /**
  8578. * Gets the position in front of the camera at a given distance.
  8579. * @param distance The distance from the camera we want the position to be
  8580. * @returns the position
  8581. */
  8582. getFrontPosition(distance: number): Vector3;
  8583. /** @hidden */
  8584. _getLockedTargetPosition(): Nullable<Vector3>;
  8585. private _storedPosition;
  8586. private _storedRotation;
  8587. private _storedRotationQuaternion;
  8588. /**
  8589. * Store current camera state of the camera (fov, position, rotation, etc..)
  8590. * @returns the camera
  8591. */
  8592. storeState(): Camera;
  8593. /**
  8594. * Restored camera state. You must call storeState() first
  8595. * @returns whether it was successful or not
  8596. * @hidden
  8597. */
  8598. _restoreStateValues(): boolean;
  8599. /** @hidden */
  8600. _initCache(): void;
  8601. /** @hidden */
  8602. _updateCache(ignoreParentClass?: boolean): void;
  8603. /** @hidden */
  8604. _isSynchronizedViewMatrix(): boolean;
  8605. /** @hidden */
  8606. _computeLocalCameraSpeed(): number;
  8607. /**
  8608. * Defines the target the camera should look at.
  8609. * @param target Defines the new target as a Vector or a mesh
  8610. */
  8611. setTarget(target: Vector3): void;
  8612. /**
  8613. * Return the current target position of the camera. This value is expressed in local space.
  8614. * @returns the target position
  8615. */
  8616. getTarget(): Vector3;
  8617. /** @hidden */
  8618. _decideIfNeedsToMove(): boolean;
  8619. /** @hidden */
  8620. _updatePosition(): void;
  8621. /** @hidden */
  8622. _checkInputs(): void;
  8623. protected _updateCameraRotationMatrix(): void;
  8624. /**
  8625. * 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)
  8626. * @returns the current camera
  8627. */
  8628. private _rotateUpVectorWithCameraRotationMatrix;
  8629. private _cachedRotationZ;
  8630. private _cachedQuaternionRotationZ;
  8631. /** @hidden */
  8632. _getViewMatrix(): Matrix;
  8633. protected _computeViewMatrix(position: Vector3, target: Vector3, up: Vector3): void;
  8634. /**
  8635. * @hidden
  8636. */
  8637. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  8638. /**
  8639. * @hidden
  8640. */
  8641. _updateRigCameras(): void;
  8642. private _getRigCamPositionAndTarget;
  8643. /**
  8644. * Gets the current object class name.
  8645. * @return the class name
  8646. */
  8647. getClassName(): string;
  8648. }
  8649. }
  8650. declare module "babylonjs/Events/keyboardEvents" {
  8651. /**
  8652. * Gather the list of keyboard event types as constants.
  8653. */
  8654. export class KeyboardEventTypes {
  8655. /**
  8656. * The keydown event is fired when a key becomes active (pressed).
  8657. */
  8658. static readonly KEYDOWN: number;
  8659. /**
  8660. * The keyup event is fired when a key has been released.
  8661. */
  8662. static readonly KEYUP: number;
  8663. }
  8664. /**
  8665. * This class is used to store keyboard related info for the onKeyboardObservable event.
  8666. */
  8667. export class KeyboardInfo {
  8668. /**
  8669. * Defines the type of event (KeyboardEventTypes)
  8670. */
  8671. type: number;
  8672. /**
  8673. * Defines the related dom event
  8674. */
  8675. event: KeyboardEvent;
  8676. /**
  8677. * Instantiates a new keyboard info.
  8678. * This class is used to store keyboard related info for the onKeyboardObservable event.
  8679. * @param type Defines the type of event (KeyboardEventTypes)
  8680. * @param event Defines the related dom event
  8681. */
  8682. constructor(
  8683. /**
  8684. * Defines the type of event (KeyboardEventTypes)
  8685. */
  8686. type: number,
  8687. /**
  8688. * Defines the related dom event
  8689. */
  8690. event: KeyboardEvent);
  8691. }
  8692. /**
  8693. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  8694. * Set the skipOnKeyboardObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onKeyboardObservable
  8695. */
  8696. export class KeyboardInfoPre extends KeyboardInfo {
  8697. /**
  8698. * Defines the type of event (KeyboardEventTypes)
  8699. */
  8700. type: number;
  8701. /**
  8702. * Defines the related dom event
  8703. */
  8704. event: KeyboardEvent;
  8705. /**
  8706. * Defines whether the engine should skip the next onKeyboardObservable associated to this pre.
  8707. */
  8708. skipOnPointerObservable: boolean;
  8709. /**
  8710. * Instantiates a new keyboard pre info.
  8711. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  8712. * @param type Defines the type of event (KeyboardEventTypes)
  8713. * @param event Defines the related dom event
  8714. */
  8715. constructor(
  8716. /**
  8717. * Defines the type of event (KeyboardEventTypes)
  8718. */
  8719. type: number,
  8720. /**
  8721. * Defines the related dom event
  8722. */
  8723. event: KeyboardEvent);
  8724. }
  8725. }
  8726. declare module "babylonjs/Cameras/Inputs/freeCameraKeyboardMoveInput" {
  8727. import { Nullable } from "babylonjs/types";
  8728. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  8729. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  8730. /**
  8731. * Manage the keyboard inputs to control the movement of a free camera.
  8732. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  8733. */
  8734. export class FreeCameraKeyboardMoveInput implements ICameraInput<FreeCamera> {
  8735. /**
  8736. * Defines the camera the input is attached to.
  8737. */
  8738. camera: FreeCamera;
  8739. /**
  8740. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  8741. */
  8742. keysUp: number[];
  8743. /**
  8744. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  8745. */
  8746. keysDown: number[];
  8747. /**
  8748. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  8749. */
  8750. keysLeft: number[];
  8751. /**
  8752. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  8753. */
  8754. keysRight: number[];
  8755. private _keys;
  8756. private _onCanvasBlurObserver;
  8757. private _onKeyboardObserver;
  8758. private _engine;
  8759. private _scene;
  8760. /**
  8761. * Attach the input controls to a specific dom element to get the input from.
  8762. * @param element Defines the element the controls should be listened from
  8763. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  8764. */
  8765. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  8766. /**
  8767. * Detach the current controls from the specified dom element.
  8768. * @param element Defines the element to stop listening the inputs from
  8769. */
  8770. detachControl(element: Nullable<HTMLElement>): void;
  8771. /**
  8772. * Update the current camera state depending on the inputs that have been used this frame.
  8773. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  8774. */
  8775. checkInputs(): void;
  8776. /**
  8777. * Gets the class name of the current intput.
  8778. * @returns the class name
  8779. */
  8780. getClassName(): string;
  8781. /** @hidden */
  8782. _onLostFocus(): void;
  8783. /**
  8784. * Get the friendly name associated with the input class.
  8785. * @returns the input friendly name
  8786. */
  8787. getSimpleName(): string;
  8788. }
  8789. }
  8790. declare module "babylonjs/Lights/shadowLight" {
  8791. import { Camera } from "babylonjs/Cameras/camera";
  8792. import { Scene } from "babylonjs/scene";
  8793. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  8794. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  8795. import { Light } from "babylonjs/Lights/light";
  8796. /**
  8797. * Interface describing all the common properties and methods a shadow light needs to implement.
  8798. * This helps both the shadow generator and materials to genrate the corresponding shadow maps
  8799. * as well as binding the different shadow properties to the effects.
  8800. */
  8801. export interface IShadowLight extends Light {
  8802. /**
  8803. * The light id in the scene (used in scene.findLighById for instance)
  8804. */
  8805. id: string;
  8806. /**
  8807. * The position the shdow will be casted from.
  8808. */
  8809. position: Vector3;
  8810. /**
  8811. * In 2d mode (needCube being false), the direction used to cast the shadow.
  8812. */
  8813. direction: Vector3;
  8814. /**
  8815. * The transformed position. Position of the light in world space taking parenting in account.
  8816. */
  8817. transformedPosition: Vector3;
  8818. /**
  8819. * The transformed direction. Direction of the light in world space taking parenting in account.
  8820. */
  8821. transformedDirection: Vector3;
  8822. /**
  8823. * The friendly name of the light in the scene.
  8824. */
  8825. name: string;
  8826. /**
  8827. * Defines the shadow projection clipping minimum z value.
  8828. */
  8829. shadowMinZ: number;
  8830. /**
  8831. * Defines the shadow projection clipping maximum z value.
  8832. */
  8833. shadowMaxZ: number;
  8834. /**
  8835. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  8836. * @returns true if the information has been computed, false if it does not need to (no parenting)
  8837. */
  8838. computeTransformedInformation(): boolean;
  8839. /**
  8840. * Gets the scene the light belongs to.
  8841. * @returns The scene
  8842. */
  8843. getScene(): Scene;
  8844. /**
  8845. * Callback defining a custom Projection Matrix Builder.
  8846. * This can be used to override the default projection matrix computation.
  8847. */
  8848. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  8849. /**
  8850. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  8851. * @param matrix The materix to updated with the projection information
  8852. * @param viewMatrix The transform matrix of the light
  8853. * @param renderList The list of mesh to render in the map
  8854. * @returns The current light
  8855. */
  8856. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  8857. /**
  8858. * Gets the current depth scale used in ESM.
  8859. * @returns The scale
  8860. */
  8861. getDepthScale(): number;
  8862. /**
  8863. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  8864. * @returns true if a cube texture needs to be use
  8865. */
  8866. needCube(): boolean;
  8867. /**
  8868. * Detects if the projection matrix requires to be recomputed this frame.
  8869. * @returns true if it requires to be recomputed otherwise, false.
  8870. */
  8871. needProjectionMatrixCompute(): boolean;
  8872. /**
  8873. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  8874. */
  8875. forceProjectionMatrixCompute(): void;
  8876. /**
  8877. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  8878. * @param faceIndex The index of the face we are computed the direction to generate shadow
  8879. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  8880. */
  8881. getShadowDirection(faceIndex?: number): Vector3;
  8882. /**
  8883. * Gets the minZ used for shadow according to both the scene and the light.
  8884. * @param activeCamera The camera we are returning the min for
  8885. * @returns the depth min z
  8886. */
  8887. getDepthMinZ(activeCamera: Camera): number;
  8888. /**
  8889. * Gets the maxZ used for shadow according to both the scene and the light.
  8890. * @param activeCamera The camera we are returning the max for
  8891. * @returns the depth max z
  8892. */
  8893. getDepthMaxZ(activeCamera: Camera): number;
  8894. }
  8895. /**
  8896. * Base implementation IShadowLight
  8897. * It groups all the common behaviour in order to reduce dupplication and better follow the DRY pattern.
  8898. */
  8899. export abstract class ShadowLight extends Light implements IShadowLight {
  8900. protected abstract _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  8901. protected _position: Vector3;
  8902. protected _setPosition(value: Vector3): void;
  8903. /**
  8904. * Sets the position the shadow will be casted from. Also use as the light position for both
  8905. * point and spot lights.
  8906. */
  8907. /**
  8908. * Sets the position the shadow will be casted from. Also use as the light position for both
  8909. * point and spot lights.
  8910. */
  8911. position: Vector3;
  8912. protected _direction: Vector3;
  8913. protected _setDirection(value: Vector3): void;
  8914. /**
  8915. * In 2d mode (needCube being false), gets the direction used to cast the shadow.
  8916. * Also use as the light direction on spot and directional lights.
  8917. */
  8918. /**
  8919. * In 2d mode (needCube being false), sets the direction used to cast the shadow.
  8920. * Also use as the light direction on spot and directional lights.
  8921. */
  8922. direction: Vector3;
  8923. private _shadowMinZ;
  8924. /**
  8925. * Gets the shadow projection clipping minimum z value.
  8926. */
  8927. /**
  8928. * Sets the shadow projection clipping minimum z value.
  8929. */
  8930. shadowMinZ: number;
  8931. private _shadowMaxZ;
  8932. /**
  8933. * Sets the shadow projection clipping maximum z value.
  8934. */
  8935. /**
  8936. * Gets the shadow projection clipping maximum z value.
  8937. */
  8938. shadowMaxZ: number;
  8939. /**
  8940. * Callback defining a custom Projection Matrix Builder.
  8941. * This can be used to override the default projection matrix computation.
  8942. */
  8943. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  8944. /**
  8945. * The transformed position. Position of the light in world space taking parenting in account.
  8946. */
  8947. transformedPosition: Vector3;
  8948. /**
  8949. * The transformed direction. Direction of the light in world space taking parenting in account.
  8950. */
  8951. transformedDirection: Vector3;
  8952. private _needProjectionMatrixCompute;
  8953. /**
  8954. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  8955. * @returns true if the information has been computed, false if it does not need to (no parenting)
  8956. */
  8957. computeTransformedInformation(): boolean;
  8958. /**
  8959. * Return the depth scale used for the shadow map.
  8960. * @returns the depth scale.
  8961. */
  8962. getDepthScale(): number;
  8963. /**
  8964. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  8965. * @param faceIndex The index of the face we are computed the direction to generate shadow
  8966. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  8967. */
  8968. getShadowDirection(faceIndex?: number): Vector3;
  8969. /**
  8970. * Returns the ShadowLight absolute position in the World.
  8971. * @returns the position vector in world space
  8972. */
  8973. getAbsolutePosition(): Vector3;
  8974. /**
  8975. * Sets the ShadowLight direction toward the passed target.
  8976. * @param target The point to target in local space
  8977. * @returns the updated ShadowLight direction
  8978. */
  8979. setDirectionToTarget(target: Vector3): Vector3;
  8980. /**
  8981. * Returns the light rotation in euler definition.
  8982. * @returns the x y z rotation in local space.
  8983. */
  8984. getRotation(): Vector3;
  8985. /**
  8986. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  8987. * @returns true if a cube texture needs to be use
  8988. */
  8989. needCube(): boolean;
  8990. /**
  8991. * Detects if the projection matrix requires to be recomputed this frame.
  8992. * @returns true if it requires to be recomputed otherwise, false.
  8993. */
  8994. needProjectionMatrixCompute(): boolean;
  8995. /**
  8996. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  8997. */
  8998. forceProjectionMatrixCompute(): void;
  8999. /** @hidden */
  9000. _initCache(): void;
  9001. /** @hidden */
  9002. _isSynchronized(): boolean;
  9003. /**
  9004. * Computes the world matrix of the node
  9005. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  9006. * @returns the world matrix
  9007. */
  9008. computeWorldMatrix(force?: boolean): Matrix;
  9009. /**
  9010. * Gets the minZ used for shadow according to both the scene and the light.
  9011. * @param activeCamera The camera we are returning the min for
  9012. * @returns the depth min z
  9013. */
  9014. getDepthMinZ(activeCamera: Camera): number;
  9015. /**
  9016. * Gets the maxZ used for shadow according to both the scene and the light.
  9017. * @param activeCamera The camera we are returning the max for
  9018. * @returns the depth max z
  9019. */
  9020. getDepthMaxZ(activeCamera: Camera): number;
  9021. /**
  9022. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  9023. * @param matrix The materix to updated with the projection information
  9024. * @param viewMatrix The transform matrix of the light
  9025. * @param renderList The list of mesh to render in the map
  9026. * @returns The current light
  9027. */
  9028. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  9029. }
  9030. }
  9031. declare module "babylonjs/Materials/effectFallbacks" {
  9032. import { IEffectFallbacks } from "babylonjs/Materials/iEffectFallbacks";
  9033. import { Effect } from "babylonjs/Materials/effect";
  9034. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  9035. /**
  9036. * EffectFallbacks can be used to add fallbacks (properties to disable) to certain properties when desired to improve performance.
  9037. * (Eg. Start at high quality with reflection and fog, if fps is low, remove reflection, if still low remove fog)
  9038. */
  9039. export class EffectFallbacks implements IEffectFallbacks {
  9040. private _defines;
  9041. private _currentRank;
  9042. private _maxRank;
  9043. private _mesh;
  9044. /**
  9045. * Removes the fallback from the bound mesh.
  9046. */
  9047. unBindMesh(): void;
  9048. /**
  9049. * Adds a fallback on the specified property.
  9050. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  9051. * @param define The name of the define in the shader
  9052. */
  9053. addFallback(rank: number, define: string): void;
  9054. /**
  9055. * Sets the mesh to use CPU skinning when needing to fallback.
  9056. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  9057. * @param mesh The mesh to use the fallbacks.
  9058. */
  9059. addCPUSkinningFallback(rank: number, mesh: AbstractMesh): void;
  9060. /**
  9061. * Checks to see if more fallbacks are still availible.
  9062. */
  9063. readonly hasMoreFallbacks: boolean;
  9064. /**
  9065. * Removes the defines that should be removed when falling back.
  9066. * @param currentDefines defines the current define statements for the shader.
  9067. * @param effect defines the current effect we try to compile
  9068. * @returns The resulting defines with defines of the current rank removed.
  9069. */
  9070. reduce(currentDefines: string, effect: Effect): string;
  9071. }
  9072. }
  9073. declare module "babylonjs/Materials/materialHelper" {
  9074. import { Nullable } from "babylonjs/types";
  9075. import { Scene } from "babylonjs/scene";
  9076. import { Engine } from "babylonjs/Engines/engine";
  9077. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  9078. import { Light } from "babylonjs/Lights/light";
  9079. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  9080. import { Effect, IEffectCreationOptions } from "babylonjs/Materials/effect";
  9081. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  9082. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  9083. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  9084. /**
  9085. * "Static Class" containing the most commonly used helper while dealing with material for
  9086. * rendering purpose.
  9087. *
  9088. * It contains the basic tools to help defining defines, binding uniform for the common part of the materials.
  9089. *
  9090. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  9091. */
  9092. export class MaterialHelper {
  9093. /**
  9094. * Bind the current view position to an effect.
  9095. * @param effect The effect to be bound
  9096. * @param scene The scene the eyes position is used from
  9097. */
  9098. static BindEyePosition(effect: Effect, scene: Scene): void;
  9099. /**
  9100. * Helps preparing the defines values about the UVs in used in the effect.
  9101. * UVs are shared as much as we can accross channels in the shaders.
  9102. * @param texture The texture we are preparing the UVs for
  9103. * @param defines The defines to update
  9104. * @param key The channel key "diffuse", "specular"... used in the shader
  9105. */
  9106. static PrepareDefinesForMergedUV(texture: BaseTexture, defines: any, key: string): void;
  9107. /**
  9108. * Binds a texture matrix value to its corrsponding uniform
  9109. * @param texture The texture to bind the matrix for
  9110. * @param uniformBuffer The uniform buffer receivin the data
  9111. * @param key The channel key "diffuse", "specular"... used in the shader
  9112. */
  9113. static BindTextureMatrix(texture: BaseTexture, uniformBuffer: UniformBuffer, key: string): void;
  9114. /**
  9115. * Gets the current status of the fog (should it be enabled?)
  9116. * @param mesh defines the mesh to evaluate for fog support
  9117. * @param scene defines the hosting scene
  9118. * @returns true if fog must be enabled
  9119. */
  9120. static GetFogState(mesh: AbstractMesh, scene: Scene): boolean;
  9121. /**
  9122. * Helper used to prepare the list of defines associated with misc. values for shader compilation
  9123. * @param mesh defines the current mesh
  9124. * @param scene defines the current scene
  9125. * @param useLogarithmicDepth defines if logarithmic depth has to be turned on
  9126. * @param pointsCloud defines if point cloud rendering has to be turned on
  9127. * @param fogEnabled defines if fog has to be turned on
  9128. * @param alphaTest defines if alpha testing has to be turned on
  9129. * @param defines defines the current list of defines
  9130. */
  9131. static PrepareDefinesForMisc(mesh: AbstractMesh, scene: Scene, useLogarithmicDepth: boolean, pointsCloud: boolean, fogEnabled: boolean, alphaTest: boolean, defines: any): void;
  9132. /**
  9133. * Helper used to prepare the list of defines associated with frame values for shader compilation
  9134. * @param scene defines the current scene
  9135. * @param engine defines the current engine
  9136. * @param defines specifies the list of active defines
  9137. * @param useInstances defines if instances have to be turned on
  9138. * @param useClipPlane defines if clip plane have to be turned on
  9139. */
  9140. static PrepareDefinesForFrameBoundValues(scene: Scene, engine: Engine, defines: any, useInstances: boolean, useClipPlane?: Nullable<boolean>): void;
  9141. /**
  9142. * Prepares the defines for bones
  9143. * @param mesh The mesh containing the geometry data we will draw
  9144. * @param defines The defines to update
  9145. */
  9146. static PrepareDefinesForBones(mesh: AbstractMesh, defines: any): void;
  9147. /**
  9148. * Prepares the defines for morph targets
  9149. * @param mesh The mesh containing the geometry data we will draw
  9150. * @param defines The defines to update
  9151. */
  9152. static PrepareDefinesForMorphTargets(mesh: AbstractMesh, defines: any): void;
  9153. /**
  9154. * Prepares the defines used in the shader depending on the attributes data available in the mesh
  9155. * @param mesh The mesh containing the geometry data we will draw
  9156. * @param defines The defines to update
  9157. * @param useVertexColor Precise whether vertex colors should be used or not (override mesh info)
  9158. * @param useBones Precise whether bones should be used or not (override mesh info)
  9159. * @param useMorphTargets Precise whether morph targets should be used or not (override mesh info)
  9160. * @param useVertexAlpha Precise whether vertex alpha should be used or not (override mesh info)
  9161. * @returns false if defines are considered not dirty and have not been checked
  9162. */
  9163. static PrepareDefinesForAttributes(mesh: AbstractMesh, defines: any, useVertexColor: boolean, useBones: boolean, useMorphTargets?: boolean, useVertexAlpha?: boolean): boolean;
  9164. /**
  9165. * Prepares the defines related to multiview
  9166. * @param scene The scene we are intending to draw
  9167. * @param defines The defines to update
  9168. */
  9169. static PrepareDefinesForMultiview(scene: Scene, defines: any): void;
  9170. /**
  9171. * Prepares the defines related to the light information passed in parameter
  9172. * @param scene The scene we are intending to draw
  9173. * @param mesh The mesh the effect is compiling for
  9174. * @param light The light the effect is compiling for
  9175. * @param lightIndex The index of the light
  9176. * @param defines The defines to update
  9177. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  9178. * @param state Defines the current state regarding what is needed (normals, etc...)
  9179. */
  9180. static PrepareDefinesForLight(scene: Scene, mesh: AbstractMesh, light: Light, lightIndex: number, defines: any, specularSupported: boolean, state: {
  9181. needNormals: boolean;
  9182. needRebuild: boolean;
  9183. shadowEnabled: boolean;
  9184. specularEnabled: boolean;
  9185. lightmapMode: boolean;
  9186. }): void;
  9187. /**
  9188. * Prepares the defines related to the light information passed in parameter
  9189. * @param scene The scene we are intending to draw
  9190. * @param mesh The mesh the effect is compiling for
  9191. * @param defines The defines to update
  9192. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  9193. * @param maxSimultaneousLights Specfies how manuy lights can be added to the effect at max
  9194. * @param disableLighting Specifies whether the lighting is disabled (override scene and light)
  9195. * @returns true if normals will be required for the rest of the effect
  9196. */
  9197. static PrepareDefinesForLights(scene: Scene, mesh: AbstractMesh, defines: any, specularSupported: boolean, maxSimultaneousLights?: number, disableLighting?: boolean): boolean;
  9198. /**
  9199. * Prepares the uniforms and samplers list to be used in the effect (for a specific light)
  9200. * @param lightIndex defines the light index
  9201. * @param uniformsList The uniform list
  9202. * @param samplersList The sampler list
  9203. * @param projectedLightTexture defines if projected texture must be used
  9204. * @param uniformBuffersList defines an optional list of uniform buffers
  9205. */
  9206. static PrepareUniformsAndSamplersForLight(lightIndex: number, uniformsList: string[], samplersList: string[], projectedLightTexture?: any, uniformBuffersList?: Nullable<string[]>): void;
  9207. /**
  9208. * Prepares the uniforms and samplers list to be used in the effect
  9209. * @param uniformsListOrOptions The uniform names to prepare or an EffectCreationOptions containing the liist and extra information
  9210. * @param samplersList The sampler list
  9211. * @param defines The defines helping in the list generation
  9212. * @param maxSimultaneousLights The maximum number of simultanous light allowed in the effect
  9213. */
  9214. static PrepareUniformsAndSamplersList(uniformsListOrOptions: string[] | IEffectCreationOptions, samplersList?: string[], defines?: any, maxSimultaneousLights?: number): void;
  9215. /**
  9216. * This helps decreasing rank by rank the shadow quality (0 being the highest rank and quality)
  9217. * @param defines The defines to update while falling back
  9218. * @param fallbacks The authorized effect fallbacks
  9219. * @param maxSimultaneousLights The maximum number of lights allowed
  9220. * @param rank the current rank of the Effect
  9221. * @returns The newly affected rank
  9222. */
  9223. static HandleFallbacksForShadows(defines: any, fallbacks: EffectFallbacks, maxSimultaneousLights?: number, rank?: number): number;
  9224. private static _TmpMorphInfluencers;
  9225. /**
  9226. * Prepares the list of attributes required for morph targets according to the effect defines.
  9227. * @param attribs The current list of supported attribs
  9228. * @param mesh The mesh to prepare the morph targets attributes for
  9229. * @param influencers The number of influencers
  9230. */
  9231. static PrepareAttributesForMorphTargetsInfluencers(attribs: string[], mesh: AbstractMesh, influencers: number): void;
  9232. /**
  9233. * Prepares the list of attributes required for morph targets according to the effect defines.
  9234. * @param attribs The current list of supported attribs
  9235. * @param mesh The mesh to prepare the morph targets attributes for
  9236. * @param defines The current Defines of the effect
  9237. */
  9238. static PrepareAttributesForMorphTargets(attribs: string[], mesh: AbstractMesh, defines: any): void;
  9239. /**
  9240. * Prepares the list of attributes required for bones according to the effect defines.
  9241. * @param attribs The current list of supported attribs
  9242. * @param mesh The mesh to prepare the bones attributes for
  9243. * @param defines The current Defines of the effect
  9244. * @param fallbacks The current efffect fallback strategy
  9245. */
  9246. static PrepareAttributesForBones(attribs: string[], mesh: AbstractMesh, defines: any, fallbacks: EffectFallbacks): void;
  9247. /**
  9248. * Check and prepare the list of attributes required for instances according to the effect defines.
  9249. * @param attribs The current list of supported attribs
  9250. * @param defines The current MaterialDefines of the effect
  9251. */
  9252. static PrepareAttributesForInstances(attribs: string[], defines: MaterialDefines): void;
  9253. /**
  9254. * Add the list of attributes required for instances to the attribs array.
  9255. * @param attribs The current list of supported attribs
  9256. */
  9257. static PushAttributesForInstances(attribs: string[]): void;
  9258. /**
  9259. * Binds the light information to the effect.
  9260. * @param light The light containing the generator
  9261. * @param effect The effect we are binding the data to
  9262. * @param lightIndex The light index in the effect used to render
  9263. */
  9264. static BindLightProperties(light: Light, effect: Effect, lightIndex: number): void;
  9265. /**
  9266. * Binds the lights information from the scene to the effect for the given mesh.
  9267. * @param light Light to bind
  9268. * @param lightIndex Light index
  9269. * @param scene The scene where the light belongs to
  9270. * @param effect The effect we are binding the data to
  9271. * @param useSpecular Defines if specular is supported
  9272. * @param usePhysicalLightFalloff Specifies whether the light falloff is defined physically or not
  9273. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  9274. */
  9275. static BindLight(light: Light, lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, usePhysicalLightFalloff?: boolean, rebuildInParallel?: boolean): void;
  9276. /**
  9277. * Binds the lights information from the scene to the effect for the given mesh.
  9278. * @param scene The scene the lights belongs to
  9279. * @param mesh The mesh we are binding the information to render
  9280. * @param effect The effect we are binding the data to
  9281. * @param defines The generated defines for the effect
  9282. * @param maxSimultaneousLights The maximum number of light that can be bound to the effect
  9283. * @param usePhysicalLightFalloff Specifies whether the light falloff is defined physically or not
  9284. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  9285. */
  9286. static BindLights(scene: Scene, mesh: AbstractMesh, effect: Effect, defines: any, maxSimultaneousLights?: number, usePhysicalLightFalloff?: boolean, rebuildInParallel?: boolean): void;
  9287. private static _tempFogColor;
  9288. /**
  9289. * Binds the fog information from the scene to the effect for the given mesh.
  9290. * @param scene The scene the lights belongs to
  9291. * @param mesh The mesh we are binding the information to render
  9292. * @param effect The effect we are binding the data to
  9293. * @param linearSpace Defines if the fog effect is applied in linear space
  9294. */
  9295. static BindFogParameters(scene: Scene, mesh: AbstractMesh, effect: Effect, linearSpace?: boolean): void;
  9296. /**
  9297. * Binds the bones information from the mesh to the effect.
  9298. * @param mesh The mesh we are binding the information to render
  9299. * @param effect The effect we are binding the data to
  9300. */
  9301. static BindBonesParameters(mesh?: AbstractMesh, effect?: Effect): void;
  9302. /**
  9303. * Binds the morph targets information from the mesh to the effect.
  9304. * @param abstractMesh The mesh we are binding the information to render
  9305. * @param effect The effect we are binding the data to
  9306. */
  9307. static BindMorphTargetParameters(abstractMesh: AbstractMesh, effect: Effect): void;
  9308. /**
  9309. * Binds the logarithmic depth information from the scene to the effect for the given defines.
  9310. * @param defines The generated defines used in the effect
  9311. * @param effect The effect we are binding the data to
  9312. * @param scene The scene we are willing to render with logarithmic scale for
  9313. */
  9314. static BindLogDepth(defines: any, effect: Effect, scene: Scene): void;
  9315. /**
  9316. * Binds the clip plane information from the scene to the effect.
  9317. * @param scene The scene the clip plane information are extracted from
  9318. * @param effect The effect we are binding the data to
  9319. */
  9320. static BindClipPlane(effect: Effect, scene: Scene): void;
  9321. }
  9322. }
  9323. declare module "babylonjs/Shaders/ShadersInclude/packingFunctions" {
  9324. /** @hidden */
  9325. export var packingFunctions: {
  9326. name: string;
  9327. shader: string;
  9328. };
  9329. }
  9330. declare module "babylonjs/Shaders/shadowMap.fragment" {
  9331. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  9332. /** @hidden */
  9333. export var shadowMapPixelShader: {
  9334. name: string;
  9335. shader: string;
  9336. };
  9337. }
  9338. declare module "babylonjs/Shaders/ShadersInclude/bonesDeclaration" {
  9339. /** @hidden */
  9340. export var bonesDeclaration: {
  9341. name: string;
  9342. shader: string;
  9343. };
  9344. }
  9345. declare module "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration" {
  9346. /** @hidden */
  9347. export var morphTargetsVertexGlobalDeclaration: {
  9348. name: string;
  9349. shader: string;
  9350. };
  9351. }
  9352. declare module "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration" {
  9353. /** @hidden */
  9354. export var morphTargetsVertexDeclaration: {
  9355. name: string;
  9356. shader: string;
  9357. };
  9358. }
  9359. declare module "babylonjs/Shaders/ShadersInclude/instancesDeclaration" {
  9360. /** @hidden */
  9361. export var instancesDeclaration: {
  9362. name: string;
  9363. shader: string;
  9364. };
  9365. }
  9366. declare module "babylonjs/Shaders/ShadersInclude/helperFunctions" {
  9367. /** @hidden */
  9368. export var helperFunctions: {
  9369. name: string;
  9370. shader: string;
  9371. };
  9372. }
  9373. declare module "babylonjs/Shaders/ShadersInclude/morphTargetsVertex" {
  9374. /** @hidden */
  9375. export var morphTargetsVertex: {
  9376. name: string;
  9377. shader: string;
  9378. };
  9379. }
  9380. declare module "babylonjs/Shaders/ShadersInclude/instancesVertex" {
  9381. /** @hidden */
  9382. export var instancesVertex: {
  9383. name: string;
  9384. shader: string;
  9385. };
  9386. }
  9387. declare module "babylonjs/Shaders/ShadersInclude/bonesVertex" {
  9388. /** @hidden */
  9389. export var bonesVertex: {
  9390. name: string;
  9391. shader: string;
  9392. };
  9393. }
  9394. declare module "babylonjs/Shaders/shadowMap.vertex" {
  9395. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  9396. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  9397. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  9398. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  9399. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  9400. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  9401. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  9402. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  9403. /** @hidden */
  9404. export var shadowMapVertexShader: {
  9405. name: string;
  9406. shader: string;
  9407. };
  9408. }
  9409. declare module "babylonjs/Shaders/depthBoxBlur.fragment" {
  9410. /** @hidden */
  9411. export var depthBoxBlurPixelShader: {
  9412. name: string;
  9413. shader: string;
  9414. };
  9415. }
  9416. declare module "babylonjs/Lights/Shadows/shadowGenerator" {
  9417. import { Nullable } from "babylonjs/types";
  9418. import { Scene } from "babylonjs/scene";
  9419. import { Matrix } from "babylonjs/Maths/math.vector";
  9420. import { SubMesh } from "babylonjs/Meshes/subMesh";
  9421. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  9422. import { Mesh } from "babylonjs/Meshes/mesh";
  9423. import { IShadowLight } from "babylonjs/Lights/shadowLight";
  9424. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  9425. import { Effect } from "babylonjs/Materials/effect";
  9426. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  9427. import "babylonjs/Shaders/shadowMap.fragment";
  9428. import "babylonjs/Shaders/shadowMap.vertex";
  9429. import "babylonjs/Shaders/depthBoxBlur.fragment";
  9430. import { Observable } from "babylonjs/Misc/observable";
  9431. /**
  9432. * Defines the options associated with the creation of a custom shader for a shadow generator.
  9433. */
  9434. export interface ICustomShaderOptions {
  9435. /**
  9436. * Gets or sets the custom shader name to use
  9437. */
  9438. shaderName: string;
  9439. /**
  9440. * The list of attribute names used in the shader
  9441. */
  9442. attributes?: string[];
  9443. /**
  9444. * The list of unifrom names used in the shader
  9445. */
  9446. uniforms?: string[];
  9447. /**
  9448. * The list of sampler names used in the shader
  9449. */
  9450. samplers?: string[];
  9451. /**
  9452. * The list of defines used in the shader
  9453. */
  9454. defines?: string[];
  9455. }
  9456. /**
  9457. * Interface to implement to create a shadow generator compatible with BJS.
  9458. */
  9459. export interface IShadowGenerator {
  9460. /**
  9461. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  9462. * @returns The render target texture if present otherwise, null
  9463. */
  9464. getShadowMap(): Nullable<RenderTargetTexture>;
  9465. /**
  9466. * Gets the RTT used during rendering (can be a blurred version of the shadow map or the shadow map itself).
  9467. * @returns The render target texture if the shadow map is present otherwise, null
  9468. */
  9469. getShadowMapForRendering(): Nullable<RenderTargetTexture>;
  9470. /**
  9471. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  9472. * @param subMesh The submesh we want to render in the shadow map
  9473. * @param useInstances Defines wether will draw in the map using instances
  9474. * @returns true if ready otherwise, false
  9475. */
  9476. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  9477. /**
  9478. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  9479. * @param defines Defines of the material we want to update
  9480. * @param lightIndex Index of the light in the enabled light list of the material
  9481. */
  9482. prepareDefines(defines: MaterialDefines, lightIndex: number): void;
  9483. /**
  9484. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  9485. * defined in the generator but impacting the effect).
  9486. * It implies the unifroms available on the materials are the standard BJS ones.
  9487. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  9488. * @param effect The effect we are binfing the information for
  9489. */
  9490. bindShadowLight(lightIndex: string, effect: Effect): void;
  9491. /**
  9492. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  9493. * (eq to shadow prjection matrix * light transform matrix)
  9494. * @returns The transform matrix used to create the shadow map
  9495. */
  9496. getTransformMatrix(): Matrix;
  9497. /**
  9498. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  9499. * Cube and 2D textures for instance.
  9500. */
  9501. recreateShadowMap(): void;
  9502. /**
  9503. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  9504. * @param onCompiled Callback triggered at the and of the effects compilation
  9505. * @param options Sets of optional options forcing the compilation with different modes
  9506. */
  9507. forceCompilation(onCompiled?: (generator: ShadowGenerator) => void, options?: Partial<{
  9508. useInstances: boolean;
  9509. }>): void;
  9510. /**
  9511. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  9512. * @param options Sets of optional options forcing the compilation with different modes
  9513. * @returns A promise that resolves when the compilation completes
  9514. */
  9515. forceCompilationAsync(options?: Partial<{
  9516. useInstances: boolean;
  9517. }>): Promise<void>;
  9518. /**
  9519. * Serializes the shadow generator setup to a json object.
  9520. * @returns The serialized JSON object
  9521. */
  9522. serialize(): any;
  9523. /**
  9524. * Disposes the Shadow map and related Textures and effects.
  9525. */
  9526. dispose(): void;
  9527. }
  9528. /**
  9529. * Default implementation IShadowGenerator.
  9530. * This is the main object responsible of generating shadows in the framework.
  9531. * Documentation: https://doc.babylonjs.com/babylon101/shadows
  9532. */
  9533. export class ShadowGenerator implements IShadowGenerator {
  9534. /**
  9535. * Shadow generator mode None: no filtering applied.
  9536. */
  9537. static readonly FILTER_NONE: number;
  9538. /**
  9539. * Shadow generator mode ESM: Exponential Shadow Mapping.
  9540. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  9541. */
  9542. static readonly FILTER_EXPONENTIALSHADOWMAP: number;
  9543. /**
  9544. * Shadow generator mode Poisson Sampling: Percentage Closer Filtering.
  9545. * (Multiple Tap around evenly distributed around the pixel are used to evaluate the shadow strength)
  9546. */
  9547. static readonly FILTER_POISSONSAMPLING: number;
  9548. /**
  9549. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping.
  9550. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  9551. */
  9552. static readonly FILTER_BLUREXPONENTIALSHADOWMAP: number;
  9553. /**
  9554. * Shadow generator mode ESM: Exponential Shadow Mapping using the inverse of the exponential preventing
  9555. * edge artifacts on steep falloff.
  9556. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  9557. */
  9558. static readonly FILTER_CLOSEEXPONENTIALSHADOWMAP: number;
  9559. /**
  9560. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping using the inverse of the exponential preventing
  9561. * edge artifacts on steep falloff.
  9562. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  9563. */
  9564. static readonly FILTER_BLURCLOSEEXPONENTIALSHADOWMAP: number;
  9565. /**
  9566. * Shadow generator mode PCF: Percentage Closer Filtering
  9567. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  9568. * (https://developer.nvidia.com/gpugems/GPUGems/gpugems_ch11.html)
  9569. */
  9570. static readonly FILTER_PCF: number;
  9571. /**
  9572. * Shadow generator mode PCSS: Percentage Closering Soft Shadow.
  9573. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  9574. * Contact Hardening
  9575. */
  9576. static readonly FILTER_PCSS: number;
  9577. /**
  9578. * Reserved for PCF and PCSS
  9579. * Highest Quality.
  9580. *
  9581. * Execute PCF on a 5*5 kernel improving a lot the shadow aliasing artifacts.
  9582. *
  9583. * Execute PCSS with 32 taps blocker search and 64 taps PCF.
  9584. */
  9585. static readonly QUALITY_HIGH: number;
  9586. /**
  9587. * Reserved for PCF and PCSS
  9588. * Good tradeoff for quality/perf cross devices
  9589. *
  9590. * Execute PCF on a 3*3 kernel.
  9591. *
  9592. * Execute PCSS with 16 taps blocker search and 32 taps PCF.
  9593. */
  9594. static readonly QUALITY_MEDIUM: number;
  9595. /**
  9596. * Reserved for PCF and PCSS
  9597. * The lowest quality but the fastest.
  9598. *
  9599. * Execute PCF on a 1*1 kernel.
  9600. *
  9601. * Execute PCSS with 16 taps blocker search and 16 taps PCF.
  9602. */
  9603. static readonly QUALITY_LOW: number;
  9604. /** Gets or sets the custom shader name to use */
  9605. customShaderOptions: ICustomShaderOptions;
  9606. /**
  9607. * Observable triggered before the shadow is rendered. Can be used to update internal effect state
  9608. */
  9609. onBeforeShadowMapRenderObservable: Observable<Effect>;
  9610. /**
  9611. * Observable triggered after the shadow is rendered. Can be used to restore internal effect state
  9612. */
  9613. onAfterShadowMapRenderObservable: Observable<Effect>;
  9614. /**
  9615. * Observable triggered before a mesh is rendered in the shadow map.
  9616. * Can be used to update internal effect state (that you can get from the onBeforeShadowMapRenderObservable)
  9617. */
  9618. onBeforeShadowMapRenderMeshObservable: Observable<Mesh>;
  9619. /**
  9620. * Observable triggered after a mesh is rendered in the shadow map.
  9621. * Can be used to update internal effect state (that you can get from the onAfterShadowMapRenderObservable)
  9622. */
  9623. onAfterShadowMapRenderMeshObservable: Observable<Mesh>;
  9624. private _bias;
  9625. /**
  9626. * Gets the bias: offset applied on the depth preventing acnea (in light direction).
  9627. */
  9628. /**
  9629. * Sets the bias: offset applied on the depth preventing acnea (in light direction).
  9630. */
  9631. bias: number;
  9632. private _normalBias;
  9633. /**
  9634. * Gets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  9635. */
  9636. /**
  9637. * Sets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  9638. */
  9639. normalBias: number;
  9640. private _blurBoxOffset;
  9641. /**
  9642. * Gets the blur box offset: offset applied during the blur pass.
  9643. * Only useful if useKernelBlur = false
  9644. */
  9645. /**
  9646. * Sets the blur box offset: offset applied during the blur pass.
  9647. * Only useful if useKernelBlur = false
  9648. */
  9649. blurBoxOffset: number;
  9650. private _blurScale;
  9651. /**
  9652. * Gets the blur scale: scale of the blurred texture compared to the main shadow map.
  9653. * 2 means half of the size.
  9654. */
  9655. /**
  9656. * Sets the blur scale: scale of the blurred texture compared to the main shadow map.
  9657. * 2 means half of the size.
  9658. */
  9659. blurScale: number;
  9660. private _blurKernel;
  9661. /**
  9662. * Gets the blur kernel: kernel size of the blur pass.
  9663. * Only useful if useKernelBlur = true
  9664. */
  9665. /**
  9666. * Sets the blur kernel: kernel size of the blur pass.
  9667. * Only useful if useKernelBlur = true
  9668. */
  9669. blurKernel: number;
  9670. private _useKernelBlur;
  9671. /**
  9672. * Gets whether the blur pass is a kernel blur (if true) or box blur.
  9673. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  9674. */
  9675. /**
  9676. * Sets whether the blur pass is a kernel blur (if true) or box blur.
  9677. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  9678. */
  9679. useKernelBlur: boolean;
  9680. private _depthScale;
  9681. /**
  9682. * Gets the depth scale used in ESM mode.
  9683. */
  9684. /**
  9685. * Sets the depth scale used in ESM mode.
  9686. * This can override the scale stored on the light.
  9687. */
  9688. depthScale: number;
  9689. private _filter;
  9690. /**
  9691. * Gets the current mode of the shadow generator (normal, PCF, ESM...).
  9692. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  9693. */
  9694. /**
  9695. * Sets the current mode of the shadow generator (normal, PCF, ESM...).
  9696. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  9697. */
  9698. filter: number;
  9699. /**
  9700. * Gets if the current filter is set to Poisson Sampling.
  9701. */
  9702. /**
  9703. * Sets the current filter to Poisson Sampling.
  9704. */
  9705. usePoissonSampling: boolean;
  9706. /**
  9707. * Gets if the current filter is set to ESM.
  9708. */
  9709. /**
  9710. * Sets the current filter is to ESM.
  9711. */
  9712. useExponentialShadowMap: boolean;
  9713. /**
  9714. * Gets if the current filter is set to filtered ESM.
  9715. */
  9716. /**
  9717. * Gets if the current filter is set to filtered ESM.
  9718. */
  9719. useBlurExponentialShadowMap: boolean;
  9720. /**
  9721. * Gets if the current filter is set to "close ESM" (using the inverse of the
  9722. * exponential to prevent steep falloff artifacts).
  9723. */
  9724. /**
  9725. * Sets the current filter to "close ESM" (using the inverse of the
  9726. * exponential to prevent steep falloff artifacts).
  9727. */
  9728. useCloseExponentialShadowMap: boolean;
  9729. /**
  9730. * Gets if the current filter is set to filtered "close ESM" (using the inverse of the
  9731. * exponential to prevent steep falloff artifacts).
  9732. */
  9733. /**
  9734. * Sets the current filter to filtered "close ESM" (using the inverse of the
  9735. * exponential to prevent steep falloff artifacts).
  9736. */
  9737. useBlurCloseExponentialShadowMap: boolean;
  9738. /**
  9739. * Gets if the current filter is set to "PCF" (percentage closer filtering).
  9740. */
  9741. /**
  9742. * Sets the current filter to "PCF" (percentage closer filtering).
  9743. */
  9744. usePercentageCloserFiltering: boolean;
  9745. private _filteringQuality;
  9746. /**
  9747. * Gets the PCF or PCSS Quality.
  9748. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  9749. */
  9750. /**
  9751. * Sets the PCF or PCSS Quality.
  9752. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  9753. */
  9754. filteringQuality: number;
  9755. /**
  9756. * Gets if the current filter is set to "PCSS" (contact hardening).
  9757. */
  9758. /**
  9759. * Sets the current filter to "PCSS" (contact hardening).
  9760. */
  9761. useContactHardeningShadow: boolean;
  9762. private _contactHardeningLightSizeUVRatio;
  9763. /**
  9764. * Gets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  9765. * Using a ratio helps keeping shape stability independently of the map size.
  9766. *
  9767. * It does not account for the light projection as it was having too much
  9768. * instability during the light setup or during light position changes.
  9769. *
  9770. * Only valid if useContactHardeningShadow is true.
  9771. */
  9772. /**
  9773. * Sets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  9774. * Using a ratio helps keeping shape stability independently of the map size.
  9775. *
  9776. * It does not account for the light projection as it was having too much
  9777. * instability during the light setup or during light position changes.
  9778. *
  9779. * Only valid if useContactHardeningShadow is true.
  9780. */
  9781. contactHardeningLightSizeUVRatio: number;
  9782. private _darkness;
  9783. /** Gets or sets the actual darkness of a shadow */
  9784. darkness: number;
  9785. /**
  9786. * Returns the darkness value (float). This can only decrease the actual darkness of a shadow.
  9787. * 0 means strongest and 1 would means no shadow.
  9788. * @returns the darkness.
  9789. */
  9790. getDarkness(): number;
  9791. /**
  9792. * Sets the darkness value (float). This can only decrease the actual darkness of a shadow.
  9793. * @param darkness The darkness value 0 means strongest and 1 would means no shadow.
  9794. * @returns the shadow generator allowing fluent coding.
  9795. */
  9796. setDarkness(darkness: number): ShadowGenerator;
  9797. private _transparencyShadow;
  9798. /** Gets or sets the ability to have transparent shadow */
  9799. transparencyShadow: boolean;
  9800. /**
  9801. * Sets the ability to have transparent shadow (boolean).
  9802. * @param transparent True if transparent else False
  9803. * @returns the shadow generator allowing fluent coding
  9804. */
  9805. setTransparencyShadow(transparent: boolean): ShadowGenerator;
  9806. private _shadowMap;
  9807. private _shadowMap2;
  9808. /**
  9809. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  9810. * @returns The render target texture if present otherwise, null
  9811. */
  9812. getShadowMap(): Nullable<RenderTargetTexture>;
  9813. /**
  9814. * Gets the RTT used during rendering (can be a blurred version of the shadow map or the shadow map itself).
  9815. * @returns The render target texture if the shadow map is present otherwise, null
  9816. */
  9817. getShadowMapForRendering(): Nullable<RenderTargetTexture>;
  9818. /**
  9819. * Gets the class name of that object
  9820. * @returns "ShadowGenerator"
  9821. */
  9822. getClassName(): string;
  9823. /**
  9824. * Helper function to add a mesh and its descendants to the list of shadow casters.
  9825. * @param mesh Mesh to add
  9826. * @param includeDescendants boolean indicating if the descendants should be added. Default to true
  9827. * @returns the Shadow Generator itself
  9828. */
  9829. addShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  9830. /**
  9831. * Helper function to remove a mesh and its descendants from the list of shadow casters
  9832. * @param mesh Mesh to remove
  9833. * @param includeDescendants boolean indicating if the descendants should be removed. Default to true
  9834. * @returns the Shadow Generator itself
  9835. */
  9836. removeShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  9837. /**
  9838. * Controls the extent to which the shadows fade out at the edge of the frustum
  9839. * Used only by directionals and spots
  9840. */
  9841. frustumEdgeFalloff: number;
  9842. private _light;
  9843. /**
  9844. * Returns the associated light object.
  9845. * @returns the light generating the shadow
  9846. */
  9847. getLight(): IShadowLight;
  9848. /**
  9849. * If true the shadow map is generated by rendering the back face of the mesh instead of the front face.
  9850. * This can help with self-shadowing as the geometry making up the back of objects is slightly offset.
  9851. * It might on the other hand introduce peter panning.
  9852. */
  9853. forceBackFacesOnly: boolean;
  9854. private _scene;
  9855. private _lightDirection;
  9856. private _effect;
  9857. private _viewMatrix;
  9858. private _projectionMatrix;
  9859. private _transformMatrix;
  9860. private _cachedPosition;
  9861. private _cachedDirection;
  9862. private _cachedDefines;
  9863. private _currentRenderID;
  9864. private _boxBlurPostprocess;
  9865. private _kernelBlurXPostprocess;
  9866. private _kernelBlurYPostprocess;
  9867. private _blurPostProcesses;
  9868. private _mapSize;
  9869. private _currentFaceIndex;
  9870. private _currentFaceIndexCache;
  9871. private _textureType;
  9872. private _defaultTextureMatrix;
  9873. private _storedUniqueId;
  9874. /** @hidden */
  9875. static _SceneComponentInitialization: (scene: Scene) => void;
  9876. /**
  9877. * Creates a ShadowGenerator object.
  9878. * A ShadowGenerator is the required tool to use the shadows.
  9879. * Each light casting shadows needs to use its own ShadowGenerator.
  9880. * Documentation : https://doc.babylonjs.com/babylon101/shadows
  9881. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  9882. * @param light The light object generating the shadows.
  9883. * @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.
  9884. */
  9885. constructor(mapSize: number, light: IShadowLight, usefulFloatFirst?: boolean);
  9886. private _initializeGenerator;
  9887. private _initializeShadowMap;
  9888. private _initializeBlurRTTAndPostProcesses;
  9889. private _renderForShadowMap;
  9890. private _renderSubMeshForShadowMap;
  9891. private _applyFilterValues;
  9892. /**
  9893. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  9894. * @param onCompiled Callback triggered at the and of the effects compilation
  9895. * @param options Sets of optional options forcing the compilation with different modes
  9896. */
  9897. forceCompilation(onCompiled?: (generator: ShadowGenerator) => void, options?: Partial<{
  9898. useInstances: boolean;
  9899. }>): void;
  9900. /**
  9901. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  9902. * @param options Sets of optional options forcing the compilation with different modes
  9903. * @returns A promise that resolves when the compilation completes
  9904. */
  9905. forceCompilationAsync(options?: Partial<{
  9906. useInstances: boolean;
  9907. }>): Promise<void>;
  9908. /**
  9909. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  9910. * @param subMesh The submesh we want to render in the shadow map
  9911. * @param useInstances Defines wether will draw in the map using instances
  9912. * @returns true if ready otherwise, false
  9913. */
  9914. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  9915. /**
  9916. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  9917. * @param defines Defines of the material we want to update
  9918. * @param lightIndex Index of the light in the enabled light list of the material
  9919. */
  9920. prepareDefines(defines: any, lightIndex: number): void;
  9921. /**
  9922. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  9923. * defined in the generator but impacting the effect).
  9924. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  9925. * @param effect The effect we are binfing the information for
  9926. */
  9927. bindShadowLight(lightIndex: string, effect: Effect): void;
  9928. /**
  9929. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  9930. * (eq to shadow prjection matrix * light transform matrix)
  9931. * @returns The transform matrix used to create the shadow map
  9932. */
  9933. getTransformMatrix(): Matrix;
  9934. /**
  9935. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  9936. * Cube and 2D textures for instance.
  9937. */
  9938. recreateShadowMap(): void;
  9939. private _disposeBlurPostProcesses;
  9940. private _disposeRTTandPostProcesses;
  9941. /**
  9942. * Disposes the ShadowGenerator.
  9943. * Returns nothing.
  9944. */
  9945. dispose(): void;
  9946. /**
  9947. * Serializes the shadow generator setup to a json object.
  9948. * @returns The serialized JSON object
  9949. */
  9950. serialize(): any;
  9951. /**
  9952. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  9953. * @param parsedShadowGenerator The JSON object to parse
  9954. * @param scene The scene to create the shadow map for
  9955. * @returns The parsed shadow generator
  9956. */
  9957. static Parse(parsedShadowGenerator: any, scene: Scene): ShadowGenerator;
  9958. }
  9959. }
  9960. declare module "babylonjs/Lights/light" {
  9961. import { Nullable } from "babylonjs/types";
  9962. import { Scene } from "babylonjs/scene";
  9963. import { Vector3 } from "babylonjs/Maths/math.vector";
  9964. import { Color3 } from "babylonjs/Maths/math.color";
  9965. import { Node } from "babylonjs/node";
  9966. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  9967. import { Effect } from "babylonjs/Materials/effect";
  9968. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  9969. import { IShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  9970. /**
  9971. * Base class of all the lights in Babylon. It groups all the generic information about lights.
  9972. * Lights are used, as you would expect, to affect how meshes are seen, in terms of both illumination and colour.
  9973. * 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.
  9974. */
  9975. export abstract class Light extends Node {
  9976. /**
  9977. * Falloff Default: light is falling off following the material specification:
  9978. * standard material is using standard falloff whereas pbr material can request special falloff per materials.
  9979. */
  9980. static readonly FALLOFF_DEFAULT: number;
  9981. /**
  9982. * Falloff Physical: light is falling off following the inverse squared distance law.
  9983. */
  9984. static readonly FALLOFF_PHYSICAL: number;
  9985. /**
  9986. * Falloff gltf: light is falling off as described in the gltf moving to PBR document
  9987. * to enhance interoperability with other engines.
  9988. */
  9989. static readonly FALLOFF_GLTF: number;
  9990. /**
  9991. * Falloff Standard: light is falling off like in the standard material
  9992. * to enhance interoperability with other materials.
  9993. */
  9994. static readonly FALLOFF_STANDARD: number;
  9995. /**
  9996. * If every light affecting the material is in this lightmapMode,
  9997. * material.lightmapTexture adds or multiplies
  9998. * (depends on material.useLightmapAsShadowmap)
  9999. * after every other light calculations.
  10000. */
  10001. static readonly LIGHTMAP_DEFAULT: number;
  10002. /**
  10003. * material.lightmapTexture as only diffuse lighting from this light
  10004. * adds only specular lighting from this light
  10005. * adds dynamic shadows
  10006. */
  10007. static readonly LIGHTMAP_SPECULAR: number;
  10008. /**
  10009. * material.lightmapTexture as only lighting
  10010. * no light calculation from this light
  10011. * only adds dynamic shadows from this light
  10012. */
  10013. static readonly LIGHTMAP_SHADOWSONLY: number;
  10014. /**
  10015. * Each light type uses the default quantity according to its type:
  10016. * point/spot lights use luminous intensity
  10017. * directional lights use illuminance
  10018. */
  10019. static readonly INTENSITYMODE_AUTOMATIC: number;
  10020. /**
  10021. * lumen (lm)
  10022. */
  10023. static readonly INTENSITYMODE_LUMINOUSPOWER: number;
  10024. /**
  10025. * candela (lm/sr)
  10026. */
  10027. static readonly INTENSITYMODE_LUMINOUSINTENSITY: number;
  10028. /**
  10029. * lux (lm/m^2)
  10030. */
  10031. static readonly INTENSITYMODE_ILLUMINANCE: number;
  10032. /**
  10033. * nit (cd/m^2)
  10034. */
  10035. static readonly INTENSITYMODE_LUMINANCE: number;
  10036. /**
  10037. * Light type const id of the point light.
  10038. */
  10039. static readonly LIGHTTYPEID_POINTLIGHT: number;
  10040. /**
  10041. * Light type const id of the directional light.
  10042. */
  10043. static readonly LIGHTTYPEID_DIRECTIONALLIGHT: number;
  10044. /**
  10045. * Light type const id of the spot light.
  10046. */
  10047. static readonly LIGHTTYPEID_SPOTLIGHT: number;
  10048. /**
  10049. * Light type const id of the hemispheric light.
  10050. */
  10051. static readonly LIGHTTYPEID_HEMISPHERICLIGHT: number;
  10052. /**
  10053. * Diffuse gives the basic color to an object.
  10054. */
  10055. diffuse: Color3;
  10056. /**
  10057. * Specular produces a highlight color on an object.
  10058. * Note: This is note affecting PBR materials.
  10059. */
  10060. specular: Color3;
  10061. /**
  10062. * Defines the falloff type for this light. This lets overrriding how punctual light are
  10063. * falling off base on range or angle.
  10064. * This can be set to any values in Light.FALLOFF_x.
  10065. *
  10066. * Note: This is only useful for PBR Materials at the moment. This could be extended if required to
  10067. * other types of materials.
  10068. */
  10069. falloffType: number;
  10070. /**
  10071. * Strength of the light.
  10072. * Note: By default it is define in the framework own unit.
  10073. * Note: In PBR materials the intensityMode can be use to chose what unit the intensity is defined in.
  10074. */
  10075. intensity: number;
  10076. private _range;
  10077. protected _inverseSquaredRange: number;
  10078. /**
  10079. * Defines how far from the source the light is impacting in scene units.
  10080. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  10081. */
  10082. /**
  10083. * Defines how far from the source the light is impacting in scene units.
  10084. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  10085. */
  10086. range: number;
  10087. /**
  10088. * Cached photometric scale default to 1.0 as the automatic intensity mode defaults to 1.0 for every type
  10089. * of light.
  10090. */
  10091. private _photometricScale;
  10092. private _intensityMode;
  10093. /**
  10094. * Gets the photometric scale used to interpret the intensity.
  10095. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  10096. */
  10097. /**
  10098. * Sets the photometric scale used to interpret the intensity.
  10099. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  10100. */
  10101. intensityMode: number;
  10102. private _radius;
  10103. /**
  10104. * Gets the light radius used by PBR Materials to simulate soft area lights.
  10105. */
  10106. /**
  10107. * sets the light radius used by PBR Materials to simulate soft area lights.
  10108. */
  10109. radius: number;
  10110. private _renderPriority;
  10111. /**
  10112. * Defines the rendering priority of the lights. It can help in case of fallback or number of lights
  10113. * exceeding the number allowed of the materials.
  10114. */
  10115. renderPriority: number;
  10116. private _shadowEnabled;
  10117. /**
  10118. * Gets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  10119. * the current shadow generator.
  10120. */
  10121. /**
  10122. * Sets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  10123. * the current shadow generator.
  10124. */
  10125. shadowEnabled: boolean;
  10126. private _includedOnlyMeshes;
  10127. /**
  10128. * Gets the only meshes impacted by this light.
  10129. */
  10130. /**
  10131. * Sets the only meshes impacted by this light.
  10132. */
  10133. includedOnlyMeshes: AbstractMesh[];
  10134. private _excludedMeshes;
  10135. /**
  10136. * Gets the meshes not impacted by this light.
  10137. */
  10138. /**
  10139. * Sets the meshes not impacted by this light.
  10140. */
  10141. excludedMeshes: AbstractMesh[];
  10142. private _excludeWithLayerMask;
  10143. /**
  10144. * Gets the layer id use to find what meshes are not impacted by the light.
  10145. * Inactive if 0
  10146. */
  10147. /**
  10148. * Sets the layer id use to find what meshes are not impacted by the light.
  10149. * Inactive if 0
  10150. */
  10151. excludeWithLayerMask: number;
  10152. private _includeOnlyWithLayerMask;
  10153. /**
  10154. * Gets the layer id use to find what meshes are impacted by the light.
  10155. * Inactive if 0
  10156. */
  10157. /**
  10158. * Sets the layer id use to find what meshes are impacted by the light.
  10159. * Inactive if 0
  10160. */
  10161. includeOnlyWithLayerMask: number;
  10162. private _lightmapMode;
  10163. /**
  10164. * Gets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  10165. */
  10166. /**
  10167. * Sets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  10168. */
  10169. lightmapMode: number;
  10170. /**
  10171. * Shadow generator associted to the light.
  10172. * @hidden Internal use only.
  10173. */
  10174. _shadowGenerator: Nullable<IShadowGenerator>;
  10175. /**
  10176. * @hidden Internal use only.
  10177. */
  10178. _excludedMeshesIds: string[];
  10179. /**
  10180. * @hidden Internal use only.
  10181. */
  10182. _includedOnlyMeshesIds: string[];
  10183. /**
  10184. * The current light unifom buffer.
  10185. * @hidden Internal use only.
  10186. */
  10187. _uniformBuffer: UniformBuffer;
  10188. /** @hidden */
  10189. _renderId: number;
  10190. /**
  10191. * Creates a Light object in the scene.
  10192. * Documentation : https://doc.babylonjs.com/babylon101/lights
  10193. * @param name The firendly name of the light
  10194. * @param scene The scene the light belongs too
  10195. */
  10196. constructor(name: string, scene: Scene);
  10197. protected abstract _buildUniformLayout(): void;
  10198. /**
  10199. * Sets the passed Effect "effect" with the Light information.
  10200. * @param effect The effect to update
  10201. * @param lightIndex The index of the light in the effect to update
  10202. * @returns The light
  10203. */
  10204. abstract transferToEffect(effect: Effect, lightIndex: string): Light;
  10205. /**
  10206. * Sets the passed Effect "effect" with the Light information.
  10207. * @param effect The effect to update
  10208. * @param lightDataUniformName The uniform used to store light data (position or direction)
  10209. * @returns The light
  10210. */
  10211. abstract transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  10212. /**
  10213. * Returns the string "Light".
  10214. * @returns the class name
  10215. */
  10216. getClassName(): string;
  10217. /** @hidden */
  10218. readonly _isLight: boolean;
  10219. /**
  10220. * Converts the light information to a readable string for debug purpose.
  10221. * @param fullDetails Supports for multiple levels of logging within scene loading
  10222. * @returns the human readable light info
  10223. */
  10224. toString(fullDetails?: boolean): string;
  10225. /** @hidden */
  10226. protected _syncParentEnabledState(): void;
  10227. /**
  10228. * Set the enabled state of this node.
  10229. * @param value - the new enabled state
  10230. */
  10231. setEnabled(value: boolean): void;
  10232. /**
  10233. * Returns the Light associated shadow generator if any.
  10234. * @return the associated shadow generator.
  10235. */
  10236. getShadowGenerator(): Nullable<IShadowGenerator>;
  10237. /**
  10238. * Returns a Vector3, the absolute light position in the World.
  10239. * @returns the world space position of the light
  10240. */
  10241. getAbsolutePosition(): Vector3;
  10242. /**
  10243. * Specifies if the light will affect the passed mesh.
  10244. * @param mesh The mesh to test against the light
  10245. * @return true the mesh is affected otherwise, false.
  10246. */
  10247. canAffectMesh(mesh: AbstractMesh): boolean;
  10248. /**
  10249. * Sort function to order lights for rendering.
  10250. * @param a First Light object to compare to second.
  10251. * @param b Second Light object to compare first.
  10252. * @return -1 to reduce's a's index relative to be, 0 for no change, 1 to increase a's index relative to b.
  10253. */
  10254. static CompareLightsPriority(a: Light, b: Light): number;
  10255. /**
  10256. * Releases resources associated with this node.
  10257. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  10258. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  10259. */
  10260. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  10261. /**
  10262. * Returns the light type ID (integer).
  10263. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  10264. */
  10265. getTypeID(): number;
  10266. /**
  10267. * Returns the intensity scaled by the Photometric Scale according to the light type and intensity mode.
  10268. * @returns the scaled intensity in intensity mode unit
  10269. */
  10270. getScaledIntensity(): number;
  10271. /**
  10272. * Returns a new Light object, named "name", from the current one.
  10273. * @param name The name of the cloned light
  10274. * @returns the new created light
  10275. */
  10276. clone(name: string): Nullable<Light>;
  10277. /**
  10278. * Serializes the current light into a Serialization object.
  10279. * @returns the serialized object.
  10280. */
  10281. serialize(): any;
  10282. /**
  10283. * Creates a new typed light from the passed type (integer) : point light = 0, directional light = 1, spot light = 2, hemispheric light = 3.
  10284. * This new light is named "name" and added to the passed scene.
  10285. * @param type Type according to the types available in Light.LIGHTTYPEID_x
  10286. * @param name The friendly name of the light
  10287. * @param scene The scene the new light will belong to
  10288. * @returns the constructor function
  10289. */
  10290. static GetConstructorFromName(type: number, name: string, scene: Scene): Nullable<() => Light>;
  10291. /**
  10292. * Parses the passed "parsedLight" and returns a new instanced Light from this parsing.
  10293. * @param parsedLight The JSON representation of the light
  10294. * @param scene The scene to create the parsed light in
  10295. * @returns the created light after parsing
  10296. */
  10297. static Parse(parsedLight: any, scene: Scene): Nullable<Light>;
  10298. private _hookArrayForExcluded;
  10299. private _hookArrayForIncludedOnly;
  10300. private _resyncMeshes;
  10301. /**
  10302. * Forces the meshes to update their light related information in their rendering used effects
  10303. * @hidden Internal Use Only
  10304. */
  10305. _markMeshesAsLightDirty(): void;
  10306. /**
  10307. * Recomputes the cached photometric scale if needed.
  10308. */
  10309. private _computePhotometricScale;
  10310. /**
  10311. * Returns the Photometric Scale according to the light type and intensity mode.
  10312. */
  10313. private _getPhotometricScale;
  10314. /**
  10315. * Reorder the light in the scene according to their defined priority.
  10316. * @hidden Internal Use Only
  10317. */
  10318. _reorderLightsInScene(): void;
  10319. /**
  10320. * Prepares the list of defines specific to the light type.
  10321. * @param defines the list of defines
  10322. * @param lightIndex defines the index of the light for the effect
  10323. */
  10324. abstract prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  10325. }
  10326. }
  10327. declare module "babylonjs/Actions/action" {
  10328. import { Observable } from "babylonjs/Misc/observable";
  10329. import { Condition } from "babylonjs/Actions/condition";
  10330. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  10331. import { ActionManager } from "babylonjs/Actions/actionManager";
  10332. import { ActionEvent } from "babylonjs/Actions/actionEvent";
  10333. /**
  10334. * Interface used to define Action
  10335. */
  10336. export interface IAction {
  10337. /**
  10338. * Trigger for the action
  10339. */
  10340. trigger: number;
  10341. /** Options of the trigger */
  10342. triggerOptions: any;
  10343. /**
  10344. * Gets the trigger parameters
  10345. * @returns the trigger parameters
  10346. */
  10347. getTriggerParameter(): any;
  10348. /**
  10349. * Internal only - executes current action event
  10350. * @hidden
  10351. */
  10352. _executeCurrent(evt?: ActionEvent): void;
  10353. /**
  10354. * Serialize placeholder for child classes
  10355. * @param parent of child
  10356. * @returns the serialized object
  10357. */
  10358. serialize(parent: any): any;
  10359. /**
  10360. * Internal only
  10361. * @hidden
  10362. */
  10363. _prepare(): void;
  10364. /**
  10365. * Internal only - manager for action
  10366. * @hidden
  10367. */
  10368. _actionManager: AbstractActionManager;
  10369. /**
  10370. * Adds action to chain of actions, may be a DoNothingAction
  10371. * @param action defines the next action to execute
  10372. * @returns The action passed in
  10373. * @see https://www.babylonjs-playground.com/#1T30HR#0
  10374. */
  10375. then(action: IAction): IAction;
  10376. }
  10377. /**
  10378. * The action to be carried out following a trigger
  10379. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#available-actions
  10380. */
  10381. export class Action implements IAction {
  10382. /** the trigger, with or without parameters, for the action */
  10383. triggerOptions: any;
  10384. /**
  10385. * Trigger for the action
  10386. */
  10387. trigger: number;
  10388. /**
  10389. * Internal only - manager for action
  10390. * @hidden
  10391. */
  10392. _actionManager: ActionManager;
  10393. private _nextActiveAction;
  10394. private _child;
  10395. private _condition?;
  10396. private _triggerParameter;
  10397. /**
  10398. * An event triggered prior to action being executed.
  10399. */
  10400. onBeforeExecuteObservable: Observable<Action>;
  10401. /**
  10402. * Creates a new Action
  10403. * @param triggerOptions the trigger, with or without parameters, for the action
  10404. * @param condition an optional determinant of action
  10405. */
  10406. constructor(
  10407. /** the trigger, with or without parameters, for the action */
  10408. triggerOptions: any, condition?: Condition);
  10409. /**
  10410. * Internal only
  10411. * @hidden
  10412. */
  10413. _prepare(): void;
  10414. /**
  10415. * Gets the trigger parameters
  10416. * @returns the trigger parameters
  10417. */
  10418. getTriggerParameter(): any;
  10419. /**
  10420. * Internal only - executes current action event
  10421. * @hidden
  10422. */
  10423. _executeCurrent(evt?: ActionEvent): void;
  10424. /**
  10425. * Execute placeholder for child classes
  10426. * @param evt optional action event
  10427. */
  10428. execute(evt?: ActionEvent): void;
  10429. /**
  10430. * Skips to next active action
  10431. */
  10432. skipToNextActiveAction(): void;
  10433. /**
  10434. * Adds action to chain of actions, may be a DoNothingAction
  10435. * @param action defines the next action to execute
  10436. * @returns The action passed in
  10437. * @see https://www.babylonjs-playground.com/#1T30HR#0
  10438. */
  10439. then(action: Action): Action;
  10440. /**
  10441. * Internal only
  10442. * @hidden
  10443. */
  10444. _getProperty(propertyPath: string): string;
  10445. /**
  10446. * Internal only
  10447. * @hidden
  10448. */
  10449. _getEffectiveTarget(target: any, propertyPath: string): any;
  10450. /**
  10451. * Serialize placeholder for child classes
  10452. * @param parent of child
  10453. * @returns the serialized object
  10454. */
  10455. serialize(parent: any): any;
  10456. /**
  10457. * Internal only called by serialize
  10458. * @hidden
  10459. */
  10460. protected _serialize(serializedAction: any, parent?: any): any;
  10461. /**
  10462. * Internal only
  10463. * @hidden
  10464. */
  10465. static _SerializeValueAsString: (value: any) => string;
  10466. /**
  10467. * Internal only
  10468. * @hidden
  10469. */
  10470. static _GetTargetProperty: (target: import("babylonjs/node").Node | import("babylonjs/scene").Scene) => {
  10471. name: string;
  10472. targetType: string;
  10473. value: string;
  10474. };
  10475. }
  10476. }
  10477. declare module "babylonjs/Actions/condition" {
  10478. import { ActionManager } from "babylonjs/Actions/actionManager";
  10479. /**
  10480. * A Condition applied to an Action
  10481. */
  10482. export class Condition {
  10483. /**
  10484. * Internal only - manager for action
  10485. * @hidden
  10486. */
  10487. _actionManager: ActionManager;
  10488. /**
  10489. * Internal only
  10490. * @hidden
  10491. */
  10492. _evaluationId: number;
  10493. /**
  10494. * Internal only
  10495. * @hidden
  10496. */
  10497. _currentResult: boolean;
  10498. /**
  10499. * Creates a new Condition
  10500. * @param actionManager the manager of the action the condition is applied to
  10501. */
  10502. constructor(actionManager: ActionManager);
  10503. /**
  10504. * Check if the current condition is valid
  10505. * @returns a boolean
  10506. */
  10507. isValid(): boolean;
  10508. /**
  10509. * Internal only
  10510. * @hidden
  10511. */
  10512. _getProperty(propertyPath: string): string;
  10513. /**
  10514. * Internal only
  10515. * @hidden
  10516. */
  10517. _getEffectiveTarget(target: any, propertyPath: string): any;
  10518. /**
  10519. * Serialize placeholder for child classes
  10520. * @returns the serialized object
  10521. */
  10522. serialize(): any;
  10523. /**
  10524. * Internal only
  10525. * @hidden
  10526. */
  10527. protected _serialize(serializedCondition: any): any;
  10528. }
  10529. /**
  10530. * Defines specific conditional operators as extensions of Condition
  10531. */
  10532. export class ValueCondition extends Condition {
  10533. /** path to specify the property of the target the conditional operator uses */
  10534. propertyPath: string;
  10535. /** the value compared by the conditional operator against the current value of the property */
  10536. value: any;
  10537. /** the conditional operator, default ValueCondition.IsEqual */
  10538. operator: number;
  10539. /**
  10540. * Internal only
  10541. * @hidden
  10542. */
  10543. private static _IsEqual;
  10544. /**
  10545. * Internal only
  10546. * @hidden
  10547. */
  10548. private static _IsDifferent;
  10549. /**
  10550. * Internal only
  10551. * @hidden
  10552. */
  10553. private static _IsGreater;
  10554. /**
  10555. * Internal only
  10556. * @hidden
  10557. */
  10558. private static _IsLesser;
  10559. /**
  10560. * returns the number for IsEqual
  10561. */
  10562. static readonly IsEqual: number;
  10563. /**
  10564. * Returns the number for IsDifferent
  10565. */
  10566. static readonly IsDifferent: number;
  10567. /**
  10568. * Returns the number for IsGreater
  10569. */
  10570. static readonly IsGreater: number;
  10571. /**
  10572. * Returns the number for IsLesser
  10573. */
  10574. static readonly IsLesser: number;
  10575. /**
  10576. * Internal only The action manager for the condition
  10577. * @hidden
  10578. */
  10579. _actionManager: ActionManager;
  10580. /**
  10581. * Internal only
  10582. * @hidden
  10583. */
  10584. private _target;
  10585. /**
  10586. * Internal only
  10587. * @hidden
  10588. */
  10589. private _effectiveTarget;
  10590. /**
  10591. * Internal only
  10592. * @hidden
  10593. */
  10594. private _property;
  10595. /**
  10596. * Creates a new ValueCondition
  10597. * @param actionManager manager for the action the condition applies to
  10598. * @param target for the action
  10599. * @param propertyPath path to specify the property of the target the conditional operator uses
  10600. * @param value the value compared by the conditional operator against the current value of the property
  10601. * @param operator the conditional operator, default ValueCondition.IsEqual
  10602. */
  10603. constructor(actionManager: ActionManager, target: any,
  10604. /** path to specify the property of the target the conditional operator uses */
  10605. propertyPath: string,
  10606. /** the value compared by the conditional operator against the current value of the property */
  10607. value: any,
  10608. /** the conditional operator, default ValueCondition.IsEqual */
  10609. operator?: number);
  10610. /**
  10611. * Compares the given value with the property value for the specified conditional operator
  10612. * @returns the result of the comparison
  10613. */
  10614. isValid(): boolean;
  10615. /**
  10616. * Serialize the ValueCondition into a JSON compatible object
  10617. * @returns serialization object
  10618. */
  10619. serialize(): any;
  10620. /**
  10621. * Gets the name of the conditional operator for the ValueCondition
  10622. * @param operator the conditional operator
  10623. * @returns the name
  10624. */
  10625. static GetOperatorName(operator: number): string;
  10626. }
  10627. /**
  10628. * Defines a predicate condition as an extension of Condition
  10629. */
  10630. export class PredicateCondition extends Condition {
  10631. /** defines the predicate function used to validate the condition */
  10632. predicate: () => boolean;
  10633. /**
  10634. * Internal only - manager for action
  10635. * @hidden
  10636. */
  10637. _actionManager: ActionManager;
  10638. /**
  10639. * Creates a new PredicateCondition
  10640. * @param actionManager manager for the action the condition applies to
  10641. * @param predicate defines the predicate function used to validate the condition
  10642. */
  10643. constructor(actionManager: ActionManager,
  10644. /** defines the predicate function used to validate the condition */
  10645. predicate: () => boolean);
  10646. /**
  10647. * @returns the validity of the predicate condition
  10648. */
  10649. isValid(): boolean;
  10650. }
  10651. /**
  10652. * Defines a state condition as an extension of Condition
  10653. */
  10654. export class StateCondition extends Condition {
  10655. /** Value to compare with target state */
  10656. value: string;
  10657. /**
  10658. * Internal only - manager for action
  10659. * @hidden
  10660. */
  10661. _actionManager: ActionManager;
  10662. /**
  10663. * Internal only
  10664. * @hidden
  10665. */
  10666. private _target;
  10667. /**
  10668. * Creates a new StateCondition
  10669. * @param actionManager manager for the action the condition applies to
  10670. * @param target of the condition
  10671. * @param value to compare with target state
  10672. */
  10673. constructor(actionManager: ActionManager, target: any,
  10674. /** Value to compare with target state */
  10675. value: string);
  10676. /**
  10677. * Gets a boolean indicating if the current condition is met
  10678. * @returns the validity of the state
  10679. */
  10680. isValid(): boolean;
  10681. /**
  10682. * Serialize the StateCondition into a JSON compatible object
  10683. * @returns serialization object
  10684. */
  10685. serialize(): any;
  10686. }
  10687. }
  10688. declare module "babylonjs/Actions/directActions" {
  10689. import { Action } from "babylonjs/Actions/action";
  10690. import { Condition } from "babylonjs/Actions/condition";
  10691. import { ActionEvent } from "babylonjs/Actions/actionEvent";
  10692. /**
  10693. * This defines an action responsible to toggle a boolean once triggered.
  10694. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10695. */
  10696. export class SwitchBooleanAction extends Action {
  10697. /**
  10698. * The path to the boolean property in the target object
  10699. */
  10700. propertyPath: string;
  10701. private _target;
  10702. private _effectiveTarget;
  10703. private _property;
  10704. /**
  10705. * Instantiate the action
  10706. * @param triggerOptions defines the trigger options
  10707. * @param target defines the object containing the boolean
  10708. * @param propertyPath defines the path to the boolean property in the target object
  10709. * @param condition defines the trigger related conditions
  10710. */
  10711. constructor(triggerOptions: any, target: any, propertyPath: string, condition?: Condition);
  10712. /** @hidden */
  10713. _prepare(): void;
  10714. /**
  10715. * Execute the action toggle the boolean value.
  10716. */
  10717. execute(): void;
  10718. /**
  10719. * Serializes the actions and its related information.
  10720. * @param parent defines the object to serialize in
  10721. * @returns the serialized object
  10722. */
  10723. serialize(parent: any): any;
  10724. }
  10725. /**
  10726. * This defines an action responsible to set a the state field of the target
  10727. * to a desired value once triggered.
  10728. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10729. */
  10730. export class SetStateAction extends Action {
  10731. /**
  10732. * The value to store in the state field.
  10733. */
  10734. value: string;
  10735. private _target;
  10736. /**
  10737. * Instantiate the action
  10738. * @param triggerOptions defines the trigger options
  10739. * @param target defines the object containing the state property
  10740. * @param value defines the value to store in the state field
  10741. * @param condition defines the trigger related conditions
  10742. */
  10743. constructor(triggerOptions: any, target: any, value: string, condition?: Condition);
  10744. /**
  10745. * Execute the action and store the value on the target state property.
  10746. */
  10747. execute(): void;
  10748. /**
  10749. * Serializes the actions and its related information.
  10750. * @param parent defines the object to serialize in
  10751. * @returns the serialized object
  10752. */
  10753. serialize(parent: any): any;
  10754. }
  10755. /**
  10756. * This defines an action responsible to set a property of the target
  10757. * to a desired value once triggered.
  10758. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10759. */
  10760. export class SetValueAction extends Action {
  10761. /**
  10762. * The path of the property to set in the target.
  10763. */
  10764. propertyPath: string;
  10765. /**
  10766. * The value to set in the property
  10767. */
  10768. value: any;
  10769. private _target;
  10770. private _effectiveTarget;
  10771. private _property;
  10772. /**
  10773. * Instantiate the action
  10774. * @param triggerOptions defines the trigger options
  10775. * @param target defines the object containing the property
  10776. * @param propertyPath defines the path of the property to set in the target
  10777. * @param value defines the value to set in the property
  10778. * @param condition defines the trigger related conditions
  10779. */
  10780. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  10781. /** @hidden */
  10782. _prepare(): void;
  10783. /**
  10784. * Execute the action and set the targetted property to the desired value.
  10785. */
  10786. execute(): void;
  10787. /**
  10788. * Serializes the actions and its related information.
  10789. * @param parent defines the object to serialize in
  10790. * @returns the serialized object
  10791. */
  10792. serialize(parent: any): any;
  10793. }
  10794. /**
  10795. * This defines an action responsible to increment the target value
  10796. * to a desired value once triggered.
  10797. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10798. */
  10799. export class IncrementValueAction extends Action {
  10800. /**
  10801. * The path of the property to increment in the target.
  10802. */
  10803. propertyPath: string;
  10804. /**
  10805. * The value we should increment the property by.
  10806. */
  10807. value: any;
  10808. private _target;
  10809. private _effectiveTarget;
  10810. private _property;
  10811. /**
  10812. * Instantiate the action
  10813. * @param triggerOptions defines the trigger options
  10814. * @param target defines the object containing the property
  10815. * @param propertyPath defines the path of the property to increment in the target
  10816. * @param value defines the value value we should increment the property by
  10817. * @param condition defines the trigger related conditions
  10818. */
  10819. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  10820. /** @hidden */
  10821. _prepare(): void;
  10822. /**
  10823. * Execute the action and increment the target of the value amount.
  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 start an animation once triggered.
  10835. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10836. */
  10837. export class PlayAnimationAction extends Action {
  10838. /**
  10839. * Where the animation should start (animation frame)
  10840. */
  10841. from: number;
  10842. /**
  10843. * Where the animation should stop (animation frame)
  10844. */
  10845. to: number;
  10846. /**
  10847. * Define if the animation should loop or stop after the first play.
  10848. */
  10849. loop?: boolean;
  10850. private _target;
  10851. /**
  10852. * Instantiate the action
  10853. * @param triggerOptions defines the trigger options
  10854. * @param target defines the target animation or animation name
  10855. * @param from defines from where the animation should start (animation frame)
  10856. * @param end defines where the animation should stop (animation frame)
  10857. * @param loop defines if the animation should loop or stop after the first play
  10858. * @param condition defines the trigger related conditions
  10859. */
  10860. constructor(triggerOptions: any, target: any, from: number, to: number, loop?: boolean, condition?: Condition);
  10861. /** @hidden */
  10862. _prepare(): void;
  10863. /**
  10864. * Execute the action and play the animation.
  10865. */
  10866. execute(): void;
  10867. /**
  10868. * Serializes the actions and its related information.
  10869. * @param parent defines the object to serialize in
  10870. * @returns the serialized object
  10871. */
  10872. serialize(parent: any): any;
  10873. }
  10874. /**
  10875. * This defines an action responsible to stop an animation once triggered.
  10876. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10877. */
  10878. export class StopAnimationAction extends Action {
  10879. private _target;
  10880. /**
  10881. * Instantiate the action
  10882. * @param triggerOptions defines the trigger options
  10883. * @param target defines the target animation or animation name
  10884. * @param condition defines the trigger related conditions
  10885. */
  10886. constructor(triggerOptions: any, target: any, condition?: Condition);
  10887. /** @hidden */
  10888. _prepare(): void;
  10889. /**
  10890. * Execute the action and stop the animation.
  10891. */
  10892. execute(): void;
  10893. /**
  10894. * Serializes the actions and its related information.
  10895. * @param parent defines the object to serialize in
  10896. * @returns the serialized object
  10897. */
  10898. serialize(parent: any): any;
  10899. }
  10900. /**
  10901. * This defines an action responsible that does nothing once triggered.
  10902. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10903. */
  10904. export class DoNothingAction extends Action {
  10905. /**
  10906. * Instantiate the action
  10907. * @param triggerOptions defines the trigger options
  10908. * @param condition defines the trigger related conditions
  10909. */
  10910. constructor(triggerOptions?: any, condition?: Condition);
  10911. /**
  10912. * Execute the action and do nothing.
  10913. */
  10914. execute(): void;
  10915. /**
  10916. * Serializes the actions and its related information.
  10917. * @param parent defines the object to serialize in
  10918. * @returns the serialized object
  10919. */
  10920. serialize(parent: any): any;
  10921. }
  10922. /**
  10923. * This defines an action responsible to trigger several actions once triggered.
  10924. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10925. */
  10926. export class CombineAction extends Action {
  10927. /**
  10928. * The list of aggregated animations to run.
  10929. */
  10930. children: Action[];
  10931. /**
  10932. * Instantiate the action
  10933. * @param triggerOptions defines the trigger options
  10934. * @param children defines the list of aggregated animations to run
  10935. * @param condition defines the trigger related conditions
  10936. */
  10937. constructor(triggerOptions: any, children: Action[], condition?: Condition);
  10938. /** @hidden */
  10939. _prepare(): void;
  10940. /**
  10941. * Execute the action and executes all the aggregated actions.
  10942. */
  10943. execute(evt: ActionEvent): void;
  10944. /**
  10945. * Serializes the actions and its related information.
  10946. * @param parent defines the object to serialize in
  10947. * @returns the serialized object
  10948. */
  10949. serialize(parent: any): any;
  10950. }
  10951. /**
  10952. * This defines an action responsible to run code (external event) once triggered.
  10953. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10954. */
  10955. export class ExecuteCodeAction extends Action {
  10956. /**
  10957. * The callback function to run.
  10958. */
  10959. func: (evt: ActionEvent) => void;
  10960. /**
  10961. * Instantiate the action
  10962. * @param triggerOptions defines the trigger options
  10963. * @param func defines the callback function to run
  10964. * @param condition defines the trigger related conditions
  10965. */
  10966. constructor(triggerOptions: any, func: (evt: ActionEvent) => void, condition?: Condition);
  10967. /**
  10968. * Execute the action and run the attached code.
  10969. */
  10970. execute(evt: ActionEvent): void;
  10971. }
  10972. /**
  10973. * This defines an action responsible to set the parent property of the target once triggered.
  10974. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  10975. */
  10976. export class SetParentAction extends Action {
  10977. private _parent;
  10978. private _target;
  10979. /**
  10980. * Instantiate the action
  10981. * @param triggerOptions defines the trigger options
  10982. * @param target defines the target containing the parent property
  10983. * @param parent defines from where the animation should start (animation frame)
  10984. * @param condition defines the trigger related conditions
  10985. */
  10986. constructor(triggerOptions: any, target: any, parent: any, condition?: Condition);
  10987. /** @hidden */
  10988. _prepare(): void;
  10989. /**
  10990. * Execute the action and set the parent property.
  10991. */
  10992. execute(): void;
  10993. /**
  10994. * Serializes the actions and its related information.
  10995. * @param parent defines the object to serialize in
  10996. * @returns the serialized object
  10997. */
  10998. serialize(parent: any): any;
  10999. }
  11000. }
  11001. declare module "babylonjs/Actions/actionManager" {
  11002. import { Nullable } from "babylonjs/types";
  11003. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  11004. import { Scene } from "babylonjs/scene";
  11005. import { IAction } from "babylonjs/Actions/action";
  11006. import { IActionEvent } from "babylonjs/Actions/actionEvent";
  11007. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  11008. /**
  11009. * Action Manager manages all events to be triggered on a given mesh or the global scene.
  11010. * A single scene can have many Action Managers to handle predefined actions on specific meshes.
  11011. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  11012. */
  11013. export class ActionManager extends AbstractActionManager {
  11014. /**
  11015. * Nothing
  11016. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  11017. */
  11018. static readonly NothingTrigger: number;
  11019. /**
  11020. * On pick
  11021. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  11022. */
  11023. static readonly OnPickTrigger: number;
  11024. /**
  11025. * On left pick
  11026. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  11027. */
  11028. static readonly OnLeftPickTrigger: number;
  11029. /**
  11030. * On right pick
  11031. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  11032. */
  11033. static readonly OnRightPickTrigger: number;
  11034. /**
  11035. * On center pick
  11036. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  11037. */
  11038. static readonly OnCenterPickTrigger: number;
  11039. /**
  11040. * On pick down
  11041. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  11042. */
  11043. static readonly OnPickDownTrigger: number;
  11044. /**
  11045. * On double pick
  11046. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  11047. */
  11048. static readonly OnDoublePickTrigger: number;
  11049. /**
  11050. * On pick up
  11051. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  11052. */
  11053. static readonly OnPickUpTrigger: number;
  11054. /**
  11055. * On pick out.
  11056. * This trigger will only be raised if you also declared a OnPickDown
  11057. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  11058. */
  11059. static readonly OnPickOutTrigger: number;
  11060. /**
  11061. * On long press
  11062. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  11063. */
  11064. static readonly OnLongPressTrigger: number;
  11065. /**
  11066. * On pointer over
  11067. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  11068. */
  11069. static readonly OnPointerOverTrigger: number;
  11070. /**
  11071. * On pointer out
  11072. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  11073. */
  11074. static readonly OnPointerOutTrigger: number;
  11075. /**
  11076. * On every frame
  11077. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  11078. */
  11079. static readonly OnEveryFrameTrigger: number;
  11080. /**
  11081. * On intersection enter
  11082. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  11083. */
  11084. static readonly OnIntersectionEnterTrigger: number;
  11085. /**
  11086. * On intersection exit
  11087. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  11088. */
  11089. static readonly OnIntersectionExitTrigger: number;
  11090. /**
  11091. * On key down
  11092. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  11093. */
  11094. static readonly OnKeyDownTrigger: number;
  11095. /**
  11096. * On key up
  11097. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  11098. */
  11099. static readonly OnKeyUpTrigger: number;
  11100. private _scene;
  11101. /**
  11102. * Creates a new action manager
  11103. * @param scene defines the hosting scene
  11104. */
  11105. constructor(scene: Scene);
  11106. /**
  11107. * Releases all associated resources
  11108. */
  11109. dispose(): void;
  11110. /**
  11111. * Gets hosting scene
  11112. * @returns the hosting scene
  11113. */
  11114. getScene(): Scene;
  11115. /**
  11116. * Does this action manager handles actions of any of the given triggers
  11117. * @param triggers defines the triggers to be tested
  11118. * @return a boolean indicating whether one (or more) of the triggers is handled
  11119. */
  11120. hasSpecificTriggers(triggers: number[]): boolean;
  11121. /**
  11122. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  11123. * speed.
  11124. * @param triggerA defines the trigger to be tested
  11125. * @param triggerB defines the trigger to be tested
  11126. * @return a boolean indicating whether one (or more) of the triggers is handled
  11127. */
  11128. hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  11129. /**
  11130. * Does this action manager handles actions of a given trigger
  11131. * @param trigger defines the trigger to be tested
  11132. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  11133. * @return whether the trigger is handled
  11134. */
  11135. hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  11136. /**
  11137. * Does this action manager has pointer triggers
  11138. */
  11139. readonly hasPointerTriggers: boolean;
  11140. /**
  11141. * Does this action manager has pick triggers
  11142. */
  11143. readonly hasPickTriggers: boolean;
  11144. /**
  11145. * Registers an action to this action manager
  11146. * @param action defines the action to be registered
  11147. * @return the action amended (prepared) after registration
  11148. */
  11149. registerAction(action: IAction): Nullable<IAction>;
  11150. /**
  11151. * Unregisters an action to this action manager
  11152. * @param action defines the action to be unregistered
  11153. * @return a boolean indicating whether the action has been unregistered
  11154. */
  11155. unregisterAction(action: IAction): Boolean;
  11156. /**
  11157. * Process a specific trigger
  11158. * @param trigger defines the trigger to process
  11159. * @param evt defines the event details to be processed
  11160. */
  11161. processTrigger(trigger: number, evt?: IActionEvent): void;
  11162. /** @hidden */
  11163. _getEffectiveTarget(target: any, propertyPath: string): any;
  11164. /** @hidden */
  11165. _getProperty(propertyPath: string): string;
  11166. /**
  11167. * Serialize this manager to a JSON object
  11168. * @param name defines the property name to store this manager
  11169. * @returns a JSON representation of this manager
  11170. */
  11171. serialize(name: string): any;
  11172. /**
  11173. * Creates a new ActionManager from a JSON data
  11174. * @param parsedActions defines the JSON data to read from
  11175. * @param object defines the hosting mesh
  11176. * @param scene defines the hosting scene
  11177. */
  11178. static Parse(parsedActions: any, object: Nullable<AbstractMesh>, scene: Scene): void;
  11179. /**
  11180. * Get a trigger name by index
  11181. * @param trigger defines the trigger index
  11182. * @returns a trigger name
  11183. */
  11184. static GetTriggerName(trigger: number): string;
  11185. }
  11186. }
  11187. declare module "babylonjs/Culling/ray" {
  11188. import { DeepImmutable, Nullable, float } from "babylonjs/types";
  11189. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  11190. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  11191. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  11192. import { IntersectionInfo } from "babylonjs/Collisions/intersectionInfo";
  11193. import { BoundingBox } from "babylonjs/Culling/boundingBox";
  11194. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  11195. import { Plane } from "babylonjs/Maths/math.plane";
  11196. /**
  11197. * Class representing a ray with position and direction
  11198. */
  11199. export class Ray {
  11200. /** origin point */
  11201. origin: Vector3;
  11202. /** direction */
  11203. direction: Vector3;
  11204. /** length of the ray */
  11205. length: number;
  11206. private static readonly TmpVector3;
  11207. private _tmpRay;
  11208. /**
  11209. * Creates a new ray
  11210. * @param origin origin point
  11211. * @param direction direction
  11212. * @param length length of the ray
  11213. */
  11214. constructor(
  11215. /** origin point */
  11216. origin: Vector3,
  11217. /** direction */
  11218. direction: Vector3,
  11219. /** length of the ray */
  11220. length?: number);
  11221. /**
  11222. * Checks if the ray intersects a box
  11223. * @param minimum bound of the box
  11224. * @param maximum bound of the box
  11225. * @param intersectionTreshold extra extend to be added to the box in all direction
  11226. * @returns if the box was hit
  11227. */
  11228. intersectsBoxMinMax(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, intersectionTreshold?: number): boolean;
  11229. /**
  11230. * Checks if the ray intersects a box
  11231. * @param box the bounding box to check
  11232. * @param intersectionTreshold extra extend to be added to the BoundingBox in all direction
  11233. * @returns if the box was hit
  11234. */
  11235. intersectsBox(box: DeepImmutable<BoundingBox>, intersectionTreshold?: number): boolean;
  11236. /**
  11237. * If the ray hits a sphere
  11238. * @param sphere the bounding sphere to check
  11239. * @param intersectionTreshold extra extend to be added to the BoundingSphere in all direction
  11240. * @returns true if it hits the sphere
  11241. */
  11242. intersectsSphere(sphere: DeepImmutable<BoundingSphere>, intersectionTreshold?: number): boolean;
  11243. /**
  11244. * If the ray hits a triange
  11245. * @param vertex0 triangle vertex
  11246. * @param vertex1 triangle vertex
  11247. * @param vertex2 triangle vertex
  11248. * @returns intersection information if hit
  11249. */
  11250. intersectsTriangle(vertex0: DeepImmutable<Vector3>, vertex1: DeepImmutable<Vector3>, vertex2: DeepImmutable<Vector3>): Nullable<IntersectionInfo>;
  11251. /**
  11252. * Checks if ray intersects a plane
  11253. * @param plane the plane to check
  11254. * @returns the distance away it was hit
  11255. */
  11256. intersectsPlane(plane: DeepImmutable<Plane>): Nullable<number>;
  11257. /**
  11258. * Calculate the intercept of a ray on a given axis
  11259. * @param axis to check 'x' | 'y' | 'z'
  11260. * @param offset from axis interception (i.e. an offset of 1y is intercepted above ground)
  11261. * @returns a vector containing the coordinates where 'axis' is equal to zero (else offset), or null if there is no intercept.
  11262. */
  11263. intersectsAxis(axis: string, offset?: number): Nullable<Vector3>;
  11264. /**
  11265. * Checks if ray intersects a mesh
  11266. * @param mesh the mesh to check
  11267. * @param fastCheck if only the bounding box should checked
  11268. * @returns picking info of the intersecton
  11269. */
  11270. intersectsMesh(mesh: DeepImmutable<AbstractMesh>, fastCheck?: boolean): PickingInfo;
  11271. /**
  11272. * Checks if ray intersects a mesh
  11273. * @param meshes the meshes to check
  11274. * @param fastCheck if only the bounding box should checked
  11275. * @param results array to store result in
  11276. * @returns Array of picking infos
  11277. */
  11278. intersectsMeshes(meshes: Array<DeepImmutable<AbstractMesh>>, fastCheck?: boolean, results?: Array<PickingInfo>): Array<PickingInfo>;
  11279. private _comparePickingInfo;
  11280. private static smallnum;
  11281. private static rayl;
  11282. /**
  11283. * Intersection test between the ray and a given segment whithin a given tolerance (threshold)
  11284. * @param sega the first point of the segment to test the intersection against
  11285. * @param segb the second point of the segment to test the intersection against
  11286. * @param threshold the tolerance margin, if the ray doesn't intersect the segment but is close to the given threshold, the intersection is successful
  11287. * @return the distance from the ray origin to the intersection point if there's intersection, or -1 if there's no intersection
  11288. */
  11289. intersectionSegment(sega: DeepImmutable<Vector3>, segb: DeepImmutable<Vector3>, threshold: number): number;
  11290. /**
  11291. * Update the ray from viewport position
  11292. * @param x position
  11293. * @param y y position
  11294. * @param viewportWidth viewport width
  11295. * @param viewportHeight viewport height
  11296. * @param world world matrix
  11297. * @param view view matrix
  11298. * @param projection projection matrix
  11299. * @returns this ray updated
  11300. */
  11301. update(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  11302. /**
  11303. * Creates a ray with origin and direction of 0,0,0
  11304. * @returns the new ray
  11305. */
  11306. static Zero(): Ray;
  11307. /**
  11308. * Creates a new ray from screen space and viewport
  11309. * @param x position
  11310. * @param y y position
  11311. * @param viewportWidth viewport width
  11312. * @param viewportHeight viewport height
  11313. * @param world world matrix
  11314. * @param view view matrix
  11315. * @param projection projection matrix
  11316. * @returns new ray
  11317. */
  11318. static CreateNew(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  11319. /**
  11320. * 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
  11321. * transformed to the given world matrix.
  11322. * @param origin The origin point
  11323. * @param end The end point
  11324. * @param world a matrix to transform the ray to. Default is the identity matrix.
  11325. * @returns the new ray
  11326. */
  11327. static CreateNewFromTo(origin: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, world?: DeepImmutable<Matrix>): Ray;
  11328. /**
  11329. * Transforms a ray by a matrix
  11330. * @param ray ray to transform
  11331. * @param matrix matrix to apply
  11332. * @returns the resulting new ray
  11333. */
  11334. static Transform(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>): Ray;
  11335. /**
  11336. * Transforms a ray by a matrix
  11337. * @param ray ray to transform
  11338. * @param matrix matrix to apply
  11339. * @param result ray to store result in
  11340. */
  11341. static TransformToRef(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>, result: Ray): void;
  11342. /**
  11343. * Unproject a ray from screen space to object space
  11344. * @param sourceX defines the screen space x coordinate to use
  11345. * @param sourceY defines the screen space y coordinate to use
  11346. * @param viewportWidth defines the current width of the viewport
  11347. * @param viewportHeight defines the current height of the viewport
  11348. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  11349. * @param view defines the view matrix to use
  11350. * @param projection defines the projection matrix to use
  11351. */
  11352. unprojectRayToRef(sourceX: float, sourceY: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): void;
  11353. }
  11354. /**
  11355. * Type used to define predicate used to select faces when a mesh intersection is detected
  11356. */
  11357. export type TrianglePickingPredicate = (p0: Vector3, p1: Vector3, p2: Vector3, ray: Ray) => boolean;
  11358. module "babylonjs/scene" {
  11359. interface Scene {
  11360. /** @hidden */
  11361. _tempPickingRay: Nullable<Ray>;
  11362. /** @hidden */
  11363. _cachedRayForTransform: Ray;
  11364. /** @hidden */
  11365. _pickWithRayInverseMatrix: Matrix;
  11366. /** @hidden */
  11367. _internalPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  11368. /** @hidden */
  11369. _internalMultiPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  11370. }
  11371. }
  11372. }
  11373. declare module "babylonjs/sceneComponent" {
  11374. import { Scene } from "babylonjs/scene";
  11375. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  11376. import { SubMesh } from "babylonjs/Meshes/subMesh";
  11377. import { _InstancesBatch } from "babylonjs/Meshes/mesh";
  11378. import { SmartArrayNoDuplicate } from "babylonjs/Misc/smartArray";
  11379. import { Nullable } from "babylonjs/types";
  11380. import { Camera } from "babylonjs/Cameras/camera";
  11381. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  11382. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  11383. import { AbstractScene } from "babylonjs/abstractScene";
  11384. import { Mesh } from "babylonjs/Meshes/mesh";
  11385. /**
  11386. * Groups all the scene component constants in one place to ease maintenance.
  11387. * @hidden
  11388. */
  11389. export class SceneComponentConstants {
  11390. static readonly NAME_EFFECTLAYER: string;
  11391. static readonly NAME_LAYER: string;
  11392. static readonly NAME_LENSFLARESYSTEM: string;
  11393. static readonly NAME_BOUNDINGBOXRENDERER: string;
  11394. static readonly NAME_PARTICLESYSTEM: string;
  11395. static readonly NAME_GAMEPAD: string;
  11396. static readonly NAME_SIMPLIFICATIONQUEUE: string;
  11397. static readonly NAME_GEOMETRYBUFFERRENDERER: string;
  11398. static readonly NAME_DEPTHRENDERER: string;
  11399. static readonly NAME_POSTPROCESSRENDERPIPELINEMANAGER: string;
  11400. static readonly NAME_SPRITE: string;
  11401. static readonly NAME_OUTLINERENDERER: string;
  11402. static readonly NAME_PROCEDURALTEXTURE: string;
  11403. static readonly NAME_SHADOWGENERATOR: string;
  11404. static readonly NAME_OCTREE: string;
  11405. static readonly NAME_PHYSICSENGINE: string;
  11406. static readonly NAME_AUDIO: string;
  11407. static readonly STEP_ISREADYFORMESH_EFFECTLAYER: number;
  11408. static readonly STEP_BEFOREEVALUATEACTIVEMESH_BOUNDINGBOXRENDERER: number;
  11409. static readonly STEP_EVALUATESUBMESH_BOUNDINGBOXRENDERER: number;
  11410. static readonly STEP_ACTIVEMESH_BOUNDINGBOXRENDERER: number;
  11411. static readonly STEP_CAMERADRAWRENDERTARGET_EFFECTLAYER: number;
  11412. static readonly STEP_BEFORECAMERADRAW_EFFECTLAYER: number;
  11413. static readonly STEP_BEFORECAMERADRAW_LAYER: number;
  11414. static readonly STEP_BEFORERENDERTARGETDRAW_LAYER: number;
  11415. static readonly STEP_BEFORERENDERINGMESH_OUTLINE: number;
  11416. static readonly STEP_AFTERRENDERINGMESH_OUTLINE: number;
  11417. static readonly STEP_AFTERRENDERINGGROUPDRAW_EFFECTLAYER_DRAW: number;
  11418. static readonly STEP_AFTERRENDERINGGROUPDRAW_BOUNDINGBOXRENDERER: number;
  11419. static readonly STEP_BEFORECAMERAUPDATE_SIMPLIFICATIONQUEUE: number;
  11420. static readonly STEP_BEFORECAMERAUPDATE_GAMEPAD: number;
  11421. static readonly STEP_BEFORECLEAR_PROCEDURALTEXTURE: number;
  11422. static readonly STEP_AFTERRENDERTARGETDRAW_LAYER: number;
  11423. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER: number;
  11424. static readonly STEP_AFTERCAMERADRAW_LENSFLARESYSTEM: number;
  11425. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER_DRAW: number;
  11426. static readonly STEP_AFTERCAMERADRAW_LAYER: number;
  11427. static readonly STEP_AFTERRENDER_AUDIO: number;
  11428. static readonly STEP_GATHERRENDERTARGETS_SHADOWGENERATOR: number;
  11429. static readonly STEP_GATHERRENDERTARGETS_GEOMETRYBUFFERRENDERER: number;
  11430. static readonly STEP_GATHERRENDERTARGETS_DEPTHRENDERER: number;
  11431. static readonly STEP_GATHERRENDERTARGETS_POSTPROCESSRENDERPIPELINEMANAGER: number;
  11432. static readonly STEP_GATHERACTIVECAMERARENDERTARGETS_DEPTHRENDERER: number;
  11433. static readonly STEP_POINTERMOVE_SPRITE: number;
  11434. static readonly STEP_POINTERDOWN_SPRITE: number;
  11435. static readonly STEP_POINTERUP_SPRITE: number;
  11436. }
  11437. /**
  11438. * This represents a scene component.
  11439. *
  11440. * This is used to decouple the dependency the scene is having on the different workloads like
  11441. * layers, post processes...
  11442. */
  11443. export interface ISceneComponent {
  11444. /**
  11445. * The name of the component. Each component must have a unique name.
  11446. */
  11447. name: string;
  11448. /**
  11449. * The scene the component belongs to.
  11450. */
  11451. scene: Scene;
  11452. /**
  11453. * Register the component to one instance of a scene.
  11454. */
  11455. register(): void;
  11456. /**
  11457. * Rebuilds the elements related to this component in case of
  11458. * context lost for instance.
  11459. */
  11460. rebuild(): void;
  11461. /**
  11462. * Disposes the component and the associated ressources.
  11463. */
  11464. dispose(): void;
  11465. }
  11466. /**
  11467. * This represents a SERIALIZABLE scene component.
  11468. *
  11469. * This extends Scene Component to add Serialization methods on top.
  11470. */
  11471. export interface ISceneSerializableComponent extends ISceneComponent {
  11472. /**
  11473. * Adds all the elements from the container to the scene
  11474. * @param container the container holding the elements
  11475. */
  11476. addFromContainer(container: AbstractScene): void;
  11477. /**
  11478. * Removes all the elements in the container from the scene
  11479. * @param container contains the elements to remove
  11480. * @param dispose if the removed element should be disposed (default: false)
  11481. */
  11482. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  11483. /**
  11484. * Serializes the component data to the specified json object
  11485. * @param serializationObject The object to serialize to
  11486. */
  11487. serialize(serializationObject: any): void;
  11488. }
  11489. /**
  11490. * Strong typing of a Mesh related stage step action
  11491. */
  11492. export type MeshStageAction = (mesh: AbstractMesh, hardwareInstancedRendering: boolean) => boolean;
  11493. /**
  11494. * Strong typing of a Evaluate Sub Mesh related stage step action
  11495. */
  11496. export type EvaluateSubMeshStageAction = (mesh: AbstractMesh, subMesh: SubMesh) => void;
  11497. /**
  11498. * Strong typing of a Active Mesh related stage step action
  11499. */
  11500. export type ActiveMeshStageAction = (sourceMesh: AbstractMesh, mesh: AbstractMesh) => void;
  11501. /**
  11502. * Strong typing of a Camera related stage step action
  11503. */
  11504. export type CameraStageAction = (camera: Camera) => void;
  11505. /**
  11506. * Strong typing of a Camera Frame buffer related stage step action
  11507. */
  11508. export type CameraStageFrameBufferAction = (camera: Camera) => boolean;
  11509. /**
  11510. * Strong typing of a Render Target related stage step action
  11511. */
  11512. export type RenderTargetStageAction = (renderTarget: RenderTargetTexture) => void;
  11513. /**
  11514. * Strong typing of a RenderingGroup related stage step action
  11515. */
  11516. export type RenderingGroupStageAction = (renderingGroupId: number) => void;
  11517. /**
  11518. * Strong typing of a Mesh Render related stage step action
  11519. */
  11520. export type RenderingMeshStageAction = (mesh: Mesh, subMesh: SubMesh, batch: _InstancesBatch) => void;
  11521. /**
  11522. * Strong typing of a simple stage step action
  11523. */
  11524. export type SimpleStageAction = () => void;
  11525. /**
  11526. * Strong typing of a render target action.
  11527. */
  11528. export type RenderTargetsStageAction = (renderTargets: SmartArrayNoDuplicate<RenderTargetTexture>) => void;
  11529. /**
  11530. * Strong typing of a pointer move action.
  11531. */
  11532. export type PointerMoveStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, isMeshPicked: boolean, element: HTMLElement) => Nullable<PickingInfo>;
  11533. /**
  11534. * Strong typing of a pointer up/down action.
  11535. */
  11536. export type PointerUpDownStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, evt: PointerEvent) => Nullable<PickingInfo>;
  11537. /**
  11538. * Representation of a stage in the scene (Basically a list of ordered steps)
  11539. * @hidden
  11540. */
  11541. export class Stage<T extends Function> extends Array<{
  11542. index: number;
  11543. component: ISceneComponent;
  11544. action: T;
  11545. }> {
  11546. /**
  11547. * Hide ctor from the rest of the world.
  11548. * @param items The items to add.
  11549. */
  11550. private constructor();
  11551. /**
  11552. * Creates a new Stage.
  11553. * @returns A new instance of a Stage
  11554. */
  11555. static Create<T extends Function>(): Stage<T>;
  11556. /**
  11557. * Registers a step in an ordered way in the targeted stage.
  11558. * @param index Defines the position to register the step in
  11559. * @param component Defines the component attached to the step
  11560. * @param action Defines the action to launch during the step
  11561. */
  11562. registerStep(index: number, component: ISceneComponent, action: T): void;
  11563. /**
  11564. * Clears all the steps from the stage.
  11565. */
  11566. clear(): void;
  11567. }
  11568. }
  11569. declare module "babylonjs/Sprites/spriteSceneComponent" {
  11570. import { Nullable } from "babylonjs/types";
  11571. import { Observable } from "babylonjs/Misc/observable";
  11572. import { Scene } from "babylonjs/scene";
  11573. import { Sprite } from "babylonjs/Sprites/sprite";
  11574. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  11575. import { Ray } from "babylonjs/Culling/ray";
  11576. import { Camera } from "babylonjs/Cameras/camera";
  11577. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  11578. import { ISceneComponent } from "babylonjs/sceneComponent";
  11579. module "babylonjs/scene" {
  11580. interface Scene {
  11581. /** @hidden */
  11582. _pointerOverSprite: Nullable<Sprite>;
  11583. /** @hidden */
  11584. _pickedDownSprite: Nullable<Sprite>;
  11585. /** @hidden */
  11586. _tempSpritePickingRay: Nullable<Ray>;
  11587. /**
  11588. * All of the sprite managers added to this scene
  11589. * @see http://doc.babylonjs.com/babylon101/sprites
  11590. */
  11591. spriteManagers: Array<ISpriteManager>;
  11592. /**
  11593. * An event triggered when sprites rendering is about to start
  11594. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  11595. */
  11596. onBeforeSpritesRenderingObservable: Observable<Scene>;
  11597. /**
  11598. * An event triggered when sprites rendering is done
  11599. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  11600. */
  11601. onAfterSpritesRenderingObservable: Observable<Scene>;
  11602. /** @hidden */
  11603. _internalPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  11604. /** Launch a ray to try to pick a sprite in the scene
  11605. * @param x position on screen
  11606. * @param y position on screen
  11607. * @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
  11608. * @param fastCheck Launch a fast check only using the bounding boxes. Can be set to null.
  11609. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  11610. * @returns a PickingInfo
  11611. */
  11612. pickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  11613. /** Use the given ray to pick a sprite in the scene
  11614. * @param ray The ray (in world space) to use to pick meshes
  11615. * @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
  11616. * @param fastCheck Launch a fast check only using the bounding boxes. Can be set to null.
  11617. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  11618. * @returns a PickingInfo
  11619. */
  11620. pickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  11621. /** @hidden */
  11622. _internalMultiPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  11623. /** Launch a ray to try to pick sprites in the scene
  11624. * @param x position on screen
  11625. * @param y position on screen
  11626. * @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
  11627. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  11628. * @returns a PickingInfo array
  11629. */
  11630. multiPickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  11631. /** Use the given ray to pick sprites in the scene
  11632. * @param ray The ray (in world space) to use to pick meshes
  11633. * @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
  11634. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  11635. * @returns a PickingInfo array
  11636. */
  11637. multiPickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  11638. /**
  11639. * Force the sprite under the pointer
  11640. * @param sprite defines the sprite to use
  11641. */
  11642. setPointerOverSprite(sprite: Nullable<Sprite>): void;
  11643. /**
  11644. * Gets the sprite under the pointer
  11645. * @returns a Sprite or null if no sprite is under the pointer
  11646. */
  11647. getPointerOverSprite(): Nullable<Sprite>;
  11648. }
  11649. }
  11650. /**
  11651. * Defines the sprite scene component responsible to manage sprites
  11652. * in a given scene.
  11653. */
  11654. export class SpriteSceneComponent implements ISceneComponent {
  11655. /**
  11656. * The component name helpfull to identify the component in the list of scene components.
  11657. */
  11658. readonly name: string;
  11659. /**
  11660. * The scene the component belongs to.
  11661. */
  11662. scene: Scene;
  11663. /** @hidden */
  11664. private _spritePredicate;
  11665. /**
  11666. * Creates a new instance of the component for the given scene
  11667. * @param scene Defines the scene to register the component in
  11668. */
  11669. constructor(scene: Scene);
  11670. /**
  11671. * Registers the component in a given scene
  11672. */
  11673. register(): void;
  11674. /**
  11675. * Rebuilds the elements related to this component in case of
  11676. * context lost for instance.
  11677. */
  11678. rebuild(): void;
  11679. /**
  11680. * Disposes the component and the associated ressources.
  11681. */
  11682. dispose(): void;
  11683. private _pickSpriteButKeepRay;
  11684. private _pointerMove;
  11685. private _pointerDown;
  11686. private _pointerUp;
  11687. }
  11688. }
  11689. declare module "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration" {
  11690. /** @hidden */
  11691. export var fogFragmentDeclaration: {
  11692. name: string;
  11693. shader: string;
  11694. };
  11695. }
  11696. declare module "babylonjs/Shaders/ShadersInclude/fogFragment" {
  11697. /** @hidden */
  11698. export var fogFragment: {
  11699. name: string;
  11700. shader: string;
  11701. };
  11702. }
  11703. declare module "babylonjs/Shaders/sprites.fragment" {
  11704. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  11705. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  11706. /** @hidden */
  11707. export var spritesPixelShader: {
  11708. name: string;
  11709. shader: string;
  11710. };
  11711. }
  11712. declare module "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration" {
  11713. /** @hidden */
  11714. export var fogVertexDeclaration: {
  11715. name: string;
  11716. shader: string;
  11717. };
  11718. }
  11719. declare module "babylonjs/Shaders/sprites.vertex" {
  11720. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  11721. /** @hidden */
  11722. export var spritesVertexShader: {
  11723. name: string;
  11724. shader: string;
  11725. };
  11726. }
  11727. declare module "babylonjs/Sprites/spriteManager" {
  11728. import { IDisposable, Scene } from "babylonjs/scene";
  11729. import { Nullable } from "babylonjs/types";
  11730. import { Observable } from "babylonjs/Misc/observable";
  11731. import { Sprite } from "babylonjs/Sprites/sprite";
  11732. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  11733. import { Camera } from "babylonjs/Cameras/camera";
  11734. import { Texture } from "babylonjs/Materials/Textures/texture";
  11735. import "babylonjs/Shaders/sprites.fragment";
  11736. import "babylonjs/Shaders/sprites.vertex";
  11737. import { Ray } from "babylonjs/Culling/ray";
  11738. /**
  11739. * Defines the minimum interface to fullfil in order to be a sprite manager.
  11740. */
  11741. export interface ISpriteManager extends IDisposable {
  11742. /**
  11743. * Restricts the camera to viewing objects with the same layerMask.
  11744. * A camera with a layerMask of 1 will render spriteManager.layerMask & camera.layerMask!== 0
  11745. */
  11746. layerMask: number;
  11747. /**
  11748. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  11749. */
  11750. isPickable: boolean;
  11751. /**
  11752. * Specifies the rendering group id for this mesh (0 by default)
  11753. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  11754. */
  11755. renderingGroupId: number;
  11756. /**
  11757. * Defines the list of sprites managed by the manager.
  11758. */
  11759. sprites: Array<Sprite>;
  11760. /**
  11761. * Tests the intersection of a sprite with a specific ray.
  11762. * @param ray The ray we are sending to test the collision
  11763. * @param camera The camera space we are sending rays in
  11764. * @param predicate A predicate allowing excluding sprites from the list of object to test
  11765. * @param fastCheck Is the hit test done in a OOBB or AOBB fashion the faster, the less precise
  11766. * @returns picking info or null.
  11767. */
  11768. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  11769. /**
  11770. * Intersects the sprites with a ray
  11771. * @param ray defines the ray to intersect with
  11772. * @param camera defines the current active camera
  11773. * @param predicate defines a predicate used to select candidate sprites
  11774. * @returns null if no hit or a PickingInfo array
  11775. */
  11776. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  11777. /**
  11778. * Renders the list of sprites on screen.
  11779. */
  11780. render(): void;
  11781. }
  11782. /**
  11783. * Class used to manage multiple sprites on the same spritesheet
  11784. * @see http://doc.babylonjs.com/babylon101/sprites
  11785. */
  11786. export class SpriteManager implements ISpriteManager {
  11787. /** defines the manager's name */
  11788. name: string;
  11789. /** Gets the list of sprites */
  11790. sprites: Sprite[];
  11791. /** Gets or sets the rendering group id (0 by default) */
  11792. renderingGroupId: number;
  11793. /** Gets or sets camera layer mask */
  11794. layerMask: number;
  11795. /** Gets or sets a boolean indicating if the manager must consider scene fog when rendering */
  11796. fogEnabled: boolean;
  11797. /** Gets or sets a boolean indicating if the sprites are pickable */
  11798. isPickable: boolean;
  11799. /** Defines the default width of a cell in the spritesheet */
  11800. cellWidth: number;
  11801. /** Defines the default height of a cell in the spritesheet */
  11802. cellHeight: number;
  11803. /** Associative array from JSON sprite data file */
  11804. private _cellData;
  11805. /** Array of sprite names from JSON sprite data file */
  11806. private _spriteMap;
  11807. /** True when packed cell data from JSON file is ready*/
  11808. private _packedAndReady;
  11809. /**
  11810. * An event triggered when the manager is disposed.
  11811. */
  11812. onDisposeObservable: Observable<SpriteManager>;
  11813. private _onDisposeObserver;
  11814. /**
  11815. * Callback called when the manager is disposed
  11816. */
  11817. onDispose: () => void;
  11818. private _capacity;
  11819. private _fromPacked;
  11820. private _spriteTexture;
  11821. private _epsilon;
  11822. private _scene;
  11823. private _vertexData;
  11824. private _buffer;
  11825. private _vertexBuffers;
  11826. private _indexBuffer;
  11827. private _effectBase;
  11828. private _effectFog;
  11829. /**
  11830. * Gets or sets the spritesheet texture
  11831. */
  11832. texture: Texture;
  11833. /**
  11834. * Creates a new sprite manager
  11835. * @param name defines the manager's name
  11836. * @param imgUrl defines the sprite sheet url
  11837. * @param capacity defines the maximum allowed number of sprites
  11838. * @param cellSize defines the size of a sprite cell
  11839. * @param scene defines the hosting scene
  11840. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  11841. * @param samplingMode defines the smapling mode to use with spritesheet
  11842. * @param fromPacked set to false; do not alter
  11843. * @param spriteJSON null otherwise a JSON object defining sprite sheet data; do not alter
  11844. */
  11845. constructor(
  11846. /** defines the manager's name */
  11847. name: string, imgUrl: string, capacity: number, cellSize: any, scene: Scene, epsilon?: number, samplingMode?: number, fromPacked?: boolean, spriteJSON?: string | null);
  11848. private _makePacked;
  11849. private _appendSpriteVertex;
  11850. /**
  11851. * Intersects the sprites with a ray
  11852. * @param ray defines the ray to intersect with
  11853. * @param camera defines the current active camera
  11854. * @param predicate defines a predicate used to select candidate sprites
  11855. * @param fastCheck defines if a fast check only must be done (the first potential sprite is will be used and not the closer)
  11856. * @returns null if no hit or a PickingInfo
  11857. */
  11858. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  11859. /**
  11860. * Intersects the sprites with a ray
  11861. * @param ray defines the ray to intersect with
  11862. * @param camera defines the current active camera
  11863. * @param predicate defines a predicate used to select candidate sprites
  11864. * @returns null if no hit or a PickingInfo array
  11865. */
  11866. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  11867. /**
  11868. * Render all child sprites
  11869. */
  11870. render(): void;
  11871. /**
  11872. * Release associated resources
  11873. */
  11874. dispose(): void;
  11875. }
  11876. }
  11877. declare module "babylonjs/Sprites/sprite" {
  11878. import { Vector3 } from "babylonjs/Maths/math.vector";
  11879. import { Nullable } from "babylonjs/types";
  11880. import { ActionManager } from "babylonjs/Actions/actionManager";
  11881. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  11882. import { Color4 } from "babylonjs/Maths/math.color";
  11883. /**
  11884. * Class used to represent a sprite
  11885. * @see http://doc.babylonjs.com/babylon101/sprites
  11886. */
  11887. export class Sprite {
  11888. /** defines the name */
  11889. name: string;
  11890. /** Gets or sets the current world position */
  11891. position: Vector3;
  11892. /** Gets or sets the main color */
  11893. color: Color4;
  11894. /** Gets or sets the width */
  11895. width: number;
  11896. /** Gets or sets the height */
  11897. height: number;
  11898. /** Gets or sets rotation angle */
  11899. angle: number;
  11900. /** Gets or sets the cell index in the sprite sheet */
  11901. cellIndex: number;
  11902. /** Gets or sets the cell reference in the sprite sheet, uses sprite's filename when added to sprite sheet */
  11903. cellRef: string;
  11904. /** Gets or sets a boolean indicating if UV coordinates should be inverted in U axis */
  11905. invertU: number;
  11906. /** Gets or sets a boolean indicating if UV coordinates should be inverted in B axis */
  11907. invertV: number;
  11908. /** Gets or sets a boolean indicating that this sprite should be disposed after animation ends */
  11909. disposeWhenFinishedAnimating: boolean;
  11910. /** Gets the list of attached animations */
  11911. animations: Animation[];
  11912. /** Gets or sets a boolean indicating if the sprite can be picked */
  11913. isPickable: boolean;
  11914. /**
  11915. * Gets or sets the associated action manager
  11916. */
  11917. actionManager: Nullable<ActionManager>;
  11918. private _animationStarted;
  11919. private _loopAnimation;
  11920. private _fromIndex;
  11921. private _toIndex;
  11922. private _delay;
  11923. private _direction;
  11924. private _manager;
  11925. private _time;
  11926. private _onAnimationEnd;
  11927. /**
  11928. * Gets or sets a boolean indicating if the sprite is visible (renderable). Default is true
  11929. */
  11930. isVisible: boolean;
  11931. /**
  11932. * Gets or sets the sprite size
  11933. */
  11934. size: number;
  11935. /**
  11936. * Creates a new Sprite
  11937. * @param name defines the name
  11938. * @param manager defines the manager
  11939. */
  11940. constructor(
  11941. /** defines the name */
  11942. name: string, manager: ISpriteManager);
  11943. /**
  11944. * Starts an animation
  11945. * @param from defines the initial key
  11946. * @param to defines the end key
  11947. * @param loop defines if the animation must loop
  11948. * @param delay defines the start delay (in ms)
  11949. * @param onAnimationEnd defines a callback to call when animation ends
  11950. */
  11951. playAnimation(from: number, to: number, loop: boolean, delay: number, onAnimationEnd: () => void): void;
  11952. /** Stops current animation (if any) */
  11953. stopAnimation(): void;
  11954. /** @hidden */
  11955. _animate(deltaTime: number): void;
  11956. /** Release associated resources */
  11957. dispose(): void;
  11958. }
  11959. }
  11960. declare module "babylonjs/Collisions/pickingInfo" {
  11961. import { Nullable } from "babylonjs/types";
  11962. import { Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  11963. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  11964. import { Sprite } from "babylonjs/Sprites/sprite";
  11965. import { Ray } from "babylonjs/Culling/ray";
  11966. /**
  11967. * Information about the result of picking within a scene
  11968. * @see https://doc.babylonjs.com/babylon101/picking_collisions
  11969. */
  11970. export class PickingInfo {
  11971. /** @hidden */
  11972. _pickingUnavailable: boolean;
  11973. /**
  11974. * If the pick collided with an object
  11975. */
  11976. hit: boolean;
  11977. /**
  11978. * Distance away where the pick collided
  11979. */
  11980. distance: number;
  11981. /**
  11982. * The location of pick collision
  11983. */
  11984. pickedPoint: Nullable<Vector3>;
  11985. /**
  11986. * The mesh corresponding the the pick collision
  11987. */
  11988. pickedMesh: Nullable<AbstractMesh>;
  11989. /** (See getTextureCoordinates) The barycentric U coordinate that is used when calculating the texture coordinates of the collision.*/
  11990. bu: number;
  11991. /** (See getTextureCoordinates) The barycentric V coordinate that is used when calculating the texture coordinates of the collision.*/
  11992. bv: number;
  11993. /** The index of the face on the mesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  11994. faceId: number;
  11995. /** Id of the the submesh that was picked */
  11996. subMeshId: number;
  11997. /** If a sprite was picked, this will be the sprite the pick collided with */
  11998. pickedSprite: Nullable<Sprite>;
  11999. /**
  12000. * If a mesh was used to do the picking (eg. 6dof controller) this will be populated.
  12001. */
  12002. originMesh: Nullable<AbstractMesh>;
  12003. /**
  12004. * The ray that was used to perform the picking.
  12005. */
  12006. ray: Nullable<Ray>;
  12007. /**
  12008. * Gets the normal correspodning to the face the pick collided with
  12009. * @param useWorldCoordinates If the resulting normal should be relative to the world (default: false)
  12010. * @param useVerticesNormals If the vertices normals should be used to calculate the normal instead of the normal map
  12011. * @returns The normal correspodning to the face the pick collided with
  12012. */
  12013. getNormal(useWorldCoordinates?: boolean, useVerticesNormals?: boolean): Nullable<Vector3>;
  12014. /**
  12015. * Gets the texture coordinates of where the pick occured
  12016. * @returns the vector containing the coordnates of the texture
  12017. */
  12018. getTextureCoordinates(): Nullable<Vector2>;
  12019. }
  12020. }
  12021. declare module "babylonjs/Events/pointerEvents" {
  12022. import { Nullable } from "babylonjs/types";
  12023. import { Vector2 } from "babylonjs/Maths/math.vector";
  12024. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  12025. import { Ray } from "babylonjs/Culling/ray";
  12026. /**
  12027. * Gather the list of pointer event types as constants.
  12028. */
  12029. export class PointerEventTypes {
  12030. /**
  12031. * 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.
  12032. */
  12033. static readonly POINTERDOWN: number;
  12034. /**
  12035. * The pointerup event is fired when a pointer is no longer active.
  12036. */
  12037. static readonly POINTERUP: number;
  12038. /**
  12039. * The pointermove event is fired when a pointer changes coordinates.
  12040. */
  12041. static readonly POINTERMOVE: number;
  12042. /**
  12043. * The pointerwheel event is fired when a mouse wheel has been rotated.
  12044. */
  12045. static readonly POINTERWHEEL: number;
  12046. /**
  12047. * The pointerpick event is fired when a mesh or sprite has been picked by the pointer.
  12048. */
  12049. static readonly POINTERPICK: number;
  12050. /**
  12051. * The pointertap event is fired when a the object has been touched and released without drag.
  12052. */
  12053. static readonly POINTERTAP: number;
  12054. /**
  12055. * The pointerdoubletap event is fired when a the object has been touched and released twice without drag.
  12056. */
  12057. static readonly POINTERDOUBLETAP: number;
  12058. }
  12059. /**
  12060. * Base class of pointer info types.
  12061. */
  12062. export class PointerInfoBase {
  12063. /**
  12064. * Defines the type of event (PointerEventTypes)
  12065. */
  12066. type: number;
  12067. /**
  12068. * Defines the related dom event
  12069. */
  12070. event: PointerEvent | MouseWheelEvent;
  12071. /**
  12072. * Instantiates the base class of pointers info.
  12073. * @param type Defines the type of event (PointerEventTypes)
  12074. * @param event Defines the related dom event
  12075. */
  12076. constructor(
  12077. /**
  12078. * Defines the type of event (PointerEventTypes)
  12079. */
  12080. type: number,
  12081. /**
  12082. * Defines the related dom event
  12083. */
  12084. event: PointerEvent | MouseWheelEvent);
  12085. }
  12086. /**
  12087. * This class is used to store pointer related info for the onPrePointerObservable event.
  12088. * Set the skipOnPointerObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onPointerObservable
  12089. */
  12090. export class PointerInfoPre extends PointerInfoBase {
  12091. /**
  12092. * Ray from a pointer if availible (eg. 6dof controller)
  12093. */
  12094. ray: Nullable<Ray>;
  12095. /**
  12096. * Defines the local position of the pointer on the canvas.
  12097. */
  12098. localPosition: Vector2;
  12099. /**
  12100. * Defines whether the engine should skip the next OnPointerObservable associated to this pre.
  12101. */
  12102. skipOnPointerObservable: boolean;
  12103. /**
  12104. * Instantiates a PointerInfoPre to store pointer related info to the onPrePointerObservable event.
  12105. * @param type Defines the type of event (PointerEventTypes)
  12106. * @param event Defines the related dom event
  12107. * @param localX Defines the local x coordinates of the pointer when the event occured
  12108. * @param localY Defines the local y coordinates of the pointer when the event occured
  12109. */
  12110. constructor(type: number, event: PointerEvent | MouseWheelEvent, localX: number, localY: number);
  12111. }
  12112. /**
  12113. * This type contains all the data related to a pointer event in Babylon.js.
  12114. * 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.
  12115. */
  12116. export class PointerInfo extends PointerInfoBase {
  12117. /**
  12118. * Defines the picking info associated to the info (if any)\
  12119. */
  12120. pickInfo: Nullable<PickingInfo>;
  12121. /**
  12122. * Instantiates a PointerInfo to store pointer related info to the onPointerObservable event.
  12123. * @param type Defines the type of event (PointerEventTypes)
  12124. * @param event Defines the related dom event
  12125. * @param pickInfo Defines the picking info associated to the info (if any)\
  12126. */
  12127. constructor(type: number, event: PointerEvent | MouseWheelEvent,
  12128. /**
  12129. * Defines the picking info associated to the info (if any)\
  12130. */
  12131. pickInfo: Nullable<PickingInfo>);
  12132. }
  12133. /**
  12134. * Data relating to a touch event on the screen.
  12135. */
  12136. export interface PointerTouch {
  12137. /**
  12138. * X coordinate of touch.
  12139. */
  12140. x: number;
  12141. /**
  12142. * Y coordinate of touch.
  12143. */
  12144. y: number;
  12145. /**
  12146. * Id of touch. Unique for each finger.
  12147. */
  12148. pointerId: number;
  12149. /**
  12150. * Event type passed from DOM.
  12151. */
  12152. type: any;
  12153. }
  12154. }
  12155. declare module "babylonjs/Cameras/Inputs/freeCameraMouseInput" {
  12156. import { Observable } from "babylonjs/Misc/observable";
  12157. import { Nullable } from "babylonjs/types";
  12158. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  12159. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  12160. /**
  12161. * Manage the mouse inputs to control the movement of a free camera.
  12162. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  12163. */
  12164. export class FreeCameraMouseInput implements ICameraInput<FreeCamera> {
  12165. /**
  12166. * Define if touch is enabled in the mouse input
  12167. */
  12168. touchEnabled: boolean;
  12169. /**
  12170. * Defines the camera the input is attached to.
  12171. */
  12172. camera: FreeCamera;
  12173. /**
  12174. * Defines the buttons associated with the input to handle camera move.
  12175. */
  12176. buttons: number[];
  12177. /**
  12178. * Defines the pointer angular sensibility along the X and Y axis or how fast is the camera rotating.
  12179. */
  12180. angularSensibility: number;
  12181. private _pointerInput;
  12182. private _onMouseMove;
  12183. private _observer;
  12184. private previousPosition;
  12185. /**
  12186. * Observable for when a pointer move event occurs containing the move offset
  12187. */
  12188. onPointerMovedObservable: Observable<{
  12189. offsetX: number;
  12190. offsetY: number;
  12191. }>;
  12192. /**
  12193. * @hidden
  12194. * If the camera should be rotated automatically based on pointer movement
  12195. */
  12196. _allowCameraRotation: boolean;
  12197. /**
  12198. * Manage the mouse inputs to control the movement of a free camera.
  12199. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  12200. * @param touchEnabled Defines if touch is enabled or not
  12201. */
  12202. constructor(
  12203. /**
  12204. * Define if touch is enabled in the mouse input
  12205. */
  12206. touchEnabled?: boolean);
  12207. /**
  12208. * Attach the input controls to a specific dom element to get the input from.
  12209. * @param element Defines the element the controls should be listened from
  12210. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  12211. */
  12212. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  12213. /**
  12214. * Called on JS contextmenu event.
  12215. * Override this method to provide functionality.
  12216. */
  12217. protected onContextMenu(evt: PointerEvent): void;
  12218. /**
  12219. * Detach the current controls from the specified dom element.
  12220. * @param element Defines the element to stop listening the inputs from
  12221. */
  12222. detachControl(element: Nullable<HTMLElement>): void;
  12223. /**
  12224. * Gets the class name of the current intput.
  12225. * @returns the class name
  12226. */
  12227. getClassName(): string;
  12228. /**
  12229. * Get the friendly name associated with the input class.
  12230. * @returns the input friendly name
  12231. */
  12232. getSimpleName(): string;
  12233. }
  12234. }
  12235. declare module "babylonjs/Cameras/Inputs/freeCameraTouchInput" {
  12236. import { Nullable } from "babylonjs/types";
  12237. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  12238. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  12239. /**
  12240. * Manage the touch inputs to control the movement of a free camera.
  12241. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  12242. */
  12243. export class FreeCameraTouchInput implements ICameraInput<FreeCamera> {
  12244. /**
  12245. * Defines the camera the input is attached to.
  12246. */
  12247. camera: FreeCamera;
  12248. /**
  12249. * Defines the touch sensibility for rotation.
  12250. * The higher the faster.
  12251. */
  12252. touchAngularSensibility: number;
  12253. /**
  12254. * Defines the touch sensibility for move.
  12255. * The higher the faster.
  12256. */
  12257. touchMoveSensibility: number;
  12258. private _offsetX;
  12259. private _offsetY;
  12260. private _pointerPressed;
  12261. private _pointerInput;
  12262. private _observer;
  12263. private _onLostFocus;
  12264. /**
  12265. * Attach the input controls to a specific dom element to get the input from.
  12266. * @param element Defines the element the controls should be listened from
  12267. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  12268. */
  12269. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  12270. /**
  12271. * Detach the current controls from the specified dom element.
  12272. * @param element Defines the element to stop listening the inputs from
  12273. */
  12274. detachControl(element: Nullable<HTMLElement>): void;
  12275. /**
  12276. * Update the current camera state depending on the inputs that have been used this frame.
  12277. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  12278. */
  12279. checkInputs(): void;
  12280. /**
  12281. * Gets the class name of the current intput.
  12282. * @returns the class name
  12283. */
  12284. getClassName(): string;
  12285. /**
  12286. * Get the friendly name associated with the input class.
  12287. * @returns the input friendly name
  12288. */
  12289. getSimpleName(): string;
  12290. }
  12291. }
  12292. declare module "babylonjs/Cameras/freeCameraInputsManager" {
  12293. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  12294. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  12295. import { FreeCameraMouseInput } from "babylonjs/Cameras/Inputs/freeCameraMouseInput";
  12296. import { Nullable } from "babylonjs/types";
  12297. /**
  12298. * Default Inputs manager for the FreeCamera.
  12299. * It groups all the default supported inputs for ease of use.
  12300. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  12301. */
  12302. export class FreeCameraInputsManager extends CameraInputsManager<FreeCamera> {
  12303. /**
  12304. * @hidden
  12305. */
  12306. _mouseInput: Nullable<FreeCameraMouseInput>;
  12307. /**
  12308. * Instantiates a new FreeCameraInputsManager.
  12309. * @param camera Defines the camera the inputs belong to
  12310. */
  12311. constructor(camera: FreeCamera);
  12312. /**
  12313. * Add keyboard input support to the input manager.
  12314. * @returns the current input manager
  12315. */
  12316. addKeyboard(): FreeCameraInputsManager;
  12317. /**
  12318. * Add mouse input support to the input manager.
  12319. * @param touchEnabled if the FreeCameraMouseInput should support touch (default: true)
  12320. * @returns the current input manager
  12321. */
  12322. addMouse(touchEnabled?: boolean): FreeCameraInputsManager;
  12323. /**
  12324. * Removes the mouse input support from the manager
  12325. * @returns the current input manager
  12326. */
  12327. removeMouse(): FreeCameraInputsManager;
  12328. /**
  12329. * Add touch input support to the input manager.
  12330. * @returns the current input manager
  12331. */
  12332. addTouch(): FreeCameraInputsManager;
  12333. /**
  12334. * Remove all attached input methods from a camera
  12335. */
  12336. clear(): void;
  12337. }
  12338. }
  12339. declare module "babylonjs/Cameras/freeCamera" {
  12340. import { Vector3 } from "babylonjs/Maths/math.vector";
  12341. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  12342. import { Scene } from "babylonjs/scene";
  12343. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  12344. import { FreeCameraInputsManager } from "babylonjs/Cameras/freeCameraInputsManager";
  12345. /**
  12346. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  12347. * Please consider using the new UniversalCamera instead as it adds more functionality like the gamepad.
  12348. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  12349. */
  12350. export class FreeCamera extends TargetCamera {
  12351. /**
  12352. * Define the collision ellipsoid of the camera.
  12353. * This is helpful to simulate a camera body like the player body around the camera
  12354. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  12355. */
  12356. ellipsoid: Vector3;
  12357. /**
  12358. * Define an offset for the position of the ellipsoid around the camera.
  12359. * This can be helpful to determine the center of the body near the gravity center of the body
  12360. * instead of its head.
  12361. */
  12362. ellipsoidOffset: Vector3;
  12363. /**
  12364. * Enable or disable collisions of the camera with the rest of the scene objects.
  12365. */
  12366. checkCollisions: boolean;
  12367. /**
  12368. * Enable or disable gravity on the camera.
  12369. */
  12370. applyGravity: boolean;
  12371. /**
  12372. * Define the input manager associated to the camera.
  12373. */
  12374. inputs: FreeCameraInputsManager;
  12375. /**
  12376. * Gets the input sensibility for a mouse input. (default is 2000.0)
  12377. * Higher values reduce sensitivity.
  12378. */
  12379. /**
  12380. * Sets the input sensibility for a mouse input. (default is 2000.0)
  12381. * Higher values reduce sensitivity.
  12382. */
  12383. angularSensibility: number;
  12384. /**
  12385. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  12386. */
  12387. keysUp: number[];
  12388. /**
  12389. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  12390. */
  12391. keysDown: number[];
  12392. /**
  12393. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  12394. */
  12395. keysLeft: number[];
  12396. /**
  12397. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  12398. */
  12399. keysRight: number[];
  12400. /**
  12401. * Event raised when the camera collide with a mesh in the scene.
  12402. */
  12403. onCollide: (collidedMesh: AbstractMesh) => void;
  12404. private _collider;
  12405. private _needMoveForGravity;
  12406. private _oldPosition;
  12407. private _diffPosition;
  12408. private _newPosition;
  12409. /** @hidden */
  12410. _localDirection: Vector3;
  12411. /** @hidden */
  12412. _transformedDirection: Vector3;
  12413. /**
  12414. * Instantiates a Free Camera.
  12415. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  12416. * Please consider using the new UniversalCamera instead as it adds more functionality like touch to this camera.
  12417. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  12418. * @param name Define the name of the camera in the scene
  12419. * @param position Define the start position of the camera in the scene
  12420. * @param scene Define the scene the camera belongs to
  12421. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  12422. */
  12423. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  12424. /**
  12425. * Attached controls to the current camera.
  12426. * @param element Defines the element the controls should be listened from
  12427. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  12428. */
  12429. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  12430. /**
  12431. * Detach the current controls from the camera.
  12432. * The camera will stop reacting to inputs.
  12433. * @param element Defines the element to stop listening the inputs from
  12434. */
  12435. detachControl(element: HTMLElement): void;
  12436. private _collisionMask;
  12437. /**
  12438. * Define a collision mask to limit the list of object the camera can collide with
  12439. */
  12440. collisionMask: number;
  12441. /** @hidden */
  12442. _collideWithWorld(displacement: Vector3): void;
  12443. private _onCollisionPositionChange;
  12444. /** @hidden */
  12445. _checkInputs(): void;
  12446. /** @hidden */
  12447. _decideIfNeedsToMove(): boolean;
  12448. /** @hidden */
  12449. _updatePosition(): void;
  12450. /**
  12451. * Destroy the camera and release the current resources hold by it.
  12452. */
  12453. dispose(): void;
  12454. /**
  12455. * Gets the current object class name.
  12456. * @return the class name
  12457. */
  12458. getClassName(): string;
  12459. }
  12460. }
  12461. declare module "babylonjs/Gamepads/gamepad" {
  12462. import { Observable } from "babylonjs/Misc/observable";
  12463. /**
  12464. * Represents a gamepad control stick position
  12465. */
  12466. export class StickValues {
  12467. /**
  12468. * The x component of the control stick
  12469. */
  12470. x: number;
  12471. /**
  12472. * The y component of the control stick
  12473. */
  12474. y: number;
  12475. /**
  12476. * Initializes the gamepad x and y control stick values
  12477. * @param x The x component of the gamepad control stick value
  12478. * @param y The y component of the gamepad control stick value
  12479. */
  12480. constructor(
  12481. /**
  12482. * The x component of the control stick
  12483. */
  12484. x: number,
  12485. /**
  12486. * The y component of the control stick
  12487. */
  12488. y: number);
  12489. }
  12490. /**
  12491. * An interface which manages callbacks for gamepad button changes
  12492. */
  12493. export interface GamepadButtonChanges {
  12494. /**
  12495. * Called when a gamepad has been changed
  12496. */
  12497. changed: boolean;
  12498. /**
  12499. * Called when a gamepad press event has been triggered
  12500. */
  12501. pressChanged: boolean;
  12502. /**
  12503. * Called when a touch event has been triggered
  12504. */
  12505. touchChanged: boolean;
  12506. /**
  12507. * Called when a value has changed
  12508. */
  12509. valueChanged: boolean;
  12510. }
  12511. /**
  12512. * Represents a gamepad
  12513. */
  12514. export class Gamepad {
  12515. /**
  12516. * The id of the gamepad
  12517. */
  12518. id: string;
  12519. /**
  12520. * The index of the gamepad
  12521. */
  12522. index: number;
  12523. /**
  12524. * The browser gamepad
  12525. */
  12526. browserGamepad: any;
  12527. /**
  12528. * Specifies what type of gamepad this represents
  12529. */
  12530. type: number;
  12531. private _leftStick;
  12532. private _rightStick;
  12533. /** @hidden */
  12534. _isConnected: boolean;
  12535. private _leftStickAxisX;
  12536. private _leftStickAxisY;
  12537. private _rightStickAxisX;
  12538. private _rightStickAxisY;
  12539. /**
  12540. * Triggered when the left control stick has been changed
  12541. */
  12542. private _onleftstickchanged;
  12543. /**
  12544. * Triggered when the right control stick has been changed
  12545. */
  12546. private _onrightstickchanged;
  12547. /**
  12548. * Represents a gamepad controller
  12549. */
  12550. static GAMEPAD: number;
  12551. /**
  12552. * Represents a generic controller
  12553. */
  12554. static GENERIC: number;
  12555. /**
  12556. * Represents an XBox controller
  12557. */
  12558. static XBOX: number;
  12559. /**
  12560. * Represents a pose-enabled controller
  12561. */
  12562. static POSE_ENABLED: number;
  12563. /**
  12564. * Represents an Dual Shock controller
  12565. */
  12566. static DUALSHOCK: number;
  12567. /**
  12568. * Specifies whether the left control stick should be Y-inverted
  12569. */
  12570. protected _invertLeftStickY: boolean;
  12571. /**
  12572. * Specifies if the gamepad has been connected
  12573. */
  12574. readonly isConnected: boolean;
  12575. /**
  12576. * Initializes the gamepad
  12577. * @param id The id of the gamepad
  12578. * @param index The index of the gamepad
  12579. * @param browserGamepad The browser gamepad
  12580. * @param leftStickX The x component of the left joystick
  12581. * @param leftStickY The y component of the left joystick
  12582. * @param rightStickX The x component of the right joystick
  12583. * @param rightStickY The y component of the right joystick
  12584. */
  12585. constructor(
  12586. /**
  12587. * The id of the gamepad
  12588. */
  12589. id: string,
  12590. /**
  12591. * The index of the gamepad
  12592. */
  12593. index: number,
  12594. /**
  12595. * The browser gamepad
  12596. */
  12597. browserGamepad: any, leftStickX?: number, leftStickY?: number, rightStickX?: number, rightStickY?: number);
  12598. /**
  12599. * Callback triggered when the left joystick has changed
  12600. * @param callback
  12601. */
  12602. onleftstickchanged(callback: (values: StickValues) => void): void;
  12603. /**
  12604. * Callback triggered when the right joystick has changed
  12605. * @param callback
  12606. */
  12607. onrightstickchanged(callback: (values: StickValues) => void): void;
  12608. /**
  12609. * Gets the left joystick
  12610. */
  12611. /**
  12612. * Sets the left joystick values
  12613. */
  12614. leftStick: StickValues;
  12615. /**
  12616. * Gets the right joystick
  12617. */
  12618. /**
  12619. * Sets the right joystick value
  12620. */
  12621. rightStick: StickValues;
  12622. /**
  12623. * Updates the gamepad joystick positions
  12624. */
  12625. update(): void;
  12626. /**
  12627. * Disposes the gamepad
  12628. */
  12629. dispose(): void;
  12630. }
  12631. /**
  12632. * Represents a generic gamepad
  12633. */
  12634. export class GenericPad extends Gamepad {
  12635. private _buttons;
  12636. private _onbuttondown;
  12637. private _onbuttonup;
  12638. /**
  12639. * Observable triggered when a button has been pressed
  12640. */
  12641. onButtonDownObservable: Observable<number>;
  12642. /**
  12643. * Observable triggered when a button has been released
  12644. */
  12645. onButtonUpObservable: Observable<number>;
  12646. /**
  12647. * Callback triggered when a button has been pressed
  12648. * @param callback Called when a button has been pressed
  12649. */
  12650. onbuttondown(callback: (buttonPressed: number) => void): void;
  12651. /**
  12652. * Callback triggered when a button has been released
  12653. * @param callback Called when a button has been released
  12654. */
  12655. onbuttonup(callback: (buttonReleased: number) => void): void;
  12656. /**
  12657. * Initializes the generic gamepad
  12658. * @param id The id of the generic gamepad
  12659. * @param index The index of the generic gamepad
  12660. * @param browserGamepad The browser gamepad
  12661. */
  12662. constructor(id: string, index: number, browserGamepad: any);
  12663. private _setButtonValue;
  12664. /**
  12665. * Updates the generic gamepad
  12666. */
  12667. update(): void;
  12668. /**
  12669. * Disposes the generic gamepad
  12670. */
  12671. dispose(): void;
  12672. }
  12673. }
  12674. declare module "babylonjs/Engines/Extensions/engine.rawTexture" {
  12675. import { Nullable } from "babylonjs/types";
  12676. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  12677. import { Scene } from "babylonjs/scene";
  12678. module "babylonjs/Engines/engine" {
  12679. interface Engine {
  12680. /**
  12681. * Creates a raw texture
  12682. * @param data defines the data to store in the texture
  12683. * @param width defines the width of the texture
  12684. * @param height defines the height of the texture
  12685. * @param format defines the format of the data
  12686. * @param generateMipMaps defines if the engine should generate the mip levels
  12687. * @param invertY defines if data must be stored with Y axis inverted
  12688. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  12689. * @param compression defines the compression used (null by default)
  12690. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  12691. * @returns the raw texture inside an InternalTexture
  12692. */
  12693. createRawTexture(data: Nullable<ArrayBufferView>, width: number, height: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, type: number): InternalTexture;
  12694. /**
  12695. * Update a raw texture
  12696. * @param texture defines the texture to update
  12697. * @param data defines the data to store in the texture
  12698. * @param format defines the format of the data
  12699. * @param invertY defines if data must be stored with Y axis inverted
  12700. */
  12701. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  12702. /**
  12703. * Update a raw texture
  12704. * @param texture defines the texture to update
  12705. * @param data defines the data to store in the texture
  12706. * @param format defines the format of the data
  12707. * @param invertY defines if data must be stored with Y axis inverted
  12708. * @param compression defines the compression used (null by default)
  12709. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  12710. */
  12711. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, type: number): void;
  12712. /**
  12713. * Creates a new raw cube texture
  12714. * @param data defines the array of data to use to create each face
  12715. * @param size defines the size of the textures
  12716. * @param format defines the format of the data
  12717. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  12718. * @param generateMipMaps defines if the engine should generate the mip levels
  12719. * @param invertY defines if data must be stored with Y axis inverted
  12720. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  12721. * @param compression defines the compression used (null by default)
  12722. * @returns the cube texture as an InternalTexture
  12723. */
  12724. createRawCubeTexture(data: Nullable<ArrayBufferView[]>, size: number, format: number, type: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>): InternalTexture;
  12725. /**
  12726. * Update a raw cube texture
  12727. * @param texture defines the texture to udpdate
  12728. * @param data defines the data to store
  12729. * @param format defines the data format
  12730. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  12731. * @param invertY defines if data must be stored with Y axis inverted
  12732. */
  12733. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean): void;
  12734. /**
  12735. * Update a raw cube texture
  12736. * @param texture defines the texture to udpdate
  12737. * @param data defines the data to store
  12738. * @param format defines the data format
  12739. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  12740. * @param invertY defines if data must be stored with Y axis inverted
  12741. * @param compression defines the compression used (null by default)
  12742. */
  12743. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>): void;
  12744. /**
  12745. * Update a raw cube texture
  12746. * @param texture defines the texture to udpdate
  12747. * @param data defines the data to store
  12748. * @param format defines the data format
  12749. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  12750. * @param invertY defines if data must be stored with Y axis inverted
  12751. * @param compression defines the compression used (null by default)
  12752. * @param level defines which level of the texture to update
  12753. */
  12754. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>, level: number): void;
  12755. /**
  12756. * Creates a new raw cube texture from a specified url
  12757. * @param url defines the url where the data is located
  12758. * @param scene defines the current scene
  12759. * @param size defines the size of the textures
  12760. * @param format defines the format of the data
  12761. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  12762. * @param noMipmap defines if the engine should avoid generating the mip levels
  12763. * @param callback defines a callback used to extract texture data from loaded data
  12764. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  12765. * @param onLoad defines a callback called when texture is loaded
  12766. * @param onError defines a callback called if there is an error
  12767. * @returns the cube texture as an InternalTexture
  12768. */
  12769. 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;
  12770. /**
  12771. * Creates a new raw cube texture from a specified url
  12772. * @param url defines the url where the data is located
  12773. * @param scene defines the current scene
  12774. * @param size defines the size of the textures
  12775. * @param format defines the format of the data
  12776. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  12777. * @param noMipmap defines if the engine should avoid generating the mip levels
  12778. * @param callback defines a callback used to extract texture data from loaded data
  12779. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  12780. * @param onLoad defines a callback called when texture is loaded
  12781. * @param onError defines a callback called if there is an error
  12782. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  12783. * @param invertY defines if data must be stored with Y axis inverted
  12784. * @returns the cube texture as an InternalTexture
  12785. */
  12786. 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;
  12787. /**
  12788. * Creates a new raw 3D texture
  12789. * @param data defines the data used to create the texture
  12790. * @param width defines the width of the texture
  12791. * @param height defines the height of the texture
  12792. * @param depth defines the depth of the texture
  12793. * @param format defines the format of the texture
  12794. * @param generateMipMaps defines if the engine must generate mip levels
  12795. * @param invertY defines if data must be stored with Y axis inverted
  12796. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  12797. * @param compression defines the compressed used (can be null)
  12798. * @param textureType defines the compressed used (can be null)
  12799. * @returns a new raw 3D texture (stored in an InternalTexture)
  12800. */
  12801. createRawTexture3D(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  12802. /**
  12803. * Update a raw 3D texture
  12804. * @param texture defines the texture to update
  12805. * @param data defines the data to store
  12806. * @param format defines the data format
  12807. * @param invertY defines if data must be stored with Y axis inverted
  12808. */
  12809. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  12810. /**
  12811. * Update a raw 3D texture
  12812. * @param texture defines the texture to update
  12813. * @param data defines the data to store
  12814. * @param format defines the data format
  12815. * @param invertY defines if data must be stored with Y axis inverted
  12816. * @param compression defines the used compression (can be null)
  12817. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  12818. */
  12819. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  12820. /**
  12821. * Creates a new raw 2D array texture
  12822. * @param data defines the data used to create the texture
  12823. * @param width defines the width of the texture
  12824. * @param height defines the height of the texture
  12825. * @param depth defines the number of layers of the texture
  12826. * @param format defines the format of the texture
  12827. * @param generateMipMaps defines if the engine must generate mip levels
  12828. * @param invertY defines if data must be stored with Y axis inverted
  12829. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  12830. * @param compression defines the compressed used (can be null)
  12831. * @param textureType defines the compressed used (can be null)
  12832. * @returns a new raw 2D array texture (stored in an InternalTexture)
  12833. */
  12834. createRawTexture2DArray(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  12835. /**
  12836. * Update a raw 2D array texture
  12837. * @param texture defines the texture to update
  12838. * @param data defines the data to store
  12839. * @param format defines the data format
  12840. * @param invertY defines if data must be stored with Y axis inverted
  12841. */
  12842. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  12843. /**
  12844. * Update a raw 2D array texture
  12845. * @param texture defines the texture to update
  12846. * @param data defines the data to store
  12847. * @param format defines the data format
  12848. * @param invertY defines if data must be stored with Y axis inverted
  12849. * @param compression defines the used compression (can be null)
  12850. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  12851. */
  12852. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  12853. }
  12854. }
  12855. }
  12856. declare module "babylonjs/Materials/Textures/rawTexture" {
  12857. import { Scene } from "babylonjs/scene";
  12858. import { Texture } from "babylonjs/Materials/Textures/texture";
  12859. import "babylonjs/Engines/Extensions/engine.rawTexture";
  12860. /**
  12861. * Raw texture can help creating a texture directly from an array of data.
  12862. * This can be super useful if you either get the data from an uncompressed source or
  12863. * if you wish to create your texture pixel by pixel.
  12864. */
  12865. export class RawTexture extends Texture {
  12866. /**
  12867. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  12868. */
  12869. format: number;
  12870. private _engine;
  12871. /**
  12872. * Instantiates a new RawTexture.
  12873. * Raw texture can help creating a texture directly from an array of data.
  12874. * This can be super useful if you either get the data from an uncompressed source or
  12875. * if you wish to create your texture pixel by pixel.
  12876. * @param data define the array of data to use to create the texture
  12877. * @param width define the width of the texture
  12878. * @param height define the height of the texture
  12879. * @param format define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  12880. * @param scene define the scene the texture belongs to
  12881. * @param generateMipMaps define whether mip maps should be generated or not
  12882. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  12883. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  12884. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  12885. */
  12886. constructor(data: ArrayBufferView, width: number, height: number,
  12887. /**
  12888. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  12889. */
  12890. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number);
  12891. /**
  12892. * Updates the texture underlying data.
  12893. * @param data Define the new data of the texture
  12894. */
  12895. update(data: ArrayBufferView): void;
  12896. /**
  12897. * Creates a luminance texture from some data.
  12898. * @param data Define the texture data
  12899. * @param width Define the width of the texture
  12900. * @param height Define the height of the texture
  12901. * @param scene Define the scene the texture belongs to
  12902. * @param generateMipMaps Define whether or not to create mip maps for the texture
  12903. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  12904. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  12905. * @returns the luminance texture
  12906. */
  12907. static CreateLuminanceTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  12908. /**
  12909. * Creates a luminance alpha texture from some data.
  12910. * @param data Define the texture data
  12911. * @param width Define the width of the texture
  12912. * @param height Define the height of the texture
  12913. * @param scene Define the scene the texture belongs to
  12914. * @param generateMipMaps Define whether or not to create mip maps for the texture
  12915. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  12916. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  12917. * @returns the luminance alpha texture
  12918. */
  12919. static CreateLuminanceAlphaTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  12920. /**
  12921. * Creates an alpha texture from some data.
  12922. * @param data Define the texture data
  12923. * @param width Define the width of the texture
  12924. * @param height Define the height of the texture
  12925. * @param scene Define the scene the texture belongs to
  12926. * @param generateMipMaps Define whether or not to create mip maps for the texture
  12927. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  12928. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  12929. * @returns the alpha texture
  12930. */
  12931. static CreateAlphaTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  12932. /**
  12933. * Creates a RGB texture from some data.
  12934. * @param data Define the texture data
  12935. * @param width Define the width of the texture
  12936. * @param height Define the height of the texture
  12937. * @param scene Define the scene the texture belongs to
  12938. * @param generateMipMaps Define whether or not to create mip maps for the texture
  12939. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  12940. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  12941. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  12942. * @returns the RGB alpha texture
  12943. */
  12944. static CreateRGBTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  12945. /**
  12946. * Creates a RGBA texture from some data.
  12947. * @param data Define the texture data
  12948. * @param width Define the width of the texture
  12949. * @param height Define the height of the texture
  12950. * @param scene Define the scene the texture belongs to
  12951. * @param generateMipMaps Define whether or not to create mip maps for the texture
  12952. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  12953. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  12954. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  12955. * @returns the RGBA texture
  12956. */
  12957. static CreateRGBATexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  12958. /**
  12959. * Creates a R texture from some data.
  12960. * @param data Define the texture data
  12961. * @param width Define the width of the texture
  12962. * @param height Define the height of the texture
  12963. * @param scene Define the scene the texture belongs to
  12964. * @param generateMipMaps Define whether or not to create mip maps for the texture
  12965. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  12966. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  12967. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  12968. * @returns the R texture
  12969. */
  12970. static CreateRTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  12971. }
  12972. }
  12973. declare module "babylonjs/Maths/math.size" {
  12974. /**
  12975. * Interface for the size containing width and height
  12976. */
  12977. export interface ISize {
  12978. /**
  12979. * Width
  12980. */
  12981. width: number;
  12982. /**
  12983. * Heighht
  12984. */
  12985. height: number;
  12986. }
  12987. /**
  12988. * Size containing widht and height
  12989. */
  12990. export class Size implements ISize {
  12991. /**
  12992. * Width
  12993. */
  12994. width: number;
  12995. /**
  12996. * Height
  12997. */
  12998. height: number;
  12999. /**
  13000. * Creates a Size object from the given width and height (floats).
  13001. * @param width width of the new size
  13002. * @param height height of the new size
  13003. */
  13004. constructor(width: number, height: number);
  13005. /**
  13006. * Returns a string with the Size width and height
  13007. * @returns a string with the Size width and height
  13008. */
  13009. toString(): string;
  13010. /**
  13011. * "Size"
  13012. * @returns the string "Size"
  13013. */
  13014. getClassName(): string;
  13015. /**
  13016. * Returns the Size hash code.
  13017. * @returns a hash code for a unique width and height
  13018. */
  13019. getHashCode(): number;
  13020. /**
  13021. * Updates the current size from the given one.
  13022. * @param src the given size
  13023. */
  13024. copyFrom(src: Size): void;
  13025. /**
  13026. * Updates in place the current Size from the given floats.
  13027. * @param width width of the new size
  13028. * @param height height of the new size
  13029. * @returns the updated Size.
  13030. */
  13031. copyFromFloats(width: number, height: number): Size;
  13032. /**
  13033. * Updates in place the current Size from the given floats.
  13034. * @param width width to set
  13035. * @param height height to set
  13036. * @returns the updated Size.
  13037. */
  13038. set(width: number, height: number): Size;
  13039. /**
  13040. * Multiplies the width and height by numbers
  13041. * @param w factor to multiple the width by
  13042. * @param h factor to multiple the height by
  13043. * @returns a new Size set with the multiplication result of the current Size and the given floats.
  13044. */
  13045. multiplyByFloats(w: number, h: number): Size;
  13046. /**
  13047. * Clones the size
  13048. * @returns a new Size copied from the given one.
  13049. */
  13050. clone(): Size;
  13051. /**
  13052. * True if the current Size and the given one width and height are strictly equal.
  13053. * @param other the other size to compare against
  13054. * @returns True if the current Size and the given one width and height are strictly equal.
  13055. */
  13056. equals(other: Size): boolean;
  13057. /**
  13058. * The surface of the Size : width * height (float).
  13059. */
  13060. readonly surface: number;
  13061. /**
  13062. * Create a new size of zero
  13063. * @returns a new Size set to (0.0, 0.0)
  13064. */
  13065. static Zero(): Size;
  13066. /**
  13067. * Sums the width and height of two sizes
  13068. * @param otherSize size to add to this size
  13069. * @returns a new Size set as the addition result of the current Size and the given one.
  13070. */
  13071. add(otherSize: Size): Size;
  13072. /**
  13073. * Subtracts the width and height of two
  13074. * @param otherSize size to subtract to this size
  13075. * @returns a new Size set as the subtraction result of the given one from the current Size.
  13076. */
  13077. subtract(otherSize: Size): Size;
  13078. /**
  13079. * Creates a new Size set at the linear interpolation "amount" between "start" and "end"
  13080. * @param start starting size to lerp between
  13081. * @param end end size to lerp between
  13082. * @param amount amount to lerp between the start and end values
  13083. * @returns a new Size set at the linear interpolation "amount" between "start" and "end"
  13084. */
  13085. static Lerp(start: Size, end: Size, amount: number): Size;
  13086. }
  13087. }
  13088. declare module "babylonjs/Animations/runtimeAnimation" {
  13089. import { Animation, _IAnimationState } from "babylonjs/Animations/animation";
  13090. import { Animatable } from "babylonjs/Animations/animatable";
  13091. import { Scene } from "babylonjs/scene";
  13092. /**
  13093. * Defines a runtime animation
  13094. */
  13095. export class RuntimeAnimation {
  13096. private _events;
  13097. /**
  13098. * The current frame of the runtime animation
  13099. */
  13100. private _currentFrame;
  13101. /**
  13102. * The animation used by the runtime animation
  13103. */
  13104. private _animation;
  13105. /**
  13106. * The target of the runtime animation
  13107. */
  13108. private _target;
  13109. /**
  13110. * The initiating animatable
  13111. */
  13112. private _host;
  13113. /**
  13114. * The original value of the runtime animation
  13115. */
  13116. private _originalValue;
  13117. /**
  13118. * The original blend value of the runtime animation
  13119. */
  13120. private _originalBlendValue;
  13121. /**
  13122. * The offsets cache of the runtime animation
  13123. */
  13124. private _offsetsCache;
  13125. /**
  13126. * The high limits cache of the runtime animation
  13127. */
  13128. private _highLimitsCache;
  13129. /**
  13130. * Specifies if the runtime animation has been stopped
  13131. */
  13132. private _stopped;
  13133. /**
  13134. * The blending factor of the runtime animation
  13135. */
  13136. private _blendingFactor;
  13137. /**
  13138. * The BabylonJS scene
  13139. */
  13140. private _scene;
  13141. /**
  13142. * The current value of the runtime animation
  13143. */
  13144. private _currentValue;
  13145. /** @hidden */
  13146. _animationState: _IAnimationState;
  13147. /**
  13148. * The active target of the runtime animation
  13149. */
  13150. private _activeTargets;
  13151. private _currentActiveTarget;
  13152. private _directTarget;
  13153. /**
  13154. * The target path of the runtime animation
  13155. */
  13156. private _targetPath;
  13157. /**
  13158. * The weight of the runtime animation
  13159. */
  13160. private _weight;
  13161. /**
  13162. * The ratio offset of the runtime animation
  13163. */
  13164. private _ratioOffset;
  13165. /**
  13166. * The previous delay of the runtime animation
  13167. */
  13168. private _previousDelay;
  13169. /**
  13170. * The previous ratio of the runtime animation
  13171. */
  13172. private _previousRatio;
  13173. private _enableBlending;
  13174. private _keys;
  13175. private _minFrame;
  13176. private _maxFrame;
  13177. private _minValue;
  13178. private _maxValue;
  13179. private _targetIsArray;
  13180. /**
  13181. * Gets the current frame of the runtime animation
  13182. */
  13183. readonly currentFrame: number;
  13184. /**
  13185. * Gets the weight of the runtime animation
  13186. */
  13187. readonly weight: number;
  13188. /**
  13189. * Gets the current value of the runtime animation
  13190. */
  13191. readonly currentValue: any;
  13192. /**
  13193. * Gets the target path of the runtime animation
  13194. */
  13195. readonly targetPath: string;
  13196. /**
  13197. * Gets the actual target of the runtime animation
  13198. */
  13199. readonly target: any;
  13200. /** @hidden */
  13201. _onLoop: () => void;
  13202. /**
  13203. * Create a new RuntimeAnimation object
  13204. * @param target defines the target of the animation
  13205. * @param animation defines the source animation object
  13206. * @param scene defines the hosting scene
  13207. * @param host defines the initiating Animatable
  13208. */
  13209. constructor(target: any, animation: Animation, scene: Scene, host: Animatable);
  13210. private _preparePath;
  13211. /**
  13212. * Gets the animation from the runtime animation
  13213. */
  13214. readonly animation: Animation;
  13215. /**
  13216. * Resets the runtime animation to the beginning
  13217. * @param restoreOriginal defines whether to restore the target property to the original value
  13218. */
  13219. reset(restoreOriginal?: boolean): void;
  13220. /**
  13221. * Specifies if the runtime animation is stopped
  13222. * @returns Boolean specifying if the runtime animation is stopped
  13223. */
  13224. isStopped(): boolean;
  13225. /**
  13226. * Disposes of the runtime animation
  13227. */
  13228. dispose(): void;
  13229. /**
  13230. * Apply the interpolated value to the target
  13231. * @param currentValue defines the value computed by the animation
  13232. * @param weight defines the weight to apply to this value (Defaults to 1.0)
  13233. */
  13234. setValue(currentValue: any, weight: number): void;
  13235. private _getOriginalValues;
  13236. private _setValue;
  13237. /**
  13238. * Gets the loop pmode of the runtime animation
  13239. * @returns Loop Mode
  13240. */
  13241. private _getCorrectLoopMode;
  13242. /**
  13243. * Move the current animation to a given frame
  13244. * @param frame defines the frame to move to
  13245. */
  13246. goToFrame(frame: number): void;
  13247. /**
  13248. * @hidden Internal use only
  13249. */
  13250. _prepareForSpeedRatioChange(newSpeedRatio: number): void;
  13251. /**
  13252. * Execute the current animation
  13253. * @param delay defines the delay to add to the current frame
  13254. * @param from defines the lower bound of the animation range
  13255. * @param to defines the upper bound of the animation range
  13256. * @param loop defines if the current animation must loop
  13257. * @param speedRatio defines the current speed ratio
  13258. * @param weight defines the weight of the animation (default is -1 so no weight)
  13259. * @param onLoop optional callback called when animation loops
  13260. * @returns a boolean indicating if the animation is running
  13261. */
  13262. animate(delay: number, from: number, to: number, loop: boolean, speedRatio: number, weight?: number): boolean;
  13263. }
  13264. }
  13265. declare module "babylonjs/Animations/animatable" {
  13266. import { Animation } from "babylonjs/Animations/animation";
  13267. import { RuntimeAnimation } from "babylonjs/Animations/runtimeAnimation";
  13268. import { Nullable } from "babylonjs/types";
  13269. import { Observable } from "babylonjs/Misc/observable";
  13270. import { Scene } from "babylonjs/scene";
  13271. import { Matrix, Quaternion, Vector3 } from "babylonjs/Maths/math.vector";
  13272. import { Node } from "babylonjs/node";
  13273. /**
  13274. * Class used to store an actual running animation
  13275. */
  13276. export class Animatable {
  13277. /** defines the target object */
  13278. target: any;
  13279. /** defines the starting frame number (default is 0) */
  13280. fromFrame: number;
  13281. /** defines the ending frame number (default is 100) */
  13282. toFrame: number;
  13283. /** defines if the animation must loop (default is false) */
  13284. loopAnimation: boolean;
  13285. /** defines a callback to call when animation ends if it is not looping */
  13286. onAnimationEnd?: (() => void) | null | undefined;
  13287. /** defines a callback to call when animation loops */
  13288. onAnimationLoop?: (() => void) | null | undefined;
  13289. private _localDelayOffset;
  13290. private _pausedDelay;
  13291. private _runtimeAnimations;
  13292. private _paused;
  13293. private _scene;
  13294. private _speedRatio;
  13295. private _weight;
  13296. private _syncRoot;
  13297. /**
  13298. * Gets or sets a boolean indicating if the animatable must be disposed and removed at the end of the animation.
  13299. * This will only apply for non looping animation (default is true)
  13300. */
  13301. disposeOnEnd: boolean;
  13302. /**
  13303. * Gets a boolean indicating if the animation has started
  13304. */
  13305. animationStarted: boolean;
  13306. /**
  13307. * Observer raised when the animation ends
  13308. */
  13309. onAnimationEndObservable: Observable<Animatable>;
  13310. /**
  13311. * Observer raised when the animation loops
  13312. */
  13313. onAnimationLoopObservable: Observable<Animatable>;
  13314. /**
  13315. * Gets the root Animatable used to synchronize and normalize animations
  13316. */
  13317. readonly syncRoot: Nullable<Animatable>;
  13318. /**
  13319. * Gets the current frame of the first RuntimeAnimation
  13320. * Used to synchronize Animatables
  13321. */
  13322. readonly masterFrame: number;
  13323. /**
  13324. * Gets or sets the animatable weight (-1.0 by default meaning not weighted)
  13325. */
  13326. weight: number;
  13327. /**
  13328. * Gets or sets the speed ratio to apply to the animatable (1.0 by default)
  13329. */
  13330. speedRatio: number;
  13331. /**
  13332. * Creates a new Animatable
  13333. * @param scene defines the hosting scene
  13334. * @param target defines the target object
  13335. * @param fromFrame defines the starting frame number (default is 0)
  13336. * @param toFrame defines the ending frame number (default is 100)
  13337. * @param loopAnimation defines if the animation must loop (default is false)
  13338. * @param speedRatio defines the factor to apply to animation speed (default is 1)
  13339. * @param onAnimationEnd defines a callback to call when animation ends if it is not looping
  13340. * @param animations defines a group of animation to add to the new Animatable
  13341. * @param onAnimationLoop defines a callback to call when animation loops
  13342. */
  13343. constructor(scene: Scene,
  13344. /** defines the target object */
  13345. target: any,
  13346. /** defines the starting frame number (default is 0) */
  13347. fromFrame?: number,
  13348. /** defines the ending frame number (default is 100) */
  13349. toFrame?: number,
  13350. /** defines if the animation must loop (default is false) */
  13351. loopAnimation?: boolean, speedRatio?: number,
  13352. /** defines a callback to call when animation ends if it is not looping */
  13353. onAnimationEnd?: (() => void) | null | undefined, animations?: Animation[],
  13354. /** defines a callback to call when animation loops */
  13355. onAnimationLoop?: (() => void) | null | undefined);
  13356. /**
  13357. * Synchronize and normalize current Animatable with a source Animatable
  13358. * This is useful when using animation weights and when animations are not of the same length
  13359. * @param root defines the root Animatable to synchronize with
  13360. * @returns the current Animatable
  13361. */
  13362. syncWith(root: Animatable): Animatable;
  13363. /**
  13364. * Gets the list of runtime animations
  13365. * @returns an array of RuntimeAnimation
  13366. */
  13367. getAnimations(): RuntimeAnimation[];
  13368. /**
  13369. * Adds more animations to the current animatable
  13370. * @param target defines the target of the animations
  13371. * @param animations defines the new animations to add
  13372. */
  13373. appendAnimations(target: any, animations: Animation[]): void;
  13374. /**
  13375. * Gets the source animation for a specific property
  13376. * @param property defines the propertyu to look for
  13377. * @returns null or the source animation for the given property
  13378. */
  13379. getAnimationByTargetProperty(property: string): Nullable<Animation>;
  13380. /**
  13381. * Gets the runtime animation for a specific property
  13382. * @param property defines the propertyu to look for
  13383. * @returns null or the runtime animation for the given property
  13384. */
  13385. getRuntimeAnimationByTargetProperty(property: string): Nullable<RuntimeAnimation>;
  13386. /**
  13387. * Resets the animatable to its original state
  13388. */
  13389. reset(): void;
  13390. /**
  13391. * Allows the animatable to blend with current running animations
  13392. * @see http://doc.babylonjs.com/babylon101/animations#animation-blending
  13393. * @param blendingSpeed defines the blending speed to use
  13394. */
  13395. enableBlending(blendingSpeed: number): void;
  13396. /**
  13397. * Disable animation blending
  13398. * @see http://doc.babylonjs.com/babylon101/animations#animation-blending
  13399. */
  13400. disableBlending(): void;
  13401. /**
  13402. * Jump directly to a given frame
  13403. * @param frame defines the frame to jump to
  13404. */
  13405. goToFrame(frame: number): void;
  13406. /**
  13407. * Pause the animation
  13408. */
  13409. pause(): void;
  13410. /**
  13411. * Restart the animation
  13412. */
  13413. restart(): void;
  13414. private _raiseOnAnimationEnd;
  13415. /**
  13416. * Stop and delete the current animation
  13417. * @param animationName defines a string used to only stop some of the runtime animations instead of all
  13418. * @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)
  13419. */
  13420. stop(animationName?: string, targetMask?: (target: any) => boolean): void;
  13421. /**
  13422. * Wait asynchronously for the animation to end
  13423. * @returns a promise which will be fullfilled when the animation ends
  13424. */
  13425. waitAsync(): Promise<Animatable>;
  13426. /** @hidden */
  13427. _animate(delay: number): boolean;
  13428. }
  13429. module "babylonjs/scene" {
  13430. interface Scene {
  13431. /** @hidden */
  13432. _registerTargetForLateAnimationBinding(runtimeAnimation: RuntimeAnimation, originalValue: any): void;
  13433. /** @hidden */
  13434. _processLateAnimationBindingsForMatrices(holder: {
  13435. totalWeight: number;
  13436. animations: RuntimeAnimation[];
  13437. originalValue: Matrix;
  13438. }): any;
  13439. /** @hidden */
  13440. _processLateAnimationBindingsForQuaternions(holder: {
  13441. totalWeight: number;
  13442. animations: RuntimeAnimation[];
  13443. originalValue: Quaternion;
  13444. }, refQuaternion: Quaternion): Quaternion;
  13445. /** @hidden */
  13446. _processLateAnimationBindings(): void;
  13447. /**
  13448. * Will start the animation sequence of a given target
  13449. * @param target defines the target
  13450. * @param from defines from which frame should animation start
  13451. * @param to defines until which frame should animation run.
  13452. * @param weight defines the weight to apply to the animation (1.0 by default)
  13453. * @param loop defines if the animation loops
  13454. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  13455. * @param onAnimationEnd defines the function to be executed when the animation ends
  13456. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  13457. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  13458. * @param onAnimationLoop defines the callback to call when an animation loops
  13459. * @returns the animatable object created for this animation
  13460. */
  13461. beginWeightedAnimation(target: any, from: number, to: number, weight: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, animatable?: Animatable, targetMask?: (target: any) => boolean, onAnimationLoop?: () => void): Animatable;
  13462. /**
  13463. * Will start the animation sequence of a given target
  13464. * @param target defines the target
  13465. * @param from defines from which frame should animation start
  13466. * @param to defines until which frame should animation run.
  13467. * @param loop defines if the animation loops
  13468. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  13469. * @param onAnimationEnd defines the function to be executed when the animation ends
  13470. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  13471. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  13472. * @param targetMask defines if the target should be animate if animations are present (this is called recursively on descendant animatables regardless of return value)
  13473. * @param onAnimationLoop defines the callback to call when an animation loops
  13474. * @returns the animatable object created for this animation
  13475. */
  13476. beginAnimation(target: any, from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, animatable?: Animatable, stopCurrent?: boolean, targetMask?: (target: any) => boolean, onAnimationLoop?: () => void): Animatable;
  13477. /**
  13478. * Will start the animation sequence of a given target and its hierarchy
  13479. * @param target defines the target
  13480. * @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.
  13481. * @param from defines from which frame should animation start
  13482. * @param to defines until which frame should animation run.
  13483. * @param loop defines if the animation loops
  13484. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  13485. * @param onAnimationEnd defines the function to be executed when the animation ends
  13486. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  13487. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  13488. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  13489. * @param onAnimationLoop defines the callback to call when an animation loops
  13490. * @returns the list of created animatables
  13491. */
  13492. 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[];
  13493. /**
  13494. * Begin a new animation on a given node
  13495. * @param target defines the target where the animation will take place
  13496. * @param animations defines the list of animations to start
  13497. * @param from defines the initial value
  13498. * @param to defines the final value
  13499. * @param loop defines if you want animation to loop (off by default)
  13500. * @param speedRatio defines the speed ratio to apply to all animations
  13501. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  13502. * @param onAnimationLoop defines the callback to call when an animation loops
  13503. * @returns the list of created animatables
  13504. */
  13505. beginDirectAnimation(target: any, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void): Animatable;
  13506. /**
  13507. * Begin a new animation on a given node and its hierarchy
  13508. * @param target defines the root node where the animation will take place
  13509. * @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.
  13510. * @param animations defines the list of animations to start
  13511. * @param from defines the initial value
  13512. * @param to defines the final value
  13513. * @param loop defines if you want animation to loop (off by default)
  13514. * @param speedRatio defines the speed ratio to apply to all animations
  13515. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  13516. * @param onAnimationLoop defines the callback to call when an animation loops
  13517. * @returns the list of animatables created for all nodes
  13518. */
  13519. beginDirectHierarchyAnimation(target: Node, directDescendantsOnly: boolean, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void): Animatable[];
  13520. /**
  13521. * Gets the animatable associated with a specific target
  13522. * @param target defines the target of the animatable
  13523. * @returns the required animatable if found
  13524. */
  13525. getAnimatableByTarget(target: any): Nullable<Animatable>;
  13526. /**
  13527. * Gets all animatables associated with a given target
  13528. * @param target defines the target to look animatables for
  13529. * @returns an array of Animatables
  13530. */
  13531. getAllAnimatablesByTarget(target: any): Array<Animatable>;
  13532. /**
  13533. * Stops and removes all animations that have been applied to the scene
  13534. */
  13535. stopAllAnimations(): void;
  13536. /**
  13537. * Gets the current delta time used by animation engine
  13538. */
  13539. deltaTime: number;
  13540. }
  13541. }
  13542. module "babylonjs/Bones/bone" {
  13543. interface Bone {
  13544. /**
  13545. * Copy an animation range from another bone
  13546. * @param source defines the source bone
  13547. * @param rangeName defines the range name to copy
  13548. * @param frameOffset defines the frame offset
  13549. * @param rescaleAsRequired defines if rescaling must be applied if required
  13550. * @param skelDimensionsRatio defines the scaling ratio
  13551. * @returns true if operation was successful
  13552. */
  13553. copyAnimationRange(source: Bone, rangeName: string, frameOffset: number, rescaleAsRequired: boolean, skelDimensionsRatio: Nullable<Vector3>): boolean;
  13554. }
  13555. }
  13556. }
  13557. declare module "babylonjs/Animations/animationPropertiesOverride" {
  13558. /**
  13559. * Class used to override all child animations of a given target
  13560. */
  13561. export class AnimationPropertiesOverride {
  13562. /**
  13563. * Gets or sets a value indicating if animation blending must be used
  13564. */
  13565. enableBlending: boolean;
  13566. /**
  13567. * Gets or sets the blending speed to use when enableBlending is true
  13568. */
  13569. blendingSpeed: number;
  13570. /**
  13571. * Gets or sets the default loop mode to use
  13572. */
  13573. loopMode: number;
  13574. }
  13575. }
  13576. declare module "babylonjs/Bones/skeleton" {
  13577. import { Bone } from "babylonjs/Bones/bone";
  13578. import { Observable } from "babylonjs/Misc/observable";
  13579. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  13580. import { Scene } from "babylonjs/scene";
  13581. import { Nullable } from "babylonjs/types";
  13582. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  13583. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  13584. import { Animatable } from "babylonjs/Animations/animatable";
  13585. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  13586. import { Animation } from "babylonjs/Animations/animation";
  13587. import { AnimationRange } from "babylonjs/Animations/animationRange";
  13588. import { IInspectable } from "babylonjs/Misc/iInspectable";
  13589. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  13590. /**
  13591. * Class used to handle skinning animations
  13592. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  13593. */
  13594. export class Skeleton implements IAnimatable {
  13595. /** defines the skeleton name */
  13596. name: string;
  13597. /** defines the skeleton Id */
  13598. id: string;
  13599. /**
  13600. * Defines the list of child bones
  13601. */
  13602. bones: Bone[];
  13603. /**
  13604. * Defines an estimate of the dimension of the skeleton at rest
  13605. */
  13606. dimensionsAtRest: Vector3;
  13607. /**
  13608. * Defines a boolean indicating if the root matrix is provided by meshes or by the current skeleton (this is the default value)
  13609. */
  13610. needInitialSkinMatrix: boolean;
  13611. /**
  13612. * Defines a mesh that override the matrix used to get the world matrix (null by default).
  13613. */
  13614. overrideMesh: Nullable<AbstractMesh>;
  13615. /**
  13616. * Gets the list of animations attached to this skeleton
  13617. */
  13618. animations: Array<Animation>;
  13619. private _scene;
  13620. private _isDirty;
  13621. private _transformMatrices;
  13622. private _transformMatrixTexture;
  13623. private _meshesWithPoseMatrix;
  13624. private _animatables;
  13625. private _identity;
  13626. private _synchronizedWithMesh;
  13627. private _ranges;
  13628. private _lastAbsoluteTransformsUpdateId;
  13629. private _canUseTextureForBones;
  13630. private _uniqueId;
  13631. /** @hidden */
  13632. _numBonesWithLinkedTransformNode: number;
  13633. /** @hidden */
  13634. _hasWaitingData: Nullable<boolean>;
  13635. /**
  13636. * Specifies if the skeleton should be serialized
  13637. */
  13638. doNotSerialize: boolean;
  13639. private _useTextureToStoreBoneMatrices;
  13640. /**
  13641. * Gets or sets a boolean indicating that bone matrices should be stored as a texture instead of using shader uniforms (default is true).
  13642. * Please note that this option is not available if the hardware does not support it
  13643. */
  13644. useTextureToStoreBoneMatrices: boolean;
  13645. private _animationPropertiesOverride;
  13646. /**
  13647. * Gets or sets the animation properties override
  13648. */
  13649. animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  13650. /**
  13651. * List of inspectable custom properties (used by the Inspector)
  13652. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  13653. */
  13654. inspectableCustomProperties: IInspectable[];
  13655. /**
  13656. * An observable triggered before computing the skeleton's matrices
  13657. */
  13658. onBeforeComputeObservable: Observable<Skeleton>;
  13659. /**
  13660. * Gets a boolean indicating that the skeleton effectively stores matrices into a texture
  13661. */
  13662. readonly isUsingTextureForMatrices: boolean;
  13663. /**
  13664. * Gets the unique ID of this skeleton
  13665. */
  13666. readonly uniqueId: number;
  13667. /**
  13668. * Creates a new skeleton
  13669. * @param name defines the skeleton name
  13670. * @param id defines the skeleton Id
  13671. * @param scene defines the hosting scene
  13672. */
  13673. constructor(
  13674. /** defines the skeleton name */
  13675. name: string,
  13676. /** defines the skeleton Id */
  13677. id: string, scene: Scene);
  13678. /**
  13679. * Gets the current object class name.
  13680. * @return the class name
  13681. */
  13682. getClassName(): string;
  13683. /**
  13684. * Returns an array containing the root bones
  13685. * @returns an array containing the root bones
  13686. */
  13687. getChildren(): Array<Bone>;
  13688. /**
  13689. * Gets the list of transform matrices to send to shaders (one matrix per bone)
  13690. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  13691. * @returns a Float32Array containing matrices data
  13692. */
  13693. getTransformMatrices(mesh: AbstractMesh): Float32Array;
  13694. /**
  13695. * Gets the list of transform matrices to send to shaders inside a texture (one matrix per bone)
  13696. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  13697. * @returns a raw texture containing the data
  13698. */
  13699. getTransformMatrixTexture(mesh: AbstractMesh): Nullable<RawTexture>;
  13700. /**
  13701. * Gets the current hosting scene
  13702. * @returns a scene object
  13703. */
  13704. getScene(): Scene;
  13705. /**
  13706. * Gets a string representing the current skeleton data
  13707. * @param fullDetails defines a boolean indicating if we want a verbose version
  13708. * @returns a string representing the current skeleton data
  13709. */
  13710. toString(fullDetails?: boolean): string;
  13711. /**
  13712. * Get bone's index searching by name
  13713. * @param name defines bone's name to search for
  13714. * @return the indice of the bone. Returns -1 if not found
  13715. */
  13716. getBoneIndexByName(name: string): number;
  13717. /**
  13718. * Creater a new animation range
  13719. * @param name defines the name of the range
  13720. * @param from defines the start key
  13721. * @param to defines the end key
  13722. */
  13723. createAnimationRange(name: string, from: number, to: number): void;
  13724. /**
  13725. * Delete a specific animation range
  13726. * @param name defines the name of the range
  13727. * @param deleteFrames defines if frames must be removed as well
  13728. */
  13729. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  13730. /**
  13731. * Gets a specific animation range
  13732. * @param name defines the name of the range to look for
  13733. * @returns the requested animation range or null if not found
  13734. */
  13735. getAnimationRange(name: string): Nullable<AnimationRange>;
  13736. /**
  13737. * Gets the list of all animation ranges defined on this skeleton
  13738. * @returns an array
  13739. */
  13740. getAnimationRanges(): Nullable<AnimationRange>[];
  13741. /**
  13742. * Copy animation range from a source skeleton.
  13743. * This is not for a complete retargeting, only between very similar skeleton's with only possible bone length differences
  13744. * @param source defines the source skeleton
  13745. * @param name defines the name of the range to copy
  13746. * @param rescaleAsRequired defines if rescaling must be applied if required
  13747. * @returns true if operation was successful
  13748. */
  13749. copyAnimationRange(source: Skeleton, name: string, rescaleAsRequired?: boolean): boolean;
  13750. /**
  13751. * Forces the skeleton to go to rest pose
  13752. */
  13753. returnToRest(): void;
  13754. private _getHighestAnimationFrame;
  13755. /**
  13756. * Begin a specific animation range
  13757. * @param name defines the name of the range to start
  13758. * @param loop defines if looping must be turned on (false by default)
  13759. * @param speedRatio defines the speed ratio to apply (1 by default)
  13760. * @param onAnimationEnd defines a callback which will be called when animation will end
  13761. * @returns a new animatable
  13762. */
  13763. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  13764. /** @hidden */
  13765. _markAsDirty(): void;
  13766. /** @hidden */
  13767. _registerMeshWithPoseMatrix(mesh: AbstractMesh): void;
  13768. /** @hidden */
  13769. _unregisterMeshWithPoseMatrix(mesh: AbstractMesh): void;
  13770. private _computeTransformMatrices;
  13771. /**
  13772. * Build all resources required to render a skeleton
  13773. */
  13774. prepare(): void;
  13775. /**
  13776. * Gets the list of animatables currently running for this skeleton
  13777. * @returns an array of animatables
  13778. */
  13779. getAnimatables(): IAnimatable[];
  13780. /**
  13781. * Clone the current skeleton
  13782. * @param name defines the name of the new skeleton
  13783. * @param id defines the id of the new skeleton
  13784. * @returns the new skeleton
  13785. */
  13786. clone(name: string, id?: string): Skeleton;
  13787. /**
  13788. * Enable animation blending for this skeleton
  13789. * @param blendingSpeed defines the blending speed to apply
  13790. * @see http://doc.babylonjs.com/babylon101/animations#animation-blending
  13791. */
  13792. enableBlending(blendingSpeed?: number): void;
  13793. /**
  13794. * Releases all resources associated with the current skeleton
  13795. */
  13796. dispose(): void;
  13797. /**
  13798. * Serialize the skeleton in a JSON object
  13799. * @returns a JSON object
  13800. */
  13801. serialize(): any;
  13802. /**
  13803. * Creates a new skeleton from serialized data
  13804. * @param parsedSkeleton defines the serialized data
  13805. * @param scene defines the hosting scene
  13806. * @returns a new skeleton
  13807. */
  13808. static Parse(parsedSkeleton: any, scene: Scene): Skeleton;
  13809. /**
  13810. * Compute all node absolute transforms
  13811. * @param forceUpdate defines if computation must be done even if cache is up to date
  13812. */
  13813. computeAbsoluteTransforms(forceUpdate?: boolean): void;
  13814. /**
  13815. * Gets the root pose matrix
  13816. * @returns a matrix
  13817. */
  13818. getPoseMatrix(): Nullable<Matrix>;
  13819. /**
  13820. * Sorts bones per internal index
  13821. */
  13822. sortBones(): void;
  13823. private _sortBones;
  13824. }
  13825. }
  13826. declare module "babylonjs/Bones/bone" {
  13827. import { Skeleton } from "babylonjs/Bones/skeleton";
  13828. import { Vector3, Quaternion, Matrix } from "babylonjs/Maths/math.vector";
  13829. import { Nullable } from "babylonjs/types";
  13830. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  13831. import { TransformNode } from "babylonjs/Meshes/transformNode";
  13832. import { Node } from "babylonjs/node";
  13833. import { Space } from "babylonjs/Maths/math.axis";
  13834. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  13835. /**
  13836. * Class used to store bone information
  13837. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  13838. */
  13839. export class Bone extends Node {
  13840. /**
  13841. * defines the bone name
  13842. */
  13843. name: string;
  13844. private static _tmpVecs;
  13845. private static _tmpQuat;
  13846. private static _tmpMats;
  13847. /**
  13848. * Gets the list of child bones
  13849. */
  13850. children: Bone[];
  13851. /** Gets the animations associated with this bone */
  13852. animations: import("babylonjs/Animations/animation").Animation[];
  13853. /**
  13854. * Gets or sets bone length
  13855. */
  13856. length: number;
  13857. /**
  13858. * @hidden Internal only
  13859. * Set this value to map this bone to a different index in the transform matrices
  13860. * Set this value to -1 to exclude the bone from the transform matrices
  13861. */
  13862. _index: Nullable<number>;
  13863. private _skeleton;
  13864. private _localMatrix;
  13865. private _restPose;
  13866. private _baseMatrix;
  13867. private _absoluteTransform;
  13868. private _invertedAbsoluteTransform;
  13869. private _parent;
  13870. private _scalingDeterminant;
  13871. private _worldTransform;
  13872. private _localScaling;
  13873. private _localRotation;
  13874. private _localPosition;
  13875. private _needToDecompose;
  13876. private _needToCompose;
  13877. /** @hidden */
  13878. _linkedTransformNode: Nullable<TransformNode>;
  13879. /** @hidden */
  13880. _waitingTransformNodeId: Nullable<string>;
  13881. /** @hidden */
  13882. /** @hidden */
  13883. _matrix: Matrix;
  13884. /**
  13885. * Create a new bone
  13886. * @param name defines the bone name
  13887. * @param skeleton defines the parent skeleton
  13888. * @param parentBone defines the parent (can be null if the bone is the root)
  13889. * @param localMatrix defines the local matrix
  13890. * @param restPose defines the rest pose matrix
  13891. * @param baseMatrix defines the base matrix
  13892. * @param index defines index of the bone in the hiearchy
  13893. */
  13894. constructor(
  13895. /**
  13896. * defines the bone name
  13897. */
  13898. name: string, skeleton: Skeleton, parentBone?: Nullable<Bone>, localMatrix?: Nullable<Matrix>, restPose?: Nullable<Matrix>, baseMatrix?: Nullable<Matrix>, index?: Nullable<number>);
  13899. /**
  13900. * Gets the current object class name.
  13901. * @return the class name
  13902. */
  13903. getClassName(): string;
  13904. /**
  13905. * Gets the parent skeleton
  13906. * @returns a skeleton
  13907. */
  13908. getSkeleton(): Skeleton;
  13909. /**
  13910. * Gets parent bone
  13911. * @returns a bone or null if the bone is the root of the bone hierarchy
  13912. */
  13913. getParent(): Nullable<Bone>;
  13914. /**
  13915. * Returns an array containing the root bones
  13916. * @returns an array containing the root bones
  13917. */
  13918. getChildren(): Array<Bone>;
  13919. /**
  13920. * Gets the node index in matrix array generated for rendering
  13921. * @returns the node index
  13922. */
  13923. getIndex(): number;
  13924. /**
  13925. * Sets the parent bone
  13926. * @param parent defines the parent (can be null if the bone is the root)
  13927. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  13928. */
  13929. setParent(parent: Nullable<Bone>, updateDifferenceMatrix?: boolean): void;
  13930. /**
  13931. * Gets the local matrix
  13932. * @returns a matrix
  13933. */
  13934. getLocalMatrix(): Matrix;
  13935. /**
  13936. * Gets the base matrix (initial matrix which remains unchanged)
  13937. * @returns a matrix
  13938. */
  13939. getBaseMatrix(): Matrix;
  13940. /**
  13941. * Gets the rest pose matrix
  13942. * @returns a matrix
  13943. */
  13944. getRestPose(): Matrix;
  13945. /**
  13946. * Gets a matrix used to store world matrix (ie. the matrix sent to shaders)
  13947. */
  13948. getWorldMatrix(): Matrix;
  13949. /**
  13950. * Sets the local matrix to rest pose matrix
  13951. */
  13952. returnToRest(): void;
  13953. /**
  13954. * Gets the inverse of the absolute transform matrix.
  13955. * This matrix will be multiplied by local matrix to get the difference matrix (ie. the difference between original state and current state)
  13956. * @returns a matrix
  13957. */
  13958. getInvertedAbsoluteTransform(): Matrix;
  13959. /**
  13960. * Gets the absolute transform matrix (ie base matrix * parent world matrix)
  13961. * @returns a matrix
  13962. */
  13963. getAbsoluteTransform(): Matrix;
  13964. /**
  13965. * Links with the given transform node.
  13966. * The local matrix of this bone is copied from the transform node every frame.
  13967. * @param transformNode defines the transform node to link to
  13968. */
  13969. linkTransformNode(transformNode: Nullable<TransformNode>): void;
  13970. /**
  13971. * Gets the node used to drive the bone's transformation
  13972. * @returns a transform node or null
  13973. */
  13974. getTransformNode(): Nullable<TransformNode>;
  13975. /** Gets or sets current position (in local space) */
  13976. position: Vector3;
  13977. /** Gets or sets current rotation (in local space) */
  13978. rotation: Vector3;
  13979. /** Gets or sets current rotation quaternion (in local space) */
  13980. rotationQuaternion: Quaternion;
  13981. /** Gets or sets current scaling (in local space) */
  13982. scaling: Vector3;
  13983. /**
  13984. * Gets the animation properties override
  13985. */
  13986. readonly animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  13987. private _decompose;
  13988. private _compose;
  13989. /**
  13990. * Update the base and local matrices
  13991. * @param matrix defines the new base or local matrix
  13992. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  13993. * @param updateLocalMatrix defines if the local matrix should be updated
  13994. */
  13995. updateMatrix(matrix: Matrix, updateDifferenceMatrix?: boolean, updateLocalMatrix?: boolean): void;
  13996. /** @hidden */
  13997. _updateDifferenceMatrix(rootMatrix?: Matrix, updateChildren?: boolean): void;
  13998. /**
  13999. * Flag the bone as dirty (Forcing it to update everything)
  14000. */
  14001. markAsDirty(): void;
  14002. /** @hidden */
  14003. _markAsDirtyAndCompose(): void;
  14004. private _markAsDirtyAndDecompose;
  14005. /**
  14006. * Translate the bone in local or world space
  14007. * @param vec The amount to translate the bone
  14008. * @param space The space that the translation is in
  14009. * @param mesh The mesh that this bone is attached to. This is only used in world space
  14010. */
  14011. translate(vec: Vector3, space?: Space, mesh?: AbstractMesh): void;
  14012. /**
  14013. * Set the postion of the bone in local or world space
  14014. * @param position The position to set the bone
  14015. * @param space The space that the position is in
  14016. * @param mesh The mesh that this bone is attached to. This is only used in world space
  14017. */
  14018. setPosition(position: Vector3, space?: Space, mesh?: AbstractMesh): void;
  14019. /**
  14020. * Set the absolute position of the bone (world space)
  14021. * @param position The position to set the bone
  14022. * @param mesh The mesh that this bone is attached to
  14023. */
  14024. setAbsolutePosition(position: Vector3, mesh?: AbstractMesh): void;
  14025. /**
  14026. * Scale the bone on the x, y and z axes (in local space)
  14027. * @param x The amount to scale the bone on the x axis
  14028. * @param y The amount to scale the bone on the y axis
  14029. * @param z The amount to scale the bone on the z axis
  14030. * @param scaleChildren sets this to true if children of the bone should be scaled as well (false by default)
  14031. */
  14032. scale(x: number, y: number, z: number, scaleChildren?: boolean): void;
  14033. /**
  14034. * Set the bone scaling in local space
  14035. * @param scale defines the scaling vector
  14036. */
  14037. setScale(scale: Vector3): void;
  14038. /**
  14039. * Gets the current scaling in local space
  14040. * @returns the current scaling vector
  14041. */
  14042. getScale(): Vector3;
  14043. /**
  14044. * Gets the current scaling in local space and stores it in a target vector
  14045. * @param result defines the target vector
  14046. */
  14047. getScaleToRef(result: Vector3): void;
  14048. /**
  14049. * Set the yaw, pitch, and roll of the bone in local or world space
  14050. * @param yaw The rotation of the bone on the y axis
  14051. * @param pitch The rotation of the bone on the x axis
  14052. * @param roll The rotation of the bone on the z axis
  14053. * @param space The space that the axes of rotation are in
  14054. * @param mesh The mesh that this bone is attached to. This is only used in world space
  14055. */
  14056. setYawPitchRoll(yaw: number, pitch: number, roll: number, space?: Space, mesh?: AbstractMesh): void;
  14057. /**
  14058. * Add a rotation to the bone on an axis in local or world space
  14059. * @param axis The axis to rotate the bone on
  14060. * @param amount The amount to rotate the bone
  14061. * @param space The space that the axis is in
  14062. * @param mesh The mesh that this bone is attached to. This is only used in world space
  14063. */
  14064. rotate(axis: Vector3, amount: number, space?: Space, mesh?: AbstractMesh): void;
  14065. /**
  14066. * Set the rotation of the bone to a particular axis angle in local or world space
  14067. * @param axis The axis to rotate the bone on
  14068. * @param angle The angle that the bone should be rotated to
  14069. * @param space The space that the axis is in
  14070. * @param mesh The mesh that this bone is attached to. This is only used in world space
  14071. */
  14072. setAxisAngle(axis: Vector3, angle: number, space?: Space, mesh?: AbstractMesh): void;
  14073. /**
  14074. * Set the euler rotation of the bone in local of world space
  14075. * @param rotation The euler rotation that the bone should be set to
  14076. * @param space The space that the rotation is in
  14077. * @param mesh The mesh that this bone is attached to. This is only used in world space
  14078. */
  14079. setRotation(rotation: Vector3, space?: Space, mesh?: AbstractMesh): void;
  14080. /**
  14081. * Set the quaternion rotation of the bone in local of world space
  14082. * @param quat The quaternion rotation that the bone should be set to
  14083. * @param space The space that the rotation is in
  14084. * @param mesh The mesh that this bone is attached to. This is only used in world space
  14085. */
  14086. setRotationQuaternion(quat: Quaternion, space?: Space, mesh?: AbstractMesh): void;
  14087. /**
  14088. * Set the rotation matrix of the bone in local of world space
  14089. * @param rotMat The rotation matrix that the bone should be set to
  14090. * @param space The space that the rotation is in
  14091. * @param mesh The mesh that this bone is attached to. This is only used in world space
  14092. */
  14093. setRotationMatrix(rotMat: Matrix, space?: Space, mesh?: AbstractMesh): void;
  14094. private _rotateWithMatrix;
  14095. private _getNegativeRotationToRef;
  14096. /**
  14097. * Get the position of the bone in local or world space
  14098. * @param space The space that the returned position is in
  14099. * @param mesh The mesh that this bone is attached to. This is only used in world space
  14100. * @returns The position of the bone
  14101. */
  14102. getPosition(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  14103. /**
  14104. * Copy the position of the bone to a vector3 in local or world space
  14105. * @param space The space that the returned position is in
  14106. * @param mesh The mesh that this bone is attached to. This is only used in world space
  14107. * @param result The vector3 to copy the position to
  14108. */
  14109. getPositionToRef(space: Space | undefined, mesh: Nullable<AbstractMesh>, result: Vector3): void;
  14110. /**
  14111. * Get the absolute position of the bone (world space)
  14112. * @param mesh The mesh that this bone is attached to
  14113. * @returns The absolute position of the bone
  14114. */
  14115. getAbsolutePosition(mesh?: Nullable<AbstractMesh>): Vector3;
  14116. /**
  14117. * Copy the absolute position of the bone (world space) to the result param
  14118. * @param mesh The mesh that this bone is attached to
  14119. * @param result The vector3 to copy the absolute position to
  14120. */
  14121. getAbsolutePositionToRef(mesh: AbstractMesh, result: Vector3): void;
  14122. /**
  14123. * Compute the absolute transforms of this bone and its children
  14124. */
  14125. computeAbsoluteTransforms(): void;
  14126. /**
  14127. * Get the world direction from an axis that is in the local space of the bone
  14128. * @param localAxis The local direction that is used to compute the world direction
  14129. * @param mesh The mesh that this bone is attached to
  14130. * @returns The world direction
  14131. */
  14132. getDirection(localAxis: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  14133. /**
  14134. * Copy the world direction to a vector3 from an axis that is in the local space of the bone
  14135. * @param localAxis The local direction that is used to compute the world direction
  14136. * @param mesh The mesh that this bone is attached to
  14137. * @param result The vector3 that the world direction will be copied to
  14138. */
  14139. getDirectionToRef(localAxis: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  14140. /**
  14141. * Get the euler rotation of the bone in local or world space
  14142. * @param space The space that the rotation should be in
  14143. * @param mesh The mesh that this bone is attached to. This is only used in world space
  14144. * @returns The euler rotation
  14145. */
  14146. getRotation(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  14147. /**
  14148. * Copy the euler rotation of the bone to a vector3. The rotation can be in either local or world space
  14149. * @param space The space that the rotation should be in
  14150. * @param mesh The mesh that this bone is attached to. This is only used in world space
  14151. * @param result The vector3 that the rotation should be copied to
  14152. */
  14153. getRotationToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  14154. /**
  14155. * Get the quaternion rotation of the bone in either local or world space
  14156. * @param space The space that the rotation should be in
  14157. * @param mesh The mesh that this bone is attached to. This is only used in world space
  14158. * @returns The quaternion rotation
  14159. */
  14160. getRotationQuaternion(space?: Space, mesh?: Nullable<AbstractMesh>): Quaternion;
  14161. /**
  14162. * Copy the quaternion rotation of the bone to a quaternion. The rotation can be in either local or world space
  14163. * @param space The space that the rotation should be in
  14164. * @param mesh The mesh that this bone is attached to. This is only used in world space
  14165. * @param result The quaternion that the rotation should be copied to
  14166. */
  14167. getRotationQuaternionToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Quaternion): void;
  14168. /**
  14169. * Get the rotation matrix of the bone in local or world space
  14170. * @param space The space that the rotation should be in
  14171. * @param mesh The mesh that this bone is attached to. This is only used in world space
  14172. * @returns The rotation matrix
  14173. */
  14174. getRotationMatrix(space: Space | undefined, mesh: AbstractMesh): Matrix;
  14175. /**
  14176. * Copy the rotation matrix of the bone to a matrix. The rotation can be in either local or world space
  14177. * @param space The space that the rotation should be in
  14178. * @param mesh The mesh that this bone is attached to. This is only used in world space
  14179. * @param result The quaternion that the rotation should be copied to
  14180. */
  14181. getRotationMatrixToRef(space: Space | undefined, mesh: AbstractMesh, result: Matrix): void;
  14182. /**
  14183. * Get the world position of a point that is in the local space of the bone
  14184. * @param position The local position
  14185. * @param mesh The mesh that this bone is attached to
  14186. * @returns The world position
  14187. */
  14188. getAbsolutePositionFromLocal(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  14189. /**
  14190. * Get the world position of a point that is in the local space of the bone and copy it to the result param
  14191. * @param position The local position
  14192. * @param mesh The mesh that this bone is attached to
  14193. * @param result The vector3 that the world position should be copied to
  14194. */
  14195. getAbsolutePositionFromLocalToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  14196. /**
  14197. * Get the local position of a point that is in world space
  14198. * @param position The world position
  14199. * @param mesh The mesh that this bone is attached to
  14200. * @returns The local position
  14201. */
  14202. getLocalPositionFromAbsolute(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  14203. /**
  14204. * Get the local position of a point that is in world space and copy it to the result param
  14205. * @param position The world position
  14206. * @param mesh The mesh that this bone is attached to
  14207. * @param result The vector3 that the local position should be copied to
  14208. */
  14209. getLocalPositionFromAbsoluteToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  14210. }
  14211. }
  14212. declare module "babylonjs/Meshes/transformNode" {
  14213. import { DeepImmutable } from "babylonjs/types";
  14214. import { Observable } from "babylonjs/Misc/observable";
  14215. import { Nullable } from "babylonjs/types";
  14216. import { Camera } from "babylonjs/Cameras/camera";
  14217. import { Scene } from "babylonjs/scene";
  14218. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  14219. import { Node } from "babylonjs/node";
  14220. import { Bone } from "babylonjs/Bones/bone";
  14221. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  14222. import { Space } from "babylonjs/Maths/math.axis";
  14223. /**
  14224. * 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.
  14225. * @see https://doc.babylonjs.com/how_to/transformnode
  14226. */
  14227. export class TransformNode extends Node {
  14228. /**
  14229. * Object will not rotate to face the camera
  14230. */
  14231. static BILLBOARDMODE_NONE: number;
  14232. /**
  14233. * Object will rotate to face the camera but only on the x axis
  14234. */
  14235. static BILLBOARDMODE_X: number;
  14236. /**
  14237. * Object will rotate to face the camera but only on the y axis
  14238. */
  14239. static BILLBOARDMODE_Y: number;
  14240. /**
  14241. * Object will rotate to face the camera but only on the z axis
  14242. */
  14243. static BILLBOARDMODE_Z: number;
  14244. /**
  14245. * Object will rotate to face the camera
  14246. */
  14247. static BILLBOARDMODE_ALL: number;
  14248. /**
  14249. * Object will rotate to face the camera's position instead of orientation
  14250. */
  14251. static BILLBOARDMODE_USE_POSITION: number;
  14252. private _forward;
  14253. private _forwardInverted;
  14254. private _up;
  14255. private _right;
  14256. private _rightInverted;
  14257. private _position;
  14258. private _rotation;
  14259. private _rotationQuaternion;
  14260. protected _scaling: Vector3;
  14261. protected _isDirty: boolean;
  14262. private _transformToBoneReferal;
  14263. private _isAbsoluteSynced;
  14264. private _billboardMode;
  14265. /**
  14266. * Gets or sets the billboard mode. Default is 0.
  14267. *
  14268. * | Value | Type | Description |
  14269. * | --- | --- | --- |
  14270. * | 0 | BILLBOARDMODE_NONE | |
  14271. * | 1 | BILLBOARDMODE_X | |
  14272. * | 2 | BILLBOARDMODE_Y | |
  14273. * | 4 | BILLBOARDMODE_Z | |
  14274. * | 7 | BILLBOARDMODE_ALL | |
  14275. *
  14276. */
  14277. billboardMode: number;
  14278. private _preserveParentRotationForBillboard;
  14279. /**
  14280. * Gets or sets a boolean indicating that parent rotation should be preserved when using billboards.
  14281. * This could be useful for glTF objects where parent rotation helps converting from right handed to left handed
  14282. */
  14283. preserveParentRotationForBillboard: boolean;
  14284. /**
  14285. * 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
  14286. */
  14287. scalingDeterminant: number;
  14288. private _infiniteDistance;
  14289. /**
  14290. * Gets or sets the distance of the object to max, often used by skybox
  14291. */
  14292. infiniteDistance: boolean;
  14293. /**
  14294. * Gets or sets a boolean indicating that non uniform scaling (when at least one component is different from others) should be ignored.
  14295. * By default the system will update normals to compensate
  14296. */
  14297. ignoreNonUniformScaling: boolean;
  14298. /**
  14299. * 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
  14300. */
  14301. reIntegrateRotationIntoRotationQuaternion: boolean;
  14302. /** @hidden */
  14303. _poseMatrix: Nullable<Matrix>;
  14304. /** @hidden */
  14305. _localMatrix: Matrix;
  14306. private _usePivotMatrix;
  14307. private _absolutePosition;
  14308. private _absoluteScaling;
  14309. private _absoluteRotationQuaternion;
  14310. private _pivotMatrix;
  14311. private _pivotMatrixInverse;
  14312. protected _postMultiplyPivotMatrix: boolean;
  14313. protected _isWorldMatrixFrozen: boolean;
  14314. /** @hidden */
  14315. _indexInSceneTransformNodesArray: number;
  14316. /**
  14317. * An event triggered after the world matrix is updated
  14318. */
  14319. onAfterWorldMatrixUpdateObservable: Observable<TransformNode>;
  14320. constructor(name: string, scene?: Nullable<Scene>, isPure?: boolean);
  14321. /**
  14322. * Gets a string identifying the name of the class
  14323. * @returns "TransformNode" string
  14324. */
  14325. getClassName(): string;
  14326. /**
  14327. * Gets or set the node position (default is (0.0, 0.0, 0.0))
  14328. */
  14329. position: Vector3;
  14330. /**
  14331. * 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)).
  14332. * If rotation quaternion is set, this Vector3 will be ignored and copy from the quaternion
  14333. */
  14334. rotation: Vector3;
  14335. /**
  14336. * 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)).
  14337. */
  14338. scaling: Vector3;
  14339. /**
  14340. * 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).
  14341. * If set, only the rotationQuaternion is then used to compute the node rotation (ie. node.rotation will be ignored)
  14342. */
  14343. rotationQuaternion: Nullable<Quaternion>;
  14344. /**
  14345. * The forward direction of that transform in world space.
  14346. */
  14347. readonly forward: Vector3;
  14348. /**
  14349. * The up direction of that transform in world space.
  14350. */
  14351. readonly up: Vector3;
  14352. /**
  14353. * The right direction of that transform in world space.
  14354. */
  14355. readonly right: Vector3;
  14356. /**
  14357. * Copies the parameter passed Matrix into the mesh Pose matrix.
  14358. * @param matrix the matrix to copy the pose from
  14359. * @returns this TransformNode.
  14360. */
  14361. updatePoseMatrix(matrix: Matrix): TransformNode;
  14362. /**
  14363. * Returns the mesh Pose matrix.
  14364. * @returns the pose matrix
  14365. */
  14366. getPoseMatrix(): Matrix;
  14367. /** @hidden */
  14368. _isSynchronized(): boolean;
  14369. /** @hidden */
  14370. _initCache(): void;
  14371. /**
  14372. * Flag the transform node as dirty (Forcing it to update everything)
  14373. * @param property if set to "rotation" the objects rotationQuaternion will be set to null
  14374. * @returns this transform node
  14375. */
  14376. markAsDirty(property: string): TransformNode;
  14377. /**
  14378. * Returns the current mesh absolute position.
  14379. * Returns a Vector3.
  14380. */
  14381. readonly absolutePosition: Vector3;
  14382. /**
  14383. * Returns the current mesh absolute scaling.
  14384. * Returns a Vector3.
  14385. */
  14386. readonly absoluteScaling: Vector3;
  14387. /**
  14388. * Returns the current mesh absolute rotation.
  14389. * Returns a Quaternion.
  14390. */
  14391. readonly absoluteRotationQuaternion: Quaternion;
  14392. /**
  14393. * Sets a new matrix to apply before all other transformation
  14394. * @param matrix defines the transform matrix
  14395. * @returns the current TransformNode
  14396. */
  14397. setPreTransformMatrix(matrix: Matrix): TransformNode;
  14398. /**
  14399. * Sets a new pivot matrix to the current node
  14400. * @param matrix defines the new pivot matrix to use
  14401. * @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
  14402. * @returns the current TransformNode
  14403. */
  14404. setPivotMatrix(matrix: DeepImmutable<Matrix>, postMultiplyPivotMatrix?: boolean): TransformNode;
  14405. /**
  14406. * Returns the mesh pivot matrix.
  14407. * Default : Identity.
  14408. * @returns the matrix
  14409. */
  14410. getPivotMatrix(): Matrix;
  14411. /**
  14412. * Instantiate (when possible) or clone that node with its hierarchy
  14413. * @param newParent defines the new parent to use for the instance (or clone)
  14414. * @param options defines options to configure how copy is done
  14415. * @param onNewNodeCreated defines an option callback to call when a clone or an instance is created
  14416. * @returns an instance (or a clone) of the current node with its hiearchy
  14417. */
  14418. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  14419. doNotInstantiate: boolean;
  14420. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  14421. /**
  14422. * Prevents the World matrix to be computed any longer
  14423. * @param newWorldMatrix defines an optional matrix to use as world matrix
  14424. * @returns the TransformNode.
  14425. */
  14426. freezeWorldMatrix(newWorldMatrix?: Nullable<Matrix>): TransformNode;
  14427. /**
  14428. * Allows back the World matrix computation.
  14429. * @returns the TransformNode.
  14430. */
  14431. unfreezeWorldMatrix(): this;
  14432. /**
  14433. * True if the World matrix has been frozen.
  14434. */
  14435. readonly isWorldMatrixFrozen: boolean;
  14436. /**
  14437. * Retuns the mesh absolute position in the World.
  14438. * @returns a Vector3.
  14439. */
  14440. getAbsolutePosition(): Vector3;
  14441. /**
  14442. * Sets the mesh absolute position in the World from a Vector3 or an Array(3).
  14443. * @param absolutePosition the absolute position to set
  14444. * @returns the TransformNode.
  14445. */
  14446. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  14447. /**
  14448. * Sets the mesh position in its local space.
  14449. * @param vector3 the position to set in localspace
  14450. * @returns the TransformNode.
  14451. */
  14452. setPositionWithLocalVector(vector3: Vector3): TransformNode;
  14453. /**
  14454. * Returns the mesh position in the local space from the current World matrix values.
  14455. * @returns a new Vector3.
  14456. */
  14457. getPositionExpressedInLocalSpace(): Vector3;
  14458. /**
  14459. * Translates the mesh along the passed Vector3 in its local space.
  14460. * @param vector3 the distance to translate in localspace
  14461. * @returns the TransformNode.
  14462. */
  14463. locallyTranslate(vector3: Vector3): TransformNode;
  14464. private static _lookAtVectorCache;
  14465. /**
  14466. * Orients a mesh towards a target point. Mesh must be drawn facing user.
  14467. * @param targetPoint the position (must be in same space as current mesh) to look at
  14468. * @param yawCor optional yaw (y-axis) correction in radians
  14469. * @param pitchCor optional pitch (x-axis) correction in radians
  14470. * @param rollCor optional roll (z-axis) correction in radians
  14471. * @param space the choosen space of the target
  14472. * @returns the TransformNode.
  14473. */
  14474. lookAt(targetPoint: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number, space?: Space): TransformNode;
  14475. /**
  14476. * Returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  14477. * This Vector3 is expressed in the World space.
  14478. * @param localAxis axis to rotate
  14479. * @returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  14480. */
  14481. getDirection(localAxis: Vector3): Vector3;
  14482. /**
  14483. * Sets the Vector3 "result" as the rotated Vector3 "localAxis" in the same rotation than the mesh.
  14484. * localAxis is expressed in the mesh local space.
  14485. * result is computed in the Wordl space from the mesh World matrix.
  14486. * @param localAxis axis to rotate
  14487. * @param result the resulting transformnode
  14488. * @returns this TransformNode.
  14489. */
  14490. getDirectionToRef(localAxis: Vector3, result: Vector3): TransformNode;
  14491. /**
  14492. * Sets this transform node rotation to the given local axis.
  14493. * @param localAxis the axis in local space
  14494. * @param yawCor optional yaw (y-axis) correction in radians
  14495. * @param pitchCor optional pitch (x-axis) correction in radians
  14496. * @param rollCor optional roll (z-axis) correction in radians
  14497. * @returns this TransformNode
  14498. */
  14499. setDirection(localAxis: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number): TransformNode;
  14500. /**
  14501. * Sets a new pivot point to the current node
  14502. * @param point defines the new pivot point to use
  14503. * @param space defines if the point is in world or local space (local by default)
  14504. * @returns the current TransformNode
  14505. */
  14506. setPivotPoint(point: Vector3, space?: Space): TransformNode;
  14507. /**
  14508. * Returns a new Vector3 set with the mesh pivot point coordinates in the local space.
  14509. * @returns the pivot point
  14510. */
  14511. getPivotPoint(): Vector3;
  14512. /**
  14513. * Sets the passed Vector3 "result" with the coordinates of the mesh pivot point in the local space.
  14514. * @param result the vector3 to store the result
  14515. * @returns this TransformNode.
  14516. */
  14517. getPivotPointToRef(result: Vector3): TransformNode;
  14518. /**
  14519. * Returns a new Vector3 set with the mesh pivot point World coordinates.
  14520. * @returns a new Vector3 set with the mesh pivot point World coordinates.
  14521. */
  14522. getAbsolutePivotPoint(): Vector3;
  14523. /**
  14524. * Sets the Vector3 "result" coordinates with the mesh pivot point World coordinates.
  14525. * @param result vector3 to store the result
  14526. * @returns this TransformNode.
  14527. */
  14528. getAbsolutePivotPointToRef(result: Vector3): TransformNode;
  14529. /**
  14530. * Defines the passed node as the parent of the current node.
  14531. * The node will remain exactly where it is and its position / rotation will be updated accordingly
  14532. * @see https://doc.babylonjs.com/how_to/parenting
  14533. * @param node the node ot set as the parent
  14534. * @returns this TransformNode.
  14535. */
  14536. setParent(node: Nullable<Node>): TransformNode;
  14537. private _nonUniformScaling;
  14538. /**
  14539. * True if the scaling property of this object is non uniform eg. (1,2,1)
  14540. */
  14541. readonly nonUniformScaling: boolean;
  14542. /** @hidden */
  14543. _updateNonUniformScalingState(value: boolean): boolean;
  14544. /**
  14545. * Attach the current TransformNode to another TransformNode associated with a bone
  14546. * @param bone Bone affecting the TransformNode
  14547. * @param affectedTransformNode TransformNode associated with the bone
  14548. * @returns this object
  14549. */
  14550. attachToBone(bone: Bone, affectedTransformNode: TransformNode): TransformNode;
  14551. /**
  14552. * Detach the transform node if its associated with a bone
  14553. * @returns this object
  14554. */
  14555. detachFromBone(): TransformNode;
  14556. private static _rotationAxisCache;
  14557. /**
  14558. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in the given space.
  14559. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  14560. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  14561. * The passed axis is also normalized.
  14562. * @param axis the axis to rotate around
  14563. * @param amount the amount to rotate in radians
  14564. * @param space Space to rotate in (Default: local)
  14565. * @returns the TransformNode.
  14566. */
  14567. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  14568. /**
  14569. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in world space.
  14570. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  14571. * The passed axis is also normalized. .
  14572. * Method is based on http://www.euclideanspace.com/maths/geometry/affine/aroundPoint/index.htm
  14573. * @param point the point to rotate around
  14574. * @param axis the axis to rotate around
  14575. * @param amount the amount to rotate in radians
  14576. * @returns the TransformNode
  14577. */
  14578. rotateAround(point: Vector3, axis: Vector3, amount: number): TransformNode;
  14579. /**
  14580. * Translates the mesh along the axis vector for the passed distance in the given space.
  14581. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  14582. * @param axis the axis to translate in
  14583. * @param distance the distance to translate
  14584. * @param space Space to rotate in (Default: local)
  14585. * @returns the TransformNode.
  14586. */
  14587. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  14588. /**
  14589. * Adds a rotation step to the mesh current rotation.
  14590. * x, y, z are Euler angles expressed in radians.
  14591. * This methods updates the current mesh rotation, either mesh.rotation, either mesh.rotationQuaternion if it's set.
  14592. * This means this rotation is made in the mesh local space only.
  14593. * It's useful to set a custom rotation order different from the BJS standard one YXZ.
  14594. * Example : this rotates the mesh first around its local X axis, then around its local Z axis, finally around its local Y axis.
  14595. * ```javascript
  14596. * mesh.addRotation(x1, 0, 0).addRotation(0, 0, z2).addRotation(0, 0, y3);
  14597. * ```
  14598. * Note that `addRotation()` accumulates the passed rotation values to the current ones and computes the .rotation or .rotationQuaternion updated values.
  14599. * 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.
  14600. * @param x Rotation to add
  14601. * @param y Rotation to add
  14602. * @param z Rotation to add
  14603. * @returns the TransformNode.
  14604. */
  14605. addRotation(x: number, y: number, z: number): TransformNode;
  14606. /**
  14607. * @hidden
  14608. */
  14609. protected _getEffectiveParent(): Nullable<Node>;
  14610. /**
  14611. * Computes the world matrix of the node
  14612. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  14613. * @returns the world matrix
  14614. */
  14615. computeWorldMatrix(force?: boolean): Matrix;
  14616. protected _afterComputeWorldMatrix(): void;
  14617. /**
  14618. * If you'd like to be called back after the mesh position, rotation or scaling has been updated.
  14619. * @param func callback function to add
  14620. *
  14621. * @returns the TransformNode.
  14622. */
  14623. registerAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  14624. /**
  14625. * Removes a registered callback function.
  14626. * @param func callback function to remove
  14627. * @returns the TransformNode.
  14628. */
  14629. unregisterAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  14630. /**
  14631. * Gets the position of the current mesh in camera space
  14632. * @param camera defines the camera to use
  14633. * @returns a position
  14634. */
  14635. getPositionInCameraSpace(camera?: Nullable<Camera>): Vector3;
  14636. /**
  14637. * Returns the distance from the mesh to the active camera
  14638. * @param camera defines the camera to use
  14639. * @returns the distance
  14640. */
  14641. getDistanceToCamera(camera?: Nullable<Camera>): number;
  14642. /**
  14643. * Clone the current transform node
  14644. * @param name Name of the new clone
  14645. * @param newParent New parent for the clone
  14646. * @param doNotCloneChildren Do not clone children hierarchy
  14647. * @returns the new transform node
  14648. */
  14649. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<TransformNode>;
  14650. /**
  14651. * Serializes the objects information.
  14652. * @param currentSerializationObject defines the object to serialize in
  14653. * @returns the serialized object
  14654. */
  14655. serialize(currentSerializationObject?: any): any;
  14656. /**
  14657. * Returns a new TransformNode object parsed from the source provided.
  14658. * @param parsedTransformNode is the source.
  14659. * @param scene the scne the object belongs to
  14660. * @param rootUrl is a string, it's the root URL to prefix the `delayLoadingFile` property with
  14661. * @returns a new TransformNode object parsed from the source provided.
  14662. */
  14663. static Parse(parsedTransformNode: any, scene: Scene, rootUrl: string): TransformNode;
  14664. /**
  14665. * Get all child-transformNodes of this node
  14666. * @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
  14667. * @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
  14668. * @returns an array of TransformNode
  14669. */
  14670. getChildTransformNodes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): TransformNode[];
  14671. /**
  14672. * Releases resources associated with this transform node.
  14673. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  14674. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  14675. */
  14676. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  14677. /**
  14678. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  14679. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  14680. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  14681. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  14682. * @returns the current mesh
  14683. */
  14684. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): TransformNode;
  14685. private _syncAbsoluteScalingAndRotation;
  14686. }
  14687. }
  14688. declare module "babylonjs/Gamepads/Controllers/poseEnabledController" {
  14689. import { Observable } from "babylonjs/Misc/observable";
  14690. import { Nullable } from "babylonjs/types";
  14691. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  14692. import { TransformNode } from "babylonjs/Meshes/transformNode";
  14693. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  14694. import { Ray } from "babylonjs/Culling/ray";
  14695. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  14696. import { PoseControlled, DevicePose } from "babylonjs/Cameras/VR/webVRCamera";
  14697. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  14698. /**
  14699. * Defines the types of pose enabled controllers that are supported
  14700. */
  14701. export enum PoseEnabledControllerType {
  14702. /**
  14703. * HTC Vive
  14704. */
  14705. VIVE = 0,
  14706. /**
  14707. * Oculus Rift
  14708. */
  14709. OCULUS = 1,
  14710. /**
  14711. * Windows mixed reality
  14712. */
  14713. WINDOWS = 2,
  14714. /**
  14715. * Samsung gear VR
  14716. */
  14717. GEAR_VR = 3,
  14718. /**
  14719. * Google Daydream
  14720. */
  14721. DAYDREAM = 4,
  14722. /**
  14723. * Generic
  14724. */
  14725. GENERIC = 5
  14726. }
  14727. /**
  14728. * Defines the MutableGamepadButton interface for the state of a gamepad button
  14729. */
  14730. export interface MutableGamepadButton {
  14731. /**
  14732. * Value of the button/trigger
  14733. */
  14734. value: number;
  14735. /**
  14736. * If the button/trigger is currently touched
  14737. */
  14738. touched: boolean;
  14739. /**
  14740. * If the button/trigger is currently pressed
  14741. */
  14742. pressed: boolean;
  14743. }
  14744. /**
  14745. * Defines the ExtendedGamepadButton interface for a gamepad button which includes state provided by a pose controller
  14746. * @hidden
  14747. */
  14748. export interface ExtendedGamepadButton extends GamepadButton {
  14749. /**
  14750. * If the button/trigger is currently pressed
  14751. */
  14752. readonly pressed: boolean;
  14753. /**
  14754. * If the button/trigger is currently touched
  14755. */
  14756. readonly touched: boolean;
  14757. /**
  14758. * Value of the button/trigger
  14759. */
  14760. readonly value: number;
  14761. }
  14762. /** @hidden */
  14763. export interface _GamePadFactory {
  14764. /**
  14765. * Returns wether or not the current gamepad can be created for this type of controller.
  14766. * @param gamepadInfo Defines the gamepad info as receveid from the controller APIs.
  14767. * @returns true if it can be created, otherwise false
  14768. */
  14769. canCreate(gamepadInfo: any): boolean;
  14770. /**
  14771. * Creates a new instance of the Gamepad.
  14772. * @param gamepadInfo Defines the gamepad info as receveid from the controller APIs.
  14773. * @returns the new gamepad instance
  14774. */
  14775. create(gamepadInfo: any): Gamepad;
  14776. }
  14777. /**
  14778. * Defines the PoseEnabledControllerHelper object that is used initialize a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  14779. */
  14780. export class PoseEnabledControllerHelper {
  14781. /** @hidden */
  14782. static _ControllerFactories: _GamePadFactory[];
  14783. /** @hidden */
  14784. static _DefaultControllerFactory: Nullable<(gamepadInfo: any) => Gamepad>;
  14785. /**
  14786. * Initializes a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  14787. * @param vrGamepad the gamepad to initialized
  14788. * @returns a vr controller of the type the gamepad identified as
  14789. */
  14790. static InitiateController(vrGamepad: any): Gamepad;
  14791. }
  14792. /**
  14793. * Defines the PoseEnabledController object that contains state of a vr capable controller
  14794. */
  14795. export class PoseEnabledController extends Gamepad implements PoseControlled {
  14796. /**
  14797. * If the controller is used in a webXR session
  14798. */
  14799. isXR: boolean;
  14800. private _deviceRoomPosition;
  14801. private _deviceRoomRotationQuaternion;
  14802. /**
  14803. * The device position in babylon space
  14804. */
  14805. devicePosition: Vector3;
  14806. /**
  14807. * The device rotation in babylon space
  14808. */
  14809. deviceRotationQuaternion: Quaternion;
  14810. /**
  14811. * The scale factor of the device in babylon space
  14812. */
  14813. deviceScaleFactor: number;
  14814. /**
  14815. * (Likely devicePosition should be used instead) The device position in its room space
  14816. */
  14817. position: Vector3;
  14818. /**
  14819. * (Likely deviceRotationQuaternion should be used instead) The device rotation in its room space
  14820. */
  14821. rotationQuaternion: Quaternion;
  14822. /**
  14823. * The type of controller (Eg. Windows mixed reality)
  14824. */
  14825. controllerType: PoseEnabledControllerType;
  14826. protected _calculatedPosition: Vector3;
  14827. private _calculatedRotation;
  14828. /**
  14829. * The raw pose from the device
  14830. */
  14831. rawPose: DevicePose;
  14832. private _trackPosition;
  14833. private _maxRotationDistFromHeadset;
  14834. private _draggedRoomRotation;
  14835. /**
  14836. * @hidden
  14837. */
  14838. _disableTrackPosition(fixedPosition: Vector3): void;
  14839. /**
  14840. * Internal, the mesh attached to the controller
  14841. * @hidden
  14842. */
  14843. _mesh: Nullable<AbstractMesh>;
  14844. private _poseControlledCamera;
  14845. private _leftHandSystemQuaternion;
  14846. /**
  14847. * Internal, matrix used to convert room space to babylon space
  14848. * @hidden
  14849. */
  14850. _deviceToWorld: Matrix;
  14851. /**
  14852. * Node to be used when casting a ray from the controller
  14853. * @hidden
  14854. */
  14855. _pointingPoseNode: Nullable<TransformNode>;
  14856. /**
  14857. * Name of the child mesh that can be used to cast a ray from the controller
  14858. */
  14859. static readonly POINTING_POSE: string;
  14860. /**
  14861. * Creates a new PoseEnabledController from a gamepad
  14862. * @param browserGamepad the gamepad that the PoseEnabledController should be created from
  14863. */
  14864. constructor(browserGamepad: any);
  14865. private _workingMatrix;
  14866. /**
  14867. * Updates the state of the pose enbaled controller and mesh based on the current position and rotation of the controller
  14868. */
  14869. update(): void;
  14870. /**
  14871. * Updates only the pose device and mesh without doing any button event checking
  14872. */
  14873. protected _updatePoseAndMesh(): void;
  14874. /**
  14875. * Updates the state of the pose enbaled controller based on the raw pose data from the device
  14876. * @param poseData raw pose fromthe device
  14877. */
  14878. updateFromDevice(poseData: DevicePose): void;
  14879. /**
  14880. * @hidden
  14881. */
  14882. _meshAttachedObservable: Observable<AbstractMesh>;
  14883. /**
  14884. * Attaches a mesh to the controller
  14885. * @param mesh the mesh to be attached
  14886. */
  14887. attachToMesh(mesh: AbstractMesh): void;
  14888. /**
  14889. * Attaches the controllers mesh to a camera
  14890. * @param camera the camera the mesh should be attached to
  14891. */
  14892. attachToPoseControlledCamera(camera: TargetCamera): void;
  14893. /**
  14894. * Disposes of the controller
  14895. */
  14896. dispose(): void;
  14897. /**
  14898. * The mesh that is attached to the controller
  14899. */
  14900. readonly mesh: Nullable<AbstractMesh>;
  14901. /**
  14902. * Gets the ray of the controller in the direction the controller is pointing
  14903. * @param length the length the resulting ray should be
  14904. * @returns a ray in the direction the controller is pointing
  14905. */
  14906. getForwardRay(length?: number): Ray;
  14907. }
  14908. }
  14909. declare module "babylonjs/Gamepads/Controllers/webVRController" {
  14910. import { Observable } from "babylonjs/Misc/observable";
  14911. import { Scene } from "babylonjs/scene";
  14912. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  14913. import { PoseEnabledController, ExtendedGamepadButton, MutableGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  14914. import { StickValues, GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  14915. import { Nullable } from "babylonjs/types";
  14916. /**
  14917. * Defines the WebVRController object that represents controllers tracked in 3D space
  14918. */
  14919. export abstract class WebVRController extends PoseEnabledController {
  14920. /**
  14921. * Internal, the default controller model for the controller
  14922. */
  14923. protected _defaultModel: Nullable<AbstractMesh>;
  14924. /**
  14925. * Fired when the trigger state has changed
  14926. */
  14927. onTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  14928. /**
  14929. * Fired when the main button state has changed
  14930. */
  14931. onMainButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  14932. /**
  14933. * Fired when the secondary button state has changed
  14934. */
  14935. onSecondaryButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  14936. /**
  14937. * Fired when the pad state has changed
  14938. */
  14939. onPadStateChangedObservable: Observable<ExtendedGamepadButton>;
  14940. /**
  14941. * Fired when controllers stick values have changed
  14942. */
  14943. onPadValuesChangedObservable: Observable<StickValues>;
  14944. /**
  14945. * Array of button availible on the controller
  14946. */
  14947. protected _buttons: Array<MutableGamepadButton>;
  14948. private _onButtonStateChange;
  14949. /**
  14950. * Fired when a controller button's state has changed
  14951. * @param callback the callback containing the button that was modified
  14952. */
  14953. onButtonStateChange(callback: (controlledIndex: number, buttonIndex: number, state: ExtendedGamepadButton) => void): void;
  14954. /**
  14955. * X and Y axis corresponding to the controllers joystick
  14956. */
  14957. pad: StickValues;
  14958. /**
  14959. * 'left' or 'right', see https://w3c.github.io/gamepad/extensions.html#gamepadhand-enum
  14960. */
  14961. hand: string;
  14962. /**
  14963. * The default controller model for the controller
  14964. */
  14965. readonly defaultModel: Nullable<AbstractMesh>;
  14966. /**
  14967. * Creates a new WebVRController from a gamepad
  14968. * @param vrGamepad the gamepad that the WebVRController should be created from
  14969. */
  14970. constructor(vrGamepad: any);
  14971. /**
  14972. * Updates the state of the controller and mesh based on the current position and rotation of the controller
  14973. */
  14974. update(): void;
  14975. /**
  14976. * Function to be called when a button is modified
  14977. */
  14978. protected abstract _handleButtonChange(buttonIdx: number, value: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  14979. /**
  14980. * Loads a mesh and attaches it to the controller
  14981. * @param scene the scene the mesh should be added to
  14982. * @param meshLoaded callback for when the mesh has been loaded
  14983. */
  14984. abstract initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  14985. private _setButtonValue;
  14986. private _changes;
  14987. private _checkChanges;
  14988. /**
  14989. * Disposes of th webVRCOntroller
  14990. */
  14991. dispose(): void;
  14992. }
  14993. }
  14994. declare module "babylonjs/Lights/hemisphericLight" {
  14995. import { Nullable } from "babylonjs/types";
  14996. import { Scene } from "babylonjs/scene";
  14997. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  14998. import { Color3 } from "babylonjs/Maths/math.color";
  14999. import { Effect } from "babylonjs/Materials/effect";
  15000. import { Light } from "babylonjs/Lights/light";
  15001. import { IShadowGenerator } from "babylonjs/Lights/Shadows/shadowGenerator";
  15002. /**
  15003. * The HemisphericLight simulates the ambient environment light,
  15004. * so the passed direction is the light reflection direction, not the incoming direction.
  15005. */
  15006. export class HemisphericLight extends Light {
  15007. /**
  15008. * The groundColor is the light in the opposite direction to the one specified during creation.
  15009. * 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.
  15010. */
  15011. groundColor: Color3;
  15012. /**
  15013. * The light reflection direction, not the incoming direction.
  15014. */
  15015. direction: Vector3;
  15016. /**
  15017. * Creates a HemisphericLight object in the scene according to the passed direction (Vector3).
  15018. * The HemisphericLight simulates the ambient environment light, so the passed direction is the light reflection direction, not the incoming direction.
  15019. * The HemisphericLight can't cast shadows.
  15020. * Documentation : https://doc.babylonjs.com/babylon101/lights
  15021. * @param name The friendly name of the light
  15022. * @param direction The direction of the light reflection
  15023. * @param scene The scene the light belongs to
  15024. */
  15025. constructor(name: string, direction: Vector3, scene: Scene);
  15026. protected _buildUniformLayout(): void;
  15027. /**
  15028. * Returns the string "HemisphericLight".
  15029. * @return The class name
  15030. */
  15031. getClassName(): string;
  15032. /**
  15033. * Sets the HemisphericLight direction towards the passed target (Vector3).
  15034. * Returns the updated direction.
  15035. * @param target The target the direction should point to
  15036. * @return The computed direction
  15037. */
  15038. setDirectionToTarget(target: Vector3): Vector3;
  15039. /**
  15040. * Returns the shadow generator associated to the light.
  15041. * @returns Always null for hemispheric lights because it does not support shadows.
  15042. */
  15043. getShadowGenerator(): Nullable<IShadowGenerator>;
  15044. /**
  15045. * Sets the passed Effect object with the HemisphericLight normalized direction and color and the passed name (string).
  15046. * @param effect The effect to update
  15047. * @param lightIndex The index of the light in the effect to update
  15048. * @returns The hemispheric light
  15049. */
  15050. transferToEffect(effect: Effect, lightIndex: string): HemisphericLight;
  15051. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  15052. /**
  15053. * Computes the world matrix of the node
  15054. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  15055. * @param useWasUpdatedFlag defines a reserved property
  15056. * @returns the world matrix
  15057. */
  15058. computeWorldMatrix(): Matrix;
  15059. /**
  15060. * Returns the integer 3.
  15061. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  15062. */
  15063. getTypeID(): number;
  15064. /**
  15065. * Prepares the list of defines specific to the light type.
  15066. * @param defines the list of defines
  15067. * @param lightIndex defines the index of the light for the effect
  15068. */
  15069. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  15070. }
  15071. }
  15072. declare module "babylonjs/Shaders/vrMultiviewToSingleview.fragment" {
  15073. /** @hidden */
  15074. export var vrMultiviewToSingleviewPixelShader: {
  15075. name: string;
  15076. shader: string;
  15077. };
  15078. }
  15079. declare module "babylonjs/Materials/Textures/MultiviewRenderTarget" {
  15080. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  15081. import { Scene } from "babylonjs/scene";
  15082. /**
  15083. * Renders to multiple views with a single draw call
  15084. * @see https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/
  15085. */
  15086. export class MultiviewRenderTarget extends RenderTargetTexture {
  15087. /**
  15088. * Creates a multiview render target
  15089. * @param scene scene used with the render target
  15090. * @param size the size of the render target (used for each view)
  15091. */
  15092. constructor(scene: Scene, size?: number | {
  15093. width: number;
  15094. height: number;
  15095. } | {
  15096. ratio: number;
  15097. });
  15098. /**
  15099. * @hidden
  15100. * @param faceIndex the face index, if its a cube texture
  15101. */
  15102. _bindFrameBuffer(faceIndex?: number): void;
  15103. /**
  15104. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  15105. * @returns the view count
  15106. */
  15107. getViewCount(): number;
  15108. }
  15109. }
  15110. declare module "babylonjs/Maths/math.frustum" {
  15111. import { Matrix } from "babylonjs/Maths/math.vector";
  15112. import { DeepImmutable } from "babylonjs/types";
  15113. import { Plane } from "babylonjs/Maths/math.plane";
  15114. /**
  15115. * Represents a camera frustum
  15116. */
  15117. export class Frustum {
  15118. /**
  15119. * Gets the planes representing the frustum
  15120. * @param transform matrix to be applied to the returned planes
  15121. * @returns a new array of 6 Frustum planes computed by the given transformation matrix.
  15122. */
  15123. static GetPlanes(transform: DeepImmutable<Matrix>): Plane[];
  15124. /**
  15125. * Gets the near frustum plane transformed by the transform matrix
  15126. * @param transform transformation matrix to be applied to the resulting frustum plane
  15127. * @param frustumPlane the resuling frustum plane
  15128. */
  15129. static GetNearPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  15130. /**
  15131. * Gets the far frustum plane transformed by the transform matrix
  15132. * @param transform transformation matrix to be applied to the resulting frustum plane
  15133. * @param frustumPlane the resuling frustum plane
  15134. */
  15135. static GetFarPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  15136. /**
  15137. * Gets the left frustum plane transformed by the transform matrix
  15138. * @param transform transformation matrix to be applied to the resulting frustum plane
  15139. * @param frustumPlane the resuling frustum plane
  15140. */
  15141. static GetLeftPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  15142. /**
  15143. * Gets the right frustum plane transformed by the transform matrix
  15144. * @param transform transformation matrix to be applied to the resulting frustum plane
  15145. * @param frustumPlane the resuling frustum plane
  15146. */
  15147. static GetRightPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  15148. /**
  15149. * Gets the top frustum plane transformed by the transform matrix
  15150. * @param transform transformation matrix to be applied to the resulting frustum plane
  15151. * @param frustumPlane the resuling frustum plane
  15152. */
  15153. static GetTopPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  15154. /**
  15155. * Gets the bottom frustum plane transformed by the transform matrix
  15156. * @param transform transformation matrix to be applied to the resulting frustum plane
  15157. * @param frustumPlane the resuling frustum plane
  15158. */
  15159. static GetBottomPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  15160. /**
  15161. * Sets the given array "frustumPlanes" with the 6 Frustum planes computed by the given transformation matrix.
  15162. * @param transform transformation matrix to be applied to the resulting frustum planes
  15163. * @param frustumPlanes the resuling frustum planes
  15164. */
  15165. static GetPlanesToRef(transform: DeepImmutable<Matrix>, frustumPlanes: Plane[]): void;
  15166. }
  15167. }
  15168. declare module "babylonjs/Engines/Extensions/engine.multiview" {
  15169. import { Camera } from "babylonjs/Cameras/camera";
  15170. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  15171. import { Nullable } from "babylonjs/types";
  15172. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  15173. import { Matrix } from "babylonjs/Maths/math.vector";
  15174. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  15175. module "babylonjs/Engines/engine" {
  15176. interface Engine {
  15177. /**
  15178. * Creates a new multiview render target
  15179. * @param width defines the width of the texture
  15180. * @param height defines the height of the texture
  15181. * @returns the created multiview texture
  15182. */
  15183. createMultiviewRenderTargetTexture(width: number, height: number): InternalTexture;
  15184. /**
  15185. * Binds a multiview framebuffer to be drawn to
  15186. * @param multiviewTexture texture to bind
  15187. */
  15188. bindMultiviewFramebuffer(multiviewTexture: InternalTexture): void;
  15189. }
  15190. }
  15191. module "babylonjs/Cameras/camera" {
  15192. interface Camera {
  15193. /**
  15194. * @hidden
  15195. * 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)
  15196. */
  15197. _useMultiviewToSingleView: boolean;
  15198. /**
  15199. * @hidden
  15200. * 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)
  15201. */
  15202. _multiviewTexture: Nullable<RenderTargetTexture>;
  15203. /**
  15204. * @hidden
  15205. * ensures the multiview texture of the camera exists and has the specified width/height
  15206. * @param width height to set on the multiview texture
  15207. * @param height width to set on the multiview texture
  15208. */
  15209. _resizeOrCreateMultiviewTexture(width: number, height: number): void;
  15210. }
  15211. }
  15212. module "babylonjs/scene" {
  15213. interface Scene {
  15214. /** @hidden */
  15215. _transformMatrixR: Matrix;
  15216. /** @hidden */
  15217. _multiviewSceneUbo: Nullable<UniformBuffer>;
  15218. /** @hidden */
  15219. _createMultiviewUbo(): void;
  15220. /** @hidden */
  15221. _updateMultiviewUbo(viewR?: Matrix, projectionR?: Matrix): void;
  15222. /** @hidden */
  15223. _renderMultiviewToSingleView(camera: Camera): void;
  15224. }
  15225. }
  15226. }
  15227. declare module "babylonjs/PostProcesses/vrMultiviewToSingleviewPostProcess" {
  15228. import { Camera } from "babylonjs/Cameras/camera";
  15229. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  15230. import "babylonjs/Shaders/vrMultiviewToSingleview.fragment";
  15231. import "babylonjs/Engines/Extensions/engine.multiview";
  15232. /**
  15233. * VRMultiviewToSingleview used to convert multiview texture arrays to standard textures for scenarios such as webVR
  15234. * This will not be used for webXR as it supports displaying texture arrays directly
  15235. */
  15236. export class VRMultiviewToSingleviewPostProcess extends PostProcess {
  15237. /**
  15238. * Initializes a VRMultiviewToSingleview
  15239. * @param name name of the post process
  15240. * @param camera camera to be applied to
  15241. * @param scaleFactor scaling factor to the size of the output texture
  15242. */
  15243. constructor(name: string, camera: Camera, scaleFactor: number);
  15244. }
  15245. }
  15246. declare module "babylonjs/Cameras/RigModes/webVRRigMode" { }
  15247. declare module "babylonjs/Engines/Extensions/engine.webVR" {
  15248. import { Nullable } from "babylonjs/types";
  15249. import { Size } from "babylonjs/Maths/math.size";
  15250. import { Observable } from "babylonjs/Misc/observable";
  15251. import { WebVROptions } from "babylonjs/Cameras/VR/webVRCamera";
  15252. /**
  15253. * Interface used to define additional presentation attributes
  15254. */
  15255. export interface IVRPresentationAttributes {
  15256. /**
  15257. * Defines a boolean indicating that we want to get 72hz mode on Oculus Browser (default is off eg. 60hz)
  15258. */
  15259. highRefreshRate: boolean;
  15260. /**
  15261. * Enables foveation in VR to improve perf. 0 none, 1 low, 2 medium, 3 high (Default is 1)
  15262. */
  15263. foveationLevel: number;
  15264. }
  15265. module "babylonjs/Engines/engine" {
  15266. interface Engine {
  15267. /** @hidden */
  15268. _vrDisplay: any;
  15269. /** @hidden */
  15270. _vrSupported: boolean;
  15271. /** @hidden */
  15272. _oldSize: Size;
  15273. /** @hidden */
  15274. _oldHardwareScaleFactor: number;
  15275. /** @hidden */
  15276. _vrExclusivePointerMode: boolean;
  15277. /** @hidden */
  15278. _webVRInitPromise: Promise<IDisplayChangedEventArgs>;
  15279. /** @hidden */
  15280. _onVRDisplayPointerRestricted: () => void;
  15281. /** @hidden */
  15282. _onVRDisplayPointerUnrestricted: () => void;
  15283. /** @hidden */
  15284. _onVrDisplayConnect: Nullable<(display: any) => void>;
  15285. /** @hidden */
  15286. _onVrDisplayDisconnect: Nullable<() => void>;
  15287. /** @hidden */
  15288. _onVrDisplayPresentChange: Nullable<() => void>;
  15289. /**
  15290. * Observable signaled when VR display mode changes
  15291. */
  15292. onVRDisplayChangedObservable: Observable<IDisplayChangedEventArgs>;
  15293. /**
  15294. * Observable signaled when VR request present is complete
  15295. */
  15296. onVRRequestPresentComplete: Observable<boolean>;
  15297. /**
  15298. * Observable signaled when VR request present starts
  15299. */
  15300. onVRRequestPresentStart: Observable<Engine>;
  15301. /**
  15302. * Gets a boolean indicating that the engine is currently in VR exclusive mode for the pointers
  15303. * @see https://docs.microsoft.com/en-us/microsoft-edge/webvr/essentials#mouse-input
  15304. */
  15305. isInVRExclusivePointerMode: boolean;
  15306. /**
  15307. * Gets a boolean indicating if a webVR device was detected
  15308. * @returns true if a webVR device was detected
  15309. */
  15310. isVRDevicePresent(): boolean;
  15311. /**
  15312. * Gets the current webVR device
  15313. * @returns the current webVR device (or null)
  15314. */
  15315. getVRDevice(): any;
  15316. /**
  15317. * Initializes a webVR display and starts listening to display change events
  15318. * The onVRDisplayChangedObservable will be notified upon these changes
  15319. * @returns A promise containing a VRDisplay and if vr is supported
  15320. */
  15321. initWebVRAsync(): Promise<IDisplayChangedEventArgs>;
  15322. /** @hidden */
  15323. _getVRDisplaysAsync(): Promise<IDisplayChangedEventArgs>;
  15324. /**
  15325. * Gets or sets the presentation attributes used to configure VR rendering
  15326. */
  15327. vrPresentationAttributes?: IVRPresentationAttributes;
  15328. /**
  15329. * Call this function to switch to webVR mode
  15330. * Will do nothing if webVR is not supported or if there is no webVR device
  15331. * @param options the webvr options provided to the camera. mainly used for multiview
  15332. * @see http://doc.babylonjs.com/how_to/webvr_camera
  15333. */
  15334. enableVR(options: WebVROptions): void;
  15335. /** @hidden */
  15336. _onVRFullScreenTriggered(): void;
  15337. }
  15338. }
  15339. }
  15340. declare module "babylonjs/Cameras/VR/webVRCamera" {
  15341. import { Nullable } from "babylonjs/types";
  15342. import { Observable } from "babylonjs/Misc/observable";
  15343. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  15344. import { Scene } from "babylonjs/scene";
  15345. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  15346. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  15347. import { Node } from "babylonjs/node";
  15348. import { Ray } from "babylonjs/Culling/ray";
  15349. import "babylonjs/Cameras/RigModes/webVRRigMode";
  15350. import "babylonjs/Engines/Extensions/engine.webVR";
  15351. /**
  15352. * This is a copy of VRPose. See https://developer.mozilla.org/en-US/docs/Web/API/VRPose
  15353. * IMPORTANT!! The data is right-hand data.
  15354. * @export
  15355. * @interface DevicePose
  15356. */
  15357. export interface DevicePose {
  15358. /**
  15359. * The position of the device, values in array are [x,y,z].
  15360. */
  15361. readonly position: Nullable<Float32Array>;
  15362. /**
  15363. * The linearVelocity of the device, values in array are [x,y,z].
  15364. */
  15365. readonly linearVelocity: Nullable<Float32Array>;
  15366. /**
  15367. * The linearAcceleration of the device, values in array are [x,y,z].
  15368. */
  15369. readonly linearAcceleration: Nullable<Float32Array>;
  15370. /**
  15371. * The orientation of the device in a quaternion array, values in array are [x,y,z,w].
  15372. */
  15373. readonly orientation: Nullable<Float32Array>;
  15374. /**
  15375. * The angularVelocity of the device, values in array are [x,y,z].
  15376. */
  15377. readonly angularVelocity: Nullable<Float32Array>;
  15378. /**
  15379. * The angularAcceleration of the device, values in array are [x,y,z].
  15380. */
  15381. readonly angularAcceleration: Nullable<Float32Array>;
  15382. }
  15383. /**
  15384. * Interface representing a pose controlled object in Babylon.
  15385. * A pose controlled object has both regular pose values as well as pose values
  15386. * from an external device such as a VR head mounted display
  15387. */
  15388. export interface PoseControlled {
  15389. /**
  15390. * The position of the object in babylon space.
  15391. */
  15392. position: Vector3;
  15393. /**
  15394. * The rotation quaternion of the object in babylon space.
  15395. */
  15396. rotationQuaternion: Quaternion;
  15397. /**
  15398. * The position of the device in babylon space.
  15399. */
  15400. devicePosition?: Vector3;
  15401. /**
  15402. * The rotation quaternion of the device in babylon space.
  15403. */
  15404. deviceRotationQuaternion: Quaternion;
  15405. /**
  15406. * The raw pose coming from the device.
  15407. */
  15408. rawPose: Nullable<DevicePose>;
  15409. /**
  15410. * The scale of the device to be used when translating from device space to babylon space.
  15411. */
  15412. deviceScaleFactor: number;
  15413. /**
  15414. * Updates the poseControlled values based on the input device pose.
  15415. * @param poseData the pose data to update the object with
  15416. */
  15417. updateFromDevice(poseData: DevicePose): void;
  15418. }
  15419. /**
  15420. * Set of options to customize the webVRCamera
  15421. */
  15422. export interface WebVROptions {
  15423. /**
  15424. * Sets if the webVR camera should be tracked to the vrDevice. (default: true)
  15425. */
  15426. trackPosition?: boolean;
  15427. /**
  15428. * Sets the scale of the vrDevice in babylon space. (default: 1)
  15429. */
  15430. positionScale?: number;
  15431. /**
  15432. * If there are more than one VRDisplays, this will choose the display matching this name. (default: pick first vrDisplay)
  15433. */
  15434. displayName?: string;
  15435. /**
  15436. * Should the native controller meshes be initialized. (default: true)
  15437. */
  15438. controllerMeshes?: boolean;
  15439. /**
  15440. * Creating a default HemiLight only on controllers. (default: true)
  15441. */
  15442. defaultLightingOnControllers?: boolean;
  15443. /**
  15444. * If you don't want to use the default VR button of the helper. (default: false)
  15445. */
  15446. useCustomVRButton?: boolean;
  15447. /**
  15448. * If you'd like to provide your own button to the VRHelper. (default: standard babylon vr button)
  15449. */
  15450. customVRButton?: HTMLButtonElement;
  15451. /**
  15452. * To change the length of the ray for gaze/controllers. Will be scaled by positionScale. (default: 100)
  15453. */
  15454. rayLength?: number;
  15455. /**
  15456. * To change the default offset from the ground to account for user's height in meters. Will be scaled by positionScale. (default: 1.7)
  15457. */
  15458. defaultHeight?: number;
  15459. /**
  15460. * If multiview should be used if availible (default: false)
  15461. */
  15462. useMultiview?: boolean;
  15463. }
  15464. /**
  15465. * This represents a WebVR camera.
  15466. * The WebVR camera is Babylon's simple interface to interaction with Windows Mixed Reality, HTC Vive and Oculus Rift.
  15467. * @example http://doc.babylonjs.com/how_to/webvr_camera
  15468. */
  15469. export class WebVRFreeCamera extends FreeCamera implements PoseControlled {
  15470. private webVROptions;
  15471. /**
  15472. * @hidden
  15473. * The vrDisplay tied to the camera. See https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay
  15474. */
  15475. _vrDevice: any;
  15476. /**
  15477. * The rawPose of the vrDevice.
  15478. */
  15479. rawPose: Nullable<DevicePose>;
  15480. private _onVREnabled;
  15481. private _specsVersion;
  15482. private _attached;
  15483. private _frameData;
  15484. protected _descendants: Array<Node>;
  15485. private _deviceRoomPosition;
  15486. /** @hidden */
  15487. _deviceRoomRotationQuaternion: Quaternion;
  15488. private _standingMatrix;
  15489. /**
  15490. * Represents device position in babylon space.
  15491. */
  15492. devicePosition: Vector3;
  15493. /**
  15494. * Represents device rotation in babylon space.
  15495. */
  15496. deviceRotationQuaternion: Quaternion;
  15497. /**
  15498. * The scale of the device to be used when translating from device space to babylon space.
  15499. */
  15500. deviceScaleFactor: number;
  15501. private _deviceToWorld;
  15502. private _worldToDevice;
  15503. /**
  15504. * References to the webVR controllers for the vrDevice.
  15505. */
  15506. controllers: Array<WebVRController>;
  15507. /**
  15508. * Emits an event when a controller is attached.
  15509. */
  15510. onControllersAttachedObservable: Observable<WebVRController[]>;
  15511. /**
  15512. * Emits an event when a controller's mesh has been loaded;
  15513. */
  15514. onControllerMeshLoadedObservable: Observable<WebVRController>;
  15515. /**
  15516. * Emits an event when the HMD's pose has been updated.
  15517. */
  15518. onPoseUpdatedFromDeviceObservable: Observable<any>;
  15519. private _poseSet;
  15520. /**
  15521. * If the rig cameras be used as parent instead of this camera.
  15522. */
  15523. rigParenting: boolean;
  15524. private _lightOnControllers;
  15525. private _defaultHeight?;
  15526. /**
  15527. * Instantiates a WebVRFreeCamera.
  15528. * @param name The name of the WebVRFreeCamera
  15529. * @param position The starting anchor position for the camera
  15530. * @param scene The scene the camera belongs to
  15531. * @param webVROptions a set of customizable options for the webVRCamera
  15532. */
  15533. constructor(name: string, position: Vector3, scene: Scene, webVROptions?: WebVROptions);
  15534. /**
  15535. * Gets the device distance from the ground in meters.
  15536. * @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.
  15537. */
  15538. deviceDistanceToRoomGround(): number;
  15539. /**
  15540. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  15541. * @param callback will be called when the standing matrix is set. Callback parameter is if the standing matrix is supported.
  15542. */
  15543. useStandingMatrix(callback?: (bool: boolean) => void): void;
  15544. /**
  15545. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  15546. * @returns A promise with a boolean set to if the standing matrix is supported.
  15547. */
  15548. useStandingMatrixAsync(): Promise<boolean>;
  15549. /**
  15550. * Disposes the camera
  15551. */
  15552. dispose(): void;
  15553. /**
  15554. * Gets a vrController by name.
  15555. * @param name The name of the controller to retreive
  15556. * @returns the controller matching the name specified or null if not found
  15557. */
  15558. getControllerByName(name: string): Nullable<WebVRController>;
  15559. private _leftController;
  15560. /**
  15561. * The controller corresponding to the users left hand.
  15562. */
  15563. readonly leftController: Nullable<WebVRController>;
  15564. private _rightController;
  15565. /**
  15566. * The controller corresponding to the users right hand.
  15567. */
  15568. readonly rightController: Nullable<WebVRController>;
  15569. /**
  15570. * Casts a ray forward from the vrCamera's gaze.
  15571. * @param length Length of the ray (default: 100)
  15572. * @returns the ray corresponding to the gaze
  15573. */
  15574. getForwardRay(length?: number): Ray;
  15575. /**
  15576. * @hidden
  15577. * Updates the camera based on device's frame data
  15578. */
  15579. _checkInputs(): void;
  15580. /**
  15581. * Updates the poseControlled values based on the input device pose.
  15582. * @param poseData Pose coming from the device
  15583. */
  15584. updateFromDevice(poseData: DevicePose): void;
  15585. private _htmlElementAttached;
  15586. private _detachIfAttached;
  15587. /**
  15588. * WebVR's attach control will start broadcasting frames to the device.
  15589. * Note that in certain browsers (chrome for example) this function must be called
  15590. * within a user-interaction callback. Example:
  15591. * <pre> scene.onPointerDown = function() { camera.attachControl(canvas); }</pre>
  15592. *
  15593. * @param element html element to attach the vrDevice to
  15594. * @param noPreventDefault prevent the default html element operation when attaching the vrDevice
  15595. */
  15596. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  15597. /**
  15598. * Detaches the camera from the html element and disables VR
  15599. *
  15600. * @param element html element to detach from
  15601. */
  15602. detachControl(element: HTMLElement): void;
  15603. /**
  15604. * @returns the name of this class
  15605. */
  15606. getClassName(): string;
  15607. /**
  15608. * Calls resetPose on the vrDisplay
  15609. * See: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/resetPose
  15610. */
  15611. resetToCurrentRotation(): void;
  15612. /**
  15613. * @hidden
  15614. * Updates the rig cameras (left and right eye)
  15615. */
  15616. _updateRigCameras(): void;
  15617. private _workingVector;
  15618. private _oneVector;
  15619. private _workingMatrix;
  15620. private updateCacheCalled;
  15621. private _correctPositionIfNotTrackPosition;
  15622. /**
  15623. * @hidden
  15624. * Updates the cached values of the camera
  15625. * @param ignoreParentClass ignores updating the parent class's cache (default: false)
  15626. */
  15627. _updateCache(ignoreParentClass?: boolean): void;
  15628. /**
  15629. * @hidden
  15630. * Get current device position in babylon world
  15631. */
  15632. _computeDevicePosition(): void;
  15633. /**
  15634. * Updates the current device position and rotation in the babylon world
  15635. */
  15636. update(): void;
  15637. /**
  15638. * @hidden
  15639. * Gets the view matrix of this camera (Always set to identity as left and right eye cameras contain the actual view matrix)
  15640. * @returns an identity matrix
  15641. */
  15642. _getViewMatrix(): Matrix;
  15643. private _tmpMatrix;
  15644. /**
  15645. * This function is called by the two RIG cameras.
  15646. * 'this' is the left or right camera (and NOT (!!!) the WebVRFreeCamera instance)
  15647. * @hidden
  15648. */
  15649. _getWebVRViewMatrix(): Matrix;
  15650. /** @hidden */
  15651. _getWebVRProjectionMatrix(): Matrix;
  15652. private _onGamepadConnectedObserver;
  15653. private _onGamepadDisconnectedObserver;
  15654. private _updateCacheWhenTrackingDisabledObserver;
  15655. /**
  15656. * Initializes the controllers and their meshes
  15657. */
  15658. initControllers(): void;
  15659. }
  15660. }
  15661. declare module "babylonjs/PostProcesses/postProcess" {
  15662. import { Nullable } from "babylonjs/types";
  15663. import { SmartArray } from "babylonjs/Misc/smartArray";
  15664. import { Observable } from "babylonjs/Misc/observable";
  15665. import { Vector2 } from "babylonjs/Maths/math.vector";
  15666. import { Camera } from "babylonjs/Cameras/camera";
  15667. import { Effect } from "babylonjs/Materials/effect";
  15668. import "babylonjs/Shaders/postprocess.vertex";
  15669. import { IInspectable } from "babylonjs/Misc/iInspectable";
  15670. import { Engine } from "babylonjs/Engines/engine";
  15671. import { Color4 } from "babylonjs/Maths/math.color";
  15672. import "babylonjs/Engines/Extensions/engine.renderTarget";
  15673. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  15674. /**
  15675. * Size options for a post process
  15676. */
  15677. export type PostProcessOptions = {
  15678. width: number;
  15679. height: number;
  15680. };
  15681. /**
  15682. * PostProcess can be used to apply a shader to a texture after it has been rendered
  15683. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  15684. */
  15685. export class PostProcess {
  15686. /** Name of the PostProcess. */
  15687. name: string;
  15688. /**
  15689. * Gets or sets the unique id of the post process
  15690. */
  15691. uniqueId: number;
  15692. /**
  15693. * Width of the texture to apply the post process on
  15694. */
  15695. width: number;
  15696. /**
  15697. * Height of the texture to apply the post process on
  15698. */
  15699. height: number;
  15700. /**
  15701. * Internal, reference to the location where this postprocess was output to. (Typically the texture on the next postprocess in the chain)
  15702. * @hidden
  15703. */
  15704. _outputTexture: Nullable<InternalTexture>;
  15705. /**
  15706. * Sampling mode used by the shader
  15707. * See https://doc.babylonjs.com/classes/3.1/texture
  15708. */
  15709. renderTargetSamplingMode: number;
  15710. /**
  15711. * Clear color to use when screen clearing
  15712. */
  15713. clearColor: Color4;
  15714. /**
  15715. * If the buffer needs to be cleared before applying the post process. (default: true)
  15716. * Should be set to false if shader will overwrite all previous pixels.
  15717. */
  15718. autoClear: boolean;
  15719. /**
  15720. * Type of alpha mode to use when performing the post process (default: Engine.ALPHA_DISABLE)
  15721. */
  15722. alphaMode: number;
  15723. /**
  15724. * Sets the setAlphaBlendConstants of the babylon engine
  15725. */
  15726. alphaConstants: Color4;
  15727. /**
  15728. * Animations to be used for the post processing
  15729. */
  15730. animations: import("babylonjs/Animations/animation").Animation[];
  15731. /**
  15732. * Enable Pixel Perfect mode where texture is not scaled to be power of 2.
  15733. * Can only be used on a single postprocess or on the last one of a chain. (default: false)
  15734. */
  15735. enablePixelPerfectMode: boolean;
  15736. /**
  15737. * Force the postprocess to be applied without taking in account viewport
  15738. */
  15739. forceFullscreenViewport: boolean;
  15740. /**
  15741. * List of inspectable custom properties (used by the Inspector)
  15742. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  15743. */
  15744. inspectableCustomProperties: IInspectable[];
  15745. /**
  15746. * Scale mode for the post process (default: Engine.SCALEMODE_FLOOR)
  15747. *
  15748. * | Value | Type | Description |
  15749. * | ----- | ----------------------------------- | ----------- |
  15750. * | 1 | SCALEMODE_FLOOR | [engine.scalemode_floor](http://doc.babylonjs.com/api/classes/babylon.engine#scalemode_floor) |
  15751. * | 2 | SCALEMODE_NEAREST | [engine.scalemode_nearest](http://doc.babylonjs.com/api/classes/babylon.engine#scalemode_nearest) |
  15752. * | 3 | SCALEMODE_CEILING | [engine.scalemode_ceiling](http://doc.babylonjs.com/api/classes/babylon.engine#scalemode_ceiling) |
  15753. *
  15754. */
  15755. scaleMode: number;
  15756. /**
  15757. * Force textures to be a power of two (default: false)
  15758. */
  15759. alwaysForcePOT: boolean;
  15760. private _samples;
  15761. /**
  15762. * Number of sample textures (default: 1)
  15763. */
  15764. samples: number;
  15765. /**
  15766. * Modify the scale of the post process to be the same as the viewport (default: false)
  15767. */
  15768. adaptScaleToCurrentViewport: boolean;
  15769. private _camera;
  15770. private _scene;
  15771. private _engine;
  15772. private _options;
  15773. private _reusable;
  15774. private _textureType;
  15775. /**
  15776. * Smart array of input and output textures for the post process.
  15777. * @hidden
  15778. */
  15779. _textures: SmartArray<import("babylonjs/Materials/Textures/internalTexture").InternalTexture>;
  15780. /**
  15781. * The index in _textures that corresponds to the output texture.
  15782. * @hidden
  15783. */
  15784. _currentRenderTextureInd: number;
  15785. private _effect;
  15786. private _samplers;
  15787. private _fragmentUrl;
  15788. private _vertexUrl;
  15789. private _parameters;
  15790. private _scaleRatio;
  15791. protected _indexParameters: any;
  15792. private _shareOutputWithPostProcess;
  15793. private _texelSize;
  15794. private _forcedOutputTexture;
  15795. /**
  15796. * Returns the fragment url or shader name used in the post process.
  15797. * @returns the fragment url or name in the shader store.
  15798. */
  15799. getEffectName(): string;
  15800. /**
  15801. * An event triggered when the postprocess is activated.
  15802. */
  15803. onActivateObservable: Observable<Camera>;
  15804. private _onActivateObserver;
  15805. /**
  15806. * A function that is added to the onActivateObservable
  15807. */
  15808. onActivate: Nullable<(camera: Camera) => void>;
  15809. /**
  15810. * An event triggered when the postprocess changes its size.
  15811. */
  15812. onSizeChangedObservable: Observable<PostProcess>;
  15813. private _onSizeChangedObserver;
  15814. /**
  15815. * A function that is added to the onSizeChangedObservable
  15816. */
  15817. onSizeChanged: (postProcess: PostProcess) => void;
  15818. /**
  15819. * An event triggered when the postprocess applies its effect.
  15820. */
  15821. onApplyObservable: Observable<Effect>;
  15822. private _onApplyObserver;
  15823. /**
  15824. * A function that is added to the onApplyObservable
  15825. */
  15826. onApply: (effect: Effect) => void;
  15827. /**
  15828. * An event triggered before rendering the postprocess
  15829. */
  15830. onBeforeRenderObservable: Observable<Effect>;
  15831. private _onBeforeRenderObserver;
  15832. /**
  15833. * A function that is added to the onBeforeRenderObservable
  15834. */
  15835. onBeforeRender: (effect: Effect) => void;
  15836. /**
  15837. * An event triggered after rendering the postprocess
  15838. */
  15839. onAfterRenderObservable: Observable<Effect>;
  15840. private _onAfterRenderObserver;
  15841. /**
  15842. * A function that is added to the onAfterRenderObservable
  15843. */
  15844. onAfterRender: (efect: Effect) => void;
  15845. /**
  15846. * 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
  15847. * render it's output into this texture and this texture will be used as textureSampler in the fragment shader of this post process.
  15848. */
  15849. inputTexture: InternalTexture;
  15850. /**
  15851. * Gets the camera which post process is applied to.
  15852. * @returns The camera the post process is applied to.
  15853. */
  15854. getCamera(): Camera;
  15855. /**
  15856. * Gets the texel size of the postprocess.
  15857. * See https://en.wikipedia.org/wiki/Texel_(graphics)
  15858. */
  15859. readonly texelSize: Vector2;
  15860. /**
  15861. * Creates a new instance PostProcess
  15862. * @param name The name of the PostProcess.
  15863. * @param fragmentUrl The url of the fragment shader to be used.
  15864. * @param parameters Array of the names of uniform non-sampler2D variables that will be passed to the shader.
  15865. * @param samplers Array of the names of uniform sampler2D variables that will be passed to the shader.
  15866. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  15867. * @param camera The camera to apply the render pass to.
  15868. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  15869. * @param engine The engine which the post process will be applied. (default: current engine)
  15870. * @param reusable If the post process can be reused on the same frame. (default: false)
  15871. * @param defines String of defines that will be set when running the fragment shader. (default: null)
  15872. * @param textureType Type of textures used when performing the post process. (default: 0)
  15873. * @param vertexUrl The url of the vertex shader to be used. (default: "postprocess")
  15874. * @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
  15875. * @param blockCompilation If the shader should not be compiled imediatly. (default: false)
  15876. */
  15877. constructor(
  15878. /** Name of the PostProcess. */
  15879. 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);
  15880. /**
  15881. * Gets a string idenfifying the name of the class
  15882. * @returns "PostProcess" string
  15883. */
  15884. getClassName(): string;
  15885. /**
  15886. * Gets the engine which this post process belongs to.
  15887. * @returns The engine the post process was enabled with.
  15888. */
  15889. getEngine(): Engine;
  15890. /**
  15891. * The effect that is created when initializing the post process.
  15892. * @returns The created effect corresponding the the postprocess.
  15893. */
  15894. getEffect(): Effect;
  15895. /**
  15896. * To avoid multiple redundant textures for multiple post process, the output the output texture for this post process can be shared with another.
  15897. * @param postProcess The post process to share the output with.
  15898. * @returns This post process.
  15899. */
  15900. shareOutputWith(postProcess: PostProcess): PostProcess;
  15901. /**
  15902. * Reverses the effect of calling shareOutputWith and returns the post process back to its original state.
  15903. * This should be called if the post process that shares output with this post process is disabled/disposed.
  15904. */
  15905. useOwnOutput(): void;
  15906. /**
  15907. * Updates the effect with the current post process compile time values and recompiles the shader.
  15908. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  15909. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  15910. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  15911. * @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
  15912. * @param onCompiled Called when the shader has been compiled.
  15913. * @param onError Called if there is an error when compiling a shader.
  15914. */
  15915. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  15916. /**
  15917. * The post process is reusable if it can be used multiple times within one frame.
  15918. * @returns If the post process is reusable
  15919. */
  15920. isReusable(): boolean;
  15921. /** invalidate frameBuffer to hint the postprocess to create a depth buffer */
  15922. markTextureDirty(): void;
  15923. /**
  15924. * Activates the post process by intializing the textures to be used when executed. Notifies onActivateObservable.
  15925. * 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.
  15926. * @param camera The camera that will be used in the post process. This camera will be used when calling onActivateObservable.
  15927. * @param sourceTexture The source texture to be inspected to get the width and height if not specified in the post process constructor. (default: null)
  15928. * @param forceDepthStencil If true, a depth and stencil buffer will be generated. (default: false)
  15929. * @returns The target texture that was bound to be written to.
  15930. */
  15931. activate(camera: Nullable<Camera>, sourceTexture?: Nullable<InternalTexture>, forceDepthStencil?: boolean): InternalTexture;
  15932. /**
  15933. * If the post process is supported.
  15934. */
  15935. readonly isSupported: boolean;
  15936. /**
  15937. * The aspect ratio of the output texture.
  15938. */
  15939. readonly aspectRatio: number;
  15940. /**
  15941. * Get a value indicating if the post-process is ready to be used
  15942. * @returns true if the post-process is ready (shader is compiled)
  15943. */
  15944. isReady(): boolean;
  15945. /**
  15946. * Binds all textures and uniforms to the shader, this will be run on every pass.
  15947. * @returns the effect corresponding to this post process. Null if not compiled or not ready.
  15948. */
  15949. apply(): Nullable<Effect>;
  15950. private _disposeTextures;
  15951. /**
  15952. * Disposes the post process.
  15953. * @param camera The camera to dispose the post process on.
  15954. */
  15955. dispose(camera?: Camera): void;
  15956. }
  15957. }
  15958. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration" {
  15959. /** @hidden */
  15960. export var kernelBlurVaryingDeclaration: {
  15961. name: string;
  15962. shader: string;
  15963. };
  15964. }
  15965. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurFragment" {
  15966. /** @hidden */
  15967. export var kernelBlurFragment: {
  15968. name: string;
  15969. shader: string;
  15970. };
  15971. }
  15972. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurFragment2" {
  15973. /** @hidden */
  15974. export var kernelBlurFragment2: {
  15975. name: string;
  15976. shader: string;
  15977. };
  15978. }
  15979. declare module "babylonjs/Shaders/kernelBlur.fragment" {
  15980. import "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration";
  15981. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  15982. import "babylonjs/Shaders/ShadersInclude/kernelBlurFragment";
  15983. import "babylonjs/Shaders/ShadersInclude/kernelBlurFragment2";
  15984. /** @hidden */
  15985. export var kernelBlurPixelShader: {
  15986. name: string;
  15987. shader: string;
  15988. };
  15989. }
  15990. declare module "babylonjs/Shaders/ShadersInclude/kernelBlurVertex" {
  15991. /** @hidden */
  15992. export var kernelBlurVertex: {
  15993. name: string;
  15994. shader: string;
  15995. };
  15996. }
  15997. declare module "babylonjs/Shaders/kernelBlur.vertex" {
  15998. import "babylonjs/Shaders/ShadersInclude/kernelBlurVaryingDeclaration";
  15999. import "babylonjs/Shaders/ShadersInclude/kernelBlurVertex";
  16000. /** @hidden */
  16001. export var kernelBlurVertexShader: {
  16002. name: string;
  16003. shader: string;
  16004. };
  16005. }
  16006. declare module "babylonjs/PostProcesses/blurPostProcess" {
  16007. import { Vector2 } from "babylonjs/Maths/math.vector";
  16008. import { Nullable } from "babylonjs/types";
  16009. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  16010. import { Camera } from "babylonjs/Cameras/camera";
  16011. import { Effect } from "babylonjs/Materials/effect";
  16012. import { Engine } from "babylonjs/Engines/engine";
  16013. import "babylonjs/Shaders/kernelBlur.fragment";
  16014. import "babylonjs/Shaders/kernelBlur.vertex";
  16015. /**
  16016. * The Blur Post Process which blurs an image based on a kernel and direction.
  16017. * Can be used twice in x and y directions to perform a guassian blur in two passes.
  16018. */
  16019. export class BlurPostProcess extends PostProcess {
  16020. /** The direction in which to blur the image. */
  16021. direction: Vector2;
  16022. private blockCompilation;
  16023. protected _kernel: number;
  16024. protected _idealKernel: number;
  16025. protected _packedFloat: boolean;
  16026. private _staticDefines;
  16027. /**
  16028. * Sets the length in pixels of the blur sample region
  16029. */
  16030. /**
  16031. * Gets the length in pixels of the blur sample region
  16032. */
  16033. kernel: number;
  16034. /**
  16035. * Sets wether or not the blur needs to unpack/repack floats
  16036. */
  16037. /**
  16038. * Gets wether or not the blur is unpacking/repacking floats
  16039. */
  16040. packedFloat: boolean;
  16041. /**
  16042. * Creates a new instance BlurPostProcess
  16043. * @param name The name of the effect.
  16044. * @param direction The direction in which to blur the image.
  16045. * @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.
  16046. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  16047. * @param camera The camera to apply the render pass to.
  16048. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  16049. * @param engine The engine which the post process will be applied. (default: current engine)
  16050. * @param reusable If the post process can be reused on the same frame. (default: false)
  16051. * @param textureType Type of textures used when performing the post process. (default: 0)
  16052. * @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)
  16053. */
  16054. constructor(name: string,
  16055. /** The direction in which to blur the image. */
  16056. direction: Vector2, kernel: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, defines?: string, blockCompilation?: boolean);
  16057. /**
  16058. * Updates the effect with the current post process compile time values and recompiles the shader.
  16059. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  16060. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  16061. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  16062. * @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
  16063. * @param onCompiled Called when the shader has been compiled.
  16064. * @param onError Called if there is an error when compiling a shader.
  16065. */
  16066. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  16067. protected _updateParameters(onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  16068. /**
  16069. * Best kernels are odd numbers that when divided by 2, their integer part is even, so 5, 9 or 13.
  16070. * Other odd kernels optimize correctly but require proportionally more samples, even kernels are
  16071. * possible but will produce minor visual artifacts. Since each new kernel requires a new shader we
  16072. * want to minimize kernel changes, having gaps between physical kernels is helpful in that regard.
  16073. * The gaps between physical kernels are compensated for in the weighting of the samples
  16074. * @param idealKernel Ideal blur kernel.
  16075. * @return Nearest best kernel.
  16076. */
  16077. protected _nearestBestKernel(idealKernel: number): number;
  16078. /**
  16079. * Calculates the value of a Gaussian distribution with sigma 3 at a given point.
  16080. * @param x The point on the Gaussian distribution to sample.
  16081. * @return the value of the Gaussian function at x.
  16082. */
  16083. protected _gaussianWeight(x: number): number;
  16084. /**
  16085. * Generates a string that can be used as a floating point number in GLSL.
  16086. * @param x Value to print.
  16087. * @param decimalFigures Number of decimal places to print the number to (excluding trailing 0s).
  16088. * @return GLSL float string.
  16089. */
  16090. protected _glslFloat(x: number, decimalFigures?: number): string;
  16091. }
  16092. }
  16093. declare module "babylonjs/Materials/Textures/mirrorTexture" {
  16094. import { Scene } from "babylonjs/scene";
  16095. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  16096. import { Plane } from "babylonjs/Maths/math.plane";
  16097. /**
  16098. * Mirror texture can be used to simulate the view from a mirror in a scene.
  16099. * It will dynamically be rendered every frame to adapt to the camera point of view.
  16100. * You can then easily use it as a reflectionTexture on a flat surface.
  16101. * In case the surface is not a plane, please consider relying on reflection probes.
  16102. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  16103. */
  16104. export class MirrorTexture extends RenderTargetTexture {
  16105. private scene;
  16106. /**
  16107. * Define the reflection plane we want to use. The mirrorPlane is usually set to the constructed reflector.
  16108. * 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.
  16109. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  16110. */
  16111. mirrorPlane: Plane;
  16112. /**
  16113. * Define the blur ratio used to blur the reflection if needed.
  16114. */
  16115. blurRatio: number;
  16116. /**
  16117. * Define the adaptive blur kernel used to blur the reflection if needed.
  16118. * This will autocompute the closest best match for the `blurKernel`
  16119. */
  16120. adaptiveBlurKernel: number;
  16121. /**
  16122. * Define the blur kernel used to blur the reflection if needed.
  16123. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  16124. */
  16125. blurKernel: number;
  16126. /**
  16127. * Define the blur kernel on the X Axis used to blur the reflection if needed.
  16128. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  16129. */
  16130. blurKernelX: number;
  16131. /**
  16132. * Define the blur kernel on the Y Axis used to blur the reflection if needed.
  16133. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  16134. */
  16135. blurKernelY: number;
  16136. private _autoComputeBlurKernel;
  16137. protected _onRatioRescale(): void;
  16138. private _updateGammaSpace;
  16139. private _imageProcessingConfigChangeObserver;
  16140. private _transformMatrix;
  16141. private _mirrorMatrix;
  16142. private _savedViewMatrix;
  16143. private _blurX;
  16144. private _blurY;
  16145. private _adaptiveBlurKernel;
  16146. private _blurKernelX;
  16147. private _blurKernelY;
  16148. private _blurRatio;
  16149. /**
  16150. * Instantiates a Mirror Texture.
  16151. * Mirror texture can be used to simulate the view from a mirror in a scene.
  16152. * It will dynamically be rendered every frame to adapt to the camera point of view.
  16153. * You can then easily use it as a reflectionTexture on a flat surface.
  16154. * In case the surface is not a plane, please consider relying on reflection probes.
  16155. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  16156. * @param name
  16157. * @param size
  16158. * @param scene
  16159. * @param generateMipMaps
  16160. * @param type
  16161. * @param samplingMode
  16162. * @param generateDepthBuffer
  16163. */
  16164. constructor(name: string, size: number | {
  16165. width: number;
  16166. height: number;
  16167. } | {
  16168. ratio: number;
  16169. }, scene: Scene, generateMipMaps?: boolean, type?: number, samplingMode?: number, generateDepthBuffer?: boolean);
  16170. private _preparePostProcesses;
  16171. /**
  16172. * Clone the mirror texture.
  16173. * @returns the cloned texture
  16174. */
  16175. clone(): MirrorTexture;
  16176. /**
  16177. * Serialize the texture to a JSON representation you could use in Parse later on
  16178. * @returns the serialized JSON representation
  16179. */
  16180. serialize(): any;
  16181. /**
  16182. * Dispose the texture and release its associated resources.
  16183. */
  16184. dispose(): void;
  16185. }
  16186. }
  16187. declare module "babylonjs/Materials/Textures/texture" {
  16188. import { Observable } from "babylonjs/Misc/observable";
  16189. import { Nullable } from "babylonjs/types";
  16190. import { Matrix } from "babylonjs/Maths/math.vector";
  16191. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  16192. import { IInspectable } from "babylonjs/Misc/iInspectable";
  16193. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  16194. import { Scene } from "babylonjs/scene";
  16195. /**
  16196. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  16197. * @see http://doc.babylonjs.com/babylon101/materials#texture
  16198. */
  16199. export class Texture extends BaseTexture {
  16200. /**
  16201. * Gets or sets a general boolean used to indicate that textures containing direct data (buffers) must be saved as part of the serialization process
  16202. */
  16203. static SerializeBuffers: boolean;
  16204. /** @hidden */
  16205. static _CubeTextureParser: (jsonTexture: any, scene: import("babylonjs/scene").Scene, rootUrl: string) => import("babylonjs/Materials/Textures/cubeTexture").CubeTexture;
  16206. /** @hidden */
  16207. static _CreateMirror: (name: string, renderTargetSize: number, scene: import("babylonjs/scene").Scene, generateMipMaps: boolean) => import("babylonjs/Materials/Textures/mirrorTexture").MirrorTexture;
  16208. /** @hidden */
  16209. static _CreateRenderTargetTexture: (name: string, renderTargetSize: number, scene: import("babylonjs/scene").Scene, generateMipMaps: boolean) => import("babylonjs/Materials/Textures/renderTargetTexture").RenderTargetTexture;
  16210. /** nearest is mag = nearest and min = nearest and mip = linear */
  16211. static readonly NEAREST_SAMPLINGMODE: number;
  16212. /** nearest is mag = nearest and min = nearest and mip = linear */
  16213. static readonly NEAREST_NEAREST_MIPLINEAR: number;
  16214. /** Bilinear is mag = linear and min = linear and mip = nearest */
  16215. static readonly BILINEAR_SAMPLINGMODE: number;
  16216. /** Bilinear is mag = linear and min = linear and mip = nearest */
  16217. static readonly LINEAR_LINEAR_MIPNEAREST: number;
  16218. /** Trilinear is mag = linear and min = linear and mip = linear */
  16219. static readonly TRILINEAR_SAMPLINGMODE: number;
  16220. /** Trilinear is mag = linear and min = linear and mip = linear */
  16221. static readonly LINEAR_LINEAR_MIPLINEAR: number;
  16222. /** mag = nearest and min = nearest and mip = nearest */
  16223. static readonly NEAREST_NEAREST_MIPNEAREST: number;
  16224. /** mag = nearest and min = linear and mip = nearest */
  16225. static readonly NEAREST_LINEAR_MIPNEAREST: number;
  16226. /** mag = nearest and min = linear and mip = linear */
  16227. static readonly NEAREST_LINEAR_MIPLINEAR: number;
  16228. /** mag = nearest and min = linear and mip = none */
  16229. static readonly NEAREST_LINEAR: number;
  16230. /** mag = nearest and min = nearest and mip = none */
  16231. static readonly NEAREST_NEAREST: number;
  16232. /** mag = linear and min = nearest and mip = nearest */
  16233. static readonly LINEAR_NEAREST_MIPNEAREST: number;
  16234. /** mag = linear and min = nearest and mip = linear */
  16235. static readonly LINEAR_NEAREST_MIPLINEAR: number;
  16236. /** mag = linear and min = linear and mip = none */
  16237. static readonly LINEAR_LINEAR: number;
  16238. /** mag = linear and min = nearest and mip = none */
  16239. static readonly LINEAR_NEAREST: number;
  16240. /** Explicit coordinates mode */
  16241. static readonly EXPLICIT_MODE: number;
  16242. /** Spherical coordinates mode */
  16243. static readonly SPHERICAL_MODE: number;
  16244. /** Planar coordinates mode */
  16245. static readonly PLANAR_MODE: number;
  16246. /** Cubic coordinates mode */
  16247. static readonly CUBIC_MODE: number;
  16248. /** Projection coordinates mode */
  16249. static readonly PROJECTION_MODE: number;
  16250. /** Inverse Cubic coordinates mode */
  16251. static readonly SKYBOX_MODE: number;
  16252. /** Inverse Cubic coordinates mode */
  16253. static readonly INVCUBIC_MODE: number;
  16254. /** Equirectangular coordinates mode */
  16255. static readonly EQUIRECTANGULAR_MODE: number;
  16256. /** Equirectangular Fixed coordinates mode */
  16257. static readonly FIXED_EQUIRECTANGULAR_MODE: number;
  16258. /** Equirectangular Fixed Mirrored coordinates mode */
  16259. static readonly FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  16260. /** Texture is not repeating outside of 0..1 UVs */
  16261. static readonly CLAMP_ADDRESSMODE: number;
  16262. /** Texture is repeating outside of 0..1 UVs */
  16263. static readonly WRAP_ADDRESSMODE: number;
  16264. /** Texture is repeating and mirrored */
  16265. static readonly MIRROR_ADDRESSMODE: number;
  16266. /**
  16267. * 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
  16268. */
  16269. static UseSerializedUrlIfAny: boolean;
  16270. /**
  16271. * Define the url of the texture.
  16272. */
  16273. url: Nullable<string>;
  16274. /**
  16275. * Define an offset on the texture to offset the u coordinates of the UVs
  16276. * @see http://doc.babylonjs.com/how_to/more_materials#offsetting
  16277. */
  16278. uOffset: number;
  16279. /**
  16280. * Define an offset on the texture to offset the v coordinates of the UVs
  16281. * @see http://doc.babylonjs.com/how_to/more_materials#offsetting
  16282. */
  16283. vOffset: number;
  16284. /**
  16285. * Define an offset on the texture to scale the u coordinates of the UVs
  16286. * @see http://doc.babylonjs.com/how_to/more_materials#tiling
  16287. */
  16288. uScale: number;
  16289. /**
  16290. * Define an offset on the texture to scale the v coordinates of the UVs
  16291. * @see http://doc.babylonjs.com/how_to/more_materials#tiling
  16292. */
  16293. vScale: number;
  16294. /**
  16295. * Define an offset on the texture to rotate around the u coordinates of the UVs
  16296. * @see http://doc.babylonjs.com/how_to/more_materials
  16297. */
  16298. uAng: number;
  16299. /**
  16300. * Define an offset on the texture to rotate around the v coordinates of the UVs
  16301. * @see http://doc.babylonjs.com/how_to/more_materials
  16302. */
  16303. vAng: number;
  16304. /**
  16305. * Define an offset on the texture to rotate around the w coordinates of the UVs (in case of 3d texture)
  16306. * @see http://doc.babylonjs.com/how_to/more_materials
  16307. */
  16308. wAng: number;
  16309. /**
  16310. * Defines the center of rotation (U)
  16311. */
  16312. uRotationCenter: number;
  16313. /**
  16314. * Defines the center of rotation (V)
  16315. */
  16316. vRotationCenter: number;
  16317. /**
  16318. * Defines the center of rotation (W)
  16319. */
  16320. wRotationCenter: number;
  16321. /**
  16322. * Are mip maps generated for this texture or not.
  16323. */
  16324. readonly noMipmap: boolean;
  16325. /**
  16326. * List of inspectable custom properties (used by the Inspector)
  16327. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  16328. */
  16329. inspectableCustomProperties: Nullable<IInspectable[]>;
  16330. private _noMipmap;
  16331. /** @hidden */
  16332. _invertY: boolean;
  16333. private _rowGenerationMatrix;
  16334. private _cachedTextureMatrix;
  16335. private _projectionModeMatrix;
  16336. private _t0;
  16337. private _t1;
  16338. private _t2;
  16339. private _cachedUOffset;
  16340. private _cachedVOffset;
  16341. private _cachedUScale;
  16342. private _cachedVScale;
  16343. private _cachedUAng;
  16344. private _cachedVAng;
  16345. private _cachedWAng;
  16346. private _cachedProjectionMatrixId;
  16347. private _cachedCoordinatesMode;
  16348. /** @hidden */
  16349. protected _initialSamplingMode: number;
  16350. /** @hidden */
  16351. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  16352. private _deleteBuffer;
  16353. protected _format: Nullable<number>;
  16354. private _delayedOnLoad;
  16355. private _delayedOnError;
  16356. private _mimeType?;
  16357. /**
  16358. * Observable triggered once the texture has been loaded.
  16359. */
  16360. onLoadObservable: Observable<Texture>;
  16361. protected _isBlocking: boolean;
  16362. /**
  16363. * Is the texture preventing material to render while loading.
  16364. * If false, a default texture will be used instead of the loading one during the preparation step.
  16365. */
  16366. isBlocking: boolean;
  16367. /**
  16368. * Get the current sampling mode associated with the texture.
  16369. */
  16370. readonly samplingMode: number;
  16371. /**
  16372. * Gets a boolean indicating if the texture needs to be inverted on the y axis during loading
  16373. */
  16374. readonly invertY: boolean;
  16375. /**
  16376. * Instantiates a new texture.
  16377. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  16378. * @see http://doc.babylonjs.com/babylon101/materials#texture
  16379. * @param url defines the url of the picture to load as a texture
  16380. * @param scene defines the scene or engine the texture will belong to
  16381. * @param noMipmap defines if the texture will require mip maps or not
  16382. * @param invertY defines if the texture needs to be inverted on the y axis during loading
  16383. * @param samplingMode defines the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  16384. * @param onLoad defines a callback triggered when the texture has been loaded
  16385. * @param onError defines a callback triggered when an error occurred during the loading session
  16386. * @param buffer defines the buffer to load the texture from in case the texture is loaded from a buffer representation
  16387. * @param deleteBuffer defines if the buffer we are loading the texture from should be deleted after load
  16388. * @param format defines the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  16389. * @param mimeType defines an optional mime type information
  16390. */
  16391. 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);
  16392. /**
  16393. * Update the url (and optional buffer) of this texture if url was null during construction.
  16394. * @param url the url of the texture
  16395. * @param buffer the buffer of the texture (defaults to null)
  16396. * @param onLoad callback called when the texture is loaded (defaults to null)
  16397. */
  16398. updateURL(url: string, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob>, onLoad?: () => void): void;
  16399. /**
  16400. * Finish the loading sequence of a texture flagged as delayed load.
  16401. * @hidden
  16402. */
  16403. delayLoad(): void;
  16404. private _prepareRowForTextureGeneration;
  16405. /**
  16406. * Get the current texture matrix which includes the requested offsetting, tiling and rotation components.
  16407. * @returns the transform matrix of the texture.
  16408. */
  16409. getTextureMatrix(): Matrix;
  16410. /**
  16411. * Get the current matrix used to apply reflection. This is useful to rotate an environment texture for instance.
  16412. * @returns The reflection texture transform
  16413. */
  16414. getReflectionTextureMatrix(): Matrix;
  16415. /**
  16416. * Clones the texture.
  16417. * @returns the cloned texture
  16418. */
  16419. clone(): Texture;
  16420. /**
  16421. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  16422. * @returns The JSON representation of the texture
  16423. */
  16424. serialize(): any;
  16425. /**
  16426. * Get the current class name of the texture useful for serialization or dynamic coding.
  16427. * @returns "Texture"
  16428. */
  16429. getClassName(): string;
  16430. /**
  16431. * Dispose the texture and release its associated resources.
  16432. */
  16433. dispose(): void;
  16434. /**
  16435. * Parse the JSON representation of a texture in order to recreate the texture in the given scene.
  16436. * @param parsedTexture Define the JSON representation of the texture
  16437. * @param scene Define the scene the parsed texture should be instantiated in
  16438. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  16439. * @returns The parsed texture if successful
  16440. */
  16441. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<BaseTexture>;
  16442. /**
  16443. * Creates a texture from its base 64 representation.
  16444. * @param data Define the base64 payload without the data: prefix
  16445. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  16446. * @param scene Define the scene the texture should belong to
  16447. * @param noMipmap Forces the texture to not create mip map information if true
  16448. * @param invertY define if the texture needs to be inverted on the y axis during loading
  16449. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  16450. * @param onLoad define a callback triggered when the texture has been loaded
  16451. * @param onError define a callback triggered when an error occurred during the loading session
  16452. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  16453. * @returns the created texture
  16454. */
  16455. static CreateFromBase64String(data: string, name: string, scene: Scene, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<() => void>, format?: number): Texture;
  16456. /**
  16457. * Creates a texture from its data: representation. (data: will be added in case only the payload has been passed in)
  16458. * @param data Define the base64 payload without the data: prefix
  16459. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  16460. * @param buffer define the buffer to load the texture from in case the texture is loaded from a buffer representation
  16461. * @param scene Define the scene the texture should belong to
  16462. * @param deleteBuffer define if the buffer we are loading the texture from should be deleted after load
  16463. * @param noMipmap Forces the texture to not create mip map information if true
  16464. * @param invertY define if the texture needs to be inverted on the y axis during loading
  16465. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  16466. * @param onLoad define a callback triggered when the texture has been loaded
  16467. * @param onError define a callback triggered when an error occurred during the loading session
  16468. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  16469. * @returns the created texture
  16470. */
  16471. 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;
  16472. }
  16473. }
  16474. declare module "babylonjs/PostProcesses/postProcessManager" {
  16475. import { Nullable } from "babylonjs/types";
  16476. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  16477. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  16478. import { Scene } from "babylonjs/scene";
  16479. /**
  16480. * PostProcessManager is used to manage one or more post processes or post process pipelines
  16481. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  16482. */
  16483. export class PostProcessManager {
  16484. private _scene;
  16485. private _indexBuffer;
  16486. private _vertexBuffers;
  16487. /**
  16488. * Creates a new instance PostProcess
  16489. * @param scene The scene that the post process is associated with.
  16490. */
  16491. constructor(scene: Scene);
  16492. private _prepareBuffers;
  16493. private _buildIndexBuffer;
  16494. /**
  16495. * Rebuilds the vertex buffers of the manager.
  16496. * @hidden
  16497. */
  16498. _rebuild(): void;
  16499. /**
  16500. * Prepares a frame to be run through a post process.
  16501. * @param sourceTexture The input texture to the post procesess. (default: null)
  16502. * @param postProcesses An array of post processes to be run. (default: null)
  16503. * @returns True if the post processes were able to be run.
  16504. * @hidden
  16505. */
  16506. _prepareFrame(sourceTexture?: Nullable<InternalTexture>, postProcesses?: Nullable<PostProcess[]>): boolean;
  16507. /**
  16508. * Manually render a set of post processes to a texture.
  16509. * @param postProcesses An array of post processes to be run.
  16510. * @param targetTexture The target texture to render to.
  16511. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight
  16512. * @param faceIndex defines the face to render to if a cubemap is defined as the target
  16513. * @param lodLevel defines which lod of the texture to render to
  16514. */
  16515. directRender(postProcesses: PostProcess[], targetTexture?: Nullable<InternalTexture>, forceFullscreenViewport?: boolean, faceIndex?: number, lodLevel?: number): void;
  16516. /**
  16517. * Finalize the result of the output of the postprocesses.
  16518. * @param doNotPresent If true the result will not be displayed to the screen.
  16519. * @param targetTexture The target texture to render to.
  16520. * @param faceIndex The index of the face to bind the target texture to.
  16521. * @param postProcesses The array of post processes to render.
  16522. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight (default: false)
  16523. * @hidden
  16524. */
  16525. _finalizeFrame(doNotPresent?: boolean, targetTexture?: InternalTexture, faceIndex?: number, postProcesses?: Array<PostProcess>, forceFullscreenViewport?: boolean): void;
  16526. /**
  16527. * Disposes of the post process manager.
  16528. */
  16529. dispose(): void;
  16530. }
  16531. }
  16532. declare module "babylonjs/Misc/gradients" {
  16533. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  16534. /** Interface used by value gradients (color, factor, ...) */
  16535. export interface IValueGradient {
  16536. /**
  16537. * Gets or sets the gradient value (between 0 and 1)
  16538. */
  16539. gradient: number;
  16540. }
  16541. /** Class used to store color4 gradient */
  16542. export class ColorGradient implements IValueGradient {
  16543. /**
  16544. * Gets or sets the gradient value (between 0 and 1)
  16545. */
  16546. gradient: number;
  16547. /**
  16548. * Gets or sets first associated color
  16549. */
  16550. color1: Color4;
  16551. /**
  16552. * Gets or sets second associated color
  16553. */
  16554. color2?: Color4;
  16555. /**
  16556. * Will get a color picked randomly between color1 and color2.
  16557. * If color2 is undefined then color1 will be used
  16558. * @param result defines the target Color4 to store the result in
  16559. */
  16560. getColorToRef(result: Color4): void;
  16561. }
  16562. /** Class used to store color 3 gradient */
  16563. export class Color3Gradient implements IValueGradient {
  16564. /**
  16565. * Gets or sets the gradient value (between 0 and 1)
  16566. */
  16567. gradient: number;
  16568. /**
  16569. * Gets or sets the associated color
  16570. */
  16571. color: Color3;
  16572. }
  16573. /** Class used to store factor gradient */
  16574. export class FactorGradient implements IValueGradient {
  16575. /**
  16576. * Gets or sets the gradient value (between 0 and 1)
  16577. */
  16578. gradient: number;
  16579. /**
  16580. * Gets or sets first associated factor
  16581. */
  16582. factor1: number;
  16583. /**
  16584. * Gets or sets second associated factor
  16585. */
  16586. factor2?: number;
  16587. /**
  16588. * Will get a number picked randomly between factor1 and factor2.
  16589. * If factor2 is undefined then factor1 will be used
  16590. * @returns the picked number
  16591. */
  16592. getFactor(): number;
  16593. }
  16594. /**
  16595. * Helper used to simplify some generic gradient tasks
  16596. */
  16597. export class GradientHelper {
  16598. /**
  16599. * Gets the current gradient from an array of IValueGradient
  16600. * @param ratio defines the current ratio to get
  16601. * @param gradients defines the array of IValueGradient
  16602. * @param updateFunc defines the callback function used to get the final value from the selected gradients
  16603. */
  16604. static GetCurrentGradient(ratio: number, gradients: IValueGradient[], updateFunc: (current: IValueGradient, next: IValueGradient, scale: number) => void): void;
  16605. }
  16606. }
  16607. declare module "babylonjs/Engines/Extensions/engine.dynamicTexture" {
  16608. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  16609. import { Nullable } from "babylonjs/types";
  16610. module "babylonjs/Engines/thinEngine" {
  16611. interface ThinEngine {
  16612. /**
  16613. * Creates a dynamic texture
  16614. * @param width defines the width of the texture
  16615. * @param height defines the height of the texture
  16616. * @param generateMipMaps defines if the engine should generate the mip levels
  16617. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  16618. * @returns the dynamic texture inside an InternalTexture
  16619. */
  16620. createDynamicTexture(width: number, height: number, generateMipMaps: boolean, samplingMode: number): InternalTexture;
  16621. /**
  16622. * Update the content of a dynamic texture
  16623. * @param texture defines the texture to update
  16624. * @param canvas defines the canvas containing the source
  16625. * @param invertY defines if data must be stored with Y axis inverted
  16626. * @param premulAlpha defines if alpha is stored as premultiplied
  16627. * @param format defines the format of the data
  16628. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  16629. */
  16630. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement | OffscreenCanvas, invertY: boolean, premulAlpha?: boolean, format?: number, forceBindTexture?: boolean): void;
  16631. }
  16632. }
  16633. }
  16634. declare module "babylonjs/Misc/canvasGenerator" {
  16635. /**
  16636. * Helper class used to generate a canvas to manipulate images
  16637. */
  16638. export class CanvasGenerator {
  16639. /**
  16640. * Create a new canvas (or offscreen canvas depending on the context)
  16641. * @param width defines the expected width
  16642. * @param height defines the expected height
  16643. * @return a new canvas or offscreen canvas
  16644. */
  16645. static CreateCanvas(width: number, height: number): HTMLCanvasElement | OffscreenCanvas;
  16646. }
  16647. }
  16648. declare module "babylonjs/Materials/Textures/dynamicTexture" {
  16649. import { Scene } from "babylonjs/scene";
  16650. import { Texture } from "babylonjs/Materials/Textures/texture";
  16651. import "babylonjs/Engines/Extensions/engine.dynamicTexture";
  16652. /**
  16653. * A class extending Texture allowing drawing on a texture
  16654. * @see http://doc.babylonjs.com/how_to/dynamictexture
  16655. */
  16656. export class DynamicTexture extends Texture {
  16657. private _generateMipMaps;
  16658. private _canvas;
  16659. private _context;
  16660. private _engine;
  16661. /**
  16662. * Creates a DynamicTexture
  16663. * @param name defines the name of the texture
  16664. * @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
  16665. * @param scene defines the scene where you want the texture
  16666. * @param generateMipMaps defines the use of MinMaps or not (default is false)
  16667. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  16668. * @param format defines the texture format to use (default is Engine.TEXTUREFORMAT_RGBA)
  16669. */
  16670. constructor(name: string, options: any, scene: Scene | null | undefined, generateMipMaps: boolean, samplingMode?: number, format?: number);
  16671. /**
  16672. * Get the current class name of the texture useful for serialization or dynamic coding.
  16673. * @returns "DynamicTexture"
  16674. */
  16675. getClassName(): string;
  16676. /**
  16677. * Gets the current state of canRescale
  16678. */
  16679. readonly canRescale: boolean;
  16680. private _recreate;
  16681. /**
  16682. * Scales the texture
  16683. * @param ratio the scale factor to apply to both width and height
  16684. */
  16685. scale(ratio: number): void;
  16686. /**
  16687. * Resizes the texture
  16688. * @param width the new width
  16689. * @param height the new height
  16690. */
  16691. scaleTo(width: number, height: number): void;
  16692. /**
  16693. * Gets the context of the canvas used by the texture
  16694. * @returns the canvas context of the dynamic texture
  16695. */
  16696. getContext(): CanvasRenderingContext2D;
  16697. /**
  16698. * Clears the texture
  16699. */
  16700. clear(): void;
  16701. /**
  16702. * Updates the texture
  16703. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  16704. * @param premulAlpha defines if alpha is stored as premultiplied (default is false)
  16705. */
  16706. update(invertY?: boolean, premulAlpha?: boolean): void;
  16707. /**
  16708. * Draws text onto the texture
  16709. * @param text defines the text to be drawn
  16710. * @param x defines the placement of the text from the left
  16711. * @param y defines the placement of the text from the top when invertY is true and from the bottom when false
  16712. * @param font defines the font to be used with font-style, font-size, font-name
  16713. * @param color defines the color used for the text
  16714. * @param clearColor defines the color for the canvas, use null to not overwrite canvas
  16715. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  16716. * @param update defines whether texture is immediately update (default is true)
  16717. */
  16718. drawText(text: string, x: number, y: number, font: string, color: string, clearColor: string, invertY?: boolean, update?: boolean): void;
  16719. /**
  16720. * Clones the texture
  16721. * @returns the clone of the texture.
  16722. */
  16723. clone(): DynamicTexture;
  16724. /**
  16725. * Serializes the dynamic texture. The scene should be ready before the dynamic texture is serialized
  16726. * @returns a serialized dynamic texture object
  16727. */
  16728. serialize(): any;
  16729. /** @hidden */
  16730. _rebuild(): void;
  16731. }
  16732. }
  16733. declare module "babylonjs/Materials/Textures/Procedurals/proceduralTextureSceneComponent" {
  16734. import { Scene } from "babylonjs/scene";
  16735. import { ISceneComponent } from "babylonjs/sceneComponent";
  16736. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  16737. module "babylonjs/abstractScene" {
  16738. interface AbstractScene {
  16739. /**
  16740. * The list of procedural textures added to the scene
  16741. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  16742. */
  16743. proceduralTextures: Array<ProceduralTexture>;
  16744. }
  16745. }
  16746. /**
  16747. * Defines the Procedural Texture scene component responsible to manage any Procedural Texture
  16748. * in a given scene.
  16749. */
  16750. export class ProceduralTextureSceneComponent implements ISceneComponent {
  16751. /**
  16752. * The component name helpfull to identify the component in the list of scene components.
  16753. */
  16754. readonly name: string;
  16755. /**
  16756. * The scene the component belongs to.
  16757. */
  16758. scene: Scene;
  16759. /**
  16760. * Creates a new instance of the component for the given scene
  16761. * @param scene Defines the scene to register the component in
  16762. */
  16763. constructor(scene: Scene);
  16764. /**
  16765. * Registers the component in a given scene
  16766. */
  16767. register(): void;
  16768. /**
  16769. * Rebuilds the elements related to this component in case of
  16770. * context lost for instance.
  16771. */
  16772. rebuild(): void;
  16773. /**
  16774. * Disposes the component and the associated ressources.
  16775. */
  16776. dispose(): void;
  16777. private _beforeClear;
  16778. }
  16779. }
  16780. declare module "babylonjs/Engines/Extensions/engine.renderTargetCube" {
  16781. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  16782. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  16783. module "babylonjs/Engines/thinEngine" {
  16784. interface ThinEngine {
  16785. /**
  16786. * Creates a new render target cube texture
  16787. * @param size defines the size of the texture
  16788. * @param options defines the options used to create the texture
  16789. * @returns a new render target cube texture stored in an InternalTexture
  16790. */
  16791. createRenderTargetCubeTexture(size: number, options?: Partial<RenderTargetCreationOptions>): InternalTexture;
  16792. }
  16793. }
  16794. }
  16795. declare module "babylonjs/Shaders/procedural.vertex" {
  16796. /** @hidden */
  16797. export var proceduralVertexShader: {
  16798. name: string;
  16799. shader: string;
  16800. };
  16801. }
  16802. declare module "babylonjs/Materials/Textures/Procedurals/proceduralTexture" {
  16803. import { Observable } from "babylonjs/Misc/observable";
  16804. import { Nullable } from "babylonjs/types";
  16805. import { Scene } from "babylonjs/scene";
  16806. import { Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  16807. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  16808. import { Effect } from "babylonjs/Materials/effect";
  16809. import { Texture } from "babylonjs/Materials/Textures/texture";
  16810. import "babylonjs/Engines/Extensions/engine.renderTarget";
  16811. import "babylonjs/Engines/Extensions/engine.renderTargetCube";
  16812. import "babylonjs/Shaders/procedural.vertex";
  16813. /**
  16814. * 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.
  16815. * This is the base class of any Procedural texture and contains most of the shareable code.
  16816. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  16817. */
  16818. export class ProceduralTexture extends Texture {
  16819. isCube: boolean;
  16820. /**
  16821. * Define if the texture is enabled or not (disabled texture will not render)
  16822. */
  16823. isEnabled: boolean;
  16824. /**
  16825. * Define if the texture must be cleared before rendering (default is true)
  16826. */
  16827. autoClear: boolean;
  16828. /**
  16829. * Callback called when the texture is generated
  16830. */
  16831. onGenerated: () => void;
  16832. /**
  16833. * Event raised when the texture is generated
  16834. */
  16835. onGeneratedObservable: Observable<ProceduralTexture>;
  16836. /** @hidden */
  16837. _generateMipMaps: boolean;
  16838. /** @hidden **/
  16839. _effect: Effect;
  16840. /** @hidden */
  16841. _textures: {
  16842. [key: string]: Texture;
  16843. };
  16844. private _size;
  16845. private _currentRefreshId;
  16846. private _refreshRate;
  16847. private _vertexBuffers;
  16848. private _indexBuffer;
  16849. private _uniforms;
  16850. private _samplers;
  16851. private _fragment;
  16852. private _floats;
  16853. private _ints;
  16854. private _floatsArrays;
  16855. private _colors3;
  16856. private _colors4;
  16857. private _vectors2;
  16858. private _vectors3;
  16859. private _matrices;
  16860. private _fallbackTexture;
  16861. private _fallbackTextureUsed;
  16862. private _engine;
  16863. private _cachedDefines;
  16864. private _contentUpdateId;
  16865. private _contentData;
  16866. /**
  16867. * Instantiates a new procedural texture.
  16868. * 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.
  16869. * This is the base class of any Procedural texture and contains most of the shareable code.
  16870. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  16871. * @param name Define the name of the texture
  16872. * @param size Define the size of the texture to create
  16873. * @param fragment Define the fragment shader to use to generate the texture or null if it is defined later
  16874. * @param scene Define the scene the texture belongs to
  16875. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  16876. * @param generateMipMaps Define if the texture should creates mip maps or not
  16877. * @param isCube Define if the texture is a cube texture or not (this will render each faces of the cube)
  16878. */
  16879. constructor(name: string, size: any, fragment: any, scene: Nullable<Scene>, fallbackTexture?: Nullable<Texture>, generateMipMaps?: boolean, isCube?: boolean);
  16880. /**
  16881. * The effect that is created when initializing the post process.
  16882. * @returns The created effect corresponding the the postprocess.
  16883. */
  16884. getEffect(): Effect;
  16885. /**
  16886. * Gets texture content (Use this function wisely as reading from a texture can be slow)
  16887. * @returns an ArrayBufferView (Uint8Array or Float32Array)
  16888. */
  16889. getContent(): Nullable<ArrayBufferView>;
  16890. private _createIndexBuffer;
  16891. /** @hidden */
  16892. _rebuild(): void;
  16893. /**
  16894. * Resets the texture in order to recreate its associated resources.
  16895. * This can be called in case of context loss
  16896. */
  16897. reset(): void;
  16898. protected _getDefines(): string;
  16899. /**
  16900. * Is the texture ready to be used ? (rendered at least once)
  16901. * @returns true if ready, otherwise, false.
  16902. */
  16903. isReady(): boolean;
  16904. /**
  16905. * Resets the refresh counter of the texture and start bak from scratch.
  16906. * Could be useful to regenerate the texture if it is setup to render only once.
  16907. */
  16908. resetRefreshCounter(): void;
  16909. /**
  16910. * Set the fragment shader to use in order to render the texture.
  16911. * @param fragment This can be set to a path (into the shader store) or to a json object containing a fragmentElement property.
  16912. */
  16913. setFragment(fragment: any): void;
  16914. /**
  16915. * Define the refresh rate of the texture or the rendering frequency.
  16916. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  16917. */
  16918. refreshRate: number;
  16919. /** @hidden */
  16920. _shouldRender(): boolean;
  16921. /**
  16922. * Get the size the texture is rendering at.
  16923. * @returns the size (texture is always squared)
  16924. */
  16925. getRenderSize(): number;
  16926. /**
  16927. * Resize the texture to new value.
  16928. * @param size Define the new size the texture should have
  16929. * @param generateMipMaps Define whether the new texture should create mip maps
  16930. */
  16931. resize(size: number, generateMipMaps: boolean): void;
  16932. private _checkUniform;
  16933. /**
  16934. * Set a texture in the shader program used to render.
  16935. * @param name Define the name of the uniform samplers as defined in the shader
  16936. * @param texture Define the texture to bind to this sampler
  16937. * @return the texture itself allowing "fluent" like uniform updates
  16938. */
  16939. setTexture(name: string, texture: Texture): ProceduralTexture;
  16940. /**
  16941. * Set a float in the shader.
  16942. * @param name Define the name of the uniform as defined in the shader
  16943. * @param value Define the value to give to the uniform
  16944. * @return the texture itself allowing "fluent" like uniform updates
  16945. */
  16946. setFloat(name: string, value: number): ProceduralTexture;
  16947. /**
  16948. * Set a int in the shader.
  16949. * @param name Define the name of the uniform as defined in the shader
  16950. * @param value Define the value to give to the uniform
  16951. * @return the texture itself allowing "fluent" like uniform updates
  16952. */
  16953. setInt(name: string, value: number): ProceduralTexture;
  16954. /**
  16955. * Set an array of floats in the shader.
  16956. * @param name Define the name of the uniform as defined in the shader
  16957. * @param value Define the value to give to the uniform
  16958. * @return the texture itself allowing "fluent" like uniform updates
  16959. */
  16960. setFloats(name: string, value: number[]): ProceduralTexture;
  16961. /**
  16962. * Set a vec3 in the shader from a Color3.
  16963. * @param name Define the name of the uniform as defined in the shader
  16964. * @param value Define the value to give to the uniform
  16965. * @return the texture itself allowing "fluent" like uniform updates
  16966. */
  16967. setColor3(name: string, value: Color3): ProceduralTexture;
  16968. /**
  16969. * Set a vec4 in the shader from a Color4.
  16970. * @param name Define the name of the uniform as defined in the shader
  16971. * @param value Define the value to give to the uniform
  16972. * @return the texture itself allowing "fluent" like uniform updates
  16973. */
  16974. setColor4(name: string, value: Color4): ProceduralTexture;
  16975. /**
  16976. * Set a vec2 in the shader from a Vector2.
  16977. * @param name Define the name of the uniform as defined in the shader
  16978. * @param value Define the value to give to the uniform
  16979. * @return the texture itself allowing "fluent" like uniform updates
  16980. */
  16981. setVector2(name: string, value: Vector2): ProceduralTexture;
  16982. /**
  16983. * Set a vec3 in the shader from a Vector3.
  16984. * @param name Define the name of the uniform as defined in the shader
  16985. * @param value Define the value to give to the uniform
  16986. * @return the texture itself allowing "fluent" like uniform updates
  16987. */
  16988. setVector3(name: string, value: Vector3): ProceduralTexture;
  16989. /**
  16990. * Set a mat4 in the shader from a MAtrix.
  16991. * @param name Define the name of the uniform as defined in the shader
  16992. * @param value Define the value to give to the uniform
  16993. * @return the texture itself allowing "fluent" like uniform updates
  16994. */
  16995. setMatrix(name: string, value: Matrix): ProceduralTexture;
  16996. /**
  16997. * Render the texture to its associated render target.
  16998. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  16999. */
  17000. render(useCameraPostProcess?: boolean): void;
  17001. /**
  17002. * Clone the texture.
  17003. * @returns the cloned texture
  17004. */
  17005. clone(): ProceduralTexture;
  17006. /**
  17007. * Dispose the texture and release its asoociated resources.
  17008. */
  17009. dispose(): void;
  17010. }
  17011. }
  17012. declare module "babylonjs/Particles/baseParticleSystem" {
  17013. import { Nullable } from "babylonjs/types";
  17014. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  17015. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  17016. import { ImageProcessingConfiguration, ImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  17017. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  17018. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  17019. import { Scene } from "babylonjs/scene";
  17020. import { ColorGradient, FactorGradient, Color3Gradient, IValueGradient } from "babylonjs/Misc/gradients";
  17021. import { BoxParticleEmitter, IParticleEmitterType, PointParticleEmitter, HemisphericParticleEmitter, SphereParticleEmitter, SphereDirectedParticleEmitter, CylinderParticleEmitter, CylinderDirectedParticleEmitter, ConeParticleEmitter } from "babylonjs/Particles/EmitterTypes/index";
  17022. import { Texture } from "babylonjs/Materials/Textures/texture";
  17023. import { Color4 } from "babylonjs/Maths/math.color";
  17024. import { Animation } from "babylonjs/Animations/animation";
  17025. /**
  17026. * This represents the base class for particle system in Babylon.
  17027. * 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.
  17028. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  17029. * @example https://doc.babylonjs.com/babylon101/particles
  17030. */
  17031. export class BaseParticleSystem {
  17032. /**
  17033. * Source color is added to the destination color without alpha affecting the result
  17034. */
  17035. static BLENDMODE_ONEONE: number;
  17036. /**
  17037. * Blend current color and particle color using particle’s alpha
  17038. */
  17039. static BLENDMODE_STANDARD: number;
  17040. /**
  17041. * Add current color and particle color multiplied by particle’s alpha
  17042. */
  17043. static BLENDMODE_ADD: number;
  17044. /**
  17045. * Multiply current color with particle color
  17046. */
  17047. static BLENDMODE_MULTIPLY: number;
  17048. /**
  17049. * Multiply current color with particle color then add current color and particle color multiplied by particle’s alpha
  17050. */
  17051. static BLENDMODE_MULTIPLYADD: number;
  17052. /**
  17053. * List of animations used by the particle system.
  17054. */
  17055. animations: Animation[];
  17056. /**
  17057. * The id of the Particle system.
  17058. */
  17059. id: string;
  17060. /**
  17061. * The friendly name of the Particle system.
  17062. */
  17063. name: string;
  17064. /**
  17065. * The rendering group used by the Particle system to chose when to render.
  17066. */
  17067. renderingGroupId: number;
  17068. /**
  17069. * The emitter represents the Mesh or position we are attaching the particle system to.
  17070. */
  17071. emitter: Nullable<AbstractMesh | Vector3>;
  17072. /**
  17073. * The maximum number of particles to emit per frame
  17074. */
  17075. emitRate: number;
  17076. /**
  17077. * If you want to launch only a few particles at once, that can be done, as well.
  17078. */
  17079. manualEmitCount: number;
  17080. /**
  17081. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  17082. */
  17083. updateSpeed: number;
  17084. /**
  17085. * The amount of time the particle system is running (depends of the overall update speed).
  17086. */
  17087. targetStopDuration: number;
  17088. /**
  17089. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  17090. */
  17091. disposeOnStop: boolean;
  17092. /**
  17093. * Minimum power of emitting particles.
  17094. */
  17095. minEmitPower: number;
  17096. /**
  17097. * Maximum power of emitting particles.
  17098. */
  17099. maxEmitPower: number;
  17100. /**
  17101. * Minimum life time of emitting particles.
  17102. */
  17103. minLifeTime: number;
  17104. /**
  17105. * Maximum life time of emitting particles.
  17106. */
  17107. maxLifeTime: number;
  17108. /**
  17109. * Minimum Size of emitting particles.
  17110. */
  17111. minSize: number;
  17112. /**
  17113. * Maximum Size of emitting particles.
  17114. */
  17115. maxSize: number;
  17116. /**
  17117. * Minimum scale of emitting particles on X axis.
  17118. */
  17119. minScaleX: number;
  17120. /**
  17121. * Maximum scale of emitting particles on X axis.
  17122. */
  17123. maxScaleX: number;
  17124. /**
  17125. * Minimum scale of emitting particles on Y axis.
  17126. */
  17127. minScaleY: number;
  17128. /**
  17129. * Maximum scale of emitting particles on Y axis.
  17130. */
  17131. maxScaleY: number;
  17132. /**
  17133. * Gets or sets the minimal initial rotation in radians.
  17134. */
  17135. minInitialRotation: number;
  17136. /**
  17137. * Gets or sets the maximal initial rotation in radians.
  17138. */
  17139. maxInitialRotation: number;
  17140. /**
  17141. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  17142. */
  17143. minAngularSpeed: number;
  17144. /**
  17145. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  17146. */
  17147. maxAngularSpeed: number;
  17148. /**
  17149. * The texture used to render each particle. (this can be a spritesheet)
  17150. */
  17151. particleTexture: Nullable<Texture>;
  17152. /**
  17153. * The layer mask we are rendering the particles through.
  17154. */
  17155. layerMask: number;
  17156. /**
  17157. * This can help using your own shader to render the particle system.
  17158. * The according effect will be created
  17159. */
  17160. customShader: any;
  17161. /**
  17162. * By default particle system starts as soon as they are created. This prevents the
  17163. * automatic start to happen and let you decide when to start emitting particles.
  17164. */
  17165. preventAutoStart: boolean;
  17166. private _noiseTexture;
  17167. /**
  17168. * Gets or sets a texture used to add random noise to particle positions
  17169. */
  17170. noiseTexture: Nullable<ProceduralTexture>;
  17171. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  17172. noiseStrength: Vector3;
  17173. /**
  17174. * Callback triggered when the particle animation is ending.
  17175. */
  17176. onAnimationEnd: Nullable<() => void>;
  17177. /**
  17178. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE or ParticleSystem.BLENDMODE_STANDARD.
  17179. */
  17180. blendMode: number;
  17181. /**
  17182. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  17183. * to override the particles.
  17184. */
  17185. forceDepthWrite: boolean;
  17186. /** 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 */
  17187. preWarmCycles: number;
  17188. /** Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1) */
  17189. preWarmStepOffset: number;
  17190. /**
  17191. * 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)
  17192. */
  17193. spriteCellChangeSpeed: number;
  17194. /**
  17195. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  17196. */
  17197. startSpriteCellID: number;
  17198. /**
  17199. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  17200. */
  17201. endSpriteCellID: number;
  17202. /**
  17203. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  17204. */
  17205. spriteCellWidth: number;
  17206. /**
  17207. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  17208. */
  17209. spriteCellHeight: number;
  17210. /**
  17211. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  17212. */
  17213. spriteRandomStartCell: boolean;
  17214. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  17215. translationPivot: Vector2;
  17216. /** @hidden */
  17217. protected _isAnimationSheetEnabled: boolean;
  17218. /**
  17219. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  17220. */
  17221. beginAnimationOnStart: boolean;
  17222. /**
  17223. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  17224. */
  17225. beginAnimationFrom: number;
  17226. /**
  17227. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  17228. */
  17229. beginAnimationTo: number;
  17230. /**
  17231. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  17232. */
  17233. beginAnimationLoop: boolean;
  17234. /**
  17235. * Gets or sets a world offset applied to all particles
  17236. */
  17237. worldOffset: Vector3;
  17238. /**
  17239. * Gets or sets whether an animation sprite sheet is enabled or not on the particle system
  17240. */
  17241. isAnimationSheetEnabled: boolean;
  17242. /**
  17243. * Get hosting scene
  17244. * @returns the scene
  17245. */
  17246. getScene(): Scene;
  17247. /**
  17248. * You can use gravity if you want to give an orientation to your particles.
  17249. */
  17250. gravity: Vector3;
  17251. protected _colorGradients: Nullable<Array<ColorGradient>>;
  17252. protected _sizeGradients: Nullable<Array<FactorGradient>>;
  17253. protected _lifeTimeGradients: Nullable<Array<FactorGradient>>;
  17254. protected _angularSpeedGradients: Nullable<Array<FactorGradient>>;
  17255. protected _velocityGradients: Nullable<Array<FactorGradient>>;
  17256. protected _limitVelocityGradients: Nullable<Array<FactorGradient>>;
  17257. protected _dragGradients: Nullable<Array<FactorGradient>>;
  17258. protected _emitRateGradients: Nullable<Array<FactorGradient>>;
  17259. protected _startSizeGradients: Nullable<Array<FactorGradient>>;
  17260. protected _rampGradients: Nullable<Array<Color3Gradient>>;
  17261. protected _colorRemapGradients: Nullable<Array<FactorGradient>>;
  17262. protected _alphaRemapGradients: Nullable<Array<FactorGradient>>;
  17263. protected _hasTargetStopDurationDependantGradient(): boolean | null;
  17264. /**
  17265. * Defines the delay in milliseconds before starting the system (0 by default)
  17266. */
  17267. startDelay: number;
  17268. /**
  17269. * Gets the current list of drag gradients.
  17270. * You must use addDragGradient and removeDragGradient to udpate this list
  17271. * @returns the list of drag gradients
  17272. */
  17273. getDragGradients(): Nullable<Array<FactorGradient>>;
  17274. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  17275. limitVelocityDamping: number;
  17276. /**
  17277. * Gets the current list of limit velocity gradients.
  17278. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  17279. * @returns the list of limit velocity gradients
  17280. */
  17281. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  17282. /**
  17283. * Gets the current list of color gradients.
  17284. * You must use addColorGradient and removeColorGradient to udpate this list
  17285. * @returns the list of color gradients
  17286. */
  17287. getColorGradients(): Nullable<Array<ColorGradient>>;
  17288. /**
  17289. * Gets the current list of size gradients.
  17290. * You must use addSizeGradient and removeSizeGradient to udpate this list
  17291. * @returns the list of size gradients
  17292. */
  17293. getSizeGradients(): Nullable<Array<FactorGradient>>;
  17294. /**
  17295. * Gets the current list of color remap gradients.
  17296. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  17297. * @returns the list of color remap gradients
  17298. */
  17299. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  17300. /**
  17301. * Gets the current list of alpha remap gradients.
  17302. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  17303. * @returns the list of alpha remap gradients
  17304. */
  17305. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  17306. /**
  17307. * Gets the current list of life time gradients.
  17308. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  17309. * @returns the list of life time gradients
  17310. */
  17311. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  17312. /**
  17313. * Gets the current list of angular speed gradients.
  17314. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  17315. * @returns the list of angular speed gradients
  17316. */
  17317. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  17318. /**
  17319. * Gets the current list of velocity gradients.
  17320. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  17321. * @returns the list of velocity gradients
  17322. */
  17323. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  17324. /**
  17325. * Gets the current list of start size gradients.
  17326. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  17327. * @returns the list of start size gradients
  17328. */
  17329. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  17330. /**
  17331. * Gets the current list of emit rate gradients.
  17332. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  17333. * @returns the list of emit rate gradients
  17334. */
  17335. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  17336. /**
  17337. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  17338. * This only works when particleEmitterTyps is a BoxParticleEmitter
  17339. */
  17340. direction1: Vector3;
  17341. /**
  17342. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  17343. * This only works when particleEmitterTyps is a BoxParticleEmitter
  17344. */
  17345. direction2: Vector3;
  17346. /**
  17347. * 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.
  17348. * This only works when particleEmitterTyps is a BoxParticleEmitter
  17349. */
  17350. minEmitBox: Vector3;
  17351. /**
  17352. * 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.
  17353. * This only works when particleEmitterTyps is a BoxParticleEmitter
  17354. */
  17355. maxEmitBox: Vector3;
  17356. /**
  17357. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  17358. */
  17359. color1: Color4;
  17360. /**
  17361. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  17362. */
  17363. color2: Color4;
  17364. /**
  17365. * Color the particle will have at the end of its lifetime
  17366. */
  17367. colorDead: Color4;
  17368. /**
  17369. * An optional mask to filter some colors out of the texture, or filter a part of the alpha channel
  17370. */
  17371. textureMask: Color4;
  17372. /**
  17373. * The particle emitter type defines the emitter used by the particle system.
  17374. * It can be for example box, sphere, or cone...
  17375. */
  17376. particleEmitterType: IParticleEmitterType;
  17377. /** @hidden */
  17378. _isSubEmitter: boolean;
  17379. /**
  17380. * Gets or sets the billboard mode to use when isBillboardBased = true.
  17381. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  17382. */
  17383. billboardMode: number;
  17384. protected _isBillboardBased: boolean;
  17385. /**
  17386. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  17387. */
  17388. isBillboardBased: boolean;
  17389. /**
  17390. * The scene the particle system belongs to.
  17391. */
  17392. protected _scene: Scene;
  17393. /**
  17394. * Local cache of defines for image processing.
  17395. */
  17396. protected _imageProcessingConfigurationDefines: ImageProcessingConfigurationDefines;
  17397. /**
  17398. * Default configuration related to image processing available in the standard Material.
  17399. */
  17400. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  17401. /**
  17402. * Gets the image processing configuration used either in this material.
  17403. */
  17404. /**
  17405. * Sets the Default image processing configuration used either in the this material.
  17406. *
  17407. * If sets to null, the scene one is in use.
  17408. */
  17409. imageProcessingConfiguration: ImageProcessingConfiguration;
  17410. /**
  17411. * Attaches a new image processing configuration to the Standard Material.
  17412. * @param configuration
  17413. */
  17414. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  17415. /** @hidden */
  17416. protected _reset(): void;
  17417. /** @hidden */
  17418. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: Nullable<RawTexture>): BaseParticleSystem;
  17419. /**
  17420. * Instantiates a particle system.
  17421. * 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.
  17422. * @param name The name of the particle system
  17423. */
  17424. constructor(name: string);
  17425. /**
  17426. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  17427. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  17428. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  17429. * @returns the emitter
  17430. */
  17431. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  17432. /**
  17433. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  17434. * @param radius The radius of the hemisphere to emit from
  17435. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  17436. * @returns the emitter
  17437. */
  17438. createHemisphericEmitter(radius?: number, radiusRange?: number): HemisphericParticleEmitter;
  17439. /**
  17440. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  17441. * @param radius The radius of the sphere to emit from
  17442. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  17443. * @returns the emitter
  17444. */
  17445. createSphereEmitter(radius?: number, radiusRange?: number): SphereParticleEmitter;
  17446. /**
  17447. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  17448. * @param radius The radius of the sphere to emit from
  17449. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  17450. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  17451. * @returns the emitter
  17452. */
  17453. createDirectedSphereEmitter(radius?: number, direction1?: Vector3, direction2?: Vector3): SphereDirectedParticleEmitter;
  17454. /**
  17455. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  17456. * @param radius The radius of the emission cylinder
  17457. * @param height The height of the emission cylinder
  17458. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  17459. * @param directionRandomizer How much to randomize the particle direction [0-1]
  17460. * @returns the emitter
  17461. */
  17462. createCylinderEmitter(radius?: number, height?: number, radiusRange?: number, directionRandomizer?: number): CylinderParticleEmitter;
  17463. /**
  17464. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  17465. * @param radius The radius of the cylinder to emit from
  17466. * @param height The height of the emission cylinder
  17467. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  17468. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  17469. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  17470. * @returns the emitter
  17471. */
  17472. createDirectedCylinderEmitter(radius?: number, height?: number, radiusRange?: number, direction1?: Vector3, direction2?: Vector3): CylinderDirectedParticleEmitter;
  17473. /**
  17474. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  17475. * @param radius The radius of the cone to emit from
  17476. * @param angle The base angle of the cone
  17477. * @returns the emitter
  17478. */
  17479. createConeEmitter(radius?: number, angle?: number): ConeParticleEmitter;
  17480. /**
  17481. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  17482. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  17483. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  17484. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  17485. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  17486. * @returns the emitter
  17487. */
  17488. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  17489. }
  17490. }
  17491. declare module "babylonjs/Particles/subEmitter" {
  17492. import { Scene } from "babylonjs/scene";
  17493. import { ParticleSystem } from "babylonjs/Particles/particleSystem";
  17494. /**
  17495. * Type of sub emitter
  17496. */
  17497. export enum SubEmitterType {
  17498. /**
  17499. * Attached to the particle over it's lifetime
  17500. */
  17501. ATTACHED = 0,
  17502. /**
  17503. * Created when the particle dies
  17504. */
  17505. END = 1
  17506. }
  17507. /**
  17508. * Sub emitter class used to emit particles from an existing particle
  17509. */
  17510. export class SubEmitter {
  17511. /**
  17512. * the particle system to be used by the sub emitter
  17513. */
  17514. particleSystem: ParticleSystem;
  17515. /**
  17516. * Type of the submitter (Default: END)
  17517. */
  17518. type: SubEmitterType;
  17519. /**
  17520. * 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)
  17521. * Note: This only is supported when using an emitter of type Mesh
  17522. */
  17523. inheritDirection: boolean;
  17524. /**
  17525. * How much of the attached particles speed should be added to the sub emitted particle (default: 0)
  17526. */
  17527. inheritedVelocityAmount: number;
  17528. /**
  17529. * Creates a sub emitter
  17530. * @param particleSystem the particle system to be used by the sub emitter
  17531. */
  17532. constructor(
  17533. /**
  17534. * the particle system to be used by the sub emitter
  17535. */
  17536. particleSystem: ParticleSystem);
  17537. /**
  17538. * Clones the sub emitter
  17539. * @returns the cloned sub emitter
  17540. */
  17541. clone(): SubEmitter;
  17542. /**
  17543. * Serialize current object to a JSON object
  17544. * @returns the serialized object
  17545. */
  17546. serialize(): any;
  17547. /** @hidden */
  17548. static _ParseParticleSystem(system: any, scene: Scene, rootUrl: string): ParticleSystem;
  17549. /**
  17550. * Creates a new SubEmitter from a serialized JSON version
  17551. * @param serializationObject defines the JSON object to read from
  17552. * @param scene defines the hosting scene
  17553. * @param rootUrl defines the rootUrl for data loading
  17554. * @returns a new SubEmitter
  17555. */
  17556. static Parse(serializationObject: any, scene: Scene, rootUrl: string): SubEmitter;
  17557. /** Release associated resources */
  17558. dispose(): void;
  17559. }
  17560. }
  17561. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration" {
  17562. /** @hidden */
  17563. export var clipPlaneFragmentDeclaration: {
  17564. name: string;
  17565. shader: string;
  17566. };
  17567. }
  17568. declare module "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration" {
  17569. /** @hidden */
  17570. export var imageProcessingDeclaration: {
  17571. name: string;
  17572. shader: string;
  17573. };
  17574. }
  17575. declare module "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions" {
  17576. /** @hidden */
  17577. export var imageProcessingFunctions: {
  17578. name: string;
  17579. shader: string;
  17580. };
  17581. }
  17582. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneFragment" {
  17583. /** @hidden */
  17584. export var clipPlaneFragment: {
  17585. name: string;
  17586. shader: string;
  17587. };
  17588. }
  17589. declare module "babylonjs/Shaders/particles.fragment" {
  17590. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  17591. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  17592. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  17593. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  17594. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  17595. /** @hidden */
  17596. export var particlesPixelShader: {
  17597. name: string;
  17598. shader: string;
  17599. };
  17600. }
  17601. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration" {
  17602. /** @hidden */
  17603. export var clipPlaneVertexDeclaration: {
  17604. name: string;
  17605. shader: string;
  17606. };
  17607. }
  17608. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneVertex" {
  17609. /** @hidden */
  17610. export var clipPlaneVertex: {
  17611. name: string;
  17612. shader: string;
  17613. };
  17614. }
  17615. declare module "babylonjs/Shaders/particles.vertex" {
  17616. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  17617. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  17618. /** @hidden */
  17619. export var particlesVertexShader: {
  17620. name: string;
  17621. shader: string;
  17622. };
  17623. }
  17624. declare module "babylonjs/Particles/particleSystem" {
  17625. import { Nullable } from "babylonjs/types";
  17626. import { FactorGradient, Color3Gradient } from "babylonjs/Misc/gradients";
  17627. import { Observable } from "babylonjs/Misc/observable";
  17628. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  17629. import { Effect } from "babylonjs/Materials/effect";
  17630. import { Scene, IDisposable } from "babylonjs/scene";
  17631. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  17632. import { BaseParticleSystem } from "babylonjs/Particles/baseParticleSystem";
  17633. import { Particle } from "babylonjs/Particles/particle";
  17634. import { SubEmitter } from "babylonjs/Particles/subEmitter";
  17635. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  17636. import "babylonjs/Shaders/particles.fragment";
  17637. import "babylonjs/Shaders/particles.vertex";
  17638. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  17639. /**
  17640. * This represents a particle system in Babylon.
  17641. * 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.
  17642. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  17643. * @example https://doc.babylonjs.com/babylon101/particles
  17644. */
  17645. export class ParticleSystem extends BaseParticleSystem implements IDisposable, IAnimatable, IParticleSystem {
  17646. /**
  17647. * Billboard mode will only apply to Y axis
  17648. */
  17649. static readonly BILLBOARDMODE_Y: number;
  17650. /**
  17651. * Billboard mode will apply to all axes
  17652. */
  17653. static readonly BILLBOARDMODE_ALL: number;
  17654. /**
  17655. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  17656. */
  17657. static readonly BILLBOARDMODE_STRETCHED: number;
  17658. /**
  17659. * This function can be defined to provide custom update for active particles.
  17660. * This function will be called instead of regular update (age, position, color, etc.).
  17661. * Do not forget that this function will be called on every frame so try to keep it simple and fast :)
  17662. */
  17663. updateFunction: (particles: Particle[]) => void;
  17664. private _emitterWorldMatrix;
  17665. /**
  17666. * This function can be defined to specify initial direction for every new particle.
  17667. * It by default use the emitterType defined function
  17668. */
  17669. startDirectionFunction: (worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle) => void;
  17670. /**
  17671. * This function can be defined to specify initial position for every new particle.
  17672. * It by default use the emitterType defined function
  17673. */
  17674. startPositionFunction: (worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle) => void;
  17675. /**
  17676. * @hidden
  17677. */
  17678. _inheritedVelocityOffset: Vector3;
  17679. /**
  17680. * An event triggered when the system is disposed
  17681. */
  17682. onDisposeObservable: Observable<ParticleSystem>;
  17683. private _onDisposeObserver;
  17684. /**
  17685. * Sets a callback that will be triggered when the system is disposed
  17686. */
  17687. onDispose: () => void;
  17688. private _particles;
  17689. private _epsilon;
  17690. private _capacity;
  17691. private _stockParticles;
  17692. private _newPartsExcess;
  17693. private _vertexData;
  17694. private _vertexBuffer;
  17695. private _vertexBuffers;
  17696. private _spriteBuffer;
  17697. private _indexBuffer;
  17698. private _effect;
  17699. private _customEffect;
  17700. private _cachedDefines;
  17701. private _scaledColorStep;
  17702. private _colorDiff;
  17703. private _scaledDirection;
  17704. private _scaledGravity;
  17705. private _currentRenderId;
  17706. private _alive;
  17707. private _useInstancing;
  17708. private _started;
  17709. private _stopped;
  17710. private _actualFrame;
  17711. private _scaledUpdateSpeed;
  17712. private _vertexBufferSize;
  17713. /** @hidden */
  17714. _currentEmitRateGradient: Nullable<FactorGradient>;
  17715. /** @hidden */
  17716. _currentEmitRate1: number;
  17717. /** @hidden */
  17718. _currentEmitRate2: number;
  17719. /** @hidden */
  17720. _currentStartSizeGradient: Nullable<FactorGradient>;
  17721. /** @hidden */
  17722. _currentStartSize1: number;
  17723. /** @hidden */
  17724. _currentStartSize2: number;
  17725. private readonly _rawTextureWidth;
  17726. private _rampGradientsTexture;
  17727. private _useRampGradients;
  17728. /** Gets or sets a boolean indicating that ramp gradients must be used
  17729. * @see http://doc.babylonjs.com/babylon101/particles#ramp-gradients
  17730. */
  17731. useRampGradients: boolean;
  17732. /**
  17733. * 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.
  17734. * 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: [])
  17735. */
  17736. subEmitters: Array<ParticleSystem | SubEmitter | Array<SubEmitter>>;
  17737. private _subEmitters;
  17738. /**
  17739. * @hidden
  17740. * If the particle systems emitter should be disposed when the particle system is disposed
  17741. */
  17742. _disposeEmitterOnDispose: boolean;
  17743. /**
  17744. * The current active Sub-systems, this property is used by the root particle system only.
  17745. */
  17746. activeSubSystems: Array<ParticleSystem>;
  17747. private _rootParticleSystem;
  17748. /**
  17749. * Gets the current list of active particles
  17750. */
  17751. readonly particles: Particle[];
  17752. /**
  17753. * Returns the string "ParticleSystem"
  17754. * @returns a string containing the class name
  17755. */
  17756. getClassName(): string;
  17757. /**
  17758. * Instantiates a particle system.
  17759. * 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.
  17760. * @param name The name of the particle system
  17761. * @param capacity The max number of particles alive at the same time
  17762. * @param scene The scene the particle system belongs to
  17763. * @param customEffect a custom effect used to change the way particles are rendered by default
  17764. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  17765. * @param epsilon Offset used to render the particles
  17766. */
  17767. constructor(name: string, capacity: number, scene: Scene, customEffect?: Nullable<Effect>, isAnimationSheetEnabled?: boolean, epsilon?: number);
  17768. private _addFactorGradient;
  17769. private _removeFactorGradient;
  17770. /**
  17771. * Adds a new life time gradient
  17772. * @param gradient defines the gradient to use (between 0 and 1)
  17773. * @param factor defines the life time factor to affect to the specified gradient
  17774. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  17775. * @returns the current particle system
  17776. */
  17777. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  17778. /**
  17779. * Remove a specific life time gradient
  17780. * @param gradient defines the gradient to remove
  17781. * @returns the current particle system
  17782. */
  17783. removeLifeTimeGradient(gradient: number): IParticleSystem;
  17784. /**
  17785. * Adds a new size gradient
  17786. * @param gradient defines the gradient to use (between 0 and 1)
  17787. * @param factor defines the size factor to affect to the specified gradient
  17788. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  17789. * @returns the current particle system
  17790. */
  17791. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  17792. /**
  17793. * Remove a specific size gradient
  17794. * @param gradient defines the gradient to remove
  17795. * @returns the current particle system
  17796. */
  17797. removeSizeGradient(gradient: number): IParticleSystem;
  17798. /**
  17799. * Adds a new color remap gradient
  17800. * @param gradient defines the gradient to use (between 0 and 1)
  17801. * @param min defines the color remap minimal range
  17802. * @param max defines the color remap maximal range
  17803. * @returns the current particle system
  17804. */
  17805. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  17806. /**
  17807. * Remove a specific color remap gradient
  17808. * @param gradient defines the gradient to remove
  17809. * @returns the current particle system
  17810. */
  17811. removeColorRemapGradient(gradient: number): IParticleSystem;
  17812. /**
  17813. * Adds a new alpha remap gradient
  17814. * @param gradient defines the gradient to use (between 0 and 1)
  17815. * @param min defines the alpha remap minimal range
  17816. * @param max defines the alpha remap maximal range
  17817. * @returns the current particle system
  17818. */
  17819. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  17820. /**
  17821. * Remove a specific alpha remap gradient
  17822. * @param gradient defines the gradient to remove
  17823. * @returns the current particle system
  17824. */
  17825. removeAlphaRemapGradient(gradient: number): IParticleSystem;
  17826. /**
  17827. * Adds a new angular speed gradient
  17828. * @param gradient defines the gradient to use (between 0 and 1)
  17829. * @param factor defines the angular speed to affect to the specified gradient
  17830. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  17831. * @returns the current particle system
  17832. */
  17833. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  17834. /**
  17835. * Remove a specific angular speed gradient
  17836. * @param gradient defines the gradient to remove
  17837. * @returns the current particle system
  17838. */
  17839. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  17840. /**
  17841. * Adds a new velocity gradient
  17842. * @param gradient defines the gradient to use (between 0 and 1)
  17843. * @param factor defines the velocity to affect to the specified gradient
  17844. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  17845. * @returns the current particle system
  17846. */
  17847. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  17848. /**
  17849. * Remove a specific velocity gradient
  17850. * @param gradient defines the gradient to remove
  17851. * @returns the current particle system
  17852. */
  17853. removeVelocityGradient(gradient: number): IParticleSystem;
  17854. /**
  17855. * Adds a new limit velocity gradient
  17856. * @param gradient defines the gradient to use (between 0 and 1)
  17857. * @param factor defines the limit velocity value to affect to the specified gradient
  17858. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  17859. * @returns the current particle system
  17860. */
  17861. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  17862. /**
  17863. * Remove a specific limit velocity gradient
  17864. * @param gradient defines the gradient to remove
  17865. * @returns the current particle system
  17866. */
  17867. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  17868. /**
  17869. * Adds a new drag gradient
  17870. * @param gradient defines the gradient to use (between 0 and 1)
  17871. * @param factor defines the drag value to affect to the specified gradient
  17872. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  17873. * @returns the current particle system
  17874. */
  17875. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  17876. /**
  17877. * Remove a specific drag gradient
  17878. * @param gradient defines the gradient to remove
  17879. * @returns the current particle system
  17880. */
  17881. removeDragGradient(gradient: number): IParticleSystem;
  17882. /**
  17883. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  17884. * @param gradient defines the gradient to use (between 0 and 1)
  17885. * @param factor defines the emit rate value to affect to the specified gradient
  17886. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  17887. * @returns the current particle system
  17888. */
  17889. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  17890. /**
  17891. * Remove a specific emit rate gradient
  17892. * @param gradient defines the gradient to remove
  17893. * @returns the current particle system
  17894. */
  17895. removeEmitRateGradient(gradient: number): IParticleSystem;
  17896. /**
  17897. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  17898. * @param gradient defines the gradient to use (between 0 and 1)
  17899. * @param factor defines the start size value to affect to the specified gradient
  17900. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  17901. * @returns the current particle system
  17902. */
  17903. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  17904. /**
  17905. * Remove a specific start size gradient
  17906. * @param gradient defines the gradient to remove
  17907. * @returns the current particle system
  17908. */
  17909. removeStartSizeGradient(gradient: number): IParticleSystem;
  17910. private _createRampGradientTexture;
  17911. /**
  17912. * Gets the current list of ramp gradients.
  17913. * You must use addRampGradient and removeRampGradient to udpate this list
  17914. * @returns the list of ramp gradients
  17915. */
  17916. getRampGradients(): Nullable<Array<Color3Gradient>>;
  17917. /**
  17918. * Adds a new ramp gradient used to remap particle colors
  17919. * @param gradient defines the gradient to use (between 0 and 1)
  17920. * @param color defines the color to affect to the specified gradient
  17921. * @returns the current particle system
  17922. */
  17923. addRampGradient(gradient: number, color: Color3): ParticleSystem;
  17924. /**
  17925. * Remove a specific ramp gradient
  17926. * @param gradient defines the gradient to remove
  17927. * @returns the current particle system
  17928. */
  17929. removeRampGradient(gradient: number): ParticleSystem;
  17930. /**
  17931. * Adds a new color gradient
  17932. * @param gradient defines the gradient to use (between 0 and 1)
  17933. * @param color1 defines the color to affect to the specified gradient
  17934. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  17935. * @returns this particle system
  17936. */
  17937. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  17938. /**
  17939. * Remove a specific color gradient
  17940. * @param gradient defines the gradient to remove
  17941. * @returns this particle system
  17942. */
  17943. removeColorGradient(gradient: number): IParticleSystem;
  17944. private _fetchR;
  17945. protected _reset(): void;
  17946. private _resetEffect;
  17947. private _createVertexBuffers;
  17948. private _createIndexBuffer;
  17949. /**
  17950. * Gets the maximum number of particles active at the same time.
  17951. * @returns The max number of active particles.
  17952. */
  17953. getCapacity(): number;
  17954. /**
  17955. * Gets whether there are still active particles in the system.
  17956. * @returns True if it is alive, otherwise false.
  17957. */
  17958. isAlive(): boolean;
  17959. /**
  17960. * Gets if the system has been started. (Note: this will still be true after stop is called)
  17961. * @returns True if it has been started, otherwise false.
  17962. */
  17963. isStarted(): boolean;
  17964. private _prepareSubEmitterInternalArray;
  17965. /**
  17966. * Starts the particle system and begins to emit
  17967. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  17968. */
  17969. start(delay?: number): void;
  17970. /**
  17971. * Stops the particle system.
  17972. * @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.
  17973. */
  17974. stop(stopSubEmitters?: boolean): void;
  17975. /**
  17976. * Remove all active particles
  17977. */
  17978. reset(): void;
  17979. /**
  17980. * @hidden (for internal use only)
  17981. */
  17982. _appendParticleVertex(index: number, particle: Particle, offsetX: number, offsetY: number): void;
  17983. /**
  17984. * "Recycles" one of the particle by copying it back to the "stock" of particles and removing it from the active list.
  17985. * Its lifetime will start back at 0.
  17986. */
  17987. recycleParticle: (particle: Particle) => void;
  17988. private _stopSubEmitters;
  17989. private _createParticle;
  17990. private _removeFromRoot;
  17991. private _emitFromParticle;
  17992. private _update;
  17993. /** @hidden */
  17994. static _GetAttributeNamesOrOptions(isAnimationSheetEnabled?: boolean, isBillboardBased?: boolean, useRampGradients?: boolean): string[];
  17995. /** @hidden */
  17996. static _GetEffectCreationOptions(isAnimationSheetEnabled?: boolean): string[];
  17997. /** @hidden */
  17998. private _getEffect;
  17999. /**
  18000. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  18001. * @param preWarmOnly will prevent the system from updating the vertex buffer (default is false)
  18002. */
  18003. animate(preWarmOnly?: boolean): void;
  18004. private _appendParticleVertices;
  18005. /**
  18006. * Rebuilds the particle system.
  18007. */
  18008. rebuild(): void;
  18009. /**
  18010. * Is this system ready to be used/rendered
  18011. * @return true if the system is ready
  18012. */
  18013. isReady(): boolean;
  18014. private _render;
  18015. /**
  18016. * Renders the particle system in its current state.
  18017. * @returns the current number of particles
  18018. */
  18019. render(): number;
  18020. /**
  18021. * Disposes the particle system and free the associated resources
  18022. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  18023. */
  18024. dispose(disposeTexture?: boolean): void;
  18025. /**
  18026. * Clones the particle system.
  18027. * @param name The name of the cloned object
  18028. * @param newEmitter The new emitter to use
  18029. * @returns the cloned particle system
  18030. */
  18031. clone(name: string, newEmitter: any): ParticleSystem;
  18032. /**
  18033. * Serializes the particle system to a JSON object.
  18034. * @returns the JSON object
  18035. */
  18036. serialize(): any;
  18037. /** @hidden */
  18038. static _Serialize(serializationObject: any, particleSystem: IParticleSystem): void;
  18039. /** @hidden */
  18040. static _Parse(parsedParticleSystem: any, particleSystem: IParticleSystem, scene: Scene, rootUrl: string): void;
  18041. /**
  18042. * Parses a JSON object to create a particle system.
  18043. * @param parsedParticleSystem The JSON object to parse
  18044. * @param scene The scene to create the particle system in
  18045. * @param rootUrl The root url to use to load external dependencies like texture
  18046. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  18047. * @returns the Parsed particle system
  18048. */
  18049. static Parse(parsedParticleSystem: any, scene: Scene, rootUrl: string, doNotStart?: boolean): ParticleSystem;
  18050. }
  18051. }
  18052. declare module "babylonjs/Particles/particle" {
  18053. import { Nullable } from "babylonjs/types";
  18054. import { Vector2, Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  18055. import { Color4 } from "babylonjs/Maths/math.color";
  18056. import { ParticleSystem } from "babylonjs/Particles/particleSystem";
  18057. import { SubEmitter } from "babylonjs/Particles/subEmitter";
  18058. import { ColorGradient, FactorGradient } from "babylonjs/Misc/gradients";
  18059. /**
  18060. * A particle represents one of the element emitted by a particle system.
  18061. * This is mainly define by its coordinates, direction, velocity and age.
  18062. */
  18063. export class Particle {
  18064. /**
  18065. * The particle system the particle belongs to.
  18066. */
  18067. particleSystem: ParticleSystem;
  18068. private static _Count;
  18069. /**
  18070. * Unique ID of the particle
  18071. */
  18072. id: number;
  18073. /**
  18074. * The world position of the particle in the scene.
  18075. */
  18076. position: Vector3;
  18077. /**
  18078. * The world direction of the particle in the scene.
  18079. */
  18080. direction: Vector3;
  18081. /**
  18082. * The color of the particle.
  18083. */
  18084. color: Color4;
  18085. /**
  18086. * The color change of the particle per step.
  18087. */
  18088. colorStep: Color4;
  18089. /**
  18090. * Defines how long will the life of the particle be.
  18091. */
  18092. lifeTime: number;
  18093. /**
  18094. * The current age of the particle.
  18095. */
  18096. age: number;
  18097. /**
  18098. * The current size of the particle.
  18099. */
  18100. size: number;
  18101. /**
  18102. * The current scale of the particle.
  18103. */
  18104. scale: Vector2;
  18105. /**
  18106. * The current angle of the particle.
  18107. */
  18108. angle: number;
  18109. /**
  18110. * Defines how fast is the angle changing.
  18111. */
  18112. angularSpeed: number;
  18113. /**
  18114. * Defines the cell index used by the particle to be rendered from a sprite.
  18115. */
  18116. cellIndex: number;
  18117. /**
  18118. * The information required to support color remapping
  18119. */
  18120. remapData: Vector4;
  18121. /** @hidden */
  18122. _randomCellOffset?: number;
  18123. /** @hidden */
  18124. _initialDirection: Nullable<Vector3>;
  18125. /** @hidden */
  18126. _attachedSubEmitters: Nullable<Array<SubEmitter>>;
  18127. /** @hidden */
  18128. _initialStartSpriteCellID: number;
  18129. /** @hidden */
  18130. _initialEndSpriteCellID: number;
  18131. /** @hidden */
  18132. _currentColorGradient: Nullable<ColorGradient>;
  18133. /** @hidden */
  18134. _currentColor1: Color4;
  18135. /** @hidden */
  18136. _currentColor2: Color4;
  18137. /** @hidden */
  18138. _currentSizeGradient: Nullable<FactorGradient>;
  18139. /** @hidden */
  18140. _currentSize1: number;
  18141. /** @hidden */
  18142. _currentSize2: number;
  18143. /** @hidden */
  18144. _currentAngularSpeedGradient: Nullable<FactorGradient>;
  18145. /** @hidden */
  18146. _currentAngularSpeed1: number;
  18147. /** @hidden */
  18148. _currentAngularSpeed2: number;
  18149. /** @hidden */
  18150. _currentVelocityGradient: Nullable<FactorGradient>;
  18151. /** @hidden */
  18152. _currentVelocity1: number;
  18153. /** @hidden */
  18154. _currentVelocity2: number;
  18155. /** @hidden */
  18156. _currentLimitVelocityGradient: Nullable<FactorGradient>;
  18157. /** @hidden */
  18158. _currentLimitVelocity1: number;
  18159. /** @hidden */
  18160. _currentLimitVelocity2: number;
  18161. /** @hidden */
  18162. _currentDragGradient: Nullable<FactorGradient>;
  18163. /** @hidden */
  18164. _currentDrag1: number;
  18165. /** @hidden */
  18166. _currentDrag2: number;
  18167. /** @hidden */
  18168. _randomNoiseCoordinates1: Vector3;
  18169. /** @hidden */
  18170. _randomNoiseCoordinates2: Vector3;
  18171. /**
  18172. * Creates a new instance Particle
  18173. * @param particleSystem the particle system the particle belongs to
  18174. */
  18175. constructor(
  18176. /**
  18177. * The particle system the particle belongs to.
  18178. */
  18179. particleSystem: ParticleSystem);
  18180. private updateCellInfoFromSystem;
  18181. /**
  18182. * Defines how the sprite cell index is updated for the particle
  18183. */
  18184. updateCellIndex(): void;
  18185. /** @hidden */
  18186. _inheritParticleInfoToSubEmitter(subEmitter: SubEmitter): void;
  18187. /** @hidden */
  18188. _inheritParticleInfoToSubEmitters(): void;
  18189. /** @hidden */
  18190. _reset(): void;
  18191. /**
  18192. * Copy the properties of particle to another one.
  18193. * @param other the particle to copy the information to.
  18194. */
  18195. copyTo(other: Particle): void;
  18196. }
  18197. }
  18198. declare module "babylonjs/Particles/EmitterTypes/IParticleEmitterType" {
  18199. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  18200. import { Effect } from "babylonjs/Materials/effect";
  18201. import { Particle } from "babylonjs/Particles/particle";
  18202. /**
  18203. * Particle emitter represents a volume emitting particles.
  18204. * This is the responsibility of the implementation to define the volume shape like cone/sphere/box.
  18205. */
  18206. export interface IParticleEmitterType {
  18207. /**
  18208. * Called by the particle System when the direction is computed for the created particle.
  18209. * @param worldMatrix is the world matrix of the particle system
  18210. * @param directionToUpdate is the direction vector to update with the result
  18211. * @param particle is the particle we are computed the direction for
  18212. */
  18213. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  18214. /**
  18215. * Called by the particle System when the position is computed for the created particle.
  18216. * @param worldMatrix is the world matrix of the particle system
  18217. * @param positionToUpdate is the position vector to update with the result
  18218. * @param particle is the particle we are computed the position for
  18219. */
  18220. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  18221. /**
  18222. * Clones the current emitter and returns a copy of it
  18223. * @returns the new emitter
  18224. */
  18225. clone(): IParticleEmitterType;
  18226. /**
  18227. * Called by the GPUParticleSystem to setup the update shader
  18228. * @param effect defines the update shader
  18229. */
  18230. applyToShader(effect: Effect): void;
  18231. /**
  18232. * Returns a string to use to update the GPU particles update shader
  18233. * @returns the effect defines string
  18234. */
  18235. getEffectDefines(): string;
  18236. /**
  18237. * Returns a string representing the class name
  18238. * @returns a string containing the class name
  18239. */
  18240. getClassName(): string;
  18241. /**
  18242. * Serializes the particle system to a JSON object.
  18243. * @returns the JSON object
  18244. */
  18245. serialize(): any;
  18246. /**
  18247. * Parse properties from a JSON object
  18248. * @param serializationObject defines the JSON object
  18249. */
  18250. parse(serializationObject: any): void;
  18251. }
  18252. }
  18253. declare module "babylonjs/Particles/EmitterTypes/boxParticleEmitter" {
  18254. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  18255. import { Effect } from "babylonjs/Materials/effect";
  18256. import { Particle } from "babylonjs/Particles/particle";
  18257. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  18258. /**
  18259. * Particle emitter emitting particles from the inside of a box.
  18260. * It emits the particles randomly between 2 given directions.
  18261. */
  18262. export class BoxParticleEmitter implements IParticleEmitterType {
  18263. /**
  18264. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  18265. */
  18266. direction1: Vector3;
  18267. /**
  18268. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  18269. */
  18270. direction2: Vector3;
  18271. /**
  18272. * 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.
  18273. */
  18274. minEmitBox: Vector3;
  18275. /**
  18276. * 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.
  18277. */
  18278. maxEmitBox: Vector3;
  18279. /**
  18280. * Creates a new instance BoxParticleEmitter
  18281. */
  18282. constructor();
  18283. /**
  18284. * Called by the particle System when the direction is computed for the created particle.
  18285. * @param worldMatrix is the world matrix of the particle system
  18286. * @param directionToUpdate is the direction vector to update with the result
  18287. * @param particle is the particle we are computed the direction for
  18288. */
  18289. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  18290. /**
  18291. * Called by the particle System when the position is computed for the created particle.
  18292. * @param worldMatrix is the world matrix of the particle system
  18293. * @param positionToUpdate is the position vector to update with the result
  18294. * @param particle is the particle we are computed the position for
  18295. */
  18296. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  18297. /**
  18298. * Clones the current emitter and returns a copy of it
  18299. * @returns the new emitter
  18300. */
  18301. clone(): BoxParticleEmitter;
  18302. /**
  18303. * Called by the GPUParticleSystem to setup the update shader
  18304. * @param effect defines the update shader
  18305. */
  18306. applyToShader(effect: Effect): void;
  18307. /**
  18308. * Returns a string to use to update the GPU particles update shader
  18309. * @returns a string containng the defines string
  18310. */
  18311. getEffectDefines(): string;
  18312. /**
  18313. * Returns the string "BoxParticleEmitter"
  18314. * @returns a string containing the class name
  18315. */
  18316. getClassName(): string;
  18317. /**
  18318. * Serializes the particle system to a JSON object.
  18319. * @returns the JSON object
  18320. */
  18321. serialize(): any;
  18322. /**
  18323. * Parse properties from a JSON object
  18324. * @param serializationObject defines the JSON object
  18325. */
  18326. parse(serializationObject: any): void;
  18327. }
  18328. }
  18329. declare module "babylonjs/Particles/EmitterTypes/coneParticleEmitter" {
  18330. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  18331. import { Effect } from "babylonjs/Materials/effect";
  18332. import { Particle } from "babylonjs/Particles/particle";
  18333. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  18334. /**
  18335. * Particle emitter emitting particles from the inside of a cone.
  18336. * It emits the particles alongside the cone volume from the base to the particle.
  18337. * The emission direction might be randomized.
  18338. */
  18339. export class ConeParticleEmitter implements IParticleEmitterType {
  18340. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  18341. directionRandomizer: number;
  18342. private _radius;
  18343. private _angle;
  18344. private _height;
  18345. /**
  18346. * Gets or sets a value indicating where on the radius the start position should be picked (1 = everywhere, 0 = only surface)
  18347. */
  18348. radiusRange: number;
  18349. /**
  18350. * Gets or sets a value indicating where on the height the start position should be picked (1 = everywhere, 0 = only surface)
  18351. */
  18352. heightRange: number;
  18353. /**
  18354. * Gets or sets a value indicating if all the particles should be emitted from the spawn point only (the base of the cone)
  18355. */
  18356. emitFromSpawnPointOnly: boolean;
  18357. /**
  18358. * Gets or sets the radius of the emission cone
  18359. */
  18360. radius: number;
  18361. /**
  18362. * Gets or sets the angle of the emission cone
  18363. */
  18364. angle: number;
  18365. private _buildHeight;
  18366. /**
  18367. * Creates a new instance ConeParticleEmitter
  18368. * @param radius the radius of the emission cone (1 by default)
  18369. * @param angle the cone base angle (PI by default)
  18370. * @param directionRandomizer defines how much to randomize the particle direction [0-1] (default is 0)
  18371. */
  18372. constructor(radius?: number, angle?: number,
  18373. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  18374. directionRandomizer?: number);
  18375. /**
  18376. * Called by the particle System when the direction is computed for the created particle.
  18377. * @param worldMatrix is the world matrix of the particle system
  18378. * @param directionToUpdate is the direction vector to update with the result
  18379. * @param particle is the particle we are computed the direction for
  18380. */
  18381. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  18382. /**
  18383. * Called by the particle System when the position is computed for the created particle.
  18384. * @param worldMatrix is the world matrix of the particle system
  18385. * @param positionToUpdate is the position vector to update with the result
  18386. * @param particle is the particle we are computed the position for
  18387. */
  18388. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  18389. /**
  18390. * Clones the current emitter and returns a copy of it
  18391. * @returns the new emitter
  18392. */
  18393. clone(): ConeParticleEmitter;
  18394. /**
  18395. * Called by the GPUParticleSystem to setup the update shader
  18396. * @param effect defines the update shader
  18397. */
  18398. applyToShader(effect: Effect): void;
  18399. /**
  18400. * Returns a string to use to update the GPU particles update shader
  18401. * @returns a string containng the defines string
  18402. */
  18403. getEffectDefines(): string;
  18404. /**
  18405. * Returns the string "ConeParticleEmitter"
  18406. * @returns a string containing the class name
  18407. */
  18408. getClassName(): string;
  18409. /**
  18410. * Serializes the particle system to a JSON object.
  18411. * @returns the JSON object
  18412. */
  18413. serialize(): any;
  18414. /**
  18415. * Parse properties from a JSON object
  18416. * @param serializationObject defines the JSON object
  18417. */
  18418. parse(serializationObject: any): void;
  18419. }
  18420. }
  18421. declare module "babylonjs/Particles/EmitterTypes/cylinderParticleEmitter" {
  18422. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  18423. import { Effect } from "babylonjs/Materials/effect";
  18424. import { Particle } from "babylonjs/Particles/particle";
  18425. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  18426. /**
  18427. * Particle emitter emitting particles from the inside of a cylinder.
  18428. * It emits the particles alongside the cylinder radius. The emission direction might be randomized.
  18429. */
  18430. export class CylinderParticleEmitter implements IParticleEmitterType {
  18431. /**
  18432. * The radius of the emission cylinder.
  18433. */
  18434. radius: number;
  18435. /**
  18436. * The height of the emission cylinder.
  18437. */
  18438. height: number;
  18439. /**
  18440. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  18441. */
  18442. radiusRange: number;
  18443. /**
  18444. * How much to randomize the particle direction [0-1].
  18445. */
  18446. directionRandomizer: number;
  18447. /**
  18448. * Creates a new instance CylinderParticleEmitter
  18449. * @param radius the radius of the emission cylinder (1 by default)
  18450. * @param height the height of the emission cylinder (1 by default)
  18451. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  18452. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  18453. */
  18454. constructor(
  18455. /**
  18456. * The radius of the emission cylinder.
  18457. */
  18458. radius?: number,
  18459. /**
  18460. * The height of the emission cylinder.
  18461. */
  18462. height?: number,
  18463. /**
  18464. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  18465. */
  18466. radiusRange?: number,
  18467. /**
  18468. * How much to randomize the particle direction [0-1].
  18469. */
  18470. directionRandomizer?: number);
  18471. /**
  18472. * Called by the particle System when the direction is computed for the created particle.
  18473. * @param worldMatrix is the world matrix of the particle system
  18474. * @param directionToUpdate is the direction vector to update with the result
  18475. * @param particle is the particle we are computed the direction for
  18476. */
  18477. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  18478. /**
  18479. * Called by the particle System when the position is computed for the created particle.
  18480. * @param worldMatrix is the world matrix of the particle system
  18481. * @param positionToUpdate is the position vector to update with the result
  18482. * @param particle is the particle we are computed the position for
  18483. */
  18484. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  18485. /**
  18486. * Clones the current emitter and returns a copy of it
  18487. * @returns the new emitter
  18488. */
  18489. clone(): CylinderParticleEmitter;
  18490. /**
  18491. * Called by the GPUParticleSystem to setup the update shader
  18492. * @param effect defines the update shader
  18493. */
  18494. applyToShader(effect: Effect): void;
  18495. /**
  18496. * Returns a string to use to update the GPU particles update shader
  18497. * @returns a string containng the defines string
  18498. */
  18499. getEffectDefines(): string;
  18500. /**
  18501. * Returns the string "CylinderParticleEmitter"
  18502. * @returns a string containing the class name
  18503. */
  18504. getClassName(): string;
  18505. /**
  18506. * Serializes the particle system to a JSON object.
  18507. * @returns the JSON object
  18508. */
  18509. serialize(): any;
  18510. /**
  18511. * Parse properties from a JSON object
  18512. * @param serializationObject defines the JSON object
  18513. */
  18514. parse(serializationObject: any): void;
  18515. }
  18516. /**
  18517. * Particle emitter emitting particles from the inside of a cylinder.
  18518. * It emits the particles randomly between two vectors.
  18519. */
  18520. export class CylinderDirectedParticleEmitter extends CylinderParticleEmitter {
  18521. /**
  18522. * The min limit of the emission direction.
  18523. */
  18524. direction1: Vector3;
  18525. /**
  18526. * The max limit of the emission direction.
  18527. */
  18528. direction2: Vector3;
  18529. /**
  18530. * Creates a new instance CylinderDirectedParticleEmitter
  18531. * @param radius the radius of the emission cylinder (1 by default)
  18532. * @param height the height of the emission cylinder (1 by default)
  18533. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  18534. * @param direction1 the min limit of the emission direction (up vector by default)
  18535. * @param direction2 the max limit of the emission direction (up vector by default)
  18536. */
  18537. constructor(radius?: number, height?: number, radiusRange?: number,
  18538. /**
  18539. * The min limit of the emission direction.
  18540. */
  18541. direction1?: Vector3,
  18542. /**
  18543. * The max limit of the emission direction.
  18544. */
  18545. direction2?: Vector3);
  18546. /**
  18547. * Called by the particle System when the direction is computed for the created particle.
  18548. * @param worldMatrix is the world matrix of the particle system
  18549. * @param directionToUpdate is the direction vector to update with the result
  18550. * @param particle is the particle we are computed the direction for
  18551. */
  18552. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  18553. /**
  18554. * Clones the current emitter and returns a copy of it
  18555. * @returns the new emitter
  18556. */
  18557. clone(): CylinderDirectedParticleEmitter;
  18558. /**
  18559. * Called by the GPUParticleSystem to setup the update shader
  18560. * @param effect defines the update shader
  18561. */
  18562. applyToShader(effect: Effect): void;
  18563. /**
  18564. * Returns a string to use to update the GPU particles update shader
  18565. * @returns a string containng the defines string
  18566. */
  18567. getEffectDefines(): string;
  18568. /**
  18569. * Returns the string "CylinderDirectedParticleEmitter"
  18570. * @returns a string containing the class name
  18571. */
  18572. getClassName(): string;
  18573. /**
  18574. * Serializes the particle system to a JSON object.
  18575. * @returns the JSON object
  18576. */
  18577. serialize(): any;
  18578. /**
  18579. * Parse properties from a JSON object
  18580. * @param serializationObject defines the JSON object
  18581. */
  18582. parse(serializationObject: any): void;
  18583. }
  18584. }
  18585. declare module "babylonjs/Particles/EmitterTypes/hemisphericParticleEmitter" {
  18586. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  18587. import { Effect } from "babylonjs/Materials/effect";
  18588. import { Particle } from "babylonjs/Particles/particle";
  18589. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  18590. /**
  18591. * Particle emitter emitting particles from the inside of a hemisphere.
  18592. * It emits the particles alongside the hemisphere radius. The emission direction might be randomized.
  18593. */
  18594. export class HemisphericParticleEmitter implements IParticleEmitterType {
  18595. /**
  18596. * The radius of the emission hemisphere.
  18597. */
  18598. radius: number;
  18599. /**
  18600. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  18601. */
  18602. radiusRange: number;
  18603. /**
  18604. * How much to randomize the particle direction [0-1].
  18605. */
  18606. directionRandomizer: number;
  18607. /**
  18608. * Creates a new instance HemisphericParticleEmitter
  18609. * @param radius the radius of the emission hemisphere (1 by default)
  18610. * @param radiusRange the range of the emission hemisphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  18611. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  18612. */
  18613. constructor(
  18614. /**
  18615. * The radius of the emission hemisphere.
  18616. */
  18617. radius?: number,
  18618. /**
  18619. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  18620. */
  18621. radiusRange?: number,
  18622. /**
  18623. * How much to randomize the particle direction [0-1].
  18624. */
  18625. directionRandomizer?: number);
  18626. /**
  18627. * Called by the particle System when the direction is computed for the created particle.
  18628. * @param worldMatrix is the world matrix of the particle system
  18629. * @param directionToUpdate is the direction vector to update with the result
  18630. * @param particle is the particle we are computed the direction for
  18631. */
  18632. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  18633. /**
  18634. * Called by the particle System when the position is computed for the created particle.
  18635. * @param worldMatrix is the world matrix of the particle system
  18636. * @param positionToUpdate is the position vector to update with the result
  18637. * @param particle is the particle we are computed the position for
  18638. */
  18639. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  18640. /**
  18641. * Clones the current emitter and returns a copy of it
  18642. * @returns the new emitter
  18643. */
  18644. clone(): HemisphericParticleEmitter;
  18645. /**
  18646. * Called by the GPUParticleSystem to setup the update shader
  18647. * @param effect defines the update shader
  18648. */
  18649. applyToShader(effect: Effect): void;
  18650. /**
  18651. * Returns a string to use to update the GPU particles update shader
  18652. * @returns a string containng the defines string
  18653. */
  18654. getEffectDefines(): string;
  18655. /**
  18656. * Returns the string "HemisphericParticleEmitter"
  18657. * @returns a string containing the class name
  18658. */
  18659. getClassName(): string;
  18660. /**
  18661. * Serializes the particle system to a JSON object.
  18662. * @returns the JSON object
  18663. */
  18664. serialize(): any;
  18665. /**
  18666. * Parse properties from a JSON object
  18667. * @param serializationObject defines the JSON object
  18668. */
  18669. parse(serializationObject: any): void;
  18670. }
  18671. }
  18672. declare module "babylonjs/Particles/EmitterTypes/pointParticleEmitter" {
  18673. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  18674. import { Effect } from "babylonjs/Materials/effect";
  18675. import { Particle } from "babylonjs/Particles/particle";
  18676. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  18677. /**
  18678. * Particle emitter emitting particles from a point.
  18679. * It emits the particles randomly between 2 given directions.
  18680. */
  18681. export class PointParticleEmitter implements IParticleEmitterType {
  18682. /**
  18683. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  18684. */
  18685. direction1: Vector3;
  18686. /**
  18687. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  18688. */
  18689. direction2: Vector3;
  18690. /**
  18691. * Creates a new instance PointParticleEmitter
  18692. */
  18693. constructor();
  18694. /**
  18695. * Called by the particle System when the direction is computed for the created particle.
  18696. * @param worldMatrix is the world matrix of the particle system
  18697. * @param directionToUpdate is the direction vector to update with the result
  18698. * @param particle is the particle we are computed the direction for
  18699. */
  18700. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  18701. /**
  18702. * Called by the particle System when the position is computed for the created particle.
  18703. * @param worldMatrix is the world matrix of the particle system
  18704. * @param positionToUpdate is the position vector to update with the result
  18705. * @param particle is the particle we are computed the position for
  18706. */
  18707. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  18708. /**
  18709. * Clones the current emitter and returns a copy of it
  18710. * @returns the new emitter
  18711. */
  18712. clone(): PointParticleEmitter;
  18713. /**
  18714. * Called by the GPUParticleSystem to setup the update shader
  18715. * @param effect defines the update shader
  18716. */
  18717. applyToShader(effect: Effect): void;
  18718. /**
  18719. * Returns a string to use to update the GPU particles update shader
  18720. * @returns a string containng the defines string
  18721. */
  18722. getEffectDefines(): string;
  18723. /**
  18724. * Returns the string "PointParticleEmitter"
  18725. * @returns a string containing the class name
  18726. */
  18727. getClassName(): string;
  18728. /**
  18729. * Serializes the particle system to a JSON object.
  18730. * @returns the JSON object
  18731. */
  18732. serialize(): any;
  18733. /**
  18734. * Parse properties from a JSON object
  18735. * @param serializationObject defines the JSON object
  18736. */
  18737. parse(serializationObject: any): void;
  18738. }
  18739. }
  18740. declare module "babylonjs/Particles/EmitterTypes/sphereParticleEmitter" {
  18741. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  18742. import { Effect } from "babylonjs/Materials/effect";
  18743. import { Particle } from "babylonjs/Particles/particle";
  18744. import { IParticleEmitterType } from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  18745. /**
  18746. * Particle emitter emitting particles from the inside of a sphere.
  18747. * It emits the particles alongside the sphere radius. The emission direction might be randomized.
  18748. */
  18749. export class SphereParticleEmitter implements IParticleEmitterType {
  18750. /**
  18751. * The radius of the emission sphere.
  18752. */
  18753. radius: number;
  18754. /**
  18755. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  18756. */
  18757. radiusRange: number;
  18758. /**
  18759. * How much to randomize the particle direction [0-1].
  18760. */
  18761. directionRandomizer: number;
  18762. /**
  18763. * Creates a new instance SphereParticleEmitter
  18764. * @param radius the radius of the emission sphere (1 by default)
  18765. * @param radiusRange the range of the emission sphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  18766. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  18767. */
  18768. constructor(
  18769. /**
  18770. * The radius of the emission sphere.
  18771. */
  18772. radius?: number,
  18773. /**
  18774. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  18775. */
  18776. radiusRange?: number,
  18777. /**
  18778. * How much to randomize the particle direction [0-1].
  18779. */
  18780. directionRandomizer?: number);
  18781. /**
  18782. * Called by the particle System when the direction is computed for the created particle.
  18783. * @param worldMatrix is the world matrix of the particle system
  18784. * @param directionToUpdate is the direction vector to update with the result
  18785. * @param particle is the particle we are computed the direction for
  18786. */
  18787. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  18788. /**
  18789. * Called by the particle System when the position is computed for the created particle.
  18790. * @param worldMatrix is the world matrix of the particle system
  18791. * @param positionToUpdate is the position vector to update with the result
  18792. * @param particle is the particle we are computed the position for
  18793. */
  18794. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  18795. /**
  18796. * Clones the current emitter and returns a copy of it
  18797. * @returns the new emitter
  18798. */
  18799. clone(): SphereParticleEmitter;
  18800. /**
  18801. * Called by the GPUParticleSystem to setup the update shader
  18802. * @param effect defines the update shader
  18803. */
  18804. applyToShader(effect: Effect): void;
  18805. /**
  18806. * Returns a string to use to update the GPU particles update shader
  18807. * @returns a string containng the defines string
  18808. */
  18809. getEffectDefines(): string;
  18810. /**
  18811. * Returns the string "SphereParticleEmitter"
  18812. * @returns a string containing the class name
  18813. */
  18814. getClassName(): string;
  18815. /**
  18816. * Serializes the particle system to a JSON object.
  18817. * @returns the JSON object
  18818. */
  18819. serialize(): any;
  18820. /**
  18821. * Parse properties from a JSON object
  18822. * @param serializationObject defines the JSON object
  18823. */
  18824. parse(serializationObject: any): void;
  18825. }
  18826. /**
  18827. * Particle emitter emitting particles from the inside of a sphere.
  18828. * It emits the particles randomly between two vectors.
  18829. */
  18830. export class SphereDirectedParticleEmitter extends SphereParticleEmitter {
  18831. /**
  18832. * The min limit of the emission direction.
  18833. */
  18834. direction1: Vector3;
  18835. /**
  18836. * The max limit of the emission direction.
  18837. */
  18838. direction2: Vector3;
  18839. /**
  18840. * Creates a new instance SphereDirectedParticleEmitter
  18841. * @param radius the radius of the emission sphere (1 by default)
  18842. * @param direction1 the min limit of the emission direction (up vector by default)
  18843. * @param direction2 the max limit of the emission direction (up vector by default)
  18844. */
  18845. constructor(radius?: number,
  18846. /**
  18847. * The min limit of the emission direction.
  18848. */
  18849. direction1?: Vector3,
  18850. /**
  18851. * The max limit of the emission direction.
  18852. */
  18853. direction2?: Vector3);
  18854. /**
  18855. * Called by the particle System when the direction is computed for the created particle.
  18856. * @param worldMatrix is the world matrix of the particle system
  18857. * @param directionToUpdate is the direction vector to update with the result
  18858. * @param particle is the particle we are computed the direction for
  18859. */
  18860. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  18861. /**
  18862. * Clones the current emitter and returns a copy of it
  18863. * @returns the new emitter
  18864. */
  18865. clone(): SphereDirectedParticleEmitter;
  18866. /**
  18867. * Called by the GPUParticleSystem to setup the update shader
  18868. * @param effect defines the update shader
  18869. */
  18870. applyToShader(effect: Effect): void;
  18871. /**
  18872. * Returns a string to use to update the GPU particles update shader
  18873. * @returns a string containng the defines string
  18874. */
  18875. getEffectDefines(): string;
  18876. /**
  18877. * Returns the string "SphereDirectedParticleEmitter"
  18878. * @returns a string containing the class name
  18879. */
  18880. getClassName(): string;
  18881. /**
  18882. * Serializes the particle system to a JSON object.
  18883. * @returns the JSON object
  18884. */
  18885. serialize(): any;
  18886. /**
  18887. * Parse properties from a JSON object
  18888. * @param serializationObject defines the JSON object
  18889. */
  18890. parse(serializationObject: any): void;
  18891. }
  18892. }
  18893. declare module "babylonjs/Particles/EmitterTypes/index" {
  18894. export * from "babylonjs/Particles/EmitterTypes/boxParticleEmitter";
  18895. export * from "babylonjs/Particles/EmitterTypes/coneParticleEmitter";
  18896. export * from "babylonjs/Particles/EmitterTypes/cylinderParticleEmitter";
  18897. export * from "babylonjs/Particles/EmitterTypes/hemisphericParticleEmitter";
  18898. export * from "babylonjs/Particles/EmitterTypes/IParticleEmitterType";
  18899. export * from "babylonjs/Particles/EmitterTypes/pointParticleEmitter";
  18900. export * from "babylonjs/Particles/EmitterTypes/sphereParticleEmitter";
  18901. }
  18902. declare module "babylonjs/Particles/IParticleSystem" {
  18903. import { Nullable } from "babylonjs/types";
  18904. import { Vector2, Vector3 } from "babylonjs/Maths/math.vector";
  18905. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  18906. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  18907. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  18908. import { Texture } from "babylonjs/Materials/Textures/texture";
  18909. import { BoxParticleEmitter, IParticleEmitterType, PointParticleEmitter, HemisphericParticleEmitter, SphereParticleEmitter, SphereDirectedParticleEmitter, CylinderParticleEmitter, ConeParticleEmitter } from "babylonjs/Particles/EmitterTypes/index";
  18910. import { Scene } from "babylonjs/scene";
  18911. import { ColorGradient, FactorGradient, Color3Gradient } from "babylonjs/Misc/gradients";
  18912. import { Animation } from "babylonjs/Animations/animation";
  18913. /**
  18914. * Interface representing a particle system in Babylon.js.
  18915. * This groups the common functionalities that needs to be implemented in order to create a particle system.
  18916. * A particle system represents a way to manage particles from their emission to their animation and rendering.
  18917. */
  18918. export interface IParticleSystem {
  18919. /**
  18920. * List of animations used by the particle system.
  18921. */
  18922. animations: Animation[];
  18923. /**
  18924. * The id of the Particle system.
  18925. */
  18926. id: string;
  18927. /**
  18928. * The name of the Particle system.
  18929. */
  18930. name: string;
  18931. /**
  18932. * The emitter represents the Mesh or position we are attaching the particle system to.
  18933. */
  18934. emitter: Nullable<AbstractMesh | Vector3>;
  18935. /**
  18936. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  18937. */
  18938. isBillboardBased: boolean;
  18939. /**
  18940. * The rendering group used by the Particle system to chose when to render.
  18941. */
  18942. renderingGroupId: number;
  18943. /**
  18944. * The layer mask we are rendering the particles through.
  18945. */
  18946. layerMask: number;
  18947. /**
  18948. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  18949. */
  18950. updateSpeed: number;
  18951. /**
  18952. * The amount of time the particle system is running (depends of the overall update speed).
  18953. */
  18954. targetStopDuration: number;
  18955. /**
  18956. * The texture used to render each particle. (this can be a spritesheet)
  18957. */
  18958. particleTexture: Nullable<Texture>;
  18959. /**
  18960. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE, ParticleSystem.BLENDMODE_STANDARD or ParticleSystem.BLENDMODE_ADD.
  18961. */
  18962. blendMode: number;
  18963. /**
  18964. * Minimum life time of emitting particles.
  18965. */
  18966. minLifeTime: number;
  18967. /**
  18968. * Maximum life time of emitting particles.
  18969. */
  18970. maxLifeTime: number;
  18971. /**
  18972. * Minimum Size of emitting particles.
  18973. */
  18974. minSize: number;
  18975. /**
  18976. * Maximum Size of emitting particles.
  18977. */
  18978. maxSize: number;
  18979. /**
  18980. * Minimum scale of emitting particles on X axis.
  18981. */
  18982. minScaleX: number;
  18983. /**
  18984. * Maximum scale of emitting particles on X axis.
  18985. */
  18986. maxScaleX: number;
  18987. /**
  18988. * Minimum scale of emitting particles on Y axis.
  18989. */
  18990. minScaleY: number;
  18991. /**
  18992. * Maximum scale of emitting particles on Y axis.
  18993. */
  18994. maxScaleY: number;
  18995. /**
  18996. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  18997. */
  18998. color1: Color4;
  18999. /**
  19000. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  19001. */
  19002. color2: Color4;
  19003. /**
  19004. * Color the particle will have at the end of its lifetime.
  19005. */
  19006. colorDead: Color4;
  19007. /**
  19008. * The maximum number of particles to emit per frame until we reach the activeParticleCount value
  19009. */
  19010. emitRate: number;
  19011. /**
  19012. * You can use gravity if you want to give an orientation to your particles.
  19013. */
  19014. gravity: Vector3;
  19015. /**
  19016. * Minimum power of emitting particles.
  19017. */
  19018. minEmitPower: number;
  19019. /**
  19020. * Maximum power of emitting particles.
  19021. */
  19022. maxEmitPower: number;
  19023. /**
  19024. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  19025. */
  19026. minAngularSpeed: number;
  19027. /**
  19028. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  19029. */
  19030. maxAngularSpeed: number;
  19031. /**
  19032. * Gets or sets the minimal initial rotation in radians.
  19033. */
  19034. minInitialRotation: number;
  19035. /**
  19036. * Gets or sets the maximal initial rotation in radians.
  19037. */
  19038. maxInitialRotation: number;
  19039. /**
  19040. * The particle emitter type defines the emitter used by the particle system.
  19041. * It can be for example box, sphere, or cone...
  19042. */
  19043. particleEmitterType: Nullable<IParticleEmitterType>;
  19044. /**
  19045. * Defines the delay in milliseconds before starting the system (0 by default)
  19046. */
  19047. startDelay: number;
  19048. /**
  19049. * 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
  19050. */
  19051. preWarmCycles: number;
  19052. /**
  19053. * Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1)
  19054. */
  19055. preWarmStepOffset: number;
  19056. /**
  19057. * 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)
  19058. */
  19059. spriteCellChangeSpeed: number;
  19060. /**
  19061. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  19062. */
  19063. startSpriteCellID: number;
  19064. /**
  19065. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  19066. */
  19067. endSpriteCellID: number;
  19068. /**
  19069. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  19070. */
  19071. spriteCellWidth: number;
  19072. /**
  19073. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  19074. */
  19075. spriteCellHeight: number;
  19076. /**
  19077. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  19078. */
  19079. spriteRandomStartCell: boolean;
  19080. /**
  19081. * Gets or sets a boolean indicating if a spritesheet is used to animate the particles texture
  19082. */
  19083. isAnimationSheetEnabled: boolean;
  19084. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  19085. translationPivot: Vector2;
  19086. /**
  19087. * Gets or sets a texture used to add random noise to particle positions
  19088. */
  19089. noiseTexture: Nullable<BaseTexture>;
  19090. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  19091. noiseStrength: Vector3;
  19092. /**
  19093. * Gets or sets the billboard mode to use when isBillboardBased = true.
  19094. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  19095. */
  19096. billboardMode: number;
  19097. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  19098. limitVelocityDamping: number;
  19099. /**
  19100. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  19101. */
  19102. beginAnimationOnStart: boolean;
  19103. /**
  19104. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  19105. */
  19106. beginAnimationFrom: number;
  19107. /**
  19108. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  19109. */
  19110. beginAnimationTo: number;
  19111. /**
  19112. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  19113. */
  19114. beginAnimationLoop: boolean;
  19115. /**
  19116. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  19117. */
  19118. disposeOnStop: boolean;
  19119. /**
  19120. * Gets the maximum number of particles active at the same time.
  19121. * @returns The max number of active particles.
  19122. */
  19123. getCapacity(): number;
  19124. /**
  19125. * Gets if the system has been started. (Note: this will still be true after stop is called)
  19126. * @returns True if it has been started, otherwise false.
  19127. */
  19128. isStarted(): boolean;
  19129. /**
  19130. * Animates the particle system for this frame.
  19131. */
  19132. animate(): void;
  19133. /**
  19134. * Renders the particle system in its current state.
  19135. * @returns the current number of particles
  19136. */
  19137. render(): number;
  19138. /**
  19139. * Dispose the particle system and frees its associated resources.
  19140. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  19141. */
  19142. dispose(disposeTexture?: boolean): void;
  19143. /**
  19144. * Clones the particle system.
  19145. * @param name The name of the cloned object
  19146. * @param newEmitter The new emitter to use
  19147. * @returns the cloned particle system
  19148. */
  19149. clone(name: string, newEmitter: any): Nullable<IParticleSystem>;
  19150. /**
  19151. * Serializes the particle system to a JSON object.
  19152. * @returns the JSON object
  19153. */
  19154. serialize(): any;
  19155. /**
  19156. * Rebuild the particle system
  19157. */
  19158. rebuild(): void;
  19159. /**
  19160. * Starts the particle system and begins to emit
  19161. * @param delay defines the delay in milliseconds before starting the system (0 by default)
  19162. */
  19163. start(delay?: number): void;
  19164. /**
  19165. * Stops the particle system.
  19166. */
  19167. stop(): void;
  19168. /**
  19169. * Remove all active particles
  19170. */
  19171. reset(): void;
  19172. /**
  19173. * Is this system ready to be used/rendered
  19174. * @return true if the system is ready
  19175. */
  19176. isReady(): boolean;
  19177. /**
  19178. * Adds a new color gradient
  19179. * @param gradient defines the gradient to use (between 0 and 1)
  19180. * @param color1 defines the color to affect to the specified gradient
  19181. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  19182. * @returns the current particle system
  19183. */
  19184. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  19185. /**
  19186. * Remove a specific color gradient
  19187. * @param gradient defines the gradient to remove
  19188. * @returns the current particle system
  19189. */
  19190. removeColorGradient(gradient: number): IParticleSystem;
  19191. /**
  19192. * Adds a new size gradient
  19193. * @param gradient defines the gradient to use (between 0 and 1)
  19194. * @param factor defines the size factor to affect to the specified gradient
  19195. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  19196. * @returns the current particle system
  19197. */
  19198. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  19199. /**
  19200. * Remove a specific size gradient
  19201. * @param gradient defines the gradient to remove
  19202. * @returns the current particle system
  19203. */
  19204. removeSizeGradient(gradient: number): IParticleSystem;
  19205. /**
  19206. * Gets the current list of color gradients.
  19207. * You must use addColorGradient and removeColorGradient to udpate this list
  19208. * @returns the list of color gradients
  19209. */
  19210. getColorGradients(): Nullable<Array<ColorGradient>>;
  19211. /**
  19212. * Gets the current list of size gradients.
  19213. * You must use addSizeGradient and removeSizeGradient to udpate this list
  19214. * @returns the list of size gradients
  19215. */
  19216. getSizeGradients(): Nullable<Array<FactorGradient>>;
  19217. /**
  19218. * Gets the current list of angular speed gradients.
  19219. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  19220. * @returns the list of angular speed gradients
  19221. */
  19222. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  19223. /**
  19224. * Adds a new angular speed gradient
  19225. * @param gradient defines the gradient to use (between 0 and 1)
  19226. * @param factor defines the angular speed to affect to the specified gradient
  19227. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  19228. * @returns the current particle system
  19229. */
  19230. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  19231. /**
  19232. * Remove a specific angular speed gradient
  19233. * @param gradient defines the gradient to remove
  19234. * @returns the current particle system
  19235. */
  19236. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  19237. /**
  19238. * Gets the current list of velocity gradients.
  19239. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  19240. * @returns the list of velocity gradients
  19241. */
  19242. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  19243. /**
  19244. * Adds a new velocity gradient
  19245. * @param gradient defines the gradient to use (between 0 and 1)
  19246. * @param factor defines the velocity to affect to the specified gradient
  19247. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  19248. * @returns the current particle system
  19249. */
  19250. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  19251. /**
  19252. * Remove a specific velocity gradient
  19253. * @param gradient defines the gradient to remove
  19254. * @returns the current particle system
  19255. */
  19256. removeVelocityGradient(gradient: number): IParticleSystem;
  19257. /**
  19258. * Gets the current list of limit velocity gradients.
  19259. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  19260. * @returns the list of limit velocity gradients
  19261. */
  19262. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  19263. /**
  19264. * Adds a new limit velocity gradient
  19265. * @param gradient defines the gradient to use (between 0 and 1)
  19266. * @param factor defines the limit velocity to affect to the specified gradient
  19267. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  19268. * @returns the current particle system
  19269. */
  19270. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  19271. /**
  19272. * Remove a specific limit velocity gradient
  19273. * @param gradient defines the gradient to remove
  19274. * @returns the current particle system
  19275. */
  19276. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  19277. /**
  19278. * Adds a new drag gradient
  19279. * @param gradient defines the gradient to use (between 0 and 1)
  19280. * @param factor defines the drag to affect to the specified gradient
  19281. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  19282. * @returns the current particle system
  19283. */
  19284. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  19285. /**
  19286. * Remove a specific drag gradient
  19287. * @param gradient defines the gradient to remove
  19288. * @returns the current particle system
  19289. */
  19290. removeDragGradient(gradient: number): IParticleSystem;
  19291. /**
  19292. * Gets the current list of drag gradients.
  19293. * You must use addDragGradient and removeDragGradient to udpate this list
  19294. * @returns the list of drag gradients
  19295. */
  19296. getDragGradients(): Nullable<Array<FactorGradient>>;
  19297. /**
  19298. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  19299. * @param gradient defines the gradient to use (between 0 and 1)
  19300. * @param factor defines the emit rate to affect to the specified gradient
  19301. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  19302. * @returns the current particle system
  19303. */
  19304. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  19305. /**
  19306. * Remove a specific emit rate gradient
  19307. * @param gradient defines the gradient to remove
  19308. * @returns the current particle system
  19309. */
  19310. removeEmitRateGradient(gradient: number): IParticleSystem;
  19311. /**
  19312. * Gets the current list of emit rate gradients.
  19313. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  19314. * @returns the list of emit rate gradients
  19315. */
  19316. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  19317. /**
  19318. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  19319. * @param gradient defines the gradient to use (between 0 and 1)
  19320. * @param factor defines the start size to affect to the specified gradient
  19321. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  19322. * @returns the current particle system
  19323. */
  19324. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  19325. /**
  19326. * Remove a specific start size gradient
  19327. * @param gradient defines the gradient to remove
  19328. * @returns the current particle system
  19329. */
  19330. removeStartSizeGradient(gradient: number): IParticleSystem;
  19331. /**
  19332. * Gets the current list of start size gradients.
  19333. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  19334. * @returns the list of start size gradients
  19335. */
  19336. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  19337. /**
  19338. * Adds a new life time gradient
  19339. * @param gradient defines the gradient to use (between 0 and 1)
  19340. * @param factor defines the life time factor to affect to the specified gradient
  19341. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  19342. * @returns the current particle system
  19343. */
  19344. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  19345. /**
  19346. * Remove a specific life time gradient
  19347. * @param gradient defines the gradient to remove
  19348. * @returns the current particle system
  19349. */
  19350. removeLifeTimeGradient(gradient: number): IParticleSystem;
  19351. /**
  19352. * Gets the current list of life time gradients.
  19353. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  19354. * @returns the list of life time gradients
  19355. */
  19356. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  19357. /**
  19358. * Gets the current list of color gradients.
  19359. * You must use addColorGradient and removeColorGradient to udpate this list
  19360. * @returns the list of color gradients
  19361. */
  19362. getColorGradients(): Nullable<Array<ColorGradient>>;
  19363. /**
  19364. * Adds a new ramp gradient used to remap particle colors
  19365. * @param gradient defines the gradient to use (between 0 and 1)
  19366. * @param color defines the color to affect to the specified gradient
  19367. * @returns the current particle system
  19368. */
  19369. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  19370. /**
  19371. * Gets the current list of ramp gradients.
  19372. * You must use addRampGradient and removeRampGradient to udpate this list
  19373. * @returns the list of ramp gradients
  19374. */
  19375. getRampGradients(): Nullable<Array<Color3Gradient>>;
  19376. /** Gets or sets a boolean indicating that ramp gradients must be used
  19377. * @see http://doc.babylonjs.com/babylon101/particles#ramp-gradients
  19378. */
  19379. useRampGradients: boolean;
  19380. /**
  19381. * Adds a new color remap gradient
  19382. * @param gradient defines the gradient to use (between 0 and 1)
  19383. * @param min defines the color remap minimal range
  19384. * @param max defines the color remap maximal range
  19385. * @returns the current particle system
  19386. */
  19387. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  19388. /**
  19389. * Gets the current list of color remap gradients.
  19390. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  19391. * @returns the list of color remap gradients
  19392. */
  19393. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  19394. /**
  19395. * Adds a new alpha remap gradient
  19396. * @param gradient defines the gradient to use (between 0 and 1)
  19397. * @param min defines the alpha remap minimal range
  19398. * @param max defines the alpha remap maximal range
  19399. * @returns the current particle system
  19400. */
  19401. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  19402. /**
  19403. * Gets the current list of alpha remap gradients.
  19404. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  19405. * @returns the list of alpha remap gradients
  19406. */
  19407. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  19408. /**
  19409. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  19410. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  19411. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  19412. * @returns the emitter
  19413. */
  19414. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  19415. /**
  19416. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  19417. * @param radius The radius of the hemisphere to emit from
  19418. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  19419. * @returns the emitter
  19420. */
  19421. createHemisphericEmitter(radius: number, radiusRange: number): HemisphericParticleEmitter;
  19422. /**
  19423. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  19424. * @param radius The radius of the sphere to emit from
  19425. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  19426. * @returns the emitter
  19427. */
  19428. createSphereEmitter(radius: number, radiusRange: number): SphereParticleEmitter;
  19429. /**
  19430. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  19431. * @param radius The radius of the sphere to emit from
  19432. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  19433. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  19434. * @returns the emitter
  19435. */
  19436. createDirectedSphereEmitter(radius: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  19437. /**
  19438. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  19439. * @param radius The radius of the emission cylinder
  19440. * @param height The height of the emission cylinder
  19441. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  19442. * @param directionRandomizer How much to randomize the particle direction [0-1]
  19443. * @returns the emitter
  19444. */
  19445. createCylinderEmitter(radius: number, height: number, radiusRange: number, directionRandomizer: number): CylinderParticleEmitter;
  19446. /**
  19447. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  19448. * @param radius The radius of the cylinder to emit from
  19449. * @param height The height of the emission cylinder
  19450. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  19451. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  19452. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  19453. * @returns the emitter
  19454. */
  19455. createDirectedCylinderEmitter(radius: number, height: number, radiusRange: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  19456. /**
  19457. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  19458. * @param radius The radius of the cone to emit from
  19459. * @param angle The base angle of the cone
  19460. * @returns the emitter
  19461. */
  19462. createConeEmitter(radius: number, angle: number): ConeParticleEmitter;
  19463. /**
  19464. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  19465. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  19466. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  19467. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  19468. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  19469. * @returns the emitter
  19470. */
  19471. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  19472. /**
  19473. * Get hosting scene
  19474. * @returns the scene
  19475. */
  19476. getScene(): Scene;
  19477. }
  19478. }
  19479. declare module "babylonjs/Meshes/instancedMesh" {
  19480. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  19481. import { Vector3, Matrix } from "babylonjs/Maths/math.vector";
  19482. import { Camera } from "babylonjs/Cameras/camera";
  19483. import { Node } from "babylonjs/node";
  19484. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  19485. import { Mesh } from "babylonjs/Meshes/mesh";
  19486. import { Material } from "babylonjs/Materials/material";
  19487. import { Skeleton } from "babylonjs/Bones/skeleton";
  19488. import { Light } from "babylonjs/Lights/light";
  19489. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  19490. /**
  19491. * Creates an instance based on a source mesh.
  19492. */
  19493. export class InstancedMesh extends AbstractMesh {
  19494. private _sourceMesh;
  19495. private _currentLOD;
  19496. /** @hidden */
  19497. _indexInSourceMeshInstanceArray: number;
  19498. constructor(name: string, source: Mesh);
  19499. /**
  19500. * Returns the string "InstancedMesh".
  19501. */
  19502. getClassName(): string;
  19503. /** Gets the list of lights affecting that mesh */
  19504. readonly lightSources: Light[];
  19505. _resyncLightSources(): void;
  19506. _resyncLighSource(light: Light): void;
  19507. _removeLightSource(light: Light, dispose: boolean): void;
  19508. /**
  19509. * If the source mesh receives shadows
  19510. */
  19511. readonly receiveShadows: boolean;
  19512. /**
  19513. * The material of the source mesh
  19514. */
  19515. readonly material: Nullable<Material>;
  19516. /**
  19517. * Visibility of the source mesh
  19518. */
  19519. readonly visibility: number;
  19520. /**
  19521. * Skeleton of the source mesh
  19522. */
  19523. readonly skeleton: Nullable<Skeleton>;
  19524. /**
  19525. * Rendering ground id of the source mesh
  19526. */
  19527. renderingGroupId: number;
  19528. /**
  19529. * Returns the total number of vertices (integer).
  19530. */
  19531. getTotalVertices(): number;
  19532. /**
  19533. * Returns a positive integer : the total number of indices in this mesh geometry.
  19534. * @returns the numner of indices or zero if the mesh has no geometry.
  19535. */
  19536. getTotalIndices(): number;
  19537. /**
  19538. * The source mesh of the instance
  19539. */
  19540. readonly sourceMesh: Mesh;
  19541. /**
  19542. * Is this node ready to be used/rendered
  19543. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  19544. * @return {boolean} is it ready
  19545. */
  19546. isReady(completeCheck?: boolean): boolean;
  19547. /**
  19548. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  19549. * @param kind kind of verticies to retreive (eg. positons, normals, uvs, etc.)
  19550. * @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.
  19551. * @returns a float array or a Float32Array of the requested kind of data : positons, normals, uvs, etc.
  19552. */
  19553. getVerticesData(kind: string, copyWhenShared?: boolean): Nullable<FloatArray>;
  19554. /**
  19555. * Sets the vertex data of the mesh geometry for the requested `kind`.
  19556. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  19557. * The `data` are either a numeric array either a Float32Array.
  19558. * The parameter `updatable` is passed as is to the underlying Geometry object constructor (if initianilly none) or updater.
  19559. * 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).
  19560. * Note that a new underlying VertexBuffer object is created each call.
  19561. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  19562. *
  19563. * Possible `kind` values :
  19564. * - VertexBuffer.PositionKind
  19565. * - VertexBuffer.UVKind
  19566. * - VertexBuffer.UV2Kind
  19567. * - VertexBuffer.UV3Kind
  19568. * - VertexBuffer.UV4Kind
  19569. * - VertexBuffer.UV5Kind
  19570. * - VertexBuffer.UV6Kind
  19571. * - VertexBuffer.ColorKind
  19572. * - VertexBuffer.MatricesIndicesKind
  19573. * - VertexBuffer.MatricesIndicesExtraKind
  19574. * - VertexBuffer.MatricesWeightsKind
  19575. * - VertexBuffer.MatricesWeightsExtraKind
  19576. *
  19577. * Returns the Mesh.
  19578. */
  19579. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  19580. /**
  19581. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  19582. * If the mesh has no geometry, it is simply returned as it is.
  19583. * The `data` are either a numeric array either a Float32Array.
  19584. * No new underlying VertexBuffer object is created.
  19585. * 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.
  19586. * If the parameter `makeItUnique` is true, a new global geometry is created from this positions and is set to the mesh.
  19587. *
  19588. * Possible `kind` values :
  19589. * - VertexBuffer.PositionKind
  19590. * - VertexBuffer.UVKind
  19591. * - VertexBuffer.UV2Kind
  19592. * - VertexBuffer.UV3Kind
  19593. * - VertexBuffer.UV4Kind
  19594. * - VertexBuffer.UV5Kind
  19595. * - VertexBuffer.UV6Kind
  19596. * - VertexBuffer.ColorKind
  19597. * - VertexBuffer.MatricesIndicesKind
  19598. * - VertexBuffer.MatricesIndicesExtraKind
  19599. * - VertexBuffer.MatricesWeightsKind
  19600. * - VertexBuffer.MatricesWeightsExtraKind
  19601. *
  19602. * Returns the Mesh.
  19603. */
  19604. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): Mesh;
  19605. /**
  19606. * Sets the mesh indices.
  19607. * Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array).
  19608. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  19609. * This method creates a new index buffer each call.
  19610. * Returns the Mesh.
  19611. */
  19612. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>): Mesh;
  19613. /**
  19614. * Boolean : True if the mesh owns the requested kind of data.
  19615. */
  19616. isVerticesDataPresent(kind: string): boolean;
  19617. /**
  19618. * Returns an array of indices (IndicesArray).
  19619. */
  19620. getIndices(): Nullable<IndicesArray>;
  19621. readonly _positions: Nullable<Vector3[]>;
  19622. /**
  19623. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  19624. * This means the mesh underlying bounding box and sphere are recomputed.
  19625. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  19626. * @returns the current mesh
  19627. */
  19628. refreshBoundingInfo(applySkeleton?: boolean): InstancedMesh;
  19629. /** @hidden */
  19630. _preActivate(): InstancedMesh;
  19631. /** @hidden */
  19632. _activate(renderId: number, intermediateRendering: boolean): boolean;
  19633. /** @hidden */
  19634. _postActivate(): void;
  19635. getWorldMatrix(): Matrix;
  19636. readonly isAnInstance: boolean;
  19637. /**
  19638. * Returns the current associated LOD AbstractMesh.
  19639. */
  19640. getLOD(camera: Camera): AbstractMesh;
  19641. /** @hidden */
  19642. _syncSubMeshes(): InstancedMesh;
  19643. /** @hidden */
  19644. _generatePointsArray(): boolean;
  19645. /**
  19646. * Creates a new InstancedMesh from the current mesh.
  19647. * - name (string) : the cloned mesh name
  19648. * - newParent (optional Node) : the optional Node to parent the clone to.
  19649. * - doNotCloneChildren (optional boolean, default `false`) : if `true` the model children aren't cloned.
  19650. *
  19651. * Returns the clone.
  19652. */
  19653. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  19654. /**
  19655. * Disposes the InstancedMesh.
  19656. * Returns nothing.
  19657. */
  19658. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  19659. }
  19660. module "babylonjs/Meshes/mesh" {
  19661. interface Mesh {
  19662. /**
  19663. * Register a custom buffer that will be instanced
  19664. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  19665. * @param kind defines the buffer kind
  19666. * @param stride defines the stride in floats
  19667. */
  19668. registerInstancedBuffer(kind: string, stride: number): void;
  19669. /** @hidden */
  19670. _userInstancedBuffersStorage: {
  19671. data: {
  19672. [key: string]: Float32Array;
  19673. };
  19674. sizes: {
  19675. [key: string]: number;
  19676. };
  19677. vertexBuffers: {
  19678. [key: string]: Nullable<VertexBuffer>;
  19679. };
  19680. strides: {
  19681. [key: string]: number;
  19682. };
  19683. };
  19684. }
  19685. }
  19686. module "babylonjs/Meshes/abstractMesh" {
  19687. interface AbstractMesh {
  19688. /**
  19689. * Object used to store instanced buffers defined by user
  19690. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  19691. */
  19692. instancedBuffers: {
  19693. [key: string]: any;
  19694. };
  19695. }
  19696. }
  19697. }
  19698. declare module "babylonjs/Materials/shaderMaterial" {
  19699. import { Scene } from "babylonjs/scene";
  19700. import { Matrix, Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  19701. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  19702. import { Mesh } from "babylonjs/Meshes/mesh";
  19703. import { BaseSubMesh } from "babylonjs/Meshes/subMesh";
  19704. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  19705. import { Texture } from "babylonjs/Materials/Textures/texture";
  19706. import { Material } from "babylonjs/Materials/material";
  19707. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  19708. /**
  19709. * Defines the options associated with the creation of a shader material.
  19710. */
  19711. export interface IShaderMaterialOptions {
  19712. /**
  19713. * Does the material work in alpha blend mode
  19714. */
  19715. needAlphaBlending: boolean;
  19716. /**
  19717. * Does the material work in alpha test mode
  19718. */
  19719. needAlphaTesting: boolean;
  19720. /**
  19721. * The list of attribute names used in the shader
  19722. */
  19723. attributes: string[];
  19724. /**
  19725. * The list of unifrom names used in the shader
  19726. */
  19727. uniforms: string[];
  19728. /**
  19729. * The list of UBO names used in the shader
  19730. */
  19731. uniformBuffers: string[];
  19732. /**
  19733. * The list of sampler names used in the shader
  19734. */
  19735. samplers: string[];
  19736. /**
  19737. * The list of defines used in the shader
  19738. */
  19739. defines: string[];
  19740. }
  19741. /**
  19742. * 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.
  19743. *
  19744. * This returned material effects how the mesh will look based on the code in the shaders.
  19745. *
  19746. * @see http://doc.babylonjs.com/how_to/shader_material
  19747. */
  19748. export class ShaderMaterial extends Material {
  19749. private _shaderPath;
  19750. private _options;
  19751. private _textures;
  19752. private _textureArrays;
  19753. private _floats;
  19754. private _ints;
  19755. private _floatsArrays;
  19756. private _colors3;
  19757. private _colors3Arrays;
  19758. private _colors4;
  19759. private _colors4Arrays;
  19760. private _vectors2;
  19761. private _vectors3;
  19762. private _vectors4;
  19763. private _matrices;
  19764. private _matrixArrays;
  19765. private _matrices3x3;
  19766. private _matrices2x2;
  19767. private _vectors2Arrays;
  19768. private _vectors3Arrays;
  19769. private _vectors4Arrays;
  19770. private _cachedWorldViewMatrix;
  19771. private _cachedWorldViewProjectionMatrix;
  19772. private _renderId;
  19773. private _multiview;
  19774. /**
  19775. * Instantiate a new shader material.
  19776. * 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.
  19777. * This returned material effects how the mesh will look based on the code in the shaders.
  19778. * @see http://doc.babylonjs.com/how_to/shader_material
  19779. * @param name Define the name of the material in the scene
  19780. * @param scene Define the scene the material belongs to
  19781. * @param shaderPath Defines the route to the shader code in one of three ways:
  19782. * * object: { vertex: "custom", fragment: "custom" }, used with Effect.ShadersStore["customVertexShader"] and Effect.ShadersStore["customFragmentShader"]
  19783. * * object: { vertexElement: "vertexShaderCode", fragmentElement: "fragmentShaderCode" }, used with shader code in script tags
  19784. * * object: { vertexSource: "vertex shader code string", fragmentSource: "fragment shader code string" } using with strings containing the shaders code
  19785. * * string: "./COMMON_NAME", used with external files COMMON_NAME.vertex.fx and COMMON_NAME.fragment.fx in index.html folder.
  19786. * @param options Define the options used to create the shader
  19787. */
  19788. constructor(name: string, scene: Scene, shaderPath: any, options?: Partial<IShaderMaterialOptions>);
  19789. /**
  19790. * Gets the shader path used to define the shader code
  19791. * It can be modified to trigger a new compilation
  19792. */
  19793. /**
  19794. * Sets the shader path used to define the shader code
  19795. * It can be modified to trigger a new compilation
  19796. */
  19797. shaderPath: any;
  19798. /**
  19799. * Gets the options used to compile the shader.
  19800. * They can be modified to trigger a new compilation
  19801. */
  19802. readonly options: IShaderMaterialOptions;
  19803. /**
  19804. * Gets the current class name of the material e.g. "ShaderMaterial"
  19805. * Mainly use in serialization.
  19806. * @returns the class name
  19807. */
  19808. getClassName(): string;
  19809. /**
  19810. * Specifies if the material will require alpha blending
  19811. * @returns a boolean specifying if alpha blending is needed
  19812. */
  19813. needAlphaBlending(): boolean;
  19814. /**
  19815. * Specifies if this material should be rendered in alpha test mode
  19816. * @returns a boolean specifying if an alpha test is needed.
  19817. */
  19818. needAlphaTesting(): boolean;
  19819. private _checkUniform;
  19820. /**
  19821. * Set a texture in the shader.
  19822. * @param name Define the name of the uniform samplers as defined in the shader
  19823. * @param texture Define the texture to bind to this sampler
  19824. * @return the material itself allowing "fluent" like uniform updates
  19825. */
  19826. setTexture(name: string, texture: Texture): ShaderMaterial;
  19827. /**
  19828. * Set a texture array in the shader.
  19829. * @param name Define the name of the uniform sampler array as defined in the shader
  19830. * @param textures Define the list of textures to bind to this sampler
  19831. * @return the material itself allowing "fluent" like uniform updates
  19832. */
  19833. setTextureArray(name: string, textures: Texture[]): ShaderMaterial;
  19834. /**
  19835. * Set a float in the shader.
  19836. * @param name Define the name of the uniform as defined in the shader
  19837. * @param value Define the value to give to the uniform
  19838. * @return the material itself allowing "fluent" like uniform updates
  19839. */
  19840. setFloat(name: string, value: number): ShaderMaterial;
  19841. /**
  19842. * Set a int in the shader.
  19843. * @param name Define the name of the uniform as defined in the shader
  19844. * @param value Define the value to give to the uniform
  19845. * @return the material itself allowing "fluent" like uniform updates
  19846. */
  19847. setInt(name: string, value: number): ShaderMaterial;
  19848. /**
  19849. * Set an array of floats in the shader.
  19850. * @param name Define the name of the uniform as defined in the shader
  19851. * @param value Define the value to give to the uniform
  19852. * @return the material itself allowing "fluent" like uniform updates
  19853. */
  19854. setFloats(name: string, value: number[]): ShaderMaterial;
  19855. /**
  19856. * Set a vec3 in the shader from a Color3.
  19857. * @param name Define the name of the uniform as defined in the shader
  19858. * @param value Define the value to give to the uniform
  19859. * @return the material itself allowing "fluent" like uniform updates
  19860. */
  19861. setColor3(name: string, value: Color3): ShaderMaterial;
  19862. /**
  19863. * Set a vec3 array in the shader from a Color3 array.
  19864. * @param name Define the name of the uniform as defined in the shader
  19865. * @param value Define the value to give to the uniform
  19866. * @return the material itself allowing "fluent" like uniform updates
  19867. */
  19868. setColor3Array(name: string, value: Color3[]): ShaderMaterial;
  19869. /**
  19870. * Set a vec4 in the shader from a Color4.
  19871. * @param name Define the name of the uniform as defined in the shader
  19872. * @param value Define the value to give to the uniform
  19873. * @return the material itself allowing "fluent" like uniform updates
  19874. */
  19875. setColor4(name: string, value: Color4): ShaderMaterial;
  19876. /**
  19877. * Set a vec4 array in the shader from a Color4 array.
  19878. * @param name Define the name of the uniform as defined in the shader
  19879. * @param value Define the value to give to the uniform
  19880. * @return the material itself allowing "fluent" like uniform updates
  19881. */
  19882. setColor4Array(name: string, value: Color4[]): ShaderMaterial;
  19883. /**
  19884. * Set a vec2 in the shader from a Vector2.
  19885. * @param name Define the name of the uniform as defined in the shader
  19886. * @param value Define the value to give to the uniform
  19887. * @return the material itself allowing "fluent" like uniform updates
  19888. */
  19889. setVector2(name: string, value: Vector2): ShaderMaterial;
  19890. /**
  19891. * Set a vec3 in the shader from a Vector3.
  19892. * @param name Define the name of the uniform as defined in the shader
  19893. * @param value Define the value to give to the uniform
  19894. * @return the material itself allowing "fluent" like uniform updates
  19895. */
  19896. setVector3(name: string, value: Vector3): ShaderMaterial;
  19897. /**
  19898. * Set a vec4 in the shader from a Vector4.
  19899. * @param name Define the name of the uniform as defined in the shader
  19900. * @param value Define the value to give to the uniform
  19901. * @return the material itself allowing "fluent" like uniform updates
  19902. */
  19903. setVector4(name: string, value: Vector4): ShaderMaterial;
  19904. /**
  19905. * Set a mat4 in the shader from a Matrix.
  19906. * @param name Define the name of the uniform as defined in the shader
  19907. * @param value Define the value to give to the uniform
  19908. * @return the material itself allowing "fluent" like uniform updates
  19909. */
  19910. setMatrix(name: string, value: Matrix): ShaderMaterial;
  19911. /**
  19912. * Set a float32Array in the shader from a matrix array.
  19913. * @param name Define the name of the uniform as defined in the shader
  19914. * @param value Define the value to give to the uniform
  19915. * @return the material itself allowing "fluent" like uniform updates
  19916. */
  19917. setMatrices(name: string, value: Matrix[]): ShaderMaterial;
  19918. /**
  19919. * Set a mat3 in the shader from a Float32Array.
  19920. * @param name Define the name of the uniform as defined in the shader
  19921. * @param value Define the value to give to the uniform
  19922. * @return the material itself allowing "fluent" like uniform updates
  19923. */
  19924. setMatrix3x3(name: string, value: Float32Array): ShaderMaterial;
  19925. /**
  19926. * Set a mat2 in the shader from a Float32Array.
  19927. * @param name Define the name of the uniform as defined in the shader
  19928. * @param value Define the value to give to the uniform
  19929. * @return the material itself allowing "fluent" like uniform updates
  19930. */
  19931. setMatrix2x2(name: string, value: Float32Array): ShaderMaterial;
  19932. /**
  19933. * Set a vec2 array in the shader from a number array.
  19934. * @param name Define the name of the uniform as defined in the shader
  19935. * @param value Define the value to give to the uniform
  19936. * @return the material itself allowing "fluent" like uniform updates
  19937. */
  19938. setArray2(name: string, value: number[]): ShaderMaterial;
  19939. /**
  19940. * Set a vec3 array in the shader from a number array.
  19941. * @param name Define the name of the uniform as defined in the shader
  19942. * @param value Define the value to give to the uniform
  19943. * @return the material itself allowing "fluent" like uniform updates
  19944. */
  19945. setArray3(name: string, value: number[]): ShaderMaterial;
  19946. /**
  19947. * Set a vec4 array in the shader from a number array.
  19948. * @param name Define the name of the uniform as defined in the shader
  19949. * @param value Define the value to give to the uniform
  19950. * @return the material itself allowing "fluent" like uniform updates
  19951. */
  19952. setArray4(name: string, value: number[]): ShaderMaterial;
  19953. private _checkCache;
  19954. /**
  19955. * Specifies that the submesh is ready to be used
  19956. * @param mesh defines the mesh to check
  19957. * @param subMesh defines which submesh to check
  19958. * @param useInstances specifies that instances should be used
  19959. * @returns a boolean indicating that the submesh is ready or not
  19960. */
  19961. isReadyForSubMesh(mesh: AbstractMesh, subMesh: BaseSubMesh, useInstances?: boolean): boolean;
  19962. /**
  19963. * Checks if the material is ready to render the requested mesh
  19964. * @param mesh Define the mesh to render
  19965. * @param useInstances Define whether or not the material is used with instances
  19966. * @returns true if ready, otherwise false
  19967. */
  19968. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  19969. /**
  19970. * Binds the world matrix to the material
  19971. * @param world defines the world transformation matrix
  19972. */
  19973. bindOnlyWorldMatrix(world: Matrix): void;
  19974. /**
  19975. * Binds the material to the mesh
  19976. * @param world defines the world transformation matrix
  19977. * @param mesh defines the mesh to bind the material to
  19978. */
  19979. bind(world: Matrix, mesh?: Mesh): void;
  19980. /**
  19981. * Gets the active textures from the material
  19982. * @returns an array of textures
  19983. */
  19984. getActiveTextures(): BaseTexture[];
  19985. /**
  19986. * Specifies if the material uses a texture
  19987. * @param texture defines the texture to check against the material
  19988. * @returns a boolean specifying if the material uses the texture
  19989. */
  19990. hasTexture(texture: BaseTexture): boolean;
  19991. /**
  19992. * Makes a duplicate of the material, and gives it a new name
  19993. * @param name defines the new name for the duplicated material
  19994. * @returns the cloned material
  19995. */
  19996. clone(name: string): ShaderMaterial;
  19997. /**
  19998. * Disposes the material
  19999. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  20000. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  20001. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  20002. */
  20003. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  20004. /**
  20005. * Serializes this material in a JSON representation
  20006. * @returns the serialized material object
  20007. */
  20008. serialize(): any;
  20009. /**
  20010. * Creates a shader material from parsed shader material data
  20011. * @param source defines the JSON represnetation of the material
  20012. * @param scene defines the hosting scene
  20013. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  20014. * @returns a new material
  20015. */
  20016. static Parse(source: any, scene: Scene, rootUrl: string): ShaderMaterial;
  20017. }
  20018. }
  20019. declare module "babylonjs/Shaders/color.fragment" {
  20020. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  20021. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  20022. /** @hidden */
  20023. export var colorPixelShader: {
  20024. name: string;
  20025. shader: string;
  20026. };
  20027. }
  20028. declare module "babylonjs/Shaders/color.vertex" {
  20029. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  20030. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  20031. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  20032. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  20033. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  20034. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  20035. /** @hidden */
  20036. export var colorVertexShader: {
  20037. name: string;
  20038. shader: string;
  20039. };
  20040. }
  20041. declare module "babylonjs/Meshes/linesMesh" {
  20042. import { Nullable } from "babylonjs/types";
  20043. import { Scene } from "babylonjs/scene";
  20044. import { Color3 } from "babylonjs/Maths/math.color";
  20045. import { Node } from "babylonjs/node";
  20046. import { SubMesh } from "babylonjs/Meshes/subMesh";
  20047. import { Mesh } from "babylonjs/Meshes/mesh";
  20048. import { InstancedMesh } from "babylonjs/Meshes/instancedMesh";
  20049. import { Effect } from "babylonjs/Materials/effect";
  20050. import { Material } from "babylonjs/Materials/material";
  20051. import "babylonjs/Shaders/color.fragment";
  20052. import "babylonjs/Shaders/color.vertex";
  20053. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  20054. /**
  20055. * Line mesh
  20056. * @see https://doc.babylonjs.com/babylon101/parametric_shapes
  20057. */
  20058. export class LinesMesh extends Mesh {
  20059. /**
  20060. * If vertex color should be applied to the mesh
  20061. */
  20062. readonly useVertexColor?: boolean | undefined;
  20063. /**
  20064. * If vertex alpha should be applied to the mesh
  20065. */
  20066. readonly useVertexAlpha?: boolean | undefined;
  20067. /**
  20068. * Color of the line (Default: White)
  20069. */
  20070. color: Color3;
  20071. /**
  20072. * Alpha of the line (Default: 1)
  20073. */
  20074. alpha: number;
  20075. /**
  20076. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  20077. * This margin is expressed in world space coordinates, so its value may vary.
  20078. * Default value is 0.1
  20079. */
  20080. intersectionThreshold: number;
  20081. private _colorShader;
  20082. private color4;
  20083. /**
  20084. * Creates a new LinesMesh
  20085. * @param name defines the name
  20086. * @param scene defines the hosting scene
  20087. * @param parent defines the parent mesh if any
  20088. * @param source defines the optional source LinesMesh used to clone data from
  20089. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  20090. * When false, achieved by calling a clone(), also passing False.
  20091. * This will make creation of children, recursive.
  20092. * @param useVertexColor defines if this LinesMesh supports vertex color
  20093. * @param useVertexAlpha defines if this LinesMesh supports vertex alpha
  20094. */
  20095. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<LinesMesh>, doNotCloneChildren?: boolean,
  20096. /**
  20097. * If vertex color should be applied to the mesh
  20098. */
  20099. useVertexColor?: boolean | undefined,
  20100. /**
  20101. * If vertex alpha should be applied to the mesh
  20102. */
  20103. useVertexAlpha?: boolean | undefined);
  20104. private _addClipPlaneDefine;
  20105. private _removeClipPlaneDefine;
  20106. isReady(): boolean;
  20107. /**
  20108. * Returns the string "LineMesh"
  20109. */
  20110. getClassName(): string;
  20111. /**
  20112. * @hidden
  20113. */
  20114. /**
  20115. * @hidden
  20116. */
  20117. material: Material;
  20118. /**
  20119. * @hidden
  20120. */
  20121. readonly checkCollisions: boolean;
  20122. /** @hidden */
  20123. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  20124. /** @hidden */
  20125. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  20126. /**
  20127. * Disposes of the line mesh
  20128. * @param doNotRecurse If children should be disposed
  20129. */
  20130. dispose(doNotRecurse?: boolean): void;
  20131. /**
  20132. * Returns a new LineMesh object cloned from the current one.
  20133. */
  20134. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  20135. /**
  20136. * Creates a new InstancedLinesMesh object from the mesh model.
  20137. * @see http://doc.babylonjs.com/how_to/how_to_use_instances
  20138. * @param name defines the name of the new instance
  20139. * @returns a new InstancedLinesMesh
  20140. */
  20141. createInstance(name: string): InstancedLinesMesh;
  20142. }
  20143. /**
  20144. * Creates an instance based on a source LinesMesh
  20145. */
  20146. export class InstancedLinesMesh extends InstancedMesh {
  20147. /**
  20148. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  20149. * This margin is expressed in world space coordinates, so its value may vary.
  20150. * Initilized with the intersectionThreshold value of the source LinesMesh
  20151. */
  20152. intersectionThreshold: number;
  20153. constructor(name: string, source: LinesMesh);
  20154. /**
  20155. * Returns the string "InstancedLinesMesh".
  20156. */
  20157. getClassName(): string;
  20158. }
  20159. }
  20160. declare module "babylonjs/Shaders/line.fragment" {
  20161. /** @hidden */
  20162. export var linePixelShader: {
  20163. name: string;
  20164. shader: string;
  20165. };
  20166. }
  20167. declare module "babylonjs/Shaders/line.vertex" {
  20168. /** @hidden */
  20169. export var lineVertexShader: {
  20170. name: string;
  20171. shader: string;
  20172. };
  20173. }
  20174. declare module "babylonjs/Rendering/edgesRenderer" {
  20175. import { Nullable } from "babylonjs/types";
  20176. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  20177. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  20178. import { Vector3 } from "babylonjs/Maths/math.vector";
  20179. import { IDisposable } from "babylonjs/scene";
  20180. import { ShaderMaterial } from "babylonjs/Materials/shaderMaterial";
  20181. import "babylonjs/Shaders/line.fragment";
  20182. import "babylonjs/Shaders/line.vertex";
  20183. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  20184. module "babylonjs/Meshes/abstractMesh" {
  20185. interface AbstractMesh {
  20186. /**
  20187. * Gets the edgesRenderer associated with the mesh
  20188. */
  20189. edgesRenderer: Nullable<EdgesRenderer>;
  20190. }
  20191. }
  20192. module "babylonjs/Meshes/linesMesh" {
  20193. interface LinesMesh {
  20194. /**
  20195. * Enables the edge rendering mode on the mesh.
  20196. * This mode makes the mesh edges visible
  20197. * @param epsilon defines the maximal distance between two angles to detect a face
  20198. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  20199. * @returns the currentAbstractMesh
  20200. * @see https://www.babylonjs-playground.com/#19O9TU#0
  20201. */
  20202. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  20203. }
  20204. }
  20205. module "babylonjs/Meshes/linesMesh" {
  20206. interface InstancedLinesMesh {
  20207. /**
  20208. * Enables the edge rendering mode on the mesh.
  20209. * This mode makes the mesh edges visible
  20210. * @param epsilon defines the maximal distance between two angles to detect a face
  20211. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  20212. * @returns the current InstancedLinesMesh
  20213. * @see https://www.babylonjs-playground.com/#19O9TU#0
  20214. */
  20215. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): InstancedLinesMesh;
  20216. }
  20217. }
  20218. /**
  20219. * Defines the minimum contract an Edges renderer should follow.
  20220. */
  20221. export interface IEdgesRenderer extends IDisposable {
  20222. /**
  20223. * Gets or sets a boolean indicating if the edgesRenderer is active
  20224. */
  20225. isEnabled: boolean;
  20226. /**
  20227. * Renders the edges of the attached mesh,
  20228. */
  20229. render(): void;
  20230. /**
  20231. * Checks wether or not the edges renderer is ready to render.
  20232. * @return true if ready, otherwise false.
  20233. */
  20234. isReady(): boolean;
  20235. }
  20236. /**
  20237. * This class is used to generate edges of the mesh that could then easily be rendered in a scene.
  20238. */
  20239. export class EdgesRenderer implements IEdgesRenderer {
  20240. /**
  20241. * Define the size of the edges with an orthographic camera
  20242. */
  20243. edgesWidthScalerForOrthographic: number;
  20244. /**
  20245. * Define the size of the edges with a perspective camera
  20246. */
  20247. edgesWidthScalerForPerspective: number;
  20248. protected _source: AbstractMesh;
  20249. protected _linesPositions: number[];
  20250. protected _linesNormals: number[];
  20251. protected _linesIndices: number[];
  20252. protected _epsilon: number;
  20253. protected _indicesCount: number;
  20254. protected _lineShader: ShaderMaterial;
  20255. protected _ib: DataBuffer;
  20256. protected _buffers: {
  20257. [key: string]: Nullable<VertexBuffer>;
  20258. };
  20259. protected _checkVerticesInsteadOfIndices: boolean;
  20260. private _meshRebuildObserver;
  20261. private _meshDisposeObserver;
  20262. /** Gets or sets a boolean indicating if the edgesRenderer is active */
  20263. isEnabled: boolean;
  20264. /**
  20265. * Creates an instance of the EdgesRenderer. It is primarily use to display edges of a mesh.
  20266. * Beware when you use this class with complex objects as the adjacencies computation can be really long
  20267. * @param source Mesh used to create edges
  20268. * @param epsilon sum of angles in adjacency to check for edge
  20269. * @param checkVerticesInsteadOfIndices bases the edges detection on vertices vs indices
  20270. * @param generateEdgesLines - should generate Lines or only prepare resources.
  20271. */
  20272. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean, generateEdgesLines?: boolean);
  20273. protected _prepareRessources(): void;
  20274. /** @hidden */
  20275. _rebuild(): void;
  20276. /**
  20277. * Releases the required resources for the edges renderer
  20278. */
  20279. dispose(): void;
  20280. protected _processEdgeForAdjacencies(pa: number, pb: number, p0: number, p1: number, p2: number): number;
  20281. protected _processEdgeForAdjacenciesWithVertices(pa: Vector3, pb: Vector3, p0: Vector3, p1: Vector3, p2: Vector3): number;
  20282. /**
  20283. * Checks if the pair of p0 and p1 is en edge
  20284. * @param faceIndex
  20285. * @param edge
  20286. * @param faceNormals
  20287. * @param p0
  20288. * @param p1
  20289. * @private
  20290. */
  20291. protected _checkEdge(faceIndex: number, edge: number, faceNormals: Array<Vector3>, p0: Vector3, p1: Vector3): void;
  20292. /**
  20293. * push line into the position, normal and index buffer
  20294. * @protected
  20295. */
  20296. protected createLine(p0: Vector3, p1: Vector3, offset: number): void;
  20297. /**
  20298. * Generates lines edges from adjacencjes
  20299. * @private
  20300. */
  20301. _generateEdgesLines(): void;
  20302. /**
  20303. * Checks wether or not the edges renderer is ready to render.
  20304. * @return true if ready, otherwise false.
  20305. */
  20306. isReady(): boolean;
  20307. /**
  20308. * Renders the edges of the attached mesh,
  20309. */
  20310. render(): void;
  20311. }
  20312. /**
  20313. * LineEdgesRenderer for LineMeshes to remove unnecessary triangulation
  20314. */
  20315. export class LineEdgesRenderer extends EdgesRenderer {
  20316. /**
  20317. * This constructor turns off auto generating edges line in Edges Renderer to make it here.
  20318. * @param source LineMesh used to generate edges
  20319. * @param epsilon not important (specified angle for edge detection)
  20320. * @param checkVerticesInsteadOfIndices not important for LineMesh
  20321. */
  20322. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean);
  20323. /**
  20324. * Generate edges for each line in LinesMesh. Every Line should be rendered as edge.
  20325. */
  20326. _generateEdgesLines(): void;
  20327. }
  20328. }
  20329. declare module "babylonjs/Rendering/renderingGroup" {
  20330. import { SmartArray } from "babylonjs/Misc/smartArray";
  20331. import { SubMesh } from "babylonjs/Meshes/subMesh";
  20332. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  20333. import { Nullable } from "babylonjs/types";
  20334. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  20335. import { IEdgesRenderer } from "babylonjs/Rendering/edgesRenderer";
  20336. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  20337. import { Material } from "babylonjs/Materials/material";
  20338. import { Scene } from "babylonjs/scene";
  20339. /**
  20340. * This represents the object necessary to create a rendering group.
  20341. * This is exclusively used and created by the rendering manager.
  20342. * To modify the behavior, you use the available helpers in your scene or meshes.
  20343. * @hidden
  20344. */
  20345. export class RenderingGroup {
  20346. index: number;
  20347. private static _zeroVector;
  20348. private _scene;
  20349. private _opaqueSubMeshes;
  20350. private _transparentSubMeshes;
  20351. private _alphaTestSubMeshes;
  20352. private _depthOnlySubMeshes;
  20353. private _particleSystems;
  20354. private _spriteManagers;
  20355. private _opaqueSortCompareFn;
  20356. private _alphaTestSortCompareFn;
  20357. private _transparentSortCompareFn;
  20358. private _renderOpaque;
  20359. private _renderAlphaTest;
  20360. private _renderTransparent;
  20361. /** @hidden */
  20362. _edgesRenderers: SmartArray<IEdgesRenderer>;
  20363. onBeforeTransparentRendering: () => void;
  20364. /**
  20365. * Set the opaque sort comparison function.
  20366. * If null the sub meshes will be render in the order they were created
  20367. */
  20368. opaqueSortCompareFn: Nullable<(a: SubMesh, b: SubMesh) => number>;
  20369. /**
  20370. * Set the alpha test sort comparison function.
  20371. * If null the sub meshes will be render in the order they were created
  20372. */
  20373. alphaTestSortCompareFn: Nullable<(a: SubMesh, b: SubMesh) => number>;
  20374. /**
  20375. * Set the transparent sort comparison function.
  20376. * If null the sub meshes will be render in the order they were created
  20377. */
  20378. transparentSortCompareFn: Nullable<(a: SubMesh, b: SubMesh) => number>;
  20379. /**
  20380. * Creates a new rendering group.
  20381. * @param index The rendering group index
  20382. * @param opaqueSortCompareFn The opaque sort comparison function. If null no order is applied
  20383. * @param alphaTestSortCompareFn The alpha test sort comparison function. If null no order is applied
  20384. * @param transparentSortCompareFn The transparent sort comparison function. If null back to front + alpha index sort is applied
  20385. */
  20386. 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>);
  20387. /**
  20388. * Render all the sub meshes contained in the group.
  20389. * @param customRenderFunction Used to override the default render behaviour of the group.
  20390. * @returns true if rendered some submeshes.
  20391. */
  20392. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, renderSprites: boolean, renderParticles: boolean, activeMeshes: Nullable<AbstractMesh[]>): void;
  20393. /**
  20394. * Renders the opaque submeshes in the order from the opaqueSortCompareFn.
  20395. * @param subMeshes The submeshes to render
  20396. */
  20397. private renderOpaqueSorted;
  20398. /**
  20399. * Renders the opaque submeshes in the order from the alphatestSortCompareFn.
  20400. * @param subMeshes The submeshes to render
  20401. */
  20402. private renderAlphaTestSorted;
  20403. /**
  20404. * Renders the opaque submeshes in the order from the transparentSortCompareFn.
  20405. * @param subMeshes The submeshes to render
  20406. */
  20407. private renderTransparentSorted;
  20408. /**
  20409. * Renders the submeshes in a specified order.
  20410. * @param subMeshes The submeshes to sort before render
  20411. * @param sortCompareFn The comparison function use to sort
  20412. * @param cameraPosition The camera position use to preprocess the submeshes to help sorting
  20413. * @param transparent Specifies to activate blending if true
  20414. */
  20415. private static renderSorted;
  20416. /**
  20417. * Renders the submeshes in the order they were dispatched (no sort applied).
  20418. * @param subMeshes The submeshes to render
  20419. */
  20420. private static renderUnsorted;
  20421. /**
  20422. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  20423. * are rendered back to front if in the same alpha index.
  20424. *
  20425. * @param a The first submesh
  20426. * @param b The second submesh
  20427. * @returns The result of the comparison
  20428. */
  20429. static defaultTransparentSortCompare(a: SubMesh, b: SubMesh): number;
  20430. /**
  20431. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  20432. * are rendered back to front.
  20433. *
  20434. * @param a The first submesh
  20435. * @param b The second submesh
  20436. * @returns The result of the comparison
  20437. */
  20438. static backToFrontSortCompare(a: SubMesh, b: SubMesh): number;
  20439. /**
  20440. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  20441. * are rendered front to back (prevent overdraw).
  20442. *
  20443. * @param a The first submesh
  20444. * @param b The second submesh
  20445. * @returns The result of the comparison
  20446. */
  20447. static frontToBackSortCompare(a: SubMesh, b: SubMesh): number;
  20448. /**
  20449. * Resets the different lists of submeshes to prepare a new frame.
  20450. */
  20451. prepare(): void;
  20452. dispose(): void;
  20453. /**
  20454. * Inserts the submesh in its correct queue depending on its material.
  20455. * @param subMesh The submesh to dispatch
  20456. * @param [mesh] Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  20457. * @param [material] Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  20458. */
  20459. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  20460. dispatchSprites(spriteManager: ISpriteManager): void;
  20461. dispatchParticles(particleSystem: IParticleSystem): void;
  20462. private _renderParticles;
  20463. private _renderSprites;
  20464. }
  20465. }
  20466. declare module "babylonjs/Rendering/renderingManager" {
  20467. import { Nullable } from "babylonjs/types";
  20468. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  20469. import { SubMesh } from "babylonjs/Meshes/subMesh";
  20470. import { SmartArray } from "babylonjs/Misc/smartArray";
  20471. import { ISpriteManager } from "babylonjs/Sprites/spriteManager";
  20472. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  20473. import { Material } from "babylonjs/Materials/material";
  20474. import { Scene } from "babylonjs/scene";
  20475. import { Camera } from "babylonjs/Cameras/camera";
  20476. /**
  20477. * Interface describing the different options available in the rendering manager
  20478. * regarding Auto Clear between groups.
  20479. */
  20480. export interface IRenderingManagerAutoClearSetup {
  20481. /**
  20482. * Defines whether or not autoclear is enable.
  20483. */
  20484. autoClear: boolean;
  20485. /**
  20486. * Defines whether or not to autoclear the depth buffer.
  20487. */
  20488. depth: boolean;
  20489. /**
  20490. * Defines whether or not to autoclear the stencil buffer.
  20491. */
  20492. stencil: boolean;
  20493. }
  20494. /**
  20495. * This class is used by the onRenderingGroupObservable
  20496. */
  20497. export class RenderingGroupInfo {
  20498. /**
  20499. * The Scene that being rendered
  20500. */
  20501. scene: Scene;
  20502. /**
  20503. * The camera currently used for the rendering pass
  20504. */
  20505. camera: Nullable<Camera>;
  20506. /**
  20507. * The ID of the renderingGroup being processed
  20508. */
  20509. renderingGroupId: number;
  20510. }
  20511. /**
  20512. * This is the manager responsible of all the rendering for meshes sprites and particles.
  20513. * It is enable to manage the different groups as well as the different necessary sort functions.
  20514. * This should not be used directly aside of the few static configurations
  20515. */
  20516. export class RenderingManager {
  20517. /**
  20518. * The max id used for rendering groups (not included)
  20519. */
  20520. static MAX_RENDERINGGROUPS: number;
  20521. /**
  20522. * The min id used for rendering groups (included)
  20523. */
  20524. static MIN_RENDERINGGROUPS: number;
  20525. /**
  20526. * Used to globally prevent autoclearing scenes.
  20527. */
  20528. static AUTOCLEAR: boolean;
  20529. /**
  20530. * @hidden
  20531. */
  20532. _useSceneAutoClearSetup: boolean;
  20533. private _scene;
  20534. private _renderingGroups;
  20535. private _depthStencilBufferAlreadyCleaned;
  20536. private _autoClearDepthStencil;
  20537. private _customOpaqueSortCompareFn;
  20538. private _customAlphaTestSortCompareFn;
  20539. private _customTransparentSortCompareFn;
  20540. private _renderingGroupInfo;
  20541. /**
  20542. * Instantiates a new rendering group for a particular scene
  20543. * @param scene Defines the scene the groups belongs to
  20544. */
  20545. constructor(scene: Scene);
  20546. private _clearDepthStencilBuffer;
  20547. /**
  20548. * Renders the entire managed groups. This is used by the scene or the different rennder targets.
  20549. * @hidden
  20550. */
  20551. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, activeMeshes: Nullable<AbstractMesh[]>, renderParticles: boolean, renderSprites: boolean): void;
  20552. /**
  20553. * Resets the different information of the group to prepare a new frame
  20554. * @hidden
  20555. */
  20556. reset(): void;
  20557. /**
  20558. * Dispose and release the group and its associated resources.
  20559. * @hidden
  20560. */
  20561. dispose(): void;
  20562. /**
  20563. * Clear the info related to rendering groups preventing retention points during dispose.
  20564. */
  20565. freeRenderingGroups(): void;
  20566. private _prepareRenderingGroup;
  20567. /**
  20568. * Add a sprite manager to the rendering manager in order to render it this frame.
  20569. * @param spriteManager Define the sprite manager to render
  20570. */
  20571. dispatchSprites(spriteManager: ISpriteManager): void;
  20572. /**
  20573. * Add a particle system to the rendering manager in order to render it this frame.
  20574. * @param particleSystem Define the particle system to render
  20575. */
  20576. dispatchParticles(particleSystem: IParticleSystem): void;
  20577. /**
  20578. * Add a submesh to the manager in order to render it this frame
  20579. * @param subMesh The submesh to dispatch
  20580. * @param mesh Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  20581. * @param material Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  20582. */
  20583. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  20584. /**
  20585. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  20586. * This allowed control for front to back rendering or reversly depending of the special needs.
  20587. *
  20588. * @param renderingGroupId The rendering group id corresponding to its index
  20589. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  20590. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  20591. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  20592. */
  20593. 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;
  20594. /**
  20595. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  20596. *
  20597. * @param renderingGroupId The rendering group id corresponding to its index
  20598. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  20599. * @param depth Automatically clears depth between groups if true and autoClear is true.
  20600. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  20601. */
  20602. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  20603. /**
  20604. * Gets the current auto clear configuration for one rendering group of the rendering
  20605. * manager.
  20606. * @param index the rendering group index to get the information for
  20607. * @returns The auto clear setup for the requested rendering group
  20608. */
  20609. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  20610. }
  20611. }
  20612. declare module "babylonjs/Materials/Textures/renderTargetTexture" {
  20613. import { Observable } from "babylonjs/Misc/observable";
  20614. import { SmartArray } from "babylonjs/Misc/smartArray";
  20615. import { Nullable } from "babylonjs/types";
  20616. import { Camera } from "babylonjs/Cameras/camera";
  20617. import { Scene } from "babylonjs/scene";
  20618. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  20619. import { Color4 } from "babylonjs/Maths/math.color";
  20620. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  20621. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  20622. import { SubMesh } from "babylonjs/Meshes/subMesh";
  20623. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  20624. import { Texture } from "babylonjs/Materials/Textures/texture";
  20625. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  20626. import { RenderingManager } from "babylonjs/Rendering/renderingManager";
  20627. import "babylonjs/Engines/Extensions/engine.renderTarget";
  20628. import "babylonjs/Engines/Extensions/engine.renderTargetCube";
  20629. import { Engine } from "babylonjs/Engines/engine";
  20630. /**
  20631. * This Helps creating a texture that will be created from a camera in your scene.
  20632. * It is basically a dynamic texture that could be used to create special effects for instance.
  20633. * Actually, It is the base of lot of effects in the framework like post process, shadows, effect layers and rendering pipelines...
  20634. */
  20635. export class RenderTargetTexture extends Texture {
  20636. isCube: boolean;
  20637. /**
  20638. * The texture will only be rendered once which can be useful to improve performance if everything in your render is static for instance.
  20639. */
  20640. static readonly REFRESHRATE_RENDER_ONCE: number;
  20641. /**
  20642. * The texture will only be rendered rendered every frame and is recomended for dynamic contents.
  20643. */
  20644. static readonly REFRESHRATE_RENDER_ONEVERYFRAME: number;
  20645. /**
  20646. * The texture will be rendered every 2 frames which could be enough if your dynamic objects are not
  20647. * the central point of your effect and can save a lot of performances.
  20648. */
  20649. static readonly REFRESHRATE_RENDER_ONEVERYTWOFRAMES: number;
  20650. /**
  20651. * Use this predicate to dynamically define the list of mesh you want to render.
  20652. * If set, the renderList property will be overwritten.
  20653. */
  20654. renderListPredicate: (AbstractMesh: AbstractMesh) => boolean;
  20655. private _renderList;
  20656. /**
  20657. * Use this list to define the list of mesh you want to render.
  20658. */
  20659. renderList: Nullable<Array<AbstractMesh>>;
  20660. private _hookArray;
  20661. /**
  20662. * Define if particles should be rendered in your texture.
  20663. */
  20664. renderParticles: boolean;
  20665. /**
  20666. * Define if sprites should be rendered in your texture.
  20667. */
  20668. renderSprites: boolean;
  20669. /**
  20670. * Override the default coordinates mode to projection for RTT as it is the most common case for rendered textures.
  20671. */
  20672. coordinatesMode: number;
  20673. /**
  20674. * Define the camera used to render the texture.
  20675. */
  20676. activeCamera: Nullable<Camera>;
  20677. /**
  20678. * Override the render function of the texture with your own one.
  20679. */
  20680. customRenderFunction: (opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>, beforeTransparents?: () => void) => void;
  20681. /**
  20682. * Define if camera post processes should be use while rendering the texture.
  20683. */
  20684. useCameraPostProcesses: boolean;
  20685. /**
  20686. * Define if the camera viewport should be respected while rendering the texture or if the render should be done to the entire texture.
  20687. */
  20688. ignoreCameraViewport: boolean;
  20689. private _postProcessManager;
  20690. private _postProcesses;
  20691. private _resizeObserver;
  20692. /**
  20693. * An event triggered when the texture is unbind.
  20694. */
  20695. onBeforeBindObservable: Observable<RenderTargetTexture>;
  20696. /**
  20697. * An event triggered when the texture is unbind.
  20698. */
  20699. onAfterUnbindObservable: Observable<RenderTargetTexture>;
  20700. private _onAfterUnbindObserver;
  20701. /**
  20702. * Set a after unbind callback in the texture.
  20703. * This has been kept for backward compatibility and use of onAfterUnbindObservable is recommended.
  20704. */
  20705. onAfterUnbind: () => void;
  20706. /**
  20707. * An event triggered before rendering the texture
  20708. */
  20709. onBeforeRenderObservable: Observable<number>;
  20710. private _onBeforeRenderObserver;
  20711. /**
  20712. * Set a before render callback in the texture.
  20713. * This has been kept for backward compatibility and use of onBeforeRenderObservable is recommended.
  20714. */
  20715. onBeforeRender: (faceIndex: number) => void;
  20716. /**
  20717. * An event triggered after rendering the texture
  20718. */
  20719. onAfterRenderObservable: Observable<number>;
  20720. private _onAfterRenderObserver;
  20721. /**
  20722. * Set a after render callback in the texture.
  20723. * This has been kept for backward compatibility and use of onAfterRenderObservable is recommended.
  20724. */
  20725. onAfterRender: (faceIndex: number) => void;
  20726. /**
  20727. * An event triggered after the texture clear
  20728. */
  20729. onClearObservable: Observable<Engine>;
  20730. private _onClearObserver;
  20731. /**
  20732. * Set a clear callback in the texture.
  20733. * This has been kept for backward compatibility and use of onClearObservable is recommended.
  20734. */
  20735. onClear: (Engine: Engine) => void;
  20736. /**
  20737. * An event triggered when the texture is resized.
  20738. */
  20739. onResizeObservable: Observable<RenderTargetTexture>;
  20740. /**
  20741. * Define the clear color of the Render Target if it should be different from the scene.
  20742. */
  20743. clearColor: Color4;
  20744. protected _size: number | {
  20745. width: number;
  20746. height: number;
  20747. };
  20748. protected _initialSizeParameter: number | {
  20749. width: number;
  20750. height: number;
  20751. } | {
  20752. ratio: number;
  20753. };
  20754. protected _sizeRatio: Nullable<number>;
  20755. /** @hidden */
  20756. _generateMipMaps: boolean;
  20757. protected _renderingManager: RenderingManager;
  20758. /** @hidden */
  20759. _waitingRenderList: string[];
  20760. protected _doNotChangeAspectRatio: boolean;
  20761. protected _currentRefreshId: number;
  20762. protected _refreshRate: number;
  20763. protected _textureMatrix: Matrix;
  20764. protected _samples: number;
  20765. protected _renderTargetOptions: RenderTargetCreationOptions;
  20766. /**
  20767. * Gets render target creation options that were used.
  20768. */
  20769. readonly renderTargetOptions: RenderTargetCreationOptions;
  20770. protected _engine: Engine;
  20771. protected _onRatioRescale(): void;
  20772. /**
  20773. * Gets or sets the center of the bounding box associated with the texture (when in cube mode)
  20774. * It must define where the camera used to render the texture is set
  20775. */
  20776. boundingBoxPosition: Vector3;
  20777. private _boundingBoxSize;
  20778. /**
  20779. * Gets or sets the size of the bounding box associated with the texture (when in cube mode)
  20780. * When defined, the cubemap will switch to local mode
  20781. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  20782. * @example https://www.babylonjs-playground.com/#RNASML
  20783. */
  20784. boundingBoxSize: Vector3;
  20785. /**
  20786. * In case the RTT has been created with a depth texture, get the associated
  20787. * depth texture.
  20788. * Otherwise, return null.
  20789. */
  20790. depthStencilTexture: Nullable<InternalTexture>;
  20791. /**
  20792. * Instantiate a render target texture. This is mainly used to render of screen the scene to for instance apply post processse
  20793. * or used a shadow, depth texture...
  20794. * @param name The friendly name of the texture
  20795. * @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)
  20796. * @param scene The scene the RTT belongs to. The latest created scene will be used if not precised.
  20797. * @param generateMipMaps True if mip maps need to be generated after render.
  20798. * @param doNotChangeAspectRatio True to not change the aspect ratio of the scene in the RTT
  20799. * @param type The type of the buffer in the RTT (int, half float, float...)
  20800. * @param isCube True if a cube texture needs to be created
  20801. * @param samplingMode The sampling mode to be usedwith the render target (Linear, Nearest...)
  20802. * @param generateDepthBuffer True to generate a depth buffer
  20803. * @param generateStencilBuffer True to generate a stencil buffer
  20804. * @param isMulti True if multiple textures need to be created (Draw Buffers)
  20805. * @param format The internal format of the buffer in the RTT (RED, RG, RGB, RGBA, ALPHA...)
  20806. * @param delayAllocation if the texture allocation should be delayed (default: false)
  20807. */
  20808. constructor(name: string, size: number | {
  20809. width: number;
  20810. height: number;
  20811. } | {
  20812. ratio: number;
  20813. }, scene: Nullable<Scene>, generateMipMaps?: boolean, doNotChangeAspectRatio?: boolean, type?: number, isCube?: boolean, samplingMode?: number, generateDepthBuffer?: boolean, generateStencilBuffer?: boolean, isMulti?: boolean, format?: number, delayAllocation?: boolean);
  20814. /**
  20815. * Creates a depth stencil texture.
  20816. * This is only available in WebGL 2 or with the depth texture extension available.
  20817. * @param comparisonFunction Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode
  20818. * @param bilinearFiltering Specifies whether or not bilinear filtering is enable on the texture
  20819. * @param generateStencil Specifies whether or not a stencil should be allocated in the texture
  20820. */
  20821. createDepthStencilTexture(comparisonFunction?: number, bilinearFiltering?: boolean, generateStencil?: boolean): void;
  20822. private _processSizeParameter;
  20823. /**
  20824. * Define the number of samples to use in case of MSAA.
  20825. * It defaults to one meaning no MSAA has been enabled.
  20826. */
  20827. samples: number;
  20828. /**
  20829. * Resets the refresh counter of the texture and start bak from scratch.
  20830. * Could be useful to regenerate the texture if it is setup to render only once.
  20831. */
  20832. resetRefreshCounter(): void;
  20833. /**
  20834. * Define the refresh rate of the texture or the rendering frequency.
  20835. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  20836. */
  20837. refreshRate: number;
  20838. /**
  20839. * Adds a post process to the render target rendering passes.
  20840. * @param postProcess define the post process to add
  20841. */
  20842. addPostProcess(postProcess: PostProcess): void;
  20843. /**
  20844. * Clear all the post processes attached to the render target
  20845. * @param dispose define if the cleared post processesshould also be disposed (false by default)
  20846. */
  20847. clearPostProcesses(dispose?: boolean): void;
  20848. /**
  20849. * Remove one of the post process from the list of attached post processes to the texture
  20850. * @param postProcess define the post process to remove from the list
  20851. */
  20852. removePostProcess(postProcess: PostProcess): void;
  20853. /** @hidden */
  20854. _shouldRender(): boolean;
  20855. /**
  20856. * Gets the actual render size of the texture.
  20857. * @returns the width of the render size
  20858. */
  20859. getRenderSize(): number;
  20860. /**
  20861. * Gets the actual render width of the texture.
  20862. * @returns the width of the render size
  20863. */
  20864. getRenderWidth(): number;
  20865. /**
  20866. * Gets the actual render height of the texture.
  20867. * @returns the height of the render size
  20868. */
  20869. getRenderHeight(): number;
  20870. /**
  20871. * Get if the texture can be rescaled or not.
  20872. */
  20873. readonly canRescale: boolean;
  20874. /**
  20875. * Resize the texture using a ratio.
  20876. * @param ratio the ratio to apply to the texture size in order to compute the new target size
  20877. */
  20878. scale(ratio: number): void;
  20879. /**
  20880. * Get the texture reflection matrix used to rotate/transform the reflection.
  20881. * @returns the reflection matrix
  20882. */
  20883. getReflectionTextureMatrix(): Matrix;
  20884. /**
  20885. * Resize the texture to a new desired size.
  20886. * Be carrefull as it will recreate all the data in the new texture.
  20887. * @param size Define the new size. It can be:
  20888. * - a number for squared texture,
  20889. * - an object containing { width: number, height: number }
  20890. * - or an object containing a ratio { ratio: number }
  20891. */
  20892. resize(size: number | {
  20893. width: number;
  20894. height: number;
  20895. } | {
  20896. ratio: number;
  20897. }): void;
  20898. /**
  20899. * Renders all the objects from the render list into the texture.
  20900. * @param useCameraPostProcess Define if camera post processes should be used during the rendering
  20901. * @param dumpForDebug Define if the rendering result should be dumped (copied) for debugging purpose
  20902. */
  20903. render(useCameraPostProcess?: boolean, dumpForDebug?: boolean): void;
  20904. private _bestReflectionRenderTargetDimension;
  20905. /**
  20906. * @hidden
  20907. * @param faceIndex face index to bind to if this is a cubetexture
  20908. */
  20909. _bindFrameBuffer(faceIndex?: number): void;
  20910. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  20911. private renderToTarget;
  20912. /**
  20913. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  20914. * This allowed control for front to back rendering or reversly depending of the special needs.
  20915. *
  20916. * @param renderingGroupId The rendering group id corresponding to its index
  20917. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  20918. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  20919. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  20920. */
  20921. 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;
  20922. /**
  20923. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  20924. *
  20925. * @param renderingGroupId The rendering group id corresponding to its index
  20926. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  20927. */
  20928. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  20929. /**
  20930. * Clones the texture.
  20931. * @returns the cloned texture
  20932. */
  20933. clone(): RenderTargetTexture;
  20934. /**
  20935. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  20936. * @returns The JSON representation of the texture
  20937. */
  20938. serialize(): any;
  20939. /**
  20940. * This will remove the attached framebuffer objects. The texture will not be able to be used as render target anymore
  20941. */
  20942. disposeFramebufferObjects(): void;
  20943. /**
  20944. * Dispose the texture and release its associated resources.
  20945. */
  20946. dispose(): void;
  20947. /** @hidden */
  20948. _rebuild(): void;
  20949. /**
  20950. * Clear the info related to rendering groups preventing retention point in material dispose.
  20951. */
  20952. freeRenderingGroups(): void;
  20953. /**
  20954. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  20955. * @returns the view count
  20956. */
  20957. getViewCount(): number;
  20958. }
  20959. }
  20960. declare module "babylonjs/Materials/material" {
  20961. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  20962. import { SmartArray } from "babylonjs/Misc/smartArray";
  20963. import { Observable } from "babylonjs/Misc/observable";
  20964. import { Nullable } from "babylonjs/types";
  20965. import { Scene } from "babylonjs/scene";
  20966. import { Matrix } from "babylonjs/Maths/math.vector";
  20967. import { BaseSubMesh, SubMesh } from "babylonjs/Meshes/subMesh";
  20968. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  20969. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  20970. import { Effect } from "babylonjs/Materials/effect";
  20971. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  20972. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  20973. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  20974. import { IInspectable } from "babylonjs/Misc/iInspectable";
  20975. import { Mesh } from "babylonjs/Meshes/mesh";
  20976. import { Animation } from "babylonjs/Animations/animation";
  20977. /**
  20978. * Options for compiling materials.
  20979. */
  20980. export interface IMaterialCompilationOptions {
  20981. /**
  20982. * Defines whether clip planes are enabled.
  20983. */
  20984. clipPlane: boolean;
  20985. /**
  20986. * Defines whether instances are enabled.
  20987. */
  20988. useInstances: boolean;
  20989. }
  20990. /**
  20991. * Base class for the main features of a material in Babylon.js
  20992. */
  20993. export class Material implements IAnimatable {
  20994. /**
  20995. * Returns the triangle fill mode
  20996. */
  20997. static readonly TriangleFillMode: number;
  20998. /**
  20999. * Returns the wireframe mode
  21000. */
  21001. static readonly WireFrameFillMode: number;
  21002. /**
  21003. * Returns the point fill mode
  21004. */
  21005. static readonly PointFillMode: number;
  21006. /**
  21007. * Returns the point list draw mode
  21008. */
  21009. static readonly PointListDrawMode: number;
  21010. /**
  21011. * Returns the line list draw mode
  21012. */
  21013. static readonly LineListDrawMode: number;
  21014. /**
  21015. * Returns the line loop draw mode
  21016. */
  21017. static readonly LineLoopDrawMode: number;
  21018. /**
  21019. * Returns the line strip draw mode
  21020. */
  21021. static readonly LineStripDrawMode: number;
  21022. /**
  21023. * Returns the triangle strip draw mode
  21024. */
  21025. static readonly TriangleStripDrawMode: number;
  21026. /**
  21027. * Returns the triangle fan draw mode
  21028. */
  21029. static readonly TriangleFanDrawMode: number;
  21030. /**
  21031. * Stores the clock-wise side orientation
  21032. */
  21033. static readonly ClockWiseSideOrientation: number;
  21034. /**
  21035. * Stores the counter clock-wise side orientation
  21036. */
  21037. static readonly CounterClockWiseSideOrientation: number;
  21038. /**
  21039. * The dirty texture flag value
  21040. */
  21041. static readonly TextureDirtyFlag: number;
  21042. /**
  21043. * The dirty light flag value
  21044. */
  21045. static readonly LightDirtyFlag: number;
  21046. /**
  21047. * The dirty fresnel flag value
  21048. */
  21049. static readonly FresnelDirtyFlag: number;
  21050. /**
  21051. * The dirty attribute flag value
  21052. */
  21053. static readonly AttributesDirtyFlag: number;
  21054. /**
  21055. * The dirty misc flag value
  21056. */
  21057. static readonly MiscDirtyFlag: number;
  21058. /**
  21059. * The all dirty flag value
  21060. */
  21061. static readonly AllDirtyFlag: number;
  21062. /**
  21063. * The ID of the material
  21064. */
  21065. id: string;
  21066. /**
  21067. * Gets or sets the unique id of the material
  21068. */
  21069. uniqueId: number;
  21070. /**
  21071. * The name of the material
  21072. */
  21073. name: string;
  21074. /**
  21075. * Gets or sets user defined metadata
  21076. */
  21077. metadata: any;
  21078. /**
  21079. * For internal use only. Please do not use.
  21080. */
  21081. reservedDataStore: any;
  21082. /**
  21083. * Specifies if the ready state should be checked on each call
  21084. */
  21085. checkReadyOnEveryCall: boolean;
  21086. /**
  21087. * Specifies if the ready state should be checked once
  21088. */
  21089. checkReadyOnlyOnce: boolean;
  21090. /**
  21091. * The state of the material
  21092. */
  21093. state: string;
  21094. /**
  21095. * The alpha value of the material
  21096. */
  21097. protected _alpha: number;
  21098. /**
  21099. * List of inspectable custom properties (used by the Inspector)
  21100. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  21101. */
  21102. inspectableCustomProperties: IInspectable[];
  21103. /**
  21104. * Sets the alpha value of the material
  21105. */
  21106. /**
  21107. * Gets the alpha value of the material
  21108. */
  21109. alpha: number;
  21110. /**
  21111. * Specifies if back face culling is enabled
  21112. */
  21113. protected _backFaceCulling: boolean;
  21114. /**
  21115. * Sets the back-face culling state
  21116. */
  21117. /**
  21118. * Gets the back-face culling state
  21119. */
  21120. backFaceCulling: boolean;
  21121. /**
  21122. * Stores the value for side orientation
  21123. */
  21124. sideOrientation: number;
  21125. /**
  21126. * Callback triggered when the material is compiled
  21127. */
  21128. onCompiled: Nullable<(effect: Effect) => void>;
  21129. /**
  21130. * Callback triggered when an error occurs
  21131. */
  21132. onError: Nullable<(effect: Effect, errors: string) => void>;
  21133. /**
  21134. * Callback triggered to get the render target textures
  21135. */
  21136. getRenderTargetTextures: Nullable<() => SmartArray<RenderTargetTexture>>;
  21137. /**
  21138. * Gets a boolean indicating that current material needs to register RTT
  21139. */
  21140. readonly hasRenderTargetTextures: boolean;
  21141. /**
  21142. * Specifies if the material should be serialized
  21143. */
  21144. doNotSerialize: boolean;
  21145. /**
  21146. * @hidden
  21147. */
  21148. _storeEffectOnSubMeshes: boolean;
  21149. /**
  21150. * Stores the animations for the material
  21151. */
  21152. animations: Nullable<Array<Animation>>;
  21153. /**
  21154. * An event triggered when the material is disposed
  21155. */
  21156. onDisposeObservable: Observable<Material>;
  21157. /**
  21158. * An observer which watches for dispose events
  21159. */
  21160. private _onDisposeObserver;
  21161. private _onUnBindObservable;
  21162. /**
  21163. * Called during a dispose event
  21164. */
  21165. onDispose: () => void;
  21166. private _onBindObservable;
  21167. /**
  21168. * An event triggered when the material is bound
  21169. */
  21170. readonly onBindObservable: Observable<AbstractMesh>;
  21171. /**
  21172. * An observer which watches for bind events
  21173. */
  21174. private _onBindObserver;
  21175. /**
  21176. * Called during a bind event
  21177. */
  21178. onBind: (Mesh: AbstractMesh) => void;
  21179. /**
  21180. * An event triggered when the material is unbound
  21181. */
  21182. readonly onUnBindObservable: Observable<Material>;
  21183. /**
  21184. * Stores the value of the alpha mode
  21185. */
  21186. private _alphaMode;
  21187. /**
  21188. * Sets the value of the alpha mode.
  21189. *
  21190. * | Value | Type | Description |
  21191. * | --- | --- | --- |
  21192. * | 0 | ALPHA_DISABLE | |
  21193. * | 1 | ALPHA_ADD | |
  21194. * | 2 | ALPHA_COMBINE | |
  21195. * | 3 | ALPHA_SUBTRACT | |
  21196. * | 4 | ALPHA_MULTIPLY | |
  21197. * | 5 | ALPHA_MAXIMIZED | |
  21198. * | 6 | ALPHA_ONEONE | |
  21199. * | 7 | ALPHA_PREMULTIPLIED | |
  21200. * | 8 | ALPHA_PREMULTIPLIED_PORTERDUFF | |
  21201. * | 9 | ALPHA_INTERPOLATE | |
  21202. * | 10 | ALPHA_SCREENMODE | |
  21203. *
  21204. */
  21205. /**
  21206. * Gets the value of the alpha mode
  21207. */
  21208. alphaMode: number;
  21209. /**
  21210. * Stores the state of the need depth pre-pass value
  21211. */
  21212. private _needDepthPrePass;
  21213. /**
  21214. * Sets the need depth pre-pass value
  21215. */
  21216. /**
  21217. * Gets the depth pre-pass value
  21218. */
  21219. needDepthPrePass: boolean;
  21220. /**
  21221. * Specifies if depth writing should be disabled
  21222. */
  21223. disableDepthWrite: boolean;
  21224. /**
  21225. * Specifies if depth writing should be forced
  21226. */
  21227. forceDepthWrite: boolean;
  21228. /**
  21229. * Specifies the depth function that should be used. 0 means the default engine function
  21230. */
  21231. depthFunction: number;
  21232. /**
  21233. * Specifies if there should be a separate pass for culling
  21234. */
  21235. separateCullingPass: boolean;
  21236. /**
  21237. * Stores the state specifing if fog should be enabled
  21238. */
  21239. private _fogEnabled;
  21240. /**
  21241. * Sets the state for enabling fog
  21242. */
  21243. /**
  21244. * Gets the value of the fog enabled state
  21245. */
  21246. fogEnabled: boolean;
  21247. /**
  21248. * Stores the size of points
  21249. */
  21250. pointSize: number;
  21251. /**
  21252. * Stores the z offset value
  21253. */
  21254. zOffset: number;
  21255. /**
  21256. * Gets a value specifying if wireframe mode is enabled
  21257. */
  21258. /**
  21259. * Sets the state of wireframe mode
  21260. */
  21261. wireframe: boolean;
  21262. /**
  21263. * Gets the value specifying if point clouds are enabled
  21264. */
  21265. /**
  21266. * Sets the state of point cloud mode
  21267. */
  21268. pointsCloud: boolean;
  21269. /**
  21270. * Gets the material fill mode
  21271. */
  21272. /**
  21273. * Sets the material fill mode
  21274. */
  21275. fillMode: number;
  21276. /**
  21277. * @hidden
  21278. * Stores the effects for the material
  21279. */
  21280. _effect: Nullable<Effect>;
  21281. /**
  21282. * @hidden
  21283. * Specifies if the material was previously ready
  21284. */
  21285. _wasPreviouslyReady: boolean;
  21286. /**
  21287. * Specifies if uniform buffers should be used
  21288. */
  21289. private _useUBO;
  21290. /**
  21291. * Stores a reference to the scene
  21292. */
  21293. private _scene;
  21294. /**
  21295. * Stores the fill mode state
  21296. */
  21297. private _fillMode;
  21298. /**
  21299. * Specifies if the depth write state should be cached
  21300. */
  21301. private _cachedDepthWriteState;
  21302. /**
  21303. * Specifies if the depth function state should be cached
  21304. */
  21305. private _cachedDepthFunctionState;
  21306. /**
  21307. * Stores the uniform buffer
  21308. */
  21309. protected _uniformBuffer: UniformBuffer;
  21310. /** @hidden */
  21311. _indexInSceneMaterialArray: number;
  21312. /** @hidden */
  21313. meshMap: Nullable<{
  21314. [id: string]: AbstractMesh | undefined;
  21315. }>;
  21316. /**
  21317. * Creates a material instance
  21318. * @param name defines the name of the material
  21319. * @param scene defines the scene to reference
  21320. * @param doNotAdd specifies if the material should be added to the scene
  21321. */
  21322. constructor(name: string, scene: Scene, doNotAdd?: boolean);
  21323. /**
  21324. * Returns a string representation of the current material
  21325. * @param fullDetails defines a boolean indicating which levels of logging is desired
  21326. * @returns a string with material information
  21327. */
  21328. toString(fullDetails?: boolean): string;
  21329. /**
  21330. * Gets the class name of the material
  21331. * @returns a string with the class name of the material
  21332. */
  21333. getClassName(): string;
  21334. /**
  21335. * Specifies if updates for the material been locked
  21336. */
  21337. readonly isFrozen: boolean;
  21338. /**
  21339. * Locks updates for the material
  21340. */
  21341. freeze(): void;
  21342. /**
  21343. * Unlocks updates for the material
  21344. */
  21345. unfreeze(): void;
  21346. /**
  21347. * Specifies if the material is ready to be used
  21348. * @param mesh defines the mesh to check
  21349. * @param useInstances specifies if instances should be used
  21350. * @returns a boolean indicating if the material is ready to be used
  21351. */
  21352. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  21353. /**
  21354. * Specifies that the submesh is ready to be used
  21355. * @param mesh defines the mesh to check
  21356. * @param subMesh defines which submesh to check
  21357. * @param useInstances specifies that instances should be used
  21358. * @returns a boolean indicating that the submesh is ready or not
  21359. */
  21360. isReadyForSubMesh(mesh: AbstractMesh, subMesh: BaseSubMesh, useInstances?: boolean): boolean;
  21361. /**
  21362. * Returns the material effect
  21363. * @returns the effect associated with the material
  21364. */
  21365. getEffect(): Nullable<Effect>;
  21366. /**
  21367. * Returns the current scene
  21368. * @returns a Scene
  21369. */
  21370. getScene(): Scene;
  21371. /**
  21372. * Specifies if the material will require alpha blending
  21373. * @returns a boolean specifying if alpha blending is needed
  21374. */
  21375. needAlphaBlending(): boolean;
  21376. /**
  21377. * Specifies if the mesh will require alpha blending
  21378. * @param mesh defines the mesh to check
  21379. * @returns a boolean specifying if alpha blending is needed for the mesh
  21380. */
  21381. needAlphaBlendingForMesh(mesh: AbstractMesh): boolean;
  21382. /**
  21383. * Specifies if this material should be rendered in alpha test mode
  21384. * @returns a boolean specifying if an alpha test is needed.
  21385. */
  21386. needAlphaTesting(): boolean;
  21387. /**
  21388. * Gets the texture used for the alpha test
  21389. * @returns the texture to use for alpha testing
  21390. */
  21391. getAlphaTestTexture(): Nullable<BaseTexture>;
  21392. /**
  21393. * Marks the material to indicate that it needs to be re-calculated
  21394. */
  21395. markDirty(): void;
  21396. /** @hidden */
  21397. _preBind(effect?: Effect, overrideOrientation?: Nullable<number>): boolean;
  21398. /**
  21399. * Binds the material to the mesh
  21400. * @param world defines the world transformation matrix
  21401. * @param mesh defines the mesh to bind the material to
  21402. */
  21403. bind(world: Matrix, mesh?: Mesh): void;
  21404. /**
  21405. * Binds the submesh to the material
  21406. * @param world defines the world transformation matrix
  21407. * @param mesh defines the mesh containing the submesh
  21408. * @param subMesh defines the submesh to bind the material to
  21409. */
  21410. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  21411. /**
  21412. * Binds the world matrix to the material
  21413. * @param world defines the world transformation matrix
  21414. */
  21415. bindOnlyWorldMatrix(world: Matrix): void;
  21416. /**
  21417. * Binds the scene's uniform buffer to the effect.
  21418. * @param effect defines the effect to bind to the scene uniform buffer
  21419. * @param sceneUbo defines the uniform buffer storing scene data
  21420. */
  21421. bindSceneUniformBuffer(effect: Effect, sceneUbo: UniformBuffer): void;
  21422. /**
  21423. * Binds the view matrix to the effect
  21424. * @param effect defines the effect to bind the view matrix to
  21425. */
  21426. bindView(effect: Effect): void;
  21427. /**
  21428. * Binds the view projection matrix to the effect
  21429. * @param effect defines the effect to bind the view projection matrix to
  21430. */
  21431. bindViewProjection(effect: Effect): void;
  21432. /**
  21433. * Specifies if material alpha testing should be turned on for the mesh
  21434. * @param mesh defines the mesh to check
  21435. */
  21436. protected _shouldTurnAlphaTestOn(mesh: AbstractMesh): boolean;
  21437. /**
  21438. * Processes to execute after binding the material to a mesh
  21439. * @param mesh defines the rendered mesh
  21440. */
  21441. protected _afterBind(mesh?: Mesh): void;
  21442. /**
  21443. * Unbinds the material from the mesh
  21444. */
  21445. unbind(): void;
  21446. /**
  21447. * Gets the active textures from the material
  21448. * @returns an array of textures
  21449. */
  21450. getActiveTextures(): BaseTexture[];
  21451. /**
  21452. * Specifies if the material uses a texture
  21453. * @param texture defines the texture to check against the material
  21454. * @returns a boolean specifying if the material uses the texture
  21455. */
  21456. hasTexture(texture: BaseTexture): boolean;
  21457. /**
  21458. * Makes a duplicate of the material, and gives it a new name
  21459. * @param name defines the new name for the duplicated material
  21460. * @returns the cloned material
  21461. */
  21462. clone(name: string): Nullable<Material>;
  21463. /**
  21464. * Gets the meshes bound to the material
  21465. * @returns an array of meshes bound to the material
  21466. */
  21467. getBindedMeshes(): AbstractMesh[];
  21468. /**
  21469. * Force shader compilation
  21470. * @param mesh defines the mesh associated with this material
  21471. * @param onCompiled defines a function to execute once the material is compiled
  21472. * @param options defines the options to configure the compilation
  21473. * @param onError defines a function to execute if the material fails compiling
  21474. */
  21475. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>, onError?: (reason: string) => void): void;
  21476. /**
  21477. * Force shader compilation
  21478. * @param mesh defines the mesh that will use this material
  21479. * @param options defines additional options for compiling the shaders
  21480. * @returns a promise that resolves when the compilation completes
  21481. */
  21482. forceCompilationAsync(mesh: AbstractMesh, options?: Partial<IMaterialCompilationOptions>): Promise<void>;
  21483. private static readonly _AllDirtyCallBack;
  21484. private static readonly _ImageProcessingDirtyCallBack;
  21485. private static readonly _TextureDirtyCallBack;
  21486. private static readonly _FresnelDirtyCallBack;
  21487. private static readonly _MiscDirtyCallBack;
  21488. private static readonly _LightsDirtyCallBack;
  21489. private static readonly _AttributeDirtyCallBack;
  21490. private static _FresnelAndMiscDirtyCallBack;
  21491. private static _TextureAndMiscDirtyCallBack;
  21492. private static readonly _DirtyCallbackArray;
  21493. private static readonly _RunDirtyCallBacks;
  21494. /**
  21495. * Marks a define in the material to indicate that it needs to be re-computed
  21496. * @param flag defines a flag used to determine which parts of the material have to be marked as dirty
  21497. */
  21498. markAsDirty(flag: number): void;
  21499. /**
  21500. * Marks all submeshes of a material to indicate that their material defines need to be re-calculated
  21501. * @param func defines a function which checks material defines against the submeshes
  21502. */
  21503. protected _markAllSubMeshesAsDirty(func: (defines: MaterialDefines) => void): void;
  21504. /**
  21505. * Indicates that we need to re-calculated for all submeshes
  21506. */
  21507. protected _markAllSubMeshesAsAllDirty(): void;
  21508. /**
  21509. * Indicates that image processing needs to be re-calculated for all submeshes
  21510. */
  21511. protected _markAllSubMeshesAsImageProcessingDirty(): void;
  21512. /**
  21513. * Indicates that textures need to be re-calculated for all submeshes
  21514. */
  21515. protected _markAllSubMeshesAsTexturesDirty(): void;
  21516. /**
  21517. * Indicates that fresnel needs to be re-calculated for all submeshes
  21518. */
  21519. protected _markAllSubMeshesAsFresnelDirty(): void;
  21520. /**
  21521. * Indicates that fresnel and misc need to be re-calculated for all submeshes
  21522. */
  21523. protected _markAllSubMeshesAsFresnelAndMiscDirty(): void;
  21524. /**
  21525. * Indicates that lights need to be re-calculated for all submeshes
  21526. */
  21527. protected _markAllSubMeshesAsLightsDirty(): void;
  21528. /**
  21529. * Indicates that attributes need to be re-calculated for all submeshes
  21530. */
  21531. protected _markAllSubMeshesAsAttributesDirty(): void;
  21532. /**
  21533. * Indicates that misc needs to be re-calculated for all submeshes
  21534. */
  21535. protected _markAllSubMeshesAsMiscDirty(): void;
  21536. /**
  21537. * Indicates that textures and misc need to be re-calculated for all submeshes
  21538. */
  21539. protected _markAllSubMeshesAsTexturesAndMiscDirty(): void;
  21540. /**
  21541. * Disposes the material
  21542. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  21543. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  21544. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  21545. */
  21546. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  21547. /** @hidden */
  21548. private releaseVertexArrayObject;
  21549. /**
  21550. * Serializes this material
  21551. * @returns the serialized material object
  21552. */
  21553. serialize(): any;
  21554. /**
  21555. * Creates a material from parsed material data
  21556. * @param parsedMaterial defines parsed material data
  21557. * @param scene defines the hosting scene
  21558. * @param rootUrl defines the root URL to use to load textures
  21559. * @returns a new material
  21560. */
  21561. static Parse(parsedMaterial: any, scene: Scene, rootUrl: string): Nullable<Material>;
  21562. }
  21563. }
  21564. declare module "babylonjs/Materials/multiMaterial" {
  21565. import { Nullable } from "babylonjs/types";
  21566. import { Scene } from "babylonjs/scene";
  21567. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21568. import { BaseSubMesh } from "babylonjs/Meshes/subMesh";
  21569. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  21570. import { Material } from "babylonjs/Materials/material";
  21571. /**
  21572. * A multi-material is used to apply different materials to different parts of the same object without the need of
  21573. * separate meshes. This can be use to improve performances.
  21574. * @see http://doc.babylonjs.com/how_to/multi_materials
  21575. */
  21576. export class MultiMaterial extends Material {
  21577. private _subMaterials;
  21578. /**
  21579. * Gets or Sets the list of Materials used within the multi material.
  21580. * They need to be ordered according to the submeshes order in the associated mesh
  21581. */
  21582. subMaterials: Nullable<Material>[];
  21583. /**
  21584. * Function used to align with Node.getChildren()
  21585. * @returns the list of Materials used within the multi material
  21586. */
  21587. getChildren(): Nullable<Material>[];
  21588. /**
  21589. * Instantiates a new Multi Material
  21590. * A multi-material is used to apply different materials to different parts of the same object without the need of
  21591. * separate meshes. This can be use to improve performances.
  21592. * @see http://doc.babylonjs.com/how_to/multi_materials
  21593. * @param name Define the name in the scene
  21594. * @param scene Define the scene the material belongs to
  21595. */
  21596. constructor(name: string, scene: Scene);
  21597. private _hookArray;
  21598. /**
  21599. * Get one of the submaterial by its index in the submaterials array
  21600. * @param index The index to look the sub material at
  21601. * @returns The Material if the index has been defined
  21602. */
  21603. getSubMaterial(index: number): Nullable<Material>;
  21604. /**
  21605. * Get the list of active textures for the whole sub materials list.
  21606. * @returns All the textures that will be used during the rendering
  21607. */
  21608. getActiveTextures(): BaseTexture[];
  21609. /**
  21610. * Gets the current class name of the material e.g. "MultiMaterial"
  21611. * Mainly use in serialization.
  21612. * @returns the class name
  21613. */
  21614. getClassName(): string;
  21615. /**
  21616. * Checks if the material is ready to render the requested sub mesh
  21617. * @param mesh Define the mesh the submesh belongs to
  21618. * @param subMesh Define the sub mesh to look readyness for
  21619. * @param useInstances Define whether or not the material is used with instances
  21620. * @returns true if ready, otherwise false
  21621. */
  21622. isReadyForSubMesh(mesh: AbstractMesh, subMesh: BaseSubMesh, useInstances?: boolean): boolean;
  21623. /**
  21624. * Clones the current material and its related sub materials
  21625. * @param name Define the name of the newly cloned material
  21626. * @param cloneChildren Define if submaterial will be cloned or shared with the parent instance
  21627. * @returns the cloned material
  21628. */
  21629. clone(name: string, cloneChildren?: boolean): MultiMaterial;
  21630. /**
  21631. * Serializes the materials into a JSON representation.
  21632. * @returns the JSON representation
  21633. */
  21634. serialize(): any;
  21635. /**
  21636. * Dispose the material and release its associated resources
  21637. * @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)
  21638. * @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)
  21639. * @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)
  21640. */
  21641. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, forceDisposeChildren?: boolean): void;
  21642. /**
  21643. * Creates a MultiMaterial from parsed MultiMaterial data.
  21644. * @param parsedMultiMaterial defines parsed MultiMaterial data.
  21645. * @param scene defines the hosting scene
  21646. * @returns a new MultiMaterial
  21647. */
  21648. static ParseMultiMaterial(parsedMultiMaterial: any, scene: Scene): MultiMaterial;
  21649. }
  21650. }
  21651. declare module "babylonjs/Meshes/subMesh" {
  21652. import { Nullable, IndicesArray, DeepImmutable, FloatArray } from "babylonjs/types";
  21653. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  21654. import { Engine } from "babylonjs/Engines/engine";
  21655. import { IntersectionInfo } from "babylonjs/Collisions/intersectionInfo";
  21656. import { ICullable, BoundingInfo } from "babylonjs/Culling/boundingInfo";
  21657. import { Effect } from "babylonjs/Materials/effect";
  21658. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  21659. import { Plane } from "babylonjs/Maths/math.plane";
  21660. import { Collider } from "babylonjs/Collisions/collider";
  21661. import { Material } from "babylonjs/Materials/material";
  21662. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  21663. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  21664. import { Mesh } from "babylonjs/Meshes/mesh";
  21665. import { Ray } from "babylonjs/Culling/ray";
  21666. import { TrianglePickingPredicate } from "babylonjs/Culling/ray";
  21667. /**
  21668. * Base class for submeshes
  21669. */
  21670. export class BaseSubMesh {
  21671. /** @hidden */
  21672. _materialDefines: Nullable<MaterialDefines>;
  21673. /** @hidden */
  21674. _materialEffect: Nullable<Effect>;
  21675. /**
  21676. * Gets associated effect
  21677. */
  21678. readonly effect: Nullable<Effect>;
  21679. /**
  21680. * Sets associated effect (effect used to render this submesh)
  21681. * @param effect defines the effect to associate with
  21682. * @param defines defines the set of defines used to compile this effect
  21683. */
  21684. setEffect(effect: Nullable<Effect>, defines?: Nullable<MaterialDefines>): void;
  21685. }
  21686. /**
  21687. * Defines a subdivision inside a mesh
  21688. */
  21689. export class SubMesh extends BaseSubMesh implements ICullable {
  21690. /** the material index to use */
  21691. materialIndex: number;
  21692. /** vertex index start */
  21693. verticesStart: number;
  21694. /** vertices count */
  21695. verticesCount: number;
  21696. /** index start */
  21697. indexStart: number;
  21698. /** indices count */
  21699. indexCount: number;
  21700. /** @hidden */
  21701. _linesIndexCount: number;
  21702. private _mesh;
  21703. private _renderingMesh;
  21704. private _boundingInfo;
  21705. private _linesIndexBuffer;
  21706. /** @hidden */
  21707. _lastColliderWorldVertices: Nullable<Vector3[]>;
  21708. /** @hidden */
  21709. _trianglePlanes: Plane[];
  21710. /** @hidden */
  21711. _lastColliderTransformMatrix: Nullable<Matrix>;
  21712. /** @hidden */
  21713. _renderId: number;
  21714. /** @hidden */
  21715. _alphaIndex: number;
  21716. /** @hidden */
  21717. _distanceToCamera: number;
  21718. /** @hidden */
  21719. _id: number;
  21720. private _currentMaterial;
  21721. /**
  21722. * Add a new submesh to a mesh
  21723. * @param materialIndex defines the material index to use
  21724. * @param verticesStart defines vertex index start
  21725. * @param verticesCount defines vertices count
  21726. * @param indexStart defines index start
  21727. * @param indexCount defines indices count
  21728. * @param mesh defines the parent mesh
  21729. * @param renderingMesh defines an optional rendering mesh
  21730. * @param createBoundingBox defines if bounding box should be created for this submesh
  21731. * @returns the new submesh
  21732. */
  21733. static AddToMesh(materialIndex: number, verticesStart: number, verticesCount: number, indexStart: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean): SubMesh;
  21734. /**
  21735. * Creates a new submesh
  21736. * @param materialIndex defines the material index to use
  21737. * @param verticesStart defines vertex index start
  21738. * @param verticesCount defines vertices count
  21739. * @param indexStart defines index start
  21740. * @param indexCount defines indices count
  21741. * @param mesh defines the parent mesh
  21742. * @param renderingMesh defines an optional rendering mesh
  21743. * @param createBoundingBox defines if bounding box should be created for this submesh
  21744. */
  21745. constructor(
  21746. /** the material index to use */
  21747. materialIndex: number,
  21748. /** vertex index start */
  21749. verticesStart: number,
  21750. /** vertices count */
  21751. verticesCount: number,
  21752. /** index start */
  21753. indexStart: number,
  21754. /** indices count */
  21755. indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean);
  21756. /**
  21757. * Returns true if this submesh covers the entire parent mesh
  21758. * @ignorenaming
  21759. */
  21760. readonly IsGlobal: boolean;
  21761. /**
  21762. * Returns the submesh BoudingInfo object
  21763. * @returns current bounding info (or mesh's one if the submesh is global)
  21764. */
  21765. getBoundingInfo(): BoundingInfo;
  21766. /**
  21767. * Sets the submesh BoundingInfo
  21768. * @param boundingInfo defines the new bounding info to use
  21769. * @returns the SubMesh
  21770. */
  21771. setBoundingInfo(boundingInfo: BoundingInfo): SubMesh;
  21772. /**
  21773. * Returns the mesh of the current submesh
  21774. * @return the parent mesh
  21775. */
  21776. getMesh(): AbstractMesh;
  21777. /**
  21778. * Returns the rendering mesh of the submesh
  21779. * @returns the rendering mesh (could be different from parent mesh)
  21780. */
  21781. getRenderingMesh(): Mesh;
  21782. /**
  21783. * Returns the submesh material
  21784. * @returns null or the current material
  21785. */
  21786. getMaterial(): Nullable<Material>;
  21787. /**
  21788. * Sets a new updated BoundingInfo object to the submesh
  21789. * @param data defines an optional position array to use to determine the bounding info
  21790. * @returns the SubMesh
  21791. */
  21792. refreshBoundingInfo(data?: Nullable<FloatArray>): SubMesh;
  21793. /** @hidden */
  21794. _checkCollision(collider: Collider): boolean;
  21795. /**
  21796. * Updates the submesh BoundingInfo
  21797. * @param world defines the world matrix to use to update the bounding info
  21798. * @returns the submesh
  21799. */
  21800. updateBoundingInfo(world: DeepImmutable<Matrix>): SubMesh;
  21801. /**
  21802. * True is the submesh bounding box intersects the frustum defined by the passed array of planes.
  21803. * @param frustumPlanes defines the frustum planes
  21804. * @returns true if the submesh is intersecting with the frustum
  21805. */
  21806. isInFrustum(frustumPlanes: Plane[]): boolean;
  21807. /**
  21808. * True is the submesh bounding box is completely inside the frustum defined by the passed array of planes
  21809. * @param frustumPlanes defines the frustum planes
  21810. * @returns true if the submesh is inside the frustum
  21811. */
  21812. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  21813. /**
  21814. * Renders the submesh
  21815. * @param enableAlphaMode defines if alpha needs to be used
  21816. * @returns the submesh
  21817. */
  21818. render(enableAlphaMode: boolean): SubMesh;
  21819. /**
  21820. * @hidden
  21821. */
  21822. _getLinesIndexBuffer(indices: IndicesArray, engine: Engine): DataBuffer;
  21823. /**
  21824. * Checks if the submesh intersects with a ray
  21825. * @param ray defines the ray to test
  21826. * @returns true is the passed ray intersects the submesh bounding box
  21827. */
  21828. canIntersects(ray: Ray): boolean;
  21829. /**
  21830. * Intersects current submesh with a ray
  21831. * @param ray defines the ray to test
  21832. * @param positions defines mesh's positions array
  21833. * @param indices defines mesh's indices array
  21834. * @param fastCheck defines if only bounding info should be used
  21835. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  21836. * @returns intersection info or null if no intersection
  21837. */
  21838. intersects(ray: Ray, positions: Vector3[], indices: IndicesArray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<IntersectionInfo>;
  21839. /** @hidden */
  21840. private _intersectLines;
  21841. /** @hidden */
  21842. private _intersectUnIndexedLines;
  21843. /** @hidden */
  21844. private _intersectTriangles;
  21845. /** @hidden */
  21846. private _intersectUnIndexedTriangles;
  21847. /** @hidden */
  21848. _rebuild(): void;
  21849. /**
  21850. * Creates a new submesh from the passed mesh
  21851. * @param newMesh defines the new hosting mesh
  21852. * @param newRenderingMesh defines an optional rendering mesh
  21853. * @returns the new submesh
  21854. */
  21855. clone(newMesh: AbstractMesh, newRenderingMesh?: Mesh): SubMesh;
  21856. /**
  21857. * Release associated resources
  21858. */
  21859. dispose(): void;
  21860. /**
  21861. * Gets the class name
  21862. * @returns the string "SubMesh".
  21863. */
  21864. getClassName(): string;
  21865. /**
  21866. * Creates a new submesh from indices data
  21867. * @param materialIndex the index of the main mesh material
  21868. * @param startIndex the index where to start the copy in the mesh indices array
  21869. * @param indexCount the number of indices to copy then from the startIndex
  21870. * @param mesh the main mesh to create the submesh from
  21871. * @param renderingMesh the optional rendering mesh
  21872. * @returns a new submesh
  21873. */
  21874. static CreateFromIndices(materialIndex: number, startIndex: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh): SubMesh;
  21875. }
  21876. }
  21877. declare module "babylonjs/Loading/sceneLoaderFlags" {
  21878. /**
  21879. * Class used to represent data loading progression
  21880. */
  21881. export class SceneLoaderFlags {
  21882. private static _ForceFullSceneLoadingForIncremental;
  21883. private static _ShowLoadingScreen;
  21884. private static _CleanBoneMatrixWeights;
  21885. private static _loggingLevel;
  21886. /**
  21887. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  21888. */
  21889. static ForceFullSceneLoadingForIncremental: boolean;
  21890. /**
  21891. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  21892. */
  21893. static ShowLoadingScreen: boolean;
  21894. /**
  21895. * Defines the current logging level (while loading the scene)
  21896. * @ignorenaming
  21897. */
  21898. static loggingLevel: number;
  21899. /**
  21900. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  21901. */
  21902. static CleanBoneMatrixWeights: boolean;
  21903. }
  21904. }
  21905. declare module "babylonjs/Meshes/geometry" {
  21906. import { Nullable, FloatArray, DataArray, IndicesArray } from "babylonjs/types";
  21907. import { Scene } from "babylonjs/scene";
  21908. import { Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  21909. import { Engine } from "babylonjs/Engines/engine";
  21910. import { IGetSetVerticesData, VertexData } from "babylonjs/Meshes/mesh.vertexData";
  21911. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  21912. import { Effect } from "babylonjs/Materials/effect";
  21913. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  21914. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  21915. import { Mesh } from "babylonjs/Meshes/mesh";
  21916. /**
  21917. * Class used to store geometry data (vertex buffers + index buffer)
  21918. */
  21919. export class Geometry implements IGetSetVerticesData {
  21920. /**
  21921. * Gets or sets the ID of the geometry
  21922. */
  21923. id: string;
  21924. /**
  21925. * Gets or sets the unique ID of the geometry
  21926. */
  21927. uniqueId: number;
  21928. /**
  21929. * Gets the delay loading state of the geometry (none by default which means not delayed)
  21930. */
  21931. delayLoadState: number;
  21932. /**
  21933. * Gets the file containing the data to load when running in delay load state
  21934. */
  21935. delayLoadingFile: Nullable<string>;
  21936. /**
  21937. * Callback called when the geometry is updated
  21938. */
  21939. onGeometryUpdated: (geometry: Geometry, kind?: string) => void;
  21940. private _scene;
  21941. private _engine;
  21942. private _meshes;
  21943. private _totalVertices;
  21944. /** @hidden */
  21945. _indices: IndicesArray;
  21946. /** @hidden */
  21947. _vertexBuffers: {
  21948. [key: string]: VertexBuffer;
  21949. };
  21950. private _isDisposed;
  21951. private _extend;
  21952. private _boundingBias;
  21953. /** @hidden */
  21954. _delayInfo: Array<string>;
  21955. private _indexBuffer;
  21956. private _indexBufferIsUpdatable;
  21957. /** @hidden */
  21958. _boundingInfo: Nullable<BoundingInfo>;
  21959. /** @hidden */
  21960. _delayLoadingFunction: Nullable<(any: any, geometry: Geometry) => void>;
  21961. /** @hidden */
  21962. _softwareSkinningFrameId: number;
  21963. private _vertexArrayObjects;
  21964. private _updatable;
  21965. /** @hidden */
  21966. _positions: Nullable<Vector3[]>;
  21967. /**
  21968. * 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
  21969. */
  21970. /**
  21971. * 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
  21972. */
  21973. boundingBias: Vector2;
  21974. /**
  21975. * Static function used to attach a new empty geometry to a mesh
  21976. * @param mesh defines the mesh to attach the geometry to
  21977. * @returns the new Geometry
  21978. */
  21979. static CreateGeometryForMesh(mesh: Mesh): Geometry;
  21980. /**
  21981. * Creates a new geometry
  21982. * @param id defines the unique ID
  21983. * @param scene defines the hosting scene
  21984. * @param vertexData defines the VertexData used to get geometry data
  21985. * @param updatable defines if geometry must be updatable (false by default)
  21986. * @param mesh defines the mesh that will be associated with the geometry
  21987. */
  21988. constructor(id: string, scene: Scene, vertexData?: VertexData, updatable?: boolean, mesh?: Nullable<Mesh>);
  21989. /**
  21990. * Gets the current extend of the geometry
  21991. */
  21992. readonly extend: {
  21993. minimum: Vector3;
  21994. maximum: Vector3;
  21995. };
  21996. /**
  21997. * Gets the hosting scene
  21998. * @returns the hosting Scene
  21999. */
  22000. getScene(): Scene;
  22001. /**
  22002. * Gets the hosting engine
  22003. * @returns the hosting Engine
  22004. */
  22005. getEngine(): Engine;
  22006. /**
  22007. * Defines if the geometry is ready to use
  22008. * @returns true if the geometry is ready to be used
  22009. */
  22010. isReady(): boolean;
  22011. /**
  22012. * Gets a value indicating that the geometry should not be serialized
  22013. */
  22014. readonly doNotSerialize: boolean;
  22015. /** @hidden */
  22016. _rebuild(): void;
  22017. /**
  22018. * Affects all geometry data in one call
  22019. * @param vertexData defines the geometry data
  22020. * @param updatable defines if the geometry must be flagged as updatable (false as default)
  22021. */
  22022. setAllVerticesData(vertexData: VertexData, updatable?: boolean): void;
  22023. /**
  22024. * Set specific vertex data
  22025. * @param kind defines the data kind (Position, normal, etc...)
  22026. * @param data defines the vertex data to use
  22027. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  22028. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  22029. */
  22030. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): void;
  22031. /**
  22032. * Removes a specific vertex data
  22033. * @param kind defines the data kind (Position, normal, etc...)
  22034. */
  22035. removeVerticesData(kind: string): void;
  22036. /**
  22037. * Affect a vertex buffer to the geometry. the vertexBuffer.getKind() function is used to determine where to store the data
  22038. * @param buffer defines the vertex buffer to use
  22039. * @param totalVertices defines the total number of vertices for position kind (could be null)
  22040. */
  22041. setVerticesBuffer(buffer: VertexBuffer, totalVertices?: Nullable<number>): void;
  22042. /**
  22043. * Update a specific vertex buffer
  22044. * This function will directly update the underlying DataBuffer according to the passed numeric array or Float32Array
  22045. * It will do nothing if the buffer is not updatable
  22046. * @param kind defines the data kind (Position, normal, etc...)
  22047. * @param data defines the data to use
  22048. * @param offset defines the offset in the target buffer where to store the data
  22049. * @param useBytes set to true if the offset is in bytes
  22050. */
  22051. updateVerticesDataDirectly(kind: string, data: DataArray, offset: number, useBytes?: boolean): void;
  22052. /**
  22053. * Update a specific vertex buffer
  22054. * This function will create a new buffer if the current one is not updatable
  22055. * @param kind defines the data kind (Position, normal, etc...)
  22056. * @param data defines the data to use
  22057. * @param updateExtends defines if the geometry extends must be recomputed (false by default)
  22058. */
  22059. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean): void;
  22060. private _updateBoundingInfo;
  22061. /** @hidden */
  22062. _bind(effect: Nullable<Effect>, indexToBind?: Nullable<DataBuffer>): void;
  22063. /**
  22064. * Gets total number of vertices
  22065. * @returns the total number of vertices
  22066. */
  22067. getTotalVertices(): number;
  22068. /**
  22069. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  22070. * @param kind defines the data kind (Position, normal, etc...)
  22071. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  22072. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  22073. * @returns a float array containing vertex data
  22074. */
  22075. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  22076. /**
  22077. * Returns a boolean defining if the vertex data for the requested `kind` is updatable
  22078. * @param kind defines the data kind (Position, normal, etc...)
  22079. * @returns true if the vertex buffer with the specified kind is updatable
  22080. */
  22081. isVertexBufferUpdatable(kind: string): boolean;
  22082. /**
  22083. * Gets a specific vertex buffer
  22084. * @param kind defines the data kind (Position, normal, etc...)
  22085. * @returns a VertexBuffer
  22086. */
  22087. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  22088. /**
  22089. * Returns all vertex buffers
  22090. * @return an object holding all vertex buffers indexed by kind
  22091. */
  22092. getVertexBuffers(): Nullable<{
  22093. [key: string]: VertexBuffer;
  22094. }>;
  22095. /**
  22096. * Gets a boolean indicating if specific vertex buffer is present
  22097. * @param kind defines the data kind (Position, normal, etc...)
  22098. * @returns true if data is present
  22099. */
  22100. isVerticesDataPresent(kind: string): boolean;
  22101. /**
  22102. * Gets a list of all attached data kinds (Position, normal, etc...)
  22103. * @returns a list of string containing all kinds
  22104. */
  22105. getVerticesDataKinds(): string[];
  22106. /**
  22107. * Update index buffer
  22108. * @param indices defines the indices to store in the index buffer
  22109. * @param offset defines the offset in the target buffer where to store the data
  22110. * @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)
  22111. */
  22112. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): void;
  22113. /**
  22114. * Creates a new index buffer
  22115. * @param indices defines the indices to store in the index buffer
  22116. * @param totalVertices defines the total number of vertices (could be null)
  22117. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  22118. */
  22119. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): void;
  22120. /**
  22121. * Return the total number of indices
  22122. * @returns the total number of indices
  22123. */
  22124. getTotalIndices(): number;
  22125. /**
  22126. * Gets the index buffer array
  22127. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  22128. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  22129. * @returns the index buffer array
  22130. */
  22131. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  22132. /**
  22133. * Gets the index buffer
  22134. * @return the index buffer
  22135. */
  22136. getIndexBuffer(): Nullable<DataBuffer>;
  22137. /** @hidden */
  22138. _releaseVertexArrayObject(effect?: Nullable<Effect>): void;
  22139. /**
  22140. * Release the associated resources for a specific mesh
  22141. * @param mesh defines the source mesh
  22142. * @param shouldDispose defines if the geometry must be disposed if there is no more mesh pointing to it
  22143. */
  22144. releaseForMesh(mesh: Mesh, shouldDispose?: boolean): void;
  22145. /**
  22146. * Apply current geometry to a given mesh
  22147. * @param mesh defines the mesh to apply geometry to
  22148. */
  22149. applyToMesh(mesh: Mesh): void;
  22150. private _updateExtend;
  22151. private _applyToMesh;
  22152. private notifyUpdate;
  22153. /**
  22154. * Load the geometry if it was flagged as delay loaded
  22155. * @param scene defines the hosting scene
  22156. * @param onLoaded defines a callback called when the geometry is loaded
  22157. */
  22158. load(scene: Scene, onLoaded?: () => void): void;
  22159. private _queueLoad;
  22160. /**
  22161. * Invert the geometry to move from a right handed system to a left handed one.
  22162. */
  22163. toLeftHanded(): void;
  22164. /** @hidden */
  22165. _resetPointsArrayCache(): void;
  22166. /** @hidden */
  22167. _generatePointsArray(): boolean;
  22168. /**
  22169. * Gets a value indicating if the geometry is disposed
  22170. * @returns true if the geometry was disposed
  22171. */
  22172. isDisposed(): boolean;
  22173. private _disposeVertexArrayObjects;
  22174. /**
  22175. * Free all associated resources
  22176. */
  22177. dispose(): void;
  22178. /**
  22179. * Clone the current geometry into a new geometry
  22180. * @param id defines the unique ID of the new geometry
  22181. * @returns a new geometry object
  22182. */
  22183. copy(id: string): Geometry;
  22184. /**
  22185. * Serialize the current geometry info (and not the vertices data) into a JSON object
  22186. * @return a JSON representation of the current geometry data (without the vertices data)
  22187. */
  22188. serialize(): any;
  22189. private toNumberArray;
  22190. /**
  22191. * Serialize all vertices data into a JSON oject
  22192. * @returns a JSON representation of the current geometry data
  22193. */
  22194. serializeVerticeData(): any;
  22195. /**
  22196. * Extracts a clone of a mesh geometry
  22197. * @param mesh defines the source mesh
  22198. * @param id defines the unique ID of the new geometry object
  22199. * @returns the new geometry object
  22200. */
  22201. static ExtractFromMesh(mesh: Mesh, id: string): Nullable<Geometry>;
  22202. /**
  22203. * You should now use Tools.RandomId(), this method is still here for legacy reasons.
  22204. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  22205. * Be aware Math.random() could cause collisions, but:
  22206. * "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"
  22207. * @returns a string containing a new GUID
  22208. */
  22209. static RandomId(): string;
  22210. /** @hidden */
  22211. static _ImportGeometry(parsedGeometry: any, mesh: Mesh): void;
  22212. private static _CleanMatricesWeights;
  22213. /**
  22214. * Create a new geometry from persisted data (Using .babylon file format)
  22215. * @param parsedVertexData defines the persisted data
  22216. * @param scene defines the hosting scene
  22217. * @param rootUrl defines the root url to use to load assets (like delayed data)
  22218. * @returns the new geometry object
  22219. */
  22220. static Parse(parsedVertexData: any, scene: Scene, rootUrl: string): Nullable<Geometry>;
  22221. }
  22222. }
  22223. declare module "babylonjs/Meshes/mesh.vertexData" {
  22224. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  22225. import { Matrix, Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  22226. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  22227. import { Geometry } from "babylonjs/Meshes/geometry";
  22228. import { Mesh } from "babylonjs/Meshes/mesh";
  22229. /**
  22230. * Define an interface for all classes that will get and set the data on vertices
  22231. */
  22232. export interface IGetSetVerticesData {
  22233. /**
  22234. * Gets a boolean indicating if specific vertex data is present
  22235. * @param kind defines the vertex data kind to use
  22236. * @returns true is data kind is present
  22237. */
  22238. isVerticesDataPresent(kind: string): boolean;
  22239. /**
  22240. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  22241. * @param kind defines the data kind (Position, normal, etc...)
  22242. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  22243. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  22244. * @returns a float array containing vertex data
  22245. */
  22246. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  22247. /**
  22248. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  22249. * @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.
  22250. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  22251. * @returns the indices array or an empty array if the mesh has no geometry
  22252. */
  22253. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  22254. /**
  22255. * Set specific vertex data
  22256. * @param kind defines the data kind (Position, normal, etc...)
  22257. * @param data defines the vertex data to use
  22258. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  22259. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  22260. */
  22261. setVerticesData(kind: string, data: FloatArray, updatable: boolean): void;
  22262. /**
  22263. * Update a specific associated vertex buffer
  22264. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  22265. * - VertexBuffer.PositionKind
  22266. * - VertexBuffer.UVKind
  22267. * - VertexBuffer.UV2Kind
  22268. * - VertexBuffer.UV3Kind
  22269. * - VertexBuffer.UV4Kind
  22270. * - VertexBuffer.UV5Kind
  22271. * - VertexBuffer.UV6Kind
  22272. * - VertexBuffer.ColorKind
  22273. * - VertexBuffer.MatricesIndicesKind
  22274. * - VertexBuffer.MatricesIndicesExtraKind
  22275. * - VertexBuffer.MatricesWeightsKind
  22276. * - VertexBuffer.MatricesWeightsExtraKind
  22277. * @param data defines the data source
  22278. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  22279. * @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)
  22280. */
  22281. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): void;
  22282. /**
  22283. * Creates a new index buffer
  22284. * @param indices defines the indices to store in the index buffer
  22285. * @param totalVertices defines the total number of vertices (could be null)
  22286. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  22287. */
  22288. setIndices(indices: IndicesArray, totalVertices: Nullable<number>, updatable?: boolean): void;
  22289. }
  22290. /**
  22291. * This class contains the various kinds of data on every vertex of a mesh used in determining its shape and appearance
  22292. */
  22293. export class VertexData {
  22294. /**
  22295. * Mesh side orientation : usually the external or front surface
  22296. */
  22297. static readonly FRONTSIDE: number;
  22298. /**
  22299. * Mesh side orientation : usually the internal or back surface
  22300. */
  22301. static readonly BACKSIDE: number;
  22302. /**
  22303. * Mesh side orientation : both internal and external or front and back surfaces
  22304. */
  22305. static readonly DOUBLESIDE: number;
  22306. /**
  22307. * Mesh side orientation : by default, `FRONTSIDE`
  22308. */
  22309. static readonly DEFAULTSIDE: number;
  22310. /**
  22311. * An array of the x, y, z position of each vertex [...., x, y, z, .....]
  22312. */
  22313. positions: Nullable<FloatArray>;
  22314. /**
  22315. * An array of the x, y, z normal vector of each vertex [...., x, y, z, .....]
  22316. */
  22317. normals: Nullable<FloatArray>;
  22318. /**
  22319. * An array of the x, y, z tangent vector of each vertex [...., x, y, z, .....]
  22320. */
  22321. tangents: Nullable<FloatArray>;
  22322. /**
  22323. * An array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  22324. */
  22325. uvs: Nullable<FloatArray>;
  22326. /**
  22327. * A second array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  22328. */
  22329. uvs2: Nullable<FloatArray>;
  22330. /**
  22331. * A third array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  22332. */
  22333. uvs3: Nullable<FloatArray>;
  22334. /**
  22335. * A fourth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  22336. */
  22337. uvs4: Nullable<FloatArray>;
  22338. /**
  22339. * A fifth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  22340. */
  22341. uvs5: Nullable<FloatArray>;
  22342. /**
  22343. * A sixth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  22344. */
  22345. uvs6: Nullable<FloatArray>;
  22346. /**
  22347. * An array of the r, g, b, a, color of each vertex [...., r, g, b, a, .....]
  22348. */
  22349. colors: Nullable<FloatArray>;
  22350. /**
  22351. * 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).
  22352. */
  22353. matricesIndices: Nullable<FloatArray>;
  22354. /**
  22355. * An array containing the list of weights defining the weight of each indexed matrix in the final computation
  22356. */
  22357. matricesWeights: Nullable<FloatArray>;
  22358. /**
  22359. * An array extending the number of possible indices
  22360. */
  22361. matricesIndicesExtra: Nullable<FloatArray>;
  22362. /**
  22363. * An array extending the number of possible weights when the number of indices is extended
  22364. */
  22365. matricesWeightsExtra: Nullable<FloatArray>;
  22366. /**
  22367. * An array of i, j, k the three vertex indices required for each triangular facet [...., i, j, k .....]
  22368. */
  22369. indices: Nullable<IndicesArray>;
  22370. /**
  22371. * Uses the passed data array to set the set the values for the specified kind of data
  22372. * @param data a linear array of floating numbers
  22373. * @param kind the type of data that is being set, eg positions, colors etc
  22374. */
  22375. set(data: FloatArray, kind: string): void;
  22376. /**
  22377. * Associates the vertexData to the passed Mesh.
  22378. * Sets it as updatable or not (default `false`)
  22379. * @param mesh the mesh the vertexData is applied to
  22380. * @param updatable when used and having the value true allows new data to update the vertexData
  22381. * @returns the VertexData
  22382. */
  22383. applyToMesh(mesh: Mesh, updatable?: boolean): VertexData;
  22384. /**
  22385. * Associates the vertexData to the passed Geometry.
  22386. * Sets it as updatable or not (default `false`)
  22387. * @param geometry the geometry the vertexData is applied to
  22388. * @param updatable when used and having the value true allows new data to update the vertexData
  22389. * @returns VertexData
  22390. */
  22391. applyToGeometry(geometry: Geometry, updatable?: boolean): VertexData;
  22392. /**
  22393. * Updates the associated mesh
  22394. * @param mesh the mesh to be updated
  22395. * @param updateExtends when true the mesh BoundingInfo will be renewed when and if position kind is updated, optional with default false
  22396. * @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
  22397. * @returns VertexData
  22398. */
  22399. updateMesh(mesh: Mesh): VertexData;
  22400. /**
  22401. * Updates the associated geometry
  22402. * @param geometry the geometry to be updated
  22403. * @param updateExtends when true BoundingInfo will be renewed when and if position kind is updated, optional with default false
  22404. * @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
  22405. * @returns VertexData.
  22406. */
  22407. updateGeometry(geometry: Geometry): VertexData;
  22408. private _applyTo;
  22409. private _update;
  22410. /**
  22411. * Transforms each position and each normal of the vertexData according to the passed Matrix
  22412. * @param matrix the transforming matrix
  22413. * @returns the VertexData
  22414. */
  22415. transform(matrix: Matrix): VertexData;
  22416. /**
  22417. * Merges the passed VertexData into the current one
  22418. * @param other the VertexData to be merged into the current one
  22419. * @param use32BitsIndices defines a boolean indicating if indices must be store in a 32 bits array
  22420. * @returns the modified VertexData
  22421. */
  22422. merge(other: VertexData, use32BitsIndices?: boolean): VertexData;
  22423. private _mergeElement;
  22424. private _validate;
  22425. /**
  22426. * Serializes the VertexData
  22427. * @returns a serialized object
  22428. */
  22429. serialize(): any;
  22430. /**
  22431. * Extracts the vertexData from a mesh
  22432. * @param mesh the mesh from which to extract the VertexData
  22433. * @param copyWhenShared defines if the VertexData must be cloned when shared between multiple meshes, optional, default false
  22434. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  22435. * @returns the object VertexData associated to the passed mesh
  22436. */
  22437. static ExtractFromMesh(mesh: Mesh, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  22438. /**
  22439. * Extracts the vertexData from the geometry
  22440. * @param geometry the geometry from which to extract the VertexData
  22441. * @param copyWhenShared defines if the VertexData must be cloned when the geometrty is shared between multiple meshes, optional, default false
  22442. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  22443. * @returns the object VertexData associated to the passed mesh
  22444. */
  22445. static ExtractFromGeometry(geometry: Geometry, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  22446. private static _ExtractFrom;
  22447. /**
  22448. * Creates the VertexData for a Ribbon
  22449. * @param options an object used to set the following optional parameters for the ribbon, required but can be empty
  22450. * * pathArray array of paths, each of which an array of successive Vector3
  22451. * * closeArray creates a seam between the first and the last paths of the pathArray, optional, default false
  22452. * * closePath creates a seam between the first and the last points of each path of the path array, optional, default false
  22453. * * 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
  22454. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22455. * * 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)
  22456. * * 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)
  22457. * * invertUV swaps in the U and V coordinates when applying a texture, optional, default false
  22458. * * uvs a linear array, of length 2 * number of vertices, of custom UV values, optional
  22459. * * colors a linear array, of length 4 * number of vertices, of custom color values, optional
  22460. * @returns the VertexData of the ribbon
  22461. */
  22462. static CreateRibbon(options: {
  22463. pathArray: Vector3[][];
  22464. closeArray?: boolean;
  22465. closePath?: boolean;
  22466. offset?: number;
  22467. sideOrientation?: number;
  22468. frontUVs?: Vector4;
  22469. backUVs?: Vector4;
  22470. invertUV?: boolean;
  22471. uvs?: Vector2[];
  22472. colors?: Color4[];
  22473. }): VertexData;
  22474. /**
  22475. * Creates the VertexData for a box
  22476. * @param options an object used to set the following optional parameters for the box, required but can be empty
  22477. * * size sets the width, height and depth of the box to the value of size, optional default 1
  22478. * * width sets the width (x direction) of the box, overwrites the width set by size, optional, default size
  22479. * * height sets the height (y direction) of the box, overwrites the height set by size, optional, default size
  22480. * * depth sets the depth (z direction) of the box, overwrites the depth set by size, optional, default size
  22481. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  22482. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  22483. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22484. * * 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)
  22485. * * 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)
  22486. * @returns the VertexData of the box
  22487. */
  22488. static CreateBox(options: {
  22489. size?: number;
  22490. width?: number;
  22491. height?: number;
  22492. depth?: number;
  22493. faceUV?: Vector4[];
  22494. faceColors?: Color4[];
  22495. sideOrientation?: number;
  22496. frontUVs?: Vector4;
  22497. backUVs?: Vector4;
  22498. }): VertexData;
  22499. /**
  22500. * Creates the VertexData for a tiled box
  22501. * @param options an object used to set the following optional parameters for the box, required but can be empty
  22502. * * faceTiles sets the pattern, tile size and number of tiles for a face
  22503. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  22504. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  22505. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22506. * @returns the VertexData of the box
  22507. */
  22508. static CreateTiledBox(options: {
  22509. pattern?: number;
  22510. width?: number;
  22511. height?: number;
  22512. depth?: number;
  22513. tileSize?: number;
  22514. tileWidth?: number;
  22515. tileHeight?: number;
  22516. alignHorizontal?: number;
  22517. alignVertical?: number;
  22518. faceUV?: Vector4[];
  22519. faceColors?: Color4[];
  22520. sideOrientation?: number;
  22521. }): VertexData;
  22522. /**
  22523. * Creates the VertexData for a tiled plane
  22524. * @param options an object used to set the following optional parameters for the box, required but can be empty
  22525. * * pattern a limited pattern arrangement depending on the number
  22526. * * tileSize sets the width, height and depth of the tile to the value of size, optional default 1
  22527. * * tileWidth sets the width (x direction) of the tile, overwrites the width set by size, optional, default size
  22528. * * tileHeight sets the height (y direction) of the tile, overwrites the height set by size, optional, default size
  22529. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22530. * * 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)
  22531. * * 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)
  22532. * @returns the VertexData of the tiled plane
  22533. */
  22534. static CreateTiledPlane(options: {
  22535. pattern?: number;
  22536. tileSize?: number;
  22537. tileWidth?: number;
  22538. tileHeight?: number;
  22539. size?: number;
  22540. width?: number;
  22541. height?: number;
  22542. alignHorizontal?: number;
  22543. alignVertical?: number;
  22544. sideOrientation?: number;
  22545. frontUVs?: Vector4;
  22546. backUVs?: Vector4;
  22547. }): VertexData;
  22548. /**
  22549. * Creates the VertexData for an ellipsoid, defaults to a sphere
  22550. * @param options an object used to set the following optional parameters for the box, required but can be empty
  22551. * * segments sets the number of horizontal strips optional, default 32
  22552. * * diameter sets the axes dimensions, diameterX, diameterY and diameterZ to the value of diameter, optional default 1
  22553. * * diameterX sets the diameterX (x direction) of the ellipsoid, overwrites the diameterX set by diameter, optional, default diameter
  22554. * * diameterY sets the diameterY (y direction) of the ellipsoid, overwrites the diameterY set by diameter, optional, default diameter
  22555. * * diameterZ sets the diameterZ (z direction) of the ellipsoid, overwrites the diameterZ set by diameter, optional, default diameter
  22556. * * 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
  22557. * * 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
  22558. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22559. * * 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)
  22560. * * 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)
  22561. * @returns the VertexData of the ellipsoid
  22562. */
  22563. static CreateSphere(options: {
  22564. segments?: number;
  22565. diameter?: number;
  22566. diameterX?: number;
  22567. diameterY?: number;
  22568. diameterZ?: number;
  22569. arc?: number;
  22570. slice?: number;
  22571. sideOrientation?: number;
  22572. frontUVs?: Vector4;
  22573. backUVs?: Vector4;
  22574. }): VertexData;
  22575. /**
  22576. * Creates the VertexData for a cylinder, cone or prism
  22577. * @param options an object used to set the following optional parameters for the box, required but can be empty
  22578. * * height sets the height (y direction) of the cylinder, optional, default 2
  22579. * * diameterTop sets the diameter of the top of the cone, overwrites diameter, optional, default diameter
  22580. * * diameterBottom sets the diameter of the bottom of the cone, overwrites diameter, optional, default diameter
  22581. * * diameter sets the diameter of the top and bottom of the cone, optional default 1
  22582. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  22583. * * subdivisions` the number of rings along the cylinder height, optional, default 1
  22584. * * 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
  22585. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  22586. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  22587. * * hasRings when true makes each subdivision independantly treated as a face for faceUV and faceColors, optional, default false
  22588. * * enclose when true closes an open cylinder by adding extra flat faces between the height axis and vertical edges, think cut cake
  22589. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22590. * * 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)
  22591. * * 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)
  22592. * @returns the VertexData of the cylinder, cone or prism
  22593. */
  22594. static CreateCylinder(options: {
  22595. height?: number;
  22596. diameterTop?: number;
  22597. diameterBottom?: number;
  22598. diameter?: number;
  22599. tessellation?: number;
  22600. subdivisions?: number;
  22601. arc?: number;
  22602. faceColors?: Color4[];
  22603. faceUV?: Vector4[];
  22604. hasRings?: boolean;
  22605. enclose?: boolean;
  22606. sideOrientation?: number;
  22607. frontUVs?: Vector4;
  22608. backUVs?: Vector4;
  22609. }): VertexData;
  22610. /**
  22611. * Creates the VertexData for a torus
  22612. * @param options an object used to set the following optional parameters for the box, required but can be empty
  22613. * * diameter the diameter of the torus, optional default 1
  22614. * * thickness the diameter of the tube forming the torus, optional default 0.5
  22615. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  22616. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22617. * * 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. * * 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 torus
  22620. */
  22621. static CreateTorus(options: {
  22622. diameter?: number;
  22623. thickness?: number;
  22624. tessellation?: number;
  22625. sideOrientation?: number;
  22626. frontUVs?: Vector4;
  22627. backUVs?: Vector4;
  22628. }): VertexData;
  22629. /**
  22630. * Creates the VertexData of the LineSystem
  22631. * @param options an object used to set the following optional parameters for the LineSystem, required but can be empty
  22632. * - lines an array of lines, each line being an array of successive Vector3
  22633. * - colors an array of line colors, each of the line colors being an array of successive Color4, one per line point
  22634. * @returns the VertexData of the LineSystem
  22635. */
  22636. static CreateLineSystem(options: {
  22637. lines: Vector3[][];
  22638. colors?: Nullable<Color4[][]>;
  22639. }): VertexData;
  22640. /**
  22641. * Create the VertexData for a DashedLines
  22642. * @param options an object used to set the following optional parameters for the DashedLines, required but can be empty
  22643. * - points an array successive Vector3
  22644. * - dashSize the size of the dashes relative to the dash number, optional, default 3
  22645. * - gapSize the size of the gap between two successive dashes relative to the dash number, optional, default 1
  22646. * - dashNb the intended total number of dashes, optional, default 200
  22647. * @returns the VertexData for the DashedLines
  22648. */
  22649. static CreateDashedLines(options: {
  22650. points: Vector3[];
  22651. dashSize?: number;
  22652. gapSize?: number;
  22653. dashNb?: number;
  22654. }): VertexData;
  22655. /**
  22656. * Creates the VertexData for a Ground
  22657. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  22658. * - width the width (x direction) of the ground, optional, default 1
  22659. * - height the height (z direction) of the ground, optional, default 1
  22660. * - subdivisions the number of subdivisions per side, optional, default 1
  22661. * @returns the VertexData of the Ground
  22662. */
  22663. static CreateGround(options: {
  22664. width?: number;
  22665. height?: number;
  22666. subdivisions?: number;
  22667. subdivisionsX?: number;
  22668. subdivisionsY?: number;
  22669. }): VertexData;
  22670. /**
  22671. * Creates the VertexData for a TiledGround by subdividing the ground into tiles
  22672. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  22673. * * xmin the ground minimum X coordinate, optional, default -1
  22674. * * zmin the ground minimum Z coordinate, optional, default -1
  22675. * * xmax the ground maximum X coordinate, optional, default 1
  22676. * * zmax the ground maximum Z coordinate, optional, default 1
  22677. * * 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}
  22678. * * 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}
  22679. * @returns the VertexData of the TiledGround
  22680. */
  22681. static CreateTiledGround(options: {
  22682. xmin: number;
  22683. zmin: number;
  22684. xmax: number;
  22685. zmax: number;
  22686. subdivisions?: {
  22687. w: number;
  22688. h: number;
  22689. };
  22690. precision?: {
  22691. w: number;
  22692. h: number;
  22693. };
  22694. }): VertexData;
  22695. /**
  22696. * Creates the VertexData of the Ground designed from a heightmap
  22697. * @param options an object used to set the following parameters for the Ground, required and provided by MeshBuilder.CreateGroundFromHeightMap
  22698. * * width the width (x direction) of the ground
  22699. * * height the height (z direction) of the ground
  22700. * * subdivisions the number of subdivisions per side
  22701. * * minHeight the minimum altitude on the ground, optional, default 0
  22702. * * maxHeight the maximum altitude on the ground, optional default 1
  22703. * * colorFilter the filter to apply to the image pixel colors to compute the height, optional Color3, default (0.3, 0.59, 0.11)
  22704. * * buffer the array holding the image color data
  22705. * * bufferWidth the width of image
  22706. * * bufferHeight the height of image
  22707. * * alphaFilter Remove any data where the alpha channel is below this value, defaults 0 (all data visible)
  22708. * @returns the VertexData of the Ground designed from a heightmap
  22709. */
  22710. static CreateGroundFromHeightMap(options: {
  22711. width: number;
  22712. height: number;
  22713. subdivisions: number;
  22714. minHeight: number;
  22715. maxHeight: number;
  22716. colorFilter: Color3;
  22717. buffer: Uint8Array;
  22718. bufferWidth: number;
  22719. bufferHeight: number;
  22720. alphaFilter: number;
  22721. }): VertexData;
  22722. /**
  22723. * Creates the VertexData for a Plane
  22724. * @param options an object used to set the following optional parameters for the plane, required but can be empty
  22725. * * size sets the width and height of the plane to the value of size, optional default 1
  22726. * * width sets the width (x direction) of the plane, overwrites the width set by size, optional, default size
  22727. * * height sets the height (y direction) of the plane, overwrites the height set by size, optional, default size
  22728. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22729. * * 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)
  22730. * * 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)
  22731. * @returns the VertexData of the box
  22732. */
  22733. static CreatePlane(options: {
  22734. size?: number;
  22735. width?: number;
  22736. height?: number;
  22737. sideOrientation?: number;
  22738. frontUVs?: Vector4;
  22739. backUVs?: Vector4;
  22740. }): VertexData;
  22741. /**
  22742. * Creates the VertexData of the Disc or regular Polygon
  22743. * @param options an object used to set the following optional parameters for the disc, required but can be empty
  22744. * * radius the radius of the disc, optional default 0.5
  22745. * * tessellation the number of polygon sides, optional, default 64
  22746. * * 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
  22747. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22748. * * 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)
  22749. * * 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)
  22750. * @returns the VertexData of the box
  22751. */
  22752. static CreateDisc(options: {
  22753. radius?: number;
  22754. tessellation?: number;
  22755. arc?: number;
  22756. sideOrientation?: number;
  22757. frontUVs?: Vector4;
  22758. backUVs?: Vector4;
  22759. }): VertexData;
  22760. /**
  22761. * Creates the VertexData for an irregular Polygon in the XoZ plane using a mesh built by polygonTriangulation.build()
  22762. * All parameters are provided by MeshBuilder.CreatePolygon as needed
  22763. * @param polygon a mesh built from polygonTriangulation.build()
  22764. * @param sideOrientation takes the values Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22765. * @param fUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  22766. * @param fColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  22767. * @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)
  22768. * @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)
  22769. * @returns the VertexData of the Polygon
  22770. */
  22771. static CreatePolygon(polygon: Mesh, sideOrientation: number, fUV?: Vector4[], fColors?: Color4[], frontUVs?: Vector4, backUVs?: Vector4): VertexData;
  22772. /**
  22773. * Creates the VertexData of the IcoSphere
  22774. * @param options an object used to set the following optional parameters for the IcoSphere, required but can be empty
  22775. * * radius the radius of the IcoSphere, optional default 1
  22776. * * radiusX allows stretching in the x direction, optional, default radius
  22777. * * radiusY allows stretching in the y direction, optional, default radius
  22778. * * radiusZ allows stretching in the z direction, optional, default radius
  22779. * * flat when true creates a flat shaded mesh, optional, default true
  22780. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  22781. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22782. * * 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)
  22783. * * 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)
  22784. * @returns the VertexData of the IcoSphere
  22785. */
  22786. static CreateIcoSphere(options: {
  22787. radius?: number;
  22788. radiusX?: number;
  22789. radiusY?: number;
  22790. radiusZ?: number;
  22791. flat?: boolean;
  22792. subdivisions?: number;
  22793. sideOrientation?: number;
  22794. frontUVs?: Vector4;
  22795. backUVs?: Vector4;
  22796. }): VertexData;
  22797. /**
  22798. * Creates the VertexData for a Polyhedron
  22799. * @param options an object used to set the following optional parameters for the polyhedron, required but can be empty
  22800. * * type provided types are:
  22801. * * 0 : Tetrahedron, 1 : Octahedron, 2 : Dodecahedron, 3 : Icosahedron, 4 : Rhombicuboctahedron, 5 : Triangular Prism, 6 : Pentagonal Prism, 7 : Hexagonal Prism, 8 : Square Pyramid (J1)
  22802. * * 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)
  22803. * * size the size of the IcoSphere, optional default 1
  22804. * * sizeX allows stretching in the x direction, optional, default size
  22805. * * sizeY allows stretching in the y direction, optional, default size
  22806. * * sizeZ allows stretching in the z direction, optional, default size
  22807. * * 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
  22808. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  22809. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  22810. * * flat when true creates a flat shaded mesh, optional, default true
  22811. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  22812. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22813. * * 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)
  22814. * * 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)
  22815. * @returns the VertexData of the Polyhedron
  22816. */
  22817. static CreatePolyhedron(options: {
  22818. type?: number;
  22819. size?: number;
  22820. sizeX?: number;
  22821. sizeY?: number;
  22822. sizeZ?: number;
  22823. custom?: any;
  22824. faceUV?: Vector4[];
  22825. faceColors?: Color4[];
  22826. flat?: boolean;
  22827. sideOrientation?: number;
  22828. frontUVs?: Vector4;
  22829. backUVs?: Vector4;
  22830. }): VertexData;
  22831. /**
  22832. * Creates the VertexData for a TorusKnot
  22833. * @param options an object used to set the following optional parameters for the TorusKnot, required but can be empty
  22834. * * radius the radius of the torus knot, optional, default 2
  22835. * * tube the thickness of the tube, optional, default 0.5
  22836. * * radialSegments the number of sides on each tube segments, optional, default 32
  22837. * * tubularSegments the number of tubes to decompose the knot into, optional, default 32
  22838. * * p the number of windings around the z axis, optional, default 2
  22839. * * q the number of windings around the x axis, optional, default 3
  22840. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  22841. * * 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)
  22842. * * 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)
  22843. * @returns the VertexData of the Torus Knot
  22844. */
  22845. static CreateTorusKnot(options: {
  22846. radius?: number;
  22847. tube?: number;
  22848. radialSegments?: number;
  22849. tubularSegments?: number;
  22850. p?: number;
  22851. q?: number;
  22852. sideOrientation?: number;
  22853. frontUVs?: Vector4;
  22854. backUVs?: Vector4;
  22855. }): VertexData;
  22856. /**
  22857. * Compute normals for given positions and indices
  22858. * @param positions an array of vertex positions, [...., x, y, z, ......]
  22859. * @param indices an array of indices in groups of three for each triangular facet, [...., i, j, k, ......]
  22860. * @param normals an array of vertex normals, [...., x, y, z, ......]
  22861. * @param options an object used to set the following optional parameters for the TorusKnot, optional
  22862. * * facetNormals : optional array of facet normals (vector3)
  22863. * * facetPositions : optional array of facet positions (vector3)
  22864. * * facetPartitioning : optional partitioning array. facetPositions is required for facetPartitioning computation
  22865. * * ratio : optional partitioning ratio / bounding box, required for facetPartitioning computation
  22866. * * bInfo : optional bounding info, required for facetPartitioning computation
  22867. * * bbSize : optional bounding box size data, required for facetPartitioning computation
  22868. * * subDiv : optional partitioning data about subdivsions on each axis (int), required for facetPartitioning computation
  22869. * * useRightHandedSystem: optional boolean to for right handed system computation
  22870. * * depthSort : optional boolean to enable the facet depth sort computation
  22871. * * distanceTo : optional Vector3 to compute the facet depth from this location
  22872. * * depthSortedFacets : optional array of depthSortedFacets to store the facet distances from the reference location
  22873. */
  22874. static ComputeNormals(positions: any, indices: any, normals: any, options?: {
  22875. facetNormals?: any;
  22876. facetPositions?: any;
  22877. facetPartitioning?: any;
  22878. ratio?: number;
  22879. bInfo?: any;
  22880. bbSize?: Vector3;
  22881. subDiv?: any;
  22882. useRightHandedSystem?: boolean;
  22883. depthSort?: boolean;
  22884. distanceTo?: Vector3;
  22885. depthSortedFacets?: any;
  22886. }): void;
  22887. /** @hidden */
  22888. static _ComputeSides(sideOrientation: number, positions: FloatArray, indices: FloatArray, normals: FloatArray, uvs: FloatArray, frontUVs?: Vector4, backUVs?: Vector4): void;
  22889. /**
  22890. * Applies VertexData created from the imported parameters to the geometry
  22891. * @param parsedVertexData the parsed data from an imported file
  22892. * @param geometry the geometry to apply the VertexData to
  22893. */
  22894. static ImportVertexData(parsedVertexData: any, geometry: Geometry): void;
  22895. }
  22896. }
  22897. declare module "babylonjs/Morph/morphTarget" {
  22898. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  22899. import { Observable } from "babylonjs/Misc/observable";
  22900. import { Nullable, FloatArray } from "babylonjs/types";
  22901. import { Scene } from "babylonjs/scene";
  22902. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  22903. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  22904. /**
  22905. * Defines a target to use with MorphTargetManager
  22906. * @see http://doc.babylonjs.com/how_to/how_to_use_morphtargets
  22907. */
  22908. export class MorphTarget implements IAnimatable {
  22909. /** defines the name of the target */
  22910. name: string;
  22911. /**
  22912. * Gets or sets the list of animations
  22913. */
  22914. animations: import("babylonjs/Animations/animation").Animation[];
  22915. private _scene;
  22916. private _positions;
  22917. private _normals;
  22918. private _tangents;
  22919. private _uvs;
  22920. private _influence;
  22921. private _uniqueId;
  22922. /**
  22923. * Observable raised when the influence changes
  22924. */
  22925. onInfluenceChanged: Observable<boolean>;
  22926. /** @hidden */
  22927. _onDataLayoutChanged: Observable<void>;
  22928. /**
  22929. * Gets or sets the influence of this target (ie. its weight in the overall morphing)
  22930. */
  22931. influence: number;
  22932. /**
  22933. * Gets or sets the id of the morph Target
  22934. */
  22935. id: string;
  22936. private _animationPropertiesOverride;
  22937. /**
  22938. * Gets or sets the animation properties override
  22939. */
  22940. animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  22941. /**
  22942. * Creates a new MorphTarget
  22943. * @param name defines the name of the target
  22944. * @param influence defines the influence to use
  22945. * @param scene defines the scene the morphtarget belongs to
  22946. */
  22947. constructor(
  22948. /** defines the name of the target */
  22949. name: string, influence?: number, scene?: Nullable<Scene>);
  22950. /**
  22951. * Gets the unique ID of this manager
  22952. */
  22953. readonly uniqueId: number;
  22954. /**
  22955. * Gets a boolean defining if the target contains position data
  22956. */
  22957. readonly hasPositions: boolean;
  22958. /**
  22959. * Gets a boolean defining if the target contains normal data
  22960. */
  22961. readonly hasNormals: boolean;
  22962. /**
  22963. * Gets a boolean defining if the target contains tangent data
  22964. */
  22965. readonly hasTangents: boolean;
  22966. /**
  22967. * Gets a boolean defining if the target contains texture coordinates data
  22968. */
  22969. readonly hasUVs: boolean;
  22970. /**
  22971. * Affects position data to this target
  22972. * @param data defines the position data to use
  22973. */
  22974. setPositions(data: Nullable<FloatArray>): void;
  22975. /**
  22976. * Gets the position data stored in this target
  22977. * @returns a FloatArray containing the position data (or null if not present)
  22978. */
  22979. getPositions(): Nullable<FloatArray>;
  22980. /**
  22981. * Affects normal data to this target
  22982. * @param data defines the normal data to use
  22983. */
  22984. setNormals(data: Nullable<FloatArray>): void;
  22985. /**
  22986. * Gets the normal data stored in this target
  22987. * @returns a FloatArray containing the normal data (or null if not present)
  22988. */
  22989. getNormals(): Nullable<FloatArray>;
  22990. /**
  22991. * Affects tangent data to this target
  22992. * @param data defines the tangent data to use
  22993. */
  22994. setTangents(data: Nullable<FloatArray>): void;
  22995. /**
  22996. * Gets the tangent data stored in this target
  22997. * @returns a FloatArray containing the tangent data (or null if not present)
  22998. */
  22999. getTangents(): Nullable<FloatArray>;
  23000. /**
  23001. * Affects texture coordinates data to this target
  23002. * @param data defines the texture coordinates data to use
  23003. */
  23004. setUVs(data: Nullable<FloatArray>): void;
  23005. /**
  23006. * Gets the texture coordinates data stored in this target
  23007. * @returns a FloatArray containing the texture coordinates data (or null if not present)
  23008. */
  23009. getUVs(): Nullable<FloatArray>;
  23010. /**
  23011. * Clone the current target
  23012. * @returns a new MorphTarget
  23013. */
  23014. clone(): MorphTarget;
  23015. /**
  23016. * Serializes the current target into a Serialization object
  23017. * @returns the serialized object
  23018. */
  23019. serialize(): any;
  23020. /**
  23021. * Returns the string "MorphTarget"
  23022. * @returns "MorphTarget"
  23023. */
  23024. getClassName(): string;
  23025. /**
  23026. * Creates a new target from serialized data
  23027. * @param serializationObject defines the serialized data to use
  23028. * @returns a new MorphTarget
  23029. */
  23030. static Parse(serializationObject: any): MorphTarget;
  23031. /**
  23032. * Creates a MorphTarget from mesh data
  23033. * @param mesh defines the source mesh
  23034. * @param name defines the name to use for the new target
  23035. * @param influence defines the influence to attach to the target
  23036. * @returns a new MorphTarget
  23037. */
  23038. static FromMesh(mesh: AbstractMesh, name?: string, influence?: number): MorphTarget;
  23039. }
  23040. }
  23041. declare module "babylonjs/Morph/morphTargetManager" {
  23042. import { Nullable } from "babylonjs/types";
  23043. import { Scene } from "babylonjs/scene";
  23044. import { MorphTarget } from "babylonjs/Morph/morphTarget";
  23045. /**
  23046. * This class is used to deform meshes using morphing between different targets
  23047. * @see http://doc.babylonjs.com/how_to/how_to_use_morphtargets
  23048. */
  23049. export class MorphTargetManager {
  23050. private _targets;
  23051. private _targetInfluenceChangedObservers;
  23052. private _targetDataLayoutChangedObservers;
  23053. private _activeTargets;
  23054. private _scene;
  23055. private _influences;
  23056. private _supportsNormals;
  23057. private _supportsTangents;
  23058. private _supportsUVs;
  23059. private _vertexCount;
  23060. private _uniqueId;
  23061. private _tempInfluences;
  23062. /**
  23063. * Gets or sets a boolean indicating if normals must be morphed
  23064. */
  23065. enableNormalMorphing: boolean;
  23066. /**
  23067. * Gets or sets a boolean indicating if tangents must be morphed
  23068. */
  23069. enableTangentMorphing: boolean;
  23070. /**
  23071. * Gets or sets a boolean indicating if UV must be morphed
  23072. */
  23073. enableUVMorphing: boolean;
  23074. /**
  23075. * Creates a new MorphTargetManager
  23076. * @param scene defines the current scene
  23077. */
  23078. constructor(scene?: Nullable<Scene>);
  23079. /**
  23080. * Gets the unique ID of this manager
  23081. */
  23082. readonly uniqueId: number;
  23083. /**
  23084. * Gets the number of vertices handled by this manager
  23085. */
  23086. readonly vertexCount: number;
  23087. /**
  23088. * Gets a boolean indicating if this manager supports morphing of normals
  23089. */
  23090. readonly supportsNormals: boolean;
  23091. /**
  23092. * Gets a boolean indicating if this manager supports morphing of tangents
  23093. */
  23094. readonly supportsTangents: boolean;
  23095. /**
  23096. * Gets a boolean indicating if this manager supports morphing of texture coordinates
  23097. */
  23098. readonly supportsUVs: boolean;
  23099. /**
  23100. * Gets the number of targets stored in this manager
  23101. */
  23102. readonly numTargets: number;
  23103. /**
  23104. * Gets the number of influencers (ie. the number of targets with influences > 0)
  23105. */
  23106. readonly numInfluencers: number;
  23107. /**
  23108. * Gets the list of influences (one per target)
  23109. */
  23110. readonly influences: Float32Array;
  23111. /**
  23112. * Gets the active target at specified index. An active target is a target with an influence > 0
  23113. * @param index defines the index to check
  23114. * @returns the requested target
  23115. */
  23116. getActiveTarget(index: number): MorphTarget;
  23117. /**
  23118. * Gets the target at specified index
  23119. * @param index defines the index to check
  23120. * @returns the requested target
  23121. */
  23122. getTarget(index: number): MorphTarget;
  23123. /**
  23124. * Add a new target to this manager
  23125. * @param target defines the target to add
  23126. */
  23127. addTarget(target: MorphTarget): void;
  23128. /**
  23129. * Removes a target from the manager
  23130. * @param target defines the target to remove
  23131. */
  23132. removeTarget(target: MorphTarget): void;
  23133. /**
  23134. * Clone the current manager
  23135. * @returns a new MorphTargetManager
  23136. */
  23137. clone(): MorphTargetManager;
  23138. /**
  23139. * Serializes the current manager into a Serialization object
  23140. * @returns the serialized object
  23141. */
  23142. serialize(): any;
  23143. private _syncActiveTargets;
  23144. /**
  23145. * Syncrhonize the targets with all the meshes using this morph target manager
  23146. */
  23147. synchronize(): void;
  23148. /**
  23149. * Creates a new MorphTargetManager from serialized data
  23150. * @param serializationObject defines the serialized data
  23151. * @param scene defines the hosting scene
  23152. * @returns the new MorphTargetManager
  23153. */
  23154. static Parse(serializationObject: any, scene: Scene): MorphTargetManager;
  23155. }
  23156. }
  23157. declare module "babylonjs/Meshes/meshLODLevel" {
  23158. import { Mesh } from "babylonjs/Meshes/mesh";
  23159. import { Nullable } from "babylonjs/types";
  23160. /**
  23161. * Class used to represent a specific level of detail of a mesh
  23162. * @see http://doc.babylonjs.com/how_to/how_to_use_lod
  23163. */
  23164. export class MeshLODLevel {
  23165. /** Defines the distance where this level should start being displayed */
  23166. distance: number;
  23167. /** Defines the mesh to use to render this level */
  23168. mesh: Nullable<Mesh>;
  23169. /**
  23170. * Creates a new LOD level
  23171. * @param distance defines the distance where this level should star being displayed
  23172. * @param mesh defines the mesh to use to render this level
  23173. */
  23174. constructor(
  23175. /** Defines the distance where this level should start being displayed */
  23176. distance: number,
  23177. /** Defines the mesh to use to render this level */
  23178. mesh: Nullable<Mesh>);
  23179. }
  23180. }
  23181. declare module "babylonjs/Meshes/groundMesh" {
  23182. import { Scene } from "babylonjs/scene";
  23183. import { Vector3 } from "babylonjs/Maths/math.vector";
  23184. import { Mesh } from "babylonjs/Meshes/mesh";
  23185. /**
  23186. * Mesh representing the gorund
  23187. */
  23188. export class GroundMesh extends Mesh {
  23189. /** If octree should be generated */
  23190. generateOctree: boolean;
  23191. private _heightQuads;
  23192. /** @hidden */
  23193. _subdivisionsX: number;
  23194. /** @hidden */
  23195. _subdivisionsY: number;
  23196. /** @hidden */
  23197. _width: number;
  23198. /** @hidden */
  23199. _height: number;
  23200. /** @hidden */
  23201. _minX: number;
  23202. /** @hidden */
  23203. _maxX: number;
  23204. /** @hidden */
  23205. _minZ: number;
  23206. /** @hidden */
  23207. _maxZ: number;
  23208. constructor(name: string, scene: Scene);
  23209. /**
  23210. * "GroundMesh"
  23211. * @returns "GroundMesh"
  23212. */
  23213. getClassName(): string;
  23214. /**
  23215. * The minimum of x and y subdivisions
  23216. */
  23217. readonly subdivisions: number;
  23218. /**
  23219. * X subdivisions
  23220. */
  23221. readonly subdivisionsX: number;
  23222. /**
  23223. * Y subdivisions
  23224. */
  23225. readonly subdivisionsY: number;
  23226. /**
  23227. * This function will update an octree to help to select the right submeshes for rendering, picking and collision computations.
  23228. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  23229. * @param chunksCount the number of subdivisions for x and y
  23230. * @param octreeBlocksSize (Default: 32)
  23231. */
  23232. optimize(chunksCount: number, octreeBlocksSize?: number): void;
  23233. /**
  23234. * Returns a height (y) value in the Worl system :
  23235. * the ground altitude at the coordinates (x, z) expressed in the World system.
  23236. * @param x x coordinate
  23237. * @param z z coordinate
  23238. * @returns the ground y position if (x, z) are outside the ground surface.
  23239. */
  23240. getHeightAtCoordinates(x: number, z: number): number;
  23241. /**
  23242. * Returns a normalized vector (Vector3) orthogonal to the ground
  23243. * at the ground coordinates (x, z) expressed in the World system.
  23244. * @param x x coordinate
  23245. * @param z z coordinate
  23246. * @returns Vector3(0.0, 1.0, 0.0) if (x, z) are outside the ground surface.
  23247. */
  23248. getNormalAtCoordinates(x: number, z: number): Vector3;
  23249. /**
  23250. * Updates the Vector3 passed a reference with a normalized vector orthogonal to the ground
  23251. * at the ground coordinates (x, z) expressed in the World system.
  23252. * Doesn't uptade the reference Vector3 if (x, z) are outside the ground surface.
  23253. * @param x x coordinate
  23254. * @param z z coordinate
  23255. * @param ref vector to store the result
  23256. * @returns the GroundMesh.
  23257. */
  23258. getNormalAtCoordinatesToRef(x: number, z: number, ref: Vector3): GroundMesh;
  23259. /**
  23260. * Force the heights to be recomputed for getHeightAtCoordinates() or getNormalAtCoordinates()
  23261. * if the ground has been updated.
  23262. * This can be used in the render loop.
  23263. * @returns the GroundMesh.
  23264. */
  23265. updateCoordinateHeights(): GroundMesh;
  23266. private _getFacetAt;
  23267. private _initHeightQuads;
  23268. private _computeHeightQuads;
  23269. /**
  23270. * Serializes this ground mesh
  23271. * @param serializationObject object to write serialization to
  23272. */
  23273. serialize(serializationObject: any): void;
  23274. /**
  23275. * Parses a serialized ground mesh
  23276. * @param parsedMesh the serialized mesh
  23277. * @param scene the scene to create the ground mesh in
  23278. * @returns the created ground mesh
  23279. */
  23280. static Parse(parsedMesh: any, scene: Scene): GroundMesh;
  23281. }
  23282. }
  23283. declare module "babylonjs/Physics/physicsJoint" {
  23284. import { Vector3 } from "babylonjs/Maths/math.vector";
  23285. import { IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  23286. /**
  23287. * Interface for Physics-Joint data
  23288. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23289. */
  23290. export interface PhysicsJointData {
  23291. /**
  23292. * The main pivot of the joint
  23293. */
  23294. mainPivot?: Vector3;
  23295. /**
  23296. * The connected pivot of the joint
  23297. */
  23298. connectedPivot?: Vector3;
  23299. /**
  23300. * The main axis of the joint
  23301. */
  23302. mainAxis?: Vector3;
  23303. /**
  23304. * The connected axis of the joint
  23305. */
  23306. connectedAxis?: Vector3;
  23307. /**
  23308. * The collision of the joint
  23309. */
  23310. collision?: boolean;
  23311. /**
  23312. * Native Oimo/Cannon/Energy data
  23313. */
  23314. nativeParams?: any;
  23315. }
  23316. /**
  23317. * This is a holder class for the physics joint created by the physics plugin
  23318. * It holds a set of functions to control the underlying joint
  23319. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23320. */
  23321. export class PhysicsJoint {
  23322. /**
  23323. * The type of the physics joint
  23324. */
  23325. type: number;
  23326. /**
  23327. * The data for the physics joint
  23328. */
  23329. jointData: PhysicsJointData;
  23330. private _physicsJoint;
  23331. protected _physicsPlugin: IPhysicsEnginePlugin;
  23332. /**
  23333. * Initializes the physics joint
  23334. * @param type The type of the physics joint
  23335. * @param jointData The data for the physics joint
  23336. */
  23337. constructor(
  23338. /**
  23339. * The type of the physics joint
  23340. */
  23341. type: number,
  23342. /**
  23343. * The data for the physics joint
  23344. */
  23345. jointData: PhysicsJointData);
  23346. /**
  23347. * Gets the physics joint
  23348. */
  23349. /**
  23350. * Sets the physics joint
  23351. */
  23352. physicsJoint: any;
  23353. /**
  23354. * Sets the physics plugin
  23355. */
  23356. physicsPlugin: IPhysicsEnginePlugin;
  23357. /**
  23358. * Execute a function that is physics-plugin specific.
  23359. * @param {Function} func the function that will be executed.
  23360. * It accepts two parameters: the physics world and the physics joint
  23361. */
  23362. executeNativeFunction(func: (world: any, physicsJoint: any) => void): void;
  23363. /**
  23364. * Distance-Joint type
  23365. */
  23366. static DistanceJoint: number;
  23367. /**
  23368. * Hinge-Joint type
  23369. */
  23370. static HingeJoint: number;
  23371. /**
  23372. * Ball-and-Socket joint type
  23373. */
  23374. static BallAndSocketJoint: number;
  23375. /**
  23376. * Wheel-Joint type
  23377. */
  23378. static WheelJoint: number;
  23379. /**
  23380. * Slider-Joint type
  23381. */
  23382. static SliderJoint: number;
  23383. /**
  23384. * Prismatic-Joint type
  23385. */
  23386. static PrismaticJoint: number;
  23387. /**
  23388. * Universal-Joint type
  23389. * ENERGY FTW! (compare with this - @see http://ode-wiki.org/wiki/index.php?title=Manual:_Joint_Types_and_Functions)
  23390. */
  23391. static UniversalJoint: number;
  23392. /**
  23393. * Hinge-Joint 2 type
  23394. */
  23395. static Hinge2Joint: number;
  23396. /**
  23397. * Point to Point Joint type. Similar to a Ball-Joint. Different in parameters
  23398. */
  23399. static PointToPointJoint: number;
  23400. /**
  23401. * Spring-Joint type
  23402. */
  23403. static SpringJoint: number;
  23404. /**
  23405. * Lock-Joint type
  23406. */
  23407. static LockJoint: number;
  23408. }
  23409. /**
  23410. * A class representing a physics distance joint
  23411. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23412. */
  23413. export class DistanceJoint extends PhysicsJoint {
  23414. /**
  23415. *
  23416. * @param jointData The data for the Distance-Joint
  23417. */
  23418. constructor(jointData: DistanceJointData);
  23419. /**
  23420. * Update the predefined distance.
  23421. * @param maxDistance The maximum preferred distance
  23422. * @param minDistance The minimum preferred distance
  23423. */
  23424. updateDistance(maxDistance: number, minDistance?: number): void;
  23425. }
  23426. /**
  23427. * Represents a Motor-Enabled Joint
  23428. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23429. */
  23430. export class MotorEnabledJoint extends PhysicsJoint implements IMotorEnabledJoint {
  23431. /**
  23432. * Initializes the Motor-Enabled Joint
  23433. * @param type The type of the joint
  23434. * @param jointData The physica joint data for the joint
  23435. */
  23436. constructor(type: number, jointData: PhysicsJointData);
  23437. /**
  23438. * Set the motor values.
  23439. * Attention, this function is plugin specific. Engines won't react 100% the same.
  23440. * @param force the force to apply
  23441. * @param maxForce max force for this motor.
  23442. */
  23443. setMotor(force?: number, maxForce?: number): void;
  23444. /**
  23445. * Set the motor's limits.
  23446. * Attention, this function is plugin specific. Engines won't react 100% the same.
  23447. * @param upperLimit The upper limit of the motor
  23448. * @param lowerLimit The lower limit of the motor
  23449. */
  23450. setLimit(upperLimit: number, lowerLimit?: number): void;
  23451. }
  23452. /**
  23453. * This class represents a single physics Hinge-Joint
  23454. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23455. */
  23456. export class HingeJoint extends MotorEnabledJoint {
  23457. /**
  23458. * Initializes the Hinge-Joint
  23459. * @param jointData The joint data for the Hinge-Joint
  23460. */
  23461. constructor(jointData: PhysicsJointData);
  23462. /**
  23463. * Set the motor values.
  23464. * Attention, this function is plugin specific. Engines won't react 100% the same.
  23465. * @param {number} force the force to apply
  23466. * @param {number} maxForce max force for this motor.
  23467. */
  23468. setMotor(force?: number, maxForce?: number): void;
  23469. /**
  23470. * Set the motor's limits.
  23471. * Attention, this function is plugin specific. Engines won't react 100% the same.
  23472. * @param upperLimit The upper limit of the motor
  23473. * @param lowerLimit The lower limit of the motor
  23474. */
  23475. setLimit(upperLimit: number, lowerLimit?: number): void;
  23476. }
  23477. /**
  23478. * This class represents a dual hinge physics joint (same as wheel joint)
  23479. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23480. */
  23481. export class Hinge2Joint extends MotorEnabledJoint {
  23482. /**
  23483. * Initializes the Hinge2-Joint
  23484. * @param jointData The joint data for the Hinge2-Joint
  23485. */
  23486. constructor(jointData: PhysicsJointData);
  23487. /**
  23488. * Set the motor values.
  23489. * Attention, this function is plugin specific. Engines won't react 100% the same.
  23490. * @param {number} targetSpeed the speed the motor is to reach
  23491. * @param {number} maxForce max force for this motor.
  23492. * @param {motorIndex} the motor's index, 0 or 1.
  23493. */
  23494. setMotor(targetSpeed?: number, maxForce?: number, motorIndex?: number): void;
  23495. /**
  23496. * Set the motor limits.
  23497. * Attention, this function is plugin specific. Engines won't react 100% the same.
  23498. * @param {number} upperLimit the upper limit
  23499. * @param {number} lowerLimit lower limit
  23500. * @param {motorIndex} the motor's index, 0 or 1.
  23501. */
  23502. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  23503. }
  23504. /**
  23505. * Interface for a motor enabled joint
  23506. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23507. */
  23508. export interface IMotorEnabledJoint {
  23509. /**
  23510. * Physics joint
  23511. */
  23512. physicsJoint: any;
  23513. /**
  23514. * Sets the motor of the motor-enabled joint
  23515. * @param force The force of the motor
  23516. * @param maxForce The maximum force of the motor
  23517. * @param motorIndex The index of the motor
  23518. */
  23519. setMotor(force?: number, maxForce?: number, motorIndex?: number): void;
  23520. /**
  23521. * Sets the limit of the motor
  23522. * @param upperLimit The upper limit of the motor
  23523. * @param lowerLimit The lower limit of the motor
  23524. * @param motorIndex The index of the motor
  23525. */
  23526. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  23527. }
  23528. /**
  23529. * Joint data for a Distance-Joint
  23530. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23531. */
  23532. export interface DistanceJointData extends PhysicsJointData {
  23533. /**
  23534. * Max distance the 2 joint objects can be apart
  23535. */
  23536. maxDistance: number;
  23537. }
  23538. /**
  23539. * Joint data from a spring joint
  23540. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23541. */
  23542. export interface SpringJointData extends PhysicsJointData {
  23543. /**
  23544. * Length of the spring
  23545. */
  23546. length: number;
  23547. /**
  23548. * Stiffness of the spring
  23549. */
  23550. stiffness: number;
  23551. /**
  23552. * Damping of the spring
  23553. */
  23554. damping: number;
  23555. /** this callback will be called when applying the force to the impostors. */
  23556. forceApplicationCallback: () => void;
  23557. }
  23558. }
  23559. declare module "babylonjs/Physics/physicsRaycastResult" {
  23560. import { Vector3 } from "babylonjs/Maths/math.vector";
  23561. /**
  23562. * Holds the data for the raycast result
  23563. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23564. */
  23565. export class PhysicsRaycastResult {
  23566. private _hasHit;
  23567. private _hitDistance;
  23568. private _hitNormalWorld;
  23569. private _hitPointWorld;
  23570. private _rayFromWorld;
  23571. private _rayToWorld;
  23572. /**
  23573. * Gets if there was a hit
  23574. */
  23575. readonly hasHit: boolean;
  23576. /**
  23577. * Gets the distance from the hit
  23578. */
  23579. readonly hitDistance: number;
  23580. /**
  23581. * Gets the hit normal/direction in the world
  23582. */
  23583. readonly hitNormalWorld: Vector3;
  23584. /**
  23585. * Gets the hit point in the world
  23586. */
  23587. readonly hitPointWorld: Vector3;
  23588. /**
  23589. * Gets the ray "start point" of the ray in the world
  23590. */
  23591. readonly rayFromWorld: Vector3;
  23592. /**
  23593. * Gets the ray "end point" of the ray in the world
  23594. */
  23595. readonly rayToWorld: Vector3;
  23596. /**
  23597. * Sets the hit data (normal & point in world space)
  23598. * @param hitNormalWorld defines the normal in world space
  23599. * @param hitPointWorld defines the point in world space
  23600. */
  23601. setHitData(hitNormalWorld: IXYZ, hitPointWorld: IXYZ): void;
  23602. /**
  23603. * Sets the distance from the start point to the hit point
  23604. * @param distance
  23605. */
  23606. setHitDistance(distance: number): void;
  23607. /**
  23608. * Calculates the distance manually
  23609. */
  23610. calculateHitDistance(): void;
  23611. /**
  23612. * Resets all the values to default
  23613. * @param from The from point on world space
  23614. * @param to The to point on world space
  23615. */
  23616. reset(from?: Vector3, to?: Vector3): void;
  23617. }
  23618. /**
  23619. * Interface for the size containing width and height
  23620. */
  23621. interface IXYZ {
  23622. /**
  23623. * X
  23624. */
  23625. x: number;
  23626. /**
  23627. * Y
  23628. */
  23629. y: number;
  23630. /**
  23631. * Z
  23632. */
  23633. z: number;
  23634. }
  23635. }
  23636. declare module "babylonjs/Physics/IPhysicsEngine" {
  23637. import { Nullable } from "babylonjs/types";
  23638. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  23639. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  23640. import { PhysicsImpostor, IPhysicsEnabledObject } from "babylonjs/Physics/physicsImpostor";
  23641. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  23642. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  23643. /**
  23644. * Interface used to describe a physics joint
  23645. */
  23646. export interface PhysicsImpostorJoint {
  23647. /** Defines the main impostor to which the joint is linked */
  23648. mainImpostor: PhysicsImpostor;
  23649. /** Defines the impostor that is connected to the main impostor using this joint */
  23650. connectedImpostor: PhysicsImpostor;
  23651. /** Defines the joint itself */
  23652. joint: PhysicsJoint;
  23653. }
  23654. /** @hidden */
  23655. export interface IPhysicsEnginePlugin {
  23656. world: any;
  23657. name: string;
  23658. setGravity(gravity: Vector3): void;
  23659. setTimeStep(timeStep: number): void;
  23660. getTimeStep(): number;
  23661. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  23662. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  23663. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  23664. generatePhysicsBody(impostor: PhysicsImpostor): void;
  23665. removePhysicsBody(impostor: PhysicsImpostor): void;
  23666. generateJoint(joint: PhysicsImpostorJoint): void;
  23667. removeJoint(joint: PhysicsImpostorJoint): void;
  23668. isSupported(): boolean;
  23669. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  23670. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  23671. setLinearVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  23672. setAngularVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  23673. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  23674. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  23675. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  23676. getBodyMass(impostor: PhysicsImpostor): number;
  23677. getBodyFriction(impostor: PhysicsImpostor): number;
  23678. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  23679. getBodyRestitution(impostor: PhysicsImpostor): number;
  23680. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  23681. getBodyPressure?(impostor: PhysicsImpostor): number;
  23682. setBodyPressure?(impostor: PhysicsImpostor, pressure: number): void;
  23683. getBodyStiffness?(impostor: PhysicsImpostor): number;
  23684. setBodyStiffness?(impostor: PhysicsImpostor, stiffness: number): void;
  23685. getBodyVelocityIterations?(impostor: PhysicsImpostor): number;
  23686. setBodyVelocityIterations?(impostor: PhysicsImpostor, velocityIterations: number): void;
  23687. getBodyPositionIterations?(impostor: PhysicsImpostor): number;
  23688. setBodyPositionIterations?(impostor: PhysicsImpostor, positionIterations: number): void;
  23689. appendAnchor?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  23690. appendHook?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  23691. sleepBody(impostor: PhysicsImpostor): void;
  23692. wakeUpBody(impostor: PhysicsImpostor): void;
  23693. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  23694. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  23695. setMotor(joint: IMotorEnabledJoint, speed: number, maxForce?: number, motorIndex?: number): void;
  23696. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  23697. getRadius(impostor: PhysicsImpostor): number;
  23698. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  23699. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  23700. dispose(): void;
  23701. }
  23702. /**
  23703. * Interface used to define a physics engine
  23704. * @see http://doc.babylonjs.com/how_to/using_the_physics_engine
  23705. */
  23706. export interface IPhysicsEngine {
  23707. /**
  23708. * Gets the gravity vector used by the simulation
  23709. */
  23710. gravity: Vector3;
  23711. /**
  23712. * Sets the gravity vector used by the simulation
  23713. * @param gravity defines the gravity vector to use
  23714. */
  23715. setGravity(gravity: Vector3): void;
  23716. /**
  23717. * Set the time step of the physics engine.
  23718. * Default is 1/60.
  23719. * To slow it down, enter 1/600 for example.
  23720. * To speed it up, 1/30
  23721. * @param newTimeStep the new timestep to apply to this world.
  23722. */
  23723. setTimeStep(newTimeStep: number): void;
  23724. /**
  23725. * Get the time step of the physics engine.
  23726. * @returns the current time step
  23727. */
  23728. getTimeStep(): number;
  23729. /**
  23730. * Release all resources
  23731. */
  23732. dispose(): void;
  23733. /**
  23734. * Gets the name of the current physics plugin
  23735. * @returns the name of the plugin
  23736. */
  23737. getPhysicsPluginName(): string;
  23738. /**
  23739. * Adding a new impostor for the impostor tracking.
  23740. * This will be done by the impostor itself.
  23741. * @param impostor the impostor to add
  23742. */
  23743. addImpostor(impostor: PhysicsImpostor): void;
  23744. /**
  23745. * Remove an impostor from the engine.
  23746. * This impostor and its mesh will not longer be updated by the physics engine.
  23747. * @param impostor the impostor to remove
  23748. */
  23749. removeImpostor(impostor: PhysicsImpostor): void;
  23750. /**
  23751. * Add a joint to the physics engine
  23752. * @param mainImpostor defines the main impostor to which the joint is added.
  23753. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  23754. * @param joint defines the joint that will connect both impostors.
  23755. */
  23756. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  23757. /**
  23758. * Removes a joint from the simulation
  23759. * @param mainImpostor defines the impostor used with the joint
  23760. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  23761. * @param joint defines the joint to remove
  23762. */
  23763. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  23764. /**
  23765. * Gets the current plugin used to run the simulation
  23766. * @returns current plugin
  23767. */
  23768. getPhysicsPlugin(): IPhysicsEnginePlugin;
  23769. /**
  23770. * Gets the list of physic impostors
  23771. * @returns an array of PhysicsImpostor
  23772. */
  23773. getImpostors(): Array<PhysicsImpostor>;
  23774. /**
  23775. * Gets the impostor for a physics enabled object
  23776. * @param object defines the object impersonated by the impostor
  23777. * @returns the PhysicsImpostor or null if not found
  23778. */
  23779. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  23780. /**
  23781. * Gets the impostor for a physics body object
  23782. * @param body defines physics body used by the impostor
  23783. * @returns the PhysicsImpostor or null if not found
  23784. */
  23785. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  23786. /**
  23787. * Does a raycast in the physics world
  23788. * @param from when should the ray start?
  23789. * @param to when should the ray end?
  23790. * @returns PhysicsRaycastResult
  23791. */
  23792. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  23793. /**
  23794. * Called by the scene. No need to call it.
  23795. * @param delta defines the timespam between frames
  23796. */
  23797. _step(delta: number): void;
  23798. }
  23799. }
  23800. declare module "babylonjs/Physics/physicsImpostor" {
  23801. import { Nullable, IndicesArray } from "babylonjs/types";
  23802. import { Vector3, Matrix, Quaternion } from "babylonjs/Maths/math.vector";
  23803. import { TransformNode } from "babylonjs/Meshes/transformNode";
  23804. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  23805. import { Scene } from "babylonjs/scene";
  23806. import { Bone } from "babylonjs/Bones/bone";
  23807. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  23808. import { PhysicsJoint, PhysicsJointData } from "babylonjs/Physics/physicsJoint";
  23809. import { Space } from "babylonjs/Maths/math.axis";
  23810. /**
  23811. * The interface for the physics imposter parameters
  23812. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23813. */
  23814. export interface PhysicsImpostorParameters {
  23815. /**
  23816. * The mass of the physics imposter
  23817. */
  23818. mass: number;
  23819. /**
  23820. * The friction of the physics imposter
  23821. */
  23822. friction?: number;
  23823. /**
  23824. * The coefficient of restitution of the physics imposter
  23825. */
  23826. restitution?: number;
  23827. /**
  23828. * The native options of the physics imposter
  23829. */
  23830. nativeOptions?: any;
  23831. /**
  23832. * Specifies if the parent should be ignored
  23833. */
  23834. ignoreParent?: boolean;
  23835. /**
  23836. * Specifies if bi-directional transformations should be disabled
  23837. */
  23838. disableBidirectionalTransformation?: boolean;
  23839. /**
  23840. * The pressure inside the physics imposter, soft object only
  23841. */
  23842. pressure?: number;
  23843. /**
  23844. * The stiffness the physics imposter, soft object only
  23845. */
  23846. stiffness?: number;
  23847. /**
  23848. * The number of iterations used in maintaining consistent vertex velocities, soft object only
  23849. */
  23850. velocityIterations?: number;
  23851. /**
  23852. * The number of iterations used in maintaining consistent vertex positions, soft object only
  23853. */
  23854. positionIterations?: number;
  23855. /**
  23856. * The number used to fix points on a cloth (0, 1, 2, 4, 8) or rope (0, 1, 2) only
  23857. * 0 None, 1, back left or top, 2, back right or bottom, 4, front left, 8, front right
  23858. * Add to fix multiple points
  23859. */
  23860. fixedPoints?: number;
  23861. /**
  23862. * The collision margin around a soft object
  23863. */
  23864. margin?: number;
  23865. /**
  23866. * The collision margin around a soft object
  23867. */
  23868. damping?: number;
  23869. /**
  23870. * The path for a rope based on an extrusion
  23871. */
  23872. path?: any;
  23873. /**
  23874. * The shape of an extrusion used for a rope based on an extrusion
  23875. */
  23876. shape?: any;
  23877. }
  23878. /**
  23879. * Interface for a physics-enabled object
  23880. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23881. */
  23882. export interface IPhysicsEnabledObject {
  23883. /**
  23884. * The position of the physics-enabled object
  23885. */
  23886. position: Vector3;
  23887. /**
  23888. * The rotation of the physics-enabled object
  23889. */
  23890. rotationQuaternion: Nullable<Quaternion>;
  23891. /**
  23892. * The scale of the physics-enabled object
  23893. */
  23894. scaling: Vector3;
  23895. /**
  23896. * The rotation of the physics-enabled object
  23897. */
  23898. rotation?: Vector3;
  23899. /**
  23900. * The parent of the physics-enabled object
  23901. */
  23902. parent?: any;
  23903. /**
  23904. * The bounding info of the physics-enabled object
  23905. * @returns The bounding info of the physics-enabled object
  23906. */
  23907. getBoundingInfo(): BoundingInfo;
  23908. /**
  23909. * Computes the world matrix
  23910. * @param force Specifies if the world matrix should be computed by force
  23911. * @returns A world matrix
  23912. */
  23913. computeWorldMatrix(force: boolean): Matrix;
  23914. /**
  23915. * Gets the world matrix
  23916. * @returns A world matrix
  23917. */
  23918. getWorldMatrix?(): Matrix;
  23919. /**
  23920. * Gets the child meshes
  23921. * @param directDescendantsOnly Specifies if only direct-descendants should be obtained
  23922. * @returns An array of abstract meshes
  23923. */
  23924. getChildMeshes?(directDescendantsOnly?: boolean): Array<AbstractMesh>;
  23925. /**
  23926. * Gets the vertex data
  23927. * @param kind The type of vertex data
  23928. * @returns A nullable array of numbers, or a float32 array
  23929. */
  23930. getVerticesData(kind: string): Nullable<Array<number> | Float32Array>;
  23931. /**
  23932. * Gets the indices from the mesh
  23933. * @returns A nullable array of index arrays
  23934. */
  23935. getIndices?(): Nullable<IndicesArray>;
  23936. /**
  23937. * Gets the scene from the mesh
  23938. * @returns the indices array or null
  23939. */
  23940. getScene?(): Scene;
  23941. /**
  23942. * Gets the absolute position from the mesh
  23943. * @returns the absolute position
  23944. */
  23945. getAbsolutePosition(): Vector3;
  23946. /**
  23947. * Gets the absolute pivot point from the mesh
  23948. * @returns the absolute pivot point
  23949. */
  23950. getAbsolutePivotPoint(): Vector3;
  23951. /**
  23952. * Rotates the mesh
  23953. * @param axis The axis of rotation
  23954. * @param amount The amount of rotation
  23955. * @param space The space of the rotation
  23956. * @returns The rotation transform node
  23957. */
  23958. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  23959. /**
  23960. * Translates the mesh
  23961. * @param axis The axis of translation
  23962. * @param distance The distance of translation
  23963. * @param space The space of the translation
  23964. * @returns The transform node
  23965. */
  23966. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  23967. /**
  23968. * Sets the absolute position of the mesh
  23969. * @param absolutePosition The absolute position of the mesh
  23970. * @returns The transform node
  23971. */
  23972. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  23973. /**
  23974. * Gets the class name of the mesh
  23975. * @returns The class name
  23976. */
  23977. getClassName(): string;
  23978. }
  23979. /**
  23980. * Represents a physics imposter
  23981. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  23982. */
  23983. export class PhysicsImpostor {
  23984. /**
  23985. * The physics-enabled object used as the physics imposter
  23986. */
  23987. object: IPhysicsEnabledObject;
  23988. /**
  23989. * The type of the physics imposter
  23990. */
  23991. type: number;
  23992. private _options;
  23993. private _scene?;
  23994. /**
  23995. * The default object size of the imposter
  23996. */
  23997. static DEFAULT_OBJECT_SIZE: Vector3;
  23998. /**
  23999. * The identity quaternion of the imposter
  24000. */
  24001. static IDENTITY_QUATERNION: Quaternion;
  24002. /** @hidden */
  24003. _pluginData: any;
  24004. private _physicsEngine;
  24005. private _physicsBody;
  24006. private _bodyUpdateRequired;
  24007. private _onBeforePhysicsStepCallbacks;
  24008. private _onAfterPhysicsStepCallbacks;
  24009. /** @hidden */
  24010. _onPhysicsCollideCallbacks: Array<{
  24011. callback: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void;
  24012. otherImpostors: Array<PhysicsImpostor>;
  24013. }>;
  24014. private _deltaPosition;
  24015. private _deltaRotation;
  24016. private _deltaRotationConjugated;
  24017. /** @hidden */
  24018. _isFromLine: boolean;
  24019. private _parent;
  24020. private _isDisposed;
  24021. private static _tmpVecs;
  24022. private static _tmpQuat;
  24023. /**
  24024. * Specifies if the physics imposter is disposed
  24025. */
  24026. readonly isDisposed: boolean;
  24027. /**
  24028. * Gets the mass of the physics imposter
  24029. */
  24030. mass: number;
  24031. /**
  24032. * Gets the coefficient of friction
  24033. */
  24034. /**
  24035. * Sets the coefficient of friction
  24036. */
  24037. friction: number;
  24038. /**
  24039. * Gets the coefficient of restitution
  24040. */
  24041. /**
  24042. * Sets the coefficient of restitution
  24043. */
  24044. restitution: number;
  24045. /**
  24046. * Gets the pressure of a soft body; only supported by the AmmoJSPlugin
  24047. */
  24048. /**
  24049. * Sets the pressure of a soft body; only supported by the AmmoJSPlugin
  24050. */
  24051. pressure: number;
  24052. /**
  24053. * Gets the stiffness of a soft body; only supported by the AmmoJSPlugin
  24054. */
  24055. /**
  24056. * Sets the stiffness of a soft body; only supported by the AmmoJSPlugin
  24057. */
  24058. stiffness: number;
  24059. /**
  24060. * Gets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  24061. */
  24062. /**
  24063. * Sets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  24064. */
  24065. velocityIterations: number;
  24066. /**
  24067. * Gets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  24068. */
  24069. /**
  24070. * Sets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  24071. */
  24072. positionIterations: number;
  24073. /**
  24074. * The unique id of the physics imposter
  24075. * set by the physics engine when adding this impostor to the array
  24076. */
  24077. uniqueId: number;
  24078. /**
  24079. * @hidden
  24080. */
  24081. soft: boolean;
  24082. /**
  24083. * @hidden
  24084. */
  24085. segments: number;
  24086. private _joints;
  24087. /**
  24088. * Initializes the physics imposter
  24089. * @param object The physics-enabled object used as the physics imposter
  24090. * @param type The type of the physics imposter
  24091. * @param _options The options for the physics imposter
  24092. * @param _scene The Babylon scene
  24093. */
  24094. constructor(
  24095. /**
  24096. * The physics-enabled object used as the physics imposter
  24097. */
  24098. object: IPhysicsEnabledObject,
  24099. /**
  24100. * The type of the physics imposter
  24101. */
  24102. type: number, _options?: PhysicsImpostorParameters, _scene?: Scene | undefined);
  24103. /**
  24104. * This function will completly initialize this impostor.
  24105. * It will create a new body - but only if this mesh has no parent.
  24106. * If it has, this impostor will not be used other than to define the impostor
  24107. * of the child mesh.
  24108. * @hidden
  24109. */
  24110. _init(): void;
  24111. private _getPhysicsParent;
  24112. /**
  24113. * Should a new body be generated.
  24114. * @returns boolean specifying if body initialization is required
  24115. */
  24116. isBodyInitRequired(): boolean;
  24117. /**
  24118. * Sets the updated scaling
  24119. * @param updated Specifies if the scaling is updated
  24120. */
  24121. setScalingUpdated(): void;
  24122. /**
  24123. * Force a regeneration of this or the parent's impostor's body.
  24124. * Use under cautious - This will remove all joints already implemented.
  24125. */
  24126. forceUpdate(): void;
  24127. /**
  24128. * Gets the body that holds this impostor. Either its own, or its parent.
  24129. */
  24130. /**
  24131. * Set the physics body. Used mainly by the physics engine/plugin
  24132. */
  24133. physicsBody: any;
  24134. /**
  24135. * Get the parent of the physics imposter
  24136. * @returns Physics imposter or null
  24137. */
  24138. /**
  24139. * Sets the parent of the physics imposter
  24140. */
  24141. parent: Nullable<PhysicsImpostor>;
  24142. /**
  24143. * Resets the update flags
  24144. */
  24145. resetUpdateFlags(): void;
  24146. /**
  24147. * Gets the object extend size
  24148. * @returns the object extend size
  24149. */
  24150. getObjectExtendSize(): Vector3;
  24151. /**
  24152. * Gets the object center
  24153. * @returns The object center
  24154. */
  24155. getObjectCenter(): Vector3;
  24156. /**
  24157. * Get a specific parametes from the options parameter
  24158. * @param paramName The object parameter name
  24159. * @returns The object parameter
  24160. */
  24161. getParam(paramName: string): any;
  24162. /**
  24163. * Sets a specific parameter in the options given to the physics plugin
  24164. * @param paramName The parameter name
  24165. * @param value The value of the parameter
  24166. */
  24167. setParam(paramName: string, value: number): void;
  24168. /**
  24169. * Specifically change the body's mass option. Won't recreate the physics body object
  24170. * @param mass The mass of the physics imposter
  24171. */
  24172. setMass(mass: number): void;
  24173. /**
  24174. * Gets the linear velocity
  24175. * @returns linear velocity or null
  24176. */
  24177. getLinearVelocity(): Nullable<Vector3>;
  24178. /**
  24179. * Sets the linear velocity
  24180. * @param velocity linear velocity or null
  24181. */
  24182. setLinearVelocity(velocity: Nullable<Vector3>): void;
  24183. /**
  24184. * Gets the angular velocity
  24185. * @returns angular velocity or null
  24186. */
  24187. getAngularVelocity(): Nullable<Vector3>;
  24188. /**
  24189. * Sets the angular velocity
  24190. * @param velocity The velocity or null
  24191. */
  24192. setAngularVelocity(velocity: Nullable<Vector3>): void;
  24193. /**
  24194. * Execute a function with the physics plugin native code
  24195. * Provide a function the will have two variables - the world object and the physics body object
  24196. * @param func The function to execute with the physics plugin native code
  24197. */
  24198. executeNativeFunction(func: (world: any, physicsBody: any) => void): void;
  24199. /**
  24200. * Register a function that will be executed before the physics world is stepping forward
  24201. * @param func The function to execute before the physics world is stepped forward
  24202. */
  24203. registerBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  24204. /**
  24205. * Unregister a function that will be executed before the physics world is stepping forward
  24206. * @param func The function to execute before the physics world is stepped forward
  24207. */
  24208. unregisterBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  24209. /**
  24210. * Register a function that will be executed after the physics step
  24211. * @param func The function to execute after physics step
  24212. */
  24213. registerAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  24214. /**
  24215. * Unregisters a function that will be executed after the physics step
  24216. * @param func The function to execute after physics step
  24217. */
  24218. unregisterAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  24219. /**
  24220. * register a function that will be executed when this impostor collides against a different body
  24221. * @param collideAgainst Physics imposter, or array of physics imposters to collide against
  24222. * @param func Callback that is executed on collision
  24223. */
  24224. registerOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void): void;
  24225. /**
  24226. * Unregisters the physics imposter on contact
  24227. * @param collideAgainst The physics object to collide against
  24228. * @param func Callback to execute on collision
  24229. */
  24230. unregisterOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor | Array<PhysicsImpostor>) => void): void;
  24231. private _tmpQuat;
  24232. private _tmpQuat2;
  24233. /**
  24234. * Get the parent rotation
  24235. * @returns The parent rotation
  24236. */
  24237. getParentsRotation(): Quaternion;
  24238. /**
  24239. * this function is executed by the physics engine.
  24240. */
  24241. beforeStep: () => void;
  24242. /**
  24243. * this function is executed by the physics engine
  24244. */
  24245. afterStep: () => void;
  24246. /**
  24247. * Legacy collision detection event support
  24248. */
  24249. onCollideEvent: Nullable<(collider: PhysicsImpostor, collidedWith: PhysicsImpostor) => void>;
  24250. /**
  24251. * event and body object due to cannon's event-based architecture.
  24252. */
  24253. onCollide: (e: {
  24254. body: any;
  24255. }) => void;
  24256. /**
  24257. * Apply a force
  24258. * @param force The force to apply
  24259. * @param contactPoint The contact point for the force
  24260. * @returns The physics imposter
  24261. */
  24262. applyForce(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  24263. /**
  24264. * Apply an impulse
  24265. * @param force The impulse force
  24266. * @param contactPoint The contact point for the impulse force
  24267. * @returns The physics imposter
  24268. */
  24269. applyImpulse(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  24270. /**
  24271. * A help function to create a joint
  24272. * @param otherImpostor A physics imposter used to create a joint
  24273. * @param jointType The type of joint
  24274. * @param jointData The data for the joint
  24275. * @returns The physics imposter
  24276. */
  24277. createJoint(otherImpostor: PhysicsImpostor, jointType: number, jointData: PhysicsJointData): PhysicsImpostor;
  24278. /**
  24279. * Add a joint to this impostor with a different impostor
  24280. * @param otherImpostor A physics imposter used to add a joint
  24281. * @param joint The joint to add
  24282. * @returns The physics imposter
  24283. */
  24284. addJoint(otherImpostor: PhysicsImpostor, joint: PhysicsJoint): PhysicsImpostor;
  24285. /**
  24286. * Add an anchor to a cloth impostor
  24287. * @param otherImpostor rigid impostor to anchor to
  24288. * @param width ratio across width from 0 to 1
  24289. * @param height ratio up height from 0 to 1
  24290. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  24291. * @param noCollisionBetweenLinkedBodies when true collisions between cloth impostor and anchor are ignored; default false
  24292. * @returns impostor the soft imposter
  24293. */
  24294. addAnchor(otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  24295. /**
  24296. * Add a hook to a rope impostor
  24297. * @param otherImpostor rigid impostor to anchor to
  24298. * @param length ratio across rope from 0 to 1
  24299. * @param influence the elasticity between rope impostor and anchor from 0, very stretchy to 1, little strech
  24300. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  24301. * @returns impostor the rope imposter
  24302. */
  24303. addHook(otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  24304. /**
  24305. * Will keep this body still, in a sleep mode.
  24306. * @returns the physics imposter
  24307. */
  24308. sleep(): PhysicsImpostor;
  24309. /**
  24310. * Wake the body up.
  24311. * @returns The physics imposter
  24312. */
  24313. wakeUp(): PhysicsImpostor;
  24314. /**
  24315. * Clones the physics imposter
  24316. * @param newObject The physics imposter clones to this physics-enabled object
  24317. * @returns A nullable physics imposter
  24318. */
  24319. clone(newObject: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  24320. /**
  24321. * Disposes the physics imposter
  24322. */
  24323. dispose(): void;
  24324. /**
  24325. * Sets the delta position
  24326. * @param position The delta position amount
  24327. */
  24328. setDeltaPosition(position: Vector3): void;
  24329. /**
  24330. * Sets the delta rotation
  24331. * @param rotation The delta rotation amount
  24332. */
  24333. setDeltaRotation(rotation: Quaternion): void;
  24334. /**
  24335. * Gets the box size of the physics imposter and stores the result in the input parameter
  24336. * @param result Stores the box size
  24337. * @returns The physics imposter
  24338. */
  24339. getBoxSizeToRef(result: Vector3): PhysicsImpostor;
  24340. /**
  24341. * Gets the radius of the physics imposter
  24342. * @returns Radius of the physics imposter
  24343. */
  24344. getRadius(): number;
  24345. /**
  24346. * Sync a bone with this impostor
  24347. * @param bone The bone to sync to the impostor.
  24348. * @param boneMesh The mesh that the bone is influencing.
  24349. * @param jointPivot The pivot of the joint / bone in local space.
  24350. * @param distToJoint Optional distance from the impostor to the joint.
  24351. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  24352. */
  24353. syncBoneWithImpostor(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion): void;
  24354. /**
  24355. * Sync impostor to a bone
  24356. * @param bone The bone that the impostor will be synced to.
  24357. * @param boneMesh The mesh that the bone is influencing.
  24358. * @param jointPivot The pivot of the joint / bone in local space.
  24359. * @param distToJoint Optional distance from the impostor to the joint.
  24360. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  24361. * @param boneAxis Optional vector3 axis the bone is aligned with
  24362. */
  24363. syncImpostorWithBone(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion, boneAxis?: Vector3): void;
  24364. /**
  24365. * No-Imposter type
  24366. */
  24367. static NoImpostor: number;
  24368. /**
  24369. * Sphere-Imposter type
  24370. */
  24371. static SphereImpostor: number;
  24372. /**
  24373. * Box-Imposter type
  24374. */
  24375. static BoxImpostor: number;
  24376. /**
  24377. * Plane-Imposter type
  24378. */
  24379. static PlaneImpostor: number;
  24380. /**
  24381. * Mesh-imposter type
  24382. */
  24383. static MeshImpostor: number;
  24384. /**
  24385. * Capsule-Impostor type (Ammo.js plugin only)
  24386. */
  24387. static CapsuleImpostor: number;
  24388. /**
  24389. * Cylinder-Imposter type
  24390. */
  24391. static CylinderImpostor: number;
  24392. /**
  24393. * Particle-Imposter type
  24394. */
  24395. static ParticleImpostor: number;
  24396. /**
  24397. * Heightmap-Imposter type
  24398. */
  24399. static HeightmapImpostor: number;
  24400. /**
  24401. * ConvexHull-Impostor type (Ammo.js plugin only)
  24402. */
  24403. static ConvexHullImpostor: number;
  24404. /**
  24405. * Rope-Imposter type
  24406. */
  24407. static RopeImpostor: number;
  24408. /**
  24409. * Cloth-Imposter type
  24410. */
  24411. static ClothImpostor: number;
  24412. /**
  24413. * Softbody-Imposter type
  24414. */
  24415. static SoftbodyImpostor: number;
  24416. }
  24417. }
  24418. declare module "babylonjs/Meshes/mesh" {
  24419. import { Observable } from "babylonjs/Misc/observable";
  24420. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  24421. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  24422. import { Camera } from "babylonjs/Cameras/camera";
  24423. import { Scene } from "babylonjs/scene";
  24424. import { Matrix, Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  24425. import { Color4 } from "babylonjs/Maths/math.color";
  24426. import { Engine } from "babylonjs/Engines/engine";
  24427. import { Node } from "babylonjs/node";
  24428. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  24429. import { IGetSetVerticesData } from "babylonjs/Meshes/mesh.vertexData";
  24430. import { Buffer } from "babylonjs/Meshes/buffer";
  24431. import { Geometry } from "babylonjs/Meshes/geometry";
  24432. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  24433. import { SubMesh } from "babylonjs/Meshes/subMesh";
  24434. import { BoundingSphere } from "babylonjs/Culling/boundingSphere";
  24435. import { Effect } from "babylonjs/Materials/effect";
  24436. import { Material } from "babylonjs/Materials/material";
  24437. import { Skeleton } from "babylonjs/Bones/skeleton";
  24438. import { MorphTargetManager } from "babylonjs/Morph/morphTargetManager";
  24439. import { MeshLODLevel } from "babylonjs/Meshes/meshLODLevel";
  24440. import { Path3D } from "babylonjs/Maths/math.path";
  24441. import { Plane } from "babylonjs/Maths/math.plane";
  24442. import { TransformNode } from "babylonjs/Meshes/transformNode";
  24443. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  24444. import { InstancedMesh } from "babylonjs/Meshes/instancedMesh";
  24445. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  24446. import { IPhysicsEnabledObject } from "babylonjs/Physics/physicsImpostor";
  24447. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  24448. /**
  24449. * @hidden
  24450. **/
  24451. export class _CreationDataStorage {
  24452. closePath?: boolean;
  24453. closeArray?: boolean;
  24454. idx: number[];
  24455. dashSize: number;
  24456. gapSize: number;
  24457. path3D: Path3D;
  24458. pathArray: Vector3[][];
  24459. arc: number;
  24460. radius: number;
  24461. cap: number;
  24462. tessellation: number;
  24463. }
  24464. /**
  24465. * @hidden
  24466. **/
  24467. class _InstanceDataStorage {
  24468. visibleInstances: any;
  24469. batchCache: _InstancesBatch;
  24470. instancesBufferSize: number;
  24471. instancesBuffer: Nullable<Buffer>;
  24472. instancesData: Float32Array;
  24473. overridenInstanceCount: number;
  24474. isFrozen: boolean;
  24475. previousBatch: Nullable<_InstancesBatch>;
  24476. hardwareInstancedRendering: boolean;
  24477. sideOrientation: number;
  24478. manualUpdate: boolean;
  24479. }
  24480. /**
  24481. * @hidden
  24482. **/
  24483. export class _InstancesBatch {
  24484. mustReturn: boolean;
  24485. visibleInstances: Nullable<import("babylonjs/Meshes/instancedMesh").InstancedMesh[]>[];
  24486. renderSelf: boolean[];
  24487. hardwareInstancedRendering: boolean[];
  24488. }
  24489. /**
  24490. * Class used to represent renderable models
  24491. */
  24492. export class Mesh extends AbstractMesh implements IGetSetVerticesData {
  24493. /**
  24494. * Mesh side orientation : usually the external or front surface
  24495. */
  24496. static readonly FRONTSIDE: number;
  24497. /**
  24498. * Mesh side orientation : usually the internal or back surface
  24499. */
  24500. static readonly BACKSIDE: number;
  24501. /**
  24502. * Mesh side orientation : both internal and external or front and back surfaces
  24503. */
  24504. static readonly DOUBLESIDE: number;
  24505. /**
  24506. * Mesh side orientation : by default, `FRONTSIDE`
  24507. */
  24508. static readonly DEFAULTSIDE: number;
  24509. /**
  24510. * Mesh cap setting : no cap
  24511. */
  24512. static readonly NO_CAP: number;
  24513. /**
  24514. * Mesh cap setting : one cap at the beginning of the mesh
  24515. */
  24516. static readonly CAP_START: number;
  24517. /**
  24518. * Mesh cap setting : one cap at the end of the mesh
  24519. */
  24520. static readonly CAP_END: number;
  24521. /**
  24522. * Mesh cap setting : two caps, one at the beginning and one at the end of the mesh
  24523. */
  24524. static readonly CAP_ALL: number;
  24525. /**
  24526. * Mesh pattern setting : no flip or rotate
  24527. */
  24528. static readonly NO_FLIP: number;
  24529. /**
  24530. * Mesh pattern setting : flip (reflect in y axis) alternate tiles on each row or column
  24531. */
  24532. static readonly FLIP_TILE: number;
  24533. /**
  24534. * Mesh pattern setting : rotate (180degs) alternate tiles on each row or column
  24535. */
  24536. static readonly ROTATE_TILE: number;
  24537. /**
  24538. * Mesh pattern setting : flip (reflect in y axis) all tiles on alternate rows
  24539. */
  24540. static readonly FLIP_ROW: number;
  24541. /**
  24542. * Mesh pattern setting : rotate (180degs) all tiles on alternate rows
  24543. */
  24544. static readonly ROTATE_ROW: number;
  24545. /**
  24546. * Mesh pattern setting : flip and rotate alternate tiles on each row or column
  24547. */
  24548. static readonly FLIP_N_ROTATE_TILE: number;
  24549. /**
  24550. * Mesh pattern setting : rotate pattern and rotate
  24551. */
  24552. static readonly FLIP_N_ROTATE_ROW: number;
  24553. /**
  24554. * Mesh tile positioning : part tiles same on left/right or top/bottom
  24555. */
  24556. static readonly CENTER: number;
  24557. /**
  24558. * Mesh tile positioning : part tiles on left
  24559. */
  24560. static readonly LEFT: number;
  24561. /**
  24562. * Mesh tile positioning : part tiles on right
  24563. */
  24564. static readonly RIGHT: number;
  24565. /**
  24566. * Mesh tile positioning : part tiles on top
  24567. */
  24568. static readonly TOP: number;
  24569. /**
  24570. * Mesh tile positioning : part tiles on bottom
  24571. */
  24572. static readonly BOTTOM: number;
  24573. /**
  24574. * Gets the default side orientation.
  24575. * @param orientation the orientation to value to attempt to get
  24576. * @returns the default orientation
  24577. * @hidden
  24578. */
  24579. static _GetDefaultSideOrientation(orientation?: number): number;
  24580. private _internalMeshDataInfo;
  24581. /**
  24582. * An event triggered before rendering the mesh
  24583. */
  24584. readonly onBeforeRenderObservable: Observable<Mesh>;
  24585. /**
  24586. * An event triggered before binding the mesh
  24587. */
  24588. readonly onBeforeBindObservable: Observable<Mesh>;
  24589. /**
  24590. * An event triggered after rendering the mesh
  24591. */
  24592. readonly onAfterRenderObservable: Observable<Mesh>;
  24593. /**
  24594. * An event triggered before drawing the mesh
  24595. */
  24596. readonly onBeforeDrawObservable: Observable<Mesh>;
  24597. private _onBeforeDrawObserver;
  24598. /**
  24599. * Sets a callback to call before drawing the mesh. It is recommended to use onBeforeDrawObservable instead
  24600. */
  24601. onBeforeDraw: () => void;
  24602. readonly hasInstances: boolean;
  24603. /**
  24604. * Gets the delay loading state of the mesh (when delay loading is turned on)
  24605. * @see http://doc.babylonjs.com/how_to/using_the_incremental_loading_system
  24606. */
  24607. delayLoadState: number;
  24608. /**
  24609. * Gets the list of instances created from this mesh
  24610. * it is not supposed to be modified manually.
  24611. * Note also that the order of the InstancedMesh wihin the array is not significant and might change.
  24612. * @see http://doc.babylonjs.com/how_to/how_to_use_instances
  24613. */
  24614. instances: import("babylonjs/Meshes/instancedMesh").InstancedMesh[];
  24615. /**
  24616. * Gets the file containing delay loading data for this mesh
  24617. */
  24618. delayLoadingFile: string;
  24619. /** @hidden */
  24620. _binaryInfo: any;
  24621. /**
  24622. * User defined function used to change how LOD level selection is done
  24623. * @see http://doc.babylonjs.com/how_to/how_to_use_lod
  24624. */
  24625. onLODLevelSelection: (distance: number, mesh: Mesh, selectedLevel: Nullable<Mesh>) => void;
  24626. /**
  24627. * Gets or sets the morph target manager
  24628. * @see http://doc.babylonjs.com/how_to/how_to_use_morphtargets
  24629. */
  24630. morphTargetManager: Nullable<MorphTargetManager>;
  24631. /** @hidden */
  24632. _creationDataStorage: Nullable<_CreationDataStorage>;
  24633. /** @hidden */
  24634. _geometry: Nullable<Geometry>;
  24635. /** @hidden */
  24636. _delayInfo: Array<string>;
  24637. /** @hidden */
  24638. _delayLoadingFunction: (any: any, mesh: Mesh) => void;
  24639. /** @hidden */
  24640. _instanceDataStorage: _InstanceDataStorage;
  24641. private _effectiveMaterial;
  24642. /** @hidden */
  24643. _shouldGenerateFlatShading: boolean;
  24644. /** @hidden */
  24645. _originalBuilderSideOrientation: number;
  24646. /**
  24647. * Use this property to change the original side orientation defined at construction time
  24648. */
  24649. overrideMaterialSideOrientation: Nullable<number>;
  24650. /**
  24651. * Gets the source mesh (the one used to clone this one from)
  24652. */
  24653. readonly source: Nullable<Mesh>;
  24654. /**
  24655. * Gets or sets a boolean indicating that this mesh does not use index buffer
  24656. */
  24657. isUnIndexed: boolean;
  24658. /** Gets the array buffer used to store the instanced buffer used for instances' world matrices */
  24659. readonly worldMatrixInstancedBuffer: Float32Array;
  24660. /** Gets or sets a boolean indicating that the update of the instance buffer of the world matrices is manual */
  24661. manualUpdateOfWorldMatrixInstancedBuffer: boolean;
  24662. /**
  24663. * @constructor
  24664. * @param name The value used by scene.getMeshByName() to do a lookup.
  24665. * @param scene The scene to add this mesh to.
  24666. * @param parent The parent of this mesh, if it has one
  24667. * @param source An optional Mesh from which geometry is shared, cloned.
  24668. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  24669. * When false, achieved by calling a clone(), also passing False.
  24670. * This will make creation of children, recursive.
  24671. * @param clonePhysicsImpostor When cloning, include cloning mesh physics impostor, default True.
  24672. */
  24673. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<Mesh>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean);
  24674. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  24675. doNotInstantiate: boolean;
  24676. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  24677. /**
  24678. * Gets the class name
  24679. * @returns the string "Mesh".
  24680. */
  24681. getClassName(): string;
  24682. /** @hidden */
  24683. readonly _isMesh: boolean;
  24684. /**
  24685. * Returns a description of this mesh
  24686. * @param fullDetails define if full details about this mesh must be used
  24687. * @returns a descriptive string representing this mesh
  24688. */
  24689. toString(fullDetails?: boolean): string;
  24690. /** @hidden */
  24691. _unBindEffect(): void;
  24692. /**
  24693. * Gets a boolean indicating if this mesh has LOD
  24694. */
  24695. readonly hasLODLevels: boolean;
  24696. /**
  24697. * Gets the list of MeshLODLevel associated with the current mesh
  24698. * @returns an array of MeshLODLevel
  24699. */
  24700. getLODLevels(): MeshLODLevel[];
  24701. private _sortLODLevels;
  24702. /**
  24703. * Add a mesh as LOD level triggered at the given distance.
  24704. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  24705. * @param distance The distance from the center of the object to show this level
  24706. * @param mesh The mesh to be added as LOD level (can be null)
  24707. * @return This mesh (for chaining)
  24708. */
  24709. addLODLevel(distance: number, mesh: Nullable<Mesh>): Mesh;
  24710. /**
  24711. * Returns the LOD level mesh at the passed distance or null if not found.
  24712. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  24713. * @param distance The distance from the center of the object to show this level
  24714. * @returns a Mesh or `null`
  24715. */
  24716. getLODLevelAtDistance(distance: number): Nullable<Mesh>;
  24717. /**
  24718. * Remove a mesh from the LOD array
  24719. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  24720. * @param mesh defines the mesh to be removed
  24721. * @return This mesh (for chaining)
  24722. */
  24723. removeLODLevel(mesh: Mesh): Mesh;
  24724. /**
  24725. * Returns the registered LOD mesh distant from the parameter `camera` position if any, else returns the current mesh.
  24726. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  24727. * @param camera defines the camera to use to compute distance
  24728. * @param boundingSphere defines a custom bounding sphere to use instead of the one from this mesh
  24729. * @return This mesh (for chaining)
  24730. */
  24731. getLOD(camera: Camera, boundingSphere?: BoundingSphere): Nullable<AbstractMesh>;
  24732. /**
  24733. * Gets the mesh internal Geometry object
  24734. */
  24735. readonly geometry: Nullable<Geometry>;
  24736. /**
  24737. * Returns the total number of vertices within the mesh geometry or zero if the mesh has no geometry.
  24738. * @returns the total number of vertices
  24739. */
  24740. getTotalVertices(): number;
  24741. /**
  24742. * Returns the content of an associated vertex buffer
  24743. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  24744. * - VertexBuffer.PositionKind
  24745. * - VertexBuffer.UVKind
  24746. * - VertexBuffer.UV2Kind
  24747. * - VertexBuffer.UV3Kind
  24748. * - VertexBuffer.UV4Kind
  24749. * - VertexBuffer.UV5Kind
  24750. * - VertexBuffer.UV6Kind
  24751. * - VertexBuffer.ColorKind
  24752. * - VertexBuffer.MatricesIndicesKind
  24753. * - VertexBuffer.MatricesIndicesExtraKind
  24754. * - VertexBuffer.MatricesWeightsKind
  24755. * - VertexBuffer.MatricesWeightsExtraKind
  24756. * @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
  24757. * @param forceCopy defines a boolean forcing the copy of the buffer no matter what the value of copyWhenShared is
  24758. * @returns a FloatArray or null if the mesh has no geometry or no vertex buffer for this kind.
  24759. */
  24760. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  24761. /**
  24762. * Returns the mesh VertexBuffer object from the requested `kind`
  24763. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  24764. * - VertexBuffer.PositionKind
  24765. * - VertexBuffer.NormalKind
  24766. * - VertexBuffer.UVKind
  24767. * - VertexBuffer.UV2Kind
  24768. * - VertexBuffer.UV3Kind
  24769. * - VertexBuffer.UV4Kind
  24770. * - VertexBuffer.UV5Kind
  24771. * - VertexBuffer.UV6Kind
  24772. * - VertexBuffer.ColorKind
  24773. * - VertexBuffer.MatricesIndicesKind
  24774. * - VertexBuffer.MatricesIndicesExtraKind
  24775. * - VertexBuffer.MatricesWeightsKind
  24776. * - VertexBuffer.MatricesWeightsExtraKind
  24777. * @returns a FloatArray or null if the mesh has no vertex buffer for this kind.
  24778. */
  24779. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  24780. /**
  24781. * Tests if a specific vertex buffer is associated with this mesh
  24782. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  24783. * - VertexBuffer.PositionKind
  24784. * - VertexBuffer.NormalKind
  24785. * - VertexBuffer.UVKind
  24786. * - VertexBuffer.UV2Kind
  24787. * - VertexBuffer.UV3Kind
  24788. * - VertexBuffer.UV4Kind
  24789. * - VertexBuffer.UV5Kind
  24790. * - VertexBuffer.UV6Kind
  24791. * - VertexBuffer.ColorKind
  24792. * - VertexBuffer.MatricesIndicesKind
  24793. * - VertexBuffer.MatricesIndicesExtraKind
  24794. * - VertexBuffer.MatricesWeightsKind
  24795. * - VertexBuffer.MatricesWeightsExtraKind
  24796. * @returns a boolean
  24797. */
  24798. isVerticesDataPresent(kind: string): boolean;
  24799. /**
  24800. * Returns a boolean defining if the vertex data for the requested `kind` is updatable.
  24801. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  24802. * - VertexBuffer.PositionKind
  24803. * - VertexBuffer.UVKind
  24804. * - VertexBuffer.UV2Kind
  24805. * - VertexBuffer.UV3Kind
  24806. * - VertexBuffer.UV4Kind
  24807. * - VertexBuffer.UV5Kind
  24808. * - VertexBuffer.UV6Kind
  24809. * - VertexBuffer.ColorKind
  24810. * - VertexBuffer.MatricesIndicesKind
  24811. * - VertexBuffer.MatricesIndicesExtraKind
  24812. * - VertexBuffer.MatricesWeightsKind
  24813. * - VertexBuffer.MatricesWeightsExtraKind
  24814. * @returns a boolean
  24815. */
  24816. isVertexBufferUpdatable(kind: string): boolean;
  24817. /**
  24818. * Returns a string which contains the list of existing `kinds` of Vertex Data associated with this mesh.
  24819. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  24820. * - VertexBuffer.PositionKind
  24821. * - VertexBuffer.NormalKind
  24822. * - VertexBuffer.UVKind
  24823. * - VertexBuffer.UV2Kind
  24824. * - VertexBuffer.UV3Kind
  24825. * - VertexBuffer.UV4Kind
  24826. * - VertexBuffer.UV5Kind
  24827. * - VertexBuffer.UV6Kind
  24828. * - VertexBuffer.ColorKind
  24829. * - VertexBuffer.MatricesIndicesKind
  24830. * - VertexBuffer.MatricesIndicesExtraKind
  24831. * - VertexBuffer.MatricesWeightsKind
  24832. * - VertexBuffer.MatricesWeightsExtraKind
  24833. * @returns an array of strings
  24834. */
  24835. getVerticesDataKinds(): string[];
  24836. /**
  24837. * Returns a positive integer : the total number of indices in this mesh geometry.
  24838. * @returns the numner of indices or zero if the mesh has no geometry.
  24839. */
  24840. getTotalIndices(): number;
  24841. /**
  24842. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  24843. * @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.
  24844. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  24845. * @returns the indices array or an empty array if the mesh has no geometry
  24846. */
  24847. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  24848. readonly isBlocked: boolean;
  24849. /**
  24850. * Determine if the current mesh is ready to be rendered
  24851. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  24852. * @param forceInstanceSupport will check if the mesh will be ready when used with instances (false by default)
  24853. * @returns true if all associated assets are ready (material, textures, shaders)
  24854. */
  24855. isReady(completeCheck?: boolean, forceInstanceSupport?: boolean): boolean;
  24856. /**
  24857. * 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.
  24858. */
  24859. readonly areNormalsFrozen: boolean;
  24860. /**
  24861. * 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.
  24862. * @returns the current mesh
  24863. */
  24864. freezeNormals(): Mesh;
  24865. /**
  24866. * 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
  24867. * @returns the current mesh
  24868. */
  24869. unfreezeNormals(): Mesh;
  24870. /**
  24871. * Sets a value overriding the instance count. Only applicable when custom instanced InterleavedVertexBuffer are used rather than InstancedMeshs
  24872. */
  24873. overridenInstanceCount: number;
  24874. /** @hidden */
  24875. _preActivate(): Mesh;
  24876. /** @hidden */
  24877. _preActivateForIntermediateRendering(renderId: number): Mesh;
  24878. /** @hidden */
  24879. _registerInstanceForRenderId(instance: InstancedMesh, renderId: number): Mesh;
  24880. /**
  24881. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  24882. * This means the mesh underlying bounding box and sphere are recomputed.
  24883. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  24884. * @returns the current mesh
  24885. */
  24886. refreshBoundingInfo(applySkeleton?: boolean): Mesh;
  24887. /** @hidden */
  24888. _createGlobalSubMesh(force: boolean): Nullable<SubMesh>;
  24889. /**
  24890. * This function will subdivide the mesh into multiple submeshes
  24891. * @param count defines the expected number of submeshes
  24892. */
  24893. subdivide(count: number): void;
  24894. /**
  24895. * Copy a FloatArray into a specific associated vertex buffer
  24896. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  24897. * - VertexBuffer.PositionKind
  24898. * - VertexBuffer.UVKind
  24899. * - VertexBuffer.UV2Kind
  24900. * - VertexBuffer.UV3Kind
  24901. * - VertexBuffer.UV4Kind
  24902. * - VertexBuffer.UV5Kind
  24903. * - VertexBuffer.UV6Kind
  24904. * - VertexBuffer.ColorKind
  24905. * - VertexBuffer.MatricesIndicesKind
  24906. * - VertexBuffer.MatricesIndicesExtraKind
  24907. * - VertexBuffer.MatricesWeightsKind
  24908. * - VertexBuffer.MatricesWeightsExtraKind
  24909. * @param data defines the data source
  24910. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  24911. * @param stride defines the data stride size (can be null)
  24912. * @returns the current mesh
  24913. */
  24914. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  24915. /**
  24916. * Delete a vertex buffer associated with this mesh
  24917. * @param kind defines which buffer to delete (positions, indices, normals, etc). Possible `kind` values :
  24918. * - VertexBuffer.PositionKind
  24919. * - VertexBuffer.UVKind
  24920. * - VertexBuffer.UV2Kind
  24921. * - VertexBuffer.UV3Kind
  24922. * - VertexBuffer.UV4Kind
  24923. * - VertexBuffer.UV5Kind
  24924. * - VertexBuffer.UV6Kind
  24925. * - VertexBuffer.ColorKind
  24926. * - VertexBuffer.MatricesIndicesKind
  24927. * - VertexBuffer.MatricesIndicesExtraKind
  24928. * - VertexBuffer.MatricesWeightsKind
  24929. * - VertexBuffer.MatricesWeightsExtraKind
  24930. */
  24931. removeVerticesData(kind: string): void;
  24932. /**
  24933. * Flags an associated vertex buffer as updatable
  24934. * @param kind defines which buffer to use (positions, indices, normals, etc). Possible `kind` values :
  24935. * - VertexBuffer.PositionKind
  24936. * - VertexBuffer.UVKind
  24937. * - VertexBuffer.UV2Kind
  24938. * - VertexBuffer.UV3Kind
  24939. * - VertexBuffer.UV4Kind
  24940. * - VertexBuffer.UV5Kind
  24941. * - VertexBuffer.UV6Kind
  24942. * - VertexBuffer.ColorKind
  24943. * - VertexBuffer.MatricesIndicesKind
  24944. * - VertexBuffer.MatricesIndicesExtraKind
  24945. * - VertexBuffer.MatricesWeightsKind
  24946. * - VertexBuffer.MatricesWeightsExtraKind
  24947. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  24948. */
  24949. markVerticesDataAsUpdatable(kind: string, updatable?: boolean): void;
  24950. /**
  24951. * Sets the mesh global Vertex Buffer
  24952. * @param buffer defines the buffer to use
  24953. * @returns the current mesh
  24954. */
  24955. setVerticesBuffer(buffer: VertexBuffer): Mesh;
  24956. /**
  24957. * Update a specific associated vertex buffer
  24958. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  24959. * - VertexBuffer.PositionKind
  24960. * - VertexBuffer.UVKind
  24961. * - VertexBuffer.UV2Kind
  24962. * - VertexBuffer.UV3Kind
  24963. * - VertexBuffer.UV4Kind
  24964. * - VertexBuffer.UV5Kind
  24965. * - VertexBuffer.UV6Kind
  24966. * - VertexBuffer.ColorKind
  24967. * - VertexBuffer.MatricesIndicesKind
  24968. * - VertexBuffer.MatricesIndicesExtraKind
  24969. * - VertexBuffer.MatricesWeightsKind
  24970. * - VertexBuffer.MatricesWeightsExtraKind
  24971. * @param data defines the data source
  24972. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  24973. * @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)
  24974. * @returns the current mesh
  24975. */
  24976. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  24977. /**
  24978. * This method updates the vertex positions of an updatable mesh according to the `positionFunction` returned values.
  24979. * @see http://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#other-shapes-updatemeshpositions
  24980. * @param positionFunction is a simple JS function what is passed the mesh `positions` array. It doesn't need to return anything
  24981. * @param computeNormals is a boolean (default true) to enable/disable the mesh normal recomputation after the vertex position update
  24982. * @returns the current mesh
  24983. */
  24984. updateMeshPositions(positionFunction: (data: FloatArray) => void, computeNormals?: boolean): Mesh;
  24985. /**
  24986. * Creates a un-shared specific occurence of the geometry for the mesh.
  24987. * @returns the current mesh
  24988. */
  24989. makeGeometryUnique(): Mesh;
  24990. /**
  24991. * Set the index buffer of this mesh
  24992. * @param indices defines the source data
  24993. * @param totalVertices defines the total number of vertices referenced by this index data (can be null)
  24994. * @param updatable defines if the updated index buffer must be flagged as updatable (default is false)
  24995. * @returns the current mesh
  24996. */
  24997. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): AbstractMesh;
  24998. /**
  24999. * Update the current index buffer
  25000. * @param indices defines the source data
  25001. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  25002. * @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)
  25003. * @returns the current mesh
  25004. */
  25005. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  25006. /**
  25007. * Invert the geometry to move from a right handed system to a left handed one.
  25008. * @returns the current mesh
  25009. */
  25010. toLeftHanded(): Mesh;
  25011. /** @hidden */
  25012. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  25013. /** @hidden */
  25014. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  25015. /**
  25016. * Registers for this mesh a javascript function called just before the rendering process
  25017. * @param func defines the function to call before rendering this mesh
  25018. * @returns the current mesh
  25019. */
  25020. registerBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  25021. /**
  25022. * Disposes a previously registered javascript function called before the rendering
  25023. * @param func defines the function to remove
  25024. * @returns the current mesh
  25025. */
  25026. unregisterBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  25027. /**
  25028. * Registers for this mesh a javascript function called just after the rendering is complete
  25029. * @param func defines the function to call after rendering this mesh
  25030. * @returns the current mesh
  25031. */
  25032. registerAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  25033. /**
  25034. * Disposes a previously registered javascript function called after the rendering.
  25035. * @param func defines the function to remove
  25036. * @returns the current mesh
  25037. */
  25038. unregisterAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  25039. /** @hidden */
  25040. _getInstancesRenderList(subMeshId: number, isReplacementMode?: boolean): _InstancesBatch;
  25041. /** @hidden */
  25042. _renderWithInstances(subMesh: SubMesh, fillMode: number, batch: _InstancesBatch, effect: Effect, engine: Engine): Mesh;
  25043. /** @hidden */
  25044. _processInstancedBuffers(visibleInstances: InstancedMesh[], renderSelf: boolean): void;
  25045. /** @hidden */
  25046. _processRendering(subMesh: SubMesh, effect: Effect, fillMode: number, batch: _InstancesBatch, hardwareInstancedRendering: boolean, onBeforeDraw: (isInstance: boolean, world: Matrix, effectiveMaterial?: Material) => void, effectiveMaterial?: Material): Mesh;
  25047. /** @hidden */
  25048. _rebuild(): void;
  25049. /** @hidden */
  25050. _freeze(): void;
  25051. /** @hidden */
  25052. _unFreeze(): void;
  25053. /**
  25054. * 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
  25055. * @param subMesh defines the subMesh to render
  25056. * @param enableAlphaMode defines if alpha mode can be changed
  25057. * @param effectiveMeshReplacement defines an optional mesh used to provide info for the rendering
  25058. * @returns the current mesh
  25059. */
  25060. render(subMesh: SubMesh, enableAlphaMode: boolean, effectiveMeshReplacement?: AbstractMesh): Mesh;
  25061. private _onBeforeDraw;
  25062. /**
  25063. * Renormalize the mesh and patch it up if there are no weights
  25064. * Similar to normalization by adding the weights compute the reciprocal and multiply all elements, this wil ensure that everything adds to 1.
  25065. * However in the case of zero weights then we set just a single influence to 1.
  25066. * We check in the function for extra's present and if so we use the normalizeSkinWeightsWithExtras rather than the FourWeights version.
  25067. */
  25068. cleanMatrixWeights(): void;
  25069. private normalizeSkinFourWeights;
  25070. private normalizeSkinWeightsAndExtra;
  25071. /**
  25072. * ValidateSkinning is used to determine that a mesh has valid skinning data along with skin metrics, if missing weights,
  25073. * or not normalized it is returned as invalid mesh the string can be used for console logs, or on screen messages to let
  25074. * the user know there was an issue with importing the mesh
  25075. * @returns a validation object with skinned, valid and report string
  25076. */
  25077. validateSkinning(): {
  25078. skinned: boolean;
  25079. valid: boolean;
  25080. report: string;
  25081. };
  25082. /** @hidden */
  25083. _checkDelayState(): Mesh;
  25084. private _queueLoad;
  25085. /**
  25086. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  25087. * A mesh is in the frustum if its bounding box intersects the frustum
  25088. * @param frustumPlanes defines the frustum to test
  25089. * @returns true if the mesh is in the frustum planes
  25090. */
  25091. isInFrustum(frustumPlanes: Plane[]): boolean;
  25092. /**
  25093. * Sets the mesh material by the material or multiMaterial `id` property
  25094. * @param id is a string identifying the material or the multiMaterial
  25095. * @returns the current mesh
  25096. */
  25097. setMaterialByID(id: string): Mesh;
  25098. /**
  25099. * Returns as a new array populated with the mesh material and/or skeleton, if any.
  25100. * @returns an array of IAnimatable
  25101. */
  25102. getAnimatables(): IAnimatable[];
  25103. /**
  25104. * Modifies the mesh geometry according to the passed transformation matrix.
  25105. * This method returns nothing but it really modifies the mesh even if it's originally not set as updatable.
  25106. * The mesh normals are modified using the same transformation.
  25107. * Note that, under the hood, this method sets a new VertexBuffer each call.
  25108. * @param transform defines the transform matrix to use
  25109. * @see http://doc.babylonjs.com/resources/baking_transformations
  25110. * @returns the current mesh
  25111. */
  25112. bakeTransformIntoVertices(transform: Matrix): Mesh;
  25113. /**
  25114. * Modifies the mesh geometry according to its own current World Matrix.
  25115. * The mesh World Matrix is then reset.
  25116. * This method returns nothing but really modifies the mesh even if it's originally not set as updatable.
  25117. * Note that, under the hood, this method sets a new VertexBuffer each call.
  25118. * @see http://doc.babylonjs.com/resources/baking_transformations
  25119. * @returns the current mesh
  25120. */
  25121. bakeCurrentTransformIntoVertices(): Mesh;
  25122. /** @hidden */
  25123. readonly _positions: Nullable<Vector3[]>;
  25124. /** @hidden */
  25125. _resetPointsArrayCache(): Mesh;
  25126. /** @hidden */
  25127. _generatePointsArray(): boolean;
  25128. /**
  25129. * Returns a new Mesh object generated from the current mesh properties.
  25130. * This method must not get confused with createInstance()
  25131. * @param name is a string, the name given to the new mesh
  25132. * @param newParent can be any Node object (default `null`)
  25133. * @param doNotCloneChildren allows/denies the recursive cloning of the original mesh children if any (default `false`)
  25134. * @param clonePhysicsImpostor allows/denies the cloning in the same time of the original mesh `body` used by the physics engine, if any (default `true`)
  25135. * @returns a new mesh
  25136. */
  25137. clone(name?: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean): Nullable<AbstractMesh>;
  25138. /**
  25139. * Releases resources associated with this mesh.
  25140. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  25141. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  25142. */
  25143. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  25144. /** @hidden */
  25145. _disposeInstanceSpecificData(): void;
  25146. /**
  25147. * Modifies the mesh geometry according to a displacement map.
  25148. * 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.
  25149. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  25150. * @param url is a string, the URL from the image file is to be downloaded.
  25151. * @param minHeight is the lower limit of the displacement.
  25152. * @param maxHeight is the upper limit of the displacement.
  25153. * @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.
  25154. * @param uvOffset is an optional vector2 used to offset UV.
  25155. * @param uvScale is an optional vector2 used to scale UV.
  25156. * @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.
  25157. * @returns the Mesh.
  25158. */
  25159. applyDisplacementMap(url: string, minHeight: number, maxHeight: number, onSuccess?: (mesh: Mesh) => void, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  25160. /**
  25161. * Modifies the mesh geometry according to a displacementMap buffer.
  25162. * 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.
  25163. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  25164. * @param buffer is a `Uint8Array` buffer containing series of `Uint8` lower than 255, the red, green, blue and alpha values of each successive pixel.
  25165. * @param heightMapWidth is the width of the buffer image.
  25166. * @param heightMapHeight is the height of the buffer image.
  25167. * @param minHeight is the lower limit of the displacement.
  25168. * @param maxHeight is the upper limit of the displacement.
  25169. * @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.
  25170. * @param uvOffset is an optional vector2 used to offset UV.
  25171. * @param uvScale is an optional vector2 used to scale UV.
  25172. * @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.
  25173. * @returns the Mesh.
  25174. */
  25175. applyDisplacementMapFromBuffer(buffer: Uint8Array, heightMapWidth: number, heightMapHeight: number, minHeight: number, maxHeight: number, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  25176. /**
  25177. * Modify the mesh to get a flat shading rendering.
  25178. * This means each mesh facet will then have its own normals. Usually new vertices are added in the mesh geometry to get this result.
  25179. * Warning : the mesh is really modified even if not set originally as updatable and, under the hood, a new VertexBuffer is allocated.
  25180. * @returns current mesh
  25181. */
  25182. convertToFlatShadedMesh(): Mesh;
  25183. /**
  25184. * This method removes all the mesh indices and add new vertices (duplication) in order to unfold facets into buffers.
  25185. * In other words, more vertices, no more indices and a single bigger VBO.
  25186. * The mesh is really modified even if not set originally as updatable. Under the hood, a new VertexBuffer is allocated.
  25187. * @returns current mesh
  25188. */
  25189. convertToUnIndexedMesh(): Mesh;
  25190. /**
  25191. * Inverses facet orientations.
  25192. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  25193. * @param flipNormals will also inverts the normals
  25194. * @returns current mesh
  25195. */
  25196. flipFaces(flipNormals?: boolean): Mesh;
  25197. /**
  25198. * Increase the number of facets and hence vertices in a mesh
  25199. * Vertex normals are interpolated from existing vertex normals
  25200. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  25201. * @param numberPerEdge the number of new vertices to add to each edge of a facet, optional default 1
  25202. */
  25203. increaseVertices(numberPerEdge: number): void;
  25204. /**
  25205. * Force adjacent facets to share vertices and remove any facets that have all vertices in a line
  25206. * This will undo any application of covertToFlatShadedMesh
  25207. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  25208. */
  25209. forceSharedVertices(): void;
  25210. /** @hidden */
  25211. static _instancedMeshFactory(name: string, mesh: Mesh): InstancedMesh;
  25212. /** @hidden */
  25213. static _PhysicsImpostorParser(scene: Scene, physicObject: IPhysicsEnabledObject, jsonObject: any): PhysicsImpostor;
  25214. /**
  25215. * Creates a new InstancedMesh object from the mesh model.
  25216. * @see http://doc.babylonjs.com/how_to/how_to_use_instances
  25217. * @param name defines the name of the new instance
  25218. * @returns a new InstancedMesh
  25219. */
  25220. createInstance(name: string): InstancedMesh;
  25221. /**
  25222. * Synchronises all the mesh instance submeshes to the current mesh submeshes, if any.
  25223. * After this call, all the mesh instances have the same submeshes than the current mesh.
  25224. * @returns the current mesh
  25225. */
  25226. synchronizeInstances(): Mesh;
  25227. /**
  25228. * Optimization of the mesh's indices, in case a mesh has duplicated vertices.
  25229. * The function will only reorder the indices and will not remove unused vertices to avoid problems with submeshes.
  25230. * This should be used together with the simplification to avoid disappearing triangles.
  25231. * @param successCallback an optional success callback to be called after the optimization finished.
  25232. * @returns the current mesh
  25233. */
  25234. optimizeIndices(successCallback?: (mesh?: Mesh) => void): Mesh;
  25235. /**
  25236. * Serialize current mesh
  25237. * @param serializationObject defines the object which will receive the serialization data
  25238. */
  25239. serialize(serializationObject: any): void;
  25240. /** @hidden */
  25241. _syncGeometryWithMorphTargetManager(): void;
  25242. /** @hidden */
  25243. static _GroundMeshParser: (parsedMesh: any, scene: Scene) => Mesh;
  25244. /**
  25245. * Returns a new Mesh object parsed from the source provided.
  25246. * @param parsedMesh is the source
  25247. * @param scene defines the hosting scene
  25248. * @param rootUrl is the root URL to prefix the `delayLoadingFile` property with
  25249. * @returns a new Mesh
  25250. */
  25251. static Parse(parsedMesh: any, scene: Scene, rootUrl: string): Mesh;
  25252. /**
  25253. * Creates a ribbon mesh. Please consider using the same method from the MeshBuilder class instead
  25254. * @see http://doc.babylonjs.com/how_to/parametric_shapes
  25255. * @param name defines the name of the mesh to create
  25256. * @param pathArray is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry.
  25257. * @param closeArray creates a seam between the first and the last paths of the path array (default is false)
  25258. * @param closePath creates a seam between the first and the last points of each path of the path array
  25259. * @param offset is taken in account only if the `pathArray` is containing a single path
  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 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)
  25264. * @returns a new Mesh
  25265. */
  25266. static CreateRibbon(name: string, pathArray: Vector3[][], closeArray: boolean, closePath: boolean, offset: number, scene?: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  25267. /**
  25268. * Creates a plane polygonal mesh. By default, this is a disc. Please consider using the same method from the MeshBuilder class instead
  25269. * @param name defines the name of the mesh to create
  25270. * @param radius sets the radius size (float) of the polygon (default 0.5)
  25271. * @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
  25272. * @param scene defines the hosting scene
  25273. * @param updatable defines if the mesh must be flagged as updatable
  25274. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25275. * @returns a new Mesh
  25276. */
  25277. static CreateDisc(name: string, radius: number, tessellation: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  25278. /**
  25279. * Creates a box mesh. Please consider using the same method from the MeshBuilder class instead
  25280. * @param name defines the name of the mesh to create
  25281. * @param size sets the size (float) of each box side (default 1)
  25282. * @param scene defines the hosting scene
  25283. * @param updatable defines if the mesh must be flagged as updatable
  25284. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25285. * @returns a new Mesh
  25286. */
  25287. static CreateBox(name: string, size: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  25288. /**
  25289. * Creates a sphere mesh. Please consider using the same method from the MeshBuilder class instead
  25290. * @param name defines the name of the mesh to create
  25291. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  25292. * @param diameter sets the diameter size (float) of the sphere (default 1)
  25293. * @param scene defines the hosting scene
  25294. * @param updatable defines if the mesh must be flagged as updatable
  25295. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25296. * @returns a new Mesh
  25297. */
  25298. static CreateSphere(name: string, segments: number, diameter: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  25299. /**
  25300. * Creates a hemisphere mesh. Please consider using the same method from the MeshBuilder class instead
  25301. * @param name defines the name of the mesh to create
  25302. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  25303. * @param diameter sets the diameter size (float) of the sphere (default 1)
  25304. * @param scene defines the hosting scene
  25305. * @returns a new Mesh
  25306. */
  25307. static CreateHemisphere(name: string, segments: number, diameter: number, scene?: Scene): Mesh;
  25308. /**
  25309. * Creates a cylinder or a cone mesh. Please consider using the same method from the MeshBuilder class instead
  25310. * @param name defines the name of the mesh to create
  25311. * @param height sets the height size (float) of the cylinder/cone (float, default 2)
  25312. * @param diameterTop set the top cap diameter (floats, default 1)
  25313. * @param diameterBottom set the bottom cap diameter (floats, default 1). This value can't be zero
  25314. * @param tessellation sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance
  25315. * @param subdivisions sets the number of rings along the cylinder height (positive integer, default 1)
  25316. * @param scene defines the hosting scene
  25317. * @param updatable defines if the mesh must be flagged as updatable
  25318. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25319. * @returns a new Mesh
  25320. */
  25321. static CreateCylinder(name: string, height: number, diameterTop: number, diameterBottom: number, tessellation: number, subdivisions: any, scene?: Scene, updatable?: any, sideOrientation?: number): Mesh;
  25322. /**
  25323. * Creates a torus mesh. Please consider using the same method from the MeshBuilder class instead
  25324. * @param name defines the name of the mesh to create
  25325. * @param diameter sets the diameter size (float) of the torus (default 1)
  25326. * @param thickness sets the diameter size of the tube of the torus (float, default 0.5)
  25327. * @param tessellation sets the number of torus sides (postive integer, default 16)
  25328. * @param scene defines the hosting scene
  25329. * @param updatable defines if the mesh must be flagged as updatable
  25330. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25331. * @returns a new Mesh
  25332. */
  25333. static CreateTorus(name: string, diameter: number, thickness: number, tessellation: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  25334. /**
  25335. * Creates a torus knot mesh. Please consider using the same method from the MeshBuilder class instead
  25336. * @param name defines the name of the mesh to create
  25337. * @param radius sets the global radius size (float) of the torus knot (default 2)
  25338. * @param tube sets the diameter size of the tube of the torus (float, default 0.5)
  25339. * @param radialSegments sets the number of sides on each tube segments (positive integer, default 32)
  25340. * @param tubularSegments sets the number of tubes to decompose the knot into (positive integer, default 32)
  25341. * @param p the number of windings on X axis (positive integers, default 2)
  25342. * @param q the number of windings on Y axis (positive integers, default 3)
  25343. * @param scene defines the hosting scene
  25344. * @param updatable defines if the mesh must be flagged as updatable
  25345. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25346. * @returns a new Mesh
  25347. */
  25348. static CreateTorusKnot(name: string, radius: number, tube: number, radialSegments: number, tubularSegments: number, p: number, q: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  25349. /**
  25350. * Creates a line mesh. Please consider using the same method from the MeshBuilder class instead.
  25351. * @param name defines the name of the mesh to create
  25352. * @param points is an array successive Vector3
  25353. * @param scene defines the hosting scene
  25354. * @param updatable defines if the mesh must be flagged as updatable
  25355. * @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).
  25356. * @returns a new Mesh
  25357. */
  25358. static CreateLines(name: string, points: Vector3[], scene?: Nullable<Scene>, updatable?: boolean, instance?: Nullable<LinesMesh>): LinesMesh;
  25359. /**
  25360. * Creates a dashed line mesh. Please consider using the same method from the MeshBuilder class instead
  25361. * @param name defines the name of the mesh to create
  25362. * @param points is an array successive Vector3
  25363. * @param dashSize is the size of the dashes relatively the dash number (positive float, default 3)
  25364. * @param gapSize is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  25365. * @param dashNb is the intended total number of dashes (positive integer, default 200)
  25366. * @param scene defines the hosting scene
  25367. * @param updatable defines if the mesh must be flagged as updatable
  25368. * @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)
  25369. * @returns a new Mesh
  25370. */
  25371. static CreateDashedLines(name: string, points: Vector3[], dashSize: number, gapSize: number, dashNb: number, scene?: Nullable<Scene>, updatable?: boolean, instance?: LinesMesh): LinesMesh;
  25372. /**
  25373. * Creates a polygon mesh.Please consider using the same method from the MeshBuilder class instead
  25374. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh.
  25375. * 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.
  25376. * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  25377. * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  25378. * Remember you can only change the shape positions, not their number when updating a polygon.
  25379. * @see http://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  25380. * @param name defines the name of the mesh to create
  25381. * @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
  25382. * @param scene defines the hosting scene
  25383. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  25384. * @param updatable defines if the mesh must be flagged as updatable
  25385. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25386. * @param earcutInjection can be used to inject your own earcut reference
  25387. * @returns a new Mesh
  25388. */
  25389. static CreatePolygon(name: string, shape: Vector3[], scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  25390. /**
  25391. * Creates an extruded polygon mesh, with depth in the Y direction. Please consider using the same method from the MeshBuilder class instead.
  25392. * @see http://doc.babylonjs.com/how_to/parametric_shapes#extruded-non-regular-polygon
  25393. * @param name defines the name of the mesh to create
  25394. * @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
  25395. * @param depth defines the height of extrusion
  25396. * @param scene defines the hosting scene
  25397. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  25398. * @param updatable defines if the mesh must be flagged as updatable
  25399. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25400. * @param earcutInjection can be used to inject your own earcut reference
  25401. * @returns a new Mesh
  25402. */
  25403. static ExtrudePolygon(name: string, shape: Vector3[], depth: number, scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  25404. /**
  25405. * Creates an extruded shape mesh.
  25406. * 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
  25407. * @see http://doc.babylonjs.com/how_to/parametric_shapes
  25408. * @see http://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  25409. * @param name defines the name of the mesh to create
  25410. * @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
  25411. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  25412. * @param scale is the value to scale the shape
  25413. * @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
  25414. * @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
  25415. * @param scene defines the hosting scene
  25416. * @param updatable defines if the mesh must be flagged as updatable
  25417. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25418. * @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)
  25419. * @returns a new Mesh
  25420. */
  25421. static ExtrudeShape(name: string, shape: Vector3[], path: Vector3[], scale: number, rotation: number, cap: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  25422. /**
  25423. * Creates an custom extruded shape mesh.
  25424. * The custom extrusion is a parametric shape.
  25425. * It has no predefined shape. Its final shape will depend on the input parameters.
  25426. * Please consider using the same method from the MeshBuilder class instead
  25427. * @see http://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  25428. * @param name defines the name of the mesh to create
  25429. * @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
  25430. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  25431. * @param scaleFunction is a custom Javascript function called on each path point
  25432. * @param rotationFunction is a custom Javascript function called on each path point
  25433. * @param ribbonCloseArray forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  25434. * @param ribbonClosePath forces the extrusion underlying ribbon to close its `pathArray`
  25435. * @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
  25436. * @param scene defines the hosting scene
  25437. * @param updatable defines if the mesh must be flagged as updatable
  25438. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25439. * @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)
  25440. * @returns a new Mesh
  25441. */
  25442. 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;
  25443. /**
  25444. * Creates lathe mesh.
  25445. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe.
  25446. * Please consider using the same method from the MeshBuilder class instead
  25447. * @param name defines the name of the mesh to create
  25448. * @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
  25449. * @param radius is the radius value of the lathe
  25450. * @param tessellation is the side number of the lathe.
  25451. * @param scene defines the hosting scene
  25452. * @param updatable defines if the mesh must be flagged as updatable
  25453. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25454. * @returns a new Mesh
  25455. */
  25456. static CreateLathe(name: string, shape: Vector3[], radius: number, tessellation: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  25457. /**
  25458. * Creates a plane mesh. Please consider using the same method from the MeshBuilder class instead
  25459. * @param name defines the name of the mesh to create
  25460. * @param size sets the size (float) of both sides of the plane at once (default 1)
  25461. * @param scene defines the hosting scene
  25462. * @param updatable defines if the mesh must be flagged as updatable
  25463. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25464. * @returns a new Mesh
  25465. */
  25466. static CreatePlane(name: string, size: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  25467. /**
  25468. * Creates a ground mesh.
  25469. * Please consider using the same method from the MeshBuilder class instead
  25470. * @param name defines the name of the mesh to create
  25471. * @param width set the width of the ground
  25472. * @param height set the height of the ground
  25473. * @param subdivisions sets the number of subdivisions per side
  25474. * @param scene defines the hosting scene
  25475. * @param updatable defines if the mesh must be flagged as updatable
  25476. * @returns a new Mesh
  25477. */
  25478. static CreateGround(name: string, width: number, height: number, subdivisions: number, scene?: Scene, updatable?: boolean): Mesh;
  25479. /**
  25480. * Creates a tiled ground mesh.
  25481. * Please consider using the same method from the MeshBuilder class instead
  25482. * @param name defines the name of the mesh to create
  25483. * @param xmin set the ground minimum X coordinate
  25484. * @param zmin set the ground minimum Y coordinate
  25485. * @param xmax set the ground maximum X coordinate
  25486. * @param zmax set the ground maximum Z coordinate
  25487. * @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
  25488. * @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
  25489. * @param scene defines the hosting scene
  25490. * @param updatable defines if the mesh must be flagged as updatable
  25491. * @returns a new Mesh
  25492. */
  25493. static CreateTiledGround(name: string, xmin: number, zmin: number, xmax: number, zmax: number, subdivisions: {
  25494. w: number;
  25495. h: number;
  25496. }, precision: {
  25497. w: number;
  25498. h: number;
  25499. }, scene: Scene, updatable?: boolean): Mesh;
  25500. /**
  25501. * Creates a ground mesh from a height map.
  25502. * Please consider using the same method from the MeshBuilder class instead
  25503. * @see http://doc.babylonjs.com/babylon101/height_map
  25504. * @param name defines the name of the mesh to create
  25505. * @param url sets the URL of the height map image resource
  25506. * @param width set the ground width size
  25507. * @param height set the ground height size
  25508. * @param subdivisions sets the number of subdivision per side
  25509. * @param minHeight is the minimum altitude on the ground
  25510. * @param maxHeight is the maximum altitude on the ground
  25511. * @param scene defines the hosting scene
  25512. * @param updatable defines if the mesh must be flagged as updatable
  25513. * @param onReady is a callback function that will be called once the mesh is built (the height map download can last some time)
  25514. * @param alphaFilter will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  25515. * @returns a new Mesh
  25516. */
  25517. 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;
  25518. /**
  25519. * Creates a tube mesh.
  25520. * The tube is a parametric shape.
  25521. * It has no predefined shape. Its final shape will depend on the input parameters.
  25522. * Please consider using the same method from the MeshBuilder class instead
  25523. * @see http://doc.babylonjs.com/how_to/parametric_shapes
  25524. * @param name defines the name of the mesh to create
  25525. * @param path is a required array of successive Vector3. It is the curve used as the axis of the tube
  25526. * @param radius sets the tube radius size
  25527. * @param tessellation is the number of sides on the tubular surface
  25528. * @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
  25529. * @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
  25530. * @param scene defines the hosting scene
  25531. * @param updatable defines if the mesh must be flagged as updatable
  25532. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  25533. * @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)
  25534. * @returns a new Mesh
  25535. */
  25536. static CreateTube(name: string, path: Vector3[], radius: number, tessellation: number, radiusFunction: {
  25537. (i: number, distance: number): number;
  25538. }, cap: number, scene: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  25539. /**
  25540. * Creates a polyhedron mesh.
  25541. * Please consider using the same method from the MeshBuilder class instead.
  25542. * * 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
  25543. * * The parameter `size` (positive float, default 1) sets the polygon size
  25544. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  25545. * * 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`
  25546. * * 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
  25547. * * 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)`)
  25548. * * 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
  25549. * * 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
  25550. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  25551. * * If you create a double-sided mesh, you can choose what parts of 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
  25552. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  25553. * @param name defines the name of the mesh to create
  25554. * @param options defines the options used to create the mesh
  25555. * @param scene defines the hosting scene
  25556. * @returns a new Mesh
  25557. */
  25558. static CreatePolyhedron(name: string, options: {
  25559. type?: number;
  25560. size?: number;
  25561. sizeX?: number;
  25562. sizeY?: number;
  25563. sizeZ?: number;
  25564. custom?: any;
  25565. faceUV?: Vector4[];
  25566. faceColors?: Color4[];
  25567. updatable?: boolean;
  25568. sideOrientation?: number;
  25569. }, scene: Scene): Mesh;
  25570. /**
  25571. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  25572. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  25573. * * 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`)
  25574. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  25575. * * 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
  25576. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  25577. * * If you create a double-sided mesh, you can choose what parts of 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
  25578. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  25579. * @param name defines the name of the mesh
  25580. * @param options defines the options used to create the mesh
  25581. * @param scene defines the hosting scene
  25582. * @returns a new Mesh
  25583. * @see http://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  25584. */
  25585. static CreateIcoSphere(name: string, options: {
  25586. radius?: number;
  25587. flat?: boolean;
  25588. subdivisions?: number;
  25589. sideOrientation?: number;
  25590. updatable?: boolean;
  25591. }, scene: Scene): Mesh;
  25592. /**
  25593. * Creates a decal mesh.
  25594. * Please consider using the same method from the MeshBuilder class instead.
  25595. * A decal is a mesh usually applied as a model onto the surface of another mesh
  25596. * @param name defines the name of the mesh
  25597. * @param sourceMesh defines the mesh receiving the decal
  25598. * @param position sets the position of the decal in world coordinates
  25599. * @param normal sets the normal of the mesh where the decal is applied onto in world coordinates
  25600. * @param size sets the decal scaling
  25601. * @param angle sets the angle to rotate the decal
  25602. * @returns a new Mesh
  25603. */
  25604. static CreateDecal(name: string, sourceMesh: AbstractMesh, position: Vector3, normal: Vector3, size: Vector3, angle: number): Mesh;
  25605. /**
  25606. * Prepare internal position array for software CPU skinning
  25607. * @returns original positions used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh
  25608. */
  25609. setPositionsForCPUSkinning(): Float32Array;
  25610. /**
  25611. * Prepare internal normal array for software CPU skinning
  25612. * @returns original normals used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh.
  25613. */
  25614. setNormalsForCPUSkinning(): Float32Array;
  25615. /**
  25616. * Updates the vertex buffer by applying transformation from the bones
  25617. * @param skeleton defines the skeleton to apply to current mesh
  25618. * @returns the current mesh
  25619. */
  25620. applySkeleton(skeleton: Skeleton): Mesh;
  25621. /**
  25622. * 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
  25623. * @param meshes defines the list of meshes to scan
  25624. * @returns an object `{min:` Vector3`, max:` Vector3`}`
  25625. */
  25626. static MinMax(meshes: AbstractMesh[]): {
  25627. min: Vector3;
  25628. max: Vector3;
  25629. };
  25630. /**
  25631. * Returns the center of the `{min:` Vector3`, max:` Vector3`}` or the center of MinMax vector3 computed from a mesh array
  25632. * @param meshesOrMinMaxVector could be an array of meshes or a `{min:` Vector3`, max:` Vector3`}` object
  25633. * @returns a vector3
  25634. */
  25635. static Center(meshesOrMinMaxVector: {
  25636. min: Vector3;
  25637. max: Vector3;
  25638. } | AbstractMesh[]): Vector3;
  25639. /**
  25640. * Merge the array of meshes into a single mesh for performance reasons.
  25641. * @param meshes defines he vertices source. They should all be of the same material. Entries can empty
  25642. * @param disposeSource when true (default), dispose of the vertices from the source meshes
  25643. * @param allow32BitsIndices when the sum of the vertices > 64k, this must be set to true
  25644. * @param meshSubclass when set, vertices inserted into this Mesh. Meshes can then be merged into a Mesh sub-class.
  25645. * @param subdivideWithSubMeshes when true (false default), subdivide mesh to his subMesh array with meshes source.
  25646. * @param multiMultiMaterials when true (false default), subdivide mesh and accept multiple multi materials, ignores subdivideWithSubMeshes.
  25647. * @returns a new mesh
  25648. */
  25649. static MergeMeshes(meshes: Array<Mesh>, disposeSource?: boolean, allow32BitsIndices?: boolean, meshSubclass?: Mesh, subdivideWithSubMeshes?: boolean, multiMultiMaterials?: boolean): Nullable<Mesh>;
  25650. /** @hidden */
  25651. addInstance(instance: InstancedMesh): void;
  25652. /** @hidden */
  25653. removeInstance(instance: InstancedMesh): void;
  25654. }
  25655. }
  25656. declare module "babylonjs/Cameras/camera" {
  25657. import { SmartArray } from "babylonjs/Misc/smartArray";
  25658. import { Observable } from "babylonjs/Misc/observable";
  25659. import { Nullable } from "babylonjs/types";
  25660. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  25661. import { Scene } from "babylonjs/scene";
  25662. import { Matrix, Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  25663. import { Node } from "babylonjs/node";
  25664. import { Mesh } from "babylonjs/Meshes/mesh";
  25665. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  25666. import { ICullable } from "babylonjs/Culling/boundingInfo";
  25667. import { Viewport } from "babylonjs/Maths/math.viewport";
  25668. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  25669. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  25670. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  25671. import { Ray } from "babylonjs/Culling/ray";
  25672. /**
  25673. * This is the base class of all the camera used in the application.
  25674. * @see http://doc.babylonjs.com/features/cameras
  25675. */
  25676. export class Camera extends Node {
  25677. /** @hidden */
  25678. static _createDefaultParsedCamera: (name: string, scene: Scene) => Camera;
  25679. /**
  25680. * This is the default projection mode used by the cameras.
  25681. * It helps recreating a feeling of perspective and better appreciate depth.
  25682. * This is the best way to simulate real life cameras.
  25683. */
  25684. static readonly PERSPECTIVE_CAMERA: number;
  25685. /**
  25686. * This helps creating camera with an orthographic mode.
  25687. * 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.
  25688. */
  25689. static readonly ORTHOGRAPHIC_CAMERA: number;
  25690. /**
  25691. * This is the default FOV mode for perspective cameras.
  25692. * This setting aligns the upper and lower bounds of the viewport to the upper and lower bounds of the camera frustum.
  25693. */
  25694. static readonly FOVMODE_VERTICAL_FIXED: number;
  25695. /**
  25696. * This setting aligns the left and right bounds of the viewport to the left and right bounds of the camera frustum.
  25697. */
  25698. static readonly FOVMODE_HORIZONTAL_FIXED: number;
  25699. /**
  25700. * This specifies ther is no need for a camera rig.
  25701. * Basically only one eye is rendered corresponding to the camera.
  25702. */
  25703. static readonly RIG_MODE_NONE: number;
  25704. /**
  25705. * Simulates a camera Rig with one blue eye and one red eye.
  25706. * This can be use with 3d blue and red glasses.
  25707. */
  25708. static readonly RIG_MODE_STEREOSCOPIC_ANAGLYPH: number;
  25709. /**
  25710. * Defines that both eyes of the camera will be rendered side by side with a parallel target.
  25711. */
  25712. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_PARALLEL: number;
  25713. /**
  25714. * Defines that both eyes of the camera will be rendered side by side with a none parallel target.
  25715. */
  25716. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_CROSSEYED: number;
  25717. /**
  25718. * Defines that both eyes of the camera will be rendered over under each other.
  25719. */
  25720. static readonly RIG_MODE_STEREOSCOPIC_OVERUNDER: number;
  25721. /**
  25722. * Defines that both eyes of the camera should be renderered in a VR mode (carbox).
  25723. */
  25724. static readonly RIG_MODE_VR: number;
  25725. /**
  25726. * Defines that both eyes of the camera should be renderered in a VR mode (webVR).
  25727. */
  25728. static readonly RIG_MODE_WEBVR: number;
  25729. /**
  25730. * Custom rig mode allowing rig cameras to be populated manually with any number of cameras
  25731. */
  25732. static readonly RIG_MODE_CUSTOM: number;
  25733. /**
  25734. * Defines if by default attaching controls should prevent the default javascript event to continue.
  25735. */
  25736. static ForceAttachControlToAlwaysPreventDefault: boolean;
  25737. /**
  25738. * Define the input manager associated with the camera.
  25739. */
  25740. inputs: CameraInputsManager<Camera>;
  25741. /** @hidden */
  25742. _position: Vector3;
  25743. /**
  25744. * Define the current local position of the camera in the scene
  25745. */
  25746. position: Vector3;
  25747. /**
  25748. * The vector the camera should consider as up.
  25749. * (default is Vector3(0, 1, 0) aka Vector3.Up())
  25750. */
  25751. upVector: Vector3;
  25752. /**
  25753. * Define the current limit on the left side for an orthographic camera
  25754. * In scene unit
  25755. */
  25756. orthoLeft: Nullable<number>;
  25757. /**
  25758. * Define the current limit on the right side for an orthographic camera
  25759. * In scene unit
  25760. */
  25761. orthoRight: Nullable<number>;
  25762. /**
  25763. * Define the current limit on the bottom side for an orthographic camera
  25764. * In scene unit
  25765. */
  25766. orthoBottom: Nullable<number>;
  25767. /**
  25768. * Define the current limit on the top side for an orthographic camera
  25769. * In scene unit
  25770. */
  25771. orthoTop: Nullable<number>;
  25772. /**
  25773. * Field Of View is set in Radians. (default is 0.8)
  25774. */
  25775. fov: number;
  25776. /**
  25777. * Define the minimum distance the camera can see from.
  25778. * This is important to note that the depth buffer are not infinite and the closer it starts
  25779. * the more your scene might encounter depth fighting issue.
  25780. */
  25781. minZ: number;
  25782. /**
  25783. * Define the maximum distance the camera can see to.
  25784. * This is important to note that the depth buffer are not infinite and the further it end
  25785. * the more your scene might encounter depth fighting issue.
  25786. */
  25787. maxZ: number;
  25788. /**
  25789. * Define the default inertia of the camera.
  25790. * This helps giving a smooth feeling to the camera movement.
  25791. */
  25792. inertia: number;
  25793. /**
  25794. * Define the mode of the camera (Camera.PERSPECTIVE_CAMERA or Camera.ORTHOGRAPHIC_CAMERA)
  25795. */
  25796. mode: number;
  25797. /**
  25798. * Define wether the camera is intermediate.
  25799. * This is useful to not present the output directly to the screen in case of rig without post process for instance
  25800. */
  25801. isIntermediate: boolean;
  25802. /**
  25803. * Define the viewport of the camera.
  25804. * This correspond to the portion of the screen the camera will render to in normalized 0 to 1 unit.
  25805. */
  25806. viewport: Viewport;
  25807. /**
  25808. * Restricts the camera to viewing objects with the same layerMask.
  25809. * A camera with a layerMask of 1 will render mesh.layerMask & camera.layerMask!== 0
  25810. */
  25811. layerMask: number;
  25812. /**
  25813. * fovMode sets the camera frustum bounds to the viewport bounds. (default is FOVMODE_VERTICAL_FIXED)
  25814. */
  25815. fovMode: number;
  25816. /**
  25817. * Rig mode of the camera.
  25818. * This is useful to create the camera with two "eyes" instead of one to create VR or stereoscopic scenes.
  25819. * This is normally controlled byt the camera themselves as internal use.
  25820. */
  25821. cameraRigMode: number;
  25822. /**
  25823. * Defines the distance between both "eyes" in case of a RIG
  25824. */
  25825. interaxialDistance: number;
  25826. /**
  25827. * Defines if stereoscopic rendering is done side by side or over under.
  25828. */
  25829. isStereoscopicSideBySide: boolean;
  25830. /**
  25831. * 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
  25832. * This is pretty helpfull if you wish to make a camera render to a texture you could reuse somewhere
  25833. * else in the scene. (Eg. security camera)
  25834. *
  25835. * 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)
  25836. */
  25837. customRenderTargets: import("babylonjs/Materials/Textures/renderTargetTexture").RenderTargetTexture[];
  25838. /**
  25839. * When set, the camera will render to this render target instead of the default canvas
  25840. *
  25841. * If the desire is to use the output of a camera as a texture in the scene consider using camera.customRenderTargets instead
  25842. */
  25843. outputRenderTarget: Nullable<RenderTargetTexture>;
  25844. /**
  25845. * Observable triggered when the camera view matrix has changed.
  25846. */
  25847. onViewMatrixChangedObservable: Observable<Camera>;
  25848. /**
  25849. * Observable triggered when the camera Projection matrix has changed.
  25850. */
  25851. onProjectionMatrixChangedObservable: Observable<Camera>;
  25852. /**
  25853. * Observable triggered when the inputs have been processed.
  25854. */
  25855. onAfterCheckInputsObservable: Observable<Camera>;
  25856. /**
  25857. * Observable triggered when reset has been called and applied to the camera.
  25858. */
  25859. onRestoreStateObservable: Observable<Camera>;
  25860. /** @hidden */
  25861. _cameraRigParams: any;
  25862. /** @hidden */
  25863. _rigCameras: Camera[];
  25864. /** @hidden */
  25865. _rigPostProcess: Nullable<PostProcess>;
  25866. protected _webvrViewMatrix: Matrix;
  25867. /** @hidden */
  25868. _skipRendering: boolean;
  25869. /** @hidden */
  25870. _projectionMatrix: Matrix;
  25871. /** @hidden */
  25872. _postProcesses: Nullable<import("babylonjs/PostProcesses/postProcess").PostProcess>[];
  25873. /** @hidden */
  25874. _activeMeshes: SmartArray<AbstractMesh>;
  25875. protected _globalPosition: Vector3;
  25876. /** @hidden */
  25877. _computedViewMatrix: Matrix;
  25878. private _doNotComputeProjectionMatrix;
  25879. private _transformMatrix;
  25880. private _frustumPlanes;
  25881. private _refreshFrustumPlanes;
  25882. private _storedFov;
  25883. private _stateStored;
  25884. /**
  25885. * Instantiates a new camera object.
  25886. * This should not be used directly but through the inherited cameras: ArcRotate, Free...
  25887. * @see http://doc.babylonjs.com/features/cameras
  25888. * @param name Defines the name of the camera in the scene
  25889. * @param position Defines the position of the camera
  25890. * @param scene Defines the scene the camera belongs too
  25891. * @param setActiveOnSceneIfNoneActive Defines if the camera should be set as active after creation if no other camera have been defined in the scene
  25892. */
  25893. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  25894. /**
  25895. * Store current camera state (fov, position, etc..)
  25896. * @returns the camera
  25897. */
  25898. storeState(): Camera;
  25899. /**
  25900. * Restores the camera state values if it has been stored. You must call storeState() first
  25901. */
  25902. protected _restoreStateValues(): boolean;
  25903. /**
  25904. * Restored camera state. You must call storeState() first.
  25905. * @returns true if restored and false otherwise
  25906. */
  25907. restoreState(): boolean;
  25908. /**
  25909. * Gets the class name of the camera.
  25910. * @returns the class name
  25911. */
  25912. getClassName(): string;
  25913. /** @hidden */
  25914. readonly _isCamera: boolean;
  25915. /**
  25916. * Gets a string representation of the camera useful for debug purpose.
  25917. * @param fullDetails Defines that a more verboe level of logging is required
  25918. * @returns the string representation
  25919. */
  25920. toString(fullDetails?: boolean): string;
  25921. /**
  25922. * Gets the current world space position of the camera.
  25923. */
  25924. readonly globalPosition: Vector3;
  25925. /**
  25926. * Gets the list of active meshes this frame (meshes no culled or excluded by lod s in the frame)
  25927. * @returns the active meshe list
  25928. */
  25929. getActiveMeshes(): SmartArray<AbstractMesh>;
  25930. /**
  25931. * Check wether a mesh is part of the current active mesh list of the camera
  25932. * @param mesh Defines the mesh to check
  25933. * @returns true if active, false otherwise
  25934. */
  25935. isActiveMesh(mesh: Mesh): boolean;
  25936. /**
  25937. * Is this camera ready to be used/rendered
  25938. * @param completeCheck defines if a complete check (including post processes) has to be done (false by default)
  25939. * @return true if the camera is ready
  25940. */
  25941. isReady(completeCheck?: boolean): boolean;
  25942. /** @hidden */
  25943. _initCache(): void;
  25944. /** @hidden */
  25945. _updateCache(ignoreParentClass?: boolean): void;
  25946. /** @hidden */
  25947. _isSynchronized(): boolean;
  25948. /** @hidden */
  25949. _isSynchronizedViewMatrix(): boolean;
  25950. /** @hidden */
  25951. _isSynchronizedProjectionMatrix(): boolean;
  25952. /**
  25953. * Attach the input controls to a specific dom element to get the input from.
  25954. * @param element Defines the element the controls should be listened from
  25955. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  25956. */
  25957. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  25958. /**
  25959. * Detach the current controls from the specified dom element.
  25960. * @param element Defines the element to stop listening the inputs from
  25961. */
  25962. detachControl(element: HTMLElement): void;
  25963. /**
  25964. * Update the camera state according to the different inputs gathered during the frame.
  25965. */
  25966. update(): void;
  25967. /** @hidden */
  25968. _checkInputs(): void;
  25969. /** @hidden */
  25970. readonly rigCameras: Camera[];
  25971. /**
  25972. * Gets the post process used by the rig cameras
  25973. */
  25974. readonly rigPostProcess: Nullable<PostProcess>;
  25975. /**
  25976. * Internal, gets the first post proces.
  25977. * @returns the first post process to be run on this camera.
  25978. */
  25979. _getFirstPostProcess(): Nullable<PostProcess>;
  25980. private _cascadePostProcessesToRigCams;
  25981. /**
  25982. * Attach a post process to the camera.
  25983. * @see http://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  25984. * @param postProcess The post process to attach to the camera
  25985. * @param insertAt The position of the post process in case several of them are in use in the scene
  25986. * @returns the position the post process has been inserted at
  25987. */
  25988. attachPostProcess(postProcess: PostProcess, insertAt?: Nullable<number>): number;
  25989. /**
  25990. * Detach a post process to the camera.
  25991. * @see http://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  25992. * @param postProcess The post process to detach from the camera
  25993. */
  25994. detachPostProcess(postProcess: PostProcess): void;
  25995. /**
  25996. * Gets the current world matrix of the camera
  25997. */
  25998. getWorldMatrix(): Matrix;
  25999. /** @hidden */
  26000. _getViewMatrix(): Matrix;
  26001. /**
  26002. * Gets the current view matrix of the camera.
  26003. * @param force forces the camera to recompute the matrix without looking at the cached state
  26004. * @returns the view matrix
  26005. */
  26006. getViewMatrix(force?: boolean): Matrix;
  26007. /**
  26008. * Freeze the projection matrix.
  26009. * It will prevent the cache check of the camera projection compute and can speed up perf
  26010. * if no parameter of the camera are meant to change
  26011. * @param projection Defines manually a projection if necessary
  26012. */
  26013. freezeProjectionMatrix(projection?: Matrix): void;
  26014. /**
  26015. * Unfreeze the projection matrix if it has previously been freezed by freezeProjectionMatrix.
  26016. */
  26017. unfreezeProjectionMatrix(): void;
  26018. /**
  26019. * Gets the current projection matrix of the camera.
  26020. * @param force forces the camera to recompute the matrix without looking at the cached state
  26021. * @returns the projection matrix
  26022. */
  26023. getProjectionMatrix(force?: boolean): Matrix;
  26024. /**
  26025. * Gets the transformation matrix (ie. the multiplication of view by projection matrices)
  26026. * @returns a Matrix
  26027. */
  26028. getTransformationMatrix(): Matrix;
  26029. private _updateFrustumPlanes;
  26030. /**
  26031. * Checks if a cullable object (mesh...) is in the camera frustum
  26032. * This checks the bounding box center. See isCompletelyInFrustum for a full bounding check
  26033. * @param target The object to check
  26034. * @param checkRigCameras If the rig cameras should be checked (eg. with webVR camera both eyes should be checked) (Default: false)
  26035. * @returns true if the object is in frustum otherwise false
  26036. */
  26037. isInFrustum(target: ICullable, checkRigCameras?: boolean): boolean;
  26038. /**
  26039. * Checks if a cullable object (mesh...) is in the camera frustum
  26040. * Unlike isInFrustum this cheks the full bounding box
  26041. * @param target The object to check
  26042. * @returns true if the object is in frustum otherwise false
  26043. */
  26044. isCompletelyInFrustum(target: ICullable): boolean;
  26045. /**
  26046. * Gets a ray in the forward direction from the camera.
  26047. * @param length Defines the length of the ray to create
  26048. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  26049. * @param origin Defines the start point of the ray which defaults to the camera position
  26050. * @returns the forward ray
  26051. */
  26052. getForwardRay(length?: number, transform?: Matrix, origin?: Vector3): Ray;
  26053. /**
  26054. * Releases resources associated with this node.
  26055. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  26056. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  26057. */
  26058. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  26059. /** @hidden */
  26060. _isLeftCamera: boolean;
  26061. /**
  26062. * Gets the left camera of a rig setup in case of Rigged Camera
  26063. */
  26064. readonly isLeftCamera: boolean;
  26065. /** @hidden */
  26066. _isRightCamera: boolean;
  26067. /**
  26068. * Gets the right camera of a rig setup in case of Rigged Camera
  26069. */
  26070. readonly isRightCamera: boolean;
  26071. /**
  26072. * Gets the left camera of a rig setup in case of Rigged Camera
  26073. */
  26074. readonly leftCamera: Nullable<FreeCamera>;
  26075. /**
  26076. * Gets the right camera of a rig setup in case of Rigged Camera
  26077. */
  26078. readonly rightCamera: Nullable<FreeCamera>;
  26079. /**
  26080. * Gets the left camera target of a rig setup in case of Rigged Camera
  26081. * @returns the target position
  26082. */
  26083. getLeftTarget(): Nullable<Vector3>;
  26084. /**
  26085. * Gets the right camera target of a rig setup in case of Rigged Camera
  26086. * @returns the target position
  26087. */
  26088. getRightTarget(): Nullable<Vector3>;
  26089. /**
  26090. * @hidden
  26091. */
  26092. setCameraRigMode(mode: number, rigParams: any): void;
  26093. /** @hidden */
  26094. static _setStereoscopicRigMode(camera: Camera): void;
  26095. /** @hidden */
  26096. static _setStereoscopicAnaglyphRigMode(camera: Camera): void;
  26097. /** @hidden */
  26098. static _setVRRigMode(camera: Camera, rigParams: any): void;
  26099. /** @hidden */
  26100. static _setWebVRRigMode(camera: Camera, rigParams: any): void;
  26101. /** @hidden */
  26102. _getVRProjectionMatrix(): Matrix;
  26103. protected _updateCameraRotationMatrix(): void;
  26104. protected _updateWebVRCameraRotationMatrix(): void;
  26105. /**
  26106. * This function MUST be overwritten by the different WebVR cameras available.
  26107. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  26108. * @hidden
  26109. */
  26110. _getWebVRProjectionMatrix(): Matrix;
  26111. /**
  26112. * This function MUST be overwritten by the different WebVR cameras available.
  26113. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  26114. * @hidden
  26115. */
  26116. _getWebVRViewMatrix(): Matrix;
  26117. /** @hidden */
  26118. setCameraRigParameter(name: string, value: any): void;
  26119. /**
  26120. * needs to be overridden by children so sub has required properties to be copied
  26121. * @hidden
  26122. */
  26123. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  26124. /**
  26125. * May need to be overridden by children
  26126. * @hidden
  26127. */
  26128. _updateRigCameras(): void;
  26129. /** @hidden */
  26130. _setupInputs(): void;
  26131. /**
  26132. * Serialiaze the camera setup to a json represention
  26133. * @returns the JSON representation
  26134. */
  26135. serialize(): any;
  26136. /**
  26137. * Clones the current camera.
  26138. * @param name The cloned camera name
  26139. * @returns the cloned camera
  26140. */
  26141. clone(name: string): Camera;
  26142. /**
  26143. * Gets the direction of the camera relative to a given local axis.
  26144. * @param localAxis Defines the reference axis to provide a relative direction.
  26145. * @return the direction
  26146. */
  26147. getDirection(localAxis: Vector3): Vector3;
  26148. /**
  26149. * Returns the current camera absolute rotation
  26150. */
  26151. readonly absoluteRotation: Quaternion;
  26152. /**
  26153. * Gets the direction of the camera relative to a given local axis into a passed vector.
  26154. * @param localAxis Defines the reference axis to provide a relative direction.
  26155. * @param result Defines the vector to store the result in
  26156. */
  26157. getDirectionToRef(localAxis: Vector3, result: Vector3): void;
  26158. /**
  26159. * Gets a camera constructor for a given camera type
  26160. * @param type The type of the camera to construct (should be equal to one of the camera class name)
  26161. * @param name The name of the camera the result will be able to instantiate
  26162. * @param scene The scene the result will construct the camera in
  26163. * @param interaxial_distance In case of stereoscopic setup, the distance between both eyes
  26164. * @param isStereoscopicSideBySide In case of stereoscopic setup, should the sereo be side b side
  26165. * @returns a factory method to construc the camera
  26166. */
  26167. static GetConstructorFromName(type: string, name: string, scene: Scene, interaxial_distance?: number, isStereoscopicSideBySide?: boolean): () => Camera;
  26168. /**
  26169. * Compute the world matrix of the camera.
  26170. * @returns the camera world matrix
  26171. */
  26172. computeWorldMatrix(): Matrix;
  26173. /**
  26174. * Parse a JSON and creates the camera from the parsed information
  26175. * @param parsedCamera The JSON to parse
  26176. * @param scene The scene to instantiate the camera in
  26177. * @returns the newly constructed camera
  26178. */
  26179. static Parse(parsedCamera: any, scene: Scene): Camera;
  26180. }
  26181. }
  26182. declare module "babylonjs/Meshes/Builders/discBuilder" {
  26183. import { Nullable } from "babylonjs/types";
  26184. import { Scene } from "babylonjs/scene";
  26185. import { Vector4 } from "babylonjs/Maths/math.vector";
  26186. import { Mesh } from "babylonjs/Meshes/mesh";
  26187. /**
  26188. * Class containing static functions to help procedurally build meshes
  26189. */
  26190. export class DiscBuilder {
  26191. /**
  26192. * Creates a plane polygonal mesh. By default, this is a disc
  26193. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  26194. * * 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
  26195. * * 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
  26196. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  26197. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  26198. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  26199. * @param name defines the name of the mesh
  26200. * @param options defines the options used to create the mesh
  26201. * @param scene defines the hosting scene
  26202. * @returns the plane polygonal mesh
  26203. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  26204. */
  26205. static CreateDisc(name: string, options: {
  26206. radius?: number;
  26207. tessellation?: number;
  26208. arc?: number;
  26209. updatable?: boolean;
  26210. sideOrientation?: number;
  26211. frontUVs?: Vector4;
  26212. backUVs?: Vector4;
  26213. }, scene?: Nullable<Scene>): Mesh;
  26214. }
  26215. }
  26216. declare module "babylonjs/Particles/solidParticleSystem" {
  26217. import { Nullable } from "babylonjs/types";
  26218. import { Vector3 } from "babylonjs/Maths/math.vector";
  26219. import { Mesh } from "babylonjs/Meshes/mesh";
  26220. import { Scene, IDisposable } from "babylonjs/scene";
  26221. import { DepthSortedParticle, SolidParticle } from "babylonjs/Particles/solidParticle";
  26222. /**
  26223. * The SPS is a single updatable mesh. The solid particles are simply separate parts or faces fo this big mesh.
  26224. *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.
  26225. * The SPS is also a particle system. It provides some methods to manage the particles.
  26226. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  26227. *
  26228. * Full documentation here : http://doc.babylonjs.com/how_to/Solid_Particle_System
  26229. */
  26230. export class SolidParticleSystem implements IDisposable {
  26231. /**
  26232. * The SPS array of Solid Particle objects. Just access each particle as with any classic array.
  26233. * Example : var p = SPS.particles[i];
  26234. */
  26235. particles: SolidParticle[];
  26236. /**
  26237. * The SPS total number of particles. Read only. Use SPS.counter instead if you need to set your own value.
  26238. */
  26239. nbParticles: number;
  26240. /**
  26241. * If the particles must ever face the camera (default false). Useful for planar particles.
  26242. */
  26243. billboard: boolean;
  26244. /**
  26245. * Recompute normals when adding a shape
  26246. */
  26247. recomputeNormals: boolean;
  26248. /**
  26249. * This a counter ofr your own usage. It's not set by any SPS functions.
  26250. */
  26251. counter: number;
  26252. /**
  26253. * The SPS name. This name is also given to the underlying mesh.
  26254. */
  26255. name: string;
  26256. /**
  26257. * The SPS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  26258. */
  26259. mesh: Mesh;
  26260. /**
  26261. * This empty object is intended to store some SPS specific or temporary values in order to lower the Garbage Collector activity.
  26262. * Please read : http://doc.babylonjs.com/how_to/Solid_Particle_System#garbage-collector-concerns
  26263. */
  26264. vars: any;
  26265. /**
  26266. * This array is populated when the SPS is set as 'pickable'.
  26267. * Each key of this array is a `faceId` value that you can get from a pickResult object.
  26268. * Each element of this array is an object `{idx: int, faceId: int}`.
  26269. * `idx` is the picked particle index in the `SPS.particles` array
  26270. * `faceId` is the picked face index counted within this particle.
  26271. * Please read : http://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  26272. */
  26273. pickedParticles: {
  26274. idx: number;
  26275. faceId: number;
  26276. }[];
  26277. /**
  26278. * This array is populated when `enableDepthSort` is set to true.
  26279. * Each element of this array is an instance of the class DepthSortedParticle.
  26280. */
  26281. depthSortedParticles: DepthSortedParticle[];
  26282. /**
  26283. * If the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster). (Internal use only)
  26284. * @hidden
  26285. */
  26286. _bSphereOnly: boolean;
  26287. /**
  26288. * A number to multiply the boundind sphere radius by in order to reduce it for instance. (Internal use only)
  26289. * @hidden
  26290. */
  26291. _bSphereRadiusFactor: number;
  26292. private _scene;
  26293. private _positions;
  26294. private _indices;
  26295. private _normals;
  26296. private _colors;
  26297. private _uvs;
  26298. private _indices32;
  26299. private _positions32;
  26300. private _normals32;
  26301. private _fixedNormal32;
  26302. private _colors32;
  26303. private _uvs32;
  26304. private _index;
  26305. private _updatable;
  26306. private _pickable;
  26307. private _isVisibilityBoxLocked;
  26308. private _alwaysVisible;
  26309. private _depthSort;
  26310. private _expandable;
  26311. private _shapeCounter;
  26312. private _copy;
  26313. private _color;
  26314. private _computeParticleColor;
  26315. private _computeParticleTexture;
  26316. private _computeParticleRotation;
  26317. private _computeParticleVertex;
  26318. private _computeBoundingBox;
  26319. private _depthSortParticles;
  26320. private _camera;
  26321. private _mustUnrotateFixedNormals;
  26322. private _particlesIntersect;
  26323. private _needs32Bits;
  26324. private _isNotBuilt;
  26325. private _lastParticleId;
  26326. private _idxOfId;
  26327. /**
  26328. * Creates a SPS (Solid Particle System) object.
  26329. * @param name (String) is the SPS name, this will be the underlying mesh name.
  26330. * @param scene (Scene) is the scene in which the SPS is added.
  26331. * @param options defines the options of the sps e.g.
  26332. * * updatable (optional boolean, default true) : if the SPS must be updatable or immutable.
  26333. * * isPickable (optional boolean, default false) : if the solid particles must be pickable.
  26334. * * enableDepthSort (optional boolean, default false) : if the solid particles must be sorted in the geometry according to their distance to the camera.
  26335. * * expandable (optional boolean, default false) : if particles can still be added after the initial SPS mesh creation.
  26336. * * particleIntersection (optional boolean, default false) : if the solid particle intersections must be computed.
  26337. * * boundingSphereOnly (optional boolean, default false) : if the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster).
  26338. * * bSphereRadiusFactor (optional float, default 1.0) : a number to multiply the boundind sphere radius by in order to reduce it for instance.
  26339. * @example bSphereRadiusFactor = 1.0 / Math.sqrt(3.0) => the bounding sphere exactly matches a spherical mesh.
  26340. */
  26341. constructor(name: string, scene: Scene, options?: {
  26342. updatable?: boolean;
  26343. isPickable?: boolean;
  26344. enableDepthSort?: boolean;
  26345. particleIntersection?: boolean;
  26346. boundingSphereOnly?: boolean;
  26347. bSphereRadiusFactor?: number;
  26348. expandable?: boolean;
  26349. });
  26350. /**
  26351. * Builds the SPS underlying mesh. Returns a standard Mesh.
  26352. * If no model shape was added to the SPS, the returned mesh is just a single triangular plane.
  26353. * @returns the created mesh
  26354. */
  26355. buildMesh(): Mesh;
  26356. /**
  26357. * Digests the mesh and generates as many solid particles in the system as wanted. Returns the SPS.
  26358. * These particles will have the same geometry than the mesh parts and will be positioned at the same localisation than the mesh original places.
  26359. * Thus the particles generated from `digest()` have their property `position` set yet.
  26360. * @param mesh ( Mesh ) is the mesh to be digested
  26361. * @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
  26362. * {delta} (optional integer, default 0) is the random extra number of facets per particle , each particle will have between `facetNb` and `facetNb + delta` facets
  26363. * {number} (optional positive integer) is the wanted number of particles : each particle is built with `mesh_total_facets / number` facets
  26364. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  26365. * @returns the current SPS
  26366. */
  26367. digest(mesh: Mesh, options?: {
  26368. facetNb?: number;
  26369. number?: number;
  26370. delta?: number;
  26371. storage?: [];
  26372. }): SolidParticleSystem;
  26373. /**
  26374. * Unrotate the fixed normals in case the mesh was built with pre-rotated particles, ex : use of positionFunction in addShape()
  26375. * @hidden
  26376. */
  26377. private _unrotateFixedNormals;
  26378. /**
  26379. * Resets the temporary working copy particle
  26380. * @hidden
  26381. */
  26382. private _resetCopy;
  26383. /**
  26384. * Inserts the shape model geometry in the global SPS mesh by updating the positions, indices, normals, colors, uvs arrays
  26385. * @param p the current index in the positions array to be updated
  26386. * @param shape a Vector3 array, the shape geometry
  26387. * @param positions the positions array to be updated
  26388. * @param meshInd the shape indices array
  26389. * @param indices the indices array to be updated
  26390. * @param meshUV the shape uv array
  26391. * @param uvs the uv array to be updated
  26392. * @param meshCol the shape color array
  26393. * @param colors the color array to be updated
  26394. * @param meshNor the shape normals array
  26395. * @param normals the normals array to be updated
  26396. * @param idx the particle index
  26397. * @param idxInShape the particle index in its shape
  26398. * @param options the addShape() method passed options
  26399. * @hidden
  26400. */
  26401. private _meshBuilder;
  26402. /**
  26403. * Returns a shape Vector3 array from positions float array
  26404. * @param positions float array
  26405. * @returns a vector3 array
  26406. * @hidden
  26407. */
  26408. private _posToShape;
  26409. /**
  26410. * Returns a shapeUV array from a float uvs (array deep copy)
  26411. * @param uvs as a float array
  26412. * @returns a shapeUV array
  26413. * @hidden
  26414. */
  26415. private _uvsToShapeUV;
  26416. /**
  26417. * Adds a new particle object in the particles array
  26418. * @param idx particle index in particles array
  26419. * @param id particle id
  26420. * @param idxpos positionIndex : the starting index of the particle vertices in the SPS "positions" array
  26421. * @param idxind indiceIndex : he starting index of the particle indices in the SPS "indices" array
  26422. * @param model particle ModelShape object
  26423. * @param shapeId model shape identifier
  26424. * @param idxInShape index of the particle in the current model
  26425. * @param bInfo model bounding info object
  26426. * @param storage target storage array, if any
  26427. * @hidden
  26428. */
  26429. private _addParticle;
  26430. /**
  26431. * Adds some particles to the SPS from the model shape. Returns the shape id.
  26432. * Please read the doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#create-an-immutable-sps
  26433. * @param mesh is any Mesh object that will be used as a model for the solid particles.
  26434. * @param nb (positive integer) the number of particles to be created from this model
  26435. * @param options {positionFunction} is an optional javascript function to called for each particle on SPS creation.
  26436. * {vertexFunction} is an optional javascript function to called for each vertex of each particle on SPS creation
  26437. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  26438. * @returns the number of shapes in the system
  26439. */
  26440. addShape(mesh: Mesh, nb: number, options?: {
  26441. positionFunction?: any;
  26442. vertexFunction?: any;
  26443. storage?: [];
  26444. }): number;
  26445. /**
  26446. * Rebuilds a particle back to its just built status : if needed, recomputes the custom positions and vertices
  26447. * @hidden
  26448. */
  26449. private _rebuildParticle;
  26450. /**
  26451. * Rebuilds the whole mesh and updates the VBO : custom positions and vertices are recomputed if needed.
  26452. * @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.
  26453. * @returns the SPS.
  26454. */
  26455. rebuildMesh(reset?: boolean): SolidParticleSystem;
  26456. /** Removes the particles from the start-th to the end-th included from an expandable SPS (required).
  26457. * Returns an array with the removed particles.
  26458. * 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.
  26459. * The SPS can't be empty so at least one particle needs to remain in place.
  26460. * Under the hood, the VertexData array, so the VBO buffer, is recreated each call.
  26461. * @param start index of the first particle to remove
  26462. * @param end index of the last particle to remove (included)
  26463. * @returns an array populated with the removed particles
  26464. */
  26465. removeParticles(start: number, end: number): SolidParticle[];
  26466. /**
  26467. * Inserts some pre-created particles in the solid particle system so that they can be managed by setParticles().
  26468. * @param solidParticleArray an array populated with Solid Particles objects
  26469. * @returns the SPS
  26470. */
  26471. insertParticlesFromArray(solidParticleArray: SolidParticle[]): SolidParticleSystem;
  26472. /**
  26473. * Creates a new particle and modifies the SPS mesh geometry :
  26474. * - calls _meshBuilder() to increase the SPS mesh geometry step by step
  26475. * - calls _addParticle() to populate the particle array
  26476. * factorized code from addShape() and insertParticlesFromArray()
  26477. * @param idx particle index in the particles array
  26478. * @param i particle index in its shape
  26479. * @param modelShape particle ModelShape object
  26480. * @param shape shape vertex array
  26481. * @param meshInd shape indices array
  26482. * @param meshUV shape uv array
  26483. * @param meshCol shape color array
  26484. * @param meshNor shape normals array
  26485. * @param bbInfo shape bounding info
  26486. * @param storage target particle storage
  26487. * @options addShape() passed options
  26488. * @hidden
  26489. */
  26490. private _insertNewParticle;
  26491. /**
  26492. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  26493. * This method calls `updateParticle()` for each particle of the SPS.
  26494. * For an animated SPS, it is usually called within the render loop.
  26495. * 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.
  26496. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  26497. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  26498. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  26499. * @returns the SPS.
  26500. */
  26501. setParticles(start?: number, end?: number, update?: boolean): SolidParticleSystem;
  26502. /**
  26503. * Disposes the SPS.
  26504. */
  26505. dispose(): void;
  26506. /**
  26507. * Returns a SolidParticle object from its identifier : particle.id
  26508. * @param id (integer) the particle Id
  26509. * @returns the searched particle or null if not found in the SPS.
  26510. */
  26511. getParticleById(id: number): Nullable<SolidParticle>;
  26512. /**
  26513. * Returns a new array populated with the particles having the passed shapeId.
  26514. * @param shapeId (integer) the shape identifier
  26515. * @returns a new solid particle array
  26516. */
  26517. getParticlesByShapeId(shapeId: number): SolidParticle[];
  26518. /**
  26519. * Populates the passed array "ref" with the particles having the passed shapeId.
  26520. * @param shapeId the shape identifier
  26521. * @returns the SPS
  26522. * @param ref
  26523. */
  26524. getParticlesByShapeIdToRef(shapeId: number, ref: SolidParticle[]): SolidParticleSystem;
  26525. /**
  26526. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  26527. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  26528. * @returns the SPS.
  26529. */
  26530. refreshVisibleSize(): SolidParticleSystem;
  26531. /**
  26532. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  26533. * @param size the size (float) of the visibility box
  26534. * note : this doesn't lock the SPS mesh bounding box.
  26535. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  26536. */
  26537. setVisibilityBox(size: number): void;
  26538. /**
  26539. * Gets whether the SPS as always visible or not
  26540. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  26541. */
  26542. /**
  26543. * Sets the SPS as always visible or not
  26544. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  26545. */
  26546. isAlwaysVisible: boolean;
  26547. /**
  26548. * Sets the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  26549. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  26550. */
  26551. /**
  26552. * Gets if the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  26553. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  26554. */
  26555. isVisibilityBoxLocked: boolean;
  26556. /**
  26557. * Tells to `setParticles()` to compute the particle rotations or not.
  26558. * Default value : true. The SPS is faster when it's set to false.
  26559. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  26560. */
  26561. /**
  26562. * Gets if `setParticles()` computes the particle rotations or not.
  26563. * Default value : true. The SPS is faster when it's set to false.
  26564. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  26565. */
  26566. computeParticleRotation: boolean;
  26567. /**
  26568. * Tells to `setParticles()` to compute the particle colors or not.
  26569. * Default value : true. The SPS is faster when it's set to false.
  26570. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  26571. */
  26572. /**
  26573. * Gets if `setParticles()` computes the particle colors or not.
  26574. * Default value : true. The SPS is faster when it's set to false.
  26575. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  26576. */
  26577. computeParticleColor: boolean;
  26578. /**
  26579. * Gets if `setParticles()` computes the particle textures or not.
  26580. * Default value : true. The SPS is faster when it's set to false.
  26581. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  26582. */
  26583. computeParticleTexture: boolean;
  26584. /**
  26585. * Tells to `setParticles()` to call the vertex function for each vertex of each particle, or not.
  26586. * Default value : false. The SPS is faster when it's set to false.
  26587. * Note : the particle custom vertex positions aren't stored values.
  26588. */
  26589. /**
  26590. * Gets if `setParticles()` calls the vertex function for each vertex of each particle, or not.
  26591. * Default value : false. The SPS is faster when it's set to false.
  26592. * Note : the particle custom vertex positions aren't stored values.
  26593. */
  26594. computeParticleVertex: boolean;
  26595. /**
  26596. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  26597. */
  26598. /**
  26599. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  26600. */
  26601. computeBoundingBox: boolean;
  26602. /**
  26603. * Tells to `setParticles()` to sort or not the distance between each particle and the camera.
  26604. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  26605. * Default : `true`
  26606. */
  26607. /**
  26608. * Gets if `setParticles()` sorts or not the distance between each particle and the camera.
  26609. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  26610. * Default : `true`
  26611. */
  26612. depthSortParticles: boolean;
  26613. /**
  26614. * Gets if the SPS is created as expandable at construction time.
  26615. * Default : `false`
  26616. */
  26617. readonly expandable: boolean;
  26618. /**
  26619. * This function does nothing. It may be overwritten to set all the particle first values.
  26620. * The SPS doesn't call this function, you may have to call it by your own.
  26621. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  26622. */
  26623. initParticles(): void;
  26624. /**
  26625. * This function does nothing. It may be overwritten to recycle a particle.
  26626. * The SPS doesn't call this function, you may have to call it by your own.
  26627. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  26628. * @param particle The particle to recycle
  26629. * @returns the recycled particle
  26630. */
  26631. recycleParticle(particle: SolidParticle): SolidParticle;
  26632. /**
  26633. * Updates a particle : this function should be overwritten by the user.
  26634. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  26635. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  26636. * @example : just set a particle position or velocity and recycle conditions
  26637. * @param particle The particle to update
  26638. * @returns the updated particle
  26639. */
  26640. updateParticle(particle: SolidParticle): SolidParticle;
  26641. /**
  26642. * Updates a vertex of a particle : it can be overwritten by the user.
  26643. * This will be called on each vertex particle by `setParticles()` if `computeParticleVertex` is set to true only.
  26644. * @param particle the current particle
  26645. * @param vertex the current index of the current particle
  26646. * @param pt the index of the current vertex in the particle shape
  26647. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#update-each-particle-shape
  26648. * @example : just set a vertex particle position
  26649. * @returns the updated vertex
  26650. */
  26651. updateParticleVertex(particle: SolidParticle, vertex: Vector3, pt: number): Vector3;
  26652. /**
  26653. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  26654. * This does nothing and may be overwritten by the user.
  26655. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  26656. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  26657. * @param update the boolean update value actually passed to setParticles()
  26658. */
  26659. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  26660. /**
  26661. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  26662. * This will be passed three parameters.
  26663. * This does nothing and may be overwritten by the user.
  26664. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  26665. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  26666. * @param update the boolean update value actually passed to setParticles()
  26667. */
  26668. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  26669. }
  26670. }
  26671. declare module "babylonjs/Particles/solidParticle" {
  26672. import { Nullable } from "babylonjs/types";
  26673. import { Vector3, Matrix, Quaternion, Vector4 } from "babylonjs/Maths/math.vector";
  26674. import { Color4 } from "babylonjs/Maths/math.color";
  26675. import { Mesh } from "babylonjs/Meshes/mesh";
  26676. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  26677. import { SolidParticleSystem } from "babylonjs/Particles/solidParticleSystem";
  26678. import { Plane } from "babylonjs/Maths/math.plane";
  26679. /**
  26680. * Represents one particle of a solid particle system.
  26681. */
  26682. export class SolidParticle {
  26683. /**
  26684. * particle global index
  26685. */
  26686. idx: number;
  26687. /**
  26688. * particle identifier
  26689. */
  26690. id: number;
  26691. /**
  26692. * The color of the particle
  26693. */
  26694. color: Nullable<Color4>;
  26695. /**
  26696. * The world space position of the particle.
  26697. */
  26698. position: Vector3;
  26699. /**
  26700. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  26701. */
  26702. rotation: Vector3;
  26703. /**
  26704. * The world space rotation quaternion of the particle.
  26705. */
  26706. rotationQuaternion: Nullable<Quaternion>;
  26707. /**
  26708. * The scaling of the particle.
  26709. */
  26710. scaling: Vector3;
  26711. /**
  26712. * The uvs of the particle.
  26713. */
  26714. uvs: Vector4;
  26715. /**
  26716. * The current speed of the particle.
  26717. */
  26718. velocity: Vector3;
  26719. /**
  26720. * The pivot point in the particle local space.
  26721. */
  26722. pivot: Vector3;
  26723. /**
  26724. * Must the particle be translated from its pivot point in its local space ?
  26725. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  26726. * Default : false
  26727. */
  26728. translateFromPivot: boolean;
  26729. /**
  26730. * Is the particle active or not ?
  26731. */
  26732. alive: boolean;
  26733. /**
  26734. * Is the particle visible or not ?
  26735. */
  26736. isVisible: boolean;
  26737. /**
  26738. * Index of this particle in the global "positions" array (Internal use)
  26739. * @hidden
  26740. */
  26741. _pos: number;
  26742. /**
  26743. * @hidden Index of this particle in the global "indices" array (Internal use)
  26744. */
  26745. _ind: number;
  26746. /**
  26747. * @hidden ModelShape of this particle (Internal use)
  26748. */
  26749. _model: ModelShape;
  26750. /**
  26751. * ModelShape id of this particle
  26752. */
  26753. shapeId: number;
  26754. /**
  26755. * Index of the particle in its shape id
  26756. */
  26757. idxInShape: number;
  26758. /**
  26759. * @hidden Reference to the shape model BoundingInfo object (Internal use)
  26760. */
  26761. _modelBoundingInfo: BoundingInfo;
  26762. /**
  26763. * @hidden Particle BoundingInfo object (Internal use)
  26764. */
  26765. _boundingInfo: BoundingInfo;
  26766. /**
  26767. * @hidden Reference to the SPS what the particle belongs to (Internal use)
  26768. */
  26769. _sps: SolidParticleSystem;
  26770. /**
  26771. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  26772. */
  26773. _stillInvisible: boolean;
  26774. /**
  26775. * @hidden Last computed particle rotation matrix
  26776. */
  26777. _rotationMatrix: number[];
  26778. /**
  26779. * Parent particle Id, if any.
  26780. * Default null.
  26781. */
  26782. parentId: Nullable<number>;
  26783. /**
  26784. * The culling strategy to use to check whether the solid particle must be culled or not when using isInFrustum().
  26785. * The possible values are :
  26786. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  26787. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  26788. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  26789. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  26790. * The default value for solid particles is AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  26791. * Please read each static variable documentation in the class AbstractMesh to get details about the culling process.
  26792. * */
  26793. cullingStrategy: number;
  26794. /**
  26795. * @hidden Internal global position in the SPS.
  26796. */
  26797. _globalPosition: Vector3;
  26798. /**
  26799. * Creates a Solid Particle object.
  26800. * Don't create particles manually, use instead the Solid Particle System internal tools like _addParticle()
  26801. * @param particleIndex (integer) is the particle index in the Solid Particle System pool.
  26802. * @param particleId (integer) is the particle identifier. Unless some particles are removed from the SPS, it's the same value than the particle idx.
  26803. * @param positionIndex (integer) is the starting index of the particle vertices in the SPS "positions" array.
  26804. * @param indiceIndex (integer) is the starting index of the particle indices in the SPS "indices" array.
  26805. * @param model (ModelShape) is a reference to the model shape on what the particle is designed.
  26806. * @param shapeId (integer) is the model shape identifier in the SPS.
  26807. * @param idxInShape (integer) is the index of the particle in the current model (ex: the 10th box of addShape(box, 30))
  26808. * @param sps defines the sps it is associated to
  26809. * @param modelBoundingInfo is the reference to the model BoundingInfo used for intersection computations.
  26810. */
  26811. constructor(particleIndex: number, particleId: number, positionIndex: number, indiceIndex: number, model: Nullable<ModelShape>, shapeId: number, idxInShape: number, sps: SolidParticleSystem, modelBoundingInfo?: Nullable<BoundingInfo>);
  26812. /**
  26813. * Copies the particle property values into the existing target : position, rotation, scaling, uvs, colors, pivot, parent, visibility, alive
  26814. * @param target the particle target
  26815. * @returns the current particle
  26816. */
  26817. copyToRef(target: SolidParticle): SolidParticle;
  26818. /**
  26819. * Legacy support, changed scale to scaling
  26820. */
  26821. /**
  26822. * Legacy support, changed scale to scaling
  26823. */
  26824. scale: Vector3;
  26825. /**
  26826. * Legacy support, changed quaternion to rotationQuaternion
  26827. */
  26828. /**
  26829. * Legacy support, changed quaternion to rotationQuaternion
  26830. */
  26831. quaternion: Nullable<Quaternion>;
  26832. /**
  26833. * Returns a boolean. True if the particle intersects another particle or another mesh, else false.
  26834. * The intersection is computed on the particle bounding sphere and Axis Aligned Bounding Box (AABB)
  26835. * @param target is the object (solid particle or mesh) what the intersection is computed against.
  26836. * @returns true if it intersects
  26837. */
  26838. intersectsMesh(target: Mesh | SolidParticle): boolean;
  26839. /**
  26840. * Returns `true` if the solid particle is within the frustum defined by the passed array of planes.
  26841. * A particle is in the frustum if its bounding box intersects the frustum
  26842. * @param frustumPlanes defines the frustum to test
  26843. * @returns true if the particle is in the frustum planes
  26844. */
  26845. isInFrustum(frustumPlanes: Plane[]): boolean;
  26846. /**
  26847. * get the rotation matrix of the particle
  26848. * @hidden
  26849. */
  26850. getRotationMatrix(m: Matrix): void;
  26851. }
  26852. /**
  26853. * Represents the shape of the model used by one particle of a solid particle system.
  26854. * SPS internal tool, don't use it manually.
  26855. */
  26856. export class ModelShape {
  26857. /**
  26858. * The shape id
  26859. * @hidden
  26860. */
  26861. shapeID: number;
  26862. /**
  26863. * flat array of model positions (internal use)
  26864. * @hidden
  26865. */
  26866. _shape: Vector3[];
  26867. /**
  26868. * flat array of model UVs (internal use)
  26869. * @hidden
  26870. */
  26871. _shapeUV: number[];
  26872. /**
  26873. * color array of the model
  26874. * @hidden
  26875. */
  26876. _shapeColors: number[];
  26877. /**
  26878. * indices array of the model
  26879. * @hidden
  26880. */
  26881. _indices: number[];
  26882. /**
  26883. * normals array of the model
  26884. * @hidden
  26885. */
  26886. _normals: number[];
  26887. /**
  26888. * length of the shape in the model indices array (internal use)
  26889. * @hidden
  26890. */
  26891. _indicesLength: number;
  26892. /**
  26893. * Custom position function (internal use)
  26894. * @hidden
  26895. */
  26896. _positionFunction: Nullable<(particle: SolidParticle, i: number, s: number) => void>;
  26897. /**
  26898. * Custom vertex function (internal use)
  26899. * @hidden
  26900. */
  26901. _vertexFunction: Nullable<(particle: SolidParticle, vertex: Vector3, i: number) => void>;
  26902. /**
  26903. * 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.
  26904. * SPS internal tool, don't use it manually.
  26905. * @hidden
  26906. */
  26907. 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>);
  26908. }
  26909. /**
  26910. * Represents a Depth Sorted Particle in the solid particle system.
  26911. */
  26912. export class DepthSortedParticle {
  26913. /**
  26914. * Index of the particle in the "indices" array
  26915. */
  26916. ind: number;
  26917. /**
  26918. * Length of the particle shape in the "indices" array
  26919. */
  26920. indicesLength: number;
  26921. /**
  26922. * Squared distance from the particle to the camera
  26923. */
  26924. sqDistance: number;
  26925. }
  26926. }
  26927. declare module "babylonjs/Collisions/meshCollisionData" {
  26928. import { Collider } from "babylonjs/Collisions/collider";
  26929. import { Vector3 } from "babylonjs/Maths/math.vector";
  26930. import { Nullable } from "babylonjs/types";
  26931. import { Observer } from "babylonjs/Misc/observable";
  26932. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  26933. /**
  26934. * @hidden
  26935. */
  26936. export class _MeshCollisionData {
  26937. _checkCollisions: boolean;
  26938. _collisionMask: number;
  26939. _collisionGroup: number;
  26940. _collider: Nullable<Collider>;
  26941. _oldPositionForCollisions: Vector3;
  26942. _diffPositionForCollisions: Vector3;
  26943. _onCollideObserver: Nullable<Observer<AbstractMesh>>;
  26944. _onCollisionPositionChangeObserver: Nullable<Observer<Vector3>>;
  26945. }
  26946. }
  26947. declare module "babylonjs/Meshes/abstractMesh" {
  26948. import { Observable } from "babylonjs/Misc/observable";
  26949. import { Nullable, FloatArray, IndicesArray, DeepImmutable } from "babylonjs/types";
  26950. import { Camera } from "babylonjs/Cameras/camera";
  26951. import { Scene, IDisposable } from "babylonjs/scene";
  26952. import { Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  26953. import { Node } from "babylonjs/node";
  26954. import { IGetSetVerticesData } from "babylonjs/Meshes/mesh.vertexData";
  26955. import { TransformNode } from "babylonjs/Meshes/transformNode";
  26956. import { SubMesh } from "babylonjs/Meshes/subMesh";
  26957. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  26958. import { ICullable, BoundingInfo } from "babylonjs/Culling/boundingInfo";
  26959. import { Material } from "babylonjs/Materials/material";
  26960. import { Light } from "babylonjs/Lights/light";
  26961. import { Skeleton } from "babylonjs/Bones/skeleton";
  26962. import { IEdgesRenderer } from "babylonjs/Rendering/edgesRenderer";
  26963. import { SolidParticle } from "babylonjs/Particles/solidParticle";
  26964. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  26965. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  26966. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  26967. import { Plane } from "babylonjs/Maths/math.plane";
  26968. import { Ray } from "babylonjs/Culling/ray";
  26969. import { Collider } from "babylonjs/Collisions/collider";
  26970. import { TrianglePickingPredicate } from "babylonjs/Culling/ray";
  26971. import { RenderingGroup } from "babylonjs/Rendering/renderingGroup";
  26972. /** @hidden */
  26973. class _FacetDataStorage {
  26974. facetPositions: Vector3[];
  26975. facetNormals: Vector3[];
  26976. facetPartitioning: number[][];
  26977. facetNb: number;
  26978. partitioningSubdivisions: number;
  26979. partitioningBBoxRatio: number;
  26980. facetDataEnabled: boolean;
  26981. facetParameters: any;
  26982. bbSize: Vector3;
  26983. subDiv: {
  26984. max: number;
  26985. X: number;
  26986. Y: number;
  26987. Z: number;
  26988. };
  26989. facetDepthSort: boolean;
  26990. facetDepthSortEnabled: boolean;
  26991. depthSortedIndices: IndicesArray;
  26992. depthSortedFacets: {
  26993. ind: number;
  26994. sqDistance: number;
  26995. }[];
  26996. facetDepthSortFunction: (f1: {
  26997. ind: number;
  26998. sqDistance: number;
  26999. }, f2: {
  27000. ind: number;
  27001. sqDistance: number;
  27002. }) => number;
  27003. facetDepthSortFrom: Vector3;
  27004. facetDepthSortOrigin: Vector3;
  27005. invertedMatrix: Matrix;
  27006. }
  27007. /**
  27008. * @hidden
  27009. **/
  27010. class _InternalAbstractMeshDataInfo {
  27011. _hasVertexAlpha: boolean;
  27012. _useVertexColors: boolean;
  27013. _numBoneInfluencers: number;
  27014. _applyFog: boolean;
  27015. _receiveShadows: boolean;
  27016. _facetData: _FacetDataStorage;
  27017. _visibility: number;
  27018. _skeleton: Nullable<Skeleton>;
  27019. _layerMask: number;
  27020. _computeBonesUsingShaders: boolean;
  27021. _isActive: boolean;
  27022. _onlyForInstances: boolean;
  27023. _isActiveIntermediate: boolean;
  27024. _onlyForInstancesIntermediate: boolean;
  27025. _actAsRegularMesh: boolean;
  27026. }
  27027. /**
  27028. * Class used to store all common mesh properties
  27029. */
  27030. export class AbstractMesh extends TransformNode implements IDisposable, ICullable, IGetSetVerticesData {
  27031. /** No occlusion */
  27032. static OCCLUSION_TYPE_NONE: number;
  27033. /** Occlusion set to optimisitic */
  27034. static OCCLUSION_TYPE_OPTIMISTIC: number;
  27035. /** Occlusion set to strict */
  27036. static OCCLUSION_TYPE_STRICT: number;
  27037. /** Use an accurante occlusion algorithm */
  27038. static OCCLUSION_ALGORITHM_TYPE_ACCURATE: number;
  27039. /** Use a conservative occlusion algorithm */
  27040. static OCCLUSION_ALGORITHM_TYPE_CONSERVATIVE: number;
  27041. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  27042. * Test order :
  27043. * Is the bounding sphere outside the frustum ?
  27044. * If not, are the bounding box vertices outside the frustum ?
  27045. * It not, then the cullable object is in the frustum.
  27046. */
  27047. static readonly CULLINGSTRATEGY_STANDARD: number;
  27048. /** Culling strategy : Bounding Sphere Only.
  27049. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  27050. * It's also less accurate than the standard because some not visible objects can still be selected.
  27051. * Test : is the bounding sphere outside the frustum ?
  27052. * If not, then the cullable object is in the frustum.
  27053. */
  27054. static readonly CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  27055. /** Culling strategy : Optimistic Inclusion.
  27056. * This in an inclusion test first, then the standard exclusion test.
  27057. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  27058. * 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.
  27059. * Anyway, it's as accurate as the standard strategy.
  27060. * Test :
  27061. * Is the cullable object bounding sphere center in the frustum ?
  27062. * If not, apply the default culling strategy.
  27063. */
  27064. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  27065. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  27066. * This in an inclusion test first, then the bounding sphere only exclusion test.
  27067. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  27068. * 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.
  27069. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  27070. * Test :
  27071. * Is the cullable object bounding sphere center in the frustum ?
  27072. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  27073. */
  27074. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  27075. /**
  27076. * No billboard
  27077. */
  27078. static readonly BILLBOARDMODE_NONE: number;
  27079. /** Billboard on X axis */
  27080. static readonly BILLBOARDMODE_X: number;
  27081. /** Billboard on Y axis */
  27082. static readonly BILLBOARDMODE_Y: number;
  27083. /** Billboard on Z axis */
  27084. static readonly BILLBOARDMODE_Z: number;
  27085. /** Billboard on all axes */
  27086. static readonly BILLBOARDMODE_ALL: number;
  27087. /** Billboard on using position instead of orientation */
  27088. static readonly BILLBOARDMODE_USE_POSITION: number;
  27089. /** @hidden */
  27090. _internalAbstractMeshDataInfo: _InternalAbstractMeshDataInfo;
  27091. /**
  27092. * The culling strategy to use to check whether the mesh must be rendered or not.
  27093. * This value can be changed at any time and will be used on the next render mesh selection.
  27094. * The possible values are :
  27095. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  27096. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  27097. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  27098. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  27099. * Please read each static variable documentation to get details about the culling process.
  27100. * */
  27101. cullingStrategy: number;
  27102. /**
  27103. * Gets the number of facets in the mesh
  27104. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  27105. */
  27106. readonly facetNb: number;
  27107. /**
  27108. * Gets or set the number (integer) of subdivisions per axis in the partioning space
  27109. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  27110. */
  27111. partitioningSubdivisions: number;
  27112. /**
  27113. * The ratio (float) to apply to the bouding box size to set to the partioning space.
  27114. * Ex : 1.01 (default) the partioning space is 1% bigger than the bounding box
  27115. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  27116. */
  27117. partitioningBBoxRatio: number;
  27118. /**
  27119. * Gets or sets a boolean indicating that the facets must be depth sorted on next call to `updateFacetData()`.
  27120. * Works only for updatable meshes.
  27121. * Doesn't work with multi-materials
  27122. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  27123. */
  27124. mustDepthSortFacets: boolean;
  27125. /**
  27126. * The location (Vector3) where the facet depth sort must be computed from.
  27127. * By default, the active camera position.
  27128. * Used only when facet depth sort is enabled
  27129. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  27130. */
  27131. facetDepthSortFrom: Vector3;
  27132. /**
  27133. * gets a boolean indicating if facetData is enabled
  27134. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  27135. */
  27136. readonly isFacetDataEnabled: boolean;
  27137. /** @hidden */
  27138. _updateNonUniformScalingState(value: boolean): boolean;
  27139. /**
  27140. * An event triggered when this mesh collides with another one
  27141. */
  27142. onCollideObservable: Observable<AbstractMesh>;
  27143. /** Set a function to call when this mesh collides with another one */
  27144. onCollide: () => void;
  27145. /**
  27146. * An event triggered when the collision's position changes
  27147. */
  27148. onCollisionPositionChangeObservable: Observable<Vector3>;
  27149. /** Set a function to call when the collision's position changes */
  27150. onCollisionPositionChange: () => void;
  27151. /**
  27152. * An event triggered when material is changed
  27153. */
  27154. onMaterialChangedObservable: Observable<AbstractMesh>;
  27155. /**
  27156. * Gets or sets the orientation for POV movement & rotation
  27157. */
  27158. definedFacingForward: boolean;
  27159. /** @hidden */
  27160. _occlusionQuery: Nullable<WebGLQuery>;
  27161. /** @hidden */
  27162. _renderingGroup: Nullable<RenderingGroup>;
  27163. /**
  27164. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  27165. */
  27166. /**
  27167. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  27168. */
  27169. visibility: number;
  27170. /** Gets or sets the alpha index used to sort transparent meshes
  27171. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#alpha-index
  27172. */
  27173. alphaIndex: number;
  27174. /**
  27175. * Gets or sets a boolean indicating if the mesh is visible (renderable). Default is true
  27176. */
  27177. isVisible: boolean;
  27178. /**
  27179. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  27180. */
  27181. isPickable: boolean;
  27182. /** Gets or sets a boolean indicating that bounding boxes of subMeshes must be rendered as well (false by default) */
  27183. showSubMeshesBoundingBox: boolean;
  27184. /** Gets or sets a boolean indicating if the mesh must be considered as a ray blocker for lens flares (false by default)
  27185. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  27186. */
  27187. isBlocker: boolean;
  27188. /**
  27189. * Gets or sets a boolean indicating that pointer move events must be supported on this mesh (false by default)
  27190. */
  27191. enablePointerMoveEvents: boolean;
  27192. /**
  27193. * Specifies the rendering group id for this mesh (0 by default)
  27194. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  27195. */
  27196. renderingGroupId: number;
  27197. private _material;
  27198. /** Gets or sets current material */
  27199. material: Nullable<Material>;
  27200. /**
  27201. * Gets or sets a boolean indicating that this mesh can receive realtime shadows
  27202. * @see http://doc.babylonjs.com/babylon101/shadows
  27203. */
  27204. receiveShadows: boolean;
  27205. /** Defines color to use when rendering outline */
  27206. outlineColor: Color3;
  27207. /** Define width to use when rendering outline */
  27208. outlineWidth: number;
  27209. /** Defines color to use when rendering overlay */
  27210. overlayColor: Color3;
  27211. /** Defines alpha to use when rendering overlay */
  27212. overlayAlpha: number;
  27213. /** Gets or sets a boolean indicating that this mesh contains vertex color data with alpha values */
  27214. hasVertexAlpha: boolean;
  27215. /** 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) */
  27216. useVertexColors: boolean;
  27217. /**
  27218. * Gets or sets a boolean indicating that bone animations must be computed by the CPU (false by default)
  27219. */
  27220. computeBonesUsingShaders: boolean;
  27221. /** Gets or sets the number of allowed bone influences per vertex (4 by default) */
  27222. numBoneInfluencers: number;
  27223. /** Gets or sets a boolean indicating that this mesh will allow fog to be rendered on it (true by default) */
  27224. applyFog: boolean;
  27225. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes selection (true by default) */
  27226. useOctreeForRenderingSelection: boolean;
  27227. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes picking (true by default) */
  27228. useOctreeForPicking: boolean;
  27229. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes collision (true by default) */
  27230. useOctreeForCollisions: boolean;
  27231. /**
  27232. * Gets or sets the current layer mask (default is 0x0FFFFFFF)
  27233. * @see http://doc.babylonjs.com/how_to/layermasks_and_multi-cam_textures
  27234. */
  27235. layerMask: number;
  27236. /**
  27237. * True if the mesh must be rendered in any case (this will shortcut the frustum clipping phase)
  27238. */
  27239. alwaysSelectAsActiveMesh: boolean;
  27240. /**
  27241. * Gets or sets a boolean indicating that the bounding info does not need to be kept in sync (for performance reason)
  27242. */
  27243. doNotSyncBoundingInfo: boolean;
  27244. /**
  27245. * Gets or sets the current action manager
  27246. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  27247. */
  27248. actionManager: Nullable<AbstractActionManager>;
  27249. private _meshCollisionData;
  27250. /**
  27251. * Gets or sets the ellipsoid used to impersonate this mesh when using collision engine (default is (0.5, 1, 0.5))
  27252. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  27253. */
  27254. ellipsoid: Vector3;
  27255. /**
  27256. * Gets or sets the ellipsoid offset used to impersonate this mesh when using collision engine (default is (0, 0, 0))
  27257. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  27258. */
  27259. ellipsoidOffset: Vector3;
  27260. /**
  27261. * Gets or sets a collision mask used to mask collisions (default is -1).
  27262. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  27263. */
  27264. collisionMask: number;
  27265. /**
  27266. * Gets or sets the current collision group mask (-1 by default).
  27267. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  27268. */
  27269. collisionGroup: number;
  27270. /**
  27271. * Defines edge width used when edgesRenderer is enabled
  27272. * @see https://www.babylonjs-playground.com/#10OJSG#13
  27273. */
  27274. edgesWidth: number;
  27275. /**
  27276. * Defines edge color used when edgesRenderer is enabled
  27277. * @see https://www.babylonjs-playground.com/#10OJSG#13
  27278. */
  27279. edgesColor: Color4;
  27280. /** @hidden */
  27281. _edgesRenderer: Nullable<IEdgesRenderer>;
  27282. /** @hidden */
  27283. _masterMesh: Nullable<AbstractMesh>;
  27284. /** @hidden */
  27285. _boundingInfo: Nullable<BoundingInfo>;
  27286. /** @hidden */
  27287. _renderId: number;
  27288. /**
  27289. * Gets or sets the list of subMeshes
  27290. * @see http://doc.babylonjs.com/how_to/multi_materials
  27291. */
  27292. subMeshes: SubMesh[];
  27293. /** @hidden */
  27294. _intersectionsInProgress: AbstractMesh[];
  27295. /** @hidden */
  27296. _unIndexed: boolean;
  27297. /** @hidden */
  27298. _lightSources: Light[];
  27299. /** Gets the list of lights affecting that mesh */
  27300. readonly lightSources: Light[];
  27301. /** @hidden */
  27302. readonly _positions: Nullable<Vector3[]>;
  27303. /** @hidden */
  27304. _waitingData: {
  27305. lods: Nullable<any>;
  27306. actions: Nullable<any>;
  27307. freezeWorldMatrix: Nullable<boolean>;
  27308. };
  27309. /** @hidden */
  27310. _bonesTransformMatrices: Nullable<Float32Array>;
  27311. /** @hidden */
  27312. _transformMatrixTexture: Nullable<RawTexture>;
  27313. /**
  27314. * Gets or sets a skeleton to apply skining transformations
  27315. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  27316. */
  27317. skeleton: Nullable<Skeleton>;
  27318. /**
  27319. * An event triggered when the mesh is rebuilt.
  27320. */
  27321. onRebuildObservable: Observable<AbstractMesh>;
  27322. /**
  27323. * Creates a new AbstractMesh
  27324. * @param name defines the name of the mesh
  27325. * @param scene defines the hosting scene
  27326. */
  27327. constructor(name: string, scene?: Nullable<Scene>);
  27328. /**
  27329. * Returns the string "AbstractMesh"
  27330. * @returns "AbstractMesh"
  27331. */
  27332. getClassName(): string;
  27333. /**
  27334. * Gets a string representation of the current mesh
  27335. * @param fullDetails defines a boolean indicating if full details must be included
  27336. * @returns a string representation of the current mesh
  27337. */
  27338. toString(fullDetails?: boolean): string;
  27339. /**
  27340. * @hidden
  27341. */
  27342. protected _getEffectiveParent(): Nullable<Node>;
  27343. /** @hidden */
  27344. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  27345. /** @hidden */
  27346. _rebuild(): void;
  27347. /** @hidden */
  27348. _resyncLightSources(): void;
  27349. /** @hidden */
  27350. _resyncLighSource(light: Light): void;
  27351. /** @hidden */
  27352. _unBindEffect(): void;
  27353. /** @hidden */
  27354. _removeLightSource(light: Light, dispose: boolean): void;
  27355. private _markSubMeshesAsDirty;
  27356. /** @hidden */
  27357. _markSubMeshesAsLightDirty(dispose?: boolean): void;
  27358. /** @hidden */
  27359. _markSubMeshesAsAttributesDirty(): void;
  27360. /** @hidden */
  27361. _markSubMeshesAsMiscDirty(): void;
  27362. /**
  27363. * Gets or sets a Vector3 depicting the mesh scaling along each local axis X, Y, Z. Default is (1.0, 1.0, 1.0)
  27364. */
  27365. scaling: Vector3;
  27366. /**
  27367. * Returns true if the mesh is blocked. Implemented by child classes
  27368. */
  27369. readonly isBlocked: boolean;
  27370. /**
  27371. * Returns the mesh itself by default. Implemented by child classes
  27372. * @param camera defines the camera to use to pick the right LOD level
  27373. * @returns the currentAbstractMesh
  27374. */
  27375. getLOD(camera: Camera): Nullable<AbstractMesh>;
  27376. /**
  27377. * Returns 0 by default. Implemented by child classes
  27378. * @returns an integer
  27379. */
  27380. getTotalVertices(): number;
  27381. /**
  27382. * Returns a positive integer : the total number of indices in this mesh geometry.
  27383. * @returns the numner of indices or zero if the mesh has no geometry.
  27384. */
  27385. getTotalIndices(): number;
  27386. /**
  27387. * Returns null by default. Implemented by child classes
  27388. * @returns null
  27389. */
  27390. getIndices(): Nullable<IndicesArray>;
  27391. /**
  27392. * Returns the array of the requested vertex data kind. Implemented by child classes
  27393. * @param kind defines the vertex data kind to use
  27394. * @returns null
  27395. */
  27396. getVerticesData(kind: string): Nullable<FloatArray>;
  27397. /**
  27398. * Sets the vertex data of the mesh geometry for the requested `kind`.
  27399. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  27400. * Note that a new underlying VertexBuffer object is created each call.
  27401. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  27402. * @param kind defines vertex data kind:
  27403. * * VertexBuffer.PositionKind
  27404. * * VertexBuffer.UVKind
  27405. * * VertexBuffer.UV2Kind
  27406. * * VertexBuffer.UV3Kind
  27407. * * VertexBuffer.UV4Kind
  27408. * * VertexBuffer.UV5Kind
  27409. * * VertexBuffer.UV6Kind
  27410. * * VertexBuffer.ColorKind
  27411. * * VertexBuffer.MatricesIndicesKind
  27412. * * VertexBuffer.MatricesIndicesExtraKind
  27413. * * VertexBuffer.MatricesWeightsKind
  27414. * * VertexBuffer.MatricesWeightsExtraKind
  27415. * @param data defines the data source
  27416. * @param updatable defines if the data must be flagged as updatable (or static)
  27417. * @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
  27418. * @returns the current mesh
  27419. */
  27420. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  27421. /**
  27422. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  27423. * If the mesh has no geometry, it is simply returned as it is.
  27424. * @param kind defines vertex data kind:
  27425. * * VertexBuffer.PositionKind
  27426. * * VertexBuffer.UVKind
  27427. * * VertexBuffer.UV2Kind
  27428. * * VertexBuffer.UV3Kind
  27429. * * VertexBuffer.UV4Kind
  27430. * * VertexBuffer.UV5Kind
  27431. * * VertexBuffer.UV6Kind
  27432. * * VertexBuffer.ColorKind
  27433. * * VertexBuffer.MatricesIndicesKind
  27434. * * VertexBuffer.MatricesIndicesExtraKind
  27435. * * VertexBuffer.MatricesWeightsKind
  27436. * * VertexBuffer.MatricesWeightsExtraKind
  27437. * @param data defines the data source
  27438. * @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
  27439. * @param makeItUnique If true, a new global geometry is created from this data and is set to the mesh
  27440. * @returns the current mesh
  27441. */
  27442. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  27443. /**
  27444. * Sets the mesh indices,
  27445. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  27446. * @param indices Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array)
  27447. * @param totalVertices Defines the total number of vertices
  27448. * @returns the current mesh
  27449. */
  27450. setIndices(indices: IndicesArray, totalVertices: Nullable<number>): AbstractMesh;
  27451. /**
  27452. * Gets a boolean indicating if specific vertex data is present
  27453. * @param kind defines the vertex data kind to use
  27454. * @returns true is data kind is present
  27455. */
  27456. isVerticesDataPresent(kind: string): boolean;
  27457. /**
  27458. * Returns the mesh BoundingInfo object or creates a new one and returns if it was undefined.
  27459. * Note that it returns a shallow bounding of the mesh (i.e. it does not include children).
  27460. * To get the full bounding of all children, call `getHierarchyBoundingVectors` instead.
  27461. * @returns a BoundingInfo
  27462. */
  27463. getBoundingInfo(): BoundingInfo;
  27464. /**
  27465. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  27466. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  27467. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  27468. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  27469. * @returns the current mesh
  27470. */
  27471. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): AbstractMesh;
  27472. /**
  27473. * Overwrite the current bounding info
  27474. * @param boundingInfo defines the new bounding info
  27475. * @returns the current mesh
  27476. */
  27477. setBoundingInfo(boundingInfo: BoundingInfo): AbstractMesh;
  27478. /** Gets a boolean indicating if this mesh has skinning data and an attached skeleton */
  27479. readonly useBones: boolean;
  27480. /** @hidden */
  27481. _preActivate(): void;
  27482. /** @hidden */
  27483. _preActivateForIntermediateRendering(renderId: number): void;
  27484. /** @hidden */
  27485. _activate(renderId: number, intermediateRendering: boolean): boolean;
  27486. /** @hidden */
  27487. _postActivate(): void;
  27488. /** @hidden */
  27489. _freeze(): void;
  27490. /** @hidden */
  27491. _unFreeze(): void;
  27492. /**
  27493. * Gets the current world matrix
  27494. * @returns a Matrix
  27495. */
  27496. getWorldMatrix(): Matrix;
  27497. /** @hidden */
  27498. _getWorldMatrixDeterminant(): number;
  27499. /**
  27500. * Gets a boolean indicating if this mesh is an instance or a regular mesh
  27501. */
  27502. readonly isAnInstance: boolean;
  27503. /**
  27504. * Gets a boolean indicating if this mesh has instances
  27505. */
  27506. readonly hasInstances: boolean;
  27507. /**
  27508. * Perform relative position change from the point of view of behind the front of the mesh.
  27509. * This is performed taking into account the meshes current rotation, so you do not have to care.
  27510. * Supports definition of mesh facing forward or backward
  27511. * @param amountRight defines the distance on the right axis
  27512. * @param amountUp defines the distance on the up axis
  27513. * @param amountForward defines the distance on the forward axis
  27514. * @returns the current mesh
  27515. */
  27516. movePOV(amountRight: number, amountUp: number, amountForward: number): AbstractMesh;
  27517. /**
  27518. * Calculate relative position change from the point of view of behind the front of the mesh.
  27519. * This is performed taking into account the meshes current rotation, so you do not have to care.
  27520. * Supports definition of mesh facing forward or backward
  27521. * @param amountRight defines the distance on the right axis
  27522. * @param amountUp defines the distance on the up axis
  27523. * @param amountForward defines the distance on the forward axis
  27524. * @returns the new displacement vector
  27525. */
  27526. calcMovePOV(amountRight: number, amountUp: number, amountForward: number): Vector3;
  27527. /**
  27528. * Perform relative rotation change from the point of view of behind the front of the mesh.
  27529. * Supports definition of mesh facing forward or backward
  27530. * @param flipBack defines the flip
  27531. * @param twirlClockwise defines the twirl
  27532. * @param tiltRight defines the tilt
  27533. * @returns the current mesh
  27534. */
  27535. rotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): AbstractMesh;
  27536. /**
  27537. * Calculate relative rotation change from the point of view of behind the front of the mesh.
  27538. * Supports definition of mesh facing forward or backward.
  27539. * @param flipBack defines the flip
  27540. * @param twirlClockwise defines the twirl
  27541. * @param tiltRight defines the tilt
  27542. * @returns the new rotation vector
  27543. */
  27544. calcRotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): Vector3;
  27545. /**
  27546. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  27547. * This means the mesh underlying bounding box and sphere are recomputed.
  27548. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  27549. * @returns the current mesh
  27550. */
  27551. refreshBoundingInfo(applySkeleton?: boolean): AbstractMesh;
  27552. /** @hidden */
  27553. _refreshBoundingInfo(data: Nullable<FloatArray>, bias: Nullable<Vector2>): void;
  27554. /** @hidden */
  27555. _getPositionData(applySkeleton: boolean): Nullable<FloatArray>;
  27556. /** @hidden */
  27557. _updateBoundingInfo(): AbstractMesh;
  27558. /** @hidden */
  27559. _updateSubMeshesBoundingInfo(matrix: DeepImmutable<Matrix>): AbstractMesh;
  27560. /** @hidden */
  27561. protected _afterComputeWorldMatrix(): void;
  27562. /** @hidden */
  27563. readonly _effectiveMesh: AbstractMesh;
  27564. /**
  27565. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  27566. * A mesh is in the frustum if its bounding box intersects the frustum
  27567. * @param frustumPlanes defines the frustum to test
  27568. * @returns true if the mesh is in the frustum planes
  27569. */
  27570. isInFrustum(frustumPlanes: Plane[]): boolean;
  27571. /**
  27572. * Returns `true` if the mesh is completely in the frustum defined be the passed array of planes.
  27573. * A mesh is completely in the frustum if its bounding box it completely inside the frustum.
  27574. * @param frustumPlanes defines the frustum to test
  27575. * @returns true if the mesh is completely in the frustum planes
  27576. */
  27577. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  27578. /**
  27579. * True if the mesh intersects another mesh or a SolidParticle object
  27580. * @param mesh defines a target mesh or SolidParticle to test
  27581. * @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)
  27582. * @param includeDescendants Can be set to true to test if the mesh defined in parameters intersects with the current mesh or any child meshes
  27583. * @returns true if there is an intersection
  27584. */
  27585. intersectsMesh(mesh: AbstractMesh | SolidParticle, precise?: boolean, includeDescendants?: boolean): boolean;
  27586. /**
  27587. * Returns true if the passed point (Vector3) is inside the mesh bounding box
  27588. * @param point defines the point to test
  27589. * @returns true if there is an intersection
  27590. */
  27591. intersectsPoint(point: Vector3): boolean;
  27592. /**
  27593. * Gets or sets a boolean indicating that this mesh can be used in the collision engine
  27594. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  27595. */
  27596. checkCollisions: boolean;
  27597. /**
  27598. * Gets Collider object used to compute collisions (not physics)
  27599. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  27600. */
  27601. readonly collider: Nullable<Collider>;
  27602. /**
  27603. * Move the mesh using collision engine
  27604. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  27605. * @param displacement defines the requested displacement vector
  27606. * @returns the current mesh
  27607. */
  27608. moveWithCollisions(displacement: Vector3): AbstractMesh;
  27609. private _onCollisionPositionChange;
  27610. /** @hidden */
  27611. _collideForSubMesh(subMesh: SubMesh, transformMatrix: Matrix, collider: Collider): AbstractMesh;
  27612. /** @hidden */
  27613. _processCollisionsForSubMeshes(collider: Collider, transformMatrix: Matrix): AbstractMesh;
  27614. /** @hidden */
  27615. _checkCollision(collider: Collider): AbstractMesh;
  27616. /** @hidden */
  27617. _generatePointsArray(): boolean;
  27618. /**
  27619. * Checks if the passed Ray intersects with the mesh
  27620. * @param ray defines the ray to use
  27621. * @param fastCheck defines if fast mode (but less precise) must be used (false by default)
  27622. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  27623. * @returns the picking info
  27624. * @see http://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  27625. */
  27626. intersects(ray: Ray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): PickingInfo;
  27627. /**
  27628. * Clones the current mesh
  27629. * @param name defines the mesh name
  27630. * @param newParent defines the new mesh parent
  27631. * @param doNotCloneChildren defines a boolean indicating that children must not be cloned (false by default)
  27632. * @returns the new mesh
  27633. */
  27634. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  27635. /**
  27636. * Disposes all the submeshes of the current meshnp
  27637. * @returns the current mesh
  27638. */
  27639. releaseSubMeshes(): AbstractMesh;
  27640. /**
  27641. * Releases resources associated with this abstract mesh.
  27642. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  27643. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  27644. */
  27645. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  27646. /**
  27647. * Adds the passed mesh as a child to the current mesh
  27648. * @param mesh defines the child mesh
  27649. * @returns the current mesh
  27650. */
  27651. addChild(mesh: AbstractMesh): AbstractMesh;
  27652. /**
  27653. * Removes the passed mesh from the current mesh children list
  27654. * @param mesh defines the child mesh
  27655. * @returns the current mesh
  27656. */
  27657. removeChild(mesh: AbstractMesh): AbstractMesh;
  27658. /** @hidden */
  27659. private _initFacetData;
  27660. /**
  27661. * Updates the mesh facetData arrays and the internal partitioning when the mesh is morphed or updated.
  27662. * This method can be called within the render loop.
  27663. * 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
  27664. * @returns the current mesh
  27665. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27666. */
  27667. updateFacetData(): AbstractMesh;
  27668. /**
  27669. * Returns the facetLocalNormals array.
  27670. * The normals are expressed in the mesh local spac
  27671. * @returns an array of Vector3
  27672. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27673. */
  27674. getFacetLocalNormals(): Vector3[];
  27675. /**
  27676. * Returns the facetLocalPositions array.
  27677. * The facet positions are expressed in the mesh local space
  27678. * @returns an array of Vector3
  27679. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27680. */
  27681. getFacetLocalPositions(): Vector3[];
  27682. /**
  27683. * Returns the facetLocalPartioning array
  27684. * @returns an array of array of numbers
  27685. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27686. */
  27687. getFacetLocalPartitioning(): number[][];
  27688. /**
  27689. * Returns the i-th facet position in the world system.
  27690. * This method allocates a new Vector3 per call
  27691. * @param i defines the facet index
  27692. * @returns a new Vector3
  27693. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27694. */
  27695. getFacetPosition(i: number): Vector3;
  27696. /**
  27697. * Sets the reference Vector3 with the i-th facet position in the world system
  27698. * @param i defines the facet index
  27699. * @param ref defines the target vector
  27700. * @returns the current mesh
  27701. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27702. */
  27703. getFacetPositionToRef(i: number, ref: Vector3): AbstractMesh;
  27704. /**
  27705. * Returns the i-th facet normal in the world system.
  27706. * This method allocates a new Vector3 per call
  27707. * @param i defines the facet index
  27708. * @returns a new Vector3
  27709. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27710. */
  27711. getFacetNormal(i: number): Vector3;
  27712. /**
  27713. * Sets the reference Vector3 with the i-th facet normal in the world system
  27714. * @param i defines the facet index
  27715. * @param ref defines the target vector
  27716. * @returns the current mesh
  27717. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27718. */
  27719. getFacetNormalToRef(i: number, ref: Vector3): this;
  27720. /**
  27721. * 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)
  27722. * @param x defines x coordinate
  27723. * @param y defines y coordinate
  27724. * @param z defines z coordinate
  27725. * @returns the array of facet indexes
  27726. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27727. */
  27728. getFacetsAtLocalCoordinates(x: number, y: number, z: number): Nullable<number[]>;
  27729. /**
  27730. * Returns the closest mesh facet index at (x,y,z) World coordinates, null if not found
  27731. * @param projected sets as the (x,y,z) world projection on the facet
  27732. * @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
  27733. * @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
  27734. * @param x defines x coordinate
  27735. * @param y defines y coordinate
  27736. * @param z defines z coordinate
  27737. * @returns the face index if found (or null instead)
  27738. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27739. */
  27740. getClosestFacetAtCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  27741. /**
  27742. * Returns the closest mesh facet index at (x,y,z) local coordinates, null if not found
  27743. * @param projected sets as the (x,y,z) local projection on the facet
  27744. * @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
  27745. * @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
  27746. * @param x defines x coordinate
  27747. * @param y defines y coordinate
  27748. * @param z defines z coordinate
  27749. * @returns the face index if found (or null instead)
  27750. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27751. */
  27752. getClosestFacetAtLocalCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  27753. /**
  27754. * Returns the object "parameter" set with all the expected parameters for facetData computation by ComputeNormals()
  27755. * @returns the parameters
  27756. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27757. */
  27758. getFacetDataParameters(): any;
  27759. /**
  27760. * Disables the feature FacetData and frees the related memory
  27761. * @returns the current mesh
  27762. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  27763. */
  27764. disableFacetData(): AbstractMesh;
  27765. /**
  27766. * Updates the AbstractMesh indices array
  27767. * @param indices defines the data source
  27768. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  27769. * @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)
  27770. * @returns the current mesh
  27771. */
  27772. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  27773. /**
  27774. * Creates new normals data for the mesh
  27775. * @param updatable defines if the normal vertex buffer must be flagged as updatable
  27776. * @returns the current mesh
  27777. */
  27778. createNormals(updatable: boolean): AbstractMesh;
  27779. /**
  27780. * Align the mesh with a normal
  27781. * @param normal defines the normal to use
  27782. * @param upDirection can be used to redefined the up vector to use (will use the (0, 1, 0) by default)
  27783. * @returns the current mesh
  27784. */
  27785. alignWithNormal(normal: Vector3, upDirection?: Vector3): AbstractMesh;
  27786. /** @hidden */
  27787. _checkOcclusionQuery(): boolean;
  27788. /**
  27789. * Disables the mesh edge rendering mode
  27790. * @returns the currentAbstractMesh
  27791. */
  27792. disableEdgesRendering(): AbstractMesh;
  27793. /**
  27794. * Enables the edge rendering mode on the mesh.
  27795. * This mode makes the mesh edges visible
  27796. * @param epsilon defines the maximal distance between two angles to detect a face
  27797. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  27798. * @returns the currentAbstractMesh
  27799. * @see https://www.babylonjs-playground.com/#19O9TU#0
  27800. */
  27801. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  27802. }
  27803. }
  27804. declare module "babylonjs/Actions/actionEvent" {
  27805. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  27806. import { Nullable } from "babylonjs/types";
  27807. import { Sprite } from "babylonjs/Sprites/sprite";
  27808. import { Scene } from "babylonjs/scene";
  27809. import { Vector2 } from "babylonjs/Maths/math.vector";
  27810. /**
  27811. * Interface used to define ActionEvent
  27812. */
  27813. export interface IActionEvent {
  27814. /** The mesh or sprite that triggered the action */
  27815. source: any;
  27816. /** The X mouse cursor position at the time of the event */
  27817. pointerX: number;
  27818. /** The Y mouse cursor position at the time of the event */
  27819. pointerY: number;
  27820. /** The mesh that is currently pointed at (can be null) */
  27821. meshUnderPointer: Nullable<AbstractMesh>;
  27822. /** the original (browser) event that triggered the ActionEvent */
  27823. sourceEvent?: any;
  27824. /** additional data for the event */
  27825. additionalData?: any;
  27826. }
  27827. /**
  27828. * ActionEvent is the event being sent when an action is triggered.
  27829. */
  27830. export class ActionEvent implements IActionEvent {
  27831. /** The mesh or sprite that triggered the action */
  27832. source: any;
  27833. /** The X mouse cursor position at the time of the event */
  27834. pointerX: number;
  27835. /** The Y mouse cursor position at the time of the event */
  27836. pointerY: number;
  27837. /** The mesh that is currently pointed at (can be null) */
  27838. meshUnderPointer: Nullable<AbstractMesh>;
  27839. /** the original (browser) event that triggered the ActionEvent */
  27840. sourceEvent?: any;
  27841. /** additional data for the event */
  27842. additionalData?: any;
  27843. /**
  27844. * Creates a new ActionEvent
  27845. * @param source The mesh or sprite that triggered the action
  27846. * @param pointerX The X mouse cursor position at the time of the event
  27847. * @param pointerY The Y mouse cursor position at the time of the event
  27848. * @param meshUnderPointer The mesh that is currently pointed at (can be null)
  27849. * @param sourceEvent the original (browser) event that triggered the ActionEvent
  27850. * @param additionalData additional data for the event
  27851. */
  27852. constructor(
  27853. /** The mesh or sprite that triggered the action */
  27854. source: any,
  27855. /** The X mouse cursor position at the time of the event */
  27856. pointerX: number,
  27857. /** The Y mouse cursor position at the time of the event */
  27858. pointerY: number,
  27859. /** The mesh that is currently pointed at (can be null) */
  27860. meshUnderPointer: Nullable<AbstractMesh>,
  27861. /** the original (browser) event that triggered the ActionEvent */
  27862. sourceEvent?: any,
  27863. /** additional data for the event */
  27864. additionalData?: any);
  27865. /**
  27866. * Helper function to auto-create an ActionEvent from a source mesh.
  27867. * @param source The source mesh that triggered the event
  27868. * @param evt The original (browser) event
  27869. * @param additionalData additional data for the event
  27870. * @returns the new ActionEvent
  27871. */
  27872. static CreateNew(source: AbstractMesh, evt?: Event, additionalData?: any): ActionEvent;
  27873. /**
  27874. * Helper function to auto-create an ActionEvent from a source sprite
  27875. * @param source The source sprite that triggered the event
  27876. * @param scene Scene associated with the sprite
  27877. * @param evt The original (browser) event
  27878. * @param additionalData additional data for the event
  27879. * @returns the new ActionEvent
  27880. */
  27881. static CreateNewFromSprite(source: Sprite, scene: Scene, evt?: Event, additionalData?: any): ActionEvent;
  27882. /**
  27883. * Helper function to auto-create an ActionEvent from a scene. If triggered by a mesh use ActionEvent.CreateNew
  27884. * @param scene the scene where the event occurred
  27885. * @param evt The original (browser) event
  27886. * @returns the new ActionEvent
  27887. */
  27888. static CreateNewFromScene(scene: Scene, evt: Event): ActionEvent;
  27889. /**
  27890. * Helper function to auto-create an ActionEvent from a primitive
  27891. * @param prim defines the target primitive
  27892. * @param pointerPos defines the pointer position
  27893. * @param evt The original (browser) event
  27894. * @param additionalData additional data for the event
  27895. * @returns the new ActionEvent
  27896. */
  27897. static CreateNewFromPrimitive(prim: any, pointerPos: Vector2, evt?: Event, additionalData?: any): ActionEvent;
  27898. }
  27899. }
  27900. declare module "babylonjs/Actions/abstractActionManager" {
  27901. import { IDisposable } from "babylonjs/scene";
  27902. import { IActionEvent } from "babylonjs/Actions/actionEvent";
  27903. import { IAction } from "babylonjs/Actions/action";
  27904. import { Nullable } from "babylonjs/types";
  27905. /**
  27906. * Abstract class used to decouple action Manager from scene and meshes.
  27907. * Do not instantiate.
  27908. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  27909. */
  27910. export abstract class AbstractActionManager implements IDisposable {
  27911. /** Gets the list of active triggers */
  27912. static Triggers: {
  27913. [key: string]: number;
  27914. };
  27915. /** Gets the cursor to use when hovering items */
  27916. hoverCursor: string;
  27917. /** Gets the list of actions */
  27918. actions: IAction[];
  27919. /**
  27920. * Gets or sets a boolean indicating that the manager is recursive meaning that it can trigger action from children
  27921. */
  27922. isRecursive: boolean;
  27923. /**
  27924. * Releases all associated resources
  27925. */
  27926. abstract dispose(): void;
  27927. /**
  27928. * Does this action manager has pointer triggers
  27929. */
  27930. abstract readonly hasPointerTriggers: boolean;
  27931. /**
  27932. * Does this action manager has pick triggers
  27933. */
  27934. abstract readonly hasPickTriggers: boolean;
  27935. /**
  27936. * Process a specific trigger
  27937. * @param trigger defines the trigger to process
  27938. * @param evt defines the event details to be processed
  27939. */
  27940. abstract processTrigger(trigger: number, evt?: IActionEvent): void;
  27941. /**
  27942. * Does this action manager handles actions of any of the given triggers
  27943. * @param triggers defines the triggers to be tested
  27944. * @return a boolean indicating whether one (or more) of the triggers is handled
  27945. */
  27946. abstract hasSpecificTriggers(triggers: number[]): boolean;
  27947. /**
  27948. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  27949. * speed.
  27950. * @param triggerA defines the trigger to be tested
  27951. * @param triggerB defines the trigger to be tested
  27952. * @return a boolean indicating whether one (or more) of the triggers is handled
  27953. */
  27954. abstract hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  27955. /**
  27956. * Does this action manager handles actions of a given trigger
  27957. * @param trigger defines the trigger to be tested
  27958. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  27959. * @return whether the trigger is handled
  27960. */
  27961. abstract hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  27962. /**
  27963. * Serialize this manager to a JSON object
  27964. * @param name defines the property name to store this manager
  27965. * @returns a JSON representation of this manager
  27966. */
  27967. abstract serialize(name: string): any;
  27968. /**
  27969. * Registers an action to this action manager
  27970. * @param action defines the action to be registered
  27971. * @return the action amended (prepared) after registration
  27972. */
  27973. abstract registerAction(action: IAction): Nullable<IAction>;
  27974. /**
  27975. * Unregisters an action to this action manager
  27976. * @param action defines the action to be unregistered
  27977. * @return a boolean indicating whether the action has been unregistered
  27978. */
  27979. abstract unregisterAction(action: IAction): Boolean;
  27980. /**
  27981. * Does exist one action manager with at least one trigger
  27982. **/
  27983. static readonly HasTriggers: boolean;
  27984. /**
  27985. * Does exist one action manager with at least one pick trigger
  27986. **/
  27987. static readonly HasPickTriggers: boolean;
  27988. /**
  27989. * Does exist one action manager that handles actions of a given trigger
  27990. * @param trigger defines the trigger to be tested
  27991. * @return a boolean indicating whether the trigger is handeled by at least one action manager
  27992. **/
  27993. static HasSpecificTrigger(trigger: number): boolean;
  27994. }
  27995. }
  27996. declare module "babylonjs/node" {
  27997. import { Scene } from "babylonjs/scene";
  27998. import { Nullable } from "babylonjs/types";
  27999. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  28000. import { Engine } from "babylonjs/Engines/engine";
  28001. import { IBehaviorAware, Behavior } from "babylonjs/Behaviors/behavior";
  28002. import { Observable } from "babylonjs/Misc/observable";
  28003. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  28004. import { IInspectable } from "babylonjs/Misc/iInspectable";
  28005. import { Animatable } from "babylonjs/Animations/animatable";
  28006. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  28007. import { Animation } from "babylonjs/Animations/animation";
  28008. import { AnimationRange } from "babylonjs/Animations/animationRange";
  28009. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  28010. /**
  28011. * Defines how a node can be built from a string name.
  28012. */
  28013. export type NodeConstructor = (name: string, scene: Scene, options?: any) => () => Node;
  28014. /**
  28015. * Node is the basic class for all scene objects (Mesh, Light, Camera.)
  28016. */
  28017. export class Node implements IBehaviorAware<Node> {
  28018. /** @hidden */
  28019. static _AnimationRangeFactory: (name: string, from: number, to: number) => import("babylonjs/Animations/animationRange").AnimationRange;
  28020. private static _NodeConstructors;
  28021. /**
  28022. * Add a new node constructor
  28023. * @param type defines the type name of the node to construct
  28024. * @param constructorFunc defines the constructor function
  28025. */
  28026. static AddNodeConstructor(type: string, constructorFunc: NodeConstructor): void;
  28027. /**
  28028. * Returns a node constructor based on type name
  28029. * @param type defines the type name
  28030. * @param name defines the new node name
  28031. * @param scene defines the hosting scene
  28032. * @param options defines optional options to transmit to constructors
  28033. * @returns the new constructor or null
  28034. */
  28035. static Construct(type: string, name: string, scene: Scene, options?: any): Nullable<() => Node>;
  28036. /**
  28037. * Gets or sets the name of the node
  28038. */
  28039. name: string;
  28040. /**
  28041. * Gets or sets the id of the node
  28042. */
  28043. id: string;
  28044. /**
  28045. * Gets or sets the unique id of the node
  28046. */
  28047. uniqueId: number;
  28048. /**
  28049. * Gets or sets a string used to store user defined state for the node
  28050. */
  28051. state: string;
  28052. /**
  28053. * Gets or sets an object used to store user defined information for the node
  28054. */
  28055. metadata: any;
  28056. /**
  28057. * For internal use only. Please do not use.
  28058. */
  28059. reservedDataStore: any;
  28060. /**
  28061. * List of inspectable custom properties (used by the Inspector)
  28062. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  28063. */
  28064. inspectableCustomProperties: IInspectable[];
  28065. private _doNotSerialize;
  28066. /**
  28067. * Gets or sets a boolean used to define if the node must be serialized
  28068. */
  28069. doNotSerialize: boolean;
  28070. /** @hidden */
  28071. _isDisposed: boolean;
  28072. /**
  28073. * Gets a list of Animations associated with the node
  28074. */
  28075. animations: import("babylonjs/Animations/animation").Animation[];
  28076. protected _ranges: {
  28077. [name: string]: Nullable<AnimationRange>;
  28078. };
  28079. /**
  28080. * Callback raised when the node is ready to be used
  28081. */
  28082. onReady: Nullable<(node: Node) => void>;
  28083. private _isEnabled;
  28084. private _isParentEnabled;
  28085. private _isReady;
  28086. /** @hidden */
  28087. _currentRenderId: number;
  28088. private _parentUpdateId;
  28089. /** @hidden */
  28090. _childUpdateId: number;
  28091. /** @hidden */
  28092. _waitingParentId: Nullable<string>;
  28093. /** @hidden */
  28094. _scene: Scene;
  28095. /** @hidden */
  28096. _cache: any;
  28097. private _parentNode;
  28098. private _children;
  28099. /** @hidden */
  28100. _worldMatrix: Matrix;
  28101. /** @hidden */
  28102. _worldMatrixDeterminant: number;
  28103. /** @hidden */
  28104. _worldMatrixDeterminantIsDirty: boolean;
  28105. /** @hidden */
  28106. private _sceneRootNodesIndex;
  28107. /**
  28108. * Gets a boolean indicating if the node has been disposed
  28109. * @returns true if the node was disposed
  28110. */
  28111. isDisposed(): boolean;
  28112. /**
  28113. * Gets or sets the parent of the node (without keeping the current position in the scene)
  28114. * @see https://doc.babylonjs.com/how_to/parenting
  28115. */
  28116. parent: Nullable<Node>;
  28117. /** @hidden */
  28118. _addToSceneRootNodes(): void;
  28119. /** @hidden */
  28120. _removeFromSceneRootNodes(): void;
  28121. private _animationPropertiesOverride;
  28122. /**
  28123. * Gets or sets the animation properties override
  28124. */
  28125. animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  28126. /**
  28127. * Gets a string idenfifying the name of the class
  28128. * @returns "Node" string
  28129. */
  28130. getClassName(): string;
  28131. /** @hidden */
  28132. readonly _isNode: boolean;
  28133. /**
  28134. * An event triggered when the mesh is disposed
  28135. */
  28136. onDisposeObservable: Observable<Node>;
  28137. private _onDisposeObserver;
  28138. /**
  28139. * Sets a callback that will be raised when the node will be disposed
  28140. */
  28141. onDispose: () => void;
  28142. /**
  28143. * Creates a new Node
  28144. * @param name the name and id to be given to this node
  28145. * @param scene the scene this node will be added to
  28146. */
  28147. constructor(name: string, scene?: Nullable<Scene>);
  28148. /**
  28149. * Gets the scene of the node
  28150. * @returns a scene
  28151. */
  28152. getScene(): Scene;
  28153. /**
  28154. * Gets the engine of the node
  28155. * @returns a Engine
  28156. */
  28157. getEngine(): Engine;
  28158. private _behaviors;
  28159. /**
  28160. * Attach a behavior to the node
  28161. * @see http://doc.babylonjs.com/features/behaviour
  28162. * @param behavior defines the behavior to attach
  28163. * @param attachImmediately defines that the behavior must be attached even if the scene is still loading
  28164. * @returns the current Node
  28165. */
  28166. addBehavior(behavior: Behavior<Node>, attachImmediately?: boolean): Node;
  28167. /**
  28168. * Remove an attached behavior
  28169. * @see http://doc.babylonjs.com/features/behaviour
  28170. * @param behavior defines the behavior to attach
  28171. * @returns the current Node
  28172. */
  28173. removeBehavior(behavior: Behavior<Node>): Node;
  28174. /**
  28175. * Gets the list of attached behaviors
  28176. * @see http://doc.babylonjs.com/features/behaviour
  28177. */
  28178. readonly behaviors: Behavior<Node>[];
  28179. /**
  28180. * Gets an attached behavior by name
  28181. * @param name defines the name of the behavior to look for
  28182. * @see http://doc.babylonjs.com/features/behaviour
  28183. * @returns null if behavior was not found else the requested behavior
  28184. */
  28185. getBehaviorByName(name: string): Nullable<Behavior<Node>>;
  28186. /**
  28187. * Returns the latest update of the World matrix
  28188. * @returns a Matrix
  28189. */
  28190. getWorldMatrix(): Matrix;
  28191. /** @hidden */
  28192. _getWorldMatrixDeterminant(): number;
  28193. /**
  28194. * Returns directly the latest state of the mesh World matrix.
  28195. * A Matrix is returned.
  28196. */
  28197. readonly worldMatrixFromCache: Matrix;
  28198. /** @hidden */
  28199. _initCache(): void;
  28200. /** @hidden */
  28201. updateCache(force?: boolean): void;
  28202. /** @hidden */
  28203. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  28204. /** @hidden */
  28205. _updateCache(ignoreParentClass?: boolean): void;
  28206. /** @hidden */
  28207. _isSynchronized(): boolean;
  28208. /** @hidden */
  28209. _markSyncedWithParent(): void;
  28210. /** @hidden */
  28211. isSynchronizedWithParent(): boolean;
  28212. /** @hidden */
  28213. isSynchronized(): boolean;
  28214. /**
  28215. * Is this node ready to be used/rendered
  28216. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  28217. * @return true if the node is ready
  28218. */
  28219. isReady(completeCheck?: boolean): boolean;
  28220. /**
  28221. * Is this node enabled?
  28222. * 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
  28223. * @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
  28224. * @return whether this node (and its parent) is enabled
  28225. */
  28226. isEnabled(checkAncestors?: boolean): boolean;
  28227. /** @hidden */
  28228. protected _syncParentEnabledState(): void;
  28229. /**
  28230. * Set the enabled state of this node
  28231. * @param value defines the new enabled state
  28232. */
  28233. setEnabled(value: boolean): void;
  28234. /**
  28235. * Is this node a descendant of the given node?
  28236. * The function will iterate up the hierarchy until the ancestor was found or no more parents defined
  28237. * @param ancestor defines the parent node to inspect
  28238. * @returns a boolean indicating if this node is a descendant of the given node
  28239. */
  28240. isDescendantOf(ancestor: Node): boolean;
  28241. /** @hidden */
  28242. _getDescendants(results: Node[], directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): void;
  28243. /**
  28244. * Will return all nodes that have this node as ascendant
  28245. * @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
  28246. * @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
  28247. * @return all children nodes of all types
  28248. */
  28249. getDescendants(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): Node[];
  28250. /**
  28251. * Get all child-meshes of this node
  28252. * @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)
  28253. * @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
  28254. * @returns an array of AbstractMesh
  28255. */
  28256. getChildMeshes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): AbstractMesh[];
  28257. /**
  28258. * Get all direct children of this node
  28259. * @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
  28260. * @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)
  28261. * @returns an array of Node
  28262. */
  28263. getChildren(predicate?: (node: Node) => boolean, directDescendantsOnly?: boolean): Node[];
  28264. /** @hidden */
  28265. _setReady(state: boolean): void;
  28266. /**
  28267. * Get an animation by name
  28268. * @param name defines the name of the animation to look for
  28269. * @returns null if not found else the requested animation
  28270. */
  28271. getAnimationByName(name: string): Nullable<Animation>;
  28272. /**
  28273. * Creates an animation range for this node
  28274. * @param name defines the name of the range
  28275. * @param from defines the starting key
  28276. * @param to defines the end key
  28277. */
  28278. createAnimationRange(name: string, from: number, to: number): void;
  28279. /**
  28280. * Delete a specific animation range
  28281. * @param name defines the name of the range to delete
  28282. * @param deleteFrames defines if animation frames from the range must be deleted as well
  28283. */
  28284. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  28285. /**
  28286. * Get an animation range by name
  28287. * @param name defines the name of the animation range to look for
  28288. * @returns null if not found else the requested animation range
  28289. */
  28290. getAnimationRange(name: string): Nullable<AnimationRange>;
  28291. /**
  28292. * Gets the list of all animation ranges defined on this node
  28293. * @returns an array
  28294. */
  28295. getAnimationRanges(): Nullable<AnimationRange>[];
  28296. /**
  28297. * Will start the animation sequence
  28298. * @param name defines the range frames for animation sequence
  28299. * @param loop defines if the animation should loop (false by default)
  28300. * @param speedRatio defines the speed factor in which to run the animation (1 by default)
  28301. * @param onAnimationEnd defines a function to be executed when the animation ended (undefined by default)
  28302. * @returns the object created for this animation. If range does not exist, it will return null
  28303. */
  28304. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  28305. /**
  28306. * Serialize animation ranges into a JSON compatible object
  28307. * @returns serialization object
  28308. */
  28309. serializeAnimationRanges(): any;
  28310. /**
  28311. * Computes the world matrix of the node
  28312. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  28313. * @returns the world matrix
  28314. */
  28315. computeWorldMatrix(force?: boolean): Matrix;
  28316. /**
  28317. * Releases resources associated with this node.
  28318. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  28319. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  28320. */
  28321. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  28322. /**
  28323. * Parse animation range data from a serialization object and store them into a given node
  28324. * @param node defines where to store the animation ranges
  28325. * @param parsedNode defines the serialization object to read data from
  28326. * @param scene defines the hosting scene
  28327. */
  28328. static ParseAnimationRanges(node: Node, parsedNode: any, scene: Scene): void;
  28329. /**
  28330. * Return the minimum and maximum world vectors of the entire hierarchy under current node
  28331. * @param includeDescendants Include bounding info from descendants as well (true by default)
  28332. * @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
  28333. * @returns the new bounding vectors
  28334. */
  28335. getHierarchyBoundingVectors(includeDescendants?: boolean, predicate?: Nullable<(abstractMesh: AbstractMesh) => boolean>): {
  28336. min: Vector3;
  28337. max: Vector3;
  28338. };
  28339. }
  28340. }
  28341. declare module "babylonjs/Animations/animation" {
  28342. import { IEasingFunction, EasingFunction } from "babylonjs/Animations/easing";
  28343. import { Vector3, Quaternion, Vector2, Matrix } from "babylonjs/Maths/math.vector";
  28344. import { Color3, Color4 } from "babylonjs/Maths/math.color";
  28345. import { Nullable } from "babylonjs/types";
  28346. import { Scene } from "babylonjs/scene";
  28347. import { IAnimationKey } from "babylonjs/Animations/animationKey";
  28348. import { AnimationRange } from "babylonjs/Animations/animationRange";
  28349. import { AnimationEvent } from "babylonjs/Animations/animationEvent";
  28350. import { Node } from "babylonjs/node";
  28351. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  28352. import { Size } from "babylonjs/Maths/math.size";
  28353. import { Animatable } from "babylonjs/Animations/animatable";
  28354. import { RuntimeAnimation } from "babylonjs/Animations/runtimeAnimation";
  28355. /**
  28356. * @hidden
  28357. */
  28358. export class _IAnimationState {
  28359. key: number;
  28360. repeatCount: number;
  28361. workValue?: any;
  28362. loopMode?: number;
  28363. offsetValue?: any;
  28364. highLimitValue?: any;
  28365. }
  28366. /**
  28367. * Class used to store any kind of animation
  28368. */
  28369. export class Animation {
  28370. /**Name of the animation */
  28371. name: string;
  28372. /**Property to animate */
  28373. targetProperty: string;
  28374. /**The frames per second of the animation */
  28375. framePerSecond: number;
  28376. /**The data type of the animation */
  28377. dataType: number;
  28378. /**The loop mode of the animation */
  28379. loopMode?: number | undefined;
  28380. /**Specifies if blending should be enabled */
  28381. enableBlending?: boolean | undefined;
  28382. /**
  28383. * Use matrix interpolation instead of using direct key value when animating matrices
  28384. */
  28385. static AllowMatricesInterpolation: boolean;
  28386. /**
  28387. * When matrix interpolation is enabled, this boolean forces the system to use Matrix.DecomposeLerp instead of Matrix.Lerp. Interpolation is more precise but slower
  28388. */
  28389. static AllowMatrixDecomposeForInterpolation: boolean;
  28390. /**
  28391. * Stores the key frames of the animation
  28392. */
  28393. private _keys;
  28394. /**
  28395. * Stores the easing function of the animation
  28396. */
  28397. private _easingFunction;
  28398. /**
  28399. * @hidden Internal use only
  28400. */
  28401. _runtimeAnimations: import("babylonjs/Animations/runtimeAnimation").RuntimeAnimation[];
  28402. /**
  28403. * The set of event that will be linked to this animation
  28404. */
  28405. private _events;
  28406. /**
  28407. * Stores an array of target property paths
  28408. */
  28409. targetPropertyPath: string[];
  28410. /**
  28411. * Stores the blending speed of the animation
  28412. */
  28413. blendingSpeed: number;
  28414. /**
  28415. * Stores the animation ranges for the animation
  28416. */
  28417. private _ranges;
  28418. /**
  28419. * @hidden Internal use
  28420. */
  28421. static _PrepareAnimation(name: string, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction): Nullable<Animation>;
  28422. /**
  28423. * Sets up an animation
  28424. * @param property The property to animate
  28425. * @param animationType The animation type to apply
  28426. * @param framePerSecond The frames per second of the animation
  28427. * @param easingFunction The easing function used in the animation
  28428. * @returns The created animation
  28429. */
  28430. static CreateAnimation(property: string, animationType: number, framePerSecond: number, easingFunction: EasingFunction): Animation;
  28431. /**
  28432. * Create and start an animation on a node
  28433. * @param name defines the name of the global animation that will be run on all nodes
  28434. * @param node defines the root node where the animation will take place
  28435. * @param targetProperty defines property to animate
  28436. * @param framePerSecond defines the number of frame per second yo use
  28437. * @param totalFrame defines the number of frames in total
  28438. * @param from defines the initial value
  28439. * @param to defines the final value
  28440. * @param loopMode defines which loop mode you want to use (off by default)
  28441. * @param easingFunction defines the easing function to use (linear by default)
  28442. * @param onAnimationEnd defines the callback to call when animation end
  28443. * @returns the animatable created for this animation
  28444. */
  28445. static CreateAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  28446. /**
  28447. * Create and start an animation on a node and its descendants
  28448. * @param name defines the name of the global animation that will be run on all nodes
  28449. * @param node defines the root node where the animation will take place
  28450. * @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
  28451. * @param targetProperty defines property to animate
  28452. * @param framePerSecond defines the number of frame per second to use
  28453. * @param totalFrame defines the number of frames in total
  28454. * @param from defines the initial value
  28455. * @param to defines the final value
  28456. * @param loopMode defines which loop mode you want to use (off by default)
  28457. * @param easingFunction defines the easing function to use (linear by default)
  28458. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  28459. * @returns the list of animatables created for all nodes
  28460. * @example https://www.babylonjs-playground.com/#MH0VLI
  28461. */
  28462. 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[]>;
  28463. /**
  28464. * Creates a new animation, merges it with the existing animations and starts it
  28465. * @param name Name of the animation
  28466. * @param node Node which contains the scene that begins the animations
  28467. * @param targetProperty Specifies which property to animate
  28468. * @param framePerSecond The frames per second of the animation
  28469. * @param totalFrame The total number of frames
  28470. * @param from The frame at the beginning of the animation
  28471. * @param to The frame at the end of the animation
  28472. * @param loopMode Specifies the loop mode of the animation
  28473. * @param easingFunction (Optional) The easing function of the animation, which allow custom mathematical formulas for animations
  28474. * @param onAnimationEnd Callback to run once the animation is complete
  28475. * @returns Nullable animation
  28476. */
  28477. static CreateMergeAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  28478. /**
  28479. * Transition property of an host to the target Value
  28480. * @param property The property to transition
  28481. * @param targetValue The target Value of the property
  28482. * @param host The object where the property to animate belongs
  28483. * @param scene Scene used to run the animation
  28484. * @param frameRate Framerate (in frame/s) to use
  28485. * @param transition The transition type we want to use
  28486. * @param duration The duration of the animation, in milliseconds
  28487. * @param onAnimationEnd Callback trigger at the end of the animation
  28488. * @returns Nullable animation
  28489. */
  28490. static TransitionTo(property: string, targetValue: any, host: any, scene: Scene, frameRate: number, transition: Animation, duration: number, onAnimationEnd?: Nullable<() => void>): Nullable<Animatable>;
  28491. /**
  28492. * Return the array of runtime animations currently using this animation
  28493. */
  28494. readonly runtimeAnimations: RuntimeAnimation[];
  28495. /**
  28496. * Specifies if any of the runtime animations are currently running
  28497. */
  28498. readonly hasRunningRuntimeAnimations: boolean;
  28499. /**
  28500. * Initializes the animation
  28501. * @param name Name of the animation
  28502. * @param targetProperty Property to animate
  28503. * @param framePerSecond The frames per second of the animation
  28504. * @param dataType The data type of the animation
  28505. * @param loopMode The loop mode of the animation
  28506. * @param enableBlending Specifies if blending should be enabled
  28507. */
  28508. constructor(
  28509. /**Name of the animation */
  28510. name: string,
  28511. /**Property to animate */
  28512. targetProperty: string,
  28513. /**The frames per second of the animation */
  28514. framePerSecond: number,
  28515. /**The data type of the animation */
  28516. dataType: number,
  28517. /**The loop mode of the animation */
  28518. loopMode?: number | undefined,
  28519. /**Specifies if blending should be enabled */
  28520. enableBlending?: boolean | undefined);
  28521. /**
  28522. * Converts the animation to a string
  28523. * @param fullDetails support for multiple levels of logging within scene loading
  28524. * @returns String form of the animation
  28525. */
  28526. toString(fullDetails?: boolean): string;
  28527. /**
  28528. * Add an event to this animation
  28529. * @param event Event to add
  28530. */
  28531. addEvent(event: AnimationEvent): void;
  28532. /**
  28533. * Remove all events found at the given frame
  28534. * @param frame The frame to remove events from
  28535. */
  28536. removeEvents(frame: number): void;
  28537. /**
  28538. * Retrieves all the events from the animation
  28539. * @returns Events from the animation
  28540. */
  28541. getEvents(): AnimationEvent[];
  28542. /**
  28543. * Creates an animation range
  28544. * @param name Name of the animation range
  28545. * @param from Starting frame of the animation range
  28546. * @param to Ending frame of the animation
  28547. */
  28548. createRange(name: string, from: number, to: number): void;
  28549. /**
  28550. * Deletes an animation range by name
  28551. * @param name Name of the animation range to delete
  28552. * @param deleteFrames Specifies if the key frames for the range should also be deleted (true) or not (false)
  28553. */
  28554. deleteRange(name: string, deleteFrames?: boolean): void;
  28555. /**
  28556. * Gets the animation range by name, or null if not defined
  28557. * @param name Name of the animation range
  28558. * @returns Nullable animation range
  28559. */
  28560. getRange(name: string): Nullable<AnimationRange>;
  28561. /**
  28562. * Gets the key frames from the animation
  28563. * @returns The key frames of the animation
  28564. */
  28565. getKeys(): Array<IAnimationKey>;
  28566. /**
  28567. * Gets the highest frame rate of the animation
  28568. * @returns Highest frame rate of the animation
  28569. */
  28570. getHighestFrame(): number;
  28571. /**
  28572. * Gets the easing function of the animation
  28573. * @returns Easing function of the animation
  28574. */
  28575. getEasingFunction(): IEasingFunction;
  28576. /**
  28577. * Sets the easing function of the animation
  28578. * @param easingFunction A custom mathematical formula for animation
  28579. */
  28580. setEasingFunction(easingFunction: EasingFunction): void;
  28581. /**
  28582. * Interpolates a scalar linearly
  28583. * @param startValue Start value of the animation curve
  28584. * @param endValue End value of the animation curve
  28585. * @param gradient Scalar amount to interpolate
  28586. * @returns Interpolated scalar value
  28587. */
  28588. floatInterpolateFunction(startValue: number, endValue: number, gradient: number): number;
  28589. /**
  28590. * Interpolates a scalar cubically
  28591. * @param startValue Start value of the animation curve
  28592. * @param outTangent End tangent of the animation
  28593. * @param endValue End value of the animation curve
  28594. * @param inTangent Start tangent of the animation curve
  28595. * @param gradient Scalar amount to interpolate
  28596. * @returns Interpolated scalar value
  28597. */
  28598. floatInterpolateFunctionWithTangents(startValue: number, outTangent: number, endValue: number, inTangent: number, gradient: number): number;
  28599. /**
  28600. * Interpolates a quaternion using a spherical linear interpolation
  28601. * @param startValue Start value of the animation curve
  28602. * @param endValue End value of the animation curve
  28603. * @param gradient Scalar amount to interpolate
  28604. * @returns Interpolated quaternion value
  28605. */
  28606. quaternionInterpolateFunction(startValue: Quaternion, endValue: Quaternion, gradient: number): Quaternion;
  28607. /**
  28608. * Interpolates a quaternion cubically
  28609. * @param startValue Start value of the animation curve
  28610. * @param outTangent End tangent of the animation curve
  28611. * @param endValue End value of the animation curve
  28612. * @param inTangent Start tangent of the animation curve
  28613. * @param gradient Scalar amount to interpolate
  28614. * @returns Interpolated quaternion value
  28615. */
  28616. quaternionInterpolateFunctionWithTangents(startValue: Quaternion, outTangent: Quaternion, endValue: Quaternion, inTangent: Quaternion, gradient: number): Quaternion;
  28617. /**
  28618. * Interpolates a Vector3 linearl
  28619. * @param startValue Start value of the animation curve
  28620. * @param endValue End value of the animation curve
  28621. * @param gradient Scalar amount to interpolate
  28622. * @returns Interpolated scalar value
  28623. */
  28624. vector3InterpolateFunction(startValue: Vector3, endValue: Vector3, gradient: number): Vector3;
  28625. /**
  28626. * Interpolates a Vector3 cubically
  28627. * @param startValue Start value of the animation curve
  28628. * @param outTangent End tangent of the animation
  28629. * @param endValue End value of the animation curve
  28630. * @param inTangent Start tangent of the animation curve
  28631. * @param gradient Scalar amount to interpolate
  28632. * @returns InterpolatedVector3 value
  28633. */
  28634. vector3InterpolateFunctionWithTangents(startValue: Vector3, outTangent: Vector3, endValue: Vector3, inTangent: Vector3, gradient: number): Vector3;
  28635. /**
  28636. * Interpolates a Vector2 linearly
  28637. * @param startValue Start value of the animation curve
  28638. * @param endValue End value of the animation curve
  28639. * @param gradient Scalar amount to interpolate
  28640. * @returns Interpolated Vector2 value
  28641. */
  28642. vector2InterpolateFunction(startValue: Vector2, endValue: Vector2, gradient: number): Vector2;
  28643. /**
  28644. * Interpolates a Vector2 cubically
  28645. * @param startValue Start value of the animation curve
  28646. * @param outTangent End tangent of the animation
  28647. * @param endValue End value of the animation curve
  28648. * @param inTangent Start tangent of the animation curve
  28649. * @param gradient Scalar amount to interpolate
  28650. * @returns Interpolated Vector2 value
  28651. */
  28652. vector2InterpolateFunctionWithTangents(startValue: Vector2, outTangent: Vector2, endValue: Vector2, inTangent: Vector2, gradient: number): Vector2;
  28653. /**
  28654. * Interpolates a size linearly
  28655. * @param startValue Start value of the animation curve
  28656. * @param endValue End value of the animation curve
  28657. * @param gradient Scalar amount to interpolate
  28658. * @returns Interpolated Size value
  28659. */
  28660. sizeInterpolateFunction(startValue: Size, endValue: Size, gradient: number): Size;
  28661. /**
  28662. * Interpolates a Color3 linearly
  28663. * @param startValue Start value of the animation curve
  28664. * @param endValue End value of the animation curve
  28665. * @param gradient Scalar amount to interpolate
  28666. * @returns Interpolated Color3 value
  28667. */
  28668. color3InterpolateFunction(startValue: Color3, endValue: Color3, gradient: number): Color3;
  28669. /**
  28670. * Interpolates a Color4 linearly
  28671. * @param startValue Start value of the animation curve
  28672. * @param endValue End value of the animation curve
  28673. * @param gradient Scalar amount to interpolate
  28674. * @returns Interpolated Color3 value
  28675. */
  28676. color4InterpolateFunction(startValue: Color4, endValue: Color4, gradient: number): Color4;
  28677. /**
  28678. * @hidden Internal use only
  28679. */
  28680. _getKeyValue(value: any): any;
  28681. /**
  28682. * @hidden Internal use only
  28683. */
  28684. _interpolate(currentFrame: number, state: _IAnimationState): any;
  28685. /**
  28686. * Defines the function to use to interpolate matrices
  28687. * @param startValue defines the start matrix
  28688. * @param endValue defines the end matrix
  28689. * @param gradient defines the gradient between both matrices
  28690. * @param result defines an optional target matrix where to store the interpolation
  28691. * @returns the interpolated matrix
  28692. */
  28693. matrixInterpolateFunction(startValue: Matrix, endValue: Matrix, gradient: number, result?: Matrix): Matrix;
  28694. /**
  28695. * Makes a copy of the animation
  28696. * @returns Cloned animation
  28697. */
  28698. clone(): Animation;
  28699. /**
  28700. * Sets the key frames of the animation
  28701. * @param values The animation key frames to set
  28702. */
  28703. setKeys(values: Array<IAnimationKey>): void;
  28704. /**
  28705. * Serializes the animation to an object
  28706. * @returns Serialized object
  28707. */
  28708. serialize(): any;
  28709. /**
  28710. * Float animation type
  28711. */
  28712. static readonly ANIMATIONTYPE_FLOAT: number;
  28713. /**
  28714. * Vector3 animation type
  28715. */
  28716. static readonly ANIMATIONTYPE_VECTOR3: number;
  28717. /**
  28718. * Quaternion animation type
  28719. */
  28720. static readonly ANIMATIONTYPE_QUATERNION: number;
  28721. /**
  28722. * Matrix animation type
  28723. */
  28724. static readonly ANIMATIONTYPE_MATRIX: number;
  28725. /**
  28726. * Color3 animation type
  28727. */
  28728. static readonly ANIMATIONTYPE_COLOR3: number;
  28729. /**
  28730. * Color3 animation type
  28731. */
  28732. static readonly ANIMATIONTYPE_COLOR4: number;
  28733. /**
  28734. * Vector2 animation type
  28735. */
  28736. static readonly ANIMATIONTYPE_VECTOR2: number;
  28737. /**
  28738. * Size animation type
  28739. */
  28740. static readonly ANIMATIONTYPE_SIZE: number;
  28741. /**
  28742. * Relative Loop Mode
  28743. */
  28744. static readonly ANIMATIONLOOPMODE_RELATIVE: number;
  28745. /**
  28746. * Cycle Loop Mode
  28747. */
  28748. static readonly ANIMATIONLOOPMODE_CYCLE: number;
  28749. /**
  28750. * Constant Loop Mode
  28751. */
  28752. static readonly ANIMATIONLOOPMODE_CONSTANT: number;
  28753. /** @hidden */
  28754. static _UniversalLerp(left: any, right: any, amount: number): any;
  28755. /**
  28756. * Parses an animation object and creates an animation
  28757. * @param parsedAnimation Parsed animation object
  28758. * @returns Animation object
  28759. */
  28760. static Parse(parsedAnimation: any): Animation;
  28761. /**
  28762. * Appends the serialized animations from the source animations
  28763. * @param source Source containing the animations
  28764. * @param destination Target to store the animations
  28765. */
  28766. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  28767. }
  28768. }
  28769. declare module "babylonjs/Animations/animatable.interface" {
  28770. import { Nullable } from "babylonjs/types";
  28771. import { Animation } from "babylonjs/Animations/animation";
  28772. /**
  28773. * Interface containing an array of animations
  28774. */
  28775. export interface IAnimatable {
  28776. /**
  28777. * Array of animations
  28778. */
  28779. animations: Nullable<Array<Animation>>;
  28780. }
  28781. }
  28782. declare module "babylonjs/Materials/fresnelParameters" {
  28783. import { Color3 } from "babylonjs/Maths/math.color";
  28784. /**
  28785. * This represents all the required information to add a fresnel effect on a material:
  28786. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  28787. */
  28788. export class FresnelParameters {
  28789. private _isEnabled;
  28790. /**
  28791. * Define if the fresnel effect is enable or not.
  28792. */
  28793. isEnabled: boolean;
  28794. /**
  28795. * Define the color used on edges (grazing angle)
  28796. */
  28797. leftColor: Color3;
  28798. /**
  28799. * Define the color used on center
  28800. */
  28801. rightColor: Color3;
  28802. /**
  28803. * Define bias applied to computed fresnel term
  28804. */
  28805. bias: number;
  28806. /**
  28807. * Defined the power exponent applied to fresnel term
  28808. */
  28809. power: number;
  28810. /**
  28811. * Clones the current fresnel and its valuues
  28812. * @returns a clone fresnel configuration
  28813. */
  28814. clone(): FresnelParameters;
  28815. /**
  28816. * Serializes the current fresnel parameters to a JSON representation.
  28817. * @return the JSON serialization
  28818. */
  28819. serialize(): any;
  28820. /**
  28821. * Parse a JSON object and deserialize it to a new Fresnel parameter object.
  28822. * @param parsedFresnelParameters Define the JSON representation
  28823. * @returns the parsed parameters
  28824. */
  28825. static Parse(parsedFresnelParameters: any): FresnelParameters;
  28826. }
  28827. }
  28828. declare module "babylonjs/Misc/decorators" {
  28829. import { Nullable } from "babylonjs/types";
  28830. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  28831. import { Scene } from "babylonjs/scene";
  28832. export function expandToProperty(callback: string, targetKey?: Nullable<string>): (target: any, propertyKey: string) => void;
  28833. export function serialize(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28834. export function serializeAsTexture(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28835. export function serializeAsColor3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28836. export function serializeAsFresnelParameters(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28837. export function serializeAsVector2(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28838. export function serializeAsVector3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28839. export function serializeAsMeshReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28840. export function serializeAsColorCurves(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28841. export function serializeAsColor4(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28842. export function serializeAsImageProcessingConfiguration(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28843. export function serializeAsQuaternion(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28844. export function serializeAsMatrix(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28845. /**
  28846. * Decorator used to define property that can be serialized as reference to a camera
  28847. * @param sourceName defines the name of the property to decorate
  28848. */
  28849. export function serializeAsCameraReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  28850. /**
  28851. * Class used to help serialization objects
  28852. */
  28853. export class SerializationHelper {
  28854. /** @hidden */
  28855. static _ImageProcessingConfigurationParser: (sourceProperty: any) => import("babylonjs/Materials/imageProcessingConfiguration").ImageProcessingConfiguration;
  28856. /** @hidden */
  28857. static _FresnelParametersParser: (sourceProperty: any) => import("babylonjs/Materials/fresnelParameters").FresnelParameters;
  28858. /** @hidden */
  28859. static _ColorCurvesParser: (sourceProperty: any) => import("babylonjs/Materials/colorCurves").ColorCurves;
  28860. /** @hidden */
  28861. static _TextureParser: (sourceProperty: any, scene: import("babylonjs/scene").Scene, rootUrl: string) => Nullable<import("babylonjs/Materials/Textures/baseTexture").BaseTexture>;
  28862. /**
  28863. * Appends the serialized animations from the source animations
  28864. * @param source Source containing the animations
  28865. * @param destination Target to store the animations
  28866. */
  28867. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  28868. /**
  28869. * Static function used to serialized a specific entity
  28870. * @param entity defines the entity to serialize
  28871. * @param serializationObject defines the optional target obecjt where serialization data will be stored
  28872. * @returns a JSON compatible object representing the serialization of the entity
  28873. */
  28874. static Serialize<T>(entity: T, serializationObject?: any): any;
  28875. /**
  28876. * Creates a new entity from a serialization data object
  28877. * @param creationFunction defines a function used to instanciated the new entity
  28878. * @param source defines the source serialization data
  28879. * @param scene defines the hosting scene
  28880. * @param rootUrl defines the root url for resources
  28881. * @returns a new entity
  28882. */
  28883. static Parse<T>(creationFunction: () => T, source: any, scene: Nullable<Scene>, rootUrl?: Nullable<string>): T;
  28884. /**
  28885. * Clones an object
  28886. * @param creationFunction defines the function used to instanciate the new object
  28887. * @param source defines the source object
  28888. * @returns the cloned object
  28889. */
  28890. static Clone<T>(creationFunction: () => T, source: T): T;
  28891. /**
  28892. * Instanciates a new object based on a source one (some data will be shared between both object)
  28893. * @param creationFunction defines the function used to instanciate the new object
  28894. * @param source defines the source object
  28895. * @returns the new object
  28896. */
  28897. static Instanciate<T>(creationFunction: () => T, source: T): T;
  28898. }
  28899. }
  28900. declare module "babylonjs/Misc/guid" {
  28901. /**
  28902. * Class used to manipulate GUIDs
  28903. */
  28904. export class GUID {
  28905. /**
  28906. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  28907. * Be aware Math.random() could cause collisions, but:
  28908. * "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"
  28909. * @returns a pseudo random id
  28910. */
  28911. static RandomId(): string;
  28912. }
  28913. }
  28914. declare module "babylonjs/Materials/Textures/baseTexture" {
  28915. import { Observable } from "babylonjs/Misc/observable";
  28916. import { Nullable } from "babylonjs/types";
  28917. import { Scene } from "babylonjs/scene";
  28918. import { Matrix } from "babylonjs/Maths/math.vector";
  28919. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  28920. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  28921. import { ISize } from "babylonjs/Maths/math.size";
  28922. /**
  28923. * Base class of all the textures in babylon.
  28924. * It groups all the common properties the materials, post process, lights... might need
  28925. * in order to make a correct use of the texture.
  28926. */
  28927. export class BaseTexture implements IAnimatable {
  28928. /**
  28929. * Default anisotropic filtering level for the application.
  28930. * It is set to 4 as a good tradeoff between perf and quality.
  28931. */
  28932. static DEFAULT_ANISOTROPIC_FILTERING_LEVEL: number;
  28933. /**
  28934. * Gets or sets the unique id of the texture
  28935. */
  28936. uniqueId: number;
  28937. /**
  28938. * Define the name of the texture.
  28939. */
  28940. name: string;
  28941. /**
  28942. * Gets or sets an object used to store user defined information.
  28943. */
  28944. metadata: any;
  28945. /**
  28946. * For internal use only. Please do not use.
  28947. */
  28948. reservedDataStore: any;
  28949. private _hasAlpha;
  28950. /**
  28951. * Define if the texture is having a usable alpha value (can be use for transparency or glossiness for instance).
  28952. */
  28953. hasAlpha: boolean;
  28954. /**
  28955. * Defines if the alpha value should be determined via the rgb values.
  28956. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  28957. */
  28958. getAlphaFromRGB: boolean;
  28959. /**
  28960. * Intensity or strength of the texture.
  28961. * It is commonly used by materials to fine tune the intensity of the texture
  28962. */
  28963. level: number;
  28964. /**
  28965. * Define the UV chanel to use starting from 0 and defaulting to 0.
  28966. * This is part of the texture as textures usually maps to one uv set.
  28967. */
  28968. coordinatesIndex: number;
  28969. private _coordinatesMode;
  28970. /**
  28971. * How a texture is mapped.
  28972. *
  28973. * | Value | Type | Description |
  28974. * | ----- | ----------------------------------- | ----------- |
  28975. * | 0 | EXPLICIT_MODE | |
  28976. * | 1 | SPHERICAL_MODE | |
  28977. * | 2 | PLANAR_MODE | |
  28978. * | 3 | CUBIC_MODE | |
  28979. * | 4 | PROJECTION_MODE | |
  28980. * | 5 | SKYBOX_MODE | |
  28981. * | 6 | INVCUBIC_MODE | |
  28982. * | 7 | EQUIRECTANGULAR_MODE | |
  28983. * | 8 | FIXED_EQUIRECTANGULAR_MODE | |
  28984. * | 9 | FIXED_EQUIRECTANGULAR_MIRRORED_MODE | |
  28985. */
  28986. coordinatesMode: number;
  28987. /**
  28988. * | Value | Type | Description |
  28989. * | ----- | ------------------ | ----------- |
  28990. * | 0 | CLAMP_ADDRESSMODE | |
  28991. * | 1 | WRAP_ADDRESSMODE | |
  28992. * | 2 | MIRROR_ADDRESSMODE | |
  28993. */
  28994. wrapU: number;
  28995. /**
  28996. * | Value | Type | Description |
  28997. * | ----- | ------------------ | ----------- |
  28998. * | 0 | CLAMP_ADDRESSMODE | |
  28999. * | 1 | WRAP_ADDRESSMODE | |
  29000. * | 2 | MIRROR_ADDRESSMODE | |
  29001. */
  29002. wrapV: number;
  29003. /**
  29004. * | Value | Type | Description |
  29005. * | ----- | ------------------ | ----------- |
  29006. * | 0 | CLAMP_ADDRESSMODE | |
  29007. * | 1 | WRAP_ADDRESSMODE | |
  29008. * | 2 | MIRROR_ADDRESSMODE | |
  29009. */
  29010. wrapR: number;
  29011. /**
  29012. * With compliant hardware and browser (supporting anisotropic filtering)
  29013. * this defines the level of anisotropic filtering in the texture.
  29014. * The higher the better but the slower. This defaults to 4 as it seems to be the best tradeoff.
  29015. */
  29016. anisotropicFilteringLevel: number;
  29017. /**
  29018. * Define if the texture is a cube texture or if false a 2d texture.
  29019. */
  29020. isCube: boolean;
  29021. /**
  29022. * Define if the texture is a 3d texture (webgl 2) or if false a 2d texture.
  29023. */
  29024. is3D: boolean;
  29025. /**
  29026. * Define if the texture is a 2d array texture (webgl 2) or if false a 2d texture.
  29027. */
  29028. is2DArray: boolean;
  29029. /**
  29030. * Define if the texture contains data in gamma space (most of the png/jpg aside bump).
  29031. * HDR texture are usually stored in linear space.
  29032. * This only impacts the PBR and Background materials
  29033. */
  29034. gammaSpace: boolean;
  29035. /**
  29036. * Gets or sets whether or not the texture contains RGBD data.
  29037. */
  29038. isRGBD: boolean;
  29039. /**
  29040. * Is Z inverted in the texture (useful in a cube texture).
  29041. */
  29042. invertZ: boolean;
  29043. /**
  29044. * Are mip maps generated for this texture or not.
  29045. */
  29046. readonly noMipmap: boolean;
  29047. /**
  29048. * @hidden
  29049. */
  29050. lodLevelInAlpha: boolean;
  29051. /**
  29052. * With prefiltered texture, defined the offset used during the prefiltering steps.
  29053. */
  29054. lodGenerationOffset: number;
  29055. /**
  29056. * With prefiltered texture, defined the scale used during the prefiltering steps.
  29057. */
  29058. lodGenerationScale: number;
  29059. /**
  29060. * With prefiltered texture, defined if the specular generation is based on a linear ramp.
  29061. * By default we are using a log2 of the linear roughness helping to keep a better resolution for
  29062. * average roughness values.
  29063. */
  29064. linearSpecularLOD: boolean;
  29065. /**
  29066. * In case a better definition than spherical harmonics is required for the diffuse part of the environment.
  29067. * You can set the irradiance texture to rely on a texture instead of the spherical approach.
  29068. * This texture need to have the same characteristics than its parent (Cube vs 2d, coordinates mode, Gamma/Linear, RGBD).
  29069. */
  29070. irradianceTexture: Nullable<BaseTexture>;
  29071. /**
  29072. * Define if the texture is a render target.
  29073. */
  29074. isRenderTarget: boolean;
  29075. /**
  29076. * Define the unique id of the texture in the scene.
  29077. */
  29078. readonly uid: string;
  29079. /**
  29080. * Return a string representation of the texture.
  29081. * @returns the texture as a string
  29082. */
  29083. toString(): string;
  29084. /**
  29085. * Get the class name of the texture.
  29086. * @returns "BaseTexture"
  29087. */
  29088. getClassName(): string;
  29089. /**
  29090. * Define the list of animation attached to the texture.
  29091. */
  29092. animations: import("babylonjs/Animations/animation").Animation[];
  29093. /**
  29094. * An event triggered when the texture is disposed.
  29095. */
  29096. onDisposeObservable: Observable<BaseTexture>;
  29097. private _onDisposeObserver;
  29098. /**
  29099. * Callback triggered when the texture has been disposed.
  29100. * Kept for back compatibility, you can use the onDisposeObservable instead.
  29101. */
  29102. onDispose: () => void;
  29103. /**
  29104. * Define the current state of the loading sequence when in delayed load mode.
  29105. */
  29106. delayLoadState: number;
  29107. private _scene;
  29108. /** @hidden */
  29109. _texture: Nullable<InternalTexture>;
  29110. private _uid;
  29111. /**
  29112. * Define if the texture is preventinga material to render or not.
  29113. * If not and the texture is not ready, the engine will use a default black texture instead.
  29114. */
  29115. readonly isBlocking: boolean;
  29116. /**
  29117. * Instantiates a new BaseTexture.
  29118. * Base class of all the textures in babylon.
  29119. * It groups all the common properties the materials, post process, lights... might need
  29120. * in order to make a correct use of the texture.
  29121. * @param scene Define the scene the texture blongs to
  29122. */
  29123. constructor(scene: Nullable<Scene>);
  29124. /**
  29125. * Get the scene the texture belongs to.
  29126. * @returns the scene or null if undefined
  29127. */
  29128. getScene(): Nullable<Scene>;
  29129. /**
  29130. * Get the texture transform matrix used to offset tile the texture for istance.
  29131. * @returns the transformation matrix
  29132. */
  29133. getTextureMatrix(): Matrix;
  29134. /**
  29135. * Get the texture reflection matrix used to rotate/transform the reflection.
  29136. * @returns the reflection matrix
  29137. */
  29138. getReflectionTextureMatrix(): Matrix;
  29139. /**
  29140. * Get the underlying lower level texture from Babylon.
  29141. * @returns the insternal texture
  29142. */
  29143. getInternalTexture(): Nullable<InternalTexture>;
  29144. /**
  29145. * Get if the texture is ready to be consumed (either it is ready or it is not blocking)
  29146. * @returns true if ready or not blocking
  29147. */
  29148. isReadyOrNotBlocking(): boolean;
  29149. /**
  29150. * Get if the texture is ready to be used (downloaded, converted, mip mapped...).
  29151. * @returns true if fully ready
  29152. */
  29153. isReady(): boolean;
  29154. private _cachedSize;
  29155. /**
  29156. * Get the size of the texture.
  29157. * @returns the texture size.
  29158. */
  29159. getSize(): ISize;
  29160. /**
  29161. * Get the base size of the texture.
  29162. * It can be different from the size if the texture has been resized for POT for instance
  29163. * @returns the base size
  29164. */
  29165. getBaseSize(): ISize;
  29166. /**
  29167. * Update the sampling mode of the texture.
  29168. * Default is Trilinear mode.
  29169. *
  29170. * | Value | Type | Description |
  29171. * | ----- | ------------------ | ----------- |
  29172. * | 1 | NEAREST_SAMPLINGMODE or NEAREST_NEAREST_MIPLINEAR | Nearest is: mag = nearest, min = nearest, mip = linear |
  29173. * | 2 | BILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPNEAREST | Bilinear is: mag = linear, min = linear, mip = nearest |
  29174. * | 3 | TRILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPLINEAR | Trilinear is: mag = linear, min = linear, mip = linear |
  29175. * | 4 | NEAREST_NEAREST_MIPNEAREST | |
  29176. * | 5 | NEAREST_LINEAR_MIPNEAREST | |
  29177. * | 6 | NEAREST_LINEAR_MIPLINEAR | |
  29178. * | 7 | NEAREST_LINEAR | |
  29179. * | 8 | NEAREST_NEAREST | |
  29180. * | 9 | LINEAR_NEAREST_MIPNEAREST | |
  29181. * | 10 | LINEAR_NEAREST_MIPLINEAR | |
  29182. * | 11 | LINEAR_LINEAR | |
  29183. * | 12 | LINEAR_NEAREST | |
  29184. *
  29185. * > _mag_: magnification filter (close to the viewer)
  29186. * > _min_: minification filter (far from the viewer)
  29187. * > _mip_: filter used between mip map levels
  29188. *@param samplingMode Define the new sampling mode of the texture
  29189. */
  29190. updateSamplingMode(samplingMode: number): void;
  29191. /**
  29192. * Scales the texture if is `canRescale()`
  29193. * @param ratio the resize factor we want to use to rescale
  29194. */
  29195. scale(ratio: number): void;
  29196. /**
  29197. * Get if the texture can rescale.
  29198. */
  29199. readonly canRescale: boolean;
  29200. /** @hidden */
  29201. _getFromCache(url: Nullable<string>, noMipmap: boolean, sampling?: number, invertY?: boolean): Nullable<InternalTexture>;
  29202. /** @hidden */
  29203. _rebuild(): void;
  29204. /**
  29205. * Triggers the load sequence in delayed load mode.
  29206. */
  29207. delayLoad(): void;
  29208. /**
  29209. * Clones the texture.
  29210. * @returns the cloned texture
  29211. */
  29212. clone(): Nullable<BaseTexture>;
  29213. /**
  29214. * Get the texture underlying type (INT, FLOAT...)
  29215. */
  29216. readonly textureType: number;
  29217. /**
  29218. * Get the texture underlying format (RGB, RGBA...)
  29219. */
  29220. readonly textureFormat: number;
  29221. /**
  29222. * Indicates that textures need to be re-calculated for all materials
  29223. */
  29224. protected _markAllSubMeshesAsTexturesDirty(): void;
  29225. /**
  29226. * Reads the pixels stored in the webgl texture and returns them as an ArrayBuffer.
  29227. * This will returns an RGBA array buffer containing either in values (0-255) or
  29228. * float values (0-1) depending of the underlying buffer type.
  29229. * @param faceIndex defines the face of the texture to read (in case of cube texture)
  29230. * @param level defines the LOD level of the texture to read (in case of Mip Maps)
  29231. * @param buffer defines a user defined buffer to fill with data (can be null)
  29232. * @returns The Array buffer containing the pixels data.
  29233. */
  29234. readPixels(faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): Nullable<ArrayBufferView>;
  29235. /**
  29236. * Release and destroy the underlying lower level texture aka internalTexture.
  29237. */
  29238. releaseInternalTexture(): void;
  29239. /** @hidden */
  29240. readonly _lodTextureHigh: Nullable<BaseTexture>;
  29241. /** @hidden */
  29242. readonly _lodTextureMid: Nullable<BaseTexture>;
  29243. /** @hidden */
  29244. readonly _lodTextureLow: Nullable<BaseTexture>;
  29245. /**
  29246. * Dispose the texture and release its associated resources.
  29247. */
  29248. dispose(): void;
  29249. /**
  29250. * Serialize the texture into a JSON representation that can be parsed later on.
  29251. * @returns the JSON representation of the texture
  29252. */
  29253. serialize(): any;
  29254. /**
  29255. * Helper function to be called back once a list of texture contains only ready textures.
  29256. * @param textures Define the list of textures to wait for
  29257. * @param callback Define the callback triggered once the entire list will be ready
  29258. */
  29259. static WhenAllReady(textures: BaseTexture[], callback: () => void): void;
  29260. }
  29261. }
  29262. declare module "babylonjs/Materials/effect" {
  29263. import { Observable } from "babylonjs/Misc/observable";
  29264. import { Nullable } from "babylonjs/types";
  29265. import { IDisposable } from "babylonjs/scene";
  29266. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  29267. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  29268. import { IMatrixLike, IVector2Like, IVector3Like, IVector4Like, IColor3Like, IColor4Like } from "babylonjs/Maths/math.like";
  29269. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  29270. import { IEffectFallbacks } from "babylonjs/Materials/iEffectFallbacks";
  29271. import { Engine } from "babylonjs/Engines/engine";
  29272. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  29273. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  29274. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  29275. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  29276. /**
  29277. * Options to be used when creating an effect.
  29278. */
  29279. export interface IEffectCreationOptions {
  29280. /**
  29281. * Atrributes that will be used in the shader.
  29282. */
  29283. attributes: string[];
  29284. /**
  29285. * Uniform varible names that will be set in the shader.
  29286. */
  29287. uniformsNames: string[];
  29288. /**
  29289. * Uniform buffer variable names that will be set in the shader.
  29290. */
  29291. uniformBuffersNames: string[];
  29292. /**
  29293. * Sampler texture variable names that will be set in the shader.
  29294. */
  29295. samplers: string[];
  29296. /**
  29297. * Define statements that will be set in the shader.
  29298. */
  29299. defines: any;
  29300. /**
  29301. * Possible fallbacks for this effect to improve performance when needed.
  29302. */
  29303. fallbacks: Nullable<IEffectFallbacks>;
  29304. /**
  29305. * Callback that will be called when the shader is compiled.
  29306. */
  29307. onCompiled: Nullable<(effect: Effect) => void>;
  29308. /**
  29309. * Callback that will be called if an error occurs during shader compilation.
  29310. */
  29311. onError: Nullable<(effect: Effect, errors: string) => void>;
  29312. /**
  29313. * Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  29314. */
  29315. indexParameters?: any;
  29316. /**
  29317. * Max number of lights that can be used in the shader.
  29318. */
  29319. maxSimultaneousLights?: number;
  29320. /**
  29321. * See https://developer.mozilla.org/en-US/docs/Web/API/WebGL2RenderingContext/transformFeedbackVaryings
  29322. */
  29323. transformFeedbackVaryings?: Nullable<string[]>;
  29324. }
  29325. /**
  29326. * Effect containing vertex and fragment shader that can be executed on an object.
  29327. */
  29328. export class Effect implements IDisposable {
  29329. /**
  29330. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  29331. */
  29332. static ShadersRepository: string;
  29333. /**
  29334. * Name of the effect.
  29335. */
  29336. name: any;
  29337. /**
  29338. * String container all the define statements that should be set on the shader.
  29339. */
  29340. defines: string;
  29341. /**
  29342. * Callback that will be called when the shader is compiled.
  29343. */
  29344. onCompiled: Nullable<(effect: Effect) => void>;
  29345. /**
  29346. * Callback that will be called if an error occurs during shader compilation.
  29347. */
  29348. onError: Nullable<(effect: Effect, errors: string) => void>;
  29349. /**
  29350. * Callback that will be called when effect is bound.
  29351. */
  29352. onBind: Nullable<(effect: Effect) => void>;
  29353. /**
  29354. * Unique ID of the effect.
  29355. */
  29356. uniqueId: number;
  29357. /**
  29358. * Observable that will be called when the shader is compiled.
  29359. * It is recommended to use executeWhenCompile() or to make sure that scene.isReady() is called to get this observable raised.
  29360. */
  29361. onCompileObservable: Observable<Effect>;
  29362. /**
  29363. * Observable that will be called if an error occurs during shader compilation.
  29364. */
  29365. onErrorObservable: Observable<Effect>;
  29366. /** @hidden */
  29367. _onBindObservable: Nullable<Observable<Effect>>;
  29368. /**
  29369. * Observable that will be called when effect is bound.
  29370. */
  29371. readonly onBindObservable: Observable<Effect>;
  29372. /** @hidden */
  29373. _bonesComputationForcedToCPU: boolean;
  29374. private static _uniqueIdSeed;
  29375. private _engine;
  29376. private _uniformBuffersNames;
  29377. private _uniformsNames;
  29378. private _samplerList;
  29379. private _samplers;
  29380. private _isReady;
  29381. private _compilationError;
  29382. private _allFallbacksProcessed;
  29383. private _attributesNames;
  29384. private _attributes;
  29385. private _uniforms;
  29386. /**
  29387. * Key for the effect.
  29388. * @hidden
  29389. */
  29390. _key: string;
  29391. private _indexParameters;
  29392. private _fallbacks;
  29393. private _vertexSourceCode;
  29394. private _fragmentSourceCode;
  29395. private _vertexSourceCodeOverride;
  29396. private _fragmentSourceCodeOverride;
  29397. private _transformFeedbackVaryings;
  29398. /**
  29399. * Compiled shader to webGL program.
  29400. * @hidden
  29401. */
  29402. _pipelineContext: Nullable<IPipelineContext>;
  29403. private _valueCache;
  29404. private static _baseCache;
  29405. /**
  29406. * Instantiates an effect.
  29407. * An effect can be used to create/manage/execute vertex and fragment shaders.
  29408. * @param baseName Name of the effect.
  29409. * @param attributesNamesOrOptions List of attribute names that will be passed to the shader or set of all options to create the effect.
  29410. * @param uniformsNamesOrEngine List of uniform variable names that will be passed to the shader or the engine that will be used to render effect.
  29411. * @param samplers List of sampler variables that will be passed to the shader.
  29412. * @param engine Engine to be used to render the effect
  29413. * @param defines Define statements to be added to the shader.
  29414. * @param fallbacks Possible fallbacks for this effect to improve performance when needed.
  29415. * @param onCompiled Callback that will be called when the shader is compiled.
  29416. * @param onError Callback that will be called if an error occurs during shader compilation.
  29417. * @param indexParameters Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  29418. */
  29419. 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);
  29420. private _useFinalCode;
  29421. /**
  29422. * Unique key for this effect
  29423. */
  29424. readonly key: string;
  29425. /**
  29426. * If the effect has been compiled and prepared.
  29427. * @returns if the effect is compiled and prepared.
  29428. */
  29429. isReady(): boolean;
  29430. private _isReadyInternal;
  29431. /**
  29432. * The engine the effect was initialized with.
  29433. * @returns the engine.
  29434. */
  29435. getEngine(): Engine;
  29436. /**
  29437. * The pipeline context for this effect
  29438. * @returns the associated pipeline context
  29439. */
  29440. getPipelineContext(): Nullable<IPipelineContext>;
  29441. /**
  29442. * The set of names of attribute variables for the shader.
  29443. * @returns An array of attribute names.
  29444. */
  29445. getAttributesNames(): string[];
  29446. /**
  29447. * Returns the attribute at the given index.
  29448. * @param index The index of the attribute.
  29449. * @returns The location of the attribute.
  29450. */
  29451. getAttributeLocation(index: number): number;
  29452. /**
  29453. * Returns the attribute based on the name of the variable.
  29454. * @param name of the attribute to look up.
  29455. * @returns the attribute location.
  29456. */
  29457. getAttributeLocationByName(name: string): number;
  29458. /**
  29459. * The number of attributes.
  29460. * @returns the numnber of attributes.
  29461. */
  29462. getAttributesCount(): number;
  29463. /**
  29464. * Gets the index of a uniform variable.
  29465. * @param uniformName of the uniform to look up.
  29466. * @returns the index.
  29467. */
  29468. getUniformIndex(uniformName: string): number;
  29469. /**
  29470. * Returns the attribute based on the name of the variable.
  29471. * @param uniformName of the uniform to look up.
  29472. * @returns the location of the uniform.
  29473. */
  29474. getUniform(uniformName: string): Nullable<WebGLUniformLocation>;
  29475. /**
  29476. * Returns an array of sampler variable names
  29477. * @returns The array of sampler variable neames.
  29478. */
  29479. getSamplers(): string[];
  29480. /**
  29481. * The error from the last compilation.
  29482. * @returns the error string.
  29483. */
  29484. getCompilationError(): string;
  29485. /**
  29486. * Gets a boolean indicating that all fallbacks were used during compilation
  29487. * @returns true if all fallbacks were used
  29488. */
  29489. allFallbacksProcessed(): boolean;
  29490. /**
  29491. * Adds a callback to the onCompiled observable and call the callback imediatly if already ready.
  29492. * @param func The callback to be used.
  29493. */
  29494. executeWhenCompiled(func: (effect: Effect) => void): void;
  29495. private _checkIsReady;
  29496. private _loadShader;
  29497. /**
  29498. * Recompiles the webGL program
  29499. * @param vertexSourceCode The source code for the vertex shader.
  29500. * @param fragmentSourceCode The source code for the fragment shader.
  29501. * @param onCompiled Callback called when completed.
  29502. * @param onError Callback called on error.
  29503. * @hidden
  29504. */
  29505. _rebuildProgram(vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (pipelineContext: IPipelineContext) => void, onError: (message: string) => void): void;
  29506. /**
  29507. * Prepares the effect
  29508. * @hidden
  29509. */
  29510. _prepareEffect(): void;
  29511. private _processCompilationErrors;
  29512. /**
  29513. * Checks if the effect is supported. (Must be called after compilation)
  29514. */
  29515. readonly isSupported: boolean;
  29516. /**
  29517. * Binds a texture to the engine to be used as output of the shader.
  29518. * @param channel Name of the output variable.
  29519. * @param texture Texture to bind.
  29520. * @hidden
  29521. */
  29522. _bindTexture(channel: string, texture: InternalTexture): void;
  29523. /**
  29524. * Sets a texture on the engine to be used in the shader.
  29525. * @param channel Name of the sampler variable.
  29526. * @param texture Texture to set.
  29527. */
  29528. setTexture(channel: string, texture: Nullable<BaseTexture>): void;
  29529. /**
  29530. * Sets a depth stencil texture from a render target on the engine to be used in the shader.
  29531. * @param channel Name of the sampler variable.
  29532. * @param texture Texture to set.
  29533. */
  29534. setDepthStencilTexture(channel: string, texture: Nullable<RenderTargetTexture>): void;
  29535. /**
  29536. * Sets an array of textures on the engine to be used in the shader.
  29537. * @param channel Name of the variable.
  29538. * @param textures Textures to set.
  29539. */
  29540. setTextureArray(channel: string, textures: BaseTexture[]): void;
  29541. /**
  29542. * 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)
  29543. * @param channel Name of the sampler variable.
  29544. * @param postProcess Post process to get the input texture from.
  29545. */
  29546. setTextureFromPostProcess(channel: string, postProcess: Nullable<PostProcess>): void;
  29547. /**
  29548. * (Warning! setTextureFromPostProcessOutput may be desired instead)
  29549. * 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)
  29550. * @param channel Name of the sampler variable.
  29551. * @param postProcess Post process to get the output texture from.
  29552. */
  29553. setTextureFromPostProcessOutput(channel: string, postProcess: Nullable<PostProcess>): void;
  29554. /** @hidden */
  29555. _cacheMatrix(uniformName: string, matrix: IMatrixLike): boolean;
  29556. /** @hidden */
  29557. _cacheFloat2(uniformName: string, x: number, y: number): boolean;
  29558. /** @hidden */
  29559. _cacheFloat3(uniformName: string, x: number, y: number, z: number): boolean;
  29560. /** @hidden */
  29561. _cacheFloat4(uniformName: string, x: number, y: number, z: number, w: number): boolean;
  29562. /**
  29563. * Binds a buffer to a uniform.
  29564. * @param buffer Buffer to bind.
  29565. * @param name Name of the uniform variable to bind to.
  29566. */
  29567. bindUniformBuffer(buffer: DataBuffer, name: string): void;
  29568. /**
  29569. * Binds block to a uniform.
  29570. * @param blockName Name of the block to bind.
  29571. * @param index Index to bind.
  29572. */
  29573. bindUniformBlock(blockName: string, index: number): void;
  29574. /**
  29575. * Sets an interger value on a uniform variable.
  29576. * @param uniformName Name of the variable.
  29577. * @param value Value to be set.
  29578. * @returns this effect.
  29579. */
  29580. setInt(uniformName: string, value: number): Effect;
  29581. /**
  29582. * Sets an int array on a uniform variable.
  29583. * @param uniformName Name of the variable.
  29584. * @param array array to be set.
  29585. * @returns this effect.
  29586. */
  29587. setIntArray(uniformName: string, array: Int32Array): Effect;
  29588. /**
  29589. * 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)
  29590. * @param uniformName Name of the variable.
  29591. * @param array array to be set.
  29592. * @returns this effect.
  29593. */
  29594. setIntArray2(uniformName: string, array: Int32Array): Effect;
  29595. /**
  29596. * 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)
  29597. * @param uniformName Name of the variable.
  29598. * @param array array to be set.
  29599. * @returns this effect.
  29600. */
  29601. setIntArray3(uniformName: string, array: Int32Array): Effect;
  29602. /**
  29603. * 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)
  29604. * @param uniformName Name of the variable.
  29605. * @param array array to be set.
  29606. * @returns this effect.
  29607. */
  29608. setIntArray4(uniformName: string, array: Int32Array): Effect;
  29609. /**
  29610. * Sets an float array on a uniform variable.
  29611. * @param uniformName Name of the variable.
  29612. * @param array array to be set.
  29613. * @returns this effect.
  29614. */
  29615. setFloatArray(uniformName: string, array: Float32Array): Effect;
  29616. /**
  29617. * 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)
  29618. * @param uniformName Name of the variable.
  29619. * @param array array to be set.
  29620. * @returns this effect.
  29621. */
  29622. setFloatArray2(uniformName: string, array: Float32Array): Effect;
  29623. /**
  29624. * 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)
  29625. * @param uniformName Name of the variable.
  29626. * @param array array to be set.
  29627. * @returns this effect.
  29628. */
  29629. setFloatArray3(uniformName: string, array: Float32Array): Effect;
  29630. /**
  29631. * 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)
  29632. * @param uniformName Name of the variable.
  29633. * @param array array to be set.
  29634. * @returns this effect.
  29635. */
  29636. setFloatArray4(uniformName: string, array: Float32Array): Effect;
  29637. /**
  29638. * Sets an array on a uniform variable.
  29639. * @param uniformName Name of the variable.
  29640. * @param array array to be set.
  29641. * @returns this effect.
  29642. */
  29643. setArray(uniformName: string, array: number[]): Effect;
  29644. /**
  29645. * 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)
  29646. * @param uniformName Name of the variable.
  29647. * @param array array to be set.
  29648. * @returns this effect.
  29649. */
  29650. setArray2(uniformName: string, array: number[]): Effect;
  29651. /**
  29652. * 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)
  29653. * @param uniformName Name of the variable.
  29654. * @param array array to be set.
  29655. * @returns this effect.
  29656. */
  29657. setArray3(uniformName: string, array: number[]): Effect;
  29658. /**
  29659. * 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)
  29660. * @param uniformName Name of the variable.
  29661. * @param array array to be set.
  29662. * @returns this effect.
  29663. */
  29664. setArray4(uniformName: string, array: number[]): Effect;
  29665. /**
  29666. * Sets matrices on a uniform variable.
  29667. * @param uniformName Name of the variable.
  29668. * @param matrices matrices to be set.
  29669. * @returns this effect.
  29670. */
  29671. setMatrices(uniformName: string, matrices: Float32Array): Effect;
  29672. /**
  29673. * Sets matrix on a uniform variable.
  29674. * @param uniformName Name of the variable.
  29675. * @param matrix matrix to be set.
  29676. * @returns this effect.
  29677. */
  29678. setMatrix(uniformName: string, matrix: IMatrixLike): Effect;
  29679. /**
  29680. * 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)
  29681. * @param uniformName Name of the variable.
  29682. * @param matrix matrix to be set.
  29683. * @returns this effect.
  29684. */
  29685. setMatrix3x3(uniformName: string, matrix: Float32Array): Effect;
  29686. /**
  29687. * Sets a 2x2 matrix on a uniform variable. (Speicified as [1,2,3,4] will result in [1,2][3,4] matrix)
  29688. * @param uniformName Name of the variable.
  29689. * @param matrix matrix to be set.
  29690. * @returns this effect.
  29691. */
  29692. setMatrix2x2(uniformName: string, matrix: Float32Array): Effect;
  29693. /**
  29694. * Sets a float on a uniform variable.
  29695. * @param uniformName Name of the variable.
  29696. * @param value value to be set.
  29697. * @returns this effect.
  29698. */
  29699. setFloat(uniformName: string, value: number): Effect;
  29700. /**
  29701. * Sets a boolean on a uniform variable.
  29702. * @param uniformName Name of the variable.
  29703. * @param bool value to be set.
  29704. * @returns this effect.
  29705. */
  29706. setBool(uniformName: string, bool: boolean): Effect;
  29707. /**
  29708. * Sets a Vector2 on a uniform variable.
  29709. * @param uniformName Name of the variable.
  29710. * @param vector2 vector2 to be set.
  29711. * @returns this effect.
  29712. */
  29713. setVector2(uniformName: string, vector2: IVector2Like): Effect;
  29714. /**
  29715. * Sets a float2 on a uniform variable.
  29716. * @param uniformName Name of the variable.
  29717. * @param x First float in float2.
  29718. * @param y Second float in float2.
  29719. * @returns this effect.
  29720. */
  29721. setFloat2(uniformName: string, x: number, y: number): Effect;
  29722. /**
  29723. * Sets a Vector3 on a uniform variable.
  29724. * @param uniformName Name of the variable.
  29725. * @param vector3 Value to be set.
  29726. * @returns this effect.
  29727. */
  29728. setVector3(uniformName: string, vector3: IVector3Like): Effect;
  29729. /**
  29730. * Sets a float3 on a uniform variable.
  29731. * @param uniformName Name of the variable.
  29732. * @param x First float in float3.
  29733. * @param y Second float in float3.
  29734. * @param z Third float in float3.
  29735. * @returns this effect.
  29736. */
  29737. setFloat3(uniformName: string, x: number, y: number, z: number): Effect;
  29738. /**
  29739. * Sets a Vector4 on a uniform variable.
  29740. * @param uniformName Name of the variable.
  29741. * @param vector4 Value to be set.
  29742. * @returns this effect.
  29743. */
  29744. setVector4(uniformName: string, vector4: IVector4Like): Effect;
  29745. /**
  29746. * Sets a float4 on a uniform variable.
  29747. * @param uniformName Name of the variable.
  29748. * @param x First float in float4.
  29749. * @param y Second float in float4.
  29750. * @param z Third float in float4.
  29751. * @param w Fourth float in float4.
  29752. * @returns this effect.
  29753. */
  29754. setFloat4(uniformName: string, x: number, y: number, z: number, w: number): Effect;
  29755. /**
  29756. * Sets a Color3 on a uniform variable.
  29757. * @param uniformName Name of the variable.
  29758. * @param color3 Value to be set.
  29759. * @returns this effect.
  29760. */
  29761. setColor3(uniformName: string, color3: IColor3Like): Effect;
  29762. /**
  29763. * Sets a Color4 on a uniform variable.
  29764. * @param uniformName Name of the variable.
  29765. * @param color3 Value to be set.
  29766. * @param alpha Alpha value to be set.
  29767. * @returns this effect.
  29768. */
  29769. setColor4(uniformName: string, color3: IColor3Like, alpha: number): Effect;
  29770. /**
  29771. * Sets a Color4 on a uniform variable
  29772. * @param uniformName defines the name of the variable
  29773. * @param color4 defines the value to be set
  29774. * @returns this effect.
  29775. */
  29776. setDirectColor4(uniformName: string, color4: IColor4Like): Effect;
  29777. /** Release all associated resources */
  29778. dispose(): void;
  29779. /**
  29780. * This function will add a new shader to the shader store
  29781. * @param name the name of the shader
  29782. * @param pixelShader optional pixel shader content
  29783. * @param vertexShader optional vertex shader content
  29784. */
  29785. static RegisterShader(name: string, pixelShader?: string, vertexShader?: string): void;
  29786. /**
  29787. * Store of each shader (The can be looked up using effect.key)
  29788. */
  29789. static ShadersStore: {
  29790. [key: string]: string;
  29791. };
  29792. /**
  29793. * Store of each included file for a shader (The can be looked up using effect.key)
  29794. */
  29795. static IncludesShadersStore: {
  29796. [key: string]: string;
  29797. };
  29798. /**
  29799. * Resets the cache of effects.
  29800. */
  29801. static ResetCache(): void;
  29802. }
  29803. }
  29804. declare module "babylonjs/Engines/engineCapabilities" {
  29805. /**
  29806. * Interface used to describe the capabilities of the engine relatively to the current browser
  29807. */
  29808. export interface EngineCapabilities {
  29809. /** Maximum textures units per fragment shader */
  29810. maxTexturesImageUnits: number;
  29811. /** Maximum texture units per vertex shader */
  29812. maxVertexTextureImageUnits: number;
  29813. /** Maximum textures units in the entire pipeline */
  29814. maxCombinedTexturesImageUnits: number;
  29815. /** Maximum texture size */
  29816. maxTextureSize: number;
  29817. /** Maximum texture samples */
  29818. maxSamples?: number;
  29819. /** Maximum cube texture size */
  29820. maxCubemapTextureSize: number;
  29821. /** Maximum render texture size */
  29822. maxRenderTextureSize: number;
  29823. /** Maximum number of vertex attributes */
  29824. maxVertexAttribs: number;
  29825. /** Maximum number of varyings */
  29826. maxVaryingVectors: number;
  29827. /** Maximum number of uniforms per vertex shader */
  29828. maxVertexUniformVectors: number;
  29829. /** Maximum number of uniforms per fragment shader */
  29830. maxFragmentUniformVectors: number;
  29831. /** Defines if standard derivates (dx/dy) are supported */
  29832. standardDerivatives: boolean;
  29833. /** Defines if s3tc texture compression is supported */
  29834. s3tc?: WEBGL_compressed_texture_s3tc;
  29835. /** Defines if pvrtc texture compression is supported */
  29836. pvrtc: any;
  29837. /** Defines if etc1 texture compression is supported */
  29838. etc1: any;
  29839. /** Defines if etc2 texture compression is supported */
  29840. etc2: any;
  29841. /** Defines if astc texture compression is supported */
  29842. astc: any;
  29843. /** Defines if float textures are supported */
  29844. textureFloat: boolean;
  29845. /** Defines if vertex array objects are supported */
  29846. vertexArrayObject: boolean;
  29847. /** Gets the webgl extension for anisotropic filtering (null if not supported) */
  29848. textureAnisotropicFilterExtension?: EXT_texture_filter_anisotropic;
  29849. /** Gets the maximum level of anisotropy supported */
  29850. maxAnisotropy: number;
  29851. /** Defines if instancing is supported */
  29852. instancedArrays: boolean;
  29853. /** Defines if 32 bits indices are supported */
  29854. uintIndices: boolean;
  29855. /** Defines if high precision shaders are supported */
  29856. highPrecisionShaderSupported: boolean;
  29857. /** Defines if depth reading in the fragment shader is supported */
  29858. fragmentDepthSupported: boolean;
  29859. /** Defines if float texture linear filtering is supported*/
  29860. textureFloatLinearFiltering: boolean;
  29861. /** Defines if rendering to float textures is supported */
  29862. textureFloatRender: boolean;
  29863. /** Defines if half float textures are supported*/
  29864. textureHalfFloat: boolean;
  29865. /** Defines if half float texture linear filtering is supported*/
  29866. textureHalfFloatLinearFiltering: boolean;
  29867. /** Defines if rendering to half float textures is supported */
  29868. textureHalfFloatRender: boolean;
  29869. /** Defines if textureLOD shader command is supported */
  29870. textureLOD: boolean;
  29871. /** Defines if draw buffers extension is supported */
  29872. drawBuffersExtension: boolean;
  29873. /** Defines if depth textures are supported */
  29874. depthTextureExtension: boolean;
  29875. /** Defines if float color buffer are supported */
  29876. colorBufferFloat: boolean;
  29877. /** Gets disjoint timer query extension (null if not supported) */
  29878. timerQuery?: EXT_disjoint_timer_query;
  29879. /** Defines if timestamp can be used with timer query */
  29880. canUseTimestampForTimerQuery: boolean;
  29881. /** Defines if multiview is supported (https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/) */
  29882. multiview?: any;
  29883. /** Defines if oculus multiview is supported (https://developer.oculus.com/documentation/oculus-browser/latest/concepts/browser-multiview/) */
  29884. oculusMultiview?: any;
  29885. /** Function used to let the system compiles shaders in background */
  29886. parallelShaderCompile?: {
  29887. COMPLETION_STATUS_KHR: number;
  29888. };
  29889. /** Max number of texture samples for MSAA */
  29890. maxMSAASamples: number;
  29891. /** Defines if the blend min max extension is supported */
  29892. blendMinMax: boolean;
  29893. }
  29894. }
  29895. declare module "babylonjs/States/depthCullingState" {
  29896. import { Nullable } from "babylonjs/types";
  29897. /**
  29898. * @hidden
  29899. **/
  29900. export class DepthCullingState {
  29901. private _isDepthTestDirty;
  29902. private _isDepthMaskDirty;
  29903. private _isDepthFuncDirty;
  29904. private _isCullFaceDirty;
  29905. private _isCullDirty;
  29906. private _isZOffsetDirty;
  29907. private _isFrontFaceDirty;
  29908. private _depthTest;
  29909. private _depthMask;
  29910. private _depthFunc;
  29911. private _cull;
  29912. private _cullFace;
  29913. private _zOffset;
  29914. private _frontFace;
  29915. /**
  29916. * Initializes the state.
  29917. */
  29918. constructor();
  29919. readonly isDirty: boolean;
  29920. zOffset: number;
  29921. cullFace: Nullable<number>;
  29922. cull: Nullable<boolean>;
  29923. depthFunc: Nullable<number>;
  29924. depthMask: boolean;
  29925. depthTest: boolean;
  29926. frontFace: Nullable<number>;
  29927. reset(): void;
  29928. apply(gl: WebGLRenderingContext): void;
  29929. }
  29930. }
  29931. declare module "babylonjs/States/stencilState" {
  29932. /**
  29933. * @hidden
  29934. **/
  29935. export class StencilState {
  29936. /** 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 */
  29937. static readonly ALWAYS: number;
  29938. /** Passed to stencilOperation to specify that stencil value must be kept */
  29939. static readonly KEEP: number;
  29940. /** Passed to stencilOperation to specify that stencil value must be replaced */
  29941. static readonly REPLACE: number;
  29942. private _isStencilTestDirty;
  29943. private _isStencilMaskDirty;
  29944. private _isStencilFuncDirty;
  29945. private _isStencilOpDirty;
  29946. private _stencilTest;
  29947. private _stencilMask;
  29948. private _stencilFunc;
  29949. private _stencilFuncRef;
  29950. private _stencilFuncMask;
  29951. private _stencilOpStencilFail;
  29952. private _stencilOpDepthFail;
  29953. private _stencilOpStencilDepthPass;
  29954. readonly isDirty: boolean;
  29955. stencilFunc: number;
  29956. stencilFuncRef: number;
  29957. stencilFuncMask: number;
  29958. stencilOpStencilFail: number;
  29959. stencilOpDepthFail: number;
  29960. stencilOpStencilDepthPass: number;
  29961. stencilMask: number;
  29962. stencilTest: boolean;
  29963. constructor();
  29964. reset(): void;
  29965. apply(gl: WebGLRenderingContext): void;
  29966. }
  29967. }
  29968. declare module "babylonjs/States/alphaCullingState" {
  29969. /**
  29970. * @hidden
  29971. **/
  29972. export class AlphaState {
  29973. private _isAlphaBlendDirty;
  29974. private _isBlendFunctionParametersDirty;
  29975. private _isBlendEquationParametersDirty;
  29976. private _isBlendConstantsDirty;
  29977. private _alphaBlend;
  29978. private _blendFunctionParameters;
  29979. private _blendEquationParameters;
  29980. private _blendConstants;
  29981. /**
  29982. * Initializes the state.
  29983. */
  29984. constructor();
  29985. readonly isDirty: boolean;
  29986. alphaBlend: boolean;
  29987. setAlphaBlendConstants(r: number, g: number, b: number, a: number): void;
  29988. setAlphaBlendFunctionParameters(value0: number, value1: number, value2: number, value3: number): void;
  29989. setAlphaEquationParameters(rgb: number, alpha: number): void;
  29990. reset(): void;
  29991. apply(gl: WebGLRenderingContext): void;
  29992. }
  29993. }
  29994. declare module "babylonjs/Engines/WebGL/webGL2ShaderProcessors" {
  29995. import { IShaderProcessor } from "babylonjs/Engines/Processors/iShaderProcessor";
  29996. /** @hidden */
  29997. export class WebGL2ShaderProcessor implements IShaderProcessor {
  29998. attributeProcessor(attribute: string): string;
  29999. varyingProcessor(varying: string, isFragment: boolean): string;
  30000. postProcessor(code: string, defines: string[], isFragment: boolean): string;
  30001. }
  30002. }
  30003. declare module "babylonjs/Engines/instancingAttributeInfo" {
  30004. /**
  30005. * Interface for attribute information associated with buffer instanciation
  30006. */
  30007. export interface InstancingAttributeInfo {
  30008. /**
  30009. * Index/offset of the attribute in the vertex shader
  30010. */
  30011. index: number;
  30012. /**
  30013. * size of the attribute, 1, 2, 3 or 4
  30014. */
  30015. attributeSize: number;
  30016. /**
  30017. * type of the attribute, gl.BYTE, gl.UNSIGNED_BYTE, gl.SHORT, gl.UNSIGNED_SHORT, gl.FIXED, gl.FLOAT.
  30018. * default is FLOAT
  30019. */
  30020. attributeType: number;
  30021. /**
  30022. * normalization of fixed-point data. behavior unclear, use FALSE, default is FALSE
  30023. */
  30024. normalized: boolean;
  30025. /**
  30026. * Offset of the data in the Vertex Buffer acting as the instancing buffer
  30027. */
  30028. offset: number;
  30029. /**
  30030. * Name of the GLSL attribute, for debugging purpose only
  30031. */
  30032. attributeName: string;
  30033. }
  30034. }
  30035. declare module "babylonjs/Engines/Extensions/engine.videoTexture" {
  30036. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  30037. import { Nullable } from "babylonjs/types";
  30038. module "babylonjs/Engines/thinEngine" {
  30039. interface ThinEngine {
  30040. /**
  30041. * Update a video texture
  30042. * @param texture defines the texture to update
  30043. * @param video defines the video element to use
  30044. * @param invertY defines if data must be stored with Y axis inverted
  30045. */
  30046. updateVideoTexture(texture: Nullable<InternalTexture>, video: HTMLVideoElement, invertY: boolean): void;
  30047. }
  30048. }
  30049. }
  30050. declare module "babylonjs/Materials/Textures/videoTexture" {
  30051. import { Observable } from "babylonjs/Misc/observable";
  30052. import { Nullable } from "babylonjs/types";
  30053. import { Scene } from "babylonjs/scene";
  30054. import { Texture } from "babylonjs/Materials/Textures/texture";
  30055. import "babylonjs/Engines/Extensions/engine.videoTexture";
  30056. /**
  30057. * Settings for finer control over video usage
  30058. */
  30059. export interface VideoTextureSettings {
  30060. /**
  30061. * Applies `autoplay` to video, if specified
  30062. */
  30063. autoPlay?: boolean;
  30064. /**
  30065. * Applies `loop` to video, if specified
  30066. */
  30067. loop?: boolean;
  30068. /**
  30069. * Automatically updates internal texture from video at every frame in the render loop
  30070. */
  30071. autoUpdateTexture: boolean;
  30072. /**
  30073. * Image src displayed during the video loading or until the user interacts with the video.
  30074. */
  30075. poster?: string;
  30076. }
  30077. /**
  30078. * If you want to display a video in your scene, this is the special texture for that.
  30079. * This special texture works similar to other textures, with the exception of a few parameters.
  30080. * @see https://doc.babylonjs.com/how_to/video_texture
  30081. */
  30082. export class VideoTexture extends Texture {
  30083. /**
  30084. * Tells whether textures will be updated automatically or user is required to call `updateTexture` manually
  30085. */
  30086. readonly autoUpdateTexture: boolean;
  30087. /**
  30088. * The video instance used by the texture internally
  30089. */
  30090. readonly video: HTMLVideoElement;
  30091. private _onUserActionRequestedObservable;
  30092. /**
  30093. * Event triggerd when a dom action is required by the user to play the video.
  30094. * This happens due to recent changes in browser policies preventing video to auto start.
  30095. */
  30096. readonly onUserActionRequestedObservable: Observable<Texture>;
  30097. private _generateMipMaps;
  30098. private _engine;
  30099. private _stillImageCaptured;
  30100. private _displayingPosterTexture;
  30101. private _settings;
  30102. private _createInternalTextureOnEvent;
  30103. private _frameId;
  30104. /**
  30105. * Creates a video texture.
  30106. * If you want to display a video in your scene, this is the special texture for that.
  30107. * This special texture works similar to other textures, with the exception of a few parameters.
  30108. * @see https://doc.babylonjs.com/how_to/video_texture
  30109. * @param name optional name, will detect from video source, if not defined
  30110. * @param src can be used to provide an url, array of urls or an already setup HTML video element.
  30111. * @param scene is obviously the current scene.
  30112. * @param generateMipMaps can be used to turn on mipmaps (Can be expensive for videoTextures because they are often updated).
  30113. * @param invertY is false by default but can be used to invert video on Y axis
  30114. * @param samplingMode controls the sampling method and is set to TRILINEAR_SAMPLINGMODE by default
  30115. * @param settings allows finer control over video usage
  30116. */
  30117. constructor(name: Nullable<string>, src: string | string[] | HTMLVideoElement, scene: Nullable<Scene>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, settings?: VideoTextureSettings);
  30118. private _getName;
  30119. private _getVideo;
  30120. private _createInternalTexture;
  30121. private reset;
  30122. /**
  30123. * @hidden Internal method to initiate `update`.
  30124. */
  30125. _rebuild(): void;
  30126. /**
  30127. * Update Texture in the `auto` mode. Does not do anything if `settings.autoUpdateTexture` is false.
  30128. */
  30129. update(): void;
  30130. /**
  30131. * Update Texture in `manual` mode. Does not do anything if not visible or paused.
  30132. * @param isVisible Visibility state, detected by user using `scene.getActiveMeshes()` or othervise.
  30133. */
  30134. updateTexture(isVisible: boolean): void;
  30135. protected _updateInternalTexture: () => void;
  30136. /**
  30137. * Change video content. Changing video instance or setting multiple urls (as in constructor) is not supported.
  30138. * @param url New url.
  30139. */
  30140. updateURL(url: string): void;
  30141. /**
  30142. * Dispose the texture and release its associated resources.
  30143. */
  30144. dispose(): void;
  30145. /**
  30146. * Creates a video texture straight from a stream.
  30147. * @param scene Define the scene the texture should be created in
  30148. * @param stream Define the stream the texture should be created from
  30149. * @returns The created video texture as a promise
  30150. */
  30151. static CreateFromStreamAsync(scene: Scene, stream: MediaStream): Promise<VideoTexture>;
  30152. /**
  30153. * Creates a video texture straight from your WebCam video feed.
  30154. * @param scene Define the scene the texture should be created in
  30155. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  30156. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  30157. * @returns The created video texture as a promise
  30158. */
  30159. static CreateFromWebCamAsync(scene: Scene, constraints: {
  30160. minWidth: number;
  30161. maxWidth: number;
  30162. minHeight: number;
  30163. maxHeight: number;
  30164. deviceId: string;
  30165. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): Promise<VideoTexture>;
  30166. /**
  30167. * Creates a video texture straight from your WebCam video feed.
  30168. * @param scene Define the scene the texture should be created in
  30169. * @param onReady Define a callback to triggered once the texture will be ready
  30170. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  30171. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  30172. */
  30173. static CreateFromWebCam(scene: Scene, onReady: (videoTexture: VideoTexture) => void, constraints: {
  30174. minWidth: number;
  30175. maxWidth: number;
  30176. minHeight: number;
  30177. maxHeight: number;
  30178. deviceId: string;
  30179. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): void;
  30180. }
  30181. }
  30182. declare module "babylonjs/Engines/thinEngine" {
  30183. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  30184. import { Effect, IEffectCreationOptions } from "babylonjs/Materials/effect";
  30185. import { IShaderProcessor } from "babylonjs/Engines/Processors/iShaderProcessor";
  30186. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  30187. import { Nullable, DataArray, IndicesArray } from "babylonjs/types";
  30188. import { EngineCapabilities } from "babylonjs/Engines/engineCapabilities";
  30189. import { Observable } from "babylonjs/Misc/observable";
  30190. import { DepthCullingState } from "babylonjs/States/depthCullingState";
  30191. import { StencilState } from "babylonjs/States/stencilState";
  30192. import { AlphaState } from "babylonjs/States/alphaCullingState";
  30193. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  30194. import { IViewportLike, IColor4Like } from "babylonjs/Maths/math.like";
  30195. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  30196. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  30197. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  30198. import { WebGLPipelineContext } from "babylonjs/Engines/WebGL/webGLPipelineContext";
  30199. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  30200. import { InstancingAttributeInfo } from "babylonjs/Engines/instancingAttributeInfo";
  30201. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  30202. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  30203. import { IEffectFallbacks } from "babylonjs/Materials/iEffectFallbacks";
  30204. import { IWebRequest } from "babylonjs/Misc/interfaces/iWebRequest";
  30205. /**
  30206. * Defines the interface used by objects working like Scene
  30207. * @hidden
  30208. */
  30209. interface ISceneLike {
  30210. _addPendingData(data: any): void;
  30211. _removePendingData(data: any): void;
  30212. offlineProvider: IOfflineProvider;
  30213. }
  30214. /** Interface defining initialization parameters for Engine class */
  30215. export interface EngineOptions extends WebGLContextAttributes {
  30216. /**
  30217. * Defines if the engine should no exceed a specified device ratio
  30218. * @see https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio
  30219. */
  30220. limitDeviceRatio?: number;
  30221. /**
  30222. * Defines if webvr should be enabled automatically
  30223. * @see http://doc.babylonjs.com/how_to/webvr_camera
  30224. */
  30225. autoEnableWebVR?: boolean;
  30226. /**
  30227. * Defines if webgl2 should be turned off even if supported
  30228. * @see http://doc.babylonjs.com/features/webgl2
  30229. */
  30230. disableWebGL2Support?: boolean;
  30231. /**
  30232. * Defines if webaudio should be initialized as well
  30233. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  30234. */
  30235. audioEngine?: boolean;
  30236. /**
  30237. * Defines if animations should run using a deterministic lock step
  30238. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  30239. */
  30240. deterministicLockstep?: boolean;
  30241. /** Defines the maximum steps to use with deterministic lock step mode */
  30242. lockstepMaxSteps?: number;
  30243. /**
  30244. * Defines that engine should ignore context lost events
  30245. * If this event happens when this parameter is true, you will have to reload the page to restore rendering
  30246. */
  30247. doNotHandleContextLost?: boolean;
  30248. /**
  30249. * Defines that engine should ignore modifying touch action attribute and style
  30250. * If not handle, you might need to set it up on your side for expected touch devices behavior.
  30251. */
  30252. doNotHandleTouchAction?: boolean;
  30253. /**
  30254. * Defines that engine should compile shaders with high precision floats (if supported). True by default
  30255. */
  30256. useHighPrecisionFloats?: boolean;
  30257. }
  30258. /**
  30259. * The base engine class (root of all engines)
  30260. */
  30261. export class ThinEngine {
  30262. /** Use this array to turn off some WebGL2 features on known buggy browsers version */
  30263. static ExceptionList: ({
  30264. key: string;
  30265. capture: string;
  30266. captureConstraint: number;
  30267. targets: string[];
  30268. } | {
  30269. key: string;
  30270. capture: null;
  30271. captureConstraint: null;
  30272. targets: string[];
  30273. })[];
  30274. /** @hidden */
  30275. static _TextureLoaders: IInternalTextureLoader[];
  30276. /**
  30277. * Returns the current npm package of the sdk
  30278. */
  30279. static readonly NpmPackage: string;
  30280. /**
  30281. * Returns the current version of the framework
  30282. */
  30283. static readonly Version: string;
  30284. /**
  30285. * Returns a string describing the current engine
  30286. */
  30287. readonly description: string;
  30288. /**
  30289. * Gets or sets the epsilon value used by collision engine
  30290. */
  30291. static CollisionsEpsilon: number;
  30292. /**
  30293. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  30294. */
  30295. static ShadersRepository: string;
  30296. /** @hidden */
  30297. _shaderProcessor: IShaderProcessor;
  30298. /**
  30299. * Gets or sets a boolean that indicates if textures must be forced to power of 2 size even if not required
  30300. */
  30301. forcePOTTextures: boolean;
  30302. /**
  30303. * Gets a boolean indicating if the engine is currently rendering in fullscreen mode
  30304. */
  30305. isFullscreen: boolean;
  30306. /**
  30307. * Gets or sets a boolean indicating if back faces must be culled (true by default)
  30308. */
  30309. cullBackFaces: boolean;
  30310. /**
  30311. * Gets or sets a boolean indicating if the engine must keep rendering even if the window is not in foregroun
  30312. */
  30313. renderEvenInBackground: boolean;
  30314. /**
  30315. * Gets or sets a boolean indicating that cache can be kept between frames
  30316. */
  30317. preventCacheWipeBetweenFrames: boolean;
  30318. /** Gets or sets a boolean indicating if the engine should validate programs after compilation */
  30319. validateShaderPrograms: boolean;
  30320. /**
  30321. * Gets or sets a boolean indicating that uniform buffers must be disabled even if they are supported
  30322. */
  30323. disableUniformBuffers: boolean;
  30324. /** @hidden */
  30325. _uniformBuffers: UniformBuffer[];
  30326. /**
  30327. * Gets a boolean indicating that the engine supports uniform buffers
  30328. * @see http://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  30329. */
  30330. readonly supportsUniformBuffers: boolean;
  30331. /** @hidden */
  30332. _gl: WebGLRenderingContext;
  30333. protected _renderingCanvas: Nullable<HTMLCanvasElement>;
  30334. protected _windowIsBackground: boolean;
  30335. protected _webGLVersion: number;
  30336. protected _creationOptions: EngineOptions;
  30337. protected _highPrecisionShadersAllowed: boolean;
  30338. /** @hidden */
  30339. readonly _shouldUseHighPrecisionShader: boolean;
  30340. /**
  30341. * Gets a boolean indicating that only power of 2 textures are supported
  30342. * Please note that you can still use non power of 2 textures but in this case the engine will forcefully convert them
  30343. */
  30344. readonly needPOTTextures: boolean;
  30345. /** @hidden */
  30346. _badOS: boolean;
  30347. /** @hidden */
  30348. _badDesktopOS: boolean;
  30349. private _hardwareScalingLevel;
  30350. /** @hidden */
  30351. _caps: EngineCapabilities;
  30352. private _isStencilEnable;
  30353. protected _colorWrite: boolean;
  30354. private _glVersion;
  30355. private _glRenderer;
  30356. private _glVendor;
  30357. /** @hidden */
  30358. _videoTextureSupported: boolean;
  30359. protected _renderingQueueLaunched: boolean;
  30360. protected _activeRenderLoops: (() => void)[];
  30361. /**
  30362. * Observable signaled when a context lost event is raised
  30363. */
  30364. onContextLostObservable: Observable<ThinEngine>;
  30365. /**
  30366. * Observable signaled when a context restored event is raised
  30367. */
  30368. onContextRestoredObservable: Observable<ThinEngine>;
  30369. private _onContextLost;
  30370. private _onContextRestored;
  30371. protected _contextWasLost: boolean;
  30372. /** @hidden */
  30373. _doNotHandleContextLost: boolean;
  30374. /**
  30375. * Gets or sets a boolean indicating if resources should be retained to be able to handle context lost events
  30376. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#handling-webgl-context-lost
  30377. */
  30378. doNotHandleContextLost: boolean;
  30379. /**
  30380. * Gets or sets a boolean indicating that vertex array object must be disabled even if they are supported
  30381. */
  30382. disableVertexArrayObjects: boolean;
  30383. /** @hidden */
  30384. protected _depthCullingState: DepthCullingState;
  30385. /** @hidden */
  30386. protected _stencilState: StencilState;
  30387. /** @hidden */
  30388. protected _alphaState: AlphaState;
  30389. /** @hidden */
  30390. _internalTexturesCache: InternalTexture[];
  30391. /** @hidden */
  30392. protected _activeChannel: number;
  30393. private _currentTextureChannel;
  30394. /** @hidden */
  30395. protected _boundTexturesCache: {
  30396. [key: string]: Nullable<InternalTexture>;
  30397. };
  30398. /** @hidden */
  30399. protected _currentEffect: Nullable<Effect>;
  30400. /** @hidden */
  30401. protected _currentProgram: Nullable<WebGLProgram>;
  30402. private _compiledEffects;
  30403. private _vertexAttribArraysEnabled;
  30404. /** @hidden */
  30405. protected _cachedViewport: Nullable<IViewportLike>;
  30406. private _cachedVertexArrayObject;
  30407. /** @hidden */
  30408. protected _cachedVertexBuffers: any;
  30409. /** @hidden */
  30410. protected _cachedIndexBuffer: Nullable<DataBuffer>;
  30411. /** @hidden */
  30412. protected _cachedEffectForVertexBuffers: Nullable<Effect>;
  30413. /** @hidden */
  30414. _currentRenderTarget: Nullable<InternalTexture>;
  30415. private _uintIndicesCurrentlySet;
  30416. protected _currentBoundBuffer: Nullable<WebGLBuffer>[];
  30417. /** @hidden */
  30418. protected _currentFramebuffer: Nullable<WebGLFramebuffer>;
  30419. private _currentBufferPointers;
  30420. private _currentInstanceLocations;
  30421. private _currentInstanceBuffers;
  30422. private _textureUnits;
  30423. /** @hidden */
  30424. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  30425. /** @hidden */
  30426. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  30427. /** @hidden */
  30428. _boundRenderFunction: any;
  30429. private _vaoRecordInProgress;
  30430. private _mustWipeVertexAttributes;
  30431. private _emptyTexture;
  30432. private _emptyCubeTexture;
  30433. private _emptyTexture3D;
  30434. private _emptyTexture2DArray;
  30435. /** @hidden */
  30436. _frameHandler: number;
  30437. private _nextFreeTextureSlots;
  30438. private _maxSimultaneousTextures;
  30439. private _activeRequests;
  30440. protected _texturesSupported: string[];
  30441. /** @hidden */
  30442. _textureFormatInUse: Nullable<string>;
  30443. protected readonly _supportsHardwareTextureRescaling: boolean;
  30444. /**
  30445. * Gets the list of texture formats supported
  30446. */
  30447. readonly texturesSupported: Array<string>;
  30448. /**
  30449. * Gets the list of texture formats in use
  30450. */
  30451. readonly textureFormatInUse: Nullable<string>;
  30452. /**
  30453. * Gets the current viewport
  30454. */
  30455. readonly currentViewport: Nullable<IViewportLike>;
  30456. /**
  30457. * Gets the default empty texture
  30458. */
  30459. readonly emptyTexture: InternalTexture;
  30460. /**
  30461. * Gets the default empty 3D texture
  30462. */
  30463. readonly emptyTexture3D: InternalTexture;
  30464. /**
  30465. * Gets the default empty 2D array texture
  30466. */
  30467. readonly emptyTexture2DArray: InternalTexture;
  30468. /**
  30469. * Gets the default empty cube texture
  30470. */
  30471. readonly emptyCubeTexture: InternalTexture;
  30472. /**
  30473. * Defines whether the engine has been created with the premultipliedAlpha option on or not.
  30474. */
  30475. readonly premultipliedAlpha: boolean;
  30476. /**
  30477. * Observable event triggered before each texture is initialized
  30478. */
  30479. onBeforeTextureInitObservable: Observable<import("babylonjs/Materials/Textures/texture").Texture>;
  30480. /**
  30481. * Creates a new engine
  30482. * @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
  30483. * @param antialias defines enable antialiasing (default: false)
  30484. * @param options defines further options to be sent to the getContext() function
  30485. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  30486. */
  30487. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  30488. private _rebuildInternalTextures;
  30489. private _rebuildEffects;
  30490. /**
  30491. * Gets a boolean indicating if all created effects are ready
  30492. * @returns true if all effects are ready
  30493. */
  30494. areAllEffectsReady(): boolean;
  30495. protected _rebuildBuffers(): void;
  30496. private _initGLContext;
  30497. /**
  30498. * Gets version of the current webGL context
  30499. */
  30500. readonly webGLVersion: number;
  30501. /**
  30502. * Gets a string idenfifying the name of the class
  30503. * @returns "Engine" string
  30504. */
  30505. getClassName(): string;
  30506. /**
  30507. * Returns true if the stencil buffer has been enabled through the creation option of the context.
  30508. */
  30509. readonly isStencilEnable: boolean;
  30510. /** @hidden */
  30511. _prepareWorkingCanvas(): void;
  30512. /**
  30513. * Reset the texture cache to empty state
  30514. */
  30515. resetTextureCache(): void;
  30516. /**
  30517. * Gets an object containing information about the current webGL context
  30518. * @returns an object containing the vender, the renderer and the version of the current webGL context
  30519. */
  30520. getGlInfo(): {
  30521. vendor: string;
  30522. renderer: string;
  30523. version: string;
  30524. };
  30525. /**
  30526. * Defines the hardware scaling level.
  30527. * By default the hardware scaling level is computed from the window device ratio.
  30528. * 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.
  30529. * @param level defines the level to use
  30530. */
  30531. setHardwareScalingLevel(level: number): void;
  30532. /**
  30533. * Gets the current hardware scaling level.
  30534. * By default the hardware scaling level is computed from the window device ratio.
  30535. * 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.
  30536. * @returns a number indicating the current hardware scaling level
  30537. */
  30538. getHardwareScalingLevel(): number;
  30539. /**
  30540. * Gets the list of loaded textures
  30541. * @returns an array containing all loaded textures
  30542. */
  30543. getLoadedTexturesCache(): InternalTexture[];
  30544. /**
  30545. * Gets the object containing all engine capabilities
  30546. * @returns the EngineCapabilities object
  30547. */
  30548. getCaps(): EngineCapabilities;
  30549. /**
  30550. * stop executing a render loop function and remove it from the execution array
  30551. * @param renderFunction defines the function to be removed. If not provided all functions will be removed.
  30552. */
  30553. stopRenderLoop(renderFunction?: () => void): void;
  30554. /** @hidden */
  30555. _renderLoop(): void;
  30556. /**
  30557. * Gets the HTML canvas attached with the current webGL context
  30558. * @returns a HTML canvas
  30559. */
  30560. getRenderingCanvas(): Nullable<HTMLCanvasElement>;
  30561. /**
  30562. * Gets host window
  30563. * @returns the host window object
  30564. */
  30565. getHostWindow(): Nullable<Window>;
  30566. /**
  30567. * Gets the current render width
  30568. * @param useScreen defines if screen size must be used (or the current render target if any)
  30569. * @returns a number defining the current render width
  30570. */
  30571. getRenderWidth(useScreen?: boolean): number;
  30572. /**
  30573. * Gets the current render height
  30574. * @param useScreen defines if screen size must be used (or the current render target if any)
  30575. * @returns a number defining the current render height
  30576. */
  30577. getRenderHeight(useScreen?: boolean): number;
  30578. /**
  30579. * Can be used to override the current requestAnimationFrame requester.
  30580. * @hidden
  30581. */
  30582. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  30583. /**
  30584. * Register and execute a render loop. The engine can have more than one render function
  30585. * @param renderFunction defines the function to continuously execute
  30586. */
  30587. runRenderLoop(renderFunction: () => void): void;
  30588. /**
  30589. * Clear the current render buffer or the current render target (if any is set up)
  30590. * @param color defines the color to use
  30591. * @param backBuffer defines if the back buffer must be cleared
  30592. * @param depth defines if the depth buffer must be cleared
  30593. * @param stencil defines if the stencil buffer must be cleared
  30594. */
  30595. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  30596. private _viewportCached;
  30597. /** @hidden */
  30598. _viewport(x: number, y: number, width: number, height: number): void;
  30599. /**
  30600. * Set the WebGL's viewport
  30601. * @param viewport defines the viewport element to be used
  30602. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  30603. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  30604. */
  30605. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  30606. /**
  30607. * Begin a new frame
  30608. */
  30609. beginFrame(): void;
  30610. /**
  30611. * Enf the current frame
  30612. */
  30613. endFrame(): void;
  30614. /**
  30615. * Resize the view according to the canvas' size
  30616. */
  30617. resize(): void;
  30618. /**
  30619. * Force a specific size of the canvas
  30620. * @param width defines the new canvas' width
  30621. * @param height defines the new canvas' height
  30622. */
  30623. setSize(width: number, height: number): void;
  30624. /**
  30625. * Binds the frame buffer to the specified texture.
  30626. * @param texture The texture to render to or null for the default canvas
  30627. * @param faceIndex The face of the texture to render to in case of cube texture
  30628. * @param requiredWidth The width of the target to render to
  30629. * @param requiredHeight The height of the target to render to
  30630. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  30631. * @param depthStencilTexture The depth stencil texture to use to render
  30632. * @param lodLevel defines le lod level to bind to the frame buffer
  30633. */
  30634. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean, depthStencilTexture?: InternalTexture, lodLevel?: number): void;
  30635. /** @hidden */
  30636. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  30637. /**
  30638. * Unbind the current render target texture from the webGL context
  30639. * @param texture defines the render target texture to unbind
  30640. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  30641. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  30642. */
  30643. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  30644. /**
  30645. * Force a webGL flush (ie. a flush of all waiting webGL commands)
  30646. */
  30647. flushFramebuffer(): void;
  30648. /**
  30649. * Unbind the current render target and bind the default framebuffer
  30650. */
  30651. restoreDefaultFramebuffer(): void;
  30652. /** @hidden */
  30653. protected _resetVertexBufferBinding(): void;
  30654. /**
  30655. * Creates a vertex buffer
  30656. * @param data the data for the vertex buffer
  30657. * @returns the new WebGL static buffer
  30658. */
  30659. createVertexBuffer(data: DataArray): DataBuffer;
  30660. private _createVertexBuffer;
  30661. /**
  30662. * Creates a dynamic vertex buffer
  30663. * @param data the data for the dynamic vertex buffer
  30664. * @returns the new WebGL dynamic buffer
  30665. */
  30666. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  30667. protected _resetIndexBufferBinding(): void;
  30668. /**
  30669. * Creates a new index buffer
  30670. * @param indices defines the content of the index buffer
  30671. * @param updatable defines if the index buffer must be updatable
  30672. * @returns a new webGL buffer
  30673. */
  30674. createIndexBuffer(indices: IndicesArray, updatable?: boolean): DataBuffer;
  30675. protected _normalizeIndexData(indices: IndicesArray): Uint16Array | Uint32Array;
  30676. /**
  30677. * Bind a webGL buffer to the webGL context
  30678. * @param buffer defines the buffer to bind
  30679. */
  30680. bindArrayBuffer(buffer: Nullable<DataBuffer>): void;
  30681. protected bindIndexBuffer(buffer: Nullable<DataBuffer>): void;
  30682. private bindBuffer;
  30683. /**
  30684. * update the bound buffer with the given data
  30685. * @param data defines the data to update
  30686. */
  30687. updateArrayBuffer(data: Float32Array): void;
  30688. private _vertexAttribPointer;
  30689. private _bindIndexBufferWithCache;
  30690. private _bindVertexBuffersAttributes;
  30691. /**
  30692. * Records a vertex array object
  30693. * @see http://doc.babylonjs.com/features/webgl2#vertex-array-objects
  30694. * @param vertexBuffers defines the list of vertex buffers to store
  30695. * @param indexBuffer defines the index buffer to store
  30696. * @param effect defines the effect to store
  30697. * @returns the new vertex array object
  30698. */
  30699. recordVertexArrayObject(vertexBuffers: {
  30700. [key: string]: VertexBuffer;
  30701. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): WebGLVertexArrayObject;
  30702. /**
  30703. * Bind a specific vertex array object
  30704. * @see http://doc.babylonjs.com/features/webgl2#vertex-array-objects
  30705. * @param vertexArrayObject defines the vertex array object to bind
  30706. * @param indexBuffer defines the index buffer to bind
  30707. */
  30708. bindVertexArrayObject(vertexArrayObject: WebGLVertexArrayObject, indexBuffer: Nullable<DataBuffer>): void;
  30709. /**
  30710. * Bind webGl buffers directly to the webGL context
  30711. * @param vertexBuffer defines the vertex buffer to bind
  30712. * @param indexBuffer defines the index buffer to bind
  30713. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  30714. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  30715. * @param effect defines the effect associated with the vertex buffer
  30716. */
  30717. bindBuffersDirectly(vertexBuffer: DataBuffer, indexBuffer: DataBuffer, vertexDeclaration: number[], vertexStrideSize: number, effect: Effect): void;
  30718. private _unbindVertexArrayObject;
  30719. /**
  30720. * Bind a list of vertex buffers to the webGL context
  30721. * @param vertexBuffers defines the list of vertex buffers to bind
  30722. * @param indexBuffer defines the index buffer to bind
  30723. * @param effect defines the effect associated with the vertex buffers
  30724. */
  30725. bindBuffers(vertexBuffers: {
  30726. [key: string]: Nullable<VertexBuffer>;
  30727. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): void;
  30728. /**
  30729. * Unbind all instance attributes
  30730. */
  30731. unbindInstanceAttributes(): void;
  30732. /**
  30733. * Release and free the memory of a vertex array object
  30734. * @param vao defines the vertex array object to delete
  30735. */
  30736. releaseVertexArrayObject(vao: WebGLVertexArrayObject): void;
  30737. /** @hidden */
  30738. _releaseBuffer(buffer: DataBuffer): boolean;
  30739. protected _deleteBuffer(buffer: DataBuffer): void;
  30740. /**
  30741. * Update the content of a webGL buffer used with instanciation and bind it to the webGL context
  30742. * @param instancesBuffer defines the webGL buffer to update and bind
  30743. * @param data defines the data to store in the buffer
  30744. * @param offsetLocations defines the offsets or attributes information used to determine where data must be stored in the buffer
  30745. */
  30746. updateAndBindInstancesBuffer(instancesBuffer: DataBuffer, data: Float32Array, offsetLocations: number[] | InstancingAttributeInfo[]): void;
  30747. /**
  30748. * Apply all cached states (depth, culling, stencil and alpha)
  30749. */
  30750. applyStates(): void;
  30751. /**
  30752. * Send a draw order
  30753. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  30754. * @param indexStart defines the starting index
  30755. * @param indexCount defines the number of index to draw
  30756. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  30757. */
  30758. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  30759. /**
  30760. * Draw a list of points
  30761. * @param verticesStart defines the index of first vertex to draw
  30762. * @param verticesCount defines the count of vertices to draw
  30763. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  30764. */
  30765. drawPointClouds(verticesStart: number, verticesCount: number, instancesCount?: number): void;
  30766. /**
  30767. * Draw a list of unindexed primitives
  30768. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  30769. * @param verticesStart defines the index of first vertex to draw
  30770. * @param verticesCount defines the count of vertices to draw
  30771. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  30772. */
  30773. drawUnIndexed(useTriangles: boolean, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  30774. /**
  30775. * Draw a list of indexed primitives
  30776. * @param fillMode defines the primitive to use
  30777. * @param indexStart defines the starting index
  30778. * @param indexCount defines the number of index to draw
  30779. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  30780. */
  30781. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  30782. /**
  30783. * Draw a list of unindexed primitives
  30784. * @param fillMode defines the primitive to use
  30785. * @param verticesStart defines the index of first vertex to draw
  30786. * @param verticesCount defines the count of vertices to draw
  30787. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  30788. */
  30789. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  30790. private _drawMode;
  30791. /** @hidden */
  30792. protected _reportDrawCall(): void;
  30793. /** @hidden */
  30794. _releaseEffect(effect: Effect): void;
  30795. /** @hidden */
  30796. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  30797. /**
  30798. * Create a new effect (used to store vertex/fragment shaders)
  30799. * @param baseName defines the base name of the effect (The name of file without .fragment.fx or .vertex.fx)
  30800. * @param attributesNamesOrOptions defines either a list of attribute names or an IEffectCreationOptions object
  30801. * @param uniformsNamesOrEngine defines either a list of uniform names or the engine to use
  30802. * @param samplers defines an array of string used to represent textures
  30803. * @param defines defines the string containing the defines to use to compile the shaders
  30804. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  30805. * @param onCompiled defines a function to call when the effect creation is successful
  30806. * @param onError defines a function to call when the effect creation has failed
  30807. * @param indexParameters defines an object containing the index values to use to compile shaders (like the maximum number of simultaneous lights)
  30808. * @returns the new Effect
  30809. */
  30810. 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;
  30811. protected static _ConcatenateShader(source: string, defines: Nullable<string>, shaderVersion?: string): string;
  30812. private _compileShader;
  30813. private _compileRawShader;
  30814. /**
  30815. * Directly creates a webGL program
  30816. * @param pipelineContext defines the pipeline context to attach to
  30817. * @param vertexCode defines the vertex shader code to use
  30818. * @param fragmentCode defines the fragment shader code to use
  30819. * @param context defines the webGL context to use (if not set, the current one will be used)
  30820. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  30821. * @returns the new webGL program
  30822. */
  30823. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  30824. /**
  30825. * Creates a webGL program
  30826. * @param pipelineContext defines the pipeline context to attach to
  30827. * @param vertexCode defines the vertex shader code to use
  30828. * @param fragmentCode defines the fragment shader code to use
  30829. * @param defines defines the string containing the defines to use to compile the shaders
  30830. * @param context defines the webGL context to use (if not set, the current one will be used)
  30831. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  30832. * @returns the new webGL program
  30833. */
  30834. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  30835. /**
  30836. * Creates a new pipeline context
  30837. * @returns the new pipeline
  30838. */
  30839. createPipelineContext(): IPipelineContext;
  30840. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  30841. protected _finalizePipelineContext(pipelineContext: WebGLPipelineContext): void;
  30842. /** @hidden */
  30843. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  30844. /** @hidden */
  30845. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  30846. /** @hidden */
  30847. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  30848. /**
  30849. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  30850. * @param pipelineContext defines the pipeline context to use
  30851. * @param uniformsNames defines the list of uniform names
  30852. * @returns an array of webGL uniform locations
  30853. */
  30854. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  30855. /**
  30856. * Gets the lsit of active attributes for a given webGL program
  30857. * @param pipelineContext defines the pipeline context to use
  30858. * @param attributesNames defines the list of attribute names to get
  30859. * @returns an array of indices indicating the offset of each attribute
  30860. */
  30861. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  30862. /**
  30863. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  30864. * @param effect defines the effect to activate
  30865. */
  30866. enableEffect(effect: Nullable<Effect>): void;
  30867. /**
  30868. * Set the value of an uniform to a number (int)
  30869. * @param uniform defines the webGL uniform location where to store the value
  30870. * @param value defines the int number to store
  30871. */
  30872. setInt(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  30873. /**
  30874. * Set the value of an uniform to an array of int32
  30875. * @param uniform defines the webGL uniform location where to store the value
  30876. * @param array defines the array of int32 to store
  30877. */
  30878. setIntArray(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  30879. /**
  30880. * Set the value of an uniform to an array of int32 (stored as vec2)
  30881. * @param uniform defines the webGL uniform location where to store the value
  30882. * @param array defines the array of int32 to store
  30883. */
  30884. setIntArray2(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  30885. /**
  30886. * Set the value of an uniform to an array of int32 (stored as vec3)
  30887. * @param uniform defines the webGL uniform location where to store the value
  30888. * @param array defines the array of int32 to store
  30889. */
  30890. setIntArray3(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  30891. /**
  30892. * Set the value of an uniform to an array of int32 (stored as vec4)
  30893. * @param uniform defines the webGL uniform location where to store the value
  30894. * @param array defines the array of int32 to store
  30895. */
  30896. setIntArray4(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  30897. /**
  30898. * Set the value of an uniform to an array of number
  30899. * @param uniform defines the webGL uniform location where to store the value
  30900. * @param array defines the array of number to store
  30901. */
  30902. setArray(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  30903. /**
  30904. * Set the value of an uniform to an array of number (stored as vec2)
  30905. * @param uniform defines the webGL uniform location where to store the value
  30906. * @param array defines the array of number to store
  30907. */
  30908. setArray2(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  30909. /**
  30910. * Set the value of an uniform to an array of number (stored as vec3)
  30911. * @param uniform defines the webGL uniform location where to store the value
  30912. * @param array defines the array of number to store
  30913. */
  30914. setArray3(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  30915. /**
  30916. * Set the value of an uniform to an array of number (stored as vec4)
  30917. * @param uniform defines the webGL uniform location where to store the value
  30918. * @param array defines the array of number to store
  30919. */
  30920. setArray4(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  30921. /**
  30922. * Set the value of an uniform to an array of float32 (stored as matrices)
  30923. * @param uniform defines the webGL uniform location where to store the value
  30924. * @param matrices defines the array of float32 to store
  30925. */
  30926. setMatrices(uniform: Nullable<WebGLUniformLocation>, matrices: Float32Array): void;
  30927. /**
  30928. * Set the value of an uniform to a matrix (3x3)
  30929. * @param uniform defines the webGL uniform location where to store the value
  30930. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  30931. */
  30932. setMatrix3x3(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  30933. /**
  30934. * Set the value of an uniform to a matrix (2x2)
  30935. * @param uniform defines the webGL uniform location where to store the value
  30936. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  30937. */
  30938. setMatrix2x2(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  30939. /**
  30940. * Set the value of an uniform to a number (float)
  30941. * @param uniform defines the webGL uniform location where to store the value
  30942. * @param value defines the float number to store
  30943. */
  30944. setFloat(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  30945. /**
  30946. * Set the value of an uniform to a vec2
  30947. * @param uniform defines the webGL uniform location where to store the value
  30948. * @param x defines the 1st component of the value
  30949. * @param y defines the 2nd component of the value
  30950. */
  30951. setFloat2(uniform: Nullable<WebGLUniformLocation>, x: number, y: number): void;
  30952. /**
  30953. * Set the value of an uniform to a vec3
  30954. * @param uniform defines the webGL uniform location where to store the value
  30955. * @param x defines the 1st component of the value
  30956. * @param y defines the 2nd component of the value
  30957. * @param z defines the 3rd component of the value
  30958. */
  30959. setFloat3(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number): void;
  30960. /**
  30961. * Set the value of an uniform to a vec4
  30962. * @param uniform defines the webGL uniform location where to store the value
  30963. * @param x defines the 1st component of the value
  30964. * @param y defines the 2nd component of the value
  30965. * @param z defines the 3rd component of the value
  30966. * @param w defines the 4th component of the value
  30967. */
  30968. setFloat4(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number, w: number): void;
  30969. /**
  30970. * Gets the depth culling state manager
  30971. */
  30972. readonly depthCullingState: DepthCullingState;
  30973. /**
  30974. * Gets the alpha state manager
  30975. */
  30976. readonly alphaState: AlphaState;
  30977. /**
  30978. * Gets the stencil state manager
  30979. */
  30980. readonly stencilState: StencilState;
  30981. /**
  30982. * Clears the list of texture accessible through engine.
  30983. * This can help preventing texture load conflict due to name collision.
  30984. */
  30985. clearInternalTexturesCache(): void;
  30986. /**
  30987. * Force the entire cache to be cleared
  30988. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  30989. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  30990. */
  30991. wipeCaches(bruteForce?: boolean): void;
  30992. /** @hidden */
  30993. _getSamplingParameters(samplingMode: number, generateMipMaps: boolean): {
  30994. min: number;
  30995. mag: number;
  30996. };
  30997. /** @hidden */
  30998. _createTexture(): WebGLTexture;
  30999. /**
  31000. * Usually called from Texture.ts.
  31001. * Passed information to create a WebGLTexture
  31002. * @param urlArg defines a value which contains one of the following:
  31003. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  31004. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  31005. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  31006. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  31007. * @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)
  31008. * @param scene needed for loading to the correct scene
  31009. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  31010. * @param onLoad optional callback to be called upon successful completion
  31011. * @param onError optional callback to be called upon failure
  31012. * @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
  31013. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  31014. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  31015. * @param forcedExtension defines the extension to use to pick the right loader
  31016. * @param excludeLoaders array of texture loaders that should be excluded when picking a loader for the texture (default: empty array)
  31017. * @param mimeType defines an optional mime type
  31018. * @returns a InternalTexture for assignment back into BABYLON.Texture
  31019. */
  31020. 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;
  31021. /**
  31022. * @hidden
  31023. */
  31024. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  31025. /**
  31026. * Creates a raw texture
  31027. * @param data defines the data to store in the texture
  31028. * @param width defines the width of the texture
  31029. * @param height defines the height of the texture
  31030. * @param format defines the format of the data
  31031. * @param generateMipMaps defines if the engine should generate the mip levels
  31032. * @param invertY defines if data must be stored with Y axis inverted
  31033. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  31034. * @param compression defines the compression used (null by default)
  31035. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  31036. * @returns the raw texture inside an InternalTexture
  31037. */
  31038. createRawTexture(data: Nullable<ArrayBufferView>, width: number, height: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression?: Nullable<string>, type?: number): InternalTexture;
  31039. /**
  31040. * Creates a new raw cube texture
  31041. * @param data defines the array of data to use to create each face
  31042. * @param size defines the size of the textures
  31043. * @param format defines the format of the data
  31044. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  31045. * @param generateMipMaps defines if the engine should generate the mip levels
  31046. * @param invertY defines if data must be stored with Y axis inverted
  31047. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  31048. * @param compression defines the compression used (null by default)
  31049. * @returns the cube texture as an InternalTexture
  31050. */
  31051. createRawCubeTexture(data: Nullable<ArrayBufferView[]>, size: number, format: number, type: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression?: Nullable<string>): InternalTexture;
  31052. /**
  31053. * Creates a new raw 3D texture
  31054. * @param data defines the data used to create the texture
  31055. * @param width defines the width of the texture
  31056. * @param height defines the height of the texture
  31057. * @param depth defines the depth of the texture
  31058. * @param format defines the format of the texture
  31059. * @param generateMipMaps defines if the engine must generate mip levels
  31060. * @param invertY defines if data must be stored with Y axis inverted
  31061. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  31062. * @param compression defines the compressed used (can be null)
  31063. * @param textureType defines the compressed used (can be null)
  31064. * @returns a new raw 3D texture (stored in an InternalTexture)
  31065. */
  31066. createRawTexture3D(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression?: Nullable<string>, textureType?: number): InternalTexture;
  31067. /**
  31068. * Creates a new raw 2D array texture
  31069. * @param data defines the data used to create the texture
  31070. * @param width defines the width of the texture
  31071. * @param height defines the height of the texture
  31072. * @param depth defines the number of layers of the texture
  31073. * @param format defines the format of the texture
  31074. * @param generateMipMaps defines if the engine must generate mip levels
  31075. * @param invertY defines if data must be stored with Y axis inverted
  31076. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  31077. * @param compression defines the compressed used (can be null)
  31078. * @param textureType defines the compressed used (can be null)
  31079. * @returns a new raw 2D array texture (stored in an InternalTexture)
  31080. */
  31081. createRawTexture2DArray(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression?: Nullable<string>, textureType?: number): InternalTexture;
  31082. private _unpackFlipYCached;
  31083. /**
  31084. * In case you are sharing the context with other applications, it might
  31085. * be interested to not cache the unpack flip y state to ensure a consistent
  31086. * value would be set.
  31087. */
  31088. enableUnpackFlipYCached: boolean;
  31089. /** @hidden */
  31090. _unpackFlipY(value: boolean): void;
  31091. /** @hidden */
  31092. _getUnpackAlignement(): number;
  31093. /**
  31094. * Update the sampling mode of a given texture
  31095. * @param samplingMode defines the required sampling mode
  31096. * @param texture defines the texture to update
  31097. */
  31098. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  31099. /** @hidden */
  31100. _setupDepthStencilTexture(internalTexture: InternalTexture, size: number | {
  31101. width: number;
  31102. height: number;
  31103. }, generateStencil: boolean, bilinearFiltering: boolean, comparisonFunction: number): void;
  31104. /** @hidden */
  31105. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  31106. /** @hidden */
  31107. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number, babylonInternalFormat?: number, useTextureWidthAndHeight?: boolean): void;
  31108. /** @hidden */
  31109. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  31110. protected _prepareWebGLTextureContinuation(texture: InternalTexture, scene: Nullable<ISceneLike>, noMipmap: boolean, isCompressed: boolean, samplingMode: number): void;
  31111. private _prepareWebGLTexture;
  31112. /** @hidden */
  31113. _setupFramebufferDepthAttachments(generateStencilBuffer: boolean, generateDepthBuffer: boolean, width: number, height: number, samples?: number): Nullable<WebGLRenderbuffer>;
  31114. /** @hidden */
  31115. _releaseFramebufferObjects(texture: InternalTexture): void;
  31116. /** @hidden */
  31117. _releaseTexture(texture: InternalTexture): void;
  31118. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  31119. protected _setProgram(program: WebGLProgram): void;
  31120. protected _boundUniforms: {
  31121. [key: number]: WebGLUniformLocation;
  31122. };
  31123. /**
  31124. * Binds an effect to the webGL context
  31125. * @param effect defines the effect to bind
  31126. */
  31127. bindSamplers(effect: Effect): void;
  31128. private _activateCurrentTexture;
  31129. /** @hidden */
  31130. _bindTextureDirectly(target: number, texture: Nullable<InternalTexture>, forTextureDataUpdate?: boolean, force?: boolean): boolean;
  31131. /** @hidden */
  31132. _bindTexture(channel: number, texture: Nullable<InternalTexture>): void;
  31133. /**
  31134. * Unbind all textures from the webGL context
  31135. */
  31136. unbindAllTextures(): void;
  31137. /**
  31138. * Sets a texture to the according uniform.
  31139. * @param channel The texture channel
  31140. * @param uniform The uniform to set
  31141. * @param texture The texture to apply
  31142. */
  31143. setTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<BaseTexture>): void;
  31144. private _bindSamplerUniformToChannel;
  31145. private _getTextureWrapMode;
  31146. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  31147. /**
  31148. * Sets an array of texture to the webGL context
  31149. * @param channel defines the channel where the texture array must be set
  31150. * @param uniform defines the associated uniform location
  31151. * @param textures defines the array of textures to bind
  31152. */
  31153. setTextureArray(channel: number, uniform: Nullable<WebGLUniformLocation>, textures: BaseTexture[]): void;
  31154. /** @hidden */
  31155. _setAnisotropicLevel(target: number, texture: BaseTexture): void;
  31156. private _setTextureParameterFloat;
  31157. private _setTextureParameterInteger;
  31158. /**
  31159. * Unbind all vertex attributes from the webGL context
  31160. */
  31161. unbindAllAttributes(): void;
  31162. /**
  31163. * 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
  31164. */
  31165. releaseEffects(): void;
  31166. /**
  31167. * Dispose and release all associated resources
  31168. */
  31169. dispose(): void;
  31170. /**
  31171. * Attach a new callback raised when context lost event is fired
  31172. * @param callback defines the callback to call
  31173. */
  31174. attachContextLostEvent(callback: ((event: WebGLContextEvent) => void)): void;
  31175. /**
  31176. * Attach a new callback raised when context restored event is fired
  31177. * @param callback defines the callback to call
  31178. */
  31179. attachContextRestoredEvent(callback: ((event: WebGLContextEvent) => void)): void;
  31180. /**
  31181. * Get the current error code of the webGL context
  31182. * @returns the error code
  31183. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  31184. */
  31185. getError(): number;
  31186. private _canRenderToFloatFramebuffer;
  31187. private _canRenderToHalfFloatFramebuffer;
  31188. private _canRenderToFramebuffer;
  31189. /** @hidden */
  31190. _getWebGLTextureType(type: number): number;
  31191. /** @hidden */
  31192. _getInternalFormat(format: number): number;
  31193. /** @hidden */
  31194. _getRGBABufferInternalSizedFormat(type: number, format?: number): number;
  31195. /** @hidden */
  31196. _getRGBAMultiSampleBufferFormat(type: number): number;
  31197. /** @hidden */
  31198. _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;
  31199. /**
  31200. * Gets a boolean indicating if the engine can be instanciated (ie. if a webGL context can be found)
  31201. * @returns true if the engine can be created
  31202. * @ignorenaming
  31203. */
  31204. static isSupported(): boolean;
  31205. /**
  31206. * Find the next highest power of two.
  31207. * @param x Number to start search from.
  31208. * @return Next highest power of two.
  31209. */
  31210. static CeilingPOT(x: number): number;
  31211. /**
  31212. * Find the next lowest power of two.
  31213. * @param x Number to start search from.
  31214. * @return Next lowest power of two.
  31215. */
  31216. static FloorPOT(x: number): number;
  31217. /**
  31218. * Find the nearest power of two.
  31219. * @param x Number to start search from.
  31220. * @return Next nearest power of two.
  31221. */
  31222. static NearestPOT(x: number): number;
  31223. /**
  31224. * Get the closest exponent of two
  31225. * @param value defines the value to approximate
  31226. * @param max defines the maximum value to return
  31227. * @param mode defines how to define the closest value
  31228. * @returns closest exponent of two of the given value
  31229. */
  31230. static GetExponentOfTwo(value: number, max: number, mode?: number): number;
  31231. /**
  31232. * Queue a new function into the requested animation frame pool (ie. this function will be executed byt the browser for the next frame)
  31233. * @param func - the function to be called
  31234. * @param requester - the object that will request the next frame. Falls back to window.
  31235. * @returns frame number
  31236. */
  31237. static QueueNewFrame(func: () => void, requester?: any): number;
  31238. }
  31239. }
  31240. declare module "babylonjs/Maths/sphericalPolynomial" {
  31241. import { Vector3 } from "babylonjs/Maths/math.vector";
  31242. import { Color3 } from "babylonjs/Maths/math.color";
  31243. /**
  31244. * Class representing spherical harmonics coefficients to the 3rd degree
  31245. */
  31246. export class SphericalHarmonics {
  31247. /**
  31248. * Defines whether or not the harmonics have been prescaled for rendering.
  31249. */
  31250. preScaled: boolean;
  31251. /**
  31252. * The l0,0 coefficients of the spherical harmonics
  31253. */
  31254. l00: Vector3;
  31255. /**
  31256. * The l1,-1 coefficients of the spherical harmonics
  31257. */
  31258. l1_1: Vector3;
  31259. /**
  31260. * The l1,0 coefficients of the spherical harmonics
  31261. */
  31262. l10: Vector3;
  31263. /**
  31264. * The l1,1 coefficients of the spherical harmonics
  31265. */
  31266. l11: Vector3;
  31267. /**
  31268. * The l2,-2 coefficients of the spherical harmonics
  31269. */
  31270. l2_2: Vector3;
  31271. /**
  31272. * The l2,-1 coefficients of the spherical harmonics
  31273. */
  31274. l2_1: Vector3;
  31275. /**
  31276. * The l2,0 coefficients of the spherical harmonics
  31277. */
  31278. l20: Vector3;
  31279. /**
  31280. * The l2,1 coefficients of the spherical harmonics
  31281. */
  31282. l21: Vector3;
  31283. /**
  31284. * The l2,2 coefficients of the spherical harmonics
  31285. */
  31286. l22: Vector3;
  31287. /**
  31288. * Adds a light to the spherical harmonics
  31289. * @param direction the direction of the light
  31290. * @param color the color of the light
  31291. * @param deltaSolidAngle the delta solid angle of the light
  31292. */
  31293. addLight(direction: Vector3, color: Color3, deltaSolidAngle: number): void;
  31294. /**
  31295. * Scales the spherical harmonics by the given amount
  31296. * @param scale the amount to scale
  31297. */
  31298. scaleInPlace(scale: number): void;
  31299. /**
  31300. * Convert from incident radiance (Li) to irradiance (E) by applying convolution with the cosine-weighted hemisphere.
  31301. *
  31302. * ```
  31303. * E_lm = A_l * L_lm
  31304. * ```
  31305. *
  31306. * In spherical harmonics this convolution amounts to scaling factors for each frequency band.
  31307. * This corresponds to equation 5 in "An Efficient Representation for Irradiance Environment Maps", where
  31308. * the scaling factors are given in equation 9.
  31309. */
  31310. convertIncidentRadianceToIrradiance(): void;
  31311. /**
  31312. * Convert from irradiance to outgoing radiance for Lambertian BDRF, suitable for efficient shader evaluation.
  31313. *
  31314. * ```
  31315. * L = (1/pi) * E * rho
  31316. * ```
  31317. *
  31318. * This is done by an additional scale by 1/pi, so is a fairly trivial operation but important conceptually.
  31319. */
  31320. convertIrradianceToLambertianRadiance(): void;
  31321. /**
  31322. * Integrates the reconstruction coefficients directly in to the SH preventing further
  31323. * required operations at run time.
  31324. *
  31325. * This is simply done by scaling back the SH with Ylm constants parameter.
  31326. * The trigonometric part being applied by the shader at run time.
  31327. */
  31328. preScaleForRendering(): void;
  31329. /**
  31330. * Constructs a spherical harmonics from an array.
  31331. * @param data defines the 9x3 coefficients (l00, l1-1, l10, l11, l2-2, l2-1, l20, l21, l22)
  31332. * @returns the spherical harmonics
  31333. */
  31334. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalHarmonics;
  31335. /**
  31336. * Gets the spherical harmonics from polynomial
  31337. * @param polynomial the spherical polynomial
  31338. * @returns the spherical harmonics
  31339. */
  31340. static FromPolynomial(polynomial: SphericalPolynomial): SphericalHarmonics;
  31341. }
  31342. /**
  31343. * Class representing spherical polynomial coefficients to the 3rd degree
  31344. */
  31345. export class SphericalPolynomial {
  31346. private _harmonics;
  31347. /**
  31348. * The spherical harmonics used to create the polynomials.
  31349. */
  31350. readonly preScaledHarmonics: SphericalHarmonics;
  31351. /**
  31352. * The x coefficients of the spherical polynomial
  31353. */
  31354. x: Vector3;
  31355. /**
  31356. * The y coefficients of the spherical polynomial
  31357. */
  31358. y: Vector3;
  31359. /**
  31360. * The z coefficients of the spherical polynomial
  31361. */
  31362. z: Vector3;
  31363. /**
  31364. * The xx coefficients of the spherical polynomial
  31365. */
  31366. xx: Vector3;
  31367. /**
  31368. * The yy coefficients of the spherical polynomial
  31369. */
  31370. yy: Vector3;
  31371. /**
  31372. * The zz coefficients of the spherical polynomial
  31373. */
  31374. zz: Vector3;
  31375. /**
  31376. * The xy coefficients of the spherical polynomial
  31377. */
  31378. xy: Vector3;
  31379. /**
  31380. * The yz coefficients of the spherical polynomial
  31381. */
  31382. yz: Vector3;
  31383. /**
  31384. * The zx coefficients of the spherical polynomial
  31385. */
  31386. zx: Vector3;
  31387. /**
  31388. * Adds an ambient color to the spherical polynomial
  31389. * @param color the color to add
  31390. */
  31391. addAmbient(color: Color3): void;
  31392. /**
  31393. * Scales the spherical polynomial by the given amount
  31394. * @param scale the amount to scale
  31395. */
  31396. scaleInPlace(scale: number): void;
  31397. /**
  31398. * Gets the spherical polynomial from harmonics
  31399. * @param harmonics the spherical harmonics
  31400. * @returns the spherical polynomial
  31401. */
  31402. static FromHarmonics(harmonics: SphericalHarmonics): SphericalPolynomial;
  31403. /**
  31404. * Constructs a spherical polynomial from an array.
  31405. * @param data defines the 9x3 coefficients (x, y, z, xx, yy, zz, yz, zx, xy)
  31406. * @returns the spherical polynomial
  31407. */
  31408. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalPolynomial;
  31409. }
  31410. }
  31411. declare module "babylonjs/Materials/Textures/internalTexture" {
  31412. import { Observable } from "babylonjs/Misc/observable";
  31413. import { Nullable, int } from "babylonjs/types";
  31414. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  31415. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  31416. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  31417. /**
  31418. * Defines the source of the internal texture
  31419. */
  31420. export enum InternalTextureSource {
  31421. /**
  31422. * The source of the texture data is unknown
  31423. */
  31424. Unknown = 0,
  31425. /**
  31426. * Texture data comes from an URL
  31427. */
  31428. Url = 1,
  31429. /**
  31430. * Texture data is only used for temporary storage
  31431. */
  31432. Temp = 2,
  31433. /**
  31434. * Texture data comes from raw data (ArrayBuffer)
  31435. */
  31436. Raw = 3,
  31437. /**
  31438. * Texture content is dynamic (video or dynamic texture)
  31439. */
  31440. Dynamic = 4,
  31441. /**
  31442. * Texture content is generated by rendering to it
  31443. */
  31444. RenderTarget = 5,
  31445. /**
  31446. * Texture content is part of a multi render target process
  31447. */
  31448. MultiRenderTarget = 6,
  31449. /**
  31450. * Texture data comes from a cube data file
  31451. */
  31452. Cube = 7,
  31453. /**
  31454. * Texture data comes from a raw cube data
  31455. */
  31456. CubeRaw = 8,
  31457. /**
  31458. * Texture data come from a prefiltered cube data file
  31459. */
  31460. CubePrefiltered = 9,
  31461. /**
  31462. * Texture content is raw 3D data
  31463. */
  31464. Raw3D = 10,
  31465. /**
  31466. * Texture content is raw 2D array data
  31467. */
  31468. Raw2DArray = 11,
  31469. /**
  31470. * Texture content is a depth texture
  31471. */
  31472. Depth = 12,
  31473. /**
  31474. * Texture data comes from a raw cube data encoded with RGBD
  31475. */
  31476. CubeRawRGBD = 13
  31477. }
  31478. /**
  31479. * Class used to store data associated with WebGL texture data for the engine
  31480. * This class should not be used directly
  31481. */
  31482. export class InternalTexture {
  31483. /** @hidden */
  31484. static _UpdateRGBDAsync: (internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<import("babylonjs/Maths/sphericalPolynomial").SphericalPolynomial>, lodScale: number, lodOffset: number) => Promise<void>;
  31485. /**
  31486. * Defines if the texture is ready
  31487. */
  31488. isReady: boolean;
  31489. /**
  31490. * Defines if the texture is a cube texture
  31491. */
  31492. isCube: boolean;
  31493. /**
  31494. * Defines if the texture contains 3D data
  31495. */
  31496. is3D: boolean;
  31497. /**
  31498. * Defines if the texture contains 2D array data
  31499. */
  31500. is2DArray: boolean;
  31501. /**
  31502. * Defines if the texture contains multiview data
  31503. */
  31504. isMultiview: boolean;
  31505. /**
  31506. * Gets the URL used to load this texture
  31507. */
  31508. url: string;
  31509. /**
  31510. * Gets the sampling mode of the texture
  31511. */
  31512. samplingMode: number;
  31513. /**
  31514. * Gets a boolean indicating if the texture needs mipmaps generation
  31515. */
  31516. generateMipMaps: boolean;
  31517. /**
  31518. * Gets the number of samples used by the texture (WebGL2+ only)
  31519. */
  31520. samples: number;
  31521. /**
  31522. * Gets the type of the texture (int, float...)
  31523. */
  31524. type: number;
  31525. /**
  31526. * Gets the format of the texture (RGB, RGBA...)
  31527. */
  31528. format: number;
  31529. /**
  31530. * Observable called when the texture is loaded
  31531. */
  31532. onLoadedObservable: Observable<InternalTexture>;
  31533. /**
  31534. * Gets the width of the texture
  31535. */
  31536. width: number;
  31537. /**
  31538. * Gets the height of the texture
  31539. */
  31540. height: number;
  31541. /**
  31542. * Gets the depth of the texture
  31543. */
  31544. depth: number;
  31545. /**
  31546. * Gets the initial width of the texture (It could be rescaled if the current system does not support non power of two textures)
  31547. */
  31548. baseWidth: number;
  31549. /**
  31550. * Gets the initial height of the texture (It could be rescaled if the current system does not support non power of two textures)
  31551. */
  31552. baseHeight: number;
  31553. /**
  31554. * Gets the initial depth of the texture (It could be rescaled if the current system does not support non power of two textures)
  31555. */
  31556. baseDepth: number;
  31557. /**
  31558. * Gets a boolean indicating if the texture is inverted on Y axis
  31559. */
  31560. invertY: boolean;
  31561. /** @hidden */
  31562. _invertVScale: boolean;
  31563. /** @hidden */
  31564. _associatedChannel: number;
  31565. /** @hidden */
  31566. _source: InternalTextureSource;
  31567. /** @hidden */
  31568. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  31569. /** @hidden */
  31570. _bufferView: Nullable<ArrayBufferView>;
  31571. /** @hidden */
  31572. _bufferViewArray: Nullable<ArrayBufferView[]>;
  31573. /** @hidden */
  31574. _bufferViewArrayArray: Nullable<ArrayBufferView[][]>;
  31575. /** @hidden */
  31576. _size: number;
  31577. /** @hidden */
  31578. _extension: string;
  31579. /** @hidden */
  31580. _files: Nullable<string[]>;
  31581. /** @hidden */
  31582. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  31583. /** @hidden */
  31584. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  31585. /** @hidden */
  31586. _framebuffer: Nullable<WebGLFramebuffer>;
  31587. /** @hidden */
  31588. _depthStencilBuffer: Nullable<WebGLRenderbuffer>;
  31589. /** @hidden */
  31590. _MSAAFramebuffer: Nullable<WebGLFramebuffer>;
  31591. /** @hidden */
  31592. _MSAARenderBuffer: Nullable<WebGLRenderbuffer>;
  31593. /** @hidden */
  31594. _attachments: Nullable<number[]>;
  31595. /** @hidden */
  31596. _cachedCoordinatesMode: Nullable<number>;
  31597. /** @hidden */
  31598. _cachedWrapU: Nullable<number>;
  31599. /** @hidden */
  31600. _cachedWrapV: Nullable<number>;
  31601. /** @hidden */
  31602. _cachedWrapR: Nullable<number>;
  31603. /** @hidden */
  31604. _cachedAnisotropicFilteringLevel: Nullable<number>;
  31605. /** @hidden */
  31606. _isDisabled: boolean;
  31607. /** @hidden */
  31608. _compression: Nullable<string>;
  31609. /** @hidden */
  31610. _generateStencilBuffer: boolean;
  31611. /** @hidden */
  31612. _generateDepthBuffer: boolean;
  31613. /** @hidden */
  31614. _comparisonFunction: number;
  31615. /** @hidden */
  31616. _sphericalPolynomial: Nullable<SphericalPolynomial>;
  31617. /** @hidden */
  31618. _lodGenerationScale: number;
  31619. /** @hidden */
  31620. _lodGenerationOffset: number;
  31621. /** @hidden */
  31622. _colorTextureArray: Nullable<WebGLTexture>;
  31623. /** @hidden */
  31624. _depthStencilTextureArray: Nullable<WebGLTexture>;
  31625. /** @hidden */
  31626. _lodTextureHigh: Nullable<BaseTexture>;
  31627. /** @hidden */
  31628. _lodTextureMid: Nullable<BaseTexture>;
  31629. /** @hidden */
  31630. _lodTextureLow: Nullable<BaseTexture>;
  31631. /** @hidden */
  31632. _isRGBD: boolean;
  31633. /** @hidden */
  31634. _linearSpecularLOD: boolean;
  31635. /** @hidden */
  31636. _irradianceTexture: Nullable<BaseTexture>;
  31637. /** @hidden */
  31638. _webGLTexture: Nullable<WebGLTexture>;
  31639. /** @hidden */
  31640. _references: number;
  31641. private _engine;
  31642. /**
  31643. * Gets the Engine the texture belongs to.
  31644. * @returns The babylon engine
  31645. */
  31646. getEngine(): ThinEngine;
  31647. /**
  31648. * Gets the data source type of the texture
  31649. */
  31650. readonly source: InternalTextureSource;
  31651. /**
  31652. * Creates a new InternalTexture
  31653. * @param engine defines the engine to use
  31654. * @param source defines the type of data that will be used
  31655. * @param delayAllocation if the texture allocation should be delayed (default: false)
  31656. */
  31657. constructor(engine: ThinEngine, source: InternalTextureSource, delayAllocation?: boolean);
  31658. /**
  31659. * Increments the number of references (ie. the number of Texture that point to it)
  31660. */
  31661. incrementReferences(): void;
  31662. /**
  31663. * Change the size of the texture (not the size of the content)
  31664. * @param width defines the new width
  31665. * @param height defines the new height
  31666. * @param depth defines the new depth (1 by default)
  31667. */
  31668. updateSize(width: int, height: int, depth?: int): void;
  31669. /** @hidden */
  31670. _rebuild(): void;
  31671. /** @hidden */
  31672. _swapAndDie(target: InternalTexture): void;
  31673. /**
  31674. * Dispose the current allocated resources
  31675. */
  31676. dispose(): void;
  31677. }
  31678. }
  31679. declare module "babylonjs/Audio/analyser" {
  31680. import { Scene } from "babylonjs/scene";
  31681. /**
  31682. * Class used to work with sound analyzer using fast fourier transform (FFT)
  31683. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  31684. */
  31685. export class Analyser {
  31686. /**
  31687. * Gets or sets the smoothing
  31688. * @ignorenaming
  31689. */
  31690. SMOOTHING: number;
  31691. /**
  31692. * Gets or sets the FFT table size
  31693. * @ignorenaming
  31694. */
  31695. FFT_SIZE: number;
  31696. /**
  31697. * Gets or sets the bar graph amplitude
  31698. * @ignorenaming
  31699. */
  31700. BARGRAPHAMPLITUDE: number;
  31701. /**
  31702. * Gets or sets the position of the debug canvas
  31703. * @ignorenaming
  31704. */
  31705. DEBUGCANVASPOS: {
  31706. x: number;
  31707. y: number;
  31708. };
  31709. /**
  31710. * Gets or sets the debug canvas size
  31711. * @ignorenaming
  31712. */
  31713. DEBUGCANVASSIZE: {
  31714. width: number;
  31715. height: number;
  31716. };
  31717. private _byteFreqs;
  31718. private _byteTime;
  31719. private _floatFreqs;
  31720. private _webAudioAnalyser;
  31721. private _debugCanvas;
  31722. private _debugCanvasContext;
  31723. private _scene;
  31724. private _registerFunc;
  31725. private _audioEngine;
  31726. /**
  31727. * Creates a new analyser
  31728. * @param scene defines hosting scene
  31729. */
  31730. constructor(scene: Scene);
  31731. /**
  31732. * Get the number of data values you will have to play with for the visualization
  31733. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/frequencyBinCount
  31734. * @returns a number
  31735. */
  31736. getFrequencyBinCount(): number;
  31737. /**
  31738. * Gets the current frequency data as a byte array
  31739. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  31740. * @returns a Uint8Array
  31741. */
  31742. getByteFrequencyData(): Uint8Array;
  31743. /**
  31744. * Gets the current waveform as a byte array
  31745. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteTimeDomainData
  31746. * @returns a Uint8Array
  31747. */
  31748. getByteTimeDomainData(): Uint8Array;
  31749. /**
  31750. * Gets the current frequency data as a float array
  31751. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  31752. * @returns a Float32Array
  31753. */
  31754. getFloatFrequencyData(): Float32Array;
  31755. /**
  31756. * Renders the debug canvas
  31757. */
  31758. drawDebugCanvas(): void;
  31759. /**
  31760. * Stops rendering the debug canvas and removes it
  31761. */
  31762. stopDebugCanvas(): void;
  31763. /**
  31764. * Connects two audio nodes
  31765. * @param inputAudioNode defines first node to connect
  31766. * @param outputAudioNode defines second node to connect
  31767. */
  31768. connectAudioNodes(inputAudioNode: AudioNode, outputAudioNode: AudioNode): void;
  31769. /**
  31770. * Releases all associated resources
  31771. */
  31772. dispose(): void;
  31773. }
  31774. }
  31775. declare module "babylonjs/Audio/audioEngine" {
  31776. import { IDisposable } from "babylonjs/scene";
  31777. import { Analyser } from "babylonjs/Audio/analyser";
  31778. import { Nullable } from "babylonjs/types";
  31779. import { Observable } from "babylonjs/Misc/observable";
  31780. /**
  31781. * This represents an audio engine and it is responsible
  31782. * to play, synchronize and analyse sounds throughout the application.
  31783. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  31784. */
  31785. export interface IAudioEngine extends IDisposable {
  31786. /**
  31787. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  31788. */
  31789. readonly canUseWebAudio: boolean;
  31790. /**
  31791. * Gets the current AudioContext if available.
  31792. */
  31793. readonly audioContext: Nullable<AudioContext>;
  31794. /**
  31795. * The master gain node defines the global audio volume of your audio engine.
  31796. */
  31797. readonly masterGain: GainNode;
  31798. /**
  31799. * Gets whether or not mp3 are supported by your browser.
  31800. */
  31801. readonly isMP3supported: boolean;
  31802. /**
  31803. * Gets whether or not ogg are supported by your browser.
  31804. */
  31805. readonly isOGGsupported: boolean;
  31806. /**
  31807. * Defines if Babylon should emit a warning if WebAudio is not supported.
  31808. * @ignoreNaming
  31809. */
  31810. WarnedWebAudioUnsupported: boolean;
  31811. /**
  31812. * Defines if the audio engine relies on a custom unlocked button.
  31813. * In this case, the embedded button will not be displayed.
  31814. */
  31815. useCustomUnlockedButton: boolean;
  31816. /**
  31817. * Gets whether or not the audio engine is unlocked (require first a user gesture on some browser).
  31818. */
  31819. readonly unlocked: boolean;
  31820. /**
  31821. * Event raised when audio has been unlocked on the browser.
  31822. */
  31823. onAudioUnlockedObservable: Observable<AudioEngine>;
  31824. /**
  31825. * Event raised when audio has been locked on the browser.
  31826. */
  31827. onAudioLockedObservable: Observable<AudioEngine>;
  31828. /**
  31829. * Flags the audio engine in Locked state.
  31830. * This happens due to new browser policies preventing audio to autoplay.
  31831. */
  31832. lock(): void;
  31833. /**
  31834. * Unlocks the audio engine once a user action has been done on the dom.
  31835. * This is helpful to resume play once browser policies have been satisfied.
  31836. */
  31837. unlock(): void;
  31838. }
  31839. /**
  31840. * This represents the default audio engine used in babylon.
  31841. * It is responsible to play, synchronize and analyse sounds throughout the application.
  31842. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  31843. */
  31844. export class AudioEngine implements IAudioEngine {
  31845. private _audioContext;
  31846. private _audioContextInitialized;
  31847. private _muteButton;
  31848. private _hostElement;
  31849. /**
  31850. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  31851. */
  31852. canUseWebAudio: boolean;
  31853. /**
  31854. * The master gain node defines the global audio volume of your audio engine.
  31855. */
  31856. masterGain: GainNode;
  31857. /**
  31858. * Defines if Babylon should emit a warning if WebAudio is not supported.
  31859. * @ignoreNaming
  31860. */
  31861. WarnedWebAudioUnsupported: boolean;
  31862. /**
  31863. * Gets whether or not mp3 are supported by your browser.
  31864. */
  31865. isMP3supported: boolean;
  31866. /**
  31867. * Gets whether or not ogg are supported by your browser.
  31868. */
  31869. isOGGsupported: boolean;
  31870. /**
  31871. * Gets whether audio has been unlocked on the device.
  31872. * Some Browsers have strong restrictions about Audio and won t autoplay unless
  31873. * a user interaction has happened.
  31874. */
  31875. unlocked: boolean;
  31876. /**
  31877. * Defines if the audio engine relies on a custom unlocked button.
  31878. * In this case, the embedded button will not be displayed.
  31879. */
  31880. useCustomUnlockedButton: boolean;
  31881. /**
  31882. * Event raised when audio has been unlocked on the browser.
  31883. */
  31884. onAudioUnlockedObservable: Observable<AudioEngine>;
  31885. /**
  31886. * Event raised when audio has been locked on the browser.
  31887. */
  31888. onAudioLockedObservable: Observable<AudioEngine>;
  31889. /**
  31890. * Gets the current AudioContext if available.
  31891. */
  31892. readonly audioContext: Nullable<AudioContext>;
  31893. private _connectedAnalyser;
  31894. /**
  31895. * Instantiates a new audio engine.
  31896. *
  31897. * There should be only one per page as some browsers restrict the number
  31898. * of audio contexts you can create.
  31899. * @param hostElement defines the host element where to display the mute icon if necessary
  31900. */
  31901. constructor(hostElement?: Nullable<HTMLElement>);
  31902. /**
  31903. * Flags the audio engine in Locked state.
  31904. * This happens due to new browser policies preventing audio to autoplay.
  31905. */
  31906. lock(): void;
  31907. /**
  31908. * Unlocks the audio engine once a user action has been done on the dom.
  31909. * This is helpful to resume play once browser policies have been satisfied.
  31910. */
  31911. unlock(): void;
  31912. private _resumeAudioContext;
  31913. private _initializeAudioContext;
  31914. private _tryToRun;
  31915. private _triggerRunningState;
  31916. private _triggerSuspendedState;
  31917. private _displayMuteButton;
  31918. private _moveButtonToTopLeft;
  31919. private _onResize;
  31920. private _hideMuteButton;
  31921. /**
  31922. * Destroy and release the resources associated with the audio ccontext.
  31923. */
  31924. dispose(): void;
  31925. /**
  31926. * Gets the global volume sets on the master gain.
  31927. * @returns the global volume if set or -1 otherwise
  31928. */
  31929. getGlobalVolume(): number;
  31930. /**
  31931. * Sets the global volume of your experience (sets on the master gain).
  31932. * @param newVolume Defines the new global volume of the application
  31933. */
  31934. setGlobalVolume(newVolume: number): void;
  31935. /**
  31936. * Connect the audio engine to an audio analyser allowing some amazing
  31937. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  31938. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  31939. * @param analyser The analyser to connect to the engine
  31940. */
  31941. connectToAnalyser(analyser: Analyser): void;
  31942. }
  31943. }
  31944. declare module "babylonjs/Loading/loadingScreen" {
  31945. /**
  31946. * Interface used to present a loading screen while loading a scene
  31947. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  31948. */
  31949. export interface ILoadingScreen {
  31950. /**
  31951. * Function called to display the loading screen
  31952. */
  31953. displayLoadingUI: () => void;
  31954. /**
  31955. * Function called to hide the loading screen
  31956. */
  31957. hideLoadingUI: () => void;
  31958. /**
  31959. * Gets or sets the color to use for the background
  31960. */
  31961. loadingUIBackgroundColor: string;
  31962. /**
  31963. * Gets or sets the text to display while loading
  31964. */
  31965. loadingUIText: string;
  31966. }
  31967. /**
  31968. * Class used for the default loading screen
  31969. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  31970. */
  31971. export class DefaultLoadingScreen implements ILoadingScreen {
  31972. private _renderingCanvas;
  31973. private _loadingText;
  31974. private _loadingDivBackgroundColor;
  31975. private _loadingDiv;
  31976. private _loadingTextDiv;
  31977. /** Gets or sets the logo url to use for the default loading screen */
  31978. static DefaultLogoUrl: string;
  31979. /** Gets or sets the spinner url to use for the default loading screen */
  31980. static DefaultSpinnerUrl: string;
  31981. /**
  31982. * Creates a new default loading screen
  31983. * @param _renderingCanvas defines the canvas used to render the scene
  31984. * @param _loadingText defines the default text to display
  31985. * @param _loadingDivBackgroundColor defines the default background color
  31986. */
  31987. constructor(_renderingCanvas: HTMLCanvasElement, _loadingText?: string, _loadingDivBackgroundColor?: string);
  31988. /**
  31989. * Function called to display the loading screen
  31990. */
  31991. displayLoadingUI(): void;
  31992. /**
  31993. * Function called to hide the loading screen
  31994. */
  31995. hideLoadingUI(): void;
  31996. /**
  31997. * Gets or sets the text to display while loading
  31998. */
  31999. loadingUIText: string;
  32000. /**
  32001. * Gets or sets the color to use for the background
  32002. */
  32003. loadingUIBackgroundColor: string;
  32004. private _resizeLoadingUI;
  32005. }
  32006. }
  32007. declare module "babylonjs/Misc/customAnimationFrameRequester" {
  32008. /**
  32009. * Interface for any object that can request an animation frame
  32010. */
  32011. export interface ICustomAnimationFrameRequester {
  32012. /**
  32013. * This function will be called when the render loop is ready. If this is not populated, the engine's renderloop function will be called
  32014. */
  32015. renderFunction?: Function;
  32016. /**
  32017. * Called to request the next frame to render to
  32018. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame
  32019. */
  32020. requestAnimationFrame: Function;
  32021. /**
  32022. * You can pass this value to cancelAnimationFrame() to cancel the refresh callback request
  32023. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame#Return_value
  32024. */
  32025. requestID?: number;
  32026. }
  32027. }
  32028. declare module "babylonjs/Misc/performanceMonitor" {
  32029. /**
  32030. * Performance monitor tracks rolling average frame-time and frame-time variance over a user defined sliding-window
  32031. */
  32032. export class PerformanceMonitor {
  32033. private _enabled;
  32034. private _rollingFrameTime;
  32035. private _lastFrameTimeMs;
  32036. /**
  32037. * constructor
  32038. * @param frameSampleSize The number of samples required to saturate the sliding window
  32039. */
  32040. constructor(frameSampleSize?: number);
  32041. /**
  32042. * Samples current frame
  32043. * @param timeMs A timestamp in milliseconds of the current frame to compare with other frames
  32044. */
  32045. sampleFrame(timeMs?: number): void;
  32046. /**
  32047. * Returns the average frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  32048. */
  32049. readonly averageFrameTime: number;
  32050. /**
  32051. * Returns the variance frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  32052. */
  32053. readonly averageFrameTimeVariance: number;
  32054. /**
  32055. * Returns the frame time of the most recent frame
  32056. */
  32057. readonly instantaneousFrameTime: number;
  32058. /**
  32059. * Returns the average framerate in frames per second over the sliding window (or the subset of frames sampled so far)
  32060. */
  32061. readonly averageFPS: number;
  32062. /**
  32063. * Returns the average framerate in frames per second using the most recent frame time
  32064. */
  32065. readonly instantaneousFPS: number;
  32066. /**
  32067. * Returns true if enough samples have been taken to completely fill the sliding window
  32068. */
  32069. readonly isSaturated: boolean;
  32070. /**
  32071. * Enables contributions to the sliding window sample set
  32072. */
  32073. enable(): void;
  32074. /**
  32075. * Disables contributions to the sliding window sample set
  32076. * Samples will not be interpolated over the disabled period
  32077. */
  32078. disable(): void;
  32079. /**
  32080. * Returns true if sampling is enabled
  32081. */
  32082. readonly isEnabled: boolean;
  32083. /**
  32084. * Resets performance monitor
  32085. */
  32086. reset(): void;
  32087. }
  32088. /**
  32089. * RollingAverage
  32090. *
  32091. * Utility to efficiently compute the rolling average and variance over a sliding window of samples
  32092. */
  32093. export class RollingAverage {
  32094. /**
  32095. * Current average
  32096. */
  32097. average: number;
  32098. /**
  32099. * Current variance
  32100. */
  32101. variance: number;
  32102. protected _samples: Array<number>;
  32103. protected _sampleCount: number;
  32104. protected _pos: number;
  32105. protected _m2: number;
  32106. /**
  32107. * constructor
  32108. * @param length The number of samples required to saturate the sliding window
  32109. */
  32110. constructor(length: number);
  32111. /**
  32112. * Adds a sample to the sample set
  32113. * @param v The sample value
  32114. */
  32115. add(v: number): void;
  32116. /**
  32117. * Returns previously added values or null if outside of history or outside the sliding window domain
  32118. * @param i Index in history. For example, pass 0 for the most recent value and 1 for the value before that
  32119. * @return Value previously recorded with add() or null if outside of range
  32120. */
  32121. history(i: number): number;
  32122. /**
  32123. * Returns true if enough samples have been taken to completely fill the sliding window
  32124. * @return true if sample-set saturated
  32125. */
  32126. isSaturated(): boolean;
  32127. /**
  32128. * Resets the rolling average (equivalent to 0 samples taken so far)
  32129. */
  32130. reset(): void;
  32131. /**
  32132. * Wraps a value around the sample range boundaries
  32133. * @param i Position in sample range, for example if the sample length is 5, and i is -3, then 2 will be returned.
  32134. * @return Wrapped position in sample range
  32135. */
  32136. protected _wrapPosition(i: number): number;
  32137. }
  32138. }
  32139. declare module "babylonjs/Misc/perfCounter" {
  32140. /**
  32141. * This class is used to track a performance counter which is number based.
  32142. * The user has access to many properties which give statistics of different nature.
  32143. *
  32144. * The implementer can track two kinds of Performance Counter: time and count.
  32145. * 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.
  32146. * 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.
  32147. */
  32148. export class PerfCounter {
  32149. /**
  32150. * Gets or sets a global boolean to turn on and off all the counters
  32151. */
  32152. static Enabled: boolean;
  32153. /**
  32154. * Returns the smallest value ever
  32155. */
  32156. readonly min: number;
  32157. /**
  32158. * Returns the biggest value ever
  32159. */
  32160. readonly max: number;
  32161. /**
  32162. * Returns the average value since the performance counter is running
  32163. */
  32164. readonly average: number;
  32165. /**
  32166. * Returns the average value of the last second the counter was monitored
  32167. */
  32168. readonly lastSecAverage: number;
  32169. /**
  32170. * Returns the current value
  32171. */
  32172. readonly current: number;
  32173. /**
  32174. * Gets the accumulated total
  32175. */
  32176. readonly total: number;
  32177. /**
  32178. * Gets the total value count
  32179. */
  32180. readonly count: number;
  32181. /**
  32182. * Creates a new counter
  32183. */
  32184. constructor();
  32185. /**
  32186. * Call this method to start monitoring a new frame.
  32187. * 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.
  32188. */
  32189. fetchNewFrame(): void;
  32190. /**
  32191. * Call this method to monitor a count of something (e.g. mesh drawn in viewport count)
  32192. * @param newCount the count value to add to the monitored count
  32193. * @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.
  32194. */
  32195. addCount(newCount: number, fetchResult: boolean): void;
  32196. /**
  32197. * Start monitoring this performance counter
  32198. */
  32199. beginMonitoring(): void;
  32200. /**
  32201. * Compute the time lapsed since the previous beginMonitoring() call.
  32202. * @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
  32203. */
  32204. endMonitoring(newFrame?: boolean): void;
  32205. private _fetchResult;
  32206. private _startMonitoringTime;
  32207. private _min;
  32208. private _max;
  32209. private _average;
  32210. private _current;
  32211. private _totalValueCount;
  32212. private _totalAccumulated;
  32213. private _lastSecAverage;
  32214. private _lastSecAccumulated;
  32215. private _lastSecTime;
  32216. private _lastSecValueCount;
  32217. }
  32218. }
  32219. declare module "babylonjs/Engines/engine" {
  32220. import { Observable } from "babylonjs/Misc/observable";
  32221. import { Nullable, IndicesArray, DataArray } from "babylonjs/types";
  32222. import { Scene } from "babylonjs/scene";
  32223. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  32224. import { IAudioEngine } from "babylonjs/Audio/audioEngine";
  32225. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  32226. import { ILoadingScreen } from "babylonjs/Loading/loadingScreen";
  32227. import { WebGLPipelineContext } from "babylonjs/Engines/WebGL/webGLPipelineContext";
  32228. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  32229. import { ICustomAnimationFrameRequester } from "babylonjs/Misc/customAnimationFrameRequester";
  32230. import { ThinEngine, EngineOptions } from "babylonjs/Engines/thinEngine";
  32231. import { IViewportLike, IColor4Like } from "babylonjs/Maths/math.like";
  32232. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  32233. import { PerformanceMonitor } from "babylonjs/Misc/performanceMonitor";
  32234. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  32235. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  32236. import { Material } from "babylonjs/Materials/material";
  32237. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  32238. /**
  32239. * Defines the interface used by display changed events
  32240. */
  32241. export interface IDisplayChangedEventArgs {
  32242. /** Gets the vrDisplay object (if any) */
  32243. vrDisplay: Nullable<any>;
  32244. /** Gets a boolean indicating if webVR is supported */
  32245. vrSupported: boolean;
  32246. }
  32247. /**
  32248. * Defines the interface used by objects containing a viewport (like a camera)
  32249. */
  32250. interface IViewportOwnerLike {
  32251. /**
  32252. * Gets or sets the viewport
  32253. */
  32254. viewport: IViewportLike;
  32255. }
  32256. /**
  32257. * The engine class is responsible for interfacing with all lower-level APIs such as WebGL and Audio
  32258. */
  32259. export class Engine extends ThinEngine {
  32260. /** Defines that alpha blending is disabled */
  32261. static readonly ALPHA_DISABLE: number;
  32262. /** Defines that alpha blending to SRC ALPHA * SRC + DEST */
  32263. static readonly ALPHA_ADD: number;
  32264. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  32265. static readonly ALPHA_COMBINE: number;
  32266. /** Defines that alpha blending to DEST - SRC * DEST */
  32267. static readonly ALPHA_SUBTRACT: number;
  32268. /** Defines that alpha blending to SRC * DEST */
  32269. static readonly ALPHA_MULTIPLY: number;
  32270. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC) * DEST */
  32271. static readonly ALPHA_MAXIMIZED: number;
  32272. /** Defines that alpha blending to SRC + DEST */
  32273. static readonly ALPHA_ONEONE: number;
  32274. /** Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST */
  32275. static readonly ALPHA_PREMULTIPLIED: number;
  32276. /**
  32277. * Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST
  32278. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  32279. */
  32280. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  32281. /** Defines that alpha blending to CST * SRC + (1 - CST) * DEST */
  32282. static readonly ALPHA_INTERPOLATE: number;
  32283. /**
  32284. * Defines that alpha blending to SRC + (1 - SRC) * DEST
  32285. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  32286. */
  32287. static readonly ALPHA_SCREENMODE: number;
  32288. /** Defines that the ressource is not delayed*/
  32289. static readonly DELAYLOADSTATE_NONE: number;
  32290. /** Defines that the ressource was successfully delay loaded */
  32291. static readonly DELAYLOADSTATE_LOADED: number;
  32292. /** Defines that the ressource is currently delay loading */
  32293. static readonly DELAYLOADSTATE_LOADING: number;
  32294. /** Defines that the ressource is delayed and has not started loading */
  32295. static readonly DELAYLOADSTATE_NOTLOADED: number;
  32296. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  32297. static readonly NEVER: number;
  32298. /** 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 */
  32299. static readonly ALWAYS: number;
  32300. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  32301. static readonly LESS: number;
  32302. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  32303. static readonly EQUAL: number;
  32304. /** 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 */
  32305. static readonly LEQUAL: number;
  32306. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  32307. static readonly GREATER: number;
  32308. /** 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 */
  32309. static readonly GEQUAL: number;
  32310. /** 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 */
  32311. static readonly NOTEQUAL: number;
  32312. /** Passed to stencilOperation to specify that stencil value must be kept */
  32313. static readonly KEEP: number;
  32314. /** Passed to stencilOperation to specify that stencil value must be replaced */
  32315. static readonly REPLACE: number;
  32316. /** Passed to stencilOperation to specify that stencil value must be incremented */
  32317. static readonly INCR: number;
  32318. /** Passed to stencilOperation to specify that stencil value must be decremented */
  32319. static readonly DECR: number;
  32320. /** Passed to stencilOperation to specify that stencil value must be inverted */
  32321. static readonly INVERT: number;
  32322. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  32323. static readonly INCR_WRAP: number;
  32324. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  32325. static readonly DECR_WRAP: number;
  32326. /** Texture is not repeating outside of 0..1 UVs */
  32327. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  32328. /** Texture is repeating outside of 0..1 UVs */
  32329. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  32330. /** Texture is repeating and mirrored */
  32331. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  32332. /** ALPHA */
  32333. static readonly TEXTUREFORMAT_ALPHA: number;
  32334. /** LUMINANCE */
  32335. static readonly TEXTUREFORMAT_LUMINANCE: number;
  32336. /** LUMINANCE_ALPHA */
  32337. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  32338. /** RGB */
  32339. static readonly TEXTUREFORMAT_RGB: number;
  32340. /** RGBA */
  32341. static readonly TEXTUREFORMAT_RGBA: number;
  32342. /** RED */
  32343. static readonly TEXTUREFORMAT_RED: number;
  32344. /** RED (2nd reference) */
  32345. static readonly TEXTUREFORMAT_R: number;
  32346. /** RG */
  32347. static readonly TEXTUREFORMAT_RG: number;
  32348. /** RED_INTEGER */
  32349. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  32350. /** RED_INTEGER (2nd reference) */
  32351. static readonly TEXTUREFORMAT_R_INTEGER: number;
  32352. /** RG_INTEGER */
  32353. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  32354. /** RGB_INTEGER */
  32355. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  32356. /** RGBA_INTEGER */
  32357. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  32358. /** UNSIGNED_BYTE */
  32359. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  32360. /** UNSIGNED_BYTE (2nd reference) */
  32361. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  32362. /** FLOAT */
  32363. static readonly TEXTURETYPE_FLOAT: number;
  32364. /** HALF_FLOAT */
  32365. static readonly TEXTURETYPE_HALF_FLOAT: number;
  32366. /** BYTE */
  32367. static readonly TEXTURETYPE_BYTE: number;
  32368. /** SHORT */
  32369. static readonly TEXTURETYPE_SHORT: number;
  32370. /** UNSIGNED_SHORT */
  32371. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  32372. /** INT */
  32373. static readonly TEXTURETYPE_INT: number;
  32374. /** UNSIGNED_INT */
  32375. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  32376. /** UNSIGNED_SHORT_4_4_4_4 */
  32377. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  32378. /** UNSIGNED_SHORT_5_5_5_1 */
  32379. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  32380. /** UNSIGNED_SHORT_5_6_5 */
  32381. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  32382. /** UNSIGNED_INT_2_10_10_10_REV */
  32383. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  32384. /** UNSIGNED_INT_24_8 */
  32385. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  32386. /** UNSIGNED_INT_10F_11F_11F_REV */
  32387. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  32388. /** UNSIGNED_INT_5_9_9_9_REV */
  32389. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  32390. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  32391. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  32392. /** nearest is mag = nearest and min = nearest and mip = linear */
  32393. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  32394. /** Bilinear is mag = linear and min = linear and mip = nearest */
  32395. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  32396. /** Trilinear is mag = linear and min = linear and mip = linear */
  32397. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  32398. /** nearest is mag = nearest and min = nearest and mip = linear */
  32399. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  32400. /** Bilinear is mag = linear and min = linear and mip = nearest */
  32401. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  32402. /** Trilinear is mag = linear and min = linear and mip = linear */
  32403. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  32404. /** mag = nearest and min = nearest and mip = nearest */
  32405. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  32406. /** mag = nearest and min = linear and mip = nearest */
  32407. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  32408. /** mag = nearest and min = linear and mip = linear */
  32409. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  32410. /** mag = nearest and min = linear and mip = none */
  32411. static readonly TEXTURE_NEAREST_LINEAR: number;
  32412. /** mag = nearest and min = nearest and mip = none */
  32413. static readonly TEXTURE_NEAREST_NEAREST: number;
  32414. /** mag = linear and min = nearest and mip = nearest */
  32415. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  32416. /** mag = linear and min = nearest and mip = linear */
  32417. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  32418. /** mag = linear and min = linear and mip = none */
  32419. static readonly TEXTURE_LINEAR_LINEAR: number;
  32420. /** mag = linear and min = nearest and mip = none */
  32421. static readonly TEXTURE_LINEAR_NEAREST: number;
  32422. /** Explicit coordinates mode */
  32423. static readonly TEXTURE_EXPLICIT_MODE: number;
  32424. /** Spherical coordinates mode */
  32425. static readonly TEXTURE_SPHERICAL_MODE: number;
  32426. /** Planar coordinates mode */
  32427. static readonly TEXTURE_PLANAR_MODE: number;
  32428. /** Cubic coordinates mode */
  32429. static readonly TEXTURE_CUBIC_MODE: number;
  32430. /** Projection coordinates mode */
  32431. static readonly TEXTURE_PROJECTION_MODE: number;
  32432. /** Skybox coordinates mode */
  32433. static readonly TEXTURE_SKYBOX_MODE: number;
  32434. /** Inverse Cubic coordinates mode */
  32435. static readonly TEXTURE_INVCUBIC_MODE: number;
  32436. /** Equirectangular coordinates mode */
  32437. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  32438. /** Equirectangular Fixed coordinates mode */
  32439. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  32440. /** Equirectangular Fixed Mirrored coordinates mode */
  32441. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  32442. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  32443. static readonly SCALEMODE_FLOOR: number;
  32444. /** Defines that texture rescaling will look for the nearest power of 2 size */
  32445. static readonly SCALEMODE_NEAREST: number;
  32446. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  32447. static readonly SCALEMODE_CEILING: number;
  32448. /**
  32449. * Returns the current npm package of the sdk
  32450. */
  32451. static readonly NpmPackage: string;
  32452. /**
  32453. * Returns the current version of the framework
  32454. */
  32455. static readonly Version: string;
  32456. /** Gets the list of created engines */
  32457. static readonly Instances: Engine[];
  32458. /**
  32459. * Gets the latest created engine
  32460. */
  32461. static readonly LastCreatedEngine: Nullable<Engine>;
  32462. /**
  32463. * Gets the latest created scene
  32464. */
  32465. static readonly LastCreatedScene: Nullable<Scene>;
  32466. /**
  32467. * Will flag all materials in all scenes in all engines as dirty to trigger new shader compilation
  32468. * @param flag defines which part of the materials must be marked as dirty
  32469. * @param predicate defines a predicate used to filter which materials should be affected
  32470. */
  32471. static MarkAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  32472. /**
  32473. * Method called to create the default loading screen.
  32474. * This can be overriden in your own app.
  32475. * @param canvas The rendering canvas element
  32476. * @returns The loading screen
  32477. */
  32478. static DefaultLoadingScreenFactory(canvas: HTMLCanvasElement): ILoadingScreen;
  32479. /**
  32480. * Method called to create the default rescale post process on each engine.
  32481. */
  32482. static _RescalePostProcessFactory: Nullable<(engine: Engine) => PostProcess>;
  32483. /**
  32484. * Gets or sets a boolean to enable/disable IndexedDB support and avoid XHR on .manifest
  32485. **/
  32486. enableOfflineSupport: boolean;
  32487. /**
  32488. * 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)
  32489. **/
  32490. disableManifestCheck: boolean;
  32491. /**
  32492. * Gets the list of created scenes
  32493. */
  32494. scenes: Scene[];
  32495. /**
  32496. * Event raised when a new scene is created
  32497. */
  32498. onNewSceneAddedObservable: Observable<Scene>;
  32499. /**
  32500. * Gets the list of created postprocesses
  32501. */
  32502. postProcesses: import("babylonjs/PostProcesses/postProcess").PostProcess[];
  32503. /**
  32504. * Gets a boolean indicating if the pointer is currently locked
  32505. */
  32506. isPointerLock: boolean;
  32507. /**
  32508. * Observable event triggered each time the rendering canvas is resized
  32509. */
  32510. onResizeObservable: Observable<Engine>;
  32511. /**
  32512. * Observable event triggered each time the canvas loses focus
  32513. */
  32514. onCanvasBlurObservable: Observable<Engine>;
  32515. /**
  32516. * Observable event triggered each time the canvas gains focus
  32517. */
  32518. onCanvasFocusObservable: Observable<Engine>;
  32519. /**
  32520. * Observable event triggered each time the canvas receives pointerout event
  32521. */
  32522. onCanvasPointerOutObservable: Observable<PointerEvent>;
  32523. /**
  32524. * Observable raised when the engine begins a new frame
  32525. */
  32526. onBeginFrameObservable: Observable<Engine>;
  32527. /**
  32528. * If set, will be used to request the next animation frame for the render loop
  32529. */
  32530. customAnimationFrameRequester: Nullable<ICustomAnimationFrameRequester>;
  32531. /**
  32532. * Observable raised when the engine ends the current frame
  32533. */
  32534. onEndFrameObservable: Observable<Engine>;
  32535. /**
  32536. * Observable raised when the engine is about to compile a shader
  32537. */
  32538. onBeforeShaderCompilationObservable: Observable<Engine>;
  32539. /**
  32540. * Observable raised when the engine has jsut compiled a shader
  32541. */
  32542. onAfterShaderCompilationObservable: Observable<Engine>;
  32543. /**
  32544. * Gets the audio engine
  32545. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  32546. * @ignorenaming
  32547. */
  32548. static audioEngine: IAudioEngine;
  32549. /**
  32550. * Default AudioEngine factory responsible of creating the Audio Engine.
  32551. * By default, this will create a BabylonJS Audio Engine if the workload has been embedded.
  32552. */
  32553. static AudioEngineFactory: (hostElement: Nullable<HTMLElement>) => IAudioEngine;
  32554. /**
  32555. * Default offline support factory responsible of creating a tool used to store data locally.
  32556. * By default, this will create a Database object if the workload has been embedded.
  32557. */
  32558. static OfflineProviderFactory: (urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck: boolean) => IOfflineProvider;
  32559. private _loadingScreen;
  32560. private _pointerLockRequested;
  32561. private _dummyFramebuffer;
  32562. private _rescalePostProcess;
  32563. /** @hidden */
  32564. protected _alphaMode: number;
  32565. /** @hidden */
  32566. protected _alphaEquation: number;
  32567. private _deterministicLockstep;
  32568. private _lockstepMaxSteps;
  32569. protected readonly _supportsHardwareTextureRescaling: boolean;
  32570. private _fps;
  32571. private _deltaTime;
  32572. /** @hidden */
  32573. _drawCalls: PerfCounter;
  32574. /**
  32575. * Turn this value on if you want to pause FPS computation when in background
  32576. */
  32577. disablePerformanceMonitorInBackground: boolean;
  32578. private _performanceMonitor;
  32579. /**
  32580. * Gets the performance monitor attached to this engine
  32581. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  32582. */
  32583. readonly performanceMonitor: PerformanceMonitor;
  32584. private _onFocus;
  32585. private _onBlur;
  32586. private _onCanvasPointerOut;
  32587. private _onCanvasBlur;
  32588. private _onCanvasFocus;
  32589. private _onFullscreenChange;
  32590. private _onPointerLockChange;
  32591. /**
  32592. * Gets the HTML element used to attach event listeners
  32593. * @returns a HTML element
  32594. */
  32595. getInputElement(): Nullable<HTMLElement>;
  32596. /**
  32597. * Creates a new engine
  32598. * @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
  32599. * @param antialias defines enable antialiasing (default: false)
  32600. * @param options defines further options to be sent to the getContext() function
  32601. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  32602. */
  32603. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  32604. /**
  32605. * Gets current aspect ratio
  32606. * @param viewportOwner defines the camera to use to get the aspect ratio
  32607. * @param useScreen defines if screen size must be used (or the current render target if any)
  32608. * @returns a number defining the aspect ratio
  32609. */
  32610. getAspectRatio(viewportOwner: IViewportOwnerLike, useScreen?: boolean): number;
  32611. /**
  32612. * Gets current screen aspect ratio
  32613. * @returns a number defining the aspect ratio
  32614. */
  32615. getScreenAspectRatio(): number;
  32616. /**
  32617. * Gets host document
  32618. * @returns the host document object
  32619. */
  32620. getHostDocument(): Document;
  32621. /**
  32622. * Gets the client rect of the HTML canvas attached with the current webGL context
  32623. * @returns a client rectanglee
  32624. */
  32625. getRenderingCanvasClientRect(): Nullable<ClientRect>;
  32626. /**
  32627. * Gets the client rect of the HTML element used for events
  32628. * @returns a client rectanglee
  32629. */
  32630. getInputElementClientRect(): Nullable<ClientRect>;
  32631. /**
  32632. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  32633. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  32634. * @returns true if engine is in deterministic lock step mode
  32635. */
  32636. isDeterministicLockStep(): boolean;
  32637. /**
  32638. * Gets the max steps when engine is running in deterministic lock step
  32639. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  32640. * @returns the max steps
  32641. */
  32642. getLockstepMaxSteps(): number;
  32643. /**
  32644. * Force the mipmap generation for the given render target texture
  32645. * @param texture defines the render target texture to use
  32646. */
  32647. generateMipMapsForCubemap(texture: InternalTexture): void;
  32648. /** States */
  32649. /**
  32650. * Set various states to the webGL context
  32651. * @param culling defines backface culling state
  32652. * @param zOffset defines the value to apply to zOffset (0 by default)
  32653. * @param force defines if states must be applied even if cache is up to date
  32654. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  32655. */
  32656. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  32657. /**
  32658. * Set the z offset to apply to current rendering
  32659. * @param value defines the offset to apply
  32660. */
  32661. setZOffset(value: number): void;
  32662. /**
  32663. * Gets the current value of the zOffset
  32664. * @returns the current zOffset state
  32665. */
  32666. getZOffset(): number;
  32667. /**
  32668. * Enable or disable depth buffering
  32669. * @param enable defines the state to set
  32670. */
  32671. setDepthBuffer(enable: boolean): void;
  32672. /**
  32673. * Gets a boolean indicating if depth writing is enabled
  32674. * @returns the current depth writing state
  32675. */
  32676. getDepthWrite(): boolean;
  32677. /**
  32678. * Enable or disable depth writing
  32679. * @param enable defines the state to set
  32680. */
  32681. setDepthWrite(enable: boolean): void;
  32682. /**
  32683. * Enable or disable color writing
  32684. * @param enable defines the state to set
  32685. */
  32686. setColorWrite(enable: boolean): void;
  32687. /**
  32688. * Gets a boolean indicating if color writing is enabled
  32689. * @returns the current color writing state
  32690. */
  32691. getColorWrite(): boolean;
  32692. /**
  32693. * Sets alpha constants used by some alpha blending modes
  32694. * @param r defines the red component
  32695. * @param g defines the green component
  32696. * @param b defines the blue component
  32697. * @param a defines the alpha component
  32698. */
  32699. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  32700. /**
  32701. * Sets the current alpha mode
  32702. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  32703. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  32704. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  32705. */
  32706. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  32707. /**
  32708. * Gets the current alpha mode
  32709. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  32710. * @returns the current alpha mode
  32711. */
  32712. getAlphaMode(): number;
  32713. /**
  32714. * Sets the current alpha equation
  32715. * @param equation defines the equation to use (one of the Engine.ALPHA_EQUATION_XXX)
  32716. */
  32717. setAlphaEquation(equation: number): void;
  32718. /**
  32719. * Gets the current alpha equation.
  32720. * @returns the current alpha equation
  32721. */
  32722. getAlphaEquation(): number;
  32723. /**
  32724. * Gets a boolean indicating if stencil buffer is enabled
  32725. * @returns the current stencil buffer state
  32726. */
  32727. getStencilBuffer(): boolean;
  32728. /**
  32729. * Enable or disable the stencil buffer
  32730. * @param enable defines if the stencil buffer must be enabled or disabled
  32731. */
  32732. setStencilBuffer(enable: boolean): void;
  32733. /**
  32734. * Gets the current stencil mask
  32735. * @returns a number defining the new stencil mask to use
  32736. */
  32737. getStencilMask(): number;
  32738. /**
  32739. * Sets the current stencil mask
  32740. * @param mask defines the new stencil mask to use
  32741. */
  32742. setStencilMask(mask: number): void;
  32743. /**
  32744. * Gets the current stencil function
  32745. * @returns a number defining the stencil function to use
  32746. */
  32747. getStencilFunction(): number;
  32748. /**
  32749. * Gets the current stencil reference value
  32750. * @returns a number defining the stencil reference value to use
  32751. */
  32752. getStencilFunctionReference(): number;
  32753. /**
  32754. * Gets the current stencil mask
  32755. * @returns a number defining the stencil mask to use
  32756. */
  32757. getStencilFunctionMask(): number;
  32758. /**
  32759. * Sets the current stencil function
  32760. * @param stencilFunc defines the new stencil function to use
  32761. */
  32762. setStencilFunction(stencilFunc: number): void;
  32763. /**
  32764. * Sets the current stencil reference
  32765. * @param reference defines the new stencil reference to use
  32766. */
  32767. setStencilFunctionReference(reference: number): void;
  32768. /**
  32769. * Sets the current stencil mask
  32770. * @param mask defines the new stencil mask to use
  32771. */
  32772. setStencilFunctionMask(mask: number): void;
  32773. /**
  32774. * Gets the current stencil operation when stencil fails
  32775. * @returns a number defining stencil operation to use when stencil fails
  32776. */
  32777. getStencilOperationFail(): number;
  32778. /**
  32779. * Gets the current stencil operation when depth fails
  32780. * @returns a number defining stencil operation to use when depth fails
  32781. */
  32782. getStencilOperationDepthFail(): number;
  32783. /**
  32784. * Gets the current stencil operation when stencil passes
  32785. * @returns a number defining stencil operation to use when stencil passes
  32786. */
  32787. getStencilOperationPass(): number;
  32788. /**
  32789. * Sets the stencil operation to use when stencil fails
  32790. * @param operation defines the stencil operation to use when stencil fails
  32791. */
  32792. setStencilOperationFail(operation: number): void;
  32793. /**
  32794. * Sets the stencil operation to use when depth fails
  32795. * @param operation defines the stencil operation to use when depth fails
  32796. */
  32797. setStencilOperationDepthFail(operation: number): void;
  32798. /**
  32799. * Sets the stencil operation to use when stencil passes
  32800. * @param operation defines the stencil operation to use when stencil passes
  32801. */
  32802. setStencilOperationPass(operation: number): void;
  32803. /**
  32804. * Sets a boolean indicating if the dithering state is enabled or disabled
  32805. * @param value defines the dithering state
  32806. */
  32807. setDitheringState(value: boolean): void;
  32808. /**
  32809. * Sets a boolean indicating if the rasterizer state is enabled or disabled
  32810. * @param value defines the rasterizer state
  32811. */
  32812. setRasterizerState(value: boolean): void;
  32813. /**
  32814. * Gets the current depth function
  32815. * @returns a number defining the depth function
  32816. */
  32817. getDepthFunction(): Nullable<number>;
  32818. /**
  32819. * Sets the current depth function
  32820. * @param depthFunc defines the function to use
  32821. */
  32822. setDepthFunction(depthFunc: number): void;
  32823. /**
  32824. * Sets the current depth function to GREATER
  32825. */
  32826. setDepthFunctionToGreater(): void;
  32827. /**
  32828. * Sets the current depth function to GEQUAL
  32829. */
  32830. setDepthFunctionToGreaterOrEqual(): void;
  32831. /**
  32832. * Sets the current depth function to LESS
  32833. */
  32834. setDepthFunctionToLess(): void;
  32835. /**
  32836. * Sets the current depth function to LEQUAL
  32837. */
  32838. setDepthFunctionToLessOrEqual(): void;
  32839. private _cachedStencilBuffer;
  32840. private _cachedStencilFunction;
  32841. private _cachedStencilMask;
  32842. private _cachedStencilOperationPass;
  32843. private _cachedStencilOperationFail;
  32844. private _cachedStencilOperationDepthFail;
  32845. private _cachedStencilReference;
  32846. /**
  32847. * Caches the the state of the stencil buffer
  32848. */
  32849. cacheStencilState(): void;
  32850. /**
  32851. * Restores the state of the stencil buffer
  32852. */
  32853. restoreStencilState(): void;
  32854. /**
  32855. * Directly set the WebGL Viewport
  32856. * @param x defines the x coordinate of the viewport (in screen space)
  32857. * @param y defines the y coordinate of the viewport (in screen space)
  32858. * @param width defines the width of the viewport (in screen space)
  32859. * @param height defines the height of the viewport (in screen space)
  32860. * @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
  32861. */
  32862. setDirectViewport(x: number, y: number, width: number, height: number): Nullable<IViewportLike>;
  32863. /**
  32864. * Executes a scissor clear (ie. a clear on a specific portion of the screen)
  32865. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  32866. * @param y defines the y-coordinate of the corner of the clear rectangle
  32867. * @param width defines the width of the clear rectangle
  32868. * @param height defines the height of the clear rectangle
  32869. * @param clearColor defines the clear color
  32870. */
  32871. scissorClear(x: number, y: number, width: number, height: number, clearColor: IColor4Like): void;
  32872. /**
  32873. * Enable scissor test on a specific rectangle (ie. render will only be executed on a specific portion of the screen)
  32874. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  32875. * @param y defines the y-coordinate of the corner of the clear rectangle
  32876. * @param width defines the width of the clear rectangle
  32877. * @param height defines the height of the clear rectangle
  32878. */
  32879. enableScissor(x: number, y: number, width: number, height: number): void;
  32880. /**
  32881. * Disable previously set scissor test rectangle
  32882. */
  32883. disableScissor(): void;
  32884. protected _reportDrawCall(): void;
  32885. /**
  32886. * Initializes a webVR display and starts listening to display change events
  32887. * The onVRDisplayChangedObservable will be notified upon these changes
  32888. * @returns The onVRDisplayChangedObservable
  32889. */
  32890. initWebVR(): Observable<IDisplayChangedEventArgs>;
  32891. /** @hidden */
  32892. _prepareVRComponent(): void;
  32893. /** @hidden */
  32894. _connectVREvents(canvas?: HTMLCanvasElement, document?: any): void;
  32895. /** @hidden */
  32896. _submitVRFrame(): void;
  32897. /**
  32898. * Call this function to leave webVR mode
  32899. * Will do nothing if webVR is not supported or if there is no webVR device
  32900. * @see http://doc.babylonjs.com/how_to/webvr_camera
  32901. */
  32902. disableVR(): void;
  32903. /**
  32904. * Gets a boolean indicating that the system is in VR mode and is presenting
  32905. * @returns true if VR mode is engaged
  32906. */
  32907. isVRPresenting(): boolean;
  32908. /** @hidden */
  32909. _requestVRFrame(): void;
  32910. /** @hidden */
  32911. _loadFileAsync(url: string, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  32912. /**
  32913. * Gets the source code of the vertex shader associated with a specific webGL program
  32914. * @param program defines the program to use
  32915. * @returns a string containing the source code of the vertex shader associated with the program
  32916. */
  32917. getVertexShaderSource(program: WebGLProgram): Nullable<string>;
  32918. /**
  32919. * Gets the source code of the fragment shader associated with a specific webGL program
  32920. * @param program defines the program to use
  32921. * @returns a string containing the source code of the fragment shader associated with the program
  32922. */
  32923. getFragmentShaderSource(program: WebGLProgram): Nullable<string>;
  32924. /**
  32925. * Reads pixels from the current frame buffer. Please note that this function can be slow
  32926. * @param x defines the x coordinate of the rectangle where pixels must be read
  32927. * @param y defines the y coordinate of the rectangle where pixels must be read
  32928. * @param width defines the width of the rectangle where pixels must be read
  32929. * @param height defines the height of the rectangle where pixels must be read
  32930. * @returns a Uint8Array containing RGBA colors
  32931. */
  32932. readPixels(x: number, y: number, width: number, height: number): Uint8Array;
  32933. /**
  32934. * Sets a depth stencil texture from a render target to the according uniform.
  32935. * @param channel The texture channel
  32936. * @param uniform The uniform to set
  32937. * @param texture The render target texture containing the depth stencil texture to apply
  32938. */
  32939. setDepthStencilTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<RenderTargetTexture>): void;
  32940. /**
  32941. * Sets a texture to the webGL context from a postprocess
  32942. * @param channel defines the channel to use
  32943. * @param postProcess defines the source postprocess
  32944. */
  32945. setTextureFromPostProcess(channel: number, postProcess: Nullable<PostProcess>): void;
  32946. /**
  32947. * Binds the output of the passed in post process to the texture channel specified
  32948. * @param channel The channel the texture should be bound to
  32949. * @param postProcess The post process which's output should be bound
  32950. */
  32951. setTextureFromPostProcessOutput(channel: number, postProcess: Nullable<PostProcess>): void;
  32952. /** @hidden */
  32953. _convertRGBtoRGBATextureData(rgbData: any, width: number, height: number, textureType: number): ArrayBufferView;
  32954. protected _rebuildBuffers(): void;
  32955. /** @hidden */
  32956. _renderFrame(): void;
  32957. _renderLoop(): void;
  32958. /** @hidden */
  32959. _renderViews(): boolean;
  32960. /**
  32961. * Toggle full screen mode
  32962. * @param requestPointerLock defines if a pointer lock should be requested from the user
  32963. */
  32964. switchFullscreen(requestPointerLock: boolean): void;
  32965. /**
  32966. * Enters full screen mode
  32967. * @param requestPointerLock defines if a pointer lock should be requested from the user
  32968. */
  32969. enterFullscreen(requestPointerLock: boolean): void;
  32970. /**
  32971. * Exits full screen mode
  32972. */
  32973. exitFullscreen(): void;
  32974. /**
  32975. * Enters Pointerlock mode
  32976. */
  32977. enterPointerlock(): void;
  32978. /**
  32979. * Exits Pointerlock mode
  32980. */
  32981. exitPointerlock(): void;
  32982. /**
  32983. * Begin a new frame
  32984. */
  32985. beginFrame(): void;
  32986. /**
  32987. * Enf the current frame
  32988. */
  32989. endFrame(): void;
  32990. resize(): void;
  32991. /**
  32992. * Set the compressed texture format to use, based on the formats you have, and the formats
  32993. * supported by the hardware / browser.
  32994. *
  32995. * Khronos Texture Container (.ktx) files are used to support this. This format has the
  32996. * advantage of being specifically designed for OpenGL. Header elements directly correspond
  32997. * to API arguments needed to compressed textures. This puts the burden on the container
  32998. * generator to house the arcane code for determining these for current & future formats.
  32999. *
  33000. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  33001. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  33002. *
  33003. * Note: The result of this call is not taken into account when a texture is base64.
  33004. *
  33005. * @param formatsAvailable defines the list of those format families you have created
  33006. * on your server. Syntax: '-' + format family + '.ktx'. (Case and order do not matter.)
  33007. *
  33008. * Current families are astc, dxt, pvrtc, etc2, & etc1.
  33009. * @returns The extension selected.
  33010. */
  33011. setTextureFormatToUse(formatsAvailable: Array<string>): Nullable<string>;
  33012. /**
  33013. * Force a specific size of the canvas
  33014. * @param width defines the new canvas' width
  33015. * @param height defines the new canvas' height
  33016. */
  33017. setSize(width: number, height: number): void;
  33018. /**
  33019. * Updates a dynamic vertex buffer.
  33020. * @param vertexBuffer the vertex buffer to update
  33021. * @param data the data used to update the vertex buffer
  33022. * @param byteOffset the byte offset of the data
  33023. * @param byteLength the byte length of the data
  33024. */
  33025. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  33026. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  33027. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  33028. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  33029. _releaseTexture(texture: InternalTexture): void;
  33030. /**
  33031. * @hidden
  33032. * Rescales a texture
  33033. * @param source input texutre
  33034. * @param destination destination texture
  33035. * @param scene scene to use to render the resize
  33036. * @param internalFormat format to use when resizing
  33037. * @param onComplete callback to be called when resize has completed
  33038. */
  33039. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  33040. /**
  33041. * Gets the current framerate
  33042. * @returns a number representing the framerate
  33043. */
  33044. getFps(): number;
  33045. /**
  33046. * Gets the time spent between current and previous frame
  33047. * @returns a number representing the delta time in ms
  33048. */
  33049. getDeltaTime(): number;
  33050. private _measureFps;
  33051. /** @hidden */
  33052. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement | ImageBitmap, faceIndex?: number, lod?: number): void;
  33053. /**
  33054. * Sets the frame buffer Depth / Stencil attachement of the render target to the defined depth stencil texture.
  33055. * @param renderTarget The render target to set the frame buffer for
  33056. */
  33057. setFrameBufferDepthStencilTexture(renderTarget: RenderTargetTexture): void;
  33058. /**
  33059. * Update a dynamic index buffer
  33060. * @param indexBuffer defines the target index buffer
  33061. * @param indices defines the data to update
  33062. * @param offset defines the offset in the target index buffer where update should start
  33063. */
  33064. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  33065. /**
  33066. * Updates the sample count of a render target texture
  33067. * @see http://doc.babylonjs.com/features/webgl2#multisample-render-targets
  33068. * @param texture defines the texture to update
  33069. * @param samples defines the sample count to set
  33070. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  33071. */
  33072. updateRenderTargetTextureSampleCount(texture: Nullable<InternalTexture>, samples: number): number;
  33073. /**
  33074. * Updates a depth texture Comparison Mode and Function.
  33075. * If the comparison Function is equal to 0, the mode will be set to none.
  33076. * Otherwise, this only works in webgl 2 and requires a shadow sampler in the shader.
  33077. * @param texture The texture to set the comparison function for
  33078. * @param comparisonFunction The comparison function to set, 0 if no comparison required
  33079. */
  33080. updateTextureComparisonFunction(texture: InternalTexture, comparisonFunction: number): void;
  33081. /**
  33082. * Creates a webGL buffer to use with instanciation
  33083. * @param capacity defines the size of the buffer
  33084. * @returns the webGL buffer
  33085. */
  33086. createInstancesBuffer(capacity: number): DataBuffer;
  33087. /**
  33088. * Delete a webGL buffer used with instanciation
  33089. * @param buffer defines the webGL buffer to delete
  33090. */
  33091. deleteInstancesBuffer(buffer: WebGLBuffer): void;
  33092. /** @hidden */
  33093. _readTexturePixels(texture: InternalTexture, width: number, height: number, faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): ArrayBufferView;
  33094. dispose(): void;
  33095. private _disableTouchAction;
  33096. /**
  33097. * Display the loading screen
  33098. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  33099. */
  33100. displayLoadingUI(): void;
  33101. /**
  33102. * Hide the loading screen
  33103. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  33104. */
  33105. hideLoadingUI(): void;
  33106. /**
  33107. * Gets the current loading screen object
  33108. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  33109. */
  33110. /**
  33111. * Sets the current loading screen object
  33112. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  33113. */
  33114. loadingScreen: ILoadingScreen;
  33115. /**
  33116. * Sets the current loading screen text
  33117. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  33118. */
  33119. loadingUIText: string;
  33120. /**
  33121. * Sets the current loading screen background color
  33122. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  33123. */
  33124. loadingUIBackgroundColor: string;
  33125. /** Pointerlock and fullscreen */
  33126. /**
  33127. * Ask the browser to promote the current element to pointerlock mode
  33128. * @param element defines the DOM element to promote
  33129. */
  33130. static _RequestPointerlock(element: HTMLElement): void;
  33131. /**
  33132. * Asks the browser to exit pointerlock mode
  33133. */
  33134. static _ExitPointerlock(): void;
  33135. /**
  33136. * Ask the browser to promote the current element to fullscreen rendering mode
  33137. * @param element defines the DOM element to promote
  33138. */
  33139. static _RequestFullscreen(element: HTMLElement): void;
  33140. /**
  33141. * Asks the browser to exit fullscreen mode
  33142. */
  33143. static _ExitFullscreen(): void;
  33144. }
  33145. }
  33146. declare module "babylonjs/Engines/engineStore" {
  33147. import { Nullable } from "babylonjs/types";
  33148. import { Engine } from "babylonjs/Engines/engine";
  33149. import { Scene } from "babylonjs/scene";
  33150. /**
  33151. * The engine store class is responsible to hold all the instances of Engine and Scene created
  33152. * during the life time of the application.
  33153. */
  33154. export class EngineStore {
  33155. /** Gets the list of created engines */
  33156. static Instances: import("babylonjs/Engines/engine").Engine[];
  33157. /** @hidden */
  33158. static _LastCreatedScene: Nullable<Scene>;
  33159. /**
  33160. * Gets the latest created engine
  33161. */
  33162. static readonly LastCreatedEngine: Nullable<Engine>;
  33163. /**
  33164. * Gets the latest created scene
  33165. */
  33166. static readonly LastCreatedScene: Nullable<Scene>;
  33167. /**
  33168. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  33169. * @ignorenaming
  33170. */
  33171. static UseFallbackTexture: boolean;
  33172. /**
  33173. * Texture content used if a texture cannot loaded
  33174. * @ignorenaming
  33175. */
  33176. static FallbackTexture: string;
  33177. }
  33178. }
  33179. declare module "babylonjs/Misc/promise" {
  33180. /**
  33181. * Helper class that provides a small promise polyfill
  33182. */
  33183. export class PromisePolyfill {
  33184. /**
  33185. * Static function used to check if the polyfill is required
  33186. * If this is the case then the function will inject the polyfill to window.Promise
  33187. * @param force defines a boolean used to force the injection (mostly for testing purposes)
  33188. */
  33189. static Apply(force?: boolean): void;
  33190. }
  33191. }
  33192. declare module "babylonjs/Misc/interfaces/screenshotSize" {
  33193. /**
  33194. * Interface for screenshot methods with describe argument called `size` as object with options
  33195. * @link https://doc.babylonjs.com/api/classes/babylon.screenshottools
  33196. */
  33197. export interface IScreenshotSize {
  33198. /**
  33199. * number in pixels for canvas height
  33200. */
  33201. height?: number;
  33202. /**
  33203. * multiplier allowing render at a higher or lower resolution
  33204. * If value is defined then height and width will be ignored and taken from camera
  33205. */
  33206. precision?: number;
  33207. /**
  33208. * number in pixels for canvas width
  33209. */
  33210. width?: number;
  33211. }
  33212. }
  33213. declare module "babylonjs/Misc/tools" {
  33214. import { Nullable, float } from "babylonjs/types";
  33215. import { DomManagement } from "babylonjs/Misc/domManagement";
  33216. import { WebRequest } from "babylonjs/Misc/webRequest";
  33217. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  33218. import { ReadFileError } from "babylonjs/Misc/fileTools";
  33219. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  33220. import { IScreenshotSize } from "babylonjs/Misc/interfaces/screenshotSize";
  33221. import { Camera } from "babylonjs/Cameras/camera";
  33222. import { Engine } from "babylonjs/Engines/engine";
  33223. interface IColor4Like {
  33224. r: float;
  33225. g: float;
  33226. b: float;
  33227. a: float;
  33228. }
  33229. /**
  33230. * Class containing a set of static utilities functions
  33231. */
  33232. export class Tools {
  33233. /**
  33234. * Gets or sets the base URL to use to load assets
  33235. */
  33236. static BaseUrl: string;
  33237. /**
  33238. * Enable/Disable Custom HTTP Request Headers globally.
  33239. * default = false
  33240. * @see CustomRequestHeaders
  33241. */
  33242. static UseCustomRequestHeaders: boolean;
  33243. /**
  33244. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  33245. * i.e. when loading files, where the server/service expects an Authorization header
  33246. */
  33247. static CustomRequestHeaders: {
  33248. [key: string]: string;
  33249. };
  33250. /**
  33251. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  33252. */
  33253. static DefaultRetryStrategy: (url: string, request: WebRequest, retryIndex: number) => number;
  33254. /**
  33255. * Default behaviour for cors in the application.
  33256. * It can be a string if the expected behavior is identical in the entire app.
  33257. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  33258. */
  33259. static CorsBehavior: string | ((url: string | string[]) => string);
  33260. /**
  33261. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  33262. * @ignorenaming
  33263. */
  33264. static UseFallbackTexture: boolean;
  33265. /**
  33266. * Use this object to register external classes like custom textures or material
  33267. * to allow the laoders to instantiate them
  33268. */
  33269. static RegisteredExternalClasses: {
  33270. [key: string]: Object;
  33271. };
  33272. /**
  33273. * Texture content used if a texture cannot loaded
  33274. * @ignorenaming
  33275. */
  33276. static fallbackTexture: string;
  33277. /**
  33278. * Read the content of a byte array at a specified coordinates (taking in account wrapping)
  33279. * @param u defines the coordinate on X axis
  33280. * @param v defines the coordinate on Y axis
  33281. * @param width defines the width of the source data
  33282. * @param height defines the height of the source data
  33283. * @param pixels defines the source byte array
  33284. * @param color defines the output color
  33285. */
  33286. static FetchToRef(u: number, v: number, width: number, height: number, pixels: Uint8Array, color: IColor4Like): void;
  33287. /**
  33288. * Interpolates between a and b via alpha
  33289. * @param a The lower value (returned when alpha = 0)
  33290. * @param b The upper value (returned when alpha = 1)
  33291. * @param alpha The interpolation-factor
  33292. * @return The mixed value
  33293. */
  33294. static Mix(a: number, b: number, alpha: number): number;
  33295. /**
  33296. * Tries to instantiate a new object from a given class name
  33297. * @param className defines the class name to instantiate
  33298. * @returns the new object or null if the system was not able to do the instantiation
  33299. */
  33300. static Instantiate(className: string): any;
  33301. /**
  33302. * Provides a slice function that will work even on IE
  33303. * @param data defines the array to slice
  33304. * @param start defines the start of the data (optional)
  33305. * @param end defines the end of the data (optional)
  33306. * @returns the new sliced array
  33307. */
  33308. static Slice<T>(data: T, start?: number, end?: number): T;
  33309. /**
  33310. * Polyfill for setImmediate
  33311. * @param action defines the action to execute after the current execution block
  33312. */
  33313. static SetImmediate(action: () => void): void;
  33314. /**
  33315. * Function indicating if a number is an exponent of 2
  33316. * @param value defines the value to test
  33317. * @returns true if the value is an exponent of 2
  33318. */
  33319. static IsExponentOfTwo(value: number): boolean;
  33320. private static _tmpFloatArray;
  33321. /**
  33322. * Returns the nearest 32-bit single precision float representation of a Number
  33323. * @param value A Number. If the parameter is of a different type, it will get converted
  33324. * to a number or to NaN if it cannot be converted
  33325. * @returns number
  33326. */
  33327. static FloatRound(value: number): number;
  33328. /**
  33329. * Extracts the filename from a path
  33330. * @param path defines the path to use
  33331. * @returns the filename
  33332. */
  33333. static GetFilename(path: string): string;
  33334. /**
  33335. * Extracts the "folder" part of a path (everything before the filename).
  33336. * @param uri The URI to extract the info from
  33337. * @param returnUnchangedIfNoSlash Do not touch the URI if no slashes are present
  33338. * @returns The "folder" part of the path
  33339. */
  33340. static GetFolderPath(uri: string, returnUnchangedIfNoSlash?: boolean): string;
  33341. /**
  33342. * Extracts text content from a DOM element hierarchy
  33343. * Back Compat only, please use DomManagement.GetDOMTextContent instead.
  33344. */
  33345. static GetDOMTextContent: typeof DomManagement.GetDOMTextContent;
  33346. /**
  33347. * Convert an angle in radians to degrees
  33348. * @param angle defines the angle to convert
  33349. * @returns the angle in degrees
  33350. */
  33351. static ToDegrees(angle: number): number;
  33352. /**
  33353. * Convert an angle in degrees to radians
  33354. * @param angle defines the angle to convert
  33355. * @returns the angle in radians
  33356. */
  33357. static ToRadians(angle: number): number;
  33358. /**
  33359. * Returns an array if obj is not an array
  33360. * @param obj defines the object to evaluate as an array
  33361. * @param allowsNullUndefined defines a boolean indicating if obj is allowed to be null or undefined
  33362. * @returns either obj directly if obj is an array or a new array containing obj
  33363. */
  33364. static MakeArray(obj: any, allowsNullUndefined?: boolean): Nullable<Array<any>>;
  33365. /**
  33366. * Gets the pointer prefix to use
  33367. * @returns "pointer" if touch is enabled. Else returns "mouse"
  33368. */
  33369. static GetPointerPrefix(): string;
  33370. /**
  33371. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  33372. * @param url define the url we are trying
  33373. * @param element define the dom element where to configure the cors policy
  33374. */
  33375. static SetCorsBehavior(url: string | string[], element: {
  33376. crossOrigin: string | null;
  33377. }): void;
  33378. /**
  33379. * Removes unwanted characters from an url
  33380. * @param url defines the url to clean
  33381. * @returns the cleaned url
  33382. */
  33383. static CleanUrl(url: string): string;
  33384. /**
  33385. * Gets or sets a function used to pre-process url before using them to load assets
  33386. */
  33387. static PreprocessUrl: (url: string) => string;
  33388. /**
  33389. * Loads an image as an HTMLImageElement.
  33390. * @param input url string, ArrayBuffer, or Blob to load
  33391. * @param onLoad callback called when the image successfully loads
  33392. * @param onError callback called when the image fails to load
  33393. * @param offlineProvider offline provider for caching
  33394. * @param mimeType optional mime type
  33395. * @returns the HTMLImageElement of the loaded image
  33396. */
  33397. static LoadImage(input: string | ArrayBuffer | Blob, onLoad: (img: HTMLImageElement | ImageBitmap) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>, mimeType?: string): Nullable<HTMLImageElement>;
  33398. /**
  33399. * Loads a file from a url
  33400. * @param url url string, ArrayBuffer, or Blob to load
  33401. * @param onSuccess callback called when the file successfully loads
  33402. * @param onProgress callback called while file is loading (if the server supports this mode)
  33403. * @param offlineProvider defines the offline provider for caching
  33404. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  33405. * @param onError callback called when the file fails to load
  33406. * @returns a file request object
  33407. */
  33408. 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;
  33409. /**
  33410. * Loads a file from a url
  33411. * @param url the file url to load
  33412. * @returns a promise containing an ArrayBuffer corrisponding to the loaded file
  33413. */
  33414. static LoadFileAsync(url: string): Promise<ArrayBuffer>;
  33415. /**
  33416. * Load a script (identified by an url). When the url returns, the
  33417. * content of this file is added into a new script element, attached to the DOM (body element)
  33418. * @param scriptUrl defines the url of the script to laod
  33419. * @param onSuccess defines the callback called when the script is loaded
  33420. * @param onError defines the callback to call if an error occurs
  33421. * @param scriptId defines the id of the script element
  33422. */
  33423. static LoadScript(scriptUrl: string, onSuccess: () => void, onError?: (message?: string, exception?: any) => void, scriptId?: string): void;
  33424. /**
  33425. * Load an asynchronous script (identified by an url). When the url returns, the
  33426. * content of this file is added into a new script element, attached to the DOM (body element)
  33427. * @param scriptUrl defines the url of the script to laod
  33428. * @param scriptId defines the id of the script element
  33429. * @returns a promise request object
  33430. */
  33431. static LoadScriptAsync(scriptUrl: string, scriptId?: string): Promise<boolean>;
  33432. /**
  33433. * Loads a file from a blob
  33434. * @param fileToLoad defines the blob to use
  33435. * @param callback defines the callback to call when data is loaded
  33436. * @param progressCallback defines the callback to call during loading process
  33437. * @returns a file request object
  33438. */
  33439. static ReadFileAsDataURL(fileToLoad: Blob, callback: (data: any) => void, progressCallback: (ev: ProgressEvent) => any): IFileRequest;
  33440. /**
  33441. * Reads a file from a File object
  33442. * @param file defines the file to load
  33443. * @param onSuccess defines the callback to call when data is loaded
  33444. * @param onProgress defines the callback to call during loading process
  33445. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  33446. * @param onError defines the callback to call when an error occurs
  33447. * @returns a file request object
  33448. */
  33449. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  33450. /**
  33451. * Creates a data url from a given string content
  33452. * @param content defines the content to convert
  33453. * @returns the new data url link
  33454. */
  33455. static FileAsURL(content: string): string;
  33456. /**
  33457. * Format the given number to a specific decimal format
  33458. * @param value defines the number to format
  33459. * @param decimals defines the number of decimals to use
  33460. * @returns the formatted string
  33461. */
  33462. static Format(value: number, decimals?: number): string;
  33463. /**
  33464. * Tries to copy an object by duplicating every property
  33465. * @param source defines the source object
  33466. * @param destination defines the target object
  33467. * @param doNotCopyList defines a list of properties to avoid
  33468. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  33469. */
  33470. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  33471. /**
  33472. * Gets a boolean indicating if the given object has no own property
  33473. * @param obj defines the object to test
  33474. * @returns true if object has no own property
  33475. */
  33476. static IsEmpty(obj: any): boolean;
  33477. /**
  33478. * Function used to register events at window level
  33479. * @param windowElement defines the Window object to use
  33480. * @param events defines the events to register
  33481. */
  33482. static RegisterTopRootEvents(windowElement: Window, events: {
  33483. name: string;
  33484. handler: Nullable<(e: FocusEvent) => any>;
  33485. }[]): void;
  33486. /**
  33487. * Function used to unregister events from window level
  33488. * @param windowElement defines the Window object to use
  33489. * @param events defines the events to unregister
  33490. */
  33491. static UnregisterTopRootEvents(windowElement: Window, events: {
  33492. name: string;
  33493. handler: Nullable<(e: FocusEvent) => any>;
  33494. }[]): void;
  33495. /**
  33496. * @ignore
  33497. */
  33498. static _ScreenshotCanvas: HTMLCanvasElement;
  33499. /**
  33500. * Dumps the current bound framebuffer
  33501. * @param width defines the rendering width
  33502. * @param height defines the rendering height
  33503. * @param engine defines the hosting engine
  33504. * @param successCallback defines the callback triggered once the data are available
  33505. * @param mimeType defines the mime type of the result
  33506. * @param fileName defines the filename to download. If present, the result will automatically be downloaded
  33507. */
  33508. static DumpFramebuffer(width: number, height: number, engine: Engine, successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  33509. /**
  33510. * Converts the canvas data to blob.
  33511. * This acts as a polyfill for browsers not supporting the to blob function.
  33512. * @param canvas Defines the canvas to extract the data from
  33513. * @param successCallback Defines the callback triggered once the data are available
  33514. * @param mimeType Defines the mime type of the result
  33515. */
  33516. static ToBlob(canvas: HTMLCanvasElement, successCallback: (blob: Nullable<Blob>) => void, mimeType?: string): void;
  33517. /**
  33518. * Encodes the canvas data to base 64 or automatically download the result if filename is defined
  33519. * @param successCallback defines the callback triggered once the data are available
  33520. * @param mimeType defines the mime type of the result
  33521. * @param fileName defines he filename to download. If present, the result will automatically be downloaded
  33522. */
  33523. static EncodeScreenshotCanvasData(successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  33524. /**
  33525. * Downloads a blob in the browser
  33526. * @param blob defines the blob to download
  33527. * @param fileName defines the name of the downloaded file
  33528. */
  33529. static Download(blob: Blob, fileName: string): void;
  33530. /**
  33531. * Captures a screenshot of the current rendering
  33532. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  33533. * @param engine defines the rendering engine
  33534. * @param camera defines the source camera
  33535. * @param size This parameter can be set to a single number or to an object with the
  33536. * following (optional) properties: precision, width, height. If a single number is passed,
  33537. * it will be used for both width and height. If an object is passed, the screenshot size
  33538. * will be derived from the parameters. The precision property is a multiplier allowing
  33539. * rendering at a higher or lower resolution
  33540. * @param successCallback defines the callback receives a single parameter which contains the
  33541. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  33542. * src parameter of an <img> to display it
  33543. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  33544. * Check your browser for supported MIME types
  33545. */
  33546. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  33547. /**
  33548. * Captures a screenshot of the current rendering
  33549. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  33550. * @param engine defines the rendering engine
  33551. * @param camera defines the source camera
  33552. * @param size This parameter can be set to a single number or to an object with the
  33553. * following (optional) properties: precision, width, height. If a single number is passed,
  33554. * it will be used for both width and height. If an object is passed, the screenshot size
  33555. * will be derived from the parameters. The precision property is a multiplier allowing
  33556. * rendering at a higher or lower resolution
  33557. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  33558. * Check your browser for supported MIME types
  33559. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  33560. * to the src parameter of an <img> to display it
  33561. */
  33562. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string): Promise<string>;
  33563. /**
  33564. * Generates an image screenshot from the specified camera.
  33565. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  33566. * @param engine The engine to use for rendering
  33567. * @param camera The camera to use for rendering
  33568. * @param size This parameter can be set to a single number or to an object with the
  33569. * following (optional) properties: precision, width, height. If a single number is passed,
  33570. * it will be used for both width and height. If an object is passed, the screenshot size
  33571. * will be derived from the parameters. The precision property is a multiplier allowing
  33572. * rendering at a higher or lower resolution
  33573. * @param successCallback The callback receives a single parameter which contains the
  33574. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  33575. * src parameter of an <img> to display it
  33576. * @param mimeType The MIME type of the screenshot image (default: image/png).
  33577. * Check your browser for supported MIME types
  33578. * @param samples Texture samples (default: 1)
  33579. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  33580. * @param fileName A name for for the downloaded file.
  33581. */
  33582. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): void;
  33583. /**
  33584. * Generates an image screenshot from the specified camera.
  33585. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  33586. * @param engine The engine to use for rendering
  33587. * @param camera The camera to use for rendering
  33588. * @param size This parameter can be set to a single number or to an object with the
  33589. * following (optional) properties: precision, width, height. If a single number is passed,
  33590. * it will be used for both width and height. If an object is passed, the screenshot size
  33591. * will be derived from the parameters. The precision property is a multiplier allowing
  33592. * rendering at a higher or lower resolution
  33593. * @param mimeType The MIME type of the screenshot image (default: image/png).
  33594. * Check your browser for supported MIME types
  33595. * @param samples Texture samples (default: 1)
  33596. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  33597. * @param fileName A name for for the downloaded file.
  33598. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  33599. * to the src parameter of an <img> to display it
  33600. */
  33601. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): Promise<string>;
  33602. /**
  33603. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  33604. * Be aware Math.random() could cause collisions, but:
  33605. * "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"
  33606. * @returns a pseudo random id
  33607. */
  33608. static RandomId(): string;
  33609. /**
  33610. * Test if the given uri is a base64 string
  33611. * @param uri The uri to test
  33612. * @return True if the uri is a base64 string or false otherwise
  33613. */
  33614. static IsBase64(uri: string): boolean;
  33615. /**
  33616. * Decode the given base64 uri.
  33617. * @param uri The uri to decode
  33618. * @return The decoded base64 data.
  33619. */
  33620. static DecodeBase64(uri: string): ArrayBuffer;
  33621. /**
  33622. * Gets the absolute url.
  33623. * @param url the input url
  33624. * @return the absolute url
  33625. */
  33626. static GetAbsoluteUrl(url: string): string;
  33627. /**
  33628. * No log
  33629. */
  33630. static readonly NoneLogLevel: number;
  33631. /**
  33632. * Only message logs
  33633. */
  33634. static readonly MessageLogLevel: number;
  33635. /**
  33636. * Only warning logs
  33637. */
  33638. static readonly WarningLogLevel: number;
  33639. /**
  33640. * Only error logs
  33641. */
  33642. static readonly ErrorLogLevel: number;
  33643. /**
  33644. * All logs
  33645. */
  33646. static readonly AllLogLevel: number;
  33647. /**
  33648. * Gets a value indicating the number of loading errors
  33649. * @ignorenaming
  33650. */
  33651. static readonly errorsCount: number;
  33652. /**
  33653. * Callback called when a new log is added
  33654. */
  33655. static OnNewCacheEntry: (entry: string) => void;
  33656. /**
  33657. * Log a message to the console
  33658. * @param message defines the message to log
  33659. */
  33660. static Log(message: string): void;
  33661. /**
  33662. * Write a warning message to the console
  33663. * @param message defines the message to log
  33664. */
  33665. static Warn(message: string): void;
  33666. /**
  33667. * Write an error message to the console
  33668. * @param message defines the message to log
  33669. */
  33670. static Error(message: string): void;
  33671. /**
  33672. * Gets current log cache (list of logs)
  33673. */
  33674. static readonly LogCache: string;
  33675. /**
  33676. * Clears the log cache
  33677. */
  33678. static ClearLogCache(): void;
  33679. /**
  33680. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  33681. */
  33682. static LogLevels: number;
  33683. /**
  33684. * Checks if the window object exists
  33685. * Back Compat only, please use DomManagement.IsWindowObjectExist instead.
  33686. */
  33687. static IsWindowObjectExist: typeof DomManagement.IsWindowObjectExist;
  33688. /**
  33689. * No performance log
  33690. */
  33691. static readonly PerformanceNoneLogLevel: number;
  33692. /**
  33693. * Use user marks to log performance
  33694. */
  33695. static readonly PerformanceUserMarkLogLevel: number;
  33696. /**
  33697. * Log performance to the console
  33698. */
  33699. static readonly PerformanceConsoleLogLevel: number;
  33700. private static _performance;
  33701. /**
  33702. * Sets the current performance log level
  33703. */
  33704. static PerformanceLogLevel: number;
  33705. private static _StartPerformanceCounterDisabled;
  33706. private static _EndPerformanceCounterDisabled;
  33707. private static _StartUserMark;
  33708. private static _EndUserMark;
  33709. private static _StartPerformanceConsole;
  33710. private static _EndPerformanceConsole;
  33711. /**
  33712. * Starts a performance counter
  33713. */
  33714. static StartPerformanceCounter: (counterName: string, condition?: boolean) => void;
  33715. /**
  33716. * Ends a specific performance coutner
  33717. */
  33718. static EndPerformanceCounter: (counterName: string, condition?: boolean) => void;
  33719. /**
  33720. * Gets either window.performance.now() if supported or Date.now() else
  33721. */
  33722. static readonly Now: number;
  33723. /**
  33724. * This method will return the name of the class used to create the instance of the given object.
  33725. * It will works only on Javascript basic data types (number, string, ...) and instance of class declared with the @className decorator.
  33726. * @param object the object to get the class name from
  33727. * @param isType defines if the object is actually a type
  33728. * @returns the name of the class, will be "object" for a custom data type not using the @className decorator
  33729. */
  33730. static GetClassName(object: any, isType?: boolean): string;
  33731. /**
  33732. * Gets the first element of an array satisfying a given predicate
  33733. * @param array defines the array to browse
  33734. * @param predicate defines the predicate to use
  33735. * @returns null if not found or the element
  33736. */
  33737. static First<T>(array: Array<T>, predicate: (item: T) => boolean): Nullable<T>;
  33738. /**
  33739. * This method will return the name of the full name of the class, including its owning module (if any).
  33740. * 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).
  33741. * @param object the object to get the class name from
  33742. * @param isType defines if the object is actually a type
  33743. * @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.
  33744. * @ignorenaming
  33745. */
  33746. static getFullClassName(object: any, isType?: boolean): Nullable<string>;
  33747. /**
  33748. * Returns a promise that resolves after the given amount of time.
  33749. * @param delay Number of milliseconds to delay
  33750. * @returns Promise that resolves after the given amount of time
  33751. */
  33752. static DelayAsync(delay: number): Promise<void>;
  33753. }
  33754. /**
  33755. * Use this className as a decorator on a given class definition to add it a name and optionally its module.
  33756. * You can then use the Tools.getClassName(obj) on an instance to retrieve its class name.
  33757. * This method is the only way to get it done in all cases, even if the .js file declaring the class is minified
  33758. * @param name The name of the class, case should be preserved
  33759. * @param module The name of the Module hosting the class, optional, but strongly recommended to specify if possible. Case should be preserved.
  33760. */
  33761. export function className(name: string, module?: string): (target: Object) => void;
  33762. /**
  33763. * An implementation of a loop for asynchronous functions.
  33764. */
  33765. export class AsyncLoop {
  33766. /**
  33767. * Defines the number of iterations for the loop
  33768. */
  33769. iterations: number;
  33770. /**
  33771. * Defines the current index of the loop.
  33772. */
  33773. index: number;
  33774. private _done;
  33775. private _fn;
  33776. private _successCallback;
  33777. /**
  33778. * Constructor.
  33779. * @param iterations the number of iterations.
  33780. * @param func the function to run each iteration
  33781. * @param successCallback the callback that will be called upon succesful execution
  33782. * @param offset starting offset.
  33783. */
  33784. constructor(
  33785. /**
  33786. * Defines the number of iterations for the loop
  33787. */
  33788. iterations: number, func: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number);
  33789. /**
  33790. * Execute the next iteration. Must be called after the last iteration was finished.
  33791. */
  33792. executeNext(): void;
  33793. /**
  33794. * Break the loop and run the success callback.
  33795. */
  33796. breakLoop(): void;
  33797. /**
  33798. * Create and run an async loop.
  33799. * @param iterations the number of iterations.
  33800. * @param fn the function to run each iteration
  33801. * @param successCallback the callback that will be called upon succesful execution
  33802. * @param offset starting offset.
  33803. * @returns the created async loop object
  33804. */
  33805. static Run(iterations: number, fn: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number): AsyncLoop;
  33806. /**
  33807. * A for-loop that will run a given number of iterations synchronous and the rest async.
  33808. * @param iterations total number of iterations
  33809. * @param syncedIterations number of synchronous iterations in each async iteration.
  33810. * @param fn the function to call each iteration.
  33811. * @param callback a success call back that will be called when iterating stops.
  33812. * @param breakFunction a break condition (optional)
  33813. * @param timeout timeout settings for the setTimeout function. default - 0.
  33814. * @returns the created async loop object
  33815. */
  33816. static SyncAsyncForLoop(iterations: number, syncedIterations: number, fn: (iteration: number) => void, callback: () => void, breakFunction?: () => boolean, timeout?: number): AsyncLoop;
  33817. }
  33818. }
  33819. declare module "babylonjs/Misc/stringDictionary" {
  33820. import { Nullable } from "babylonjs/types";
  33821. /**
  33822. * This class implement a typical dictionary using a string as key and the generic type T as value.
  33823. * The underlying implementation relies on an associative array to ensure the best performances.
  33824. * The value can be anything including 'null' but except 'undefined'
  33825. */
  33826. export class StringDictionary<T> {
  33827. /**
  33828. * This will clear this dictionary and copy the content from the 'source' one.
  33829. * If the T value is a custom object, it won't be copied/cloned, the same object will be used
  33830. * @param source the dictionary to take the content from and copy to this dictionary
  33831. */
  33832. copyFrom(source: StringDictionary<T>): void;
  33833. /**
  33834. * Get a value based from its key
  33835. * @param key the given key to get the matching value from
  33836. * @return the value if found, otherwise undefined is returned
  33837. */
  33838. get(key: string): T | undefined;
  33839. /**
  33840. * Get a value from its key or add it if it doesn't exist.
  33841. * This method will ensure you that a given key/data will be present in the dictionary.
  33842. * @param key the given key to get the matching value from
  33843. * @param factory the factory that will create the value if the key is not present in the dictionary.
  33844. * The factory will only be invoked if there's no data for the given key.
  33845. * @return the value corresponding to the key.
  33846. */
  33847. getOrAddWithFactory(key: string, factory: (key: string) => T): T;
  33848. /**
  33849. * Get a value from its key if present in the dictionary otherwise add it
  33850. * @param key the key to get the value from
  33851. * @param val if there's no such key/value pair in the dictionary add it with this value
  33852. * @return the value corresponding to the key
  33853. */
  33854. getOrAdd(key: string, val: T): T;
  33855. /**
  33856. * Check if there's a given key in the dictionary
  33857. * @param key the key to check for
  33858. * @return true if the key is present, false otherwise
  33859. */
  33860. contains(key: string): boolean;
  33861. /**
  33862. * Add a new key and its corresponding value
  33863. * @param key the key to add
  33864. * @param value the value corresponding to the key
  33865. * @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
  33866. */
  33867. add(key: string, value: T): boolean;
  33868. /**
  33869. * Update a specific value associated to a key
  33870. * @param key defines the key to use
  33871. * @param value defines the value to store
  33872. * @returns true if the value was updated (or false if the key was not found)
  33873. */
  33874. set(key: string, value: T): boolean;
  33875. /**
  33876. * Get the element of the given key and remove it from the dictionary
  33877. * @param key defines the key to search
  33878. * @returns the value associated with the key or null if not found
  33879. */
  33880. getAndRemove(key: string): Nullable<T>;
  33881. /**
  33882. * Remove a key/value from the dictionary.
  33883. * @param key the key to remove
  33884. * @return true if the item was successfully deleted, false if no item with such key exist in the dictionary
  33885. */
  33886. remove(key: string): boolean;
  33887. /**
  33888. * Clear the whole content of the dictionary
  33889. */
  33890. clear(): void;
  33891. /**
  33892. * Gets the current count
  33893. */
  33894. readonly count: number;
  33895. /**
  33896. * Execute a callback on each key/val of the dictionary.
  33897. * Note that you can remove any element in this dictionary in the callback implementation
  33898. * @param callback the callback to execute on a given key/value pair
  33899. */
  33900. forEach(callback: (key: string, val: T) => void): void;
  33901. /**
  33902. * Execute a callback on every occurrence of the dictionary until it returns a valid TRes object.
  33903. * If the callback returns null or undefined the method will iterate to the next key/value pair
  33904. * Note that you can remove any element in this dictionary in the callback implementation
  33905. * @param callback the callback to execute, if it return a valid T instanced object the enumeration will stop and the object will be returned
  33906. * @returns the first item
  33907. */
  33908. first<TRes>(callback: (key: string, val: T) => TRes): TRes | null;
  33909. private _count;
  33910. private _data;
  33911. }
  33912. }
  33913. declare module "babylonjs/Collisions/collisionCoordinator" {
  33914. import { Nullable } from "babylonjs/types";
  33915. import { Scene } from "babylonjs/scene";
  33916. import { Vector3 } from "babylonjs/Maths/math.vector";
  33917. import { Collider } from "babylonjs/Collisions/collider";
  33918. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  33919. /** @hidden */
  33920. export interface ICollisionCoordinator {
  33921. createCollider(): Collider;
  33922. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: Nullable<AbstractMesh>, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  33923. init(scene: Scene): void;
  33924. }
  33925. /** @hidden */
  33926. export class DefaultCollisionCoordinator implements ICollisionCoordinator {
  33927. private _scene;
  33928. private _scaledPosition;
  33929. private _scaledVelocity;
  33930. private _finalPosition;
  33931. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: AbstractMesh, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  33932. createCollider(): Collider;
  33933. init(scene: Scene): void;
  33934. private _collideWithWorld;
  33935. }
  33936. }
  33937. declare module "babylonjs/Inputs/scene.inputManager" {
  33938. import { Nullable } from "babylonjs/types";
  33939. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  33940. import { Vector2 } from "babylonjs/Maths/math.vector";
  33941. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  33942. import { Scene } from "babylonjs/scene";
  33943. /**
  33944. * Class used to manage all inputs for the scene.
  33945. */
  33946. export class InputManager {
  33947. /** The distance in pixel that you have to move to prevent some events */
  33948. static DragMovementThreshold: number;
  33949. /** Time in milliseconds to wait to raise long press events if button is still pressed */
  33950. static LongPressDelay: number;
  33951. /** Time in milliseconds with two consecutive clicks will be considered as a double click */
  33952. static DoubleClickDelay: number;
  33953. /** If you need to check double click without raising a single click at first click, enable this flag */
  33954. static ExclusiveDoubleClickMode: boolean;
  33955. private _wheelEventName;
  33956. private _onPointerMove;
  33957. private _onPointerDown;
  33958. private _onPointerUp;
  33959. private _initClickEvent;
  33960. private _initActionManager;
  33961. private _delayedSimpleClick;
  33962. private _delayedSimpleClickTimeout;
  33963. private _previousDelayedSimpleClickTimeout;
  33964. private _meshPickProceed;
  33965. private _previousButtonPressed;
  33966. private _currentPickResult;
  33967. private _previousPickResult;
  33968. private _totalPointersPressed;
  33969. private _doubleClickOccured;
  33970. private _pointerOverMesh;
  33971. private _pickedDownMesh;
  33972. private _pickedUpMesh;
  33973. private _pointerX;
  33974. private _pointerY;
  33975. private _unTranslatedPointerX;
  33976. private _unTranslatedPointerY;
  33977. private _startingPointerPosition;
  33978. private _previousStartingPointerPosition;
  33979. private _startingPointerTime;
  33980. private _previousStartingPointerTime;
  33981. private _pointerCaptures;
  33982. private _onKeyDown;
  33983. private _onKeyUp;
  33984. private _onCanvasFocusObserver;
  33985. private _onCanvasBlurObserver;
  33986. private _scene;
  33987. /**
  33988. * Creates a new InputManager
  33989. * @param scene defines the hosting scene
  33990. */
  33991. constructor(scene: Scene);
  33992. /**
  33993. * Gets the mesh that is currently under the pointer
  33994. */
  33995. readonly meshUnderPointer: Nullable<AbstractMesh>;
  33996. /**
  33997. * Gets the pointer coordinates in 2D without any translation (ie. straight out of the pointer event)
  33998. */
  33999. readonly unTranslatedPointer: Vector2;
  34000. /**
  34001. * Gets or sets the current on-screen X position of the pointer
  34002. */
  34003. pointerX: number;
  34004. /**
  34005. * Gets or sets the current on-screen Y position of the pointer
  34006. */
  34007. pointerY: number;
  34008. private _updatePointerPosition;
  34009. private _processPointerMove;
  34010. private _setRayOnPointerInfo;
  34011. private _checkPrePointerObservable;
  34012. /**
  34013. * Use this method to simulate a pointer move on a mesh
  34014. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  34015. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  34016. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  34017. */
  34018. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  34019. /**
  34020. * Use this method to simulate a pointer down on a mesh
  34021. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  34022. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  34023. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  34024. */
  34025. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  34026. private _processPointerDown;
  34027. /** @hidden */
  34028. _isPointerSwiping(): boolean;
  34029. /**
  34030. * Use this method to simulate a pointer up on a mesh
  34031. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  34032. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  34033. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  34034. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  34035. */
  34036. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): void;
  34037. private _processPointerUp;
  34038. /**
  34039. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  34040. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  34041. * @returns true if the pointer was captured
  34042. */
  34043. isPointerCaptured(pointerId?: number): boolean;
  34044. /**
  34045. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  34046. * @param attachUp defines if you want to attach events to pointerup
  34047. * @param attachDown defines if you want to attach events to pointerdown
  34048. * @param attachMove defines if you want to attach events to pointermove
  34049. */
  34050. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean): void;
  34051. /**
  34052. * Detaches all event handlers
  34053. */
  34054. detachControl(): void;
  34055. /**
  34056. * Force the value of meshUnderPointer
  34057. * @param mesh defines the mesh to use
  34058. */
  34059. setPointerOverMesh(mesh: Nullable<AbstractMesh>): void;
  34060. /**
  34061. * Gets the mesh under the pointer
  34062. * @returns a Mesh or null if no mesh is under the pointer
  34063. */
  34064. getPointerOverMesh(): Nullable<AbstractMesh>;
  34065. }
  34066. }
  34067. declare module "babylonjs/Misc/uniqueIdGenerator" {
  34068. /**
  34069. * Helper class used to generate session unique ID
  34070. */
  34071. export class UniqueIdGenerator {
  34072. private static _UniqueIdCounter;
  34073. /**
  34074. * Gets an unique (relatively to the current scene) Id
  34075. */
  34076. static readonly UniqueId: number;
  34077. }
  34078. }
  34079. declare module "babylonjs/Animations/animationGroup" {
  34080. import { Animatable } from "babylonjs/Animations/animatable";
  34081. import { Animation } from "babylonjs/Animations/animation";
  34082. import { Scene, IDisposable } from "babylonjs/scene";
  34083. import { Observable } from "babylonjs/Misc/observable";
  34084. import { Nullable } from "babylonjs/types";
  34085. import "babylonjs/Animations/animatable";
  34086. /**
  34087. * This class defines the direct association between an animation and a target
  34088. */
  34089. export class TargetedAnimation {
  34090. /**
  34091. * Animation to perform
  34092. */
  34093. animation: Animation;
  34094. /**
  34095. * Target to animate
  34096. */
  34097. target: any;
  34098. /**
  34099. * Serialize the object
  34100. * @returns the JSON object representing the current entity
  34101. */
  34102. serialize(): any;
  34103. }
  34104. /**
  34105. * Use this class to create coordinated animations on multiple targets
  34106. */
  34107. export class AnimationGroup implements IDisposable {
  34108. /** The name of the animation group */
  34109. name: string;
  34110. private _scene;
  34111. private _targetedAnimations;
  34112. private _animatables;
  34113. private _from;
  34114. private _to;
  34115. private _isStarted;
  34116. private _isPaused;
  34117. private _speedRatio;
  34118. private _loopAnimation;
  34119. /**
  34120. * Gets or sets the unique id of the node
  34121. */
  34122. uniqueId: number;
  34123. /**
  34124. * This observable will notify when one animation have ended
  34125. */
  34126. onAnimationEndObservable: Observable<TargetedAnimation>;
  34127. /**
  34128. * Observer raised when one animation loops
  34129. */
  34130. onAnimationLoopObservable: Observable<TargetedAnimation>;
  34131. /**
  34132. * Observer raised when all animations have looped
  34133. */
  34134. onAnimationGroupLoopObservable: Observable<AnimationGroup>;
  34135. /**
  34136. * This observable will notify when all animations have ended.
  34137. */
  34138. onAnimationGroupEndObservable: Observable<AnimationGroup>;
  34139. /**
  34140. * This observable will notify when all animations have paused.
  34141. */
  34142. onAnimationGroupPauseObservable: Observable<AnimationGroup>;
  34143. /**
  34144. * This observable will notify when all animations are playing.
  34145. */
  34146. onAnimationGroupPlayObservable: Observable<AnimationGroup>;
  34147. /**
  34148. * Gets the first frame
  34149. */
  34150. readonly from: number;
  34151. /**
  34152. * Gets the last frame
  34153. */
  34154. readonly to: number;
  34155. /**
  34156. * Define if the animations are started
  34157. */
  34158. readonly isStarted: boolean;
  34159. /**
  34160. * Gets a value indicating that the current group is playing
  34161. */
  34162. readonly isPlaying: boolean;
  34163. /**
  34164. * Gets or sets the speed ratio to use for all animations
  34165. */
  34166. /**
  34167. * Gets or sets the speed ratio to use for all animations
  34168. */
  34169. speedRatio: number;
  34170. /**
  34171. * Gets or sets if all animations should loop or not
  34172. */
  34173. loopAnimation: boolean;
  34174. /**
  34175. * Gets the targeted animations for this animation group
  34176. */
  34177. readonly targetedAnimations: Array<TargetedAnimation>;
  34178. /**
  34179. * returning the list of animatables controlled by this animation group.
  34180. */
  34181. readonly animatables: Array<Animatable>;
  34182. /**
  34183. * Instantiates a new Animation Group.
  34184. * This helps managing several animations at once.
  34185. * @see http://doc.babylonjs.com/how_to/group
  34186. * @param name Defines the name of the group
  34187. * @param scene Defines the scene the group belongs to
  34188. */
  34189. constructor(
  34190. /** The name of the animation group */
  34191. name: string, scene?: Nullable<Scene>);
  34192. /**
  34193. * Add an animation (with its target) in the group
  34194. * @param animation defines the animation we want to add
  34195. * @param target defines the target of the animation
  34196. * @returns the TargetedAnimation object
  34197. */
  34198. addTargetedAnimation(animation: Animation, target: any): TargetedAnimation;
  34199. /**
  34200. * This function will normalize every animation in the group to make sure they all go from beginFrame to endFrame
  34201. * It can add constant keys at begin or end
  34202. * @param beginFrame defines the new begin frame for all animations or the smallest begin frame of all animations if null (defaults to null)
  34203. * @param endFrame defines the new end frame for all animations or the largest end frame of all animations if null (defaults to null)
  34204. * @returns the animation group
  34205. */
  34206. normalize(beginFrame?: Nullable<number>, endFrame?: Nullable<number>): AnimationGroup;
  34207. private _animationLoopCount;
  34208. private _animationLoopFlags;
  34209. private _processLoop;
  34210. /**
  34211. * Start all animations on given targets
  34212. * @param loop defines if animations must loop
  34213. * @param speedRatio defines the ratio to apply to animation speed (1 by default)
  34214. * @param from defines the from key (optional)
  34215. * @param to defines the to key (optional)
  34216. * @returns the current animation group
  34217. */
  34218. start(loop?: boolean, speedRatio?: number, from?: number, to?: number): AnimationGroup;
  34219. /**
  34220. * Pause all animations
  34221. * @returns the animation group
  34222. */
  34223. pause(): AnimationGroup;
  34224. /**
  34225. * Play all animations to initial state
  34226. * This function will start() the animations if they were not started or will restart() them if they were paused
  34227. * @param loop defines if animations must loop
  34228. * @returns the animation group
  34229. */
  34230. play(loop?: boolean): AnimationGroup;
  34231. /**
  34232. * Reset all animations to initial state
  34233. * @returns the animation group
  34234. */
  34235. reset(): AnimationGroup;
  34236. /**
  34237. * Restart animations from key 0
  34238. * @returns the animation group
  34239. */
  34240. restart(): AnimationGroup;
  34241. /**
  34242. * Stop all animations
  34243. * @returns the animation group
  34244. */
  34245. stop(): AnimationGroup;
  34246. /**
  34247. * Set animation weight for all animatables
  34248. * @param weight defines the weight to use
  34249. * @return the animationGroup
  34250. * @see http://doc.babylonjs.com/babylon101/animations#animation-weights
  34251. */
  34252. setWeightForAllAnimatables(weight: number): AnimationGroup;
  34253. /**
  34254. * Synchronize and normalize all animatables with a source animatable
  34255. * @param root defines the root animatable to synchronize with
  34256. * @return the animationGroup
  34257. * @see http://doc.babylonjs.com/babylon101/animations#animation-weights
  34258. */
  34259. syncAllAnimationsWith(root: Animatable): AnimationGroup;
  34260. /**
  34261. * Goes to a specific frame in this animation group
  34262. * @param frame the frame number to go to
  34263. * @return the animationGroup
  34264. */
  34265. goToFrame(frame: number): AnimationGroup;
  34266. /**
  34267. * Dispose all associated resources
  34268. */
  34269. dispose(): void;
  34270. private _checkAnimationGroupEnded;
  34271. /**
  34272. * Clone the current animation group and returns a copy
  34273. * @param newName defines the name of the new group
  34274. * @param targetConverter defines an optional function used to convert current animation targets to new ones
  34275. * @returns the new aniamtion group
  34276. */
  34277. clone(newName: string, targetConverter?: (oldTarget: any) => any): AnimationGroup;
  34278. /**
  34279. * Serializes the animationGroup to an object
  34280. * @returns Serialized object
  34281. */
  34282. serialize(): any;
  34283. /**
  34284. * Returns a new AnimationGroup object parsed from the source provided.
  34285. * @param parsedAnimationGroup defines the source
  34286. * @param scene defines the scene that will receive the animationGroup
  34287. * @returns a new AnimationGroup
  34288. */
  34289. static Parse(parsedAnimationGroup: any, scene: Scene): AnimationGroup;
  34290. /**
  34291. * Returns the string "AnimationGroup"
  34292. * @returns "AnimationGroup"
  34293. */
  34294. getClassName(): string;
  34295. /**
  34296. * Creates a detailled string about the object
  34297. * @param fullDetails defines if the output string will support multiple levels of logging within scene loading
  34298. * @returns a string representing the object
  34299. */
  34300. toString(fullDetails?: boolean): string;
  34301. }
  34302. }
  34303. declare module "babylonjs/scene" {
  34304. import { Nullable } from "babylonjs/types";
  34305. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  34306. import { Observable } from "babylonjs/Misc/observable";
  34307. import { SmartArrayNoDuplicate, SmartArray, ISmartArrayLike } from "babylonjs/Misc/smartArray";
  34308. import { Vector2, Vector3, Matrix } from "babylonjs/Maths/math.vector";
  34309. import { Geometry } from "babylonjs/Meshes/geometry";
  34310. import { TransformNode } from "babylonjs/Meshes/transformNode";
  34311. import { SubMesh } from "babylonjs/Meshes/subMesh";
  34312. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  34313. import { Mesh } from "babylonjs/Meshes/mesh";
  34314. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  34315. import { Bone } from "babylonjs/Bones/bone";
  34316. import { Skeleton } from "babylonjs/Bones/skeleton";
  34317. import { MorphTargetManager } from "babylonjs/Morph/morphTargetManager";
  34318. import { Camera } from "babylonjs/Cameras/camera";
  34319. import { AbstractScene } from "babylonjs/abstractScene";
  34320. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  34321. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  34322. import { Material } from "babylonjs/Materials/material";
  34323. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  34324. import { Effect } from "babylonjs/Materials/effect";
  34325. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  34326. import { MultiMaterial } from "babylonjs/Materials/multiMaterial";
  34327. import { Light } from "babylonjs/Lights/light";
  34328. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  34329. import { ICollisionCoordinator } from "babylonjs/Collisions/collisionCoordinator";
  34330. import { PointerEventTypes, PointerInfoPre, PointerInfo } from "babylonjs/Events/pointerEvents";
  34331. import { KeyboardInfoPre, KeyboardInfo } from "babylonjs/Events/keyboardEvents";
  34332. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  34333. import { PostProcessManager } from "babylonjs/PostProcesses/postProcessManager";
  34334. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  34335. import { RenderingGroupInfo, IRenderingManagerAutoClearSetup } from "babylonjs/Rendering/renderingManager";
  34336. import { ISceneComponent, ISceneSerializableComponent, Stage, SimpleStageAction, RenderTargetsStageAction, RenderTargetStageAction, MeshStageAction, EvaluateSubMeshStageAction, ActiveMeshStageAction, CameraStageAction, RenderingGroupStageAction, RenderingMeshStageAction, PointerMoveStageAction, PointerUpDownStageAction, CameraStageFrameBufferAction } from "babylonjs/sceneComponent";
  34337. import { Engine } from "babylonjs/Engines/engine";
  34338. import { Node } from "babylonjs/node";
  34339. import { MorphTarget } from "babylonjs/Morph/morphTarget";
  34340. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  34341. import { WebRequest } from "babylonjs/Misc/webRequest";
  34342. import { InputManager } from "babylonjs/Inputs/scene.inputManager";
  34343. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  34344. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  34345. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  34346. import { Plane } from "babylonjs/Maths/math.plane";
  34347. import { LoadFileError, RequestFileError, ReadFileError } from "babylonjs/Misc/fileTools";
  34348. import { Ray } from "babylonjs/Culling/ray";
  34349. import { TrianglePickingPredicate } from "babylonjs/Culling/ray";
  34350. import { Animation } from "babylonjs/Animations/animation";
  34351. import { Animatable } from "babylonjs/Animations/animatable";
  34352. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  34353. import { AnimationPropertiesOverride } from "babylonjs/Animations/animationPropertiesOverride";
  34354. import { Collider } from "babylonjs/Collisions/collider";
  34355. /**
  34356. * Define an interface for all classes that will hold resources
  34357. */
  34358. export interface IDisposable {
  34359. /**
  34360. * Releases all held resources
  34361. */
  34362. dispose(): void;
  34363. }
  34364. /** Interface defining initialization parameters for Scene class */
  34365. export interface SceneOptions {
  34366. /**
  34367. * Defines that scene should keep up-to-date a map of geometry to enable fast look-up by uniqueId
  34368. * It will improve performance when the number of geometries becomes important.
  34369. */
  34370. useGeometryUniqueIdsMap?: boolean;
  34371. /**
  34372. * Defines that each material of the scene should keep up-to-date a map of referencing meshes for fast diposing
  34373. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  34374. */
  34375. useMaterialMeshMap?: boolean;
  34376. /**
  34377. * Defines that each mesh of the scene should keep up-to-date a map of referencing cloned meshes for fast diposing
  34378. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  34379. */
  34380. useClonedMeshhMap?: boolean;
  34381. /** Defines if the creation of the scene should impact the engine (Eg. UtilityLayer's scene) */
  34382. virtual?: boolean;
  34383. }
  34384. /**
  34385. * Represents a scene to be rendered by the engine.
  34386. * @see http://doc.babylonjs.com/features/scene
  34387. */
  34388. export class Scene extends AbstractScene implements IAnimatable {
  34389. /** The fog is deactivated */
  34390. static readonly FOGMODE_NONE: number;
  34391. /** The fog density is following an exponential function */
  34392. static readonly FOGMODE_EXP: number;
  34393. /** The fog density is following an exponential function faster than FOGMODE_EXP */
  34394. static readonly FOGMODE_EXP2: number;
  34395. /** The fog density is following a linear function. */
  34396. static readonly FOGMODE_LINEAR: number;
  34397. /**
  34398. * Gets or sets the minimum deltatime when deterministic lock step is enabled
  34399. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  34400. */
  34401. static MinDeltaTime: number;
  34402. /**
  34403. * Gets or sets the maximum deltatime when deterministic lock step is enabled
  34404. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  34405. */
  34406. static MaxDeltaTime: number;
  34407. /**
  34408. * Factory used to create the default material.
  34409. * @param name The name of the material to create
  34410. * @param scene The scene to create the material for
  34411. * @returns The default material
  34412. */
  34413. static DefaultMaterialFactory(scene: Scene): Material;
  34414. /**
  34415. * Factory used to create the a collision coordinator.
  34416. * @returns The collision coordinator
  34417. */
  34418. static CollisionCoordinatorFactory(): ICollisionCoordinator;
  34419. /** @hidden */
  34420. _inputManager: InputManager;
  34421. /** Define this parameter if you are using multiple cameras and you want to specify which one should be used for pointer position */
  34422. cameraToUseForPointers: Nullable<Camera>;
  34423. /** @hidden */
  34424. readonly _isScene: boolean;
  34425. /**
  34426. * Gets or sets a boolean that indicates if the scene must clear the render buffer before rendering a frame
  34427. */
  34428. autoClear: boolean;
  34429. /**
  34430. * Gets or sets a boolean that indicates if the scene must clear the depth and stencil buffers before rendering a frame
  34431. */
  34432. autoClearDepthAndStencil: boolean;
  34433. /**
  34434. * Defines the color used to clear the render buffer (Default is (0.2, 0.2, 0.3, 1.0))
  34435. */
  34436. clearColor: Color4;
  34437. /**
  34438. * Defines the color used to simulate the ambient color (Default is (0, 0, 0))
  34439. */
  34440. ambientColor: Color3;
  34441. /**
  34442. * This is use to store the default BRDF lookup for PBR materials in your scene.
  34443. * It should only be one of the following (if not the default embedded one):
  34444. * * For uncorrelated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = false) : https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  34445. * * For correlated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedBRDF.dds
  34446. * * For correlated multi scattering BRDF (pbr.brdf.useEnergyConservation = true and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  34447. * The material properties need to be setup according to the type of texture in use.
  34448. */
  34449. environmentBRDFTexture: BaseTexture;
  34450. /** @hidden */
  34451. protected _environmentTexture: Nullable<BaseTexture>;
  34452. /**
  34453. * Texture used in all pbr material as the reflection texture.
  34454. * As in the majority of the scene they are the same (exception for multi room and so on),
  34455. * this is easier to reference from here than from all the materials.
  34456. */
  34457. /**
  34458. * Texture used in all pbr material as the reflection texture.
  34459. * As in the majority of the scene they are the same (exception for multi room and so on),
  34460. * this is easier to set here than in all the materials.
  34461. */
  34462. environmentTexture: Nullable<BaseTexture>;
  34463. /** @hidden */
  34464. protected _environmentIntensity: number;
  34465. /**
  34466. * Intensity of the environment in all pbr material.
  34467. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  34468. * As in the majority of the scene they are the same (exception for multi room and so on),
  34469. * this is easier to reference from here than from all the materials.
  34470. */
  34471. /**
  34472. * Intensity of the environment in all pbr material.
  34473. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  34474. * As in the majority of the scene they are the same (exception for multi room and so on),
  34475. * this is easier to set here than in all the materials.
  34476. */
  34477. environmentIntensity: number;
  34478. /** @hidden */
  34479. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  34480. /**
  34481. * Default image processing configuration used either in the rendering
  34482. * Forward main pass or through the imageProcessingPostProcess if present.
  34483. * As in the majority of the scene they are the same (exception for multi camera),
  34484. * this is easier to reference from here than from all the materials and post process.
  34485. *
  34486. * No setter as we it is a shared configuration, you can set the values instead.
  34487. */
  34488. readonly imageProcessingConfiguration: ImageProcessingConfiguration;
  34489. private _forceWireframe;
  34490. /**
  34491. * Gets or sets a boolean indicating if all rendering must be done in wireframe
  34492. */
  34493. forceWireframe: boolean;
  34494. private _forcePointsCloud;
  34495. /**
  34496. * Gets or sets a boolean indicating if all rendering must be done in point cloud
  34497. */
  34498. forcePointsCloud: boolean;
  34499. /**
  34500. * Gets or sets the active clipplane 1
  34501. */
  34502. clipPlane: Nullable<Plane>;
  34503. /**
  34504. * Gets or sets the active clipplane 2
  34505. */
  34506. clipPlane2: Nullable<Plane>;
  34507. /**
  34508. * Gets or sets the active clipplane 3
  34509. */
  34510. clipPlane3: Nullable<Plane>;
  34511. /**
  34512. * Gets or sets the active clipplane 4
  34513. */
  34514. clipPlane4: Nullable<Plane>;
  34515. /**
  34516. * Gets or sets a boolean indicating if animations are enabled
  34517. */
  34518. animationsEnabled: boolean;
  34519. private _animationPropertiesOverride;
  34520. /**
  34521. * Gets or sets the animation properties override
  34522. */
  34523. animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  34524. /**
  34525. * Gets or sets a boolean indicating if a constant deltatime has to be used
  34526. * This is mostly useful for testing purposes when you do not want the animations to scale with the framerate
  34527. */
  34528. useConstantAnimationDeltaTime: boolean;
  34529. /**
  34530. * Gets or sets a boolean indicating if the scene must keep the meshUnderPointer property updated
  34531. * Please note that it requires to run a ray cast through the scene on every frame
  34532. */
  34533. constantlyUpdateMeshUnderPointer: boolean;
  34534. /**
  34535. * Defines the HTML cursor to use when hovering over interactive elements
  34536. */
  34537. hoverCursor: string;
  34538. /**
  34539. * Defines the HTML default cursor to use (empty by default)
  34540. */
  34541. defaultCursor: string;
  34542. /**
  34543. * Defines wether cursors are handled by the scene.
  34544. */
  34545. doNotHandleCursors: boolean;
  34546. /**
  34547. * This is used to call preventDefault() on pointer down
  34548. * in order to block unwanted artifacts like system double clicks
  34549. */
  34550. preventDefaultOnPointerDown: boolean;
  34551. /**
  34552. * This is used to call preventDefault() on pointer up
  34553. * in order to block unwanted artifacts like system double clicks
  34554. */
  34555. preventDefaultOnPointerUp: boolean;
  34556. /**
  34557. * Gets or sets user defined metadata
  34558. */
  34559. metadata: any;
  34560. /**
  34561. * For internal use only. Please do not use.
  34562. */
  34563. reservedDataStore: any;
  34564. /**
  34565. * Gets the name of the plugin used to load this scene (null by default)
  34566. */
  34567. loadingPluginName: string;
  34568. /**
  34569. * Use this array to add regular expressions used to disable offline support for specific urls
  34570. */
  34571. disableOfflineSupportExceptionRules: RegExp[];
  34572. /**
  34573. * An event triggered when the scene is disposed.
  34574. */
  34575. onDisposeObservable: Observable<Scene>;
  34576. private _onDisposeObserver;
  34577. /** Sets a function to be executed when this scene is disposed. */
  34578. onDispose: () => void;
  34579. /**
  34580. * An event triggered before rendering the scene (right after animations and physics)
  34581. */
  34582. onBeforeRenderObservable: Observable<Scene>;
  34583. private _onBeforeRenderObserver;
  34584. /** Sets a function to be executed before rendering this scene */
  34585. beforeRender: Nullable<() => void>;
  34586. /**
  34587. * An event triggered after rendering the scene
  34588. */
  34589. onAfterRenderObservable: Observable<Scene>;
  34590. /**
  34591. * An event triggered after rendering the scene for an active camera (When scene.render is called this will be called after each camera)
  34592. */
  34593. onAfterRenderCameraObservable: Observable<Camera>;
  34594. private _onAfterRenderObserver;
  34595. /** Sets a function to be executed after rendering this scene */
  34596. afterRender: Nullable<() => void>;
  34597. /**
  34598. * An event triggered before animating the scene
  34599. */
  34600. onBeforeAnimationsObservable: Observable<Scene>;
  34601. /**
  34602. * An event triggered after animations processing
  34603. */
  34604. onAfterAnimationsObservable: Observable<Scene>;
  34605. /**
  34606. * An event triggered before draw calls are ready to be sent
  34607. */
  34608. onBeforeDrawPhaseObservable: Observable<Scene>;
  34609. /**
  34610. * An event triggered after draw calls have been sent
  34611. */
  34612. onAfterDrawPhaseObservable: Observable<Scene>;
  34613. /**
  34614. * An event triggered when the scene is ready
  34615. */
  34616. onReadyObservable: Observable<Scene>;
  34617. /**
  34618. * An event triggered before rendering a camera
  34619. */
  34620. onBeforeCameraRenderObservable: Observable<Camera>;
  34621. private _onBeforeCameraRenderObserver;
  34622. /** Sets a function to be executed before rendering a camera*/
  34623. beforeCameraRender: () => void;
  34624. /**
  34625. * An event triggered after rendering a camera
  34626. */
  34627. onAfterCameraRenderObservable: Observable<Camera>;
  34628. private _onAfterCameraRenderObserver;
  34629. /** Sets a function to be executed after rendering a camera*/
  34630. afterCameraRender: () => void;
  34631. /**
  34632. * An event triggered when active meshes evaluation is about to start
  34633. */
  34634. onBeforeActiveMeshesEvaluationObservable: Observable<Scene>;
  34635. /**
  34636. * An event triggered when active meshes evaluation is done
  34637. */
  34638. onAfterActiveMeshesEvaluationObservable: Observable<Scene>;
  34639. /**
  34640. * An event triggered when particles rendering is about to start
  34641. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  34642. */
  34643. onBeforeParticlesRenderingObservable: Observable<Scene>;
  34644. /**
  34645. * An event triggered when particles rendering is done
  34646. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  34647. */
  34648. onAfterParticlesRenderingObservable: Observable<Scene>;
  34649. /**
  34650. * An event triggered when SceneLoader.Append or SceneLoader.Load or SceneLoader.ImportMesh were successfully executed
  34651. */
  34652. onDataLoadedObservable: Observable<Scene>;
  34653. /**
  34654. * An event triggered when a camera is created
  34655. */
  34656. onNewCameraAddedObservable: Observable<Camera>;
  34657. /**
  34658. * An event triggered when a camera is removed
  34659. */
  34660. onCameraRemovedObservable: Observable<Camera>;
  34661. /**
  34662. * An event triggered when a light is created
  34663. */
  34664. onNewLightAddedObservable: Observable<Light>;
  34665. /**
  34666. * An event triggered when a light is removed
  34667. */
  34668. onLightRemovedObservable: Observable<Light>;
  34669. /**
  34670. * An event triggered when a geometry is created
  34671. */
  34672. onNewGeometryAddedObservable: Observable<Geometry>;
  34673. /**
  34674. * An event triggered when a geometry is removed
  34675. */
  34676. onGeometryRemovedObservable: Observable<Geometry>;
  34677. /**
  34678. * An event triggered when a transform node is created
  34679. */
  34680. onNewTransformNodeAddedObservable: Observable<TransformNode>;
  34681. /**
  34682. * An event triggered when a transform node is removed
  34683. */
  34684. onTransformNodeRemovedObservable: Observable<TransformNode>;
  34685. /**
  34686. * An event triggered when a mesh is created
  34687. */
  34688. onNewMeshAddedObservable: Observable<AbstractMesh>;
  34689. /**
  34690. * An event triggered when a mesh is removed
  34691. */
  34692. onMeshRemovedObservable: Observable<AbstractMesh>;
  34693. /**
  34694. * An event triggered when a skeleton is created
  34695. */
  34696. onNewSkeletonAddedObservable: Observable<Skeleton>;
  34697. /**
  34698. * An event triggered when a skeleton is removed
  34699. */
  34700. onSkeletonRemovedObservable: Observable<Skeleton>;
  34701. /**
  34702. * An event triggered when a material is created
  34703. */
  34704. onNewMaterialAddedObservable: Observable<Material>;
  34705. /**
  34706. * An event triggered when a material is removed
  34707. */
  34708. onMaterialRemovedObservable: Observable<Material>;
  34709. /**
  34710. * An event triggered when a texture is created
  34711. */
  34712. onNewTextureAddedObservable: Observable<BaseTexture>;
  34713. /**
  34714. * An event triggered when a texture is removed
  34715. */
  34716. onTextureRemovedObservable: Observable<BaseTexture>;
  34717. /**
  34718. * An event triggered when render targets are about to be rendered
  34719. * Can happen multiple times per frame.
  34720. */
  34721. onBeforeRenderTargetsRenderObservable: Observable<Scene>;
  34722. /**
  34723. * An event triggered when render targets were rendered.
  34724. * Can happen multiple times per frame.
  34725. */
  34726. onAfterRenderTargetsRenderObservable: Observable<Scene>;
  34727. /**
  34728. * An event triggered before calculating deterministic simulation step
  34729. */
  34730. onBeforeStepObservable: Observable<Scene>;
  34731. /**
  34732. * An event triggered after calculating deterministic simulation step
  34733. */
  34734. onAfterStepObservable: Observable<Scene>;
  34735. /**
  34736. * An event triggered when the activeCamera property is updated
  34737. */
  34738. onActiveCameraChanged: Observable<Scene>;
  34739. /**
  34740. * This Observable will be triggered before rendering each renderingGroup of each rendered camera.
  34741. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  34742. * 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)
  34743. */
  34744. onBeforeRenderingGroupObservable: Observable<RenderingGroupInfo>;
  34745. /**
  34746. * This Observable will be triggered after rendering each renderingGroup of each rendered camera.
  34747. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  34748. * 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)
  34749. */
  34750. onAfterRenderingGroupObservable: Observable<RenderingGroupInfo>;
  34751. /**
  34752. * This Observable will when a mesh has been imported into the scene.
  34753. */
  34754. onMeshImportedObservable: Observable<AbstractMesh>;
  34755. /**
  34756. * Gets or sets a user defined funtion to select LOD from a mesh and a camera.
  34757. * By default this function is undefined and Babylon.js will select LOD based on distance to camera
  34758. */
  34759. customLODSelector: (mesh: AbstractMesh, camera: Camera) => Nullable<AbstractMesh>;
  34760. /** @hidden */
  34761. _registeredForLateAnimationBindings: SmartArrayNoDuplicate<any>;
  34762. /**
  34763. * Gets or sets a predicate used to select candidate meshes for a pointer down event
  34764. */
  34765. pointerDownPredicate: (Mesh: AbstractMesh) => boolean;
  34766. /**
  34767. * Gets or sets a predicate used to select candidate meshes for a pointer up event
  34768. */
  34769. pointerUpPredicate: (Mesh: AbstractMesh) => boolean;
  34770. /**
  34771. * Gets or sets a predicate used to select candidate meshes for a pointer move event
  34772. */
  34773. pointerMovePredicate: (Mesh: AbstractMesh) => boolean;
  34774. /** Callback called when a pointer move is detected */
  34775. onPointerMove: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  34776. /** Callback called when a pointer down is detected */
  34777. onPointerDown: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  34778. /** Callback called when a pointer up is detected */
  34779. onPointerUp: (evt: PointerEvent, pickInfo: Nullable<PickingInfo>, type: PointerEventTypes) => void;
  34780. /** Callback called when a pointer pick is detected */
  34781. onPointerPick: (evt: PointerEvent, pickInfo: PickingInfo) => void;
  34782. /**
  34783. * 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).
  34784. * You have the possibility to skip the process and the call to onPointerObservable by setting PointerInfoPre.skipOnPointerObservable to true
  34785. */
  34786. onPrePointerObservable: Observable<PointerInfoPre>;
  34787. /**
  34788. * Observable event triggered each time an input event is received from the rendering canvas
  34789. */
  34790. onPointerObservable: Observable<PointerInfo>;
  34791. /**
  34792. * Gets the pointer coordinates without any translation (ie. straight out of the pointer event)
  34793. */
  34794. readonly unTranslatedPointer: Vector2;
  34795. /**
  34796. * Gets or sets the distance in pixel that you have to move to prevent some events. Default is 10 pixels
  34797. */
  34798. static DragMovementThreshold: number;
  34799. /**
  34800. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 500 ms
  34801. */
  34802. static LongPressDelay: number;
  34803. /**
  34804. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 300 ms
  34805. */
  34806. static DoubleClickDelay: number;
  34807. /** If you need to check double click without raising a single click at first click, enable this flag */
  34808. static ExclusiveDoubleClickMode: boolean;
  34809. /** @hidden */
  34810. _mirroredCameraPosition: Nullable<Vector3>;
  34811. /**
  34812. * This observable event is triggered when any keyboard event si raised and registered during Scene.attachControl()
  34813. * You have the possibility to skip the process and the call to onKeyboardObservable by setting KeyboardInfoPre.skipOnPointerObservable to true
  34814. */
  34815. onPreKeyboardObservable: Observable<KeyboardInfoPre>;
  34816. /**
  34817. * Observable event triggered each time an keyboard event is received from the hosting window
  34818. */
  34819. onKeyboardObservable: Observable<KeyboardInfo>;
  34820. private _useRightHandedSystem;
  34821. /**
  34822. * Gets or sets a boolean indicating if the scene must use right-handed coordinates system
  34823. */
  34824. useRightHandedSystem: boolean;
  34825. private _timeAccumulator;
  34826. private _currentStepId;
  34827. private _currentInternalStep;
  34828. /**
  34829. * Sets the step Id used by deterministic lock step
  34830. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  34831. * @param newStepId defines the step Id
  34832. */
  34833. setStepId(newStepId: number): void;
  34834. /**
  34835. * Gets the step Id used by deterministic lock step
  34836. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  34837. * @returns the step Id
  34838. */
  34839. getStepId(): number;
  34840. /**
  34841. * Gets the internal step used by deterministic lock step
  34842. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  34843. * @returns the internal step
  34844. */
  34845. getInternalStep(): number;
  34846. private _fogEnabled;
  34847. /**
  34848. * Gets or sets a boolean indicating if fog is enabled on this scene
  34849. * @see http://doc.babylonjs.com/babylon101/environment#fog
  34850. * (Default is true)
  34851. */
  34852. fogEnabled: boolean;
  34853. private _fogMode;
  34854. /**
  34855. * Gets or sets the fog mode to use
  34856. * @see http://doc.babylonjs.com/babylon101/environment#fog
  34857. * | mode | value |
  34858. * | --- | --- |
  34859. * | FOGMODE_NONE | 0 |
  34860. * | FOGMODE_EXP | 1 |
  34861. * | FOGMODE_EXP2 | 2 |
  34862. * | FOGMODE_LINEAR | 3 |
  34863. */
  34864. fogMode: number;
  34865. /**
  34866. * Gets or sets the fog color to use
  34867. * @see http://doc.babylonjs.com/babylon101/environment#fog
  34868. * (Default is Color3(0.2, 0.2, 0.3))
  34869. */
  34870. fogColor: Color3;
  34871. /**
  34872. * Gets or sets the fog density to use
  34873. * @see http://doc.babylonjs.com/babylon101/environment#fog
  34874. * (Default is 0.1)
  34875. */
  34876. fogDensity: number;
  34877. /**
  34878. * Gets or sets the fog start distance to use
  34879. * @see http://doc.babylonjs.com/babylon101/environment#fog
  34880. * (Default is 0)
  34881. */
  34882. fogStart: number;
  34883. /**
  34884. * Gets or sets the fog end distance to use
  34885. * @see http://doc.babylonjs.com/babylon101/environment#fog
  34886. * (Default is 1000)
  34887. */
  34888. fogEnd: number;
  34889. private _shadowsEnabled;
  34890. /**
  34891. * Gets or sets a boolean indicating if shadows are enabled on this scene
  34892. */
  34893. shadowsEnabled: boolean;
  34894. private _lightsEnabled;
  34895. /**
  34896. * Gets or sets a boolean indicating if lights are enabled on this scene
  34897. */
  34898. lightsEnabled: boolean;
  34899. /** All of the active cameras added to this scene. */
  34900. activeCameras: Camera[];
  34901. /** @hidden */
  34902. _activeCamera: Nullable<Camera>;
  34903. /** Gets or sets the current active camera */
  34904. activeCamera: Nullable<Camera>;
  34905. private _defaultMaterial;
  34906. /** The default material used on meshes when no material is affected */
  34907. /** The default material used on meshes when no material is affected */
  34908. defaultMaterial: Material;
  34909. private _texturesEnabled;
  34910. /**
  34911. * Gets or sets a boolean indicating if textures are enabled on this scene
  34912. */
  34913. texturesEnabled: boolean;
  34914. /**
  34915. * Gets or sets a boolean indicating if particles are enabled on this scene
  34916. */
  34917. particlesEnabled: boolean;
  34918. /**
  34919. * Gets or sets a boolean indicating if sprites are enabled on this scene
  34920. */
  34921. spritesEnabled: boolean;
  34922. private _skeletonsEnabled;
  34923. /**
  34924. * Gets or sets a boolean indicating if skeletons are enabled on this scene
  34925. */
  34926. skeletonsEnabled: boolean;
  34927. /**
  34928. * Gets or sets a boolean indicating if lens flares are enabled on this scene
  34929. */
  34930. lensFlaresEnabled: boolean;
  34931. /**
  34932. * Gets or sets a boolean indicating if collisions are enabled on this scene
  34933. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  34934. */
  34935. collisionsEnabled: boolean;
  34936. private _collisionCoordinator;
  34937. /** @hidden */
  34938. readonly collisionCoordinator: ICollisionCoordinator;
  34939. /**
  34940. * Defines the gravity applied to this scene (used only for collisions)
  34941. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  34942. */
  34943. gravity: Vector3;
  34944. /**
  34945. * Gets or sets a boolean indicating if postprocesses are enabled on this scene
  34946. */
  34947. postProcessesEnabled: boolean;
  34948. /**
  34949. * The list of postprocesses added to the scene
  34950. */
  34951. postProcesses: PostProcess[];
  34952. /**
  34953. * Gets the current postprocess manager
  34954. */
  34955. postProcessManager: PostProcessManager;
  34956. /**
  34957. * Gets or sets a boolean indicating if render targets are enabled on this scene
  34958. */
  34959. renderTargetsEnabled: boolean;
  34960. /**
  34961. * Gets or sets a boolean indicating if next render targets must be dumped as image for debugging purposes
  34962. * We recommend not using it and instead rely on Spector.js: http://spector.babylonjs.com
  34963. */
  34964. dumpNextRenderTargets: boolean;
  34965. /**
  34966. * The list of user defined render targets added to the scene
  34967. */
  34968. customRenderTargets: RenderTargetTexture[];
  34969. /**
  34970. * Defines if texture loading must be delayed
  34971. * If true, textures will only be loaded when they need to be rendered
  34972. */
  34973. useDelayedTextureLoading: boolean;
  34974. /**
  34975. * Gets the list of meshes imported to the scene through SceneLoader
  34976. */
  34977. importedMeshesFiles: String[];
  34978. /**
  34979. * Gets or sets a boolean indicating if probes are enabled on this scene
  34980. */
  34981. probesEnabled: boolean;
  34982. /**
  34983. * Gets or sets the current offline provider to use to store scene data
  34984. * @see http://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  34985. */
  34986. offlineProvider: IOfflineProvider;
  34987. /**
  34988. * Gets or sets the action manager associated with the scene
  34989. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  34990. */
  34991. actionManager: AbstractActionManager;
  34992. private _meshesForIntersections;
  34993. /**
  34994. * Gets or sets a boolean indicating if procedural textures are enabled on this scene
  34995. */
  34996. proceduralTexturesEnabled: boolean;
  34997. private _engine;
  34998. private _totalVertices;
  34999. /** @hidden */
  35000. _activeIndices: PerfCounter;
  35001. /** @hidden */
  35002. _activeParticles: PerfCounter;
  35003. /** @hidden */
  35004. _activeBones: PerfCounter;
  35005. private _animationRatio;
  35006. /** @hidden */
  35007. _animationTimeLast: number;
  35008. /** @hidden */
  35009. _animationTime: number;
  35010. /**
  35011. * Gets or sets a general scale for animation speed
  35012. * @see https://www.babylonjs-playground.com/#IBU2W7#3
  35013. */
  35014. animationTimeScale: number;
  35015. /** @hidden */
  35016. _cachedMaterial: Nullable<Material>;
  35017. /** @hidden */
  35018. _cachedEffect: Nullable<Effect>;
  35019. /** @hidden */
  35020. _cachedVisibility: Nullable<number>;
  35021. private _renderId;
  35022. private _frameId;
  35023. private _executeWhenReadyTimeoutId;
  35024. private _intermediateRendering;
  35025. private _viewUpdateFlag;
  35026. private _projectionUpdateFlag;
  35027. /** @hidden */
  35028. _toBeDisposed: Nullable<IDisposable>[];
  35029. private _activeRequests;
  35030. /** @hidden */
  35031. _pendingData: any[];
  35032. private _isDisposed;
  35033. /**
  35034. * Gets or sets a boolean indicating that all submeshes of active meshes must be rendered
  35035. * Use this boolean to avoid computing frustum clipping on submeshes (This could help when you are CPU bound)
  35036. */
  35037. dispatchAllSubMeshesOfActiveMeshes: boolean;
  35038. private _activeMeshes;
  35039. private _processedMaterials;
  35040. private _renderTargets;
  35041. /** @hidden */
  35042. _activeParticleSystems: SmartArray<IParticleSystem>;
  35043. private _activeSkeletons;
  35044. private _softwareSkinnedMeshes;
  35045. private _renderingManager;
  35046. /** @hidden */
  35047. _activeAnimatables: import("babylonjs/Animations/animatable").Animatable[];
  35048. private _transformMatrix;
  35049. private _sceneUbo;
  35050. /** @hidden */
  35051. _viewMatrix: Matrix;
  35052. private _projectionMatrix;
  35053. /** @hidden */
  35054. _forcedViewPosition: Nullable<Vector3>;
  35055. /** @hidden */
  35056. _frustumPlanes: Plane[];
  35057. /**
  35058. * Gets the list of frustum planes (built from the active camera)
  35059. */
  35060. readonly frustumPlanes: Plane[];
  35061. /**
  35062. * Gets or sets a boolean indicating if lights must be sorted by priority (off by default)
  35063. * This is useful if there are more lights that the maximum simulteanous authorized
  35064. */
  35065. requireLightSorting: boolean;
  35066. /** @hidden */
  35067. readonly useMaterialMeshMap: boolean;
  35068. /** @hidden */
  35069. readonly useClonedMeshhMap: boolean;
  35070. private _externalData;
  35071. private _uid;
  35072. /**
  35073. * @hidden
  35074. * Backing store of defined scene components.
  35075. */
  35076. _components: ISceneComponent[];
  35077. /**
  35078. * @hidden
  35079. * Backing store of defined scene components.
  35080. */
  35081. _serializableComponents: ISceneSerializableComponent[];
  35082. /**
  35083. * List of components to register on the next registration step.
  35084. */
  35085. private _transientComponents;
  35086. /**
  35087. * Registers the transient components if needed.
  35088. */
  35089. private _registerTransientComponents;
  35090. /**
  35091. * @hidden
  35092. * Add a component to the scene.
  35093. * Note that the ccomponent could be registered on th next frame if this is called after
  35094. * the register component stage.
  35095. * @param component Defines the component to add to the scene
  35096. */
  35097. _addComponent(component: ISceneComponent): void;
  35098. /**
  35099. * @hidden
  35100. * Gets a component from the scene.
  35101. * @param name defines the name of the component to retrieve
  35102. * @returns the component or null if not present
  35103. */
  35104. _getComponent(name: string): Nullable<ISceneComponent>;
  35105. /**
  35106. * @hidden
  35107. * Defines the actions happening before camera updates.
  35108. */
  35109. _beforeCameraUpdateStage: Stage<SimpleStageAction>;
  35110. /**
  35111. * @hidden
  35112. * Defines the actions happening before clear the canvas.
  35113. */
  35114. _beforeClearStage: Stage<SimpleStageAction>;
  35115. /**
  35116. * @hidden
  35117. * Defines the actions when collecting render targets for the frame.
  35118. */
  35119. _gatherRenderTargetsStage: Stage<RenderTargetsStageAction>;
  35120. /**
  35121. * @hidden
  35122. * Defines the actions happening for one camera in the frame.
  35123. */
  35124. _gatherActiveCameraRenderTargetsStage: Stage<RenderTargetsStageAction>;
  35125. /**
  35126. * @hidden
  35127. * Defines the actions happening during the per mesh ready checks.
  35128. */
  35129. _isReadyForMeshStage: Stage<MeshStageAction>;
  35130. /**
  35131. * @hidden
  35132. * Defines the actions happening before evaluate active mesh checks.
  35133. */
  35134. _beforeEvaluateActiveMeshStage: Stage<SimpleStageAction>;
  35135. /**
  35136. * @hidden
  35137. * Defines the actions happening during the evaluate sub mesh checks.
  35138. */
  35139. _evaluateSubMeshStage: Stage<EvaluateSubMeshStageAction>;
  35140. /**
  35141. * @hidden
  35142. * Defines the actions happening during the active mesh stage.
  35143. */
  35144. _activeMeshStage: Stage<ActiveMeshStageAction>;
  35145. /**
  35146. * @hidden
  35147. * Defines the actions happening during the per camera render target step.
  35148. */
  35149. _cameraDrawRenderTargetStage: Stage<CameraStageFrameBufferAction>;
  35150. /**
  35151. * @hidden
  35152. * Defines the actions happening just before the active camera is drawing.
  35153. */
  35154. _beforeCameraDrawStage: Stage<CameraStageAction>;
  35155. /**
  35156. * @hidden
  35157. * Defines the actions happening just before a render target is drawing.
  35158. */
  35159. _beforeRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  35160. /**
  35161. * @hidden
  35162. * Defines the actions happening just before a rendering group is drawing.
  35163. */
  35164. _beforeRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  35165. /**
  35166. * @hidden
  35167. * Defines the actions happening just before a mesh is drawing.
  35168. */
  35169. _beforeRenderingMeshStage: Stage<RenderingMeshStageAction>;
  35170. /**
  35171. * @hidden
  35172. * Defines the actions happening just after a mesh has been drawn.
  35173. */
  35174. _afterRenderingMeshStage: Stage<RenderingMeshStageAction>;
  35175. /**
  35176. * @hidden
  35177. * Defines the actions happening just after a rendering group has been drawn.
  35178. */
  35179. _afterRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  35180. /**
  35181. * @hidden
  35182. * Defines the actions happening just after the active camera has been drawn.
  35183. */
  35184. _afterCameraDrawStage: Stage<CameraStageAction>;
  35185. /**
  35186. * @hidden
  35187. * Defines the actions happening just after a render target has been drawn.
  35188. */
  35189. _afterRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  35190. /**
  35191. * @hidden
  35192. * Defines the actions happening just after rendering all cameras and computing intersections.
  35193. */
  35194. _afterRenderStage: Stage<SimpleStageAction>;
  35195. /**
  35196. * @hidden
  35197. * Defines the actions happening when a pointer move event happens.
  35198. */
  35199. _pointerMoveStage: Stage<PointerMoveStageAction>;
  35200. /**
  35201. * @hidden
  35202. * Defines the actions happening when a pointer down event happens.
  35203. */
  35204. _pointerDownStage: Stage<PointerUpDownStageAction>;
  35205. /**
  35206. * @hidden
  35207. * Defines the actions happening when a pointer up event happens.
  35208. */
  35209. _pointerUpStage: Stage<PointerUpDownStageAction>;
  35210. /**
  35211. * an optional map from Geometry Id to Geometry index in the 'geometries' array
  35212. */
  35213. private geometriesByUniqueId;
  35214. /**
  35215. * Creates a new Scene
  35216. * @param engine defines the engine to use to render this scene
  35217. * @param options defines the scene options
  35218. */
  35219. constructor(engine: Engine, options?: SceneOptions);
  35220. /**
  35221. * Gets a string idenfifying the name of the class
  35222. * @returns "Scene" string
  35223. */
  35224. getClassName(): string;
  35225. private _defaultMeshCandidates;
  35226. /**
  35227. * @hidden
  35228. */
  35229. _getDefaultMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  35230. private _defaultSubMeshCandidates;
  35231. /**
  35232. * @hidden
  35233. */
  35234. _getDefaultSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  35235. /**
  35236. * Sets the default candidate providers for the scene.
  35237. * This sets the getActiveMeshCandidates, getActiveSubMeshCandidates, getIntersectingSubMeshCandidates
  35238. * and getCollidingSubMeshCandidates to their default function
  35239. */
  35240. setDefaultCandidateProviders(): void;
  35241. /**
  35242. * Gets the mesh that is currently under the pointer
  35243. */
  35244. readonly meshUnderPointer: Nullable<AbstractMesh>;
  35245. /**
  35246. * Gets or sets the current on-screen X position of the pointer
  35247. */
  35248. pointerX: number;
  35249. /**
  35250. * Gets or sets the current on-screen Y position of the pointer
  35251. */
  35252. pointerY: number;
  35253. /**
  35254. * Gets the cached material (ie. the latest rendered one)
  35255. * @returns the cached material
  35256. */
  35257. getCachedMaterial(): Nullable<Material>;
  35258. /**
  35259. * Gets the cached effect (ie. the latest rendered one)
  35260. * @returns the cached effect
  35261. */
  35262. getCachedEffect(): Nullable<Effect>;
  35263. /**
  35264. * Gets the cached visibility state (ie. the latest rendered one)
  35265. * @returns the cached visibility state
  35266. */
  35267. getCachedVisibility(): Nullable<number>;
  35268. /**
  35269. * Gets a boolean indicating if the current material / effect / visibility must be bind again
  35270. * @param material defines the current material
  35271. * @param effect defines the current effect
  35272. * @param visibility defines the current visibility state
  35273. * @returns true if one parameter is not cached
  35274. */
  35275. isCachedMaterialInvalid(material: Material, effect: Effect, visibility?: number): boolean;
  35276. /**
  35277. * Gets the engine associated with the scene
  35278. * @returns an Engine
  35279. */
  35280. getEngine(): Engine;
  35281. /**
  35282. * Gets the total number of vertices rendered per frame
  35283. * @returns the total number of vertices rendered per frame
  35284. */
  35285. getTotalVertices(): number;
  35286. /**
  35287. * Gets the performance counter for total vertices
  35288. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  35289. */
  35290. readonly totalVerticesPerfCounter: PerfCounter;
  35291. /**
  35292. * Gets the total number of active indices rendered per frame (You can deduce the number of rendered triangles by dividing this number by 3)
  35293. * @returns the total number of active indices rendered per frame
  35294. */
  35295. getActiveIndices(): number;
  35296. /**
  35297. * Gets the performance counter for active indices
  35298. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  35299. */
  35300. readonly totalActiveIndicesPerfCounter: PerfCounter;
  35301. /**
  35302. * Gets the total number of active particles rendered per frame
  35303. * @returns the total number of active particles rendered per frame
  35304. */
  35305. getActiveParticles(): number;
  35306. /**
  35307. * Gets the performance counter for active particles
  35308. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  35309. */
  35310. readonly activeParticlesPerfCounter: PerfCounter;
  35311. /**
  35312. * Gets the total number of active bones rendered per frame
  35313. * @returns the total number of active bones rendered per frame
  35314. */
  35315. getActiveBones(): number;
  35316. /**
  35317. * Gets the performance counter for active bones
  35318. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  35319. */
  35320. readonly activeBonesPerfCounter: PerfCounter;
  35321. /**
  35322. * Gets the array of active meshes
  35323. * @returns an array of AbstractMesh
  35324. */
  35325. getActiveMeshes(): SmartArray<AbstractMesh>;
  35326. /**
  35327. * Gets the animation ratio (which is 1.0 is the scene renders at 60fps and 2 if the scene renders at 30fps, etc.)
  35328. * @returns a number
  35329. */
  35330. getAnimationRatio(): number;
  35331. /**
  35332. * Gets an unique Id for the current render phase
  35333. * @returns a number
  35334. */
  35335. getRenderId(): number;
  35336. /**
  35337. * Gets an unique Id for the current frame
  35338. * @returns a number
  35339. */
  35340. getFrameId(): number;
  35341. /** Call this function if you want to manually increment the render Id*/
  35342. incrementRenderId(): void;
  35343. private _createUbo;
  35344. /**
  35345. * Use this method to simulate a pointer move on a mesh
  35346. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  35347. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  35348. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  35349. * @returns the current scene
  35350. */
  35351. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  35352. /**
  35353. * Use this method to simulate a pointer down on a mesh
  35354. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  35355. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  35356. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  35357. * @returns the current scene
  35358. */
  35359. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  35360. /**
  35361. * Use this method to simulate a pointer up on a mesh
  35362. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  35363. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  35364. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  35365. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  35366. * @returns the current scene
  35367. */
  35368. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): Scene;
  35369. /**
  35370. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  35371. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  35372. * @returns true if the pointer was captured
  35373. */
  35374. isPointerCaptured(pointerId?: number): boolean;
  35375. /**
  35376. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  35377. * @param attachUp defines if you want to attach events to pointerup
  35378. * @param attachDown defines if you want to attach events to pointerdown
  35379. * @param attachMove defines if you want to attach events to pointermove
  35380. */
  35381. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean): void;
  35382. /** Detaches all event handlers*/
  35383. detachControl(): void;
  35384. /**
  35385. * This function will check if the scene can be rendered (textures are loaded, shaders are compiled)
  35386. * Delay loaded resources are not taking in account
  35387. * @return true if all required resources are ready
  35388. */
  35389. isReady(): boolean;
  35390. /** Resets all cached information relative to material (including effect and visibility) */
  35391. resetCachedMaterial(): void;
  35392. /**
  35393. * Registers a function to be called before every frame render
  35394. * @param func defines the function to register
  35395. */
  35396. registerBeforeRender(func: () => void): void;
  35397. /**
  35398. * Unregisters a function called before every frame render
  35399. * @param func defines the function to unregister
  35400. */
  35401. unregisterBeforeRender(func: () => void): void;
  35402. /**
  35403. * Registers a function to be called after every frame render
  35404. * @param func defines the function to register
  35405. */
  35406. registerAfterRender(func: () => void): void;
  35407. /**
  35408. * Unregisters a function called after every frame render
  35409. * @param func defines the function to unregister
  35410. */
  35411. unregisterAfterRender(func: () => void): void;
  35412. private _executeOnceBeforeRender;
  35413. /**
  35414. * The provided function will run before render once and will be disposed afterwards.
  35415. * A timeout delay can be provided so that the function will be executed in N ms.
  35416. * The timeout is using the browser's native setTimeout so time percision cannot be guaranteed.
  35417. * @param func The function to be executed.
  35418. * @param timeout optional delay in ms
  35419. */
  35420. executeOnceBeforeRender(func: () => void, timeout?: number): void;
  35421. /** @hidden */
  35422. _addPendingData(data: any): void;
  35423. /** @hidden */
  35424. _removePendingData(data: any): void;
  35425. /**
  35426. * Returns the number of items waiting to be loaded
  35427. * @returns the number of items waiting to be loaded
  35428. */
  35429. getWaitingItemsCount(): number;
  35430. /**
  35431. * Returns a boolean indicating if the scene is still loading data
  35432. */
  35433. readonly isLoading: boolean;
  35434. /**
  35435. * Registers a function to be executed when the scene is ready
  35436. * @param {Function} func - the function to be executed
  35437. */
  35438. executeWhenReady(func: () => void): void;
  35439. /**
  35440. * Returns a promise that resolves when the scene is ready
  35441. * @returns A promise that resolves when the scene is ready
  35442. */
  35443. whenReadyAsync(): Promise<void>;
  35444. /** @hidden */
  35445. _checkIsReady(): void;
  35446. /**
  35447. * Gets all animatable attached to the scene
  35448. */
  35449. readonly animatables: Animatable[];
  35450. /**
  35451. * Resets the last animation time frame.
  35452. * Useful to override when animations start running when loading a scene for the first time.
  35453. */
  35454. resetLastAnimationTimeFrame(): void;
  35455. /**
  35456. * Gets the current view matrix
  35457. * @returns a Matrix
  35458. */
  35459. getViewMatrix(): Matrix;
  35460. /**
  35461. * Gets the current projection matrix
  35462. * @returns a Matrix
  35463. */
  35464. getProjectionMatrix(): Matrix;
  35465. /**
  35466. * Gets the current transform matrix
  35467. * @returns a Matrix made of View * Projection
  35468. */
  35469. getTransformMatrix(): Matrix;
  35470. /**
  35471. * Sets the current transform matrix
  35472. * @param viewL defines the View matrix to use
  35473. * @param projectionL defines the Projection matrix to use
  35474. * @param viewR defines the right View matrix to use (if provided)
  35475. * @param projectionR defines the right Projection matrix to use (if provided)
  35476. */
  35477. setTransformMatrix(viewL: Matrix, projectionL: Matrix, viewR?: Matrix, projectionR?: Matrix): void;
  35478. /**
  35479. * Gets the uniform buffer used to store scene data
  35480. * @returns a UniformBuffer
  35481. */
  35482. getSceneUniformBuffer(): UniformBuffer;
  35483. /**
  35484. * Gets an unique (relatively to the current scene) Id
  35485. * @returns an unique number for the scene
  35486. */
  35487. getUniqueId(): number;
  35488. /**
  35489. * Add a mesh to the list of scene's meshes
  35490. * @param newMesh defines the mesh to add
  35491. * @param recursive if all child meshes should also be added to the scene
  35492. */
  35493. addMesh(newMesh: AbstractMesh, recursive?: boolean): void;
  35494. /**
  35495. * Remove a mesh for the list of scene's meshes
  35496. * @param toRemove defines the mesh to remove
  35497. * @param recursive if all child meshes should also be removed from the scene
  35498. * @returns the index where the mesh was in the mesh list
  35499. */
  35500. removeMesh(toRemove: AbstractMesh, recursive?: boolean): number;
  35501. /**
  35502. * Add a transform node to the list of scene's transform nodes
  35503. * @param newTransformNode defines the transform node to add
  35504. */
  35505. addTransformNode(newTransformNode: TransformNode): void;
  35506. /**
  35507. * Remove a transform node for the list of scene's transform nodes
  35508. * @param toRemove defines the transform node to remove
  35509. * @returns the index where the transform node was in the transform node list
  35510. */
  35511. removeTransformNode(toRemove: TransformNode): number;
  35512. /**
  35513. * Remove a skeleton for the list of scene's skeletons
  35514. * @param toRemove defines the skeleton to remove
  35515. * @returns the index where the skeleton was in the skeleton list
  35516. */
  35517. removeSkeleton(toRemove: Skeleton): number;
  35518. /**
  35519. * Remove a morph target for the list of scene's morph targets
  35520. * @param toRemove defines the morph target to remove
  35521. * @returns the index where the morph target was in the morph target list
  35522. */
  35523. removeMorphTargetManager(toRemove: MorphTargetManager): number;
  35524. /**
  35525. * Remove a light for the list of scene's lights
  35526. * @param toRemove defines the light to remove
  35527. * @returns the index where the light was in the light list
  35528. */
  35529. removeLight(toRemove: Light): number;
  35530. /**
  35531. * Remove a camera for the list of scene's cameras
  35532. * @param toRemove defines the camera to remove
  35533. * @returns the index where the camera was in the camera list
  35534. */
  35535. removeCamera(toRemove: Camera): number;
  35536. /**
  35537. * Remove a particle system for the list of scene's particle systems
  35538. * @param toRemove defines the particle system to remove
  35539. * @returns the index where the particle system was in the particle system list
  35540. */
  35541. removeParticleSystem(toRemove: IParticleSystem): number;
  35542. /**
  35543. * Remove a animation for the list of scene's animations
  35544. * @param toRemove defines the animation to remove
  35545. * @returns the index where the animation was in the animation list
  35546. */
  35547. removeAnimation(toRemove: Animation): number;
  35548. /**
  35549. * Will stop the animation of the given target
  35550. * @param target - the target
  35551. * @param animationName - the name of the animation to stop (all animations will be stopped if both this and targetMask are empty)
  35552. * @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)
  35553. */
  35554. stopAnimation(target: any, animationName?: string, targetMask?: (target: any) => boolean): void;
  35555. /**
  35556. * Removes the given animation group from this scene.
  35557. * @param toRemove The animation group to remove
  35558. * @returns The index of the removed animation group
  35559. */
  35560. removeAnimationGroup(toRemove: AnimationGroup): number;
  35561. /**
  35562. * Removes the given multi-material from this scene.
  35563. * @param toRemove The multi-material to remove
  35564. * @returns The index of the removed multi-material
  35565. */
  35566. removeMultiMaterial(toRemove: MultiMaterial): number;
  35567. /**
  35568. * Removes the given material from this scene.
  35569. * @param toRemove The material to remove
  35570. * @returns The index of the removed material
  35571. */
  35572. removeMaterial(toRemove: Material): number;
  35573. /**
  35574. * Removes the given action manager from this scene.
  35575. * @param toRemove The action manager to remove
  35576. * @returns The index of the removed action manager
  35577. */
  35578. removeActionManager(toRemove: AbstractActionManager): number;
  35579. /**
  35580. * Removes the given texture from this scene.
  35581. * @param toRemove The texture to remove
  35582. * @returns The index of the removed texture
  35583. */
  35584. removeTexture(toRemove: BaseTexture): number;
  35585. /**
  35586. * Adds the given light to this scene
  35587. * @param newLight The light to add
  35588. */
  35589. addLight(newLight: Light): void;
  35590. /**
  35591. * Sorts the list list based on light priorities
  35592. */
  35593. sortLightsByPriority(): void;
  35594. /**
  35595. * Adds the given camera to this scene
  35596. * @param newCamera The camera to add
  35597. */
  35598. addCamera(newCamera: Camera): void;
  35599. /**
  35600. * Adds the given skeleton to this scene
  35601. * @param newSkeleton The skeleton to add
  35602. */
  35603. addSkeleton(newSkeleton: Skeleton): void;
  35604. /**
  35605. * Adds the given particle system to this scene
  35606. * @param newParticleSystem The particle system to add
  35607. */
  35608. addParticleSystem(newParticleSystem: IParticleSystem): void;
  35609. /**
  35610. * Adds the given animation to this scene
  35611. * @param newAnimation The animation to add
  35612. */
  35613. addAnimation(newAnimation: Animation): void;
  35614. /**
  35615. * Adds the given animation group to this scene.
  35616. * @param newAnimationGroup The animation group to add
  35617. */
  35618. addAnimationGroup(newAnimationGroup: AnimationGroup): void;
  35619. /**
  35620. * Adds the given multi-material to this scene
  35621. * @param newMultiMaterial The multi-material to add
  35622. */
  35623. addMultiMaterial(newMultiMaterial: MultiMaterial): void;
  35624. /**
  35625. * Adds the given material to this scene
  35626. * @param newMaterial The material to add
  35627. */
  35628. addMaterial(newMaterial: Material): void;
  35629. /**
  35630. * Adds the given morph target to this scene
  35631. * @param newMorphTargetManager The morph target to add
  35632. */
  35633. addMorphTargetManager(newMorphTargetManager: MorphTargetManager): void;
  35634. /**
  35635. * Adds the given geometry to this scene
  35636. * @param newGeometry The geometry to add
  35637. */
  35638. addGeometry(newGeometry: Geometry): void;
  35639. /**
  35640. * Adds the given action manager to this scene
  35641. * @param newActionManager The action manager to add
  35642. */
  35643. addActionManager(newActionManager: AbstractActionManager): void;
  35644. /**
  35645. * Adds the given texture to this scene.
  35646. * @param newTexture The texture to add
  35647. */
  35648. addTexture(newTexture: BaseTexture): void;
  35649. /**
  35650. * Switch active camera
  35651. * @param newCamera defines the new active camera
  35652. * @param attachControl defines if attachControl must be called for the new active camera (default: true)
  35653. */
  35654. switchActiveCamera(newCamera: Camera, attachControl?: boolean): void;
  35655. /**
  35656. * sets the active camera of the scene using its ID
  35657. * @param id defines the camera's ID
  35658. * @return the new active camera or null if none found.
  35659. */
  35660. setActiveCameraByID(id: string): Nullable<Camera>;
  35661. /**
  35662. * sets the active camera of the scene using its name
  35663. * @param name defines the camera's name
  35664. * @returns the new active camera or null if none found.
  35665. */
  35666. setActiveCameraByName(name: string): Nullable<Camera>;
  35667. /**
  35668. * get an animation group using its name
  35669. * @param name defines the material's name
  35670. * @return the animation group or null if none found.
  35671. */
  35672. getAnimationGroupByName(name: string): Nullable<AnimationGroup>;
  35673. /**
  35674. * Get a material using its unique id
  35675. * @param uniqueId defines the material's unique id
  35676. * @return the material or null if none found.
  35677. */
  35678. getMaterialByUniqueID(uniqueId: number): Nullable<Material>;
  35679. /**
  35680. * get a material using its id
  35681. * @param id defines the material's ID
  35682. * @return the material or null if none found.
  35683. */
  35684. getMaterialByID(id: string): Nullable<Material>;
  35685. /**
  35686. * Gets a the last added material using a given id
  35687. * @param id defines the material's ID
  35688. * @return the last material with the given id or null if none found.
  35689. */
  35690. getLastMaterialByID(id: string): Nullable<Material>;
  35691. /**
  35692. * Gets a material using its name
  35693. * @param name defines the material's name
  35694. * @return the material or null if none found.
  35695. */
  35696. getMaterialByName(name: string): Nullable<Material>;
  35697. /**
  35698. * Get a texture using its unique id
  35699. * @param uniqueId defines the texture's unique id
  35700. * @return the texture or null if none found.
  35701. */
  35702. getTextureByUniqueID(uniqueId: number): Nullable<BaseTexture>;
  35703. /**
  35704. * Gets a camera using its id
  35705. * @param id defines the id to look for
  35706. * @returns the camera or null if not found
  35707. */
  35708. getCameraByID(id: string): Nullable<Camera>;
  35709. /**
  35710. * Gets a camera using its unique id
  35711. * @param uniqueId defines the unique id to look for
  35712. * @returns the camera or null if not found
  35713. */
  35714. getCameraByUniqueID(uniqueId: number): Nullable<Camera>;
  35715. /**
  35716. * Gets a camera using its name
  35717. * @param name defines the camera's name
  35718. * @return the camera or null if none found.
  35719. */
  35720. getCameraByName(name: string): Nullable<Camera>;
  35721. /**
  35722. * Gets a bone using its id
  35723. * @param id defines the bone's id
  35724. * @return the bone or null if not found
  35725. */
  35726. getBoneByID(id: string): Nullable<Bone>;
  35727. /**
  35728. * Gets a bone using its id
  35729. * @param name defines the bone's name
  35730. * @return the bone or null if not found
  35731. */
  35732. getBoneByName(name: string): Nullable<Bone>;
  35733. /**
  35734. * Gets a light node using its name
  35735. * @param name defines the the light's name
  35736. * @return the light or null if none found.
  35737. */
  35738. getLightByName(name: string): Nullable<Light>;
  35739. /**
  35740. * Gets a light node using its id
  35741. * @param id defines the light's id
  35742. * @return the light or null if none found.
  35743. */
  35744. getLightByID(id: string): Nullable<Light>;
  35745. /**
  35746. * Gets a light node using its scene-generated unique ID
  35747. * @param uniqueId defines the light's unique id
  35748. * @return the light or null if none found.
  35749. */
  35750. getLightByUniqueID(uniqueId: number): Nullable<Light>;
  35751. /**
  35752. * Gets a particle system by id
  35753. * @param id defines the particle system id
  35754. * @return the corresponding system or null if none found
  35755. */
  35756. getParticleSystemByID(id: string): Nullable<IParticleSystem>;
  35757. /**
  35758. * Gets a geometry using its ID
  35759. * @param id defines the geometry's id
  35760. * @return the geometry or null if none found.
  35761. */
  35762. getGeometryByID(id: string): Nullable<Geometry>;
  35763. private _getGeometryByUniqueID;
  35764. /**
  35765. * Add a new geometry to this scene
  35766. * @param geometry defines the geometry to be added to the scene.
  35767. * @param force defines if the geometry must be pushed even if a geometry with this id already exists
  35768. * @return a boolean defining if the geometry was added or not
  35769. */
  35770. pushGeometry(geometry: Geometry, force?: boolean): boolean;
  35771. /**
  35772. * Removes an existing geometry
  35773. * @param geometry defines the geometry to be removed from the scene
  35774. * @return a boolean defining if the geometry was removed or not
  35775. */
  35776. removeGeometry(geometry: Geometry): boolean;
  35777. /**
  35778. * Gets the list of geometries attached to the scene
  35779. * @returns an array of Geometry
  35780. */
  35781. getGeometries(): Geometry[];
  35782. /**
  35783. * Gets the first added mesh found of a given ID
  35784. * @param id defines the id to search for
  35785. * @return the mesh found or null if not found at all
  35786. */
  35787. getMeshByID(id: string): Nullable<AbstractMesh>;
  35788. /**
  35789. * Gets a list of meshes using their id
  35790. * @param id defines the id to search for
  35791. * @returns a list of meshes
  35792. */
  35793. getMeshesByID(id: string): Array<AbstractMesh>;
  35794. /**
  35795. * Gets the first added transform node found of a given ID
  35796. * @param id defines the id to search for
  35797. * @return the found transform node or null if not found at all.
  35798. */
  35799. getTransformNodeByID(id: string): Nullable<TransformNode>;
  35800. /**
  35801. * Gets a transform node with its auto-generated unique id
  35802. * @param uniqueId efines the unique id to search for
  35803. * @return the found transform node or null if not found at all.
  35804. */
  35805. getTransformNodeByUniqueID(uniqueId: number): Nullable<TransformNode>;
  35806. /**
  35807. * Gets a list of transform nodes using their id
  35808. * @param id defines the id to search for
  35809. * @returns a list of transform nodes
  35810. */
  35811. getTransformNodesByID(id: string): Array<TransformNode>;
  35812. /**
  35813. * Gets a mesh with its auto-generated unique id
  35814. * @param uniqueId defines the unique id to search for
  35815. * @return the found mesh or null if not found at all.
  35816. */
  35817. getMeshByUniqueID(uniqueId: number): Nullable<AbstractMesh>;
  35818. /**
  35819. * Gets a the last added mesh using a given id
  35820. * @param id defines the id to search for
  35821. * @return the found mesh or null if not found at all.
  35822. */
  35823. getLastMeshByID(id: string): Nullable<AbstractMesh>;
  35824. /**
  35825. * Gets a the last added node (Mesh, Camera, Light) using a given id
  35826. * @param id defines the id to search for
  35827. * @return the found node or null if not found at all
  35828. */
  35829. getLastEntryByID(id: string): Nullable<Node>;
  35830. /**
  35831. * Gets a node (Mesh, Camera, Light) using a given id
  35832. * @param id defines the id to search for
  35833. * @return the found node or null if not found at all
  35834. */
  35835. getNodeByID(id: string): Nullable<Node>;
  35836. /**
  35837. * Gets a node (Mesh, Camera, Light) using a given name
  35838. * @param name defines the name to search for
  35839. * @return the found node or null if not found at all.
  35840. */
  35841. getNodeByName(name: string): Nullable<Node>;
  35842. /**
  35843. * Gets a mesh using a given name
  35844. * @param name defines the name to search for
  35845. * @return the found mesh or null if not found at all.
  35846. */
  35847. getMeshByName(name: string): Nullable<AbstractMesh>;
  35848. /**
  35849. * Gets a transform node using a given name
  35850. * @param name defines the name to search for
  35851. * @return the found transform node or null if not found at all.
  35852. */
  35853. getTransformNodeByName(name: string): Nullable<TransformNode>;
  35854. /**
  35855. * Gets a skeleton using a given id (if many are found, this function will pick the last one)
  35856. * @param id defines the id to search for
  35857. * @return the found skeleton or null if not found at all.
  35858. */
  35859. getLastSkeletonByID(id: string): Nullable<Skeleton>;
  35860. /**
  35861. * Gets a skeleton using a given auto generated unique id
  35862. * @param uniqueId defines the unique id to search for
  35863. * @return the found skeleton or null if not found at all.
  35864. */
  35865. getSkeletonByUniqueId(uniqueId: number): Nullable<Skeleton>;
  35866. /**
  35867. * Gets a skeleton using a given id (if many are found, this function will pick the first one)
  35868. * @param id defines the id to search for
  35869. * @return the found skeleton or null if not found at all.
  35870. */
  35871. getSkeletonById(id: string): Nullable<Skeleton>;
  35872. /**
  35873. * Gets a skeleton using a given name
  35874. * @param name defines the name to search for
  35875. * @return the found skeleton or null if not found at all.
  35876. */
  35877. getSkeletonByName(name: string): Nullable<Skeleton>;
  35878. /**
  35879. * Gets a morph target manager using a given id (if many are found, this function will pick the last one)
  35880. * @param id defines the id to search for
  35881. * @return the found morph target manager or null if not found at all.
  35882. */
  35883. getMorphTargetManagerById(id: number): Nullable<MorphTargetManager>;
  35884. /**
  35885. * Gets a morph target using a given id (if many are found, this function will pick the first one)
  35886. * @param id defines the id to search for
  35887. * @return the found morph target or null if not found at all.
  35888. */
  35889. getMorphTargetById(id: string): Nullable<MorphTarget>;
  35890. /**
  35891. * Gets a boolean indicating if the given mesh is active
  35892. * @param mesh defines the mesh to look for
  35893. * @returns true if the mesh is in the active list
  35894. */
  35895. isActiveMesh(mesh: AbstractMesh): boolean;
  35896. /**
  35897. * Return a unique id as a string which can serve as an identifier for the scene
  35898. */
  35899. readonly uid: string;
  35900. /**
  35901. * Add an externaly attached data from its key.
  35902. * This method call will fail and return false, if such key already exists.
  35903. * If you don't care and just want to get the data no matter what, use the more convenient getOrAddExternalDataWithFactory() method.
  35904. * @param key the unique key that identifies the data
  35905. * @param data the data object to associate to the key for this Engine instance
  35906. * @return true if no such key were already present and the data was added successfully, false otherwise
  35907. */
  35908. addExternalData<T>(key: string, data: T): boolean;
  35909. /**
  35910. * Get an externaly attached data from its key
  35911. * @param key the unique key that identifies the data
  35912. * @return the associated data, if present (can be null), or undefined if not present
  35913. */
  35914. getExternalData<T>(key: string): Nullable<T>;
  35915. /**
  35916. * Get an externaly attached data from its key, create it using a factory if it's not already present
  35917. * @param key the unique key that identifies the data
  35918. * @param factory the factory that will be called to create the instance if and only if it doesn't exists
  35919. * @return the associated data, can be null if the factory returned null.
  35920. */
  35921. getOrAddExternalDataWithFactory<T>(key: string, factory: (k: string) => T): T;
  35922. /**
  35923. * Remove an externaly attached data from the Engine instance
  35924. * @param key the unique key that identifies the data
  35925. * @return true if the data was successfully removed, false if it doesn't exist
  35926. */
  35927. removeExternalData(key: string): boolean;
  35928. private _evaluateSubMesh;
  35929. /**
  35930. * Clear the processed materials smart array preventing retention point in material dispose.
  35931. */
  35932. freeProcessedMaterials(): void;
  35933. private _preventFreeActiveMeshesAndRenderingGroups;
  35934. /** Gets or sets a boolean blocking all the calls to freeActiveMeshes and freeRenderingGroups
  35935. * It can be used in order to prevent going through methods freeRenderingGroups and freeActiveMeshes several times to improve performance
  35936. * when disposing several meshes in a row or a hierarchy of meshes.
  35937. * When used, it is the responsability of the user to blockfreeActiveMeshesAndRenderingGroups back to false.
  35938. */
  35939. blockfreeActiveMeshesAndRenderingGroups: boolean;
  35940. /**
  35941. * Clear the active meshes smart array preventing retention point in mesh dispose.
  35942. */
  35943. freeActiveMeshes(): void;
  35944. /**
  35945. * Clear the info related to rendering groups preventing retention points during dispose.
  35946. */
  35947. freeRenderingGroups(): void;
  35948. /** @hidden */
  35949. _isInIntermediateRendering(): boolean;
  35950. /**
  35951. * Lambda returning the list of potentially active meshes.
  35952. */
  35953. getActiveMeshCandidates: () => ISmartArrayLike<AbstractMesh>;
  35954. /**
  35955. * Lambda returning the list of potentially active sub meshes.
  35956. */
  35957. getActiveSubMeshCandidates: (mesh: AbstractMesh) => ISmartArrayLike<SubMesh>;
  35958. /**
  35959. * Lambda returning the list of potentially intersecting sub meshes.
  35960. */
  35961. getIntersectingSubMeshCandidates: (mesh: AbstractMesh, localRay: Ray) => ISmartArrayLike<SubMesh>;
  35962. /**
  35963. * Lambda returning the list of potentially colliding sub meshes.
  35964. */
  35965. getCollidingSubMeshCandidates: (mesh: AbstractMesh, collider: Collider) => ISmartArrayLike<SubMesh>;
  35966. private _activeMeshesFrozen;
  35967. private _skipEvaluateActiveMeshesCompletely;
  35968. /**
  35969. * Use this function to stop evaluating active meshes. The current list will be keep alive between frames
  35970. * @param skipEvaluateActiveMeshes defines an optional boolean indicating that the evaluate active meshes step must be completely skipped
  35971. * @returns the current scene
  35972. */
  35973. freezeActiveMeshes(skipEvaluateActiveMeshes?: boolean): Scene;
  35974. /**
  35975. * Use this function to restart evaluating active meshes on every frame
  35976. * @returns the current scene
  35977. */
  35978. unfreezeActiveMeshes(): Scene;
  35979. private _evaluateActiveMeshes;
  35980. private _activeMesh;
  35981. /**
  35982. * Update the transform matrix to update from the current active camera
  35983. * @param force defines a boolean used to force the update even if cache is up to date
  35984. */
  35985. updateTransformMatrix(force?: boolean): void;
  35986. private _bindFrameBuffer;
  35987. /** @hidden */
  35988. _allowPostProcessClearColor: boolean;
  35989. /** @hidden */
  35990. _renderForCamera(camera: Camera, rigParent?: Camera): void;
  35991. private _processSubCameras;
  35992. private _checkIntersections;
  35993. /** @hidden */
  35994. _advancePhysicsEngineStep(step: number): void;
  35995. /**
  35996. * User updatable function that will return a deterministic frame time when engine is in deterministic lock step mode
  35997. */
  35998. getDeterministicFrameTime: () => number;
  35999. /** @hidden */
  36000. _animate(): void;
  36001. /** Execute all animations (for a frame) */
  36002. animate(): void;
  36003. /**
  36004. * Render the scene
  36005. * @param updateCameras defines a boolean indicating if cameras must update according to their inputs (true by default)
  36006. * @param ignoreAnimations defines a boolean indicating if animations should not be executed (false by default)
  36007. */
  36008. render(updateCameras?: boolean, ignoreAnimations?: boolean): void;
  36009. /**
  36010. * Freeze all materials
  36011. * A frozen material will not be updatable but should be faster to render
  36012. */
  36013. freezeMaterials(): void;
  36014. /**
  36015. * Unfreeze all materials
  36016. * A frozen material will not be updatable but should be faster to render
  36017. */
  36018. unfreezeMaterials(): void;
  36019. /**
  36020. * Releases all held ressources
  36021. */
  36022. dispose(): void;
  36023. /**
  36024. * Gets if the scene is already disposed
  36025. */
  36026. readonly isDisposed: boolean;
  36027. /**
  36028. * Call this function to reduce memory footprint of the scene.
  36029. * Vertex buffers will not store CPU data anymore (this will prevent picking, collisions or physics to work correctly)
  36030. */
  36031. clearCachedVertexData(): void;
  36032. /**
  36033. * This function will remove the local cached buffer data from texture.
  36034. * It will save memory but will prevent the texture from being rebuilt
  36035. */
  36036. cleanCachedTextureBuffer(): void;
  36037. /**
  36038. * Get the world extend vectors with an optional filter
  36039. *
  36040. * @param filterPredicate the predicate - which meshes should be included when calculating the world size
  36041. * @returns {{ min: Vector3; max: Vector3 }} min and max vectors
  36042. */
  36043. getWorldExtends(filterPredicate?: (mesh: AbstractMesh) => boolean): {
  36044. min: Vector3;
  36045. max: Vector3;
  36046. };
  36047. /**
  36048. * Creates a ray that can be used to pick in the scene
  36049. * @param x defines the x coordinate of the origin (on-screen)
  36050. * @param y defines the y coordinate of the origin (on-screen)
  36051. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  36052. * @param camera defines the camera to use for the picking
  36053. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  36054. * @returns a Ray
  36055. */
  36056. createPickingRay(x: number, y: number, world: Matrix, camera: Nullable<Camera>, cameraViewSpace?: boolean): Ray;
  36057. /**
  36058. * Creates a ray that can be used to pick in the scene
  36059. * @param x defines the x coordinate of the origin (on-screen)
  36060. * @param y defines the y coordinate of the origin (on-screen)
  36061. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  36062. * @param result defines the ray where to store the picking ray
  36063. * @param camera defines the camera to use for the picking
  36064. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  36065. * @returns the current scene
  36066. */
  36067. createPickingRayToRef(x: number, y: number, world: Matrix, result: Ray, camera: Nullable<Camera>, cameraViewSpace?: boolean): Scene;
  36068. /**
  36069. * Creates a ray that can be used to pick in the scene
  36070. * @param x defines the x coordinate of the origin (on-screen)
  36071. * @param y defines the y coordinate of the origin (on-screen)
  36072. * @param camera defines the camera to use for the picking
  36073. * @returns a Ray
  36074. */
  36075. createPickingRayInCameraSpace(x: number, y: number, camera?: Camera): Ray;
  36076. /**
  36077. * Creates a ray that can be used to pick in the scene
  36078. * @param x defines the x coordinate of the origin (on-screen)
  36079. * @param y defines the y coordinate of the origin (on-screen)
  36080. * @param result defines the ray where to store the picking ray
  36081. * @param camera defines the camera to use for the picking
  36082. * @returns the current scene
  36083. */
  36084. createPickingRayInCameraSpaceToRef(x: number, y: number, result: Ray, camera?: Camera): Scene;
  36085. /** Launch a ray to try to pick a mesh in the scene
  36086. * @param x position on screen
  36087. * @param y position on screen
  36088. * @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
  36089. * @param fastCheck Launch a fast check only using the bounding boxes. Can be set to null.
  36090. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  36091. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  36092. * @returns a PickingInfo
  36093. */
  36094. pick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  36095. /** Use the given ray to pick a mesh in the scene
  36096. * @param ray The ray to use to pick meshes
  36097. * @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
  36098. * @param fastCheck Launch a fast check only using the bounding boxes. Can be set to null
  36099. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  36100. * @returns a PickingInfo
  36101. */
  36102. pickWithRay(ray: Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  36103. /**
  36104. * Launch a ray to try to pick a mesh in the scene
  36105. * @param x X position on screen
  36106. * @param y Y position on screen
  36107. * @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
  36108. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  36109. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  36110. * @returns an array of PickingInfo
  36111. */
  36112. multiPick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, camera?: Camera, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  36113. /**
  36114. * Launch a ray to try to pick a mesh in the scene
  36115. * @param ray Ray to use
  36116. * @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
  36117. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  36118. * @returns an array of PickingInfo
  36119. */
  36120. multiPickWithRay(ray: Ray, predicate: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  36121. /**
  36122. * Force the value of meshUnderPointer
  36123. * @param mesh defines the mesh to use
  36124. */
  36125. setPointerOverMesh(mesh: Nullable<AbstractMesh>): void;
  36126. /**
  36127. * Gets the mesh under the pointer
  36128. * @returns a Mesh or null if no mesh is under the pointer
  36129. */
  36130. getPointerOverMesh(): Nullable<AbstractMesh>;
  36131. /** @hidden */
  36132. _rebuildGeometries(): void;
  36133. /** @hidden */
  36134. _rebuildTextures(): void;
  36135. private _getByTags;
  36136. /**
  36137. * Get a list of meshes by tags
  36138. * @param tagsQuery defines the tags query to use
  36139. * @param forEach defines a predicate used to filter results
  36140. * @returns an array of Mesh
  36141. */
  36142. getMeshesByTags(tagsQuery: string, forEach?: (mesh: AbstractMesh) => void): Mesh[];
  36143. /**
  36144. * Get a list of cameras by tags
  36145. * @param tagsQuery defines the tags query to use
  36146. * @param forEach defines a predicate used to filter results
  36147. * @returns an array of Camera
  36148. */
  36149. getCamerasByTags(tagsQuery: string, forEach?: (camera: Camera) => void): Camera[];
  36150. /**
  36151. * Get a list of lights by tags
  36152. * @param tagsQuery defines the tags query to use
  36153. * @param forEach defines a predicate used to filter results
  36154. * @returns an array of Light
  36155. */
  36156. getLightsByTags(tagsQuery: string, forEach?: (light: Light) => void): Light[];
  36157. /**
  36158. * Get a list of materials by tags
  36159. * @param tagsQuery defines the tags query to use
  36160. * @param forEach defines a predicate used to filter results
  36161. * @returns an array of Material
  36162. */
  36163. getMaterialByTags(tagsQuery: string, forEach?: (material: Material) => void): Material[];
  36164. /**
  36165. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  36166. * This allowed control for front to back rendering or reversly depending of the special needs.
  36167. *
  36168. * @param renderingGroupId The rendering group id corresponding to its index
  36169. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  36170. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  36171. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  36172. */
  36173. 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;
  36174. /**
  36175. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  36176. *
  36177. * @param renderingGroupId The rendering group id corresponding to its index
  36178. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  36179. * @param depth Automatically clears depth between groups if true and autoClear is true.
  36180. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  36181. */
  36182. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  36183. /**
  36184. * Gets the current auto clear configuration for one rendering group of the rendering
  36185. * manager.
  36186. * @param index the rendering group index to get the information for
  36187. * @returns The auto clear setup for the requested rendering group
  36188. */
  36189. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  36190. private _blockMaterialDirtyMechanism;
  36191. /** Gets or sets a boolean blocking all the calls to markAllMaterialsAsDirty (ie. the materials won't be updated if they are out of sync) */
  36192. blockMaterialDirtyMechanism: boolean;
  36193. /**
  36194. * Will flag all materials as dirty to trigger new shader compilation
  36195. * @param flag defines the flag used to specify which material part must be marked as dirty
  36196. * @param predicate If not null, it will be used to specifiy if a material has to be marked as dirty
  36197. */
  36198. markAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  36199. /** @hidden */
  36200. _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;
  36201. /** @hidden */
  36202. _loadFileAsync(url: string, onProgress?: (data: any) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  36203. /** @hidden */
  36204. _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;
  36205. /** @hidden */
  36206. _requestFileAsync(url: string, onProgress?: (ev: ProgressEvent) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean, onOpened?: (request: WebRequest) => void): Promise<string | ArrayBuffer>;
  36207. /** @hidden */
  36208. _readFile(file: File, onSuccess: (data: string | ArrayBuffer) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  36209. /** @hidden */
  36210. _readFileAsync(file: File, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  36211. }
  36212. }
  36213. declare module "babylonjs/assetContainer" {
  36214. import { AbstractScene } from "babylonjs/abstractScene";
  36215. import { Scene } from "babylonjs/scene";
  36216. import { Mesh } from "babylonjs/Meshes/mesh";
  36217. import { TransformNode } from "babylonjs/Meshes/transformNode";
  36218. import { Skeleton } from "babylonjs/Bones/skeleton";
  36219. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  36220. /**
  36221. * Set of assets to keep when moving a scene into an asset container.
  36222. */
  36223. export class KeepAssets extends AbstractScene {
  36224. }
  36225. /**
  36226. * Class used to store the output of the AssetContainer.instantiateAllMeshesToScene function
  36227. */
  36228. export class InstantiatedEntries {
  36229. /**
  36230. * List of new root nodes (eg. nodes with no parent)
  36231. */
  36232. rootNodes: TransformNode[];
  36233. /**
  36234. * List of new skeletons
  36235. */
  36236. skeletons: Skeleton[];
  36237. /**
  36238. * List of new animation groups
  36239. */
  36240. animationGroups: AnimationGroup[];
  36241. }
  36242. /**
  36243. * Container with a set of assets that can be added or removed from a scene.
  36244. */
  36245. export class AssetContainer extends AbstractScene {
  36246. /**
  36247. * The scene the AssetContainer belongs to.
  36248. */
  36249. scene: Scene;
  36250. /**
  36251. * Instantiates an AssetContainer.
  36252. * @param scene The scene the AssetContainer belongs to.
  36253. */
  36254. constructor(scene: Scene);
  36255. /**
  36256. * Instantiate or clone all meshes and add the new ones to the scene.
  36257. * Skeletons and animation groups will all be cloned
  36258. * @param nameFunction defines an optional function used to get new names for clones
  36259. * @param cloneMaterials defines an optional boolean that defines if materials must be cloned as well (false by default)
  36260. * @returns a list of rootNodes, skeletons and aniamtion groups that were duplicated
  36261. */
  36262. instantiateModelsToScene(nameFunction?: (sourceName: string) => string, cloneMaterials?: boolean): InstantiatedEntries;
  36263. /**
  36264. * Adds all the assets from the container to the scene.
  36265. */
  36266. addAllToScene(): void;
  36267. /**
  36268. * Removes all the assets in the container from the scene
  36269. */
  36270. removeAllFromScene(): void;
  36271. /**
  36272. * Disposes all the assets in the container
  36273. */
  36274. dispose(): void;
  36275. private _moveAssets;
  36276. /**
  36277. * Removes all the assets contained in the scene and adds them to the container.
  36278. * @param keepAssets Set of assets to keep in the scene. (default: empty)
  36279. */
  36280. moveAllFromScene(keepAssets?: KeepAssets): void;
  36281. /**
  36282. * 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.
  36283. * @returns the root mesh
  36284. */
  36285. createRootMesh(): Mesh;
  36286. }
  36287. }
  36288. declare module "babylonjs/abstractScene" {
  36289. import { Scene } from "babylonjs/scene";
  36290. import { Nullable } from "babylonjs/types";
  36291. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  36292. import { TransformNode } from "babylonjs/Meshes/transformNode";
  36293. import { Geometry } from "babylonjs/Meshes/geometry";
  36294. import { Skeleton } from "babylonjs/Bones/skeleton";
  36295. import { MorphTargetManager } from "babylonjs/Morph/morphTargetManager";
  36296. import { AssetContainer } from "babylonjs/assetContainer";
  36297. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  36298. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  36299. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  36300. import { Material } from "babylonjs/Materials/material";
  36301. import { MultiMaterial } from "babylonjs/Materials/multiMaterial";
  36302. import { AbstractActionManager } from "babylonjs/Actions/abstractActionManager";
  36303. import { Camera } from "babylonjs/Cameras/camera";
  36304. import { Light } from "babylonjs/Lights/light";
  36305. import { Node } from "babylonjs/node";
  36306. import { Animation } from "babylonjs/Animations/animation";
  36307. /**
  36308. * Defines how the parser contract is defined.
  36309. * These parsers are used to parse a list of specific assets (like particle systems, etc..)
  36310. */
  36311. export type BabylonFileParser = (parsedData: any, scene: Scene, container: AssetContainer, rootUrl: string) => void;
  36312. /**
  36313. * Defines how the individual parser contract is defined.
  36314. * These parser can parse an individual asset
  36315. */
  36316. export type IndividualBabylonFileParser = (parsedData: any, scene: Scene, rootUrl: string) => any;
  36317. /**
  36318. * Base class of the scene acting as a container for the different elements composing a scene.
  36319. * This class is dynamically extended by the different components of the scene increasing
  36320. * flexibility and reducing coupling
  36321. */
  36322. export abstract class AbstractScene {
  36323. /**
  36324. * Stores the list of available parsers in the application.
  36325. */
  36326. private static _BabylonFileParsers;
  36327. /**
  36328. * Stores the list of available individual parsers in the application.
  36329. */
  36330. private static _IndividualBabylonFileParsers;
  36331. /**
  36332. * Adds a parser in the list of available ones
  36333. * @param name Defines the name of the parser
  36334. * @param parser Defines the parser to add
  36335. */
  36336. static AddParser(name: string, parser: BabylonFileParser): void;
  36337. /**
  36338. * Gets a general parser from the list of avaialble ones
  36339. * @param name Defines the name of the parser
  36340. * @returns the requested parser or null
  36341. */
  36342. static GetParser(name: string): Nullable<BabylonFileParser>;
  36343. /**
  36344. * Adds n individual parser in the list of available ones
  36345. * @param name Defines the name of the parser
  36346. * @param parser Defines the parser to add
  36347. */
  36348. static AddIndividualParser(name: string, parser: IndividualBabylonFileParser): void;
  36349. /**
  36350. * Gets an individual parser from the list of avaialble ones
  36351. * @param name Defines the name of the parser
  36352. * @returns the requested parser or null
  36353. */
  36354. static GetIndividualParser(name: string): Nullable<IndividualBabylonFileParser>;
  36355. /**
  36356. * Parser json data and populate both a scene and its associated container object
  36357. * @param jsonData Defines the data to parse
  36358. * @param scene Defines the scene to parse the data for
  36359. * @param container Defines the container attached to the parsing sequence
  36360. * @param rootUrl Defines the root url of the data
  36361. */
  36362. static Parse(jsonData: any, scene: Scene, container: AssetContainer, rootUrl: string): void;
  36363. /**
  36364. * Gets the list of root nodes (ie. nodes with no parent)
  36365. */
  36366. rootNodes: Node[];
  36367. /** All of the cameras added to this scene
  36368. * @see http://doc.babylonjs.com/babylon101/cameras
  36369. */
  36370. cameras: Camera[];
  36371. /**
  36372. * All of the lights added to this scene
  36373. * @see http://doc.babylonjs.com/babylon101/lights
  36374. */
  36375. lights: Light[];
  36376. /**
  36377. * All of the (abstract) meshes added to this scene
  36378. */
  36379. meshes: AbstractMesh[];
  36380. /**
  36381. * The list of skeletons added to the scene
  36382. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  36383. */
  36384. skeletons: Skeleton[];
  36385. /**
  36386. * All of the particle systems added to this scene
  36387. * @see http://doc.babylonjs.com/babylon101/particles
  36388. */
  36389. particleSystems: IParticleSystem[];
  36390. /**
  36391. * Gets a list of Animations associated with the scene
  36392. */
  36393. animations: Animation[];
  36394. /**
  36395. * All of the animation groups added to this scene
  36396. * @see http://doc.babylonjs.com/how_to/group
  36397. */
  36398. animationGroups: AnimationGroup[];
  36399. /**
  36400. * All of the multi-materials added to this scene
  36401. * @see http://doc.babylonjs.com/how_to/multi_materials
  36402. */
  36403. multiMaterials: MultiMaterial[];
  36404. /**
  36405. * All of the materials added to this scene
  36406. * In the context of a Scene, it is not supposed to be modified manually.
  36407. * Any addition or removal should be done using the addMaterial and removeMaterial Scene methods.
  36408. * Note also that the order of the Material within the array is not significant and might change.
  36409. * @see http://doc.babylonjs.com/babylon101/materials
  36410. */
  36411. materials: Material[];
  36412. /**
  36413. * The list of morph target managers added to the scene
  36414. * @see http://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh
  36415. */
  36416. morphTargetManagers: MorphTargetManager[];
  36417. /**
  36418. * The list of geometries used in the scene.
  36419. */
  36420. geometries: Geometry[];
  36421. /**
  36422. * All of the tranform nodes added to this scene
  36423. * In the context of a Scene, it is not supposed to be modified manually.
  36424. * Any addition or removal should be done using the addTransformNode and removeTransformNode Scene methods.
  36425. * Note also that the order of the TransformNode wihin the array is not significant and might change.
  36426. * @see http://doc.babylonjs.com/how_to/transformnode
  36427. */
  36428. transformNodes: TransformNode[];
  36429. /**
  36430. * ActionManagers available on the scene.
  36431. */
  36432. actionManagers: AbstractActionManager[];
  36433. /**
  36434. * Textures to keep.
  36435. */
  36436. textures: BaseTexture[];
  36437. /**
  36438. * Environment texture for the scene
  36439. */
  36440. environmentTexture: Nullable<BaseTexture>;
  36441. }
  36442. }
  36443. declare module "babylonjs/Audio/sound" {
  36444. import { Observable } from "babylonjs/Misc/observable";
  36445. import { Vector3 } from "babylonjs/Maths/math.vector";
  36446. import { Nullable } from "babylonjs/types";
  36447. import { Scene } from "babylonjs/scene";
  36448. import { TransformNode } from "babylonjs/Meshes/transformNode";
  36449. /**
  36450. * Interface used to define options for Sound class
  36451. */
  36452. export interface ISoundOptions {
  36453. /**
  36454. * Does the sound autoplay once loaded.
  36455. */
  36456. autoplay?: boolean;
  36457. /**
  36458. * Does the sound loop after it finishes playing once.
  36459. */
  36460. loop?: boolean;
  36461. /**
  36462. * Sound's volume
  36463. */
  36464. volume?: number;
  36465. /**
  36466. * Is it a spatial sound?
  36467. */
  36468. spatialSound?: boolean;
  36469. /**
  36470. * Maximum distance to hear that sound
  36471. */
  36472. maxDistance?: number;
  36473. /**
  36474. * Uses user defined attenuation function
  36475. */
  36476. useCustomAttenuation?: boolean;
  36477. /**
  36478. * Define the roll off factor of spatial sounds.
  36479. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  36480. */
  36481. rolloffFactor?: number;
  36482. /**
  36483. * Define the reference distance the sound should be heard perfectly.
  36484. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  36485. */
  36486. refDistance?: number;
  36487. /**
  36488. * Define the distance attenuation model the sound will follow.
  36489. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  36490. */
  36491. distanceModel?: string;
  36492. /**
  36493. * Defines the playback speed (1 by default)
  36494. */
  36495. playbackRate?: number;
  36496. /**
  36497. * Defines if the sound is from a streaming source
  36498. */
  36499. streaming?: boolean;
  36500. /**
  36501. * Defines an optional length (in seconds) inside the sound file
  36502. */
  36503. length?: number;
  36504. /**
  36505. * Defines an optional offset (in seconds) inside the sound file
  36506. */
  36507. offset?: number;
  36508. /**
  36509. * If true, URLs will not be required to state the audio file codec to use.
  36510. */
  36511. skipCodecCheck?: boolean;
  36512. }
  36513. /**
  36514. * Defines a sound that can be played in the application.
  36515. * The sound can either be an ambient track or a simple sound played in reaction to a user action.
  36516. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  36517. */
  36518. export class Sound {
  36519. /**
  36520. * The name of the sound in the scene.
  36521. */
  36522. name: string;
  36523. /**
  36524. * Does the sound autoplay once loaded.
  36525. */
  36526. autoplay: boolean;
  36527. /**
  36528. * Does the sound loop after it finishes playing once.
  36529. */
  36530. loop: boolean;
  36531. /**
  36532. * Does the sound use a custom attenuation curve to simulate the falloff
  36533. * happening when the source gets further away from the camera.
  36534. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  36535. */
  36536. useCustomAttenuation: boolean;
  36537. /**
  36538. * The sound track id this sound belongs to.
  36539. */
  36540. soundTrackId: number;
  36541. /**
  36542. * Is this sound currently played.
  36543. */
  36544. isPlaying: boolean;
  36545. /**
  36546. * Is this sound currently paused.
  36547. */
  36548. isPaused: boolean;
  36549. /**
  36550. * Does this sound enables spatial sound.
  36551. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  36552. */
  36553. spatialSound: boolean;
  36554. /**
  36555. * Define the reference distance the sound should be heard perfectly.
  36556. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  36557. */
  36558. refDistance: number;
  36559. /**
  36560. * Define the roll off factor of spatial sounds.
  36561. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  36562. */
  36563. rolloffFactor: number;
  36564. /**
  36565. * Define the max distance the sound should be heard (intensity just became 0 at this point).
  36566. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  36567. */
  36568. maxDistance: number;
  36569. /**
  36570. * Define the distance attenuation model the sound will follow.
  36571. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  36572. */
  36573. distanceModel: string;
  36574. /**
  36575. * @hidden
  36576. * Back Compat
  36577. **/
  36578. onended: () => any;
  36579. /**
  36580. * Observable event when the current playing sound finishes.
  36581. */
  36582. onEndedObservable: Observable<Sound>;
  36583. private _panningModel;
  36584. private _playbackRate;
  36585. private _streaming;
  36586. private _startTime;
  36587. private _startOffset;
  36588. private _position;
  36589. /** @hidden */
  36590. _positionInEmitterSpace: boolean;
  36591. private _localDirection;
  36592. private _volume;
  36593. private _isReadyToPlay;
  36594. private _isDirectional;
  36595. private _readyToPlayCallback;
  36596. private _audioBuffer;
  36597. private _soundSource;
  36598. private _streamingSource;
  36599. private _soundPanner;
  36600. private _soundGain;
  36601. private _inputAudioNode;
  36602. private _outputAudioNode;
  36603. private _coneInnerAngle;
  36604. private _coneOuterAngle;
  36605. private _coneOuterGain;
  36606. private _scene;
  36607. private _connectedTransformNode;
  36608. private _customAttenuationFunction;
  36609. private _registerFunc;
  36610. private _isOutputConnected;
  36611. private _htmlAudioElement;
  36612. private _urlType;
  36613. private _length?;
  36614. private _offset?;
  36615. /** @hidden */
  36616. static _SceneComponentInitialization: (scene: Scene) => void;
  36617. /**
  36618. * Create a sound and attach it to a scene
  36619. * @param name Name of your sound
  36620. * @param urlOrArrayBuffer Url to the sound to load async or ArrayBuffer, it also works with MediaStreams
  36621. * @param scene defines the scene the sound belongs to
  36622. * @param readyToPlayCallback Provide a callback function if you'd like to load your code once the sound is ready to be played
  36623. * @param options Objects to provide with the current available options: autoplay, loop, volume, spatialSound, maxDistance, rolloffFactor, refDistance, distanceModel, panningModel, streaming
  36624. */
  36625. constructor(name: string, urlOrArrayBuffer: any, scene: Scene, readyToPlayCallback?: Nullable<() => void>, options?: ISoundOptions);
  36626. /**
  36627. * Release the sound and its associated resources
  36628. */
  36629. dispose(): void;
  36630. /**
  36631. * Gets if the sounds is ready to be played or not.
  36632. * @returns true if ready, otherwise false
  36633. */
  36634. isReady(): boolean;
  36635. private _soundLoaded;
  36636. /**
  36637. * Sets the data of the sound from an audiobuffer
  36638. * @param audioBuffer The audioBuffer containing the data
  36639. */
  36640. setAudioBuffer(audioBuffer: AudioBuffer): void;
  36641. /**
  36642. * Updates the current sounds options such as maxdistance, loop...
  36643. * @param options A JSON object containing values named as the object properties
  36644. */
  36645. updateOptions(options: ISoundOptions): void;
  36646. private _createSpatialParameters;
  36647. private _updateSpatialParameters;
  36648. /**
  36649. * Switch the panning model to HRTF:
  36650. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  36651. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  36652. */
  36653. switchPanningModelToHRTF(): void;
  36654. /**
  36655. * Switch the panning model to Equal Power:
  36656. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  36657. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  36658. */
  36659. switchPanningModelToEqualPower(): void;
  36660. private _switchPanningModel;
  36661. /**
  36662. * Connect this sound to a sound track audio node like gain...
  36663. * @param soundTrackAudioNode the sound track audio node to connect to
  36664. */
  36665. connectToSoundTrackAudioNode(soundTrackAudioNode: AudioNode): void;
  36666. /**
  36667. * Transform this sound into a directional source
  36668. * @param coneInnerAngle Size of the inner cone in degree
  36669. * @param coneOuterAngle Size of the outer cone in degree
  36670. * @param coneOuterGain Volume of the sound outside the outer cone (between 0.0 and 1.0)
  36671. */
  36672. setDirectionalCone(coneInnerAngle: number, coneOuterAngle: number, coneOuterGain: number): void;
  36673. /**
  36674. * Gets or sets the inner angle for the directional cone.
  36675. */
  36676. /**
  36677. * Gets or sets the inner angle for the directional cone.
  36678. */
  36679. directionalConeInnerAngle: number;
  36680. /**
  36681. * Gets or sets the outer angle for the directional cone.
  36682. */
  36683. /**
  36684. * Gets or sets the outer angle for the directional cone.
  36685. */
  36686. directionalConeOuterAngle: number;
  36687. /**
  36688. * Sets the position of the emitter if spatial sound is enabled
  36689. * @param newPosition Defines the new posisiton
  36690. */
  36691. setPosition(newPosition: Vector3): void;
  36692. /**
  36693. * Sets the local direction of the emitter if spatial sound is enabled
  36694. * @param newLocalDirection Defines the new local direction
  36695. */
  36696. setLocalDirectionToMesh(newLocalDirection: Vector3): void;
  36697. private _updateDirection;
  36698. /** @hidden */
  36699. updateDistanceFromListener(): void;
  36700. /**
  36701. * Sets a new custom attenuation function for the sound.
  36702. * @param callback Defines the function used for the attenuation
  36703. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  36704. */
  36705. setAttenuationFunction(callback: (currentVolume: number, currentDistance: number, maxDistance: number, refDistance: number, rolloffFactor: number) => number): void;
  36706. /**
  36707. * Play the sound
  36708. * @param time (optional) Start the sound after X seconds. Start immediately (0) by default.
  36709. * @param offset (optional) Start the sound at a specific time in seconds
  36710. * @param length (optional) Sound duration (in seconds)
  36711. */
  36712. play(time?: number, offset?: number, length?: number): void;
  36713. private _onended;
  36714. /**
  36715. * Stop the sound
  36716. * @param time (optional) Stop the sound after X seconds. Stop immediately (0) by default.
  36717. */
  36718. stop(time?: number): void;
  36719. /**
  36720. * Put the sound in pause
  36721. */
  36722. pause(): void;
  36723. /**
  36724. * Sets a dedicated volume for this sounds
  36725. * @param newVolume Define the new volume of the sound
  36726. * @param time Define time for gradual change to new volume
  36727. */
  36728. setVolume(newVolume: number, time?: number): void;
  36729. /**
  36730. * Set the sound play back rate
  36731. * @param newPlaybackRate Define the playback rate the sound should be played at
  36732. */
  36733. setPlaybackRate(newPlaybackRate: number): void;
  36734. /**
  36735. * Gets the volume of the sound.
  36736. * @returns the volume of the sound
  36737. */
  36738. getVolume(): number;
  36739. /**
  36740. * Attach the sound to a dedicated mesh
  36741. * @param transformNode The transform node to connect the sound with
  36742. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  36743. */
  36744. attachToMesh(transformNode: TransformNode): void;
  36745. /**
  36746. * Detach the sound from the previously attached mesh
  36747. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  36748. */
  36749. detachFromMesh(): void;
  36750. private _onRegisterAfterWorldMatrixUpdate;
  36751. /**
  36752. * Clone the current sound in the scene.
  36753. * @returns the new sound clone
  36754. */
  36755. clone(): Nullable<Sound>;
  36756. /**
  36757. * Gets the current underlying audio buffer containing the data
  36758. * @returns the audio buffer
  36759. */
  36760. getAudioBuffer(): Nullable<AudioBuffer>;
  36761. /**
  36762. * Serializes the Sound in a JSON representation
  36763. * @returns the JSON representation of the sound
  36764. */
  36765. serialize(): any;
  36766. /**
  36767. * Parse a JSON representation of a sound to innstantiate in a given scene
  36768. * @param parsedSound Define the JSON representation of the sound (usually coming from the serialize method)
  36769. * @param scene Define the scene the new parsed sound should be created in
  36770. * @param rootUrl Define the rooturl of the load in case we need to fetch relative dependencies
  36771. * @param sourceSound Define a cound place holder if do not need to instantiate a new one
  36772. * @returns the newly parsed sound
  36773. */
  36774. static Parse(parsedSound: any, scene: Scene, rootUrl: string, sourceSound?: Sound): Sound;
  36775. }
  36776. }
  36777. declare module "babylonjs/Actions/directAudioActions" {
  36778. import { Action } from "babylonjs/Actions/action";
  36779. import { Condition } from "babylonjs/Actions/condition";
  36780. import { Sound } from "babylonjs/Audio/sound";
  36781. /**
  36782. * This defines an action helpful to play a defined sound on a triggered action.
  36783. */
  36784. export class PlaySoundAction extends Action {
  36785. private _sound;
  36786. /**
  36787. * Instantiate the action
  36788. * @param triggerOptions defines the trigger options
  36789. * @param sound defines the sound to play
  36790. * @param condition defines the trigger related conditions
  36791. */
  36792. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  36793. /** @hidden */
  36794. _prepare(): void;
  36795. /**
  36796. * Execute the action and play the sound.
  36797. */
  36798. execute(): void;
  36799. /**
  36800. * Serializes the actions and its related information.
  36801. * @param parent defines the object to serialize in
  36802. * @returns the serialized object
  36803. */
  36804. serialize(parent: any): any;
  36805. }
  36806. /**
  36807. * This defines an action helpful to stop a defined sound on a triggered action.
  36808. */
  36809. export class StopSoundAction extends Action {
  36810. private _sound;
  36811. /**
  36812. * Instantiate the action
  36813. * @param triggerOptions defines the trigger options
  36814. * @param sound defines the sound to stop
  36815. * @param condition defines the trigger related conditions
  36816. */
  36817. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  36818. /** @hidden */
  36819. _prepare(): void;
  36820. /**
  36821. * Execute the action and stop the sound.
  36822. */
  36823. execute(): void;
  36824. /**
  36825. * Serializes the actions and its related information.
  36826. * @param parent defines the object to serialize in
  36827. * @returns the serialized object
  36828. */
  36829. serialize(parent: any): any;
  36830. }
  36831. }
  36832. declare module "babylonjs/Actions/interpolateValueAction" {
  36833. import { Action } from "babylonjs/Actions/action";
  36834. import { Condition } from "babylonjs/Actions/condition";
  36835. import { Observable } from "babylonjs/Misc/observable";
  36836. /**
  36837. * This defines an action responsible to change the value of a property
  36838. * by interpolating between its current value and the newly set one once triggered.
  36839. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  36840. */
  36841. export class InterpolateValueAction extends Action {
  36842. /**
  36843. * Defines the path of the property where the value should be interpolated
  36844. */
  36845. propertyPath: string;
  36846. /**
  36847. * Defines the target value at the end of the interpolation.
  36848. */
  36849. value: any;
  36850. /**
  36851. * Defines the time it will take for the property to interpolate to the value.
  36852. */
  36853. duration: number;
  36854. /**
  36855. * Defines if the other scene animations should be stopped when the action has been triggered
  36856. */
  36857. stopOtherAnimations?: boolean;
  36858. /**
  36859. * Defines a callback raised once the interpolation animation has been done.
  36860. */
  36861. onInterpolationDone?: () => void;
  36862. /**
  36863. * Observable triggered once the interpolation animation has been done.
  36864. */
  36865. onInterpolationDoneObservable: Observable<InterpolateValueAction>;
  36866. private _target;
  36867. private _effectiveTarget;
  36868. private _property;
  36869. /**
  36870. * Instantiate the action
  36871. * @param triggerOptions defines the trigger options
  36872. * @param target defines the object containing the value to interpolate
  36873. * @param propertyPath defines the path to the property in the target object
  36874. * @param value defines the target value at the end of the interpolation
  36875. * @param duration deines the time it will take for the property to interpolate to the value.
  36876. * @param condition defines the trigger related conditions
  36877. * @param stopOtherAnimations defines if the other scene animations should be stopped when the action has been triggered
  36878. * @param onInterpolationDone defines a callback raised once the interpolation animation has been done
  36879. */
  36880. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, duration?: number, condition?: Condition, stopOtherAnimations?: boolean, onInterpolationDone?: () => void);
  36881. /** @hidden */
  36882. _prepare(): void;
  36883. /**
  36884. * Execute the action starts the value interpolation.
  36885. */
  36886. execute(): void;
  36887. /**
  36888. * Serializes the actions and its related information.
  36889. * @param parent defines the object to serialize in
  36890. * @returns the serialized object
  36891. */
  36892. serialize(parent: any): any;
  36893. }
  36894. }
  36895. declare module "babylonjs/Actions/index" {
  36896. export * from "babylonjs/Actions/abstractActionManager";
  36897. export * from "babylonjs/Actions/action";
  36898. export * from "babylonjs/Actions/actionEvent";
  36899. export * from "babylonjs/Actions/actionManager";
  36900. export * from "babylonjs/Actions/condition";
  36901. export * from "babylonjs/Actions/directActions";
  36902. export * from "babylonjs/Actions/directAudioActions";
  36903. export * from "babylonjs/Actions/interpolateValueAction";
  36904. }
  36905. declare module "babylonjs/Animations/index" {
  36906. export * from "babylonjs/Animations/animatable";
  36907. export * from "babylonjs/Animations/animation";
  36908. export * from "babylonjs/Animations/animationGroup";
  36909. export * from "babylonjs/Animations/animationPropertiesOverride";
  36910. export * from "babylonjs/Animations/easing";
  36911. export * from "babylonjs/Animations/runtimeAnimation";
  36912. export * from "babylonjs/Animations/animationEvent";
  36913. export * from "babylonjs/Animations/animationGroup";
  36914. export * from "babylonjs/Animations/animationKey";
  36915. export * from "babylonjs/Animations/animationRange";
  36916. export * from "babylonjs/Animations/animatable.interface";
  36917. }
  36918. declare module "babylonjs/Audio/soundTrack" {
  36919. import { Sound } from "babylonjs/Audio/sound";
  36920. import { Analyser } from "babylonjs/Audio/analyser";
  36921. import { Scene } from "babylonjs/scene";
  36922. /**
  36923. * Options allowed during the creation of a sound track.
  36924. */
  36925. export interface ISoundTrackOptions {
  36926. /**
  36927. * The volume the sound track should take during creation
  36928. */
  36929. volume?: number;
  36930. /**
  36931. * Define if the sound track is the main sound track of the scene
  36932. */
  36933. mainTrack?: boolean;
  36934. }
  36935. /**
  36936. * It could be useful to isolate your music & sounds on several tracks to better manage volume on a grouped instance of sounds.
  36937. * It will be also used in a future release to apply effects on a specific track.
  36938. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  36939. */
  36940. export class SoundTrack {
  36941. /**
  36942. * The unique identifier of the sound track in the scene.
  36943. */
  36944. id: number;
  36945. /**
  36946. * The list of sounds included in the sound track.
  36947. */
  36948. soundCollection: Array<Sound>;
  36949. private _outputAudioNode;
  36950. private _scene;
  36951. private _connectedAnalyser;
  36952. private _options;
  36953. private _isInitialized;
  36954. /**
  36955. * Creates a new sound track.
  36956. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  36957. * @param scene Define the scene the sound track belongs to
  36958. * @param options
  36959. */
  36960. constructor(scene: Scene, options?: ISoundTrackOptions);
  36961. private _initializeSoundTrackAudioGraph;
  36962. /**
  36963. * Release the sound track and its associated resources
  36964. */
  36965. dispose(): void;
  36966. /**
  36967. * Adds a sound to this sound track
  36968. * @param sound define the cound to add
  36969. * @ignoreNaming
  36970. */
  36971. AddSound(sound: Sound): void;
  36972. /**
  36973. * Removes a sound to this sound track
  36974. * @param sound define the cound to remove
  36975. * @ignoreNaming
  36976. */
  36977. RemoveSound(sound: Sound): void;
  36978. /**
  36979. * Set a global volume for the full sound track.
  36980. * @param newVolume Define the new volume of the sound track
  36981. */
  36982. setVolume(newVolume: number): void;
  36983. /**
  36984. * Switch the panning model to HRTF:
  36985. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  36986. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  36987. */
  36988. switchPanningModelToHRTF(): void;
  36989. /**
  36990. * Switch the panning model to Equal Power:
  36991. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  36992. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  36993. */
  36994. switchPanningModelToEqualPower(): void;
  36995. /**
  36996. * Connect the sound track to an audio analyser allowing some amazing
  36997. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  36998. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  36999. * @param analyser The analyser to connect to the engine
  37000. */
  37001. connectToAnalyser(analyser: Analyser): void;
  37002. }
  37003. }
  37004. declare module "babylonjs/Audio/audioSceneComponent" {
  37005. import { Sound } from "babylonjs/Audio/sound";
  37006. import { SoundTrack } from "babylonjs/Audio/soundTrack";
  37007. import { Nullable } from "babylonjs/types";
  37008. import { Vector3 } from "babylonjs/Maths/math.vector";
  37009. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  37010. import { Scene } from "babylonjs/scene";
  37011. import { AbstractScene } from "babylonjs/abstractScene";
  37012. import "babylonjs/Audio/audioEngine";
  37013. module "babylonjs/abstractScene" {
  37014. interface AbstractScene {
  37015. /**
  37016. * The list of sounds used in the scene.
  37017. */
  37018. sounds: Nullable<Array<Sound>>;
  37019. }
  37020. }
  37021. module "babylonjs/scene" {
  37022. interface Scene {
  37023. /**
  37024. * @hidden
  37025. * Backing field
  37026. */
  37027. _mainSoundTrack: SoundTrack;
  37028. /**
  37029. * The main sound track played by the scene.
  37030. * It cotains your primary collection of sounds.
  37031. */
  37032. mainSoundTrack: SoundTrack;
  37033. /**
  37034. * The list of sound tracks added to the scene
  37035. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  37036. */
  37037. soundTracks: Nullable<Array<SoundTrack>>;
  37038. /**
  37039. * Gets a sound using a given name
  37040. * @param name defines the name to search for
  37041. * @return the found sound or null if not found at all.
  37042. */
  37043. getSoundByName(name: string): Nullable<Sound>;
  37044. /**
  37045. * Gets or sets if audio support is enabled
  37046. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  37047. */
  37048. audioEnabled: boolean;
  37049. /**
  37050. * Gets or sets if audio will be output to headphones
  37051. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  37052. */
  37053. headphone: boolean;
  37054. /**
  37055. * Gets or sets custom audio listener position provider
  37056. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  37057. */
  37058. audioListenerPositionProvider: Nullable<() => Vector3>;
  37059. /**
  37060. * Gets or sets a refresh rate when using 3D audio positioning
  37061. */
  37062. audioPositioningRefreshRate: number;
  37063. }
  37064. }
  37065. /**
  37066. * Defines the sound scene component responsible to manage any sounds
  37067. * in a given scene.
  37068. */
  37069. export class AudioSceneComponent implements ISceneSerializableComponent {
  37070. /**
  37071. * The component name helpfull to identify the component in the list of scene components.
  37072. */
  37073. readonly name: string;
  37074. /**
  37075. * The scene the component belongs to.
  37076. */
  37077. scene: Scene;
  37078. private _audioEnabled;
  37079. /**
  37080. * Gets whether audio is enabled or not.
  37081. * Please use related enable/disable method to switch state.
  37082. */
  37083. readonly audioEnabled: boolean;
  37084. private _headphone;
  37085. /**
  37086. * Gets whether audio is outputing to headphone or not.
  37087. * Please use the according Switch methods to change output.
  37088. */
  37089. readonly headphone: boolean;
  37090. /**
  37091. * Gets or sets a refresh rate when using 3D audio positioning
  37092. */
  37093. audioPositioningRefreshRate: number;
  37094. private _audioListenerPositionProvider;
  37095. /**
  37096. * Gets the current audio listener position provider
  37097. */
  37098. /**
  37099. * Sets a custom listener position for all sounds in the scene
  37100. * By default, this is the position of the first active camera
  37101. */
  37102. audioListenerPositionProvider: Nullable<() => Vector3>;
  37103. /**
  37104. * Creates a new instance of the component for the given scene
  37105. * @param scene Defines the scene to register the component in
  37106. */
  37107. constructor(scene: Scene);
  37108. /**
  37109. * Registers the component in a given scene
  37110. */
  37111. register(): void;
  37112. /**
  37113. * Rebuilds the elements related to this component in case of
  37114. * context lost for instance.
  37115. */
  37116. rebuild(): void;
  37117. /**
  37118. * Serializes the component data to the specified json object
  37119. * @param serializationObject The object to serialize to
  37120. */
  37121. serialize(serializationObject: any): void;
  37122. /**
  37123. * Adds all the elements from the container to the scene
  37124. * @param container the container holding the elements
  37125. */
  37126. addFromContainer(container: AbstractScene): void;
  37127. /**
  37128. * Removes all the elements in the container from the scene
  37129. * @param container contains the elements to remove
  37130. * @param dispose if the removed element should be disposed (default: false)
  37131. */
  37132. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  37133. /**
  37134. * Disposes the component and the associated ressources.
  37135. */
  37136. dispose(): void;
  37137. /**
  37138. * Disables audio in the associated scene.
  37139. */
  37140. disableAudio(): void;
  37141. /**
  37142. * Enables audio in the associated scene.
  37143. */
  37144. enableAudio(): void;
  37145. /**
  37146. * Switch audio to headphone output.
  37147. */
  37148. switchAudioModeForHeadphones(): void;
  37149. /**
  37150. * Switch audio to normal speakers.
  37151. */
  37152. switchAudioModeForNormalSpeakers(): void;
  37153. private _cachedCameraDirection;
  37154. private _cachedCameraPosition;
  37155. private _lastCheck;
  37156. private _afterRender;
  37157. }
  37158. }
  37159. declare module "babylonjs/Audio/weightedsound" {
  37160. import { Sound } from "babylonjs/Audio/sound";
  37161. /**
  37162. * Wraps one or more Sound objects and selects one with random weight for playback.
  37163. */
  37164. export class WeightedSound {
  37165. /** When true a Sound will be selected and played when the current playing Sound completes. */
  37166. loop: boolean;
  37167. private _coneInnerAngle;
  37168. private _coneOuterAngle;
  37169. private _volume;
  37170. /** A Sound is currently playing. */
  37171. isPlaying: boolean;
  37172. /** A Sound is currently paused. */
  37173. isPaused: boolean;
  37174. private _sounds;
  37175. private _weights;
  37176. private _currentIndex?;
  37177. /**
  37178. * Creates a new WeightedSound from the list of sounds given.
  37179. * @param loop When true a Sound will be selected and played when the current playing Sound completes.
  37180. * @param sounds Array of Sounds that will be selected from.
  37181. * @param weights Array of number values for selection weights; length must equal sounds, values will be normalized to 1
  37182. */
  37183. constructor(loop: boolean, sounds: Sound[], weights: number[]);
  37184. /**
  37185. * The size of cone in degrees for a directional sound in which there will be no attenuation.
  37186. */
  37187. /**
  37188. * The size of cone in degress for a directional sound in which there will be no attenuation.
  37189. */
  37190. directionalConeInnerAngle: number;
  37191. /**
  37192. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  37193. * Listener angles between innerAngle and outerAngle will falloff linearly.
  37194. */
  37195. /**
  37196. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  37197. * Listener angles between innerAngle and outerAngle will falloff linearly.
  37198. */
  37199. directionalConeOuterAngle: number;
  37200. /**
  37201. * Playback volume.
  37202. */
  37203. /**
  37204. * Playback volume.
  37205. */
  37206. volume: number;
  37207. private _onended;
  37208. /**
  37209. * Suspend playback
  37210. */
  37211. pause(): void;
  37212. /**
  37213. * Stop playback
  37214. */
  37215. stop(): void;
  37216. /**
  37217. * Start playback.
  37218. * @param startOffset Position the clip head at a specific time in seconds.
  37219. */
  37220. play(startOffset?: number): void;
  37221. }
  37222. }
  37223. declare module "babylonjs/Audio/index" {
  37224. export * from "babylonjs/Audio/analyser";
  37225. export * from "babylonjs/Audio/audioEngine";
  37226. export * from "babylonjs/Audio/audioSceneComponent";
  37227. export * from "babylonjs/Audio/sound";
  37228. export * from "babylonjs/Audio/soundTrack";
  37229. export * from "babylonjs/Audio/weightedsound";
  37230. }
  37231. declare module "babylonjs/Behaviors/Cameras/bouncingBehavior" {
  37232. import { Behavior } from "babylonjs/Behaviors/behavior";
  37233. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  37234. import { BackEase } from "babylonjs/Animations/easing";
  37235. /**
  37236. * Add a bouncing effect to an ArcRotateCamera when reaching a specified minimum and maximum radius
  37237. * @see http://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  37238. */
  37239. export class BouncingBehavior implements Behavior<ArcRotateCamera> {
  37240. /**
  37241. * Gets the name of the behavior.
  37242. */
  37243. readonly name: string;
  37244. /**
  37245. * The easing function used by animations
  37246. */
  37247. static EasingFunction: BackEase;
  37248. /**
  37249. * The easing mode used by animations
  37250. */
  37251. static EasingMode: number;
  37252. /**
  37253. * The duration of the animation, in milliseconds
  37254. */
  37255. transitionDuration: number;
  37256. /**
  37257. * Length of the distance animated by the transition when lower radius is reached
  37258. */
  37259. lowerRadiusTransitionRange: number;
  37260. /**
  37261. * Length of the distance animated by the transition when upper radius is reached
  37262. */
  37263. upperRadiusTransitionRange: number;
  37264. private _autoTransitionRange;
  37265. /**
  37266. * Gets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  37267. */
  37268. /**
  37269. * Sets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  37270. * Transition ranges will be set to 5% of the bounding box diagonal in world space
  37271. */
  37272. autoTransitionRange: boolean;
  37273. private _attachedCamera;
  37274. private _onAfterCheckInputsObserver;
  37275. private _onMeshTargetChangedObserver;
  37276. /**
  37277. * Initializes the behavior.
  37278. */
  37279. init(): void;
  37280. /**
  37281. * Attaches the behavior to its arc rotate camera.
  37282. * @param camera Defines the camera to attach the behavior to
  37283. */
  37284. attach(camera: ArcRotateCamera): void;
  37285. /**
  37286. * Detaches the behavior from its current arc rotate camera.
  37287. */
  37288. detach(): void;
  37289. private _radiusIsAnimating;
  37290. private _radiusBounceTransition;
  37291. private _animatables;
  37292. private _cachedWheelPrecision;
  37293. /**
  37294. * Checks if the camera radius is at the specified limit. Takes into account animation locks.
  37295. * @param radiusLimit The limit to check against.
  37296. * @return Bool to indicate if at limit.
  37297. */
  37298. private _isRadiusAtLimit;
  37299. /**
  37300. * Applies an animation to the radius of the camera, extending by the radiusDelta.
  37301. * @param radiusDelta The delta by which to animate to. Can be negative.
  37302. */
  37303. private _applyBoundRadiusAnimation;
  37304. /**
  37305. * Removes all animation locks. Allows new animations to be added to any of the camera properties.
  37306. */
  37307. protected _clearAnimationLocks(): void;
  37308. /**
  37309. * Stops and removes all animations that have been applied to the camera
  37310. */
  37311. stopAllAnimations(): void;
  37312. }
  37313. }
  37314. declare module "babylonjs/Behaviors/Cameras/framingBehavior" {
  37315. import { Behavior } from "babylonjs/Behaviors/behavior";
  37316. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  37317. import { ExponentialEase } from "babylonjs/Animations/easing";
  37318. import { Nullable } from "babylonjs/types";
  37319. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  37320. import { Vector3 } from "babylonjs/Maths/math.vector";
  37321. /**
  37322. * 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.
  37323. * @see http://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  37324. */
  37325. export class FramingBehavior implements Behavior<ArcRotateCamera> {
  37326. /**
  37327. * Gets the name of the behavior.
  37328. */
  37329. readonly name: string;
  37330. private _mode;
  37331. private _radiusScale;
  37332. private _positionScale;
  37333. private _defaultElevation;
  37334. private _elevationReturnTime;
  37335. private _elevationReturnWaitTime;
  37336. private _zoomStopsAnimation;
  37337. private _framingTime;
  37338. /**
  37339. * The easing function used by animations
  37340. */
  37341. static EasingFunction: ExponentialEase;
  37342. /**
  37343. * The easing mode used by animations
  37344. */
  37345. static EasingMode: number;
  37346. /**
  37347. * Sets the current mode used by the behavior
  37348. */
  37349. /**
  37350. * Gets current mode used by the behavior.
  37351. */
  37352. mode: number;
  37353. /**
  37354. * Sets the scale applied to the radius (1 by default)
  37355. */
  37356. /**
  37357. * Gets the scale applied to the radius
  37358. */
  37359. radiusScale: number;
  37360. /**
  37361. * Sets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  37362. */
  37363. /**
  37364. * Gets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  37365. */
  37366. positionScale: number;
  37367. /**
  37368. * Sets the angle above/below the horizontal plane to return to when the return to default elevation idle
  37369. * behaviour is triggered, in radians.
  37370. */
  37371. /**
  37372. * Gets the angle above/below the horizontal plane to return to when the return to default elevation idle
  37373. * behaviour is triggered, in radians.
  37374. */
  37375. defaultElevation: number;
  37376. /**
  37377. * Sets the time (in milliseconds) taken to return to the default beta position.
  37378. * Negative value indicates camera should not return to default.
  37379. */
  37380. /**
  37381. * Gets the time (in milliseconds) taken to return to the default beta position.
  37382. * Negative value indicates camera should not return to default.
  37383. */
  37384. elevationReturnTime: number;
  37385. /**
  37386. * Sets the delay (in milliseconds) taken before the camera returns to the default beta position.
  37387. */
  37388. /**
  37389. * Gets the delay (in milliseconds) taken before the camera returns to the default beta position.
  37390. */
  37391. elevationReturnWaitTime: number;
  37392. /**
  37393. * Sets the flag that indicates if user zooming should stop animation.
  37394. */
  37395. /**
  37396. * Gets the flag that indicates if user zooming should stop animation.
  37397. */
  37398. zoomStopsAnimation: boolean;
  37399. /**
  37400. * Sets the transition time when framing the mesh, in milliseconds
  37401. */
  37402. /**
  37403. * Gets the transition time when framing the mesh, in milliseconds
  37404. */
  37405. framingTime: number;
  37406. /**
  37407. * Define if the behavior should automatically change the configured
  37408. * camera limits and sensibilities.
  37409. */
  37410. autoCorrectCameraLimitsAndSensibility: boolean;
  37411. private _onPrePointerObservableObserver;
  37412. private _onAfterCheckInputsObserver;
  37413. private _onMeshTargetChangedObserver;
  37414. private _attachedCamera;
  37415. private _isPointerDown;
  37416. private _lastInteractionTime;
  37417. /**
  37418. * Initializes the behavior.
  37419. */
  37420. init(): void;
  37421. /**
  37422. * Attaches the behavior to its arc rotate camera.
  37423. * @param camera Defines the camera to attach the behavior to
  37424. */
  37425. attach(camera: ArcRotateCamera): void;
  37426. /**
  37427. * Detaches the behavior from its current arc rotate camera.
  37428. */
  37429. detach(): void;
  37430. private _animatables;
  37431. private _betaIsAnimating;
  37432. private _betaTransition;
  37433. private _radiusTransition;
  37434. private _vectorTransition;
  37435. /**
  37436. * Targets the given mesh and updates zoom level accordingly.
  37437. * @param mesh The mesh to target.
  37438. * @param radius Optional. If a cached radius position already exists, overrides default.
  37439. * @param framingPositionY Position on mesh to center camera focus where 0 corresponds bottom of its bounding box and 1, the top
  37440. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  37441. * @param onAnimationEnd Callback triggered at the end of the framing animation
  37442. */
  37443. zoomOnMesh(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  37444. /**
  37445. * Targets the given mesh with its children and updates zoom level accordingly.
  37446. * @param mesh The mesh to target.
  37447. * @param radius Optional. If a cached radius position already exists, overrides default.
  37448. * @param framingPositionY Position on mesh to center camera focus where 0 corresponds bottom of its bounding box and 1, the top
  37449. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  37450. * @param onAnimationEnd Callback triggered at the end of the framing animation
  37451. */
  37452. zoomOnMeshHierarchy(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  37453. /**
  37454. * Targets the given meshes with their children and updates zoom level accordingly.
  37455. * @param meshes The mesh to target.
  37456. * @param radius Optional. If a cached radius position already exists, overrides default.
  37457. * @param framingPositionY Position on mesh to center camera focus where 0 corresponds bottom of its bounding box and 1, the top
  37458. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  37459. * @param onAnimationEnd Callback triggered at the end of the framing animation
  37460. */
  37461. zoomOnMeshesHierarchy(meshes: AbstractMesh[], focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  37462. /**
  37463. * Targets the bounding box info defined by its extends and updates zoom level accordingly.
  37464. * @param minimumWorld Determines the smaller position of the bounding box extend
  37465. * @param maximumWorld Determines the bigger position of the bounding box extend
  37466. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  37467. * @param onAnimationEnd Callback triggered at the end of the framing animation
  37468. */
  37469. zoomOnBoundingInfo(minimumWorld: Vector3, maximumWorld: Vector3, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  37470. /**
  37471. * Calculates the lowest radius for the camera based on the bounding box of the mesh.
  37472. * @param mesh The mesh on which to base the calculation. mesh boundingInfo used to estimate necessary
  37473. * frustum width.
  37474. * @return The minimum distance from the primary mesh's center point at which the camera must be kept in order
  37475. * to fully enclose the mesh in the viewing frustum.
  37476. */
  37477. protected _calculateLowerRadiusFromModelBoundingSphere(minimumWorld: Vector3, maximumWorld: Vector3): number;
  37478. /**
  37479. * Keeps the camera above the ground plane. If the user pulls the camera below the ground plane, the camera
  37480. * is automatically returned to its default position (expected to be above ground plane).
  37481. */
  37482. private _maintainCameraAboveGround;
  37483. /**
  37484. * Returns the frustum slope based on the canvas ratio and camera FOV
  37485. * @returns The frustum slope represented as a Vector2 with X and Y slopes
  37486. */
  37487. private _getFrustumSlope;
  37488. /**
  37489. * Removes all animation locks. Allows new animations to be added to any of the arcCamera properties.
  37490. */
  37491. private _clearAnimationLocks;
  37492. /**
  37493. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  37494. */
  37495. private _applyUserInteraction;
  37496. /**
  37497. * Stops and removes all animations that have been applied to the camera
  37498. */
  37499. stopAllAnimations(): void;
  37500. /**
  37501. * Gets a value indicating if the user is moving the camera
  37502. */
  37503. readonly isUserIsMoving: boolean;
  37504. /**
  37505. * The camera can move all the way towards the mesh.
  37506. */
  37507. static IgnoreBoundsSizeMode: number;
  37508. /**
  37509. * The camera is not allowed to zoom closer to the mesh than the point at which the adjusted bounding sphere touches the frustum sides
  37510. */
  37511. static FitFrustumSidesMode: number;
  37512. }
  37513. }
  37514. declare module "babylonjs/Cameras/Inputs/BaseCameraPointersInput" {
  37515. import { Nullable } from "babylonjs/types";
  37516. import { Camera } from "babylonjs/Cameras/camera";
  37517. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  37518. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  37519. /**
  37520. * Base class for Camera Pointer Inputs.
  37521. * See FollowCameraPointersInput in src/Cameras/Inputs/followCameraPointersInput.ts
  37522. * for example usage.
  37523. */
  37524. export abstract class BaseCameraPointersInput implements ICameraInput<Camera> {
  37525. /**
  37526. * Defines the camera the input is attached to.
  37527. */
  37528. abstract camera: Camera;
  37529. /**
  37530. * Whether keyboard modifier keys are pressed at time of last mouse event.
  37531. */
  37532. protected _altKey: boolean;
  37533. protected _ctrlKey: boolean;
  37534. protected _metaKey: boolean;
  37535. protected _shiftKey: boolean;
  37536. /**
  37537. * Which mouse buttons were pressed at time of last mouse event.
  37538. * https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/buttons
  37539. */
  37540. protected _buttonsPressed: number;
  37541. /**
  37542. * Defines the buttons associated with the input to handle camera move.
  37543. */
  37544. buttons: number[];
  37545. /**
  37546. * Attach the input controls to a specific dom element to get the input from.
  37547. * @param element Defines the element the controls should be listened from
  37548. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  37549. */
  37550. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  37551. /**
  37552. * Detach the current controls from the specified dom element.
  37553. * @param element Defines the element to stop listening the inputs from
  37554. */
  37555. detachControl(element: Nullable<HTMLElement>): void;
  37556. /**
  37557. * Gets the class name of the current input.
  37558. * @returns the class name
  37559. */
  37560. getClassName(): string;
  37561. /**
  37562. * Get the friendly name associated with the input class.
  37563. * @returns the input friendly name
  37564. */
  37565. getSimpleName(): string;
  37566. /**
  37567. * Called on pointer POINTERDOUBLETAP event.
  37568. * Override this method to provide functionality on POINTERDOUBLETAP event.
  37569. */
  37570. protected onDoubleTap(type: string): void;
  37571. /**
  37572. * Called on pointer POINTERMOVE event if only a single touch is active.
  37573. * Override this method to provide functionality.
  37574. */
  37575. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  37576. /**
  37577. * Called on pointer POINTERMOVE event if multiple touches are active.
  37578. * Override this method to provide functionality.
  37579. */
  37580. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  37581. /**
  37582. * Called on JS contextmenu event.
  37583. * Override this method to provide functionality.
  37584. */
  37585. protected onContextMenu(evt: PointerEvent): void;
  37586. /**
  37587. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  37588. * press.
  37589. * Override this method to provide functionality.
  37590. */
  37591. protected onButtonDown(evt: PointerEvent): void;
  37592. /**
  37593. * Called each time a new POINTERUP event occurs. Ie, for each button
  37594. * release.
  37595. * Override this method to provide functionality.
  37596. */
  37597. protected onButtonUp(evt: PointerEvent): void;
  37598. /**
  37599. * Called when window becomes inactive.
  37600. * Override this method to provide functionality.
  37601. */
  37602. protected onLostFocus(): void;
  37603. private _pointerInput;
  37604. private _observer;
  37605. private _onLostFocus;
  37606. private pointA;
  37607. private pointB;
  37608. }
  37609. }
  37610. declare module "babylonjs/Cameras/Inputs/arcRotateCameraPointersInput" {
  37611. import { Nullable } from "babylonjs/types";
  37612. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  37613. import { BaseCameraPointersInput } from "babylonjs/Cameras/Inputs/BaseCameraPointersInput";
  37614. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  37615. /**
  37616. * Manage the pointers inputs to control an arc rotate camera.
  37617. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  37618. */
  37619. export class ArcRotateCameraPointersInput extends BaseCameraPointersInput {
  37620. /**
  37621. * Defines the camera the input is attached to.
  37622. */
  37623. camera: ArcRotateCamera;
  37624. /**
  37625. * Gets the class name of the current input.
  37626. * @returns the class name
  37627. */
  37628. getClassName(): string;
  37629. /**
  37630. * Defines the buttons associated with the input to handle camera move.
  37631. */
  37632. buttons: number[];
  37633. /**
  37634. * Defines the pointer angular sensibility along the X axis or how fast is
  37635. * the camera rotating.
  37636. */
  37637. angularSensibilityX: number;
  37638. /**
  37639. * Defines the pointer angular sensibility along the Y axis or how fast is
  37640. * the camera rotating.
  37641. */
  37642. angularSensibilityY: number;
  37643. /**
  37644. * Defines the pointer pinch precision or how fast is the camera zooming.
  37645. */
  37646. pinchPrecision: number;
  37647. /**
  37648. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  37649. * from 0.
  37650. * It defines the percentage of current camera.radius to use as delta when
  37651. * pinch zoom is used.
  37652. */
  37653. pinchDeltaPercentage: number;
  37654. /**
  37655. * Defines the pointer panning sensibility or how fast is the camera moving.
  37656. */
  37657. panningSensibility: number;
  37658. /**
  37659. * Defines whether panning (2 fingers swipe) is enabled through multitouch.
  37660. */
  37661. multiTouchPanning: boolean;
  37662. /**
  37663. * Defines whether panning is enabled for both pan (2 fingers swipe) and
  37664. * zoom (pinch) through multitouch.
  37665. */
  37666. multiTouchPanAndZoom: boolean;
  37667. /**
  37668. * Revers pinch action direction.
  37669. */
  37670. pinchInwards: boolean;
  37671. private _isPanClick;
  37672. private _twoFingerActivityCount;
  37673. private _isPinching;
  37674. /**
  37675. * Called on pointer POINTERMOVE event if only a single touch is active.
  37676. */
  37677. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  37678. /**
  37679. * Called on pointer POINTERDOUBLETAP event.
  37680. */
  37681. protected onDoubleTap(type: string): void;
  37682. /**
  37683. * Called on pointer POINTERMOVE event if multiple touches are active.
  37684. */
  37685. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  37686. /**
  37687. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  37688. * press.
  37689. */
  37690. protected onButtonDown(evt: PointerEvent): void;
  37691. /**
  37692. * Called each time a new POINTERUP event occurs. Ie, for each button
  37693. * release.
  37694. */
  37695. protected onButtonUp(evt: PointerEvent): void;
  37696. /**
  37697. * Called when window becomes inactive.
  37698. */
  37699. protected onLostFocus(): void;
  37700. }
  37701. }
  37702. declare module "babylonjs/Cameras/Inputs/arcRotateCameraKeyboardMoveInput" {
  37703. import { Nullable } from "babylonjs/types";
  37704. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  37705. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  37706. /**
  37707. * Manage the keyboard inputs to control the movement of an arc rotate camera.
  37708. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  37709. */
  37710. export class ArcRotateCameraKeyboardMoveInput implements ICameraInput<ArcRotateCamera> {
  37711. /**
  37712. * Defines the camera the input is attached to.
  37713. */
  37714. camera: ArcRotateCamera;
  37715. /**
  37716. * Defines the list of key codes associated with the up action (increase alpha)
  37717. */
  37718. keysUp: number[];
  37719. /**
  37720. * Defines the list of key codes associated with the down action (decrease alpha)
  37721. */
  37722. keysDown: number[];
  37723. /**
  37724. * Defines the list of key codes associated with the left action (increase beta)
  37725. */
  37726. keysLeft: number[];
  37727. /**
  37728. * Defines the list of key codes associated with the right action (decrease beta)
  37729. */
  37730. keysRight: number[];
  37731. /**
  37732. * Defines the list of key codes associated with the reset action.
  37733. * Those keys reset the camera to its last stored state (with the method camera.storeState())
  37734. */
  37735. keysReset: number[];
  37736. /**
  37737. * Defines the panning sensibility of the inputs.
  37738. * (How fast is the camera paning)
  37739. */
  37740. panningSensibility: number;
  37741. /**
  37742. * Defines the zooming sensibility of the inputs.
  37743. * (How fast is the camera zooming)
  37744. */
  37745. zoomingSensibility: number;
  37746. /**
  37747. * Defines wether maintaining the alt key down switch the movement mode from
  37748. * orientation to zoom.
  37749. */
  37750. useAltToZoom: boolean;
  37751. /**
  37752. * Rotation speed of the camera
  37753. */
  37754. angularSpeed: number;
  37755. private _keys;
  37756. private _ctrlPressed;
  37757. private _altPressed;
  37758. private _onCanvasBlurObserver;
  37759. private _onKeyboardObserver;
  37760. private _engine;
  37761. private _scene;
  37762. /**
  37763. * Attach the input controls to a specific dom element to get the input from.
  37764. * @param element Defines the element the controls should be listened from
  37765. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  37766. */
  37767. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  37768. /**
  37769. * Detach the current controls from the specified dom element.
  37770. * @param element Defines the element to stop listening the inputs from
  37771. */
  37772. detachControl(element: Nullable<HTMLElement>): void;
  37773. /**
  37774. * Update the current camera state depending on the inputs that have been used this frame.
  37775. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  37776. */
  37777. checkInputs(): void;
  37778. /**
  37779. * Gets the class name of the current intput.
  37780. * @returns the class name
  37781. */
  37782. getClassName(): string;
  37783. /**
  37784. * Get the friendly name associated with the input class.
  37785. * @returns the input friendly name
  37786. */
  37787. getSimpleName(): string;
  37788. }
  37789. }
  37790. declare module "babylonjs/Cameras/Inputs/arcRotateCameraMouseWheelInput" {
  37791. import { Nullable } from "babylonjs/types";
  37792. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  37793. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  37794. /**
  37795. * Manage the mouse wheel inputs to control an arc rotate camera.
  37796. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  37797. */
  37798. export class ArcRotateCameraMouseWheelInput implements ICameraInput<ArcRotateCamera> {
  37799. /**
  37800. * Defines the camera the input is attached to.
  37801. */
  37802. camera: ArcRotateCamera;
  37803. /**
  37804. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  37805. */
  37806. wheelPrecision: number;
  37807. /**
  37808. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  37809. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  37810. */
  37811. wheelDeltaPercentage: number;
  37812. private _wheel;
  37813. private _observer;
  37814. private computeDeltaFromMouseWheelLegacyEvent;
  37815. /**
  37816. * Attach the input controls to a specific dom element to get the input from.
  37817. * @param element Defines the element the controls should be listened from
  37818. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  37819. */
  37820. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  37821. /**
  37822. * Detach the current controls from the specified dom element.
  37823. * @param element Defines the element to stop listening the inputs from
  37824. */
  37825. detachControl(element: Nullable<HTMLElement>): void;
  37826. /**
  37827. * Gets the class name of the current intput.
  37828. * @returns the class name
  37829. */
  37830. getClassName(): string;
  37831. /**
  37832. * Get the friendly name associated with the input class.
  37833. * @returns the input friendly name
  37834. */
  37835. getSimpleName(): string;
  37836. }
  37837. }
  37838. declare module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  37839. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  37840. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  37841. /**
  37842. * Default Inputs manager for the ArcRotateCamera.
  37843. * It groups all the default supported inputs for ease of use.
  37844. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  37845. */
  37846. export class ArcRotateCameraInputsManager extends CameraInputsManager<ArcRotateCamera> {
  37847. /**
  37848. * Instantiates a new ArcRotateCameraInputsManager.
  37849. * @param camera Defines the camera the inputs belong to
  37850. */
  37851. constructor(camera: ArcRotateCamera);
  37852. /**
  37853. * Add mouse wheel input support to the input manager.
  37854. * @returns the current input manager
  37855. */
  37856. addMouseWheel(): ArcRotateCameraInputsManager;
  37857. /**
  37858. * Add pointers input support to the input manager.
  37859. * @returns the current input manager
  37860. */
  37861. addPointers(): ArcRotateCameraInputsManager;
  37862. /**
  37863. * Add keyboard input support to the input manager.
  37864. * @returns the current input manager
  37865. */
  37866. addKeyboard(): ArcRotateCameraInputsManager;
  37867. }
  37868. }
  37869. declare module "babylonjs/Cameras/arcRotateCamera" {
  37870. import { Observable } from "babylonjs/Misc/observable";
  37871. import { Nullable } from "babylonjs/types";
  37872. import { Scene } from "babylonjs/scene";
  37873. import { Matrix, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  37874. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  37875. import { AutoRotationBehavior } from "babylonjs/Behaviors/Cameras/autoRotationBehavior";
  37876. import { BouncingBehavior } from "babylonjs/Behaviors/Cameras/bouncingBehavior";
  37877. import { FramingBehavior } from "babylonjs/Behaviors/Cameras/framingBehavior";
  37878. import { Camera } from "babylonjs/Cameras/camera";
  37879. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  37880. import { ArcRotateCameraInputsManager } from "babylonjs/Cameras/arcRotateCameraInputsManager";
  37881. import { Collider } from "babylonjs/Collisions/collider";
  37882. /**
  37883. * This represents an orbital type of camera.
  37884. *
  37885. * 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.
  37886. * 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.
  37887. * @see http://doc.babylonjs.com/babylon101/cameras#arc-rotate-camera
  37888. */
  37889. export class ArcRotateCamera extends TargetCamera {
  37890. /**
  37891. * Defines the rotation angle of the camera along the longitudinal axis.
  37892. */
  37893. alpha: number;
  37894. /**
  37895. * Defines the rotation angle of the camera along the latitudinal axis.
  37896. */
  37897. beta: number;
  37898. /**
  37899. * Defines the radius of the camera from it s target point.
  37900. */
  37901. radius: number;
  37902. protected _target: Vector3;
  37903. protected _targetHost: Nullable<AbstractMesh>;
  37904. /**
  37905. * Defines the target point of the camera.
  37906. * The camera looks towards it form the radius distance.
  37907. */
  37908. target: Vector3;
  37909. /**
  37910. * Define the current local position of the camera in the scene
  37911. */
  37912. position: Vector3;
  37913. protected _upVector: Vector3;
  37914. protected _upToYMatrix: Matrix;
  37915. protected _YToUpMatrix: Matrix;
  37916. /**
  37917. * The vector the camera should consider as up. (default is Vector3(0, 1, 0) as returned by Vector3.Up())
  37918. * Setting this will copy the given vector to the camera's upVector, and set rotation matrices to and from Y up.
  37919. * DO NOT set the up vector using copyFrom or copyFromFloats, as this bypasses setting the above matrices.
  37920. */
  37921. upVector: Vector3;
  37922. /**
  37923. * Sets the Y-up to camera up-vector rotation matrix, and the up-vector to Y-up rotation matrix.
  37924. */
  37925. setMatUp(): void;
  37926. /**
  37927. * Current inertia value on the longitudinal axis.
  37928. * The bigger this number the longer it will take for the camera to stop.
  37929. */
  37930. inertialAlphaOffset: number;
  37931. /**
  37932. * Current inertia value on the latitudinal axis.
  37933. * The bigger this number the longer it will take for the camera to stop.
  37934. */
  37935. inertialBetaOffset: number;
  37936. /**
  37937. * Current inertia value on the radius axis.
  37938. * The bigger this number the longer it will take for the camera to stop.
  37939. */
  37940. inertialRadiusOffset: number;
  37941. /**
  37942. * Minimum allowed angle on the longitudinal axis.
  37943. * This can help limiting how the Camera is able to move in the scene.
  37944. */
  37945. lowerAlphaLimit: Nullable<number>;
  37946. /**
  37947. * Maximum allowed angle on the longitudinal axis.
  37948. * This can help limiting how the Camera is able to move in the scene.
  37949. */
  37950. upperAlphaLimit: Nullable<number>;
  37951. /**
  37952. * Minimum allowed angle on the latitudinal axis.
  37953. * This can help limiting how the Camera is able to move in the scene.
  37954. */
  37955. lowerBetaLimit: number;
  37956. /**
  37957. * Maximum allowed angle on the latitudinal axis.
  37958. * This can help limiting how the Camera is able to move in the scene.
  37959. */
  37960. upperBetaLimit: number;
  37961. /**
  37962. * Minimum allowed distance of the camera to the target (The camera can not get closer).
  37963. * This can help limiting how the Camera is able to move in the scene.
  37964. */
  37965. lowerRadiusLimit: Nullable<number>;
  37966. /**
  37967. * Maximum allowed distance of the camera to the target (The camera can not get further).
  37968. * This can help limiting how the Camera is able to move in the scene.
  37969. */
  37970. upperRadiusLimit: Nullable<number>;
  37971. /**
  37972. * Defines the current inertia value used during panning of the camera along the X axis.
  37973. */
  37974. inertialPanningX: number;
  37975. /**
  37976. * Defines the current inertia value used during panning of the camera along the Y axis.
  37977. */
  37978. inertialPanningY: number;
  37979. /**
  37980. * Defines the distance used to consider the camera in pan mode vs pinch/zoom.
  37981. * Basically if your fingers moves away from more than this distance you will be considered
  37982. * in pinch mode.
  37983. */
  37984. pinchToPanMaxDistance: number;
  37985. /**
  37986. * Defines the maximum distance the camera can pan.
  37987. * This could help keeping the cammera always in your scene.
  37988. */
  37989. panningDistanceLimit: Nullable<number>;
  37990. /**
  37991. * Defines the target of the camera before paning.
  37992. */
  37993. panningOriginTarget: Vector3;
  37994. /**
  37995. * Defines the value of the inertia used during panning.
  37996. * 0 would mean stop inertia and one would mean no decelleration at all.
  37997. */
  37998. panningInertia: number;
  37999. /**
  38000. * Gets or Set the pointer angular sensibility along the X axis or how fast is the camera rotating.
  38001. */
  38002. angularSensibilityX: number;
  38003. /**
  38004. * Gets or Set the pointer angular sensibility along the Y axis or how fast is the camera rotating.
  38005. */
  38006. angularSensibilityY: number;
  38007. /**
  38008. * Gets or Set the pointer pinch precision or how fast is the camera zooming.
  38009. */
  38010. pinchPrecision: number;
  38011. /**
  38012. * Gets or Set the pointer pinch delta percentage or how fast is the camera zooming.
  38013. * It will be used instead of pinchDeltaPrecision if different from 0.
  38014. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  38015. */
  38016. pinchDeltaPercentage: number;
  38017. /**
  38018. * Gets or Set the pointer panning sensibility or how fast is the camera moving.
  38019. */
  38020. panningSensibility: number;
  38021. /**
  38022. * Gets or Set the list of keyboard keys used to control beta angle in a positive direction.
  38023. */
  38024. keysUp: number[];
  38025. /**
  38026. * Gets or Set the list of keyboard keys used to control beta angle in a negative direction.
  38027. */
  38028. keysDown: number[];
  38029. /**
  38030. * Gets or Set the list of keyboard keys used to control alpha angle in a negative direction.
  38031. */
  38032. keysLeft: number[];
  38033. /**
  38034. * Gets or Set the list of keyboard keys used to control alpha angle in a positive direction.
  38035. */
  38036. keysRight: number[];
  38037. /**
  38038. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  38039. */
  38040. wheelPrecision: number;
  38041. /**
  38042. * Gets or Set the mouse wheel delta percentage or how fast is the camera zooming.
  38043. * It will be used instead of pinchDeltaPrecision if different from 0.
  38044. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  38045. */
  38046. wheelDeltaPercentage: number;
  38047. /**
  38048. * Defines how much the radius should be scaled while zomming on a particular mesh (through the zoomOn function)
  38049. */
  38050. zoomOnFactor: number;
  38051. /**
  38052. * Defines a screen offset for the camera position.
  38053. */
  38054. targetScreenOffset: Vector2;
  38055. /**
  38056. * Allows the camera to be completely reversed.
  38057. * If false the camera can not arrive upside down.
  38058. */
  38059. allowUpsideDown: boolean;
  38060. /**
  38061. * Define if double tap/click is used to restore the previously saved state of the camera.
  38062. */
  38063. useInputToRestoreState: boolean;
  38064. /** @hidden */
  38065. _viewMatrix: Matrix;
  38066. /** @hidden */
  38067. _useCtrlForPanning: boolean;
  38068. /** @hidden */
  38069. _panningMouseButton: number;
  38070. /**
  38071. * Defines the input associated to the camera.
  38072. */
  38073. inputs: ArcRotateCameraInputsManager;
  38074. /** @hidden */
  38075. _reset: () => void;
  38076. /**
  38077. * Defines the allowed panning axis.
  38078. */
  38079. panningAxis: Vector3;
  38080. protected _localDirection: Vector3;
  38081. protected _transformedDirection: Vector3;
  38082. private _bouncingBehavior;
  38083. /**
  38084. * Gets the bouncing behavior of the camera if it has been enabled.
  38085. * @see http://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  38086. */
  38087. readonly bouncingBehavior: Nullable<BouncingBehavior>;
  38088. /**
  38089. * Defines if the bouncing behavior of the camera is enabled on the camera.
  38090. * @see http://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  38091. */
  38092. useBouncingBehavior: boolean;
  38093. private _framingBehavior;
  38094. /**
  38095. * Gets the framing behavior of the camera if it has been enabled.
  38096. * @see http://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  38097. */
  38098. readonly framingBehavior: Nullable<FramingBehavior>;
  38099. /**
  38100. * Defines if the framing behavior of the camera is enabled on the camera.
  38101. * @see http://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  38102. */
  38103. useFramingBehavior: boolean;
  38104. private _autoRotationBehavior;
  38105. /**
  38106. * Gets the auto rotation behavior of the camera if it has been enabled.
  38107. * @see http://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  38108. */
  38109. readonly autoRotationBehavior: Nullable<AutoRotationBehavior>;
  38110. /**
  38111. * Defines if the auto rotation behavior of the camera is enabled on the camera.
  38112. * @see http://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  38113. */
  38114. useAutoRotationBehavior: boolean;
  38115. /**
  38116. * Observable triggered when the mesh target has been changed on the camera.
  38117. */
  38118. onMeshTargetChangedObservable: Observable<Nullable<AbstractMesh>>;
  38119. /**
  38120. * Event raised when the camera is colliding with a mesh.
  38121. */
  38122. onCollide: (collidedMesh: AbstractMesh) => void;
  38123. /**
  38124. * Defines whether the camera should check collision with the objects oh the scene.
  38125. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#how-can-i-do-this
  38126. */
  38127. checkCollisions: boolean;
  38128. /**
  38129. * Defines the collision radius of the camera.
  38130. * This simulates a sphere around the camera.
  38131. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  38132. */
  38133. collisionRadius: Vector3;
  38134. protected _collider: Collider;
  38135. protected _previousPosition: Vector3;
  38136. protected _collisionVelocity: Vector3;
  38137. protected _newPosition: Vector3;
  38138. protected _previousAlpha: number;
  38139. protected _previousBeta: number;
  38140. protected _previousRadius: number;
  38141. protected _collisionTriggered: boolean;
  38142. protected _targetBoundingCenter: Nullable<Vector3>;
  38143. private _computationVector;
  38144. /**
  38145. * Instantiates a new ArcRotateCamera in a given scene
  38146. * @param name Defines the name of the camera
  38147. * @param alpha Defines the camera rotation along the logitudinal axis
  38148. * @param beta Defines the camera rotation along the latitudinal axis
  38149. * @param radius Defines the camera distance from its target
  38150. * @param target Defines the camera target
  38151. * @param scene Defines the scene the camera belongs to
  38152. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  38153. */
  38154. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  38155. /** @hidden */
  38156. _initCache(): void;
  38157. /** @hidden */
  38158. _updateCache(ignoreParentClass?: boolean): void;
  38159. protected _getTargetPosition(): Vector3;
  38160. private _storedAlpha;
  38161. private _storedBeta;
  38162. private _storedRadius;
  38163. private _storedTarget;
  38164. private _storedTargetScreenOffset;
  38165. /**
  38166. * Stores the current state of the camera (alpha, beta, radius and target)
  38167. * @returns the camera itself
  38168. */
  38169. storeState(): Camera;
  38170. /**
  38171. * @hidden
  38172. * Restored camera state. You must call storeState() first
  38173. */
  38174. _restoreStateValues(): boolean;
  38175. /** @hidden */
  38176. _isSynchronizedViewMatrix(): boolean;
  38177. /**
  38178. * Attached controls to the current camera.
  38179. * @param element Defines the element the controls should be listened from
  38180. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  38181. * @param useCtrlForPanning Defines whether ctrl is used for paning within the controls
  38182. * @param panningMouseButton Defines whether panning is allowed through mouse click button
  38183. */
  38184. attachControl(element: HTMLElement, noPreventDefault?: boolean, useCtrlForPanning?: boolean, panningMouseButton?: number): void;
  38185. /**
  38186. * Detach the current controls from the camera.
  38187. * The camera will stop reacting to inputs.
  38188. * @param element Defines the element to stop listening the inputs from
  38189. */
  38190. detachControl(element: HTMLElement): void;
  38191. /** @hidden */
  38192. _checkInputs(): void;
  38193. protected _checkLimits(): void;
  38194. /**
  38195. * Rebuilds angles (alpha, beta) and radius from the give position and target
  38196. */
  38197. rebuildAnglesAndRadius(): void;
  38198. /**
  38199. * Use a position to define the current camera related information like alpha, beta and radius
  38200. * @param position Defines the position to set the camera at
  38201. */
  38202. setPosition(position: Vector3): void;
  38203. /**
  38204. * Defines the target the camera should look at.
  38205. * This will automatically adapt alpha beta and radius to fit within the new target.
  38206. * @param target Defines the new target as a Vector or a mesh
  38207. * @param toBoundingCenter In case of a mesh target, defines wether to target the mesh position or its bounding information center
  38208. * @param allowSamePosition If false, prevents reapplying the new computed position if it is identical to the current one (optim)
  38209. */
  38210. setTarget(target: AbstractMesh | Vector3, toBoundingCenter?: boolean, allowSamePosition?: boolean): void;
  38211. /** @hidden */
  38212. _getViewMatrix(): Matrix;
  38213. protected _onCollisionPositionChange: (collisionId: number, newPosition: Vector3, collidedMesh?: Nullable<AbstractMesh>) => void;
  38214. /**
  38215. * Zooms on a mesh to be at the min distance where we could see it fully in the current viewport.
  38216. * @param meshes Defines the mesh to zoom on
  38217. * @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)
  38218. */
  38219. zoomOn(meshes?: AbstractMesh[], doNotUpdateMaxZ?: boolean): void;
  38220. /**
  38221. * Focus on a mesh or a bounding box. This adapts the target and maxRadius if necessary but does not update the current radius.
  38222. * The target will be changed but the radius
  38223. * @param meshesOrMinMaxVectorAndDistance Defines the mesh or bounding info to focus on
  38224. * @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)
  38225. */
  38226. focusOn(meshesOrMinMaxVectorAndDistance: AbstractMesh[] | {
  38227. min: Vector3;
  38228. max: Vector3;
  38229. distance: number;
  38230. }, doNotUpdateMaxZ?: boolean): void;
  38231. /**
  38232. * @override
  38233. * Override Camera.createRigCamera
  38234. */
  38235. createRigCamera(name: string, cameraIndex: number): Camera;
  38236. /**
  38237. * @hidden
  38238. * @override
  38239. * Override Camera._updateRigCameras
  38240. */
  38241. _updateRigCameras(): void;
  38242. /**
  38243. * Destroy the camera and release the current resources hold by it.
  38244. */
  38245. dispose(): void;
  38246. /**
  38247. * Gets the current object class name.
  38248. * @return the class name
  38249. */
  38250. getClassName(): string;
  38251. }
  38252. }
  38253. declare module "babylonjs/Behaviors/Cameras/autoRotationBehavior" {
  38254. import { Behavior } from "babylonjs/Behaviors/behavior";
  38255. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  38256. /**
  38257. * The autoRotation behavior (AutoRotationBehavior) is designed to create a smooth rotation of an ArcRotateCamera when there is no user interaction.
  38258. * @see http://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  38259. */
  38260. export class AutoRotationBehavior implements Behavior<ArcRotateCamera> {
  38261. /**
  38262. * Gets the name of the behavior.
  38263. */
  38264. readonly name: string;
  38265. private _zoomStopsAnimation;
  38266. private _idleRotationSpeed;
  38267. private _idleRotationWaitTime;
  38268. private _idleRotationSpinupTime;
  38269. /**
  38270. * Sets the flag that indicates if user zooming should stop animation.
  38271. */
  38272. /**
  38273. * Gets the flag that indicates if user zooming should stop animation.
  38274. */
  38275. zoomStopsAnimation: boolean;
  38276. /**
  38277. * Sets the default speed at which the camera rotates around the model.
  38278. */
  38279. /**
  38280. * Gets the default speed at which the camera rotates around the model.
  38281. */
  38282. idleRotationSpeed: number;
  38283. /**
  38284. * Sets the time (in milliseconds) to wait after user interaction before the camera starts rotating.
  38285. */
  38286. /**
  38287. * Gets the time (milliseconds) to wait after user interaction before the camera starts rotating.
  38288. */
  38289. idleRotationWaitTime: number;
  38290. /**
  38291. * Sets the time (milliseconds) to take to spin up to the full idle rotation speed.
  38292. */
  38293. /**
  38294. * Gets the time (milliseconds) to take to spin up to the full idle rotation speed.
  38295. */
  38296. idleRotationSpinupTime: number;
  38297. /**
  38298. * Gets a value indicating if the camera is currently rotating because of this behavior
  38299. */
  38300. readonly rotationInProgress: boolean;
  38301. private _onPrePointerObservableObserver;
  38302. private _onAfterCheckInputsObserver;
  38303. private _attachedCamera;
  38304. private _isPointerDown;
  38305. private _lastFrameTime;
  38306. private _lastInteractionTime;
  38307. private _cameraRotationSpeed;
  38308. /**
  38309. * Initializes the behavior.
  38310. */
  38311. init(): void;
  38312. /**
  38313. * Attaches the behavior to its arc rotate camera.
  38314. * @param camera Defines the camera to attach the behavior to
  38315. */
  38316. attach(camera: ArcRotateCamera): void;
  38317. /**
  38318. * Detaches the behavior from its current arc rotate camera.
  38319. */
  38320. detach(): void;
  38321. /**
  38322. * Returns true if user is scrolling.
  38323. * @return true if user is scrolling.
  38324. */
  38325. private _userIsZooming;
  38326. private _lastFrameRadius;
  38327. private _shouldAnimationStopForInteraction;
  38328. /**
  38329. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  38330. */
  38331. private _applyUserInteraction;
  38332. private _userIsMoving;
  38333. }
  38334. }
  38335. declare module "babylonjs/Behaviors/Cameras/index" {
  38336. export * from "babylonjs/Behaviors/Cameras/autoRotationBehavior";
  38337. export * from "babylonjs/Behaviors/Cameras/bouncingBehavior";
  38338. export * from "babylonjs/Behaviors/Cameras/framingBehavior";
  38339. }
  38340. declare module "babylonjs/Behaviors/Meshes/attachToBoxBehavior" {
  38341. import { Mesh } from "babylonjs/Meshes/mesh";
  38342. import { TransformNode } from "babylonjs/Meshes/transformNode";
  38343. import { Behavior } from "babylonjs/Behaviors/behavior";
  38344. /**
  38345. * A behavior that when attached to a mesh will will place a specified node on the meshes face pointing towards the camera
  38346. */
  38347. export class AttachToBoxBehavior implements Behavior<Mesh> {
  38348. private ui;
  38349. /**
  38350. * The name of the behavior
  38351. */
  38352. name: string;
  38353. /**
  38354. * The distance away from the face of the mesh that the UI should be attached to (default: 0.15)
  38355. */
  38356. distanceAwayFromFace: number;
  38357. /**
  38358. * The distance from the bottom of the face that the UI should be attached to (default: 0.15)
  38359. */
  38360. distanceAwayFromBottomOfFace: number;
  38361. private _faceVectors;
  38362. private _target;
  38363. private _scene;
  38364. private _onRenderObserver;
  38365. private _tmpMatrix;
  38366. private _tmpVector;
  38367. /**
  38368. * Creates the AttachToBoxBehavior, used to attach UI to the closest face of the box to a camera
  38369. * @param ui The transform node that should be attched to the mesh
  38370. */
  38371. constructor(ui: TransformNode);
  38372. /**
  38373. * Initializes the behavior
  38374. */
  38375. init(): void;
  38376. private _closestFace;
  38377. private _zeroVector;
  38378. private _lookAtTmpMatrix;
  38379. private _lookAtToRef;
  38380. /**
  38381. * Attaches the AttachToBoxBehavior to the passed in mesh
  38382. * @param target The mesh that the specified node will be attached to
  38383. */
  38384. attach(target: Mesh): void;
  38385. /**
  38386. * Detaches the behavior from the mesh
  38387. */
  38388. detach(): void;
  38389. }
  38390. }
  38391. declare module "babylonjs/Behaviors/Meshes/fadeInOutBehavior" {
  38392. import { Behavior } from "babylonjs/Behaviors/behavior";
  38393. import { Mesh } from "babylonjs/Meshes/mesh";
  38394. /**
  38395. * A behavior that when attached to a mesh will allow the mesh to fade in and out
  38396. */
  38397. export class FadeInOutBehavior implements Behavior<Mesh> {
  38398. /**
  38399. * Time in milliseconds to delay before fading in (Default: 0)
  38400. */
  38401. delay: number;
  38402. /**
  38403. * Time in milliseconds for the mesh to fade in (Default: 300)
  38404. */
  38405. fadeInTime: number;
  38406. private _millisecondsPerFrame;
  38407. private _hovered;
  38408. private _hoverValue;
  38409. private _ownerNode;
  38410. /**
  38411. * Instatiates the FadeInOutBehavior
  38412. */
  38413. constructor();
  38414. /**
  38415. * The name of the behavior
  38416. */
  38417. readonly name: string;
  38418. /**
  38419. * Initializes the behavior
  38420. */
  38421. init(): void;
  38422. /**
  38423. * Attaches the fade behavior on the passed in mesh
  38424. * @param ownerNode The mesh that will be faded in/out once attached
  38425. */
  38426. attach(ownerNode: Mesh): void;
  38427. /**
  38428. * Detaches the behavior from the mesh
  38429. */
  38430. detach(): void;
  38431. /**
  38432. * Triggers the mesh to begin fading in or out
  38433. * @param value if the object should fade in or out (true to fade in)
  38434. */
  38435. fadeIn(value: boolean): void;
  38436. private _update;
  38437. private _setAllVisibility;
  38438. }
  38439. }
  38440. declare module "babylonjs/Misc/pivotTools" {
  38441. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  38442. /**
  38443. * Class containing a set of static utilities functions for managing Pivots
  38444. * @hidden
  38445. */
  38446. export class PivotTools {
  38447. private static _PivotCached;
  38448. private static _OldPivotPoint;
  38449. private static _PivotTranslation;
  38450. private static _PivotTmpVector;
  38451. /** @hidden */
  38452. static _RemoveAndStorePivotPoint(mesh: AbstractMesh): void;
  38453. /** @hidden */
  38454. static _RestorePivotPoint(mesh: AbstractMesh): void;
  38455. }
  38456. }
  38457. declare module "babylonjs/Meshes/Builders/planeBuilder" {
  38458. import { Scene } from "babylonjs/scene";
  38459. import { Vector4 } from "babylonjs/Maths/math.vector";
  38460. import { Mesh } from "babylonjs/Meshes/mesh";
  38461. import { Nullable } from "babylonjs/types";
  38462. import { Plane } from "babylonjs/Maths/math.plane";
  38463. /**
  38464. * Class containing static functions to help procedurally build meshes
  38465. */
  38466. export class PlaneBuilder {
  38467. /**
  38468. * Creates a plane mesh
  38469. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  38470. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  38471. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  38472. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  38473. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  38474. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  38475. * @param name defines the name of the mesh
  38476. * @param options defines the options used to create the mesh
  38477. * @param scene defines the hosting scene
  38478. * @returns the plane mesh
  38479. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  38480. */
  38481. static CreatePlane(name: string, options: {
  38482. size?: number;
  38483. width?: number;
  38484. height?: number;
  38485. sideOrientation?: number;
  38486. frontUVs?: Vector4;
  38487. backUVs?: Vector4;
  38488. updatable?: boolean;
  38489. sourcePlane?: Plane;
  38490. }, scene?: Nullable<Scene>): Mesh;
  38491. }
  38492. }
  38493. declare module "babylonjs/Behaviors/Meshes/pointerDragBehavior" {
  38494. import { Behavior } from "babylonjs/Behaviors/behavior";
  38495. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  38496. import { Observable } from "babylonjs/Misc/observable";
  38497. import { Vector3 } from "babylonjs/Maths/math.vector";
  38498. import { Ray } from "babylonjs/Culling/ray";
  38499. import "babylonjs/Meshes/Builders/planeBuilder";
  38500. /**
  38501. * A behavior that when attached to a mesh will allow the mesh to be dragged around the screen based on pointer events
  38502. */
  38503. export class PointerDragBehavior implements Behavior<AbstractMesh> {
  38504. private static _AnyMouseID;
  38505. /**
  38506. * Abstract mesh the behavior is set on
  38507. */
  38508. attachedNode: AbstractMesh;
  38509. private _dragPlane;
  38510. private _scene;
  38511. private _pointerObserver;
  38512. private _beforeRenderObserver;
  38513. private static _planeScene;
  38514. private _useAlternatePickedPointAboveMaxDragAngleDragSpeed;
  38515. /**
  38516. * 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)
  38517. */
  38518. maxDragAngle: number;
  38519. /**
  38520. * @hidden
  38521. */
  38522. _useAlternatePickedPointAboveMaxDragAngle: boolean;
  38523. /**
  38524. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  38525. */
  38526. currentDraggingPointerID: number;
  38527. /**
  38528. * The last position where the pointer hit the drag plane in world space
  38529. */
  38530. lastDragPosition: Vector3;
  38531. /**
  38532. * If the behavior is currently in a dragging state
  38533. */
  38534. dragging: boolean;
  38535. /**
  38536. * 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)
  38537. */
  38538. dragDeltaRatio: number;
  38539. /**
  38540. * If the drag plane orientation should be updated during the dragging (Default: true)
  38541. */
  38542. updateDragPlane: boolean;
  38543. private _debugMode;
  38544. private _moving;
  38545. /**
  38546. * Fires each time the attached mesh is dragged with the pointer
  38547. * * delta between last drag position and current drag position in world space
  38548. * * dragDistance along the drag axis
  38549. * * dragPlaneNormal normal of the current drag plane used during the drag
  38550. * * dragPlanePoint in world space where the drag intersects the drag plane
  38551. */
  38552. onDragObservable: Observable<{
  38553. delta: Vector3;
  38554. dragPlanePoint: Vector3;
  38555. dragPlaneNormal: Vector3;
  38556. dragDistance: number;
  38557. pointerId: number;
  38558. }>;
  38559. /**
  38560. * Fires each time a drag begins (eg. mouse down on mesh)
  38561. */
  38562. onDragStartObservable: Observable<{
  38563. dragPlanePoint: Vector3;
  38564. pointerId: number;
  38565. }>;
  38566. /**
  38567. * Fires each time a drag ends (eg. mouse release after drag)
  38568. */
  38569. onDragEndObservable: Observable<{
  38570. dragPlanePoint: Vector3;
  38571. pointerId: number;
  38572. }>;
  38573. /**
  38574. * If the attached mesh should be moved when dragged
  38575. */
  38576. moveAttached: boolean;
  38577. /**
  38578. * If the drag behavior will react to drag events (Default: true)
  38579. */
  38580. enabled: boolean;
  38581. /**
  38582. * If pointer events should start and release the drag (Default: true)
  38583. */
  38584. startAndReleaseDragOnPointerEvents: boolean;
  38585. /**
  38586. * If camera controls should be detached during the drag
  38587. */
  38588. detachCameraControls: boolean;
  38589. /**
  38590. * If set, the drag plane/axis will be rotated based on the attached mesh's world rotation (Default: true)
  38591. */
  38592. useObjectOrienationForDragging: boolean;
  38593. private _options;
  38594. /**
  38595. * Creates a pointer drag behavior that can be attached to a mesh
  38596. * @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)
  38597. */
  38598. constructor(options?: {
  38599. dragAxis?: Vector3;
  38600. dragPlaneNormal?: Vector3;
  38601. });
  38602. /**
  38603. * Predicate to determine if it is valid to move the object to a new position when it is moved
  38604. */
  38605. validateDrag: (targetPosition: Vector3) => boolean;
  38606. /**
  38607. * The name of the behavior
  38608. */
  38609. readonly name: string;
  38610. /**
  38611. * Initializes the behavior
  38612. */
  38613. init(): void;
  38614. private _tmpVector;
  38615. private _alternatePickedPoint;
  38616. private _worldDragAxis;
  38617. private _targetPosition;
  38618. private _attachedElement;
  38619. /**
  38620. * Attaches the drag behavior the passed in mesh
  38621. * @param ownerNode The mesh that will be dragged around once attached
  38622. * @param predicate Predicate to use for pick filtering
  38623. */
  38624. attach(ownerNode: AbstractMesh, predicate?: (m: AbstractMesh) => boolean): void;
  38625. /**
  38626. * Force relase the drag action by code.
  38627. */
  38628. releaseDrag(): void;
  38629. private _startDragRay;
  38630. private _lastPointerRay;
  38631. /**
  38632. * Simulates the start of a pointer drag event on the behavior
  38633. * @param pointerId pointerID of the pointer that should be simulated (Default: Any mouse pointer ID)
  38634. * @param fromRay initial ray of the pointer to be simulated (Default: Ray from camera to attached mesh)
  38635. * @param startPickedPoint picked point of the pointer to be simulated (Default: attached mesh position)
  38636. */
  38637. startDrag(pointerId?: number, fromRay?: Ray, startPickedPoint?: Vector3): void;
  38638. private _startDrag;
  38639. private _dragDelta;
  38640. private _moveDrag;
  38641. private _pickWithRayOnDragPlane;
  38642. private _pointA;
  38643. private _pointB;
  38644. private _pointC;
  38645. private _lineA;
  38646. private _lineB;
  38647. private _localAxis;
  38648. private _lookAt;
  38649. private _updateDragPlanePosition;
  38650. /**
  38651. * Detaches the behavior from the mesh
  38652. */
  38653. detach(): void;
  38654. }
  38655. }
  38656. declare module "babylonjs/Behaviors/Meshes/multiPointerScaleBehavior" {
  38657. import { Mesh } from "babylonjs/Meshes/mesh";
  38658. import { Behavior } from "babylonjs/Behaviors/behavior";
  38659. /**
  38660. * A behavior that when attached to a mesh will allow the mesh to be scaled
  38661. */
  38662. export class MultiPointerScaleBehavior implements Behavior<Mesh> {
  38663. private _dragBehaviorA;
  38664. private _dragBehaviorB;
  38665. private _startDistance;
  38666. private _initialScale;
  38667. private _targetScale;
  38668. private _ownerNode;
  38669. private _sceneRenderObserver;
  38670. /**
  38671. * Instantiate a new behavior that when attached to a mesh will allow the mesh to be scaled
  38672. */
  38673. constructor();
  38674. /**
  38675. * The name of the behavior
  38676. */
  38677. readonly name: string;
  38678. /**
  38679. * Initializes the behavior
  38680. */
  38681. init(): void;
  38682. private _getCurrentDistance;
  38683. /**
  38684. * Attaches the scale behavior the passed in mesh
  38685. * @param ownerNode The mesh that will be scaled around once attached
  38686. */
  38687. attach(ownerNode: Mesh): void;
  38688. /**
  38689. * Detaches the behavior from the mesh
  38690. */
  38691. detach(): void;
  38692. }
  38693. }
  38694. declare module "babylonjs/Behaviors/Meshes/sixDofDragBehavior" {
  38695. import { Behavior } from "babylonjs/Behaviors/behavior";
  38696. import { Mesh } from "babylonjs/Meshes/mesh";
  38697. import { Observable } from "babylonjs/Misc/observable";
  38698. /**
  38699. * 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
  38700. */
  38701. export class SixDofDragBehavior implements Behavior<Mesh> {
  38702. private static _virtualScene;
  38703. private _ownerNode;
  38704. private _sceneRenderObserver;
  38705. private _scene;
  38706. private _targetPosition;
  38707. private _virtualOriginMesh;
  38708. private _virtualDragMesh;
  38709. private _pointerObserver;
  38710. private _moving;
  38711. private _startingOrientation;
  38712. /**
  38713. * 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)
  38714. */
  38715. private zDragFactor;
  38716. /**
  38717. * If the object should rotate to face the drag origin
  38718. */
  38719. rotateDraggedObject: boolean;
  38720. /**
  38721. * If the behavior is currently in a dragging state
  38722. */
  38723. dragging: boolean;
  38724. /**
  38725. * 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)
  38726. */
  38727. dragDeltaRatio: number;
  38728. /**
  38729. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  38730. */
  38731. currentDraggingPointerID: number;
  38732. /**
  38733. * If camera controls should be detached during the drag
  38734. */
  38735. detachCameraControls: boolean;
  38736. /**
  38737. * Fires each time a drag starts
  38738. */
  38739. onDragStartObservable: Observable<{}>;
  38740. /**
  38741. * Fires each time a drag ends (eg. mouse release after drag)
  38742. */
  38743. onDragEndObservable: Observable<{}>;
  38744. /**
  38745. * 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
  38746. */
  38747. constructor();
  38748. /**
  38749. * The name of the behavior
  38750. */
  38751. readonly name: string;
  38752. /**
  38753. * Initializes the behavior
  38754. */
  38755. init(): void;
  38756. /**
  38757. * In the case of multiplea active cameras, the cameraToUseForPointers should be used if set instead of active camera
  38758. */
  38759. private readonly _pointerCamera;
  38760. /**
  38761. * Attaches the scale behavior the passed in mesh
  38762. * @param ownerNode The mesh that will be scaled around once attached
  38763. */
  38764. attach(ownerNode: Mesh): void;
  38765. /**
  38766. * Detaches the behavior from the mesh
  38767. */
  38768. detach(): void;
  38769. }
  38770. }
  38771. declare module "babylonjs/Behaviors/Meshes/index" {
  38772. export * from "babylonjs/Behaviors/Meshes/attachToBoxBehavior";
  38773. export * from "babylonjs/Behaviors/Meshes/fadeInOutBehavior";
  38774. export * from "babylonjs/Behaviors/Meshes/multiPointerScaleBehavior";
  38775. export * from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  38776. export * from "babylonjs/Behaviors/Meshes/sixDofDragBehavior";
  38777. }
  38778. declare module "babylonjs/Behaviors/index" {
  38779. export * from "babylonjs/Behaviors/behavior";
  38780. export * from "babylonjs/Behaviors/Cameras/index";
  38781. export * from "babylonjs/Behaviors/Meshes/index";
  38782. }
  38783. declare module "babylonjs/Bones/boneIKController" {
  38784. import { Bone } from "babylonjs/Bones/bone";
  38785. import { Vector3 } from "babylonjs/Maths/math.vector";
  38786. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  38787. import { Nullable } from "babylonjs/types";
  38788. /**
  38789. * Class used to apply inverse kinematics to bones
  38790. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#boneikcontroller
  38791. */
  38792. export class BoneIKController {
  38793. private static _tmpVecs;
  38794. private static _tmpQuat;
  38795. private static _tmpMats;
  38796. /**
  38797. * Gets or sets the target mesh
  38798. */
  38799. targetMesh: AbstractMesh;
  38800. /** Gets or sets the mesh used as pole */
  38801. poleTargetMesh: AbstractMesh;
  38802. /**
  38803. * Gets or sets the bone used as pole
  38804. */
  38805. poleTargetBone: Nullable<Bone>;
  38806. /**
  38807. * Gets or sets the target position
  38808. */
  38809. targetPosition: Vector3;
  38810. /**
  38811. * Gets or sets the pole target position
  38812. */
  38813. poleTargetPosition: Vector3;
  38814. /**
  38815. * Gets or sets the pole target local offset
  38816. */
  38817. poleTargetLocalOffset: Vector3;
  38818. /**
  38819. * Gets or sets the pole angle
  38820. */
  38821. poleAngle: number;
  38822. /**
  38823. * Gets or sets the mesh associated with the controller
  38824. */
  38825. mesh: AbstractMesh;
  38826. /**
  38827. * 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)
  38828. */
  38829. slerpAmount: number;
  38830. private _bone1Quat;
  38831. private _bone1Mat;
  38832. private _bone2Ang;
  38833. private _bone1;
  38834. private _bone2;
  38835. private _bone1Length;
  38836. private _bone2Length;
  38837. private _maxAngle;
  38838. private _maxReach;
  38839. private _rightHandedSystem;
  38840. private _bendAxis;
  38841. private _slerping;
  38842. private _adjustRoll;
  38843. /**
  38844. * Gets or sets maximum allowed angle
  38845. */
  38846. maxAngle: number;
  38847. /**
  38848. * Creates a new BoneIKController
  38849. * @param mesh defines the mesh to control
  38850. * @param bone defines the bone to control
  38851. * @param options defines options to set up the controller
  38852. */
  38853. constructor(mesh: AbstractMesh, bone: Bone, options?: {
  38854. targetMesh?: AbstractMesh;
  38855. poleTargetMesh?: AbstractMesh;
  38856. poleTargetBone?: Bone;
  38857. poleTargetLocalOffset?: Vector3;
  38858. poleAngle?: number;
  38859. bendAxis?: Vector3;
  38860. maxAngle?: number;
  38861. slerpAmount?: number;
  38862. });
  38863. private _setMaxAngle;
  38864. /**
  38865. * Force the controller to update the bones
  38866. */
  38867. update(): void;
  38868. }
  38869. }
  38870. declare module "babylonjs/Bones/boneLookController" {
  38871. import { Vector3 } from "babylonjs/Maths/math.vector";
  38872. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  38873. import { Bone } from "babylonjs/Bones/bone";
  38874. import { Space } from "babylonjs/Maths/math.axis";
  38875. /**
  38876. * Class used to make a bone look toward a point in space
  38877. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#bonelookcontroller
  38878. */
  38879. export class BoneLookController {
  38880. private static _tmpVecs;
  38881. private static _tmpQuat;
  38882. private static _tmpMats;
  38883. /**
  38884. * The target Vector3 that the bone will look at
  38885. */
  38886. target: Vector3;
  38887. /**
  38888. * The mesh that the bone is attached to
  38889. */
  38890. mesh: AbstractMesh;
  38891. /**
  38892. * The bone that will be looking to the target
  38893. */
  38894. bone: Bone;
  38895. /**
  38896. * The up axis of the coordinate system that is used when the bone is rotated
  38897. */
  38898. upAxis: Vector3;
  38899. /**
  38900. * The space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD
  38901. */
  38902. upAxisSpace: Space;
  38903. /**
  38904. * Used to make an adjustment to the yaw of the bone
  38905. */
  38906. adjustYaw: number;
  38907. /**
  38908. * Used to make an adjustment to the pitch of the bone
  38909. */
  38910. adjustPitch: number;
  38911. /**
  38912. * Used to make an adjustment to the roll of the bone
  38913. */
  38914. adjustRoll: number;
  38915. /**
  38916. * 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)
  38917. */
  38918. slerpAmount: number;
  38919. private _minYaw;
  38920. private _maxYaw;
  38921. private _minPitch;
  38922. private _maxPitch;
  38923. private _minYawSin;
  38924. private _minYawCos;
  38925. private _maxYawSin;
  38926. private _maxYawCos;
  38927. private _midYawConstraint;
  38928. private _minPitchTan;
  38929. private _maxPitchTan;
  38930. private _boneQuat;
  38931. private _slerping;
  38932. private _transformYawPitch;
  38933. private _transformYawPitchInv;
  38934. private _firstFrameSkipped;
  38935. private _yawRange;
  38936. private _fowardAxis;
  38937. /**
  38938. * Gets or sets the minimum yaw angle that the bone can look to
  38939. */
  38940. minYaw: number;
  38941. /**
  38942. * Gets or sets the maximum yaw angle that the bone can look to
  38943. */
  38944. maxYaw: number;
  38945. /**
  38946. * Gets or sets the minimum pitch angle that the bone can look to
  38947. */
  38948. minPitch: number;
  38949. /**
  38950. * Gets or sets the maximum pitch angle that the bone can look to
  38951. */
  38952. maxPitch: number;
  38953. /**
  38954. * Create a BoneLookController
  38955. * @param mesh the mesh that the bone belongs to
  38956. * @param bone the bone that will be looking to the target
  38957. * @param target the target Vector3 to look at
  38958. * @param options optional settings:
  38959. * * maxYaw: the maximum angle the bone will yaw to
  38960. * * minYaw: the minimum angle the bone will yaw to
  38961. * * maxPitch: the maximum angle the bone will pitch to
  38962. * * minPitch: the minimum angle the bone will yaw to
  38963. * * slerpAmount: set the between 0 and 1 to make the bone slerp to the target.
  38964. * * upAxis: the up axis of the coordinate system
  38965. * * upAxisSpace: the space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD.
  38966. * * yawAxis: set yawAxis if the bone does not yaw on the y axis
  38967. * * pitchAxis: set pitchAxis if the bone does not pitch on the x axis
  38968. * * adjustYaw: used to make an adjustment to the yaw of the bone
  38969. * * adjustPitch: used to make an adjustment to the pitch of the bone
  38970. * * adjustRoll: used to make an adjustment to the roll of the bone
  38971. **/
  38972. constructor(mesh: AbstractMesh, bone: Bone, target: Vector3, options?: {
  38973. maxYaw?: number;
  38974. minYaw?: number;
  38975. maxPitch?: number;
  38976. minPitch?: number;
  38977. slerpAmount?: number;
  38978. upAxis?: Vector3;
  38979. upAxisSpace?: Space;
  38980. yawAxis?: Vector3;
  38981. pitchAxis?: Vector3;
  38982. adjustYaw?: number;
  38983. adjustPitch?: number;
  38984. adjustRoll?: number;
  38985. });
  38986. /**
  38987. * Update the bone to look at the target. This should be called before the scene is rendered (use scene.registerBeforeRender())
  38988. */
  38989. update(): void;
  38990. private _getAngleDiff;
  38991. private _getAngleBetween;
  38992. private _isAngleBetween;
  38993. }
  38994. }
  38995. declare module "babylonjs/Bones/index" {
  38996. export * from "babylonjs/Bones/bone";
  38997. export * from "babylonjs/Bones/boneIKController";
  38998. export * from "babylonjs/Bones/boneLookController";
  38999. export * from "babylonjs/Bones/skeleton";
  39000. }
  39001. declare module "babylonjs/Cameras/Inputs/arcRotateCameraGamepadInput" {
  39002. import { Nullable } from "babylonjs/types";
  39003. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  39004. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  39005. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  39006. /**
  39007. * Manage the gamepad inputs to control an arc rotate camera.
  39008. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  39009. */
  39010. export class ArcRotateCameraGamepadInput implements ICameraInput<ArcRotateCamera> {
  39011. /**
  39012. * Defines the camera the input is attached to.
  39013. */
  39014. camera: ArcRotateCamera;
  39015. /**
  39016. * Defines the gamepad the input is gathering event from.
  39017. */
  39018. gamepad: Nullable<Gamepad>;
  39019. /**
  39020. * Defines the gamepad rotation sensiblity.
  39021. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  39022. */
  39023. gamepadRotationSensibility: number;
  39024. /**
  39025. * Defines the gamepad move sensiblity.
  39026. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  39027. */
  39028. gamepadMoveSensibility: number;
  39029. private _yAxisScale;
  39030. /**
  39031. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  39032. */
  39033. invertYAxis: boolean;
  39034. private _onGamepadConnectedObserver;
  39035. private _onGamepadDisconnectedObserver;
  39036. /**
  39037. * Attach the input controls to a specific dom element to get the input from.
  39038. * @param element Defines the element the controls should be listened from
  39039. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  39040. */
  39041. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  39042. /**
  39043. * Detach the current controls from the specified dom element.
  39044. * @param element Defines the element to stop listening the inputs from
  39045. */
  39046. detachControl(element: Nullable<HTMLElement>): void;
  39047. /**
  39048. * Update the current camera state depending on the inputs that have been used this frame.
  39049. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  39050. */
  39051. checkInputs(): void;
  39052. /**
  39053. * Gets the class name of the current intput.
  39054. * @returns the class name
  39055. */
  39056. getClassName(): string;
  39057. /**
  39058. * Get the friendly name associated with the input class.
  39059. * @returns the input friendly name
  39060. */
  39061. getSimpleName(): string;
  39062. }
  39063. }
  39064. declare module "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput" {
  39065. import { Nullable } from "babylonjs/types";
  39066. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  39067. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  39068. module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  39069. interface ArcRotateCameraInputsManager {
  39070. /**
  39071. * Add orientation input support to the input manager.
  39072. * @returns the current input manager
  39073. */
  39074. addVRDeviceOrientation(): ArcRotateCameraInputsManager;
  39075. }
  39076. }
  39077. /**
  39078. * Manage the device orientation inputs (gyroscope) to control an arc rotate camera.
  39079. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  39080. */
  39081. export class ArcRotateCameraVRDeviceOrientationInput implements ICameraInput<ArcRotateCamera> {
  39082. /**
  39083. * Defines the camera the input is attached to.
  39084. */
  39085. camera: ArcRotateCamera;
  39086. /**
  39087. * Defines a correction factor applied on the alpha value retrieved from the orientation events.
  39088. */
  39089. alphaCorrection: number;
  39090. /**
  39091. * Defines a correction factor applied on the gamma value retrieved from the orientation events.
  39092. */
  39093. gammaCorrection: number;
  39094. private _alpha;
  39095. private _gamma;
  39096. private _dirty;
  39097. private _deviceOrientationHandler;
  39098. /**
  39099. * Instantiate a new ArcRotateCameraVRDeviceOrientationInput.
  39100. */
  39101. constructor();
  39102. /**
  39103. * Attach the input controls to a specific dom element to get the input from.
  39104. * @param element Defines the element the controls should be listened from
  39105. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  39106. */
  39107. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  39108. /** @hidden */
  39109. _onOrientationEvent(evt: DeviceOrientationEvent): void;
  39110. /**
  39111. * Update the current camera state depending on the inputs that have been used this frame.
  39112. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  39113. */
  39114. checkInputs(): void;
  39115. /**
  39116. * Detach the current controls from the specified dom element.
  39117. * @param element Defines the element to stop listening the inputs from
  39118. */
  39119. detachControl(element: Nullable<HTMLElement>): void;
  39120. /**
  39121. * Gets the class name of the current intput.
  39122. * @returns the class name
  39123. */
  39124. getClassName(): string;
  39125. /**
  39126. * Get the friendly name associated with the input class.
  39127. * @returns the input friendly name
  39128. */
  39129. getSimpleName(): string;
  39130. }
  39131. }
  39132. declare module "babylonjs/Cameras/Inputs/flyCameraMouseInput" {
  39133. import { Nullable } from "babylonjs/types";
  39134. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  39135. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  39136. /**
  39137. * Listen to mouse events to control the camera.
  39138. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  39139. */
  39140. export class FlyCameraMouseInput implements ICameraInput<FlyCamera> {
  39141. /**
  39142. * Defines the camera the input is attached to.
  39143. */
  39144. camera: FlyCamera;
  39145. /**
  39146. * Defines if touch is enabled. (Default is true.)
  39147. */
  39148. touchEnabled: boolean;
  39149. /**
  39150. * Defines the buttons associated with the input to handle camera rotation.
  39151. */
  39152. buttons: number[];
  39153. /**
  39154. * Assign buttons for Yaw control.
  39155. */
  39156. buttonsYaw: number[];
  39157. /**
  39158. * Assign buttons for Pitch control.
  39159. */
  39160. buttonsPitch: number[];
  39161. /**
  39162. * Assign buttons for Roll control.
  39163. */
  39164. buttonsRoll: number[];
  39165. /**
  39166. * Detect if any button is being pressed while mouse is moved.
  39167. * -1 = Mouse locked.
  39168. * 0 = Left button.
  39169. * 1 = Middle Button.
  39170. * 2 = Right Button.
  39171. */
  39172. activeButton: number;
  39173. /**
  39174. * Defines the pointer's angular sensibility, to control the camera rotation speed.
  39175. * Higher values reduce its sensitivity.
  39176. */
  39177. angularSensibility: number;
  39178. private _mousemoveCallback;
  39179. private _observer;
  39180. private _rollObserver;
  39181. private previousPosition;
  39182. private noPreventDefault;
  39183. private element;
  39184. /**
  39185. * Listen to mouse events to control the camera.
  39186. * @param touchEnabled Define if touch is enabled. (Default is true.)
  39187. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  39188. */
  39189. constructor(touchEnabled?: boolean);
  39190. /**
  39191. * Attach the mouse control to the HTML DOM element.
  39192. * @param element Defines the element that listens to the input events.
  39193. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault().
  39194. */
  39195. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  39196. /**
  39197. * Detach the current controls from the specified dom element.
  39198. * @param element Defines the element to stop listening the inputs from
  39199. */
  39200. detachControl(element: Nullable<HTMLElement>): void;
  39201. /**
  39202. * Gets the class name of the current input.
  39203. * @returns the class name.
  39204. */
  39205. getClassName(): string;
  39206. /**
  39207. * Get the friendly name associated with the input class.
  39208. * @returns the input's friendly name.
  39209. */
  39210. getSimpleName(): string;
  39211. private _pointerInput;
  39212. private _onMouseMove;
  39213. /**
  39214. * Rotate camera by mouse offset.
  39215. */
  39216. private rotateCamera;
  39217. }
  39218. }
  39219. declare module "babylonjs/Cameras/flyCameraInputsManager" {
  39220. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  39221. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  39222. /**
  39223. * Default Inputs manager for the FlyCamera.
  39224. * It groups all the default supported inputs for ease of use.
  39225. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  39226. */
  39227. export class FlyCameraInputsManager extends CameraInputsManager<FlyCamera> {
  39228. /**
  39229. * Instantiates a new FlyCameraInputsManager.
  39230. * @param camera Defines the camera the inputs belong to.
  39231. */
  39232. constructor(camera: FlyCamera);
  39233. /**
  39234. * Add keyboard input support to the input manager.
  39235. * @returns the new FlyCameraKeyboardMoveInput().
  39236. */
  39237. addKeyboard(): FlyCameraInputsManager;
  39238. /**
  39239. * Add mouse input support to the input manager.
  39240. * @param touchEnabled Enable touch screen support.
  39241. * @returns the new FlyCameraMouseInput().
  39242. */
  39243. addMouse(touchEnabled?: boolean): FlyCameraInputsManager;
  39244. }
  39245. }
  39246. declare module "babylonjs/Cameras/flyCamera" {
  39247. import { Scene } from "babylonjs/scene";
  39248. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  39249. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  39250. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  39251. import { FlyCameraInputsManager } from "babylonjs/Cameras/flyCameraInputsManager";
  39252. /**
  39253. * This is a flying camera, designed for 3D movement and rotation in all directions,
  39254. * such as in a 3D Space Shooter or a Flight Simulator.
  39255. */
  39256. export class FlyCamera extends TargetCamera {
  39257. /**
  39258. * Define the collision ellipsoid of the camera.
  39259. * This is helpful for simulating a camera body, like a player's body.
  39260. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  39261. */
  39262. ellipsoid: Vector3;
  39263. /**
  39264. * Define an offset for the position of the ellipsoid around the camera.
  39265. * This can be helpful if the camera is attached away from the player's body center,
  39266. * such as at its head.
  39267. */
  39268. ellipsoidOffset: Vector3;
  39269. /**
  39270. * Enable or disable collisions of the camera with the rest of the scene objects.
  39271. */
  39272. checkCollisions: boolean;
  39273. /**
  39274. * Enable or disable gravity on the camera.
  39275. */
  39276. applyGravity: boolean;
  39277. /**
  39278. * Define the current direction the camera is moving to.
  39279. */
  39280. cameraDirection: Vector3;
  39281. /**
  39282. * Define the current local rotation of the camera as a quaternion to prevent Gimbal lock.
  39283. * This overrides and empties cameraRotation.
  39284. */
  39285. rotationQuaternion: Quaternion;
  39286. /**
  39287. * Track Roll to maintain the wanted Rolling when looking around.
  39288. */
  39289. _trackRoll: number;
  39290. /**
  39291. * Slowly correct the Roll to its original value after a Pitch+Yaw rotation.
  39292. */
  39293. rollCorrect: number;
  39294. /**
  39295. * Mimic a banked turn, Rolling the camera when Yawing.
  39296. * It's recommended to use rollCorrect = 10 for faster banking correction.
  39297. */
  39298. bankedTurn: boolean;
  39299. /**
  39300. * Limit in radians for how much Roll banking will add. (Default: 90°)
  39301. */
  39302. bankedTurnLimit: number;
  39303. /**
  39304. * Value of 0 disables the banked Roll.
  39305. * Value of 1 is equal to the Yaw angle in radians.
  39306. */
  39307. bankedTurnMultiplier: number;
  39308. /**
  39309. * The inputs manager loads all the input sources, such as keyboard and mouse.
  39310. */
  39311. inputs: FlyCameraInputsManager;
  39312. /**
  39313. * Gets the input sensibility for mouse input.
  39314. * Higher values reduce sensitivity.
  39315. */
  39316. /**
  39317. * Sets the input sensibility for a mouse input.
  39318. * Higher values reduce sensitivity.
  39319. */
  39320. angularSensibility: number;
  39321. /**
  39322. * Get the keys for camera movement forward.
  39323. */
  39324. /**
  39325. * Set the keys for camera movement forward.
  39326. */
  39327. keysForward: number[];
  39328. /**
  39329. * Get the keys for camera movement backward.
  39330. */
  39331. keysBackward: number[];
  39332. /**
  39333. * Get the keys for camera movement up.
  39334. */
  39335. /**
  39336. * Set the keys for camera movement up.
  39337. */
  39338. keysUp: number[];
  39339. /**
  39340. * Get the keys for camera movement down.
  39341. */
  39342. /**
  39343. * Set the keys for camera movement down.
  39344. */
  39345. keysDown: number[];
  39346. /**
  39347. * Get the keys for camera movement left.
  39348. */
  39349. /**
  39350. * Set the keys for camera movement left.
  39351. */
  39352. keysLeft: number[];
  39353. /**
  39354. * Set the keys for camera movement right.
  39355. */
  39356. /**
  39357. * Set the keys for camera movement right.
  39358. */
  39359. keysRight: number[];
  39360. /**
  39361. * Event raised when the camera collides with a mesh in the scene.
  39362. */
  39363. onCollide: (collidedMesh: AbstractMesh) => void;
  39364. private _collider;
  39365. private _needMoveForGravity;
  39366. private _oldPosition;
  39367. private _diffPosition;
  39368. private _newPosition;
  39369. /** @hidden */
  39370. _localDirection: Vector3;
  39371. /** @hidden */
  39372. _transformedDirection: Vector3;
  39373. /**
  39374. * Instantiates a FlyCamera.
  39375. * This is a flying camera, designed for 3D movement and rotation in all directions,
  39376. * such as in a 3D Space Shooter or a Flight Simulator.
  39377. * @param name Define the name of the camera in the scene.
  39378. * @param position Define the starting position of the camera in the scene.
  39379. * @param scene Define the scene the camera belongs to.
  39380. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active, if no other camera has been defined as active.
  39381. */
  39382. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  39383. /**
  39384. * Attach a control to the HTML DOM element.
  39385. * @param element Defines the element that listens to the input events.
  39386. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault(). https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault
  39387. */
  39388. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  39389. /**
  39390. * Detach a control from the HTML DOM element.
  39391. * The camera will stop reacting to that input.
  39392. * @param element Defines the element that listens to the input events.
  39393. */
  39394. detachControl(element: HTMLElement): void;
  39395. private _collisionMask;
  39396. /**
  39397. * Get the mask that the camera ignores in collision events.
  39398. */
  39399. /**
  39400. * Set the mask that the camera ignores in collision events.
  39401. */
  39402. collisionMask: number;
  39403. /** @hidden */
  39404. _collideWithWorld(displacement: Vector3): void;
  39405. /** @hidden */
  39406. private _onCollisionPositionChange;
  39407. /** @hidden */
  39408. _checkInputs(): void;
  39409. /** @hidden */
  39410. _decideIfNeedsToMove(): boolean;
  39411. /** @hidden */
  39412. _updatePosition(): void;
  39413. /**
  39414. * Restore the Roll to its target value at the rate specified.
  39415. * @param rate - Higher means slower restoring.
  39416. * @hidden
  39417. */
  39418. restoreRoll(rate: number): void;
  39419. /**
  39420. * Destroy the camera and release the current resources held by it.
  39421. */
  39422. dispose(): void;
  39423. /**
  39424. * Get the current object class name.
  39425. * @returns the class name.
  39426. */
  39427. getClassName(): string;
  39428. }
  39429. }
  39430. declare module "babylonjs/Cameras/Inputs/flyCameraKeyboardInput" {
  39431. import { Nullable } from "babylonjs/types";
  39432. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  39433. import { FlyCamera } from "babylonjs/Cameras/flyCamera";
  39434. /**
  39435. * Listen to keyboard events to control the camera.
  39436. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  39437. */
  39438. export class FlyCameraKeyboardInput implements ICameraInput<FlyCamera> {
  39439. /**
  39440. * Defines the camera the input is attached to.
  39441. */
  39442. camera: FlyCamera;
  39443. /**
  39444. * The list of keyboard keys used to control the forward move of the camera.
  39445. */
  39446. keysForward: number[];
  39447. /**
  39448. * The list of keyboard keys used to control the backward move of the camera.
  39449. */
  39450. keysBackward: number[];
  39451. /**
  39452. * The list of keyboard keys used to control the forward move of the camera.
  39453. */
  39454. keysUp: number[];
  39455. /**
  39456. * The list of keyboard keys used to control the backward move of the camera.
  39457. */
  39458. keysDown: number[];
  39459. /**
  39460. * The list of keyboard keys used to control the right strafe move of the camera.
  39461. */
  39462. keysRight: number[];
  39463. /**
  39464. * The list of keyboard keys used to control the left strafe move of the camera.
  39465. */
  39466. keysLeft: number[];
  39467. private _keys;
  39468. private _onCanvasBlurObserver;
  39469. private _onKeyboardObserver;
  39470. private _engine;
  39471. private _scene;
  39472. /**
  39473. * Attach the input controls to a specific dom element to get the input from.
  39474. * @param element Defines the element the controls should be listened from
  39475. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  39476. */
  39477. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  39478. /**
  39479. * Detach the current controls from the specified dom element.
  39480. * @param element Defines the element to stop listening the inputs from
  39481. */
  39482. detachControl(element: Nullable<HTMLElement>): void;
  39483. /**
  39484. * Gets the class name of the current intput.
  39485. * @returns the class name
  39486. */
  39487. getClassName(): string;
  39488. /** @hidden */
  39489. _onLostFocus(e: FocusEvent): void;
  39490. /**
  39491. * Get the friendly name associated with the input class.
  39492. * @returns the input friendly name
  39493. */
  39494. getSimpleName(): string;
  39495. /**
  39496. * Update the current camera state depending on the inputs that have been used this frame.
  39497. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  39498. */
  39499. checkInputs(): void;
  39500. }
  39501. }
  39502. declare module "babylonjs/Cameras/Inputs/followCameraMouseWheelInput" {
  39503. import { Nullable } from "babylonjs/types";
  39504. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  39505. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  39506. /**
  39507. * Manage the mouse wheel inputs to control a follow camera.
  39508. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  39509. */
  39510. export class FollowCameraMouseWheelInput implements ICameraInput<FollowCamera> {
  39511. /**
  39512. * Defines the camera the input is attached to.
  39513. */
  39514. camera: FollowCamera;
  39515. /**
  39516. * Moue wheel controls zoom. (Mouse wheel modifies camera.radius value.)
  39517. */
  39518. axisControlRadius: boolean;
  39519. /**
  39520. * Moue wheel controls height. (Mouse wheel modifies camera.heightOffset value.)
  39521. */
  39522. axisControlHeight: boolean;
  39523. /**
  39524. * Moue wheel controls angle. (Mouse wheel modifies camera.rotationOffset value.)
  39525. */
  39526. axisControlRotation: boolean;
  39527. /**
  39528. * Gets or Set the mouse wheel precision or how fast is the camera moves in
  39529. * relation to mouseWheel events.
  39530. */
  39531. wheelPrecision: number;
  39532. /**
  39533. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  39534. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  39535. */
  39536. wheelDeltaPercentage: number;
  39537. private _wheel;
  39538. private _observer;
  39539. /**
  39540. * Attach the input controls to a specific dom element to get the input from.
  39541. * @param element Defines the element the controls should be listened from
  39542. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  39543. */
  39544. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  39545. /**
  39546. * Detach the current controls from the specified dom element.
  39547. * @param element Defines the element to stop listening the inputs from
  39548. */
  39549. detachControl(element: Nullable<HTMLElement>): void;
  39550. /**
  39551. * Gets the class name of the current intput.
  39552. * @returns the class name
  39553. */
  39554. getClassName(): string;
  39555. /**
  39556. * Get the friendly name associated with the input class.
  39557. * @returns the input friendly name
  39558. */
  39559. getSimpleName(): string;
  39560. }
  39561. }
  39562. declare module "babylonjs/Cameras/Inputs/followCameraPointersInput" {
  39563. import { Nullable } from "babylonjs/types";
  39564. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  39565. import { BaseCameraPointersInput } from "babylonjs/Cameras/Inputs/BaseCameraPointersInput";
  39566. import { PointerTouch } from "babylonjs/Events/pointerEvents";
  39567. /**
  39568. * Manage the pointers inputs to control an follow camera.
  39569. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  39570. */
  39571. export class FollowCameraPointersInput extends BaseCameraPointersInput {
  39572. /**
  39573. * Defines the camera the input is attached to.
  39574. */
  39575. camera: FollowCamera;
  39576. /**
  39577. * Gets the class name of the current input.
  39578. * @returns the class name
  39579. */
  39580. getClassName(): string;
  39581. /**
  39582. * Defines the pointer angular sensibility along the X axis or how fast is
  39583. * the camera rotating.
  39584. * A negative number will reverse the axis direction.
  39585. */
  39586. angularSensibilityX: number;
  39587. /**
  39588. * Defines the pointer angular sensibility along the Y axis or how fast is
  39589. * the camera rotating.
  39590. * A negative number will reverse the axis direction.
  39591. */
  39592. angularSensibilityY: number;
  39593. /**
  39594. * Defines the pointer pinch precision or how fast is the camera zooming.
  39595. * A negative number will reverse the axis direction.
  39596. */
  39597. pinchPrecision: number;
  39598. /**
  39599. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  39600. * from 0.
  39601. * It defines the percentage of current camera.radius to use as delta when
  39602. * pinch zoom is used.
  39603. */
  39604. pinchDeltaPercentage: number;
  39605. /**
  39606. * Pointer X axis controls zoom. (X axis modifies camera.radius value.)
  39607. */
  39608. axisXControlRadius: boolean;
  39609. /**
  39610. * Pointer X axis controls height. (X axis modifies camera.heightOffset value.)
  39611. */
  39612. axisXControlHeight: boolean;
  39613. /**
  39614. * Pointer X axis controls angle. (X axis modifies camera.rotationOffset value.)
  39615. */
  39616. axisXControlRotation: boolean;
  39617. /**
  39618. * Pointer Y axis controls zoom. (Y axis modifies camera.radius value.)
  39619. */
  39620. axisYControlRadius: boolean;
  39621. /**
  39622. * Pointer Y axis controls height. (Y axis modifies camera.heightOffset value.)
  39623. */
  39624. axisYControlHeight: boolean;
  39625. /**
  39626. * Pointer Y axis controls angle. (Y axis modifies camera.rotationOffset value.)
  39627. */
  39628. axisYControlRotation: boolean;
  39629. /**
  39630. * Pinch controls zoom. (Pinch modifies camera.radius value.)
  39631. */
  39632. axisPinchControlRadius: boolean;
  39633. /**
  39634. * Pinch controls height. (Pinch modifies camera.heightOffset value.)
  39635. */
  39636. axisPinchControlHeight: boolean;
  39637. /**
  39638. * Pinch controls angle. (Pinch modifies camera.rotationOffset value.)
  39639. */
  39640. axisPinchControlRotation: boolean;
  39641. /**
  39642. * Log error messages if basic misconfiguration has occurred.
  39643. */
  39644. warningEnable: boolean;
  39645. protected onTouch(pointA: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  39646. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  39647. private _warningCounter;
  39648. private _warning;
  39649. }
  39650. }
  39651. declare module "babylonjs/Cameras/followCameraInputsManager" {
  39652. import { CameraInputsManager } from "babylonjs/Cameras/cameraInputsManager";
  39653. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  39654. /**
  39655. * Default Inputs manager for the FollowCamera.
  39656. * It groups all the default supported inputs for ease of use.
  39657. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  39658. */
  39659. export class FollowCameraInputsManager extends CameraInputsManager<FollowCamera> {
  39660. /**
  39661. * Instantiates a new FollowCameraInputsManager.
  39662. * @param camera Defines the camera the inputs belong to
  39663. */
  39664. constructor(camera: FollowCamera);
  39665. /**
  39666. * Add keyboard input support to the input manager.
  39667. * @returns the current input manager
  39668. */
  39669. addKeyboard(): FollowCameraInputsManager;
  39670. /**
  39671. * Add mouse wheel input support to the input manager.
  39672. * @returns the current input manager
  39673. */
  39674. addMouseWheel(): FollowCameraInputsManager;
  39675. /**
  39676. * Add pointers input support to the input manager.
  39677. * @returns the current input manager
  39678. */
  39679. addPointers(): FollowCameraInputsManager;
  39680. /**
  39681. * Add orientation input support to the input manager.
  39682. * @returns the current input manager
  39683. */
  39684. addVRDeviceOrientation(): FollowCameraInputsManager;
  39685. }
  39686. }
  39687. declare module "babylonjs/Cameras/followCamera" {
  39688. import { Nullable } from "babylonjs/types";
  39689. import { TargetCamera } from "babylonjs/Cameras/targetCamera";
  39690. import { Scene } from "babylonjs/scene";
  39691. import { Vector3 } from "babylonjs/Maths/math.vector";
  39692. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  39693. import { FollowCameraInputsManager } from "babylonjs/Cameras/followCameraInputsManager";
  39694. /**
  39695. * A follow camera takes a mesh as a target and follows it as it moves. Both a free camera version followCamera and
  39696. * an arc rotate version arcFollowCamera are available.
  39697. * @see http://doc.babylonjs.com/features/cameras#follow-camera
  39698. */
  39699. export class FollowCamera extends TargetCamera {
  39700. /**
  39701. * Distance the follow camera should follow an object at
  39702. */
  39703. radius: number;
  39704. /**
  39705. * Minimum allowed distance of the camera to the axis of rotation
  39706. * (The camera can not get closer).
  39707. * This can help limiting how the Camera is able to move in the scene.
  39708. */
  39709. lowerRadiusLimit: Nullable<number>;
  39710. /**
  39711. * Maximum allowed distance of the camera to the axis of rotation
  39712. * (The camera can not get further).
  39713. * This can help limiting how the Camera is able to move in the scene.
  39714. */
  39715. upperRadiusLimit: Nullable<number>;
  39716. /**
  39717. * Define a rotation offset between the camera and the object it follows
  39718. */
  39719. rotationOffset: number;
  39720. /**
  39721. * Minimum allowed angle to camera position relative to target object.
  39722. * This can help limiting how the Camera is able to move in the scene.
  39723. */
  39724. lowerRotationOffsetLimit: Nullable<number>;
  39725. /**
  39726. * Maximum allowed angle to camera position relative to target object.
  39727. * This can help limiting how the Camera is able to move in the scene.
  39728. */
  39729. upperRotationOffsetLimit: Nullable<number>;
  39730. /**
  39731. * Define a height offset between the camera and the object it follows.
  39732. * It can help following an object from the top (like a car chaing a plane)
  39733. */
  39734. heightOffset: number;
  39735. /**
  39736. * Minimum allowed height of camera position relative to target object.
  39737. * This can help limiting how the Camera is able to move in the scene.
  39738. */
  39739. lowerHeightOffsetLimit: Nullable<number>;
  39740. /**
  39741. * Maximum allowed height of camera position relative to target object.
  39742. * This can help limiting how the Camera is able to move in the scene.
  39743. */
  39744. upperHeightOffsetLimit: Nullable<number>;
  39745. /**
  39746. * Define how fast the camera can accelerate to follow it s target.
  39747. */
  39748. cameraAcceleration: number;
  39749. /**
  39750. * Define the speed limit of the camera following an object.
  39751. */
  39752. maxCameraSpeed: number;
  39753. /**
  39754. * Define the target of the camera.
  39755. */
  39756. lockedTarget: Nullable<AbstractMesh>;
  39757. /**
  39758. * Defines the input associated with the camera.
  39759. */
  39760. inputs: FollowCameraInputsManager;
  39761. /**
  39762. * Instantiates the follow camera.
  39763. * @see http://doc.babylonjs.com/features/cameras#follow-camera
  39764. * @param name Define the name of the camera in the scene
  39765. * @param position Define the position of the camera
  39766. * @param scene Define the scene the camera belong to
  39767. * @param lockedTarget Define the target of the camera
  39768. */
  39769. constructor(name: string, position: Vector3, scene: Scene, lockedTarget?: Nullable<AbstractMesh>);
  39770. private _follow;
  39771. /**
  39772. * Attached controls to the current camera.
  39773. * @param element Defines the element the controls should be listened from
  39774. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  39775. */
  39776. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  39777. /**
  39778. * Detach the current controls from the camera.
  39779. * The camera will stop reacting to inputs.
  39780. * @param element Defines the element to stop listening the inputs from
  39781. */
  39782. detachControl(element: HTMLElement): void;
  39783. /** @hidden */
  39784. _checkInputs(): void;
  39785. private _checkLimits;
  39786. /**
  39787. * Gets the camera class name.
  39788. * @returns the class name
  39789. */
  39790. getClassName(): string;
  39791. }
  39792. /**
  39793. * Arc Rotate version of the follow camera.
  39794. * It still follows a Defined mesh but in an Arc Rotate Camera fashion.
  39795. * @see http://doc.babylonjs.com/features/cameras#follow-camera
  39796. */
  39797. export class ArcFollowCamera extends TargetCamera {
  39798. /** The longitudinal angle of the camera */
  39799. alpha: number;
  39800. /** The latitudinal angle of the camera */
  39801. beta: number;
  39802. /** The radius of the camera from its target */
  39803. radius: number;
  39804. /** Define the camera target (the messh it should follow) */
  39805. target: Nullable<AbstractMesh>;
  39806. private _cartesianCoordinates;
  39807. /**
  39808. * Instantiates a new ArcFollowCamera
  39809. * @see http://doc.babylonjs.com/features/cameras#follow-camera
  39810. * @param name Define the name of the camera
  39811. * @param alpha Define the rotation angle of the camera around the logitudinal axis
  39812. * @param beta Define the rotation angle of the camera around the elevation axis
  39813. * @param radius Define the radius of the camera from its target point
  39814. * @param target Define the target of the camera
  39815. * @param scene Define the scene the camera belongs to
  39816. */
  39817. constructor(name: string,
  39818. /** The longitudinal angle of the camera */
  39819. alpha: number,
  39820. /** The latitudinal angle of the camera */
  39821. beta: number,
  39822. /** The radius of the camera from its target */
  39823. radius: number,
  39824. /** Define the camera target (the messh it should follow) */
  39825. target: Nullable<AbstractMesh>, scene: Scene);
  39826. private _follow;
  39827. /** @hidden */
  39828. _checkInputs(): void;
  39829. /**
  39830. * Returns the class name of the object.
  39831. * It is mostly used internally for serialization purposes.
  39832. */
  39833. getClassName(): string;
  39834. }
  39835. }
  39836. declare module "babylonjs/Cameras/Inputs/followCameraKeyboardMoveInput" {
  39837. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  39838. import { FollowCamera } from "babylonjs/Cameras/followCamera";
  39839. import { Nullable } from "babylonjs/types";
  39840. /**
  39841. * Manage the keyboard inputs to control the movement of a follow camera.
  39842. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  39843. */
  39844. export class FollowCameraKeyboardMoveInput implements ICameraInput<FollowCamera> {
  39845. /**
  39846. * Defines the camera the input is attached to.
  39847. */
  39848. camera: FollowCamera;
  39849. /**
  39850. * Defines the list of key codes associated with the up action (increase heightOffset)
  39851. */
  39852. keysHeightOffsetIncr: number[];
  39853. /**
  39854. * Defines the list of key codes associated with the down action (decrease heightOffset)
  39855. */
  39856. keysHeightOffsetDecr: number[];
  39857. /**
  39858. * Defines whether the Alt modifier key is required to move up/down (alter heightOffset)
  39859. */
  39860. keysHeightOffsetModifierAlt: boolean;
  39861. /**
  39862. * Defines whether the Ctrl modifier key is required to move up/down (alter heightOffset)
  39863. */
  39864. keysHeightOffsetModifierCtrl: boolean;
  39865. /**
  39866. * Defines whether the Shift modifier key is required to move up/down (alter heightOffset)
  39867. */
  39868. keysHeightOffsetModifierShift: boolean;
  39869. /**
  39870. * Defines the list of key codes associated with the left action (increase rotationOffset)
  39871. */
  39872. keysRotationOffsetIncr: number[];
  39873. /**
  39874. * Defines the list of key codes associated with the right action (decrease rotationOffset)
  39875. */
  39876. keysRotationOffsetDecr: number[];
  39877. /**
  39878. * Defines whether the Alt modifier key is required to move left/right (alter rotationOffset)
  39879. */
  39880. keysRotationOffsetModifierAlt: boolean;
  39881. /**
  39882. * Defines whether the Ctrl modifier key is required to move left/right (alter rotationOffset)
  39883. */
  39884. keysRotationOffsetModifierCtrl: boolean;
  39885. /**
  39886. * Defines whether the Shift modifier key is required to move left/right (alter rotationOffset)
  39887. */
  39888. keysRotationOffsetModifierShift: boolean;
  39889. /**
  39890. * Defines the list of key codes associated with the zoom-in action (decrease radius)
  39891. */
  39892. keysRadiusIncr: number[];
  39893. /**
  39894. * Defines the list of key codes associated with the zoom-out action (increase radius)
  39895. */
  39896. keysRadiusDecr: number[];
  39897. /**
  39898. * Defines whether the Alt modifier key is required to zoom in/out (alter radius value)
  39899. */
  39900. keysRadiusModifierAlt: boolean;
  39901. /**
  39902. * Defines whether the Ctrl modifier key is required to zoom in/out (alter radius value)
  39903. */
  39904. keysRadiusModifierCtrl: boolean;
  39905. /**
  39906. * Defines whether the Shift modifier key is required to zoom in/out (alter radius value)
  39907. */
  39908. keysRadiusModifierShift: boolean;
  39909. /**
  39910. * Defines the rate of change of heightOffset.
  39911. */
  39912. heightSensibility: number;
  39913. /**
  39914. * Defines the rate of change of rotationOffset.
  39915. */
  39916. rotationSensibility: number;
  39917. /**
  39918. * Defines the rate of change of radius.
  39919. */
  39920. radiusSensibility: number;
  39921. private _keys;
  39922. private _ctrlPressed;
  39923. private _altPressed;
  39924. private _shiftPressed;
  39925. private _onCanvasBlurObserver;
  39926. private _onKeyboardObserver;
  39927. private _engine;
  39928. private _scene;
  39929. /**
  39930. * Attach the input controls to a specific dom element to get the input from.
  39931. * @param element Defines the element the controls should be listened from
  39932. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  39933. */
  39934. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  39935. /**
  39936. * Detach the current controls from the specified dom element.
  39937. * @param element Defines the element to stop listening the inputs from
  39938. */
  39939. detachControl(element: Nullable<HTMLElement>): void;
  39940. /**
  39941. * Update the current camera state depending on the inputs that have been used this frame.
  39942. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  39943. */
  39944. checkInputs(): void;
  39945. /**
  39946. * Gets the class name of the current input.
  39947. * @returns the class name
  39948. */
  39949. getClassName(): string;
  39950. /**
  39951. * Get the friendly name associated with the input class.
  39952. * @returns the input friendly name
  39953. */
  39954. getSimpleName(): string;
  39955. /**
  39956. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  39957. * allow modification of the heightOffset value.
  39958. */
  39959. private _modifierHeightOffset;
  39960. /**
  39961. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  39962. * allow modification of the rotationOffset value.
  39963. */
  39964. private _modifierRotationOffset;
  39965. /**
  39966. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  39967. * allow modification of the radius value.
  39968. */
  39969. private _modifierRadius;
  39970. }
  39971. }
  39972. declare module "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput" {
  39973. import { Nullable } from "babylonjs/types";
  39974. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  39975. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  39976. import { Observable } from "babylonjs/Misc/observable";
  39977. module "babylonjs/Cameras/freeCameraInputsManager" {
  39978. interface FreeCameraInputsManager {
  39979. /**
  39980. * @hidden
  39981. */
  39982. _deviceOrientationInput: Nullable<FreeCameraDeviceOrientationInput>;
  39983. /**
  39984. * Add orientation input support to the input manager.
  39985. * @returns the current input manager
  39986. */
  39987. addDeviceOrientation(): FreeCameraInputsManager;
  39988. }
  39989. }
  39990. /**
  39991. * Takes information about the orientation of the device as reported by the deviceorientation event to orient the camera.
  39992. * Screen rotation is taken into account.
  39993. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  39994. */
  39995. export class FreeCameraDeviceOrientationInput implements ICameraInput<FreeCamera> {
  39996. private _camera;
  39997. private _screenOrientationAngle;
  39998. private _constantTranform;
  39999. private _screenQuaternion;
  40000. private _alpha;
  40001. private _beta;
  40002. private _gamma;
  40003. /**
  40004. * Can be used to detect if a device orientation sensor is availible on a device
  40005. * @param timeout amount of time in milliseconds to wait for a response from the sensor (default: infinite)
  40006. * @returns a promise that will resolve on orientation change
  40007. */
  40008. static WaitForOrientationChangeAsync(timeout?: number): Promise<unknown>;
  40009. /**
  40010. * @hidden
  40011. */
  40012. _onDeviceOrientationChangedObservable: Observable<void>;
  40013. /**
  40014. * Instantiates a new input
  40015. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  40016. */
  40017. constructor();
  40018. /**
  40019. * Define the camera controlled by the input.
  40020. */
  40021. camera: FreeCamera;
  40022. /**
  40023. * Attach the input controls to a specific dom element to get the input from.
  40024. * @param element Defines the element the controls should be listened from
  40025. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  40026. */
  40027. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  40028. private _orientationChanged;
  40029. private _deviceOrientation;
  40030. /**
  40031. * Detach the current controls from the specified dom element.
  40032. * @param element Defines the element to stop listening the inputs from
  40033. */
  40034. detachControl(element: Nullable<HTMLElement>): void;
  40035. /**
  40036. * Update the current camera state depending on the inputs that have been used this frame.
  40037. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  40038. */
  40039. checkInputs(): void;
  40040. /**
  40041. * Gets the class name of the current intput.
  40042. * @returns the class name
  40043. */
  40044. getClassName(): string;
  40045. /**
  40046. * Get the friendly name associated with the input class.
  40047. * @returns the input friendly name
  40048. */
  40049. getSimpleName(): string;
  40050. }
  40051. }
  40052. declare module "babylonjs/Cameras/Inputs/freeCameraGamepadInput" {
  40053. import { Nullable } from "babylonjs/types";
  40054. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  40055. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  40056. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  40057. /**
  40058. * Manage the gamepad inputs to control a free camera.
  40059. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  40060. */
  40061. export class FreeCameraGamepadInput implements ICameraInput<FreeCamera> {
  40062. /**
  40063. * Define the camera the input is attached to.
  40064. */
  40065. camera: FreeCamera;
  40066. /**
  40067. * Define the Gamepad controlling the input
  40068. */
  40069. gamepad: Nullable<Gamepad>;
  40070. /**
  40071. * Defines the gamepad rotation sensiblity.
  40072. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  40073. */
  40074. gamepadAngularSensibility: number;
  40075. /**
  40076. * Defines the gamepad move sensiblity.
  40077. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  40078. */
  40079. gamepadMoveSensibility: number;
  40080. private _yAxisScale;
  40081. /**
  40082. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  40083. */
  40084. invertYAxis: boolean;
  40085. private _onGamepadConnectedObserver;
  40086. private _onGamepadDisconnectedObserver;
  40087. private _cameraTransform;
  40088. private _deltaTransform;
  40089. private _vector3;
  40090. private _vector2;
  40091. /**
  40092. * Attach the input controls to a specific dom element to get the input from.
  40093. * @param element Defines the element the controls should be listened from
  40094. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  40095. */
  40096. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  40097. /**
  40098. * Detach the current controls from the specified dom element.
  40099. * @param element Defines the element to stop listening the inputs from
  40100. */
  40101. detachControl(element: Nullable<HTMLElement>): void;
  40102. /**
  40103. * Update the current camera state depending on the inputs that have been used this frame.
  40104. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  40105. */
  40106. checkInputs(): void;
  40107. /**
  40108. * Gets the class name of the current intput.
  40109. * @returns the class name
  40110. */
  40111. getClassName(): string;
  40112. /**
  40113. * Get the friendly name associated with the input class.
  40114. * @returns the input friendly name
  40115. */
  40116. getSimpleName(): string;
  40117. }
  40118. }
  40119. declare module "babylonjs/Misc/virtualJoystick" {
  40120. import { Nullable } from "babylonjs/types";
  40121. import { Vector3 } from "babylonjs/Maths/math.vector";
  40122. /**
  40123. * Defines the potential axis of a Joystick
  40124. */
  40125. export enum JoystickAxis {
  40126. /** X axis */
  40127. X = 0,
  40128. /** Y axis */
  40129. Y = 1,
  40130. /** Z axis */
  40131. Z = 2
  40132. }
  40133. /**
  40134. * Class used to define virtual joystick (used in touch mode)
  40135. */
  40136. export class VirtualJoystick {
  40137. /**
  40138. * Gets or sets a boolean indicating that left and right values must be inverted
  40139. */
  40140. reverseLeftRight: boolean;
  40141. /**
  40142. * Gets or sets a boolean indicating that up and down values must be inverted
  40143. */
  40144. reverseUpDown: boolean;
  40145. /**
  40146. * Gets the offset value for the position (ie. the change of the position value)
  40147. */
  40148. deltaPosition: Vector3;
  40149. /**
  40150. * Gets a boolean indicating if the virtual joystick was pressed
  40151. */
  40152. pressed: boolean;
  40153. /**
  40154. * Canvas the virtual joystick will render onto, default z-index of this is 5
  40155. */
  40156. static Canvas: Nullable<HTMLCanvasElement>;
  40157. private static _globalJoystickIndex;
  40158. private static vjCanvasContext;
  40159. private static vjCanvasWidth;
  40160. private static vjCanvasHeight;
  40161. private static halfWidth;
  40162. private _action;
  40163. private _axisTargetedByLeftAndRight;
  40164. private _axisTargetedByUpAndDown;
  40165. private _joystickSensibility;
  40166. private _inversedSensibility;
  40167. private _joystickPointerID;
  40168. private _joystickColor;
  40169. private _joystickPointerPos;
  40170. private _joystickPreviousPointerPos;
  40171. private _joystickPointerStartPos;
  40172. private _deltaJoystickVector;
  40173. private _leftJoystick;
  40174. private _touches;
  40175. private _onPointerDownHandlerRef;
  40176. private _onPointerMoveHandlerRef;
  40177. private _onPointerUpHandlerRef;
  40178. private _onResize;
  40179. /**
  40180. * Creates a new virtual joystick
  40181. * @param leftJoystick defines that the joystick is for left hand (false by default)
  40182. */
  40183. constructor(leftJoystick?: boolean);
  40184. /**
  40185. * Defines joystick sensibility (ie. the ratio beteen a physical move and virtual joystick position change)
  40186. * @param newJoystickSensibility defines the new sensibility
  40187. */
  40188. setJoystickSensibility(newJoystickSensibility: number): void;
  40189. private _onPointerDown;
  40190. private _onPointerMove;
  40191. private _onPointerUp;
  40192. /**
  40193. * Change the color of the virtual joystick
  40194. * @param newColor a string that must be a CSS color value (like "red") or the hexa value (like "#FF0000")
  40195. */
  40196. setJoystickColor(newColor: string): void;
  40197. /**
  40198. * Defines a callback to call when the joystick is touched
  40199. * @param action defines the callback
  40200. */
  40201. setActionOnTouch(action: () => any): void;
  40202. /**
  40203. * Defines which axis you'd like to control for left & right
  40204. * @param axis defines the axis to use
  40205. */
  40206. setAxisForLeftRight(axis: JoystickAxis): void;
  40207. /**
  40208. * Defines which axis you'd like to control for up & down
  40209. * @param axis defines the axis to use
  40210. */
  40211. setAxisForUpDown(axis: JoystickAxis): void;
  40212. private _drawVirtualJoystick;
  40213. /**
  40214. * Release internal HTML canvas
  40215. */
  40216. releaseCanvas(): void;
  40217. }
  40218. }
  40219. declare module "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput" {
  40220. import { VirtualJoystick } from "babylonjs/Misc/virtualJoystick";
  40221. import { Nullable } from "babylonjs/types";
  40222. import { ICameraInput } from "babylonjs/Cameras/cameraInputsManager";
  40223. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  40224. module "babylonjs/Cameras/freeCameraInputsManager" {
  40225. interface FreeCameraInputsManager {
  40226. /**
  40227. * Add virtual joystick input support to the input manager.
  40228. * @returns the current input manager
  40229. */
  40230. addVirtualJoystick(): FreeCameraInputsManager;
  40231. }
  40232. }
  40233. /**
  40234. * Manage the Virtual Joystick inputs to control the movement of a free camera.
  40235. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  40236. */
  40237. export class FreeCameraVirtualJoystickInput implements ICameraInput<FreeCamera> {
  40238. /**
  40239. * Defines the camera the input is attached to.
  40240. */
  40241. camera: FreeCamera;
  40242. private _leftjoystick;
  40243. private _rightjoystick;
  40244. /**
  40245. * Gets the left stick of the virtual joystick.
  40246. * @returns The virtual Joystick
  40247. */
  40248. getLeftJoystick(): VirtualJoystick;
  40249. /**
  40250. * Gets the right stick of the virtual joystick.
  40251. * @returns The virtual Joystick
  40252. */
  40253. getRightJoystick(): VirtualJoystick;
  40254. /**
  40255. * Update the current camera state depending on the inputs that have been used this frame.
  40256. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  40257. */
  40258. checkInputs(): void;
  40259. /**
  40260. * Attach the input controls to a specific dom element to get the input from.
  40261. * @param element Defines the element the controls should be listened from
  40262. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  40263. */
  40264. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  40265. /**
  40266. * Detach the current controls from the specified dom element.
  40267. * @param element Defines the element to stop listening the inputs from
  40268. */
  40269. detachControl(element: Nullable<HTMLElement>): void;
  40270. /**
  40271. * Gets the class name of the current intput.
  40272. * @returns the class name
  40273. */
  40274. getClassName(): string;
  40275. /**
  40276. * Get the friendly name associated with the input class.
  40277. * @returns the input friendly name
  40278. */
  40279. getSimpleName(): string;
  40280. }
  40281. }
  40282. declare module "babylonjs/Cameras/Inputs/index" {
  40283. export * from "babylonjs/Cameras/Inputs/arcRotateCameraGamepadInput";
  40284. export * from "babylonjs/Cameras/Inputs/arcRotateCameraKeyboardMoveInput";
  40285. export * from "babylonjs/Cameras/Inputs/arcRotateCameraMouseWheelInput";
  40286. export * from "babylonjs/Cameras/Inputs/arcRotateCameraPointersInput";
  40287. export * from "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput";
  40288. export * from "babylonjs/Cameras/Inputs/flyCameraKeyboardInput";
  40289. export * from "babylonjs/Cameras/Inputs/flyCameraMouseInput";
  40290. export * from "babylonjs/Cameras/Inputs/followCameraKeyboardMoveInput";
  40291. export * from "babylonjs/Cameras/Inputs/followCameraMouseWheelInput";
  40292. export * from "babylonjs/Cameras/Inputs/followCameraPointersInput";
  40293. export * from "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput";
  40294. export * from "babylonjs/Cameras/Inputs/freeCameraGamepadInput";
  40295. export * from "babylonjs/Cameras/Inputs/freeCameraKeyboardMoveInput";
  40296. export * from "babylonjs/Cameras/Inputs/freeCameraMouseInput";
  40297. export * from "babylonjs/Cameras/Inputs/freeCameraTouchInput";
  40298. export * from "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput";
  40299. }
  40300. declare module "babylonjs/Cameras/touchCamera" {
  40301. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  40302. import { Scene } from "babylonjs/scene";
  40303. import { Vector3 } from "babylonjs/Maths/math.vector";
  40304. /**
  40305. * This represents a FPS type of camera controlled by touch.
  40306. * This is like a universal camera minus the Gamepad controls.
  40307. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  40308. */
  40309. export class TouchCamera extends FreeCamera {
  40310. /**
  40311. * Defines the touch sensibility for rotation.
  40312. * The higher the faster.
  40313. */
  40314. touchAngularSensibility: number;
  40315. /**
  40316. * Defines the touch sensibility for move.
  40317. * The higher the faster.
  40318. */
  40319. touchMoveSensibility: number;
  40320. /**
  40321. * Instantiates a new touch camera.
  40322. * This represents a FPS type of camera controlled by touch.
  40323. * This is like a universal camera minus the Gamepad controls.
  40324. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  40325. * @param name Define the name of the camera in the scene
  40326. * @param position Define the start position of the camera in the scene
  40327. * @param scene Define the scene the camera belongs to
  40328. */
  40329. constructor(name: string, position: Vector3, scene: Scene);
  40330. /**
  40331. * Gets the current object class name.
  40332. * @return the class name
  40333. */
  40334. getClassName(): string;
  40335. /** @hidden */
  40336. _setupInputs(): void;
  40337. }
  40338. }
  40339. declare module "babylonjs/Cameras/deviceOrientationCamera" {
  40340. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  40341. import { Scene } from "babylonjs/scene";
  40342. import { Vector3 } from "babylonjs/Maths/math.vector";
  40343. import "babylonjs/Cameras/Inputs/freeCameraDeviceOrientationInput";
  40344. import { Axis } from "babylonjs/Maths/math.axis";
  40345. /**
  40346. * This is a camera specifically designed to react to device orientation events such as a modern mobile device
  40347. * being tilted forward or back and left or right.
  40348. */
  40349. export class DeviceOrientationCamera extends FreeCamera {
  40350. private _initialQuaternion;
  40351. private _quaternionCache;
  40352. private _tmpDragQuaternion;
  40353. private _disablePointerInputWhenUsingDeviceOrientation;
  40354. /**
  40355. * Creates a new device orientation camera
  40356. * @param name The name of the camera
  40357. * @param position The start position camera
  40358. * @param scene The scene the camera belongs to
  40359. */
  40360. constructor(name: string, position: Vector3, scene: Scene);
  40361. /**
  40362. * Gets or sets a boolean indicating that pointer input must be disabled on first orientation sensor update (Default: true)
  40363. */
  40364. disablePointerInputWhenUsingDeviceOrientation: boolean;
  40365. private _dragFactor;
  40366. /**
  40367. * Enabled turning on the y axis when the orientation sensor is active
  40368. * @param dragFactor the factor that controls the turn speed (default: 1/300)
  40369. */
  40370. enableHorizontalDragging(dragFactor?: number): void;
  40371. /**
  40372. * Gets the current instance class name ("DeviceOrientationCamera").
  40373. * This helps avoiding instanceof at run time.
  40374. * @returns the class name
  40375. */
  40376. getClassName(): string;
  40377. /**
  40378. * @hidden
  40379. * Checks and applies the current values of the inputs to the camera. (Internal use only)
  40380. */
  40381. _checkInputs(): void;
  40382. /**
  40383. * Reset the camera to its default orientation on the specified axis only.
  40384. * @param axis The axis to reset
  40385. */
  40386. resetToCurrentRotation(axis?: Axis): void;
  40387. }
  40388. }
  40389. declare module "babylonjs/Gamepads/xboxGamepad" {
  40390. import { Observable } from "babylonjs/Misc/observable";
  40391. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  40392. /**
  40393. * Defines supported buttons for XBox360 compatible gamepads
  40394. */
  40395. export enum Xbox360Button {
  40396. /** A */
  40397. A = 0,
  40398. /** B */
  40399. B = 1,
  40400. /** X */
  40401. X = 2,
  40402. /** Y */
  40403. Y = 3,
  40404. /** Start */
  40405. Start = 4,
  40406. /** Back */
  40407. Back = 5,
  40408. /** Left button */
  40409. LB = 6,
  40410. /** Right button */
  40411. RB = 7,
  40412. /** Left stick */
  40413. LeftStick = 8,
  40414. /** Right stick */
  40415. RightStick = 9
  40416. }
  40417. /** Defines values for XBox360 DPad */
  40418. export enum Xbox360Dpad {
  40419. /** Up */
  40420. Up = 0,
  40421. /** Down */
  40422. Down = 1,
  40423. /** Left */
  40424. Left = 2,
  40425. /** Right */
  40426. Right = 3
  40427. }
  40428. /**
  40429. * Defines a XBox360 gamepad
  40430. */
  40431. export class Xbox360Pad extends Gamepad {
  40432. private _leftTrigger;
  40433. private _rightTrigger;
  40434. private _onlefttriggerchanged;
  40435. private _onrighttriggerchanged;
  40436. private _onbuttondown;
  40437. private _onbuttonup;
  40438. private _ondpaddown;
  40439. private _ondpadup;
  40440. /** Observable raised when a button is pressed */
  40441. onButtonDownObservable: Observable<Xbox360Button>;
  40442. /** Observable raised when a button is released */
  40443. onButtonUpObservable: Observable<Xbox360Button>;
  40444. /** Observable raised when a pad is pressed */
  40445. onPadDownObservable: Observable<Xbox360Dpad>;
  40446. /** Observable raised when a pad is released */
  40447. onPadUpObservable: Observable<Xbox360Dpad>;
  40448. private _buttonA;
  40449. private _buttonB;
  40450. private _buttonX;
  40451. private _buttonY;
  40452. private _buttonBack;
  40453. private _buttonStart;
  40454. private _buttonLB;
  40455. private _buttonRB;
  40456. private _buttonLeftStick;
  40457. private _buttonRightStick;
  40458. private _dPadUp;
  40459. private _dPadDown;
  40460. private _dPadLeft;
  40461. private _dPadRight;
  40462. private _isXboxOnePad;
  40463. /**
  40464. * Creates a new XBox360 gamepad object
  40465. * @param id defines the id of this gamepad
  40466. * @param index defines its index
  40467. * @param gamepad defines the internal HTML gamepad object
  40468. * @param xboxOne defines if it is a XBox One gamepad
  40469. */
  40470. constructor(id: string, index: number, gamepad: any, xboxOne?: boolean);
  40471. /**
  40472. * Defines the callback to call when left trigger is pressed
  40473. * @param callback defines the callback to use
  40474. */
  40475. onlefttriggerchanged(callback: (value: number) => void): void;
  40476. /**
  40477. * Defines the callback to call when right trigger is pressed
  40478. * @param callback defines the callback to use
  40479. */
  40480. onrighttriggerchanged(callback: (value: number) => void): void;
  40481. /**
  40482. * Gets the left trigger value
  40483. */
  40484. /**
  40485. * Sets the left trigger value
  40486. */
  40487. leftTrigger: number;
  40488. /**
  40489. * Gets the right trigger value
  40490. */
  40491. /**
  40492. * Sets the right trigger value
  40493. */
  40494. rightTrigger: number;
  40495. /**
  40496. * Defines the callback to call when a button is pressed
  40497. * @param callback defines the callback to use
  40498. */
  40499. onbuttondown(callback: (buttonPressed: Xbox360Button) => void): void;
  40500. /**
  40501. * Defines the callback to call when a button is released
  40502. * @param callback defines the callback to use
  40503. */
  40504. onbuttonup(callback: (buttonReleased: Xbox360Button) => void): void;
  40505. /**
  40506. * Defines the callback to call when a pad is pressed
  40507. * @param callback defines the callback to use
  40508. */
  40509. ondpaddown(callback: (dPadPressed: Xbox360Dpad) => void): void;
  40510. /**
  40511. * Defines the callback to call when a pad is released
  40512. * @param callback defines the callback to use
  40513. */
  40514. ondpadup(callback: (dPadReleased: Xbox360Dpad) => void): void;
  40515. private _setButtonValue;
  40516. private _setDPadValue;
  40517. /**
  40518. * Gets the value of the `A` button
  40519. */
  40520. /**
  40521. * Sets the value of the `A` button
  40522. */
  40523. buttonA: number;
  40524. /**
  40525. * Gets the value of the `B` button
  40526. */
  40527. /**
  40528. * Sets the value of the `B` button
  40529. */
  40530. buttonB: number;
  40531. /**
  40532. * Gets the value of the `X` button
  40533. */
  40534. /**
  40535. * Sets the value of the `X` button
  40536. */
  40537. buttonX: number;
  40538. /**
  40539. * Gets the value of the `Y` button
  40540. */
  40541. /**
  40542. * Sets the value of the `Y` button
  40543. */
  40544. buttonY: number;
  40545. /**
  40546. * Gets the value of the `Start` button
  40547. */
  40548. /**
  40549. * Sets the value of the `Start` button
  40550. */
  40551. buttonStart: number;
  40552. /**
  40553. * Gets the value of the `Back` button
  40554. */
  40555. /**
  40556. * Sets the value of the `Back` button
  40557. */
  40558. buttonBack: number;
  40559. /**
  40560. * Gets the value of the `Left` button
  40561. */
  40562. /**
  40563. * Sets the value of the `Left` button
  40564. */
  40565. buttonLB: number;
  40566. /**
  40567. * Gets the value of the `Right` button
  40568. */
  40569. /**
  40570. * Sets the value of the `Right` button
  40571. */
  40572. buttonRB: number;
  40573. /**
  40574. * Gets the value of the Left joystick
  40575. */
  40576. /**
  40577. * Sets the value of the Left joystick
  40578. */
  40579. buttonLeftStick: number;
  40580. /**
  40581. * Gets the value of the Right joystick
  40582. */
  40583. /**
  40584. * Sets the value of the Right joystick
  40585. */
  40586. buttonRightStick: number;
  40587. /**
  40588. * Gets the value of D-pad up
  40589. */
  40590. /**
  40591. * Sets the value of D-pad up
  40592. */
  40593. dPadUp: number;
  40594. /**
  40595. * Gets the value of D-pad down
  40596. */
  40597. /**
  40598. * Sets the value of D-pad down
  40599. */
  40600. dPadDown: number;
  40601. /**
  40602. * Gets the value of D-pad left
  40603. */
  40604. /**
  40605. * Sets the value of D-pad left
  40606. */
  40607. dPadLeft: number;
  40608. /**
  40609. * Gets the value of D-pad right
  40610. */
  40611. /**
  40612. * Sets the value of D-pad right
  40613. */
  40614. dPadRight: number;
  40615. /**
  40616. * Force the gamepad to synchronize with device values
  40617. */
  40618. update(): void;
  40619. /**
  40620. * Disposes the gamepad
  40621. */
  40622. dispose(): void;
  40623. }
  40624. }
  40625. declare module "babylonjs/Gamepads/dualShockGamepad" {
  40626. import { Observable } from "babylonjs/Misc/observable";
  40627. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  40628. /**
  40629. * Defines supported buttons for DualShock compatible gamepads
  40630. */
  40631. export enum DualShockButton {
  40632. /** Cross */
  40633. Cross = 0,
  40634. /** Circle */
  40635. Circle = 1,
  40636. /** Square */
  40637. Square = 2,
  40638. /** Triangle */
  40639. Triangle = 3,
  40640. /** Options */
  40641. Options = 4,
  40642. /** Share */
  40643. Share = 5,
  40644. /** L1 */
  40645. L1 = 6,
  40646. /** R1 */
  40647. R1 = 7,
  40648. /** Left stick */
  40649. LeftStick = 8,
  40650. /** Right stick */
  40651. RightStick = 9
  40652. }
  40653. /** Defines values for DualShock DPad */
  40654. export enum DualShockDpad {
  40655. /** Up */
  40656. Up = 0,
  40657. /** Down */
  40658. Down = 1,
  40659. /** Left */
  40660. Left = 2,
  40661. /** Right */
  40662. Right = 3
  40663. }
  40664. /**
  40665. * Defines a DualShock gamepad
  40666. */
  40667. export class DualShockPad extends Gamepad {
  40668. private _leftTrigger;
  40669. private _rightTrigger;
  40670. private _onlefttriggerchanged;
  40671. private _onrighttriggerchanged;
  40672. private _onbuttondown;
  40673. private _onbuttonup;
  40674. private _ondpaddown;
  40675. private _ondpadup;
  40676. /** Observable raised when a button is pressed */
  40677. onButtonDownObservable: Observable<DualShockButton>;
  40678. /** Observable raised when a button is released */
  40679. onButtonUpObservable: Observable<DualShockButton>;
  40680. /** Observable raised when a pad is pressed */
  40681. onPadDownObservable: Observable<DualShockDpad>;
  40682. /** Observable raised when a pad is released */
  40683. onPadUpObservable: Observable<DualShockDpad>;
  40684. private _buttonCross;
  40685. private _buttonCircle;
  40686. private _buttonSquare;
  40687. private _buttonTriangle;
  40688. private _buttonShare;
  40689. private _buttonOptions;
  40690. private _buttonL1;
  40691. private _buttonR1;
  40692. private _buttonLeftStick;
  40693. private _buttonRightStick;
  40694. private _dPadUp;
  40695. private _dPadDown;
  40696. private _dPadLeft;
  40697. private _dPadRight;
  40698. /**
  40699. * Creates a new DualShock gamepad object
  40700. * @param id defines the id of this gamepad
  40701. * @param index defines its index
  40702. * @param gamepad defines the internal HTML gamepad object
  40703. */
  40704. constructor(id: string, index: number, gamepad: any);
  40705. /**
  40706. * Defines the callback to call when left trigger is pressed
  40707. * @param callback defines the callback to use
  40708. */
  40709. onlefttriggerchanged(callback: (value: number) => void): void;
  40710. /**
  40711. * Defines the callback to call when right trigger is pressed
  40712. * @param callback defines the callback to use
  40713. */
  40714. onrighttriggerchanged(callback: (value: number) => void): void;
  40715. /**
  40716. * Gets the left trigger value
  40717. */
  40718. /**
  40719. * Sets the left trigger value
  40720. */
  40721. leftTrigger: number;
  40722. /**
  40723. * Gets the right trigger value
  40724. */
  40725. /**
  40726. * Sets the right trigger value
  40727. */
  40728. rightTrigger: number;
  40729. /**
  40730. * Defines the callback to call when a button is pressed
  40731. * @param callback defines the callback to use
  40732. */
  40733. onbuttondown(callback: (buttonPressed: DualShockButton) => void): void;
  40734. /**
  40735. * Defines the callback to call when a button is released
  40736. * @param callback defines the callback to use
  40737. */
  40738. onbuttonup(callback: (buttonReleased: DualShockButton) => void): void;
  40739. /**
  40740. * Defines the callback to call when a pad is pressed
  40741. * @param callback defines the callback to use
  40742. */
  40743. ondpaddown(callback: (dPadPressed: DualShockDpad) => void): void;
  40744. /**
  40745. * Defines the callback to call when a pad is released
  40746. * @param callback defines the callback to use
  40747. */
  40748. ondpadup(callback: (dPadReleased: DualShockDpad) => void): void;
  40749. private _setButtonValue;
  40750. private _setDPadValue;
  40751. /**
  40752. * Gets the value of the `Cross` button
  40753. */
  40754. /**
  40755. * Sets the value of the `Cross` button
  40756. */
  40757. buttonCross: number;
  40758. /**
  40759. * Gets the value of the `Circle` button
  40760. */
  40761. /**
  40762. * Sets the value of the `Circle` button
  40763. */
  40764. buttonCircle: number;
  40765. /**
  40766. * Gets the value of the `Square` button
  40767. */
  40768. /**
  40769. * Sets the value of the `Square` button
  40770. */
  40771. buttonSquare: number;
  40772. /**
  40773. * Gets the value of the `Triangle` button
  40774. */
  40775. /**
  40776. * Sets the value of the `Triangle` button
  40777. */
  40778. buttonTriangle: number;
  40779. /**
  40780. * Gets the value of the `Options` button
  40781. */
  40782. /**
  40783. * Sets the value of the `Options` button
  40784. */
  40785. buttonOptions: number;
  40786. /**
  40787. * Gets the value of the `Share` button
  40788. */
  40789. /**
  40790. * Sets the value of the `Share` button
  40791. */
  40792. buttonShare: number;
  40793. /**
  40794. * Gets the value of the `L1` button
  40795. */
  40796. /**
  40797. * Sets the value of the `L1` button
  40798. */
  40799. buttonL1: number;
  40800. /**
  40801. * Gets the value of the `R1` button
  40802. */
  40803. /**
  40804. * Sets the value of the `R1` button
  40805. */
  40806. buttonR1: number;
  40807. /**
  40808. * Gets the value of the Left joystick
  40809. */
  40810. /**
  40811. * Sets the value of the Left joystick
  40812. */
  40813. buttonLeftStick: number;
  40814. /**
  40815. * Gets the value of the Right joystick
  40816. */
  40817. /**
  40818. * Sets the value of the Right joystick
  40819. */
  40820. buttonRightStick: number;
  40821. /**
  40822. * Gets the value of D-pad up
  40823. */
  40824. /**
  40825. * Sets the value of D-pad up
  40826. */
  40827. dPadUp: number;
  40828. /**
  40829. * Gets the value of D-pad down
  40830. */
  40831. /**
  40832. * Sets the value of D-pad down
  40833. */
  40834. dPadDown: number;
  40835. /**
  40836. * Gets the value of D-pad left
  40837. */
  40838. /**
  40839. * Sets the value of D-pad left
  40840. */
  40841. dPadLeft: number;
  40842. /**
  40843. * Gets the value of D-pad right
  40844. */
  40845. /**
  40846. * Sets the value of D-pad right
  40847. */
  40848. dPadRight: number;
  40849. /**
  40850. * Force the gamepad to synchronize with device values
  40851. */
  40852. update(): void;
  40853. /**
  40854. * Disposes the gamepad
  40855. */
  40856. dispose(): void;
  40857. }
  40858. }
  40859. declare module "babylonjs/Gamepads/gamepadManager" {
  40860. import { Observable } from "babylonjs/Misc/observable";
  40861. import { Nullable } from "babylonjs/types";
  40862. import { Scene } from "babylonjs/scene";
  40863. import { Gamepad } from "babylonjs/Gamepads/gamepad";
  40864. /**
  40865. * Manager for handling gamepads
  40866. */
  40867. export class GamepadManager {
  40868. private _scene?;
  40869. private _babylonGamepads;
  40870. private _oneGamepadConnected;
  40871. /** @hidden */
  40872. _isMonitoring: boolean;
  40873. private _gamepadEventSupported;
  40874. private _gamepadSupport;
  40875. /**
  40876. * observable to be triggered when the gamepad controller has been connected
  40877. */
  40878. onGamepadConnectedObservable: Observable<Gamepad>;
  40879. /**
  40880. * observable to be triggered when the gamepad controller has been disconnected
  40881. */
  40882. onGamepadDisconnectedObservable: Observable<Gamepad>;
  40883. private _onGamepadConnectedEvent;
  40884. private _onGamepadDisconnectedEvent;
  40885. /**
  40886. * Initializes the gamepad manager
  40887. * @param _scene BabylonJS scene
  40888. */
  40889. constructor(_scene?: Scene | undefined);
  40890. /**
  40891. * The gamepads in the game pad manager
  40892. */
  40893. readonly gamepads: Gamepad[];
  40894. /**
  40895. * Get the gamepad controllers based on type
  40896. * @param type The type of gamepad controller
  40897. * @returns Nullable gamepad
  40898. */
  40899. getGamepadByType(type?: number): Nullable<Gamepad>;
  40900. /**
  40901. * Disposes the gamepad manager
  40902. */
  40903. dispose(): void;
  40904. private _addNewGamepad;
  40905. private _startMonitoringGamepads;
  40906. private _stopMonitoringGamepads;
  40907. /** @hidden */
  40908. _checkGamepadsStatus(): void;
  40909. private _updateGamepadObjects;
  40910. }
  40911. }
  40912. declare module "babylonjs/Gamepads/gamepadSceneComponent" {
  40913. import { Nullable } from "babylonjs/types";
  40914. import { Scene } from "babylonjs/scene";
  40915. import { ISceneComponent } from "babylonjs/sceneComponent";
  40916. import { GamepadManager } from "babylonjs/Gamepads/gamepadManager";
  40917. module "babylonjs/scene" {
  40918. interface Scene {
  40919. /** @hidden */
  40920. _gamepadManager: Nullable<GamepadManager>;
  40921. /**
  40922. * Gets the gamepad manager associated with the scene
  40923. * @see http://doc.babylonjs.com/how_to/how_to_use_gamepads
  40924. */
  40925. gamepadManager: GamepadManager;
  40926. }
  40927. }
  40928. module "babylonjs/Cameras/freeCameraInputsManager" {
  40929. /**
  40930. * Interface representing a free camera inputs manager
  40931. */
  40932. interface FreeCameraInputsManager {
  40933. /**
  40934. * Adds gamepad input support to the FreeCameraInputsManager.
  40935. * @returns the FreeCameraInputsManager
  40936. */
  40937. addGamepad(): FreeCameraInputsManager;
  40938. }
  40939. }
  40940. module "babylonjs/Cameras/arcRotateCameraInputsManager" {
  40941. /**
  40942. * Interface representing an arc rotate camera inputs manager
  40943. */
  40944. interface ArcRotateCameraInputsManager {
  40945. /**
  40946. * Adds gamepad input support to the ArcRotateCamera InputManager.
  40947. * @returns the camera inputs manager
  40948. */
  40949. addGamepad(): ArcRotateCameraInputsManager;
  40950. }
  40951. }
  40952. /**
  40953. * Defines the gamepad scene component responsible to manage gamepads in a given scene
  40954. */
  40955. export class GamepadSystemSceneComponent implements ISceneComponent {
  40956. /**
  40957. * The component name helpfull to identify the component in the list of scene components.
  40958. */
  40959. readonly name: string;
  40960. /**
  40961. * The scene the component belongs to.
  40962. */
  40963. scene: Scene;
  40964. /**
  40965. * Creates a new instance of the component for the given scene
  40966. * @param scene Defines the scene to register the component in
  40967. */
  40968. constructor(scene: Scene);
  40969. /**
  40970. * Registers the component in a given scene
  40971. */
  40972. register(): void;
  40973. /**
  40974. * Rebuilds the elements related to this component in case of
  40975. * context lost for instance.
  40976. */
  40977. rebuild(): void;
  40978. /**
  40979. * Disposes the component and the associated ressources
  40980. */
  40981. dispose(): void;
  40982. private _beforeCameraUpdate;
  40983. }
  40984. }
  40985. declare module "babylonjs/Cameras/universalCamera" {
  40986. import { TouchCamera } from "babylonjs/Cameras/touchCamera";
  40987. import { Scene } from "babylonjs/scene";
  40988. import { Vector3 } from "babylonjs/Maths/math.vector";
  40989. import "babylonjs/Gamepads/gamepadSceneComponent";
  40990. /**
  40991. * 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,
  40992. * which still works and will still be found in many Playgrounds.
  40993. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  40994. */
  40995. export class UniversalCamera extends TouchCamera {
  40996. /**
  40997. * Defines the gamepad rotation sensiblity.
  40998. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  40999. */
  41000. gamepadAngularSensibility: number;
  41001. /**
  41002. * Defines the gamepad move sensiblity.
  41003. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  41004. */
  41005. gamepadMoveSensibility: number;
  41006. /**
  41007. * 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,
  41008. * which still works and will still be found in many Playgrounds.
  41009. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  41010. * @param name Define the name of the camera in the scene
  41011. * @param position Define the start position of the camera in the scene
  41012. * @param scene Define the scene the camera belongs to
  41013. */
  41014. constructor(name: string, position: Vector3, scene: Scene);
  41015. /**
  41016. * Gets the current object class name.
  41017. * @return the class name
  41018. */
  41019. getClassName(): string;
  41020. }
  41021. }
  41022. declare module "babylonjs/Cameras/gamepadCamera" {
  41023. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  41024. import { Scene } from "babylonjs/scene";
  41025. import { Vector3 } from "babylonjs/Maths/math.vector";
  41026. /**
  41027. * This represents a FPS type of camera. This is only here for back compat purpose.
  41028. * Please use the UniversalCamera instead as both are identical.
  41029. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  41030. */
  41031. export class GamepadCamera extends UniversalCamera {
  41032. /**
  41033. * Instantiates a new Gamepad Camera
  41034. * This represents a FPS type of camera. This is only here for back compat purpose.
  41035. * Please use the UniversalCamera instead as both are identical.
  41036. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  41037. * @param name Define the name of the camera in the scene
  41038. * @param position Define the start position of the camera in the scene
  41039. * @param scene Define the scene the camera belongs to
  41040. */
  41041. constructor(name: string, position: Vector3, scene: Scene);
  41042. /**
  41043. * Gets the current object class name.
  41044. * @return the class name
  41045. */
  41046. getClassName(): string;
  41047. }
  41048. }
  41049. declare module "babylonjs/Shaders/pass.fragment" {
  41050. /** @hidden */
  41051. export var passPixelShader: {
  41052. name: string;
  41053. shader: string;
  41054. };
  41055. }
  41056. declare module "babylonjs/Shaders/passCube.fragment" {
  41057. /** @hidden */
  41058. export var passCubePixelShader: {
  41059. name: string;
  41060. shader: string;
  41061. };
  41062. }
  41063. declare module "babylonjs/PostProcesses/passPostProcess" {
  41064. import { Nullable } from "babylonjs/types";
  41065. import { Camera } from "babylonjs/Cameras/camera";
  41066. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  41067. import { Engine } from "babylonjs/Engines/engine";
  41068. import "babylonjs/Shaders/pass.fragment";
  41069. import "babylonjs/Shaders/passCube.fragment";
  41070. /**
  41071. * PassPostProcess which produces an output the same as it's input
  41072. */
  41073. export class PassPostProcess extends PostProcess {
  41074. /**
  41075. * Creates the PassPostProcess
  41076. * @param name The name of the effect.
  41077. * @param options The required width/height ratio to downsize to before computing the render pass.
  41078. * @param camera The camera to apply the render pass to.
  41079. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  41080. * @param engine The engine which the post process will be applied. (default: current engine)
  41081. * @param reusable If the post process can be reused on the same frame. (default: false)
  41082. * @param textureType The type of texture to be used when performing the post processing.
  41083. * @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)
  41084. */
  41085. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  41086. }
  41087. /**
  41088. * PassCubePostProcess which produces an output the same as it's input (which must be a cube texture)
  41089. */
  41090. export class PassCubePostProcess extends PostProcess {
  41091. private _face;
  41092. /**
  41093. * Gets or sets the cube face to display.
  41094. * * 0 is +X
  41095. * * 1 is -X
  41096. * * 2 is +Y
  41097. * * 3 is -Y
  41098. * * 4 is +Z
  41099. * * 5 is -Z
  41100. */
  41101. face: number;
  41102. /**
  41103. * Creates the PassCubePostProcess
  41104. * @param name The name of the effect.
  41105. * @param options The required width/height ratio to downsize to before computing the render pass.
  41106. * @param camera The camera to apply the render pass to.
  41107. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  41108. * @param engine The engine which the post process will be applied. (default: current engine)
  41109. * @param reusable If the post process can be reused on the same frame. (default: false)
  41110. * @param textureType The type of texture to be used when performing the post processing.
  41111. * @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)
  41112. */
  41113. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  41114. }
  41115. }
  41116. declare module "babylonjs/Shaders/anaglyph.fragment" {
  41117. /** @hidden */
  41118. export var anaglyphPixelShader: {
  41119. name: string;
  41120. shader: string;
  41121. };
  41122. }
  41123. declare module "babylonjs/PostProcesses/anaglyphPostProcess" {
  41124. import { Engine } from "babylonjs/Engines/engine";
  41125. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  41126. import { Camera } from "babylonjs/Cameras/camera";
  41127. import "babylonjs/Shaders/anaglyph.fragment";
  41128. /**
  41129. * Postprocess used to generate anaglyphic rendering
  41130. */
  41131. export class AnaglyphPostProcess extends PostProcess {
  41132. private _passedProcess;
  41133. /**
  41134. * Creates a new AnaglyphPostProcess
  41135. * @param name defines postprocess name
  41136. * @param options defines creation options or target ratio scale
  41137. * @param rigCameras defines cameras using this postprocess
  41138. * @param samplingMode defines required sampling mode (BABYLON.Texture.NEAREST_SAMPLINGMODE by default)
  41139. * @param engine defines hosting engine
  41140. * @param reusable defines if the postprocess will be reused multiple times per frame
  41141. */
  41142. constructor(name: string, options: number | PostProcessOptions, rigCameras: Camera[], samplingMode?: number, engine?: Engine, reusable?: boolean);
  41143. }
  41144. }
  41145. declare module "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode" { }
  41146. declare module "babylonjs/Cameras/Stereoscopic/anaglyphArcRotateCamera" {
  41147. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  41148. import { Scene } from "babylonjs/scene";
  41149. import { Vector3 } from "babylonjs/Maths/math.vector";
  41150. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  41151. /**
  41152. * Camera used to simulate anaglyphic rendering (based on ArcRotateCamera)
  41153. * @see http://doc.babylonjs.com/features/cameras#anaglyph-cameras
  41154. */
  41155. export class AnaglyphArcRotateCamera extends ArcRotateCamera {
  41156. /**
  41157. * Creates a new AnaglyphArcRotateCamera
  41158. * @param name defines camera name
  41159. * @param alpha defines alpha angle (in radians)
  41160. * @param beta defines beta angle (in radians)
  41161. * @param radius defines radius
  41162. * @param target defines camera target
  41163. * @param interaxialDistance defines distance between each color axis
  41164. * @param scene defines the hosting scene
  41165. */
  41166. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, scene: Scene);
  41167. /**
  41168. * Gets camera class name
  41169. * @returns AnaglyphArcRotateCamera
  41170. */
  41171. getClassName(): string;
  41172. }
  41173. }
  41174. declare module "babylonjs/Cameras/Stereoscopic/anaglyphFreeCamera" {
  41175. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  41176. import { Scene } from "babylonjs/scene";
  41177. import { Vector3 } from "babylonjs/Maths/math.vector";
  41178. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  41179. /**
  41180. * Camera used to simulate anaglyphic rendering (based on FreeCamera)
  41181. * @see http://doc.babylonjs.com/features/cameras#anaglyph-cameras
  41182. */
  41183. export class AnaglyphFreeCamera extends FreeCamera {
  41184. /**
  41185. * Creates a new AnaglyphFreeCamera
  41186. * @param name defines camera name
  41187. * @param position defines initial position
  41188. * @param interaxialDistance defines distance between each color axis
  41189. * @param scene defines the hosting scene
  41190. */
  41191. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  41192. /**
  41193. * Gets camera class name
  41194. * @returns AnaglyphFreeCamera
  41195. */
  41196. getClassName(): string;
  41197. }
  41198. }
  41199. declare module "babylonjs/Cameras/Stereoscopic/anaglyphGamepadCamera" {
  41200. import { GamepadCamera } from "babylonjs/Cameras/gamepadCamera";
  41201. import { Scene } from "babylonjs/scene";
  41202. import { Vector3 } from "babylonjs/Maths/math.vector";
  41203. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  41204. /**
  41205. * Camera used to simulate anaglyphic rendering (based on GamepadCamera)
  41206. * @see http://doc.babylonjs.com/features/cameras#anaglyph-cameras
  41207. */
  41208. export class AnaglyphGamepadCamera extends GamepadCamera {
  41209. /**
  41210. * Creates a new AnaglyphGamepadCamera
  41211. * @param name defines camera name
  41212. * @param position defines initial position
  41213. * @param interaxialDistance defines distance between each color axis
  41214. * @param scene defines the hosting scene
  41215. */
  41216. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  41217. /**
  41218. * Gets camera class name
  41219. * @returns AnaglyphGamepadCamera
  41220. */
  41221. getClassName(): string;
  41222. }
  41223. }
  41224. declare module "babylonjs/Cameras/Stereoscopic/anaglyphUniversalCamera" {
  41225. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  41226. import { Scene } from "babylonjs/scene";
  41227. import { Vector3 } from "babylonjs/Maths/math.vector";
  41228. import "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  41229. /**
  41230. * Camera used to simulate anaglyphic rendering (based on UniversalCamera)
  41231. * @see http://doc.babylonjs.com/features/cameras#anaglyph-cameras
  41232. */
  41233. export class AnaglyphUniversalCamera extends UniversalCamera {
  41234. /**
  41235. * Creates a new AnaglyphUniversalCamera
  41236. * @param name defines camera name
  41237. * @param position defines initial position
  41238. * @param interaxialDistance defines distance between each color axis
  41239. * @param scene defines the hosting scene
  41240. */
  41241. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  41242. /**
  41243. * Gets camera class name
  41244. * @returns AnaglyphUniversalCamera
  41245. */
  41246. getClassName(): string;
  41247. }
  41248. }
  41249. declare module "babylonjs/Shaders/stereoscopicInterlace.fragment" {
  41250. /** @hidden */
  41251. export var stereoscopicInterlacePixelShader: {
  41252. name: string;
  41253. shader: string;
  41254. };
  41255. }
  41256. declare module "babylonjs/PostProcesses/stereoscopicInterlacePostProcess" {
  41257. import { Camera } from "babylonjs/Cameras/camera";
  41258. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  41259. import { Engine } from "babylonjs/Engines/engine";
  41260. import "babylonjs/Shaders/stereoscopicInterlace.fragment";
  41261. /**
  41262. * StereoscopicInterlacePostProcess used to render stereo views from a rigged camera
  41263. */
  41264. export class StereoscopicInterlacePostProcess extends PostProcess {
  41265. private _stepSize;
  41266. private _passedProcess;
  41267. /**
  41268. * Initializes a StereoscopicInterlacePostProcess
  41269. * @param name The name of the effect.
  41270. * @param rigCameras The rig cameras to be appled to the post process
  41271. * @param isStereoscopicHoriz If the rendered results are horizontal or verticle
  41272. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  41273. * @param engine The engine which the post process will be applied. (default: current engine)
  41274. * @param reusable If the post process can be reused on the same frame. (default: false)
  41275. */
  41276. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  41277. }
  41278. }
  41279. declare module "babylonjs/Cameras/RigModes/stereoscopicRigMode" { }
  41280. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicArcRotateCamera" {
  41281. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  41282. import { Scene } from "babylonjs/scene";
  41283. import { Vector3 } from "babylonjs/Maths/math.vector";
  41284. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  41285. /**
  41286. * Camera used to simulate stereoscopic rendering (based on ArcRotateCamera)
  41287. * @see http://doc.babylonjs.com/features/cameras
  41288. */
  41289. export class StereoscopicArcRotateCamera extends ArcRotateCamera {
  41290. /**
  41291. * Creates a new StereoscopicArcRotateCamera
  41292. * @param name defines camera name
  41293. * @param alpha defines alpha angle (in radians)
  41294. * @param beta defines beta angle (in radians)
  41295. * @param radius defines radius
  41296. * @param target defines camera target
  41297. * @param interaxialDistance defines distance between each color axis
  41298. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  41299. * @param scene defines the hosting scene
  41300. */
  41301. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  41302. /**
  41303. * Gets camera class name
  41304. * @returns StereoscopicArcRotateCamera
  41305. */
  41306. getClassName(): string;
  41307. }
  41308. }
  41309. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicFreeCamera" {
  41310. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  41311. import { Scene } from "babylonjs/scene";
  41312. import { Vector3 } from "babylonjs/Maths/math.vector";
  41313. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  41314. /**
  41315. * Camera used to simulate stereoscopic rendering (based on FreeCamera)
  41316. * @see http://doc.babylonjs.com/features/cameras
  41317. */
  41318. export class StereoscopicFreeCamera extends FreeCamera {
  41319. /**
  41320. * Creates a new StereoscopicFreeCamera
  41321. * @param name defines camera name
  41322. * @param position defines initial position
  41323. * @param interaxialDistance defines distance between each color axis
  41324. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  41325. * @param scene defines the hosting scene
  41326. */
  41327. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  41328. /**
  41329. * Gets camera class name
  41330. * @returns StereoscopicFreeCamera
  41331. */
  41332. getClassName(): string;
  41333. }
  41334. }
  41335. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicGamepadCamera" {
  41336. import { GamepadCamera } from "babylonjs/Cameras/gamepadCamera";
  41337. import { Scene } from "babylonjs/scene";
  41338. import { Vector3 } from "babylonjs/Maths/math.vector";
  41339. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  41340. /**
  41341. * Camera used to simulate stereoscopic rendering (based on GamepadCamera)
  41342. * @see http://doc.babylonjs.com/features/cameras
  41343. */
  41344. export class StereoscopicGamepadCamera extends GamepadCamera {
  41345. /**
  41346. * Creates a new StereoscopicGamepadCamera
  41347. * @param name defines camera name
  41348. * @param position defines initial position
  41349. * @param interaxialDistance defines distance between each color axis
  41350. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  41351. * @param scene defines the hosting scene
  41352. */
  41353. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  41354. /**
  41355. * Gets camera class name
  41356. * @returns StereoscopicGamepadCamera
  41357. */
  41358. getClassName(): string;
  41359. }
  41360. }
  41361. declare module "babylonjs/Cameras/Stereoscopic/stereoscopicUniversalCamera" {
  41362. import { UniversalCamera } from "babylonjs/Cameras/universalCamera";
  41363. import { Scene } from "babylonjs/scene";
  41364. import { Vector3 } from "babylonjs/Maths/math.vector";
  41365. import "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  41366. /**
  41367. * Camera used to simulate stereoscopic rendering (based on UniversalCamera)
  41368. * @see http://doc.babylonjs.com/features/cameras
  41369. */
  41370. export class StereoscopicUniversalCamera extends UniversalCamera {
  41371. /**
  41372. * Creates a new StereoscopicUniversalCamera
  41373. * @param name defines camera name
  41374. * @param position defines initial position
  41375. * @param interaxialDistance defines distance between each color axis
  41376. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  41377. * @param scene defines the hosting scene
  41378. */
  41379. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  41380. /**
  41381. * Gets camera class name
  41382. * @returns StereoscopicUniversalCamera
  41383. */
  41384. getClassName(): string;
  41385. }
  41386. }
  41387. declare module "babylonjs/Cameras/Stereoscopic/index" {
  41388. export * from "babylonjs/Cameras/Stereoscopic/anaglyphArcRotateCamera";
  41389. export * from "babylonjs/Cameras/Stereoscopic/anaglyphFreeCamera";
  41390. export * from "babylonjs/Cameras/Stereoscopic/anaglyphGamepadCamera";
  41391. export * from "babylonjs/Cameras/Stereoscopic/anaglyphUniversalCamera";
  41392. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicArcRotateCamera";
  41393. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicFreeCamera";
  41394. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicGamepadCamera";
  41395. export * from "babylonjs/Cameras/Stereoscopic/stereoscopicUniversalCamera";
  41396. }
  41397. declare module "babylonjs/Cameras/virtualJoysticksCamera" {
  41398. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  41399. import { Scene } from "babylonjs/scene";
  41400. import { Vector3 } from "babylonjs/Maths/math.vector";
  41401. import "babylonjs/Cameras/Inputs/freeCameraVirtualJoystickInput";
  41402. /**
  41403. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  41404. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  41405. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  41406. * @see http://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  41407. */
  41408. export class VirtualJoysticksCamera extends FreeCamera {
  41409. /**
  41410. * Intantiates a VirtualJoysticksCamera. It can be useful in First Person Shooter game for instance.
  41411. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  41412. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  41413. * @see http://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  41414. * @param name Define the name of the camera in the scene
  41415. * @param position Define the start position of the camera in the scene
  41416. * @param scene Define the scene the camera belongs to
  41417. */
  41418. constructor(name: string, position: Vector3, scene: Scene);
  41419. /**
  41420. * Gets the current object class name.
  41421. * @return the class name
  41422. */
  41423. getClassName(): string;
  41424. }
  41425. }
  41426. declare module "babylonjs/Cameras/VR/vrCameraMetrics" {
  41427. import { Matrix } from "babylonjs/Maths/math.vector";
  41428. /**
  41429. * This represents all the required metrics to create a VR camera.
  41430. * @see http://doc.babylonjs.com/babylon101/cameras#device-orientation-camera
  41431. */
  41432. export class VRCameraMetrics {
  41433. /**
  41434. * Define the horizontal resolution off the screen.
  41435. */
  41436. hResolution: number;
  41437. /**
  41438. * Define the vertical resolution off the screen.
  41439. */
  41440. vResolution: number;
  41441. /**
  41442. * Define the horizontal screen size.
  41443. */
  41444. hScreenSize: number;
  41445. /**
  41446. * Define the vertical screen size.
  41447. */
  41448. vScreenSize: number;
  41449. /**
  41450. * Define the vertical screen center position.
  41451. */
  41452. vScreenCenter: number;
  41453. /**
  41454. * Define the distance of the eyes to the screen.
  41455. */
  41456. eyeToScreenDistance: number;
  41457. /**
  41458. * Define the distance between both lenses
  41459. */
  41460. lensSeparationDistance: number;
  41461. /**
  41462. * Define the distance between both viewer's eyes.
  41463. */
  41464. interpupillaryDistance: number;
  41465. /**
  41466. * Define the distortion factor of the VR postprocess.
  41467. * Please, touch with care.
  41468. */
  41469. distortionK: number[];
  41470. /**
  41471. * Define the chromatic aberration correction factors for the VR post process.
  41472. */
  41473. chromaAbCorrection: number[];
  41474. /**
  41475. * Define the scale factor of the post process.
  41476. * The smaller the better but the slower.
  41477. */
  41478. postProcessScaleFactor: number;
  41479. /**
  41480. * Define an offset for the lens center.
  41481. */
  41482. lensCenterOffset: number;
  41483. /**
  41484. * Define if the current vr camera should compensate the distortion of the lense or not.
  41485. */
  41486. compensateDistortion: boolean;
  41487. /**
  41488. * Defines if multiview should be enabled when rendering (Default: false)
  41489. */
  41490. multiviewEnabled: boolean;
  41491. /**
  41492. * Gets the rendering aspect ratio based on the provided resolutions.
  41493. */
  41494. readonly aspectRatio: number;
  41495. /**
  41496. * Gets the aspect ratio based on the FOV, scale factors, and real screen sizes.
  41497. */
  41498. readonly aspectRatioFov: number;
  41499. /**
  41500. * @hidden
  41501. */
  41502. readonly leftHMatrix: Matrix;
  41503. /**
  41504. * @hidden
  41505. */
  41506. readonly rightHMatrix: Matrix;
  41507. /**
  41508. * @hidden
  41509. */
  41510. readonly leftPreViewMatrix: Matrix;
  41511. /**
  41512. * @hidden
  41513. */
  41514. readonly rightPreViewMatrix: Matrix;
  41515. /**
  41516. * Get the default VRMetrics based on the most generic setup.
  41517. * @returns the default vr metrics
  41518. */
  41519. static GetDefault(): VRCameraMetrics;
  41520. }
  41521. }
  41522. declare module "babylonjs/Shaders/vrDistortionCorrection.fragment" {
  41523. /** @hidden */
  41524. export var vrDistortionCorrectionPixelShader: {
  41525. name: string;
  41526. shader: string;
  41527. };
  41528. }
  41529. declare module "babylonjs/PostProcesses/vrDistortionCorrectionPostProcess" {
  41530. import { Camera } from "babylonjs/Cameras/camera";
  41531. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  41532. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  41533. import "babylonjs/Shaders/vrDistortionCorrection.fragment";
  41534. /**
  41535. * VRDistortionCorrectionPostProcess used for mobile VR
  41536. */
  41537. export class VRDistortionCorrectionPostProcess extends PostProcess {
  41538. private _isRightEye;
  41539. private _distortionFactors;
  41540. private _postProcessScaleFactor;
  41541. private _lensCenterOffset;
  41542. private _scaleIn;
  41543. private _scaleFactor;
  41544. private _lensCenter;
  41545. /**
  41546. * Initializes the VRDistortionCorrectionPostProcess
  41547. * @param name The name of the effect.
  41548. * @param camera The camera to apply the render pass to.
  41549. * @param isRightEye If this is for the right eye distortion
  41550. * @param vrMetrics All the required metrics for the VR camera
  41551. */
  41552. constructor(name: string, camera: Camera, isRightEye: boolean, vrMetrics: VRCameraMetrics);
  41553. }
  41554. }
  41555. declare module "babylonjs/Cameras/RigModes/vrRigMode" { }
  41556. declare module "babylonjs/Cameras/VR/vrDeviceOrientationArcRotateCamera" {
  41557. import { ArcRotateCamera } from "babylonjs/Cameras/arcRotateCamera";
  41558. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  41559. import { Scene } from "babylonjs/scene";
  41560. import { Vector3 } from "babylonjs/Maths/math.vector";
  41561. import "babylonjs/Cameras/Inputs/arcRotateCameraVRDeviceOrientationInput";
  41562. import "babylonjs/Cameras/RigModes/vrRigMode";
  41563. /**
  41564. * Camera used to simulate VR rendering (based on ArcRotateCamera)
  41565. * @see http://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  41566. */
  41567. export class VRDeviceOrientationArcRotateCamera extends ArcRotateCamera {
  41568. /**
  41569. * Creates a new VRDeviceOrientationArcRotateCamera
  41570. * @param name defines camera name
  41571. * @param alpha defines the camera rotation along the logitudinal axis
  41572. * @param beta defines the camera rotation along the latitudinal axis
  41573. * @param radius defines the camera distance from its target
  41574. * @param target defines the camera target
  41575. * @param scene defines the scene the camera belongs to
  41576. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  41577. * @param vrCameraMetrics defines the vr metrics associated to the camera
  41578. */
  41579. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  41580. /**
  41581. * Gets camera class name
  41582. * @returns VRDeviceOrientationArcRotateCamera
  41583. */
  41584. getClassName(): string;
  41585. }
  41586. }
  41587. declare module "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera" {
  41588. import { DeviceOrientationCamera } from "babylonjs/Cameras/deviceOrientationCamera";
  41589. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  41590. import { Scene } from "babylonjs/scene";
  41591. import { Vector3 } from "babylonjs/Maths/math.vector";
  41592. import "babylonjs/Cameras/RigModes/vrRigMode";
  41593. /**
  41594. * Camera used to simulate VR rendering (based on FreeCamera)
  41595. * @see http://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  41596. */
  41597. export class VRDeviceOrientationFreeCamera extends DeviceOrientationCamera {
  41598. /**
  41599. * Creates a new VRDeviceOrientationFreeCamera
  41600. * @param name defines camera name
  41601. * @param position defines the start position of the camera
  41602. * @param scene defines the scene the camera belongs to
  41603. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  41604. * @param vrCameraMetrics defines the vr metrics associated to the camera
  41605. */
  41606. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  41607. /**
  41608. * Gets camera class name
  41609. * @returns VRDeviceOrientationFreeCamera
  41610. */
  41611. getClassName(): string;
  41612. }
  41613. }
  41614. declare module "babylonjs/Cameras/VR/vrDeviceOrientationGamepadCamera" {
  41615. import { VRDeviceOrientationFreeCamera } from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  41616. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  41617. import { Scene } from "babylonjs/scene";
  41618. import { Vector3 } from "babylonjs/Maths/math.vector";
  41619. import "babylonjs/Gamepads/gamepadSceneComponent";
  41620. /**
  41621. * Camera used to simulate VR rendering (based on VRDeviceOrientationFreeCamera)
  41622. * @see http://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  41623. */
  41624. export class VRDeviceOrientationGamepadCamera extends VRDeviceOrientationFreeCamera {
  41625. /**
  41626. * Creates a new VRDeviceOrientationGamepadCamera
  41627. * @param name defines camera name
  41628. * @param position defines the start position of the camera
  41629. * @param scene defines the scene the camera belongs to
  41630. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  41631. * @param vrCameraMetrics defines the vr metrics associated to the camera
  41632. */
  41633. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  41634. /**
  41635. * Gets camera class name
  41636. * @returns VRDeviceOrientationGamepadCamera
  41637. */
  41638. getClassName(): string;
  41639. }
  41640. }
  41641. declare module "babylonjs/Materials/pushMaterial" {
  41642. import { Nullable } from "babylonjs/types";
  41643. import { Scene } from "babylonjs/scene";
  41644. import { Matrix } from "babylonjs/Maths/math.vector";
  41645. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  41646. import { Mesh } from "babylonjs/Meshes/mesh";
  41647. import { Material } from "babylonjs/Materials/material";
  41648. import { Effect } from "babylonjs/Materials/effect";
  41649. /**
  41650. * Base class of materials working in push mode in babylon JS
  41651. * @hidden
  41652. */
  41653. export class PushMaterial extends Material {
  41654. protected _activeEffect: Effect;
  41655. protected _normalMatrix: Matrix;
  41656. /**
  41657. * Gets or sets a boolean indicating that the material is allowed to do shader hot swapping.
  41658. * This means that the material can keep using a previous shader while a new one is being compiled.
  41659. * This is mostly used when shader parallel compilation is supported (true by default)
  41660. */
  41661. allowShaderHotSwapping: boolean;
  41662. constructor(name: string, scene: Scene);
  41663. getEffect(): Effect;
  41664. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  41665. /**
  41666. * Binds the given world matrix to the active effect
  41667. *
  41668. * @param world the matrix to bind
  41669. */
  41670. bindOnlyWorldMatrix(world: Matrix): void;
  41671. /**
  41672. * Binds the given normal matrix to the active effect
  41673. *
  41674. * @param normalMatrix the matrix to bind
  41675. */
  41676. bindOnlyNormalMatrix(normalMatrix: Matrix): void;
  41677. bind(world: Matrix, mesh?: Mesh): void;
  41678. protected _afterBind(mesh: Mesh, effect?: Nullable<Effect>): void;
  41679. protected _mustRebind(scene: Scene, effect: Effect, visibility?: number): boolean;
  41680. }
  41681. }
  41682. declare module "babylonjs/Materials/materialFlags" {
  41683. /**
  41684. * This groups all the flags used to control the materials channel.
  41685. */
  41686. export class MaterialFlags {
  41687. private static _DiffuseTextureEnabled;
  41688. /**
  41689. * Are diffuse textures enabled in the application.
  41690. */
  41691. static DiffuseTextureEnabled: boolean;
  41692. private static _AmbientTextureEnabled;
  41693. /**
  41694. * Are ambient textures enabled in the application.
  41695. */
  41696. static AmbientTextureEnabled: boolean;
  41697. private static _OpacityTextureEnabled;
  41698. /**
  41699. * Are opacity textures enabled in the application.
  41700. */
  41701. static OpacityTextureEnabled: boolean;
  41702. private static _ReflectionTextureEnabled;
  41703. /**
  41704. * Are reflection textures enabled in the application.
  41705. */
  41706. static ReflectionTextureEnabled: boolean;
  41707. private static _EmissiveTextureEnabled;
  41708. /**
  41709. * Are emissive textures enabled in the application.
  41710. */
  41711. static EmissiveTextureEnabled: boolean;
  41712. private static _SpecularTextureEnabled;
  41713. /**
  41714. * Are specular textures enabled in the application.
  41715. */
  41716. static SpecularTextureEnabled: boolean;
  41717. private static _BumpTextureEnabled;
  41718. /**
  41719. * Are bump textures enabled in the application.
  41720. */
  41721. static BumpTextureEnabled: boolean;
  41722. private static _LightmapTextureEnabled;
  41723. /**
  41724. * Are lightmap textures enabled in the application.
  41725. */
  41726. static LightmapTextureEnabled: boolean;
  41727. private static _RefractionTextureEnabled;
  41728. /**
  41729. * Are refraction textures enabled in the application.
  41730. */
  41731. static RefractionTextureEnabled: boolean;
  41732. private static _ColorGradingTextureEnabled;
  41733. /**
  41734. * Are color grading textures enabled in the application.
  41735. */
  41736. static ColorGradingTextureEnabled: boolean;
  41737. private static _FresnelEnabled;
  41738. /**
  41739. * Are fresnels enabled in the application.
  41740. */
  41741. static FresnelEnabled: boolean;
  41742. private static _ClearCoatTextureEnabled;
  41743. /**
  41744. * Are clear coat textures enabled in the application.
  41745. */
  41746. static ClearCoatTextureEnabled: boolean;
  41747. private static _ClearCoatBumpTextureEnabled;
  41748. /**
  41749. * Are clear coat bump textures enabled in the application.
  41750. */
  41751. static ClearCoatBumpTextureEnabled: boolean;
  41752. private static _ClearCoatTintTextureEnabled;
  41753. /**
  41754. * Are clear coat tint textures enabled in the application.
  41755. */
  41756. static ClearCoatTintTextureEnabled: boolean;
  41757. private static _SheenTextureEnabled;
  41758. /**
  41759. * Are sheen textures enabled in the application.
  41760. */
  41761. static SheenTextureEnabled: boolean;
  41762. private static _AnisotropicTextureEnabled;
  41763. /**
  41764. * Are anisotropic textures enabled in the application.
  41765. */
  41766. static AnisotropicTextureEnabled: boolean;
  41767. private static _ThicknessTextureEnabled;
  41768. /**
  41769. * Are thickness textures enabled in the application.
  41770. */
  41771. static ThicknessTextureEnabled: boolean;
  41772. }
  41773. }
  41774. declare module "babylonjs/Shaders/ShadersInclude/defaultFragmentDeclaration" {
  41775. /** @hidden */
  41776. export var defaultFragmentDeclaration: {
  41777. name: string;
  41778. shader: string;
  41779. };
  41780. }
  41781. declare module "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration" {
  41782. /** @hidden */
  41783. export var defaultUboDeclaration: {
  41784. name: string;
  41785. shader: string;
  41786. };
  41787. }
  41788. declare module "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration" {
  41789. /** @hidden */
  41790. export var lightFragmentDeclaration: {
  41791. name: string;
  41792. shader: string;
  41793. };
  41794. }
  41795. declare module "babylonjs/Shaders/ShadersInclude/lightUboDeclaration" {
  41796. /** @hidden */
  41797. export var lightUboDeclaration: {
  41798. name: string;
  41799. shader: string;
  41800. };
  41801. }
  41802. declare module "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions" {
  41803. /** @hidden */
  41804. export var lightsFragmentFunctions: {
  41805. name: string;
  41806. shader: string;
  41807. };
  41808. }
  41809. declare module "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions" {
  41810. /** @hidden */
  41811. export var shadowsFragmentFunctions: {
  41812. name: string;
  41813. shader: string;
  41814. };
  41815. }
  41816. declare module "babylonjs/Shaders/ShadersInclude/fresnelFunction" {
  41817. /** @hidden */
  41818. export var fresnelFunction: {
  41819. name: string;
  41820. shader: string;
  41821. };
  41822. }
  41823. declare module "babylonjs/Shaders/ShadersInclude/reflectionFunction" {
  41824. /** @hidden */
  41825. export var reflectionFunction: {
  41826. name: string;
  41827. shader: string;
  41828. };
  41829. }
  41830. declare module "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions" {
  41831. /** @hidden */
  41832. export var bumpFragmentFunctions: {
  41833. name: string;
  41834. shader: string;
  41835. };
  41836. }
  41837. declare module "babylonjs/Shaders/ShadersInclude/logDepthDeclaration" {
  41838. /** @hidden */
  41839. export var logDepthDeclaration: {
  41840. name: string;
  41841. shader: string;
  41842. };
  41843. }
  41844. declare module "babylonjs/Shaders/ShadersInclude/bumpFragment" {
  41845. /** @hidden */
  41846. export var bumpFragment: {
  41847. name: string;
  41848. shader: string;
  41849. };
  41850. }
  41851. declare module "babylonjs/Shaders/ShadersInclude/depthPrePass" {
  41852. /** @hidden */
  41853. export var depthPrePass: {
  41854. name: string;
  41855. shader: string;
  41856. };
  41857. }
  41858. declare module "babylonjs/Shaders/ShadersInclude/lightFragment" {
  41859. /** @hidden */
  41860. export var lightFragment: {
  41861. name: string;
  41862. shader: string;
  41863. };
  41864. }
  41865. declare module "babylonjs/Shaders/ShadersInclude/logDepthFragment" {
  41866. /** @hidden */
  41867. export var logDepthFragment: {
  41868. name: string;
  41869. shader: string;
  41870. };
  41871. }
  41872. declare module "babylonjs/Shaders/default.fragment" {
  41873. import "babylonjs/Shaders/ShadersInclude/defaultFragmentDeclaration";
  41874. import "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration";
  41875. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  41876. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  41877. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  41878. import "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions";
  41879. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  41880. import "babylonjs/Shaders/ShadersInclude/fresnelFunction";
  41881. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  41882. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  41883. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  41884. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  41885. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  41886. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  41887. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  41888. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  41889. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  41890. import "babylonjs/Shaders/ShadersInclude/depthPrePass";
  41891. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  41892. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  41893. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  41894. /** @hidden */
  41895. export var defaultPixelShader: {
  41896. name: string;
  41897. shader: string;
  41898. };
  41899. }
  41900. declare module "babylonjs/Shaders/ShadersInclude/defaultVertexDeclaration" {
  41901. /** @hidden */
  41902. export var defaultVertexDeclaration: {
  41903. name: string;
  41904. shader: string;
  41905. };
  41906. }
  41907. declare module "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration" {
  41908. /** @hidden */
  41909. export var bumpVertexDeclaration: {
  41910. name: string;
  41911. shader: string;
  41912. };
  41913. }
  41914. declare module "babylonjs/Shaders/ShadersInclude/bumpVertex" {
  41915. /** @hidden */
  41916. export var bumpVertex: {
  41917. name: string;
  41918. shader: string;
  41919. };
  41920. }
  41921. declare module "babylonjs/Shaders/ShadersInclude/fogVertex" {
  41922. /** @hidden */
  41923. export var fogVertex: {
  41924. name: string;
  41925. shader: string;
  41926. };
  41927. }
  41928. declare module "babylonjs/Shaders/ShadersInclude/shadowsVertex" {
  41929. /** @hidden */
  41930. export var shadowsVertex: {
  41931. name: string;
  41932. shader: string;
  41933. };
  41934. }
  41935. declare module "babylonjs/Shaders/ShadersInclude/pointCloudVertex" {
  41936. /** @hidden */
  41937. export var pointCloudVertex: {
  41938. name: string;
  41939. shader: string;
  41940. };
  41941. }
  41942. declare module "babylonjs/Shaders/ShadersInclude/logDepthVertex" {
  41943. /** @hidden */
  41944. export var logDepthVertex: {
  41945. name: string;
  41946. shader: string;
  41947. };
  41948. }
  41949. declare module "babylonjs/Shaders/default.vertex" {
  41950. import "babylonjs/Shaders/ShadersInclude/defaultVertexDeclaration";
  41951. import "babylonjs/Shaders/ShadersInclude/defaultUboDeclaration";
  41952. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  41953. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  41954. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  41955. import "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration";
  41956. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  41957. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  41958. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  41959. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  41960. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  41961. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  41962. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  41963. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  41964. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  41965. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  41966. import "babylonjs/Shaders/ShadersInclude/bumpVertex";
  41967. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  41968. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  41969. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  41970. import "babylonjs/Shaders/ShadersInclude/pointCloudVertex";
  41971. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  41972. /** @hidden */
  41973. export var defaultVertexShader: {
  41974. name: string;
  41975. shader: string;
  41976. };
  41977. }
  41978. declare module "babylonjs/Materials/standardMaterial" {
  41979. import { SmartArray } from "babylonjs/Misc/smartArray";
  41980. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  41981. import { Nullable } from "babylonjs/types";
  41982. import { Scene } from "babylonjs/scene";
  41983. import { Matrix } from "babylonjs/Maths/math.vector";
  41984. import { Color3 } from "babylonjs/Maths/math.color";
  41985. import { SubMesh } from "babylonjs/Meshes/subMesh";
  41986. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  41987. import { Mesh } from "babylonjs/Meshes/mesh";
  41988. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  41989. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  41990. import { FresnelParameters } from "babylonjs/Materials/fresnelParameters";
  41991. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  41992. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  41993. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  41994. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  41995. import "babylonjs/Shaders/default.fragment";
  41996. import "babylonjs/Shaders/default.vertex";
  41997. /** @hidden */
  41998. export class StandardMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  41999. MAINUV1: boolean;
  42000. MAINUV2: boolean;
  42001. DIFFUSE: boolean;
  42002. DIFFUSEDIRECTUV: number;
  42003. AMBIENT: boolean;
  42004. AMBIENTDIRECTUV: number;
  42005. OPACITY: boolean;
  42006. OPACITYDIRECTUV: number;
  42007. OPACITYRGB: boolean;
  42008. REFLECTION: boolean;
  42009. EMISSIVE: boolean;
  42010. EMISSIVEDIRECTUV: number;
  42011. SPECULAR: boolean;
  42012. SPECULARDIRECTUV: number;
  42013. BUMP: boolean;
  42014. BUMPDIRECTUV: number;
  42015. PARALLAX: boolean;
  42016. PARALLAXOCCLUSION: boolean;
  42017. SPECULAROVERALPHA: boolean;
  42018. CLIPPLANE: boolean;
  42019. CLIPPLANE2: boolean;
  42020. CLIPPLANE3: boolean;
  42021. CLIPPLANE4: boolean;
  42022. ALPHATEST: boolean;
  42023. DEPTHPREPASS: boolean;
  42024. ALPHAFROMDIFFUSE: boolean;
  42025. POINTSIZE: boolean;
  42026. FOG: boolean;
  42027. SPECULARTERM: boolean;
  42028. DIFFUSEFRESNEL: boolean;
  42029. OPACITYFRESNEL: boolean;
  42030. REFLECTIONFRESNEL: boolean;
  42031. REFRACTIONFRESNEL: boolean;
  42032. EMISSIVEFRESNEL: boolean;
  42033. FRESNEL: boolean;
  42034. NORMAL: boolean;
  42035. UV1: boolean;
  42036. UV2: boolean;
  42037. VERTEXCOLOR: boolean;
  42038. VERTEXALPHA: boolean;
  42039. NUM_BONE_INFLUENCERS: number;
  42040. BonesPerMesh: number;
  42041. BONETEXTURE: boolean;
  42042. INSTANCES: boolean;
  42043. GLOSSINESS: boolean;
  42044. ROUGHNESS: boolean;
  42045. EMISSIVEASILLUMINATION: boolean;
  42046. LINKEMISSIVEWITHDIFFUSE: boolean;
  42047. REFLECTIONFRESNELFROMSPECULAR: boolean;
  42048. LIGHTMAP: boolean;
  42049. LIGHTMAPDIRECTUV: number;
  42050. OBJECTSPACE_NORMALMAP: boolean;
  42051. USELIGHTMAPASSHADOWMAP: boolean;
  42052. REFLECTIONMAP_3D: boolean;
  42053. REFLECTIONMAP_SPHERICAL: boolean;
  42054. REFLECTIONMAP_PLANAR: boolean;
  42055. REFLECTIONMAP_CUBIC: boolean;
  42056. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  42057. REFLECTIONMAP_PROJECTION: boolean;
  42058. REFLECTIONMAP_SKYBOX: boolean;
  42059. REFLECTIONMAP_SKYBOX_TRANSFORMED: boolean;
  42060. REFLECTIONMAP_EXPLICIT: boolean;
  42061. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  42062. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  42063. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  42064. INVERTCUBICMAP: boolean;
  42065. LOGARITHMICDEPTH: boolean;
  42066. REFRACTION: boolean;
  42067. REFRACTIONMAP_3D: boolean;
  42068. REFLECTIONOVERALPHA: boolean;
  42069. TWOSIDEDLIGHTING: boolean;
  42070. SHADOWFLOAT: boolean;
  42071. MORPHTARGETS: boolean;
  42072. MORPHTARGETS_NORMAL: boolean;
  42073. MORPHTARGETS_TANGENT: boolean;
  42074. MORPHTARGETS_UV: boolean;
  42075. NUM_MORPH_INFLUENCERS: number;
  42076. NONUNIFORMSCALING: boolean;
  42077. PREMULTIPLYALPHA: boolean;
  42078. IMAGEPROCESSING: boolean;
  42079. VIGNETTE: boolean;
  42080. VIGNETTEBLENDMODEMULTIPLY: boolean;
  42081. VIGNETTEBLENDMODEOPAQUE: boolean;
  42082. TONEMAPPING: boolean;
  42083. TONEMAPPING_ACES: boolean;
  42084. CONTRAST: boolean;
  42085. COLORCURVES: boolean;
  42086. COLORGRADING: boolean;
  42087. COLORGRADING3D: boolean;
  42088. SAMPLER3DGREENDEPTH: boolean;
  42089. SAMPLER3DBGRMAP: boolean;
  42090. IMAGEPROCESSINGPOSTPROCESS: boolean;
  42091. MULTIVIEW: boolean;
  42092. /**
  42093. * If the reflection texture on this material is in linear color space
  42094. * @hidden
  42095. */
  42096. IS_REFLECTION_LINEAR: boolean;
  42097. /**
  42098. * If the refraction texture on this material is in linear color space
  42099. * @hidden
  42100. */
  42101. IS_REFRACTION_LINEAR: boolean;
  42102. EXPOSURE: boolean;
  42103. constructor();
  42104. setReflectionMode(modeToEnable: string): void;
  42105. }
  42106. /**
  42107. * This is the default material used in Babylon. It is the best trade off between quality
  42108. * and performances.
  42109. * @see http://doc.babylonjs.com/babylon101/materials
  42110. */
  42111. export class StandardMaterial extends PushMaterial {
  42112. private _diffuseTexture;
  42113. /**
  42114. * The basic texture of the material as viewed under a light.
  42115. */
  42116. diffuseTexture: Nullable<BaseTexture>;
  42117. private _ambientTexture;
  42118. /**
  42119. * AKA Occlusion Texture in other nomenclature, it helps adding baked shadows into your material.
  42120. */
  42121. ambientTexture: Nullable<BaseTexture>;
  42122. private _opacityTexture;
  42123. /**
  42124. * Define the transparency of the material from a texture.
  42125. * The final alpha value can be read either from the red channel (if texture.getAlphaFromRGB is false)
  42126. * or from the luminance or the current texel (if texture.getAlphaFromRGB is true)
  42127. */
  42128. opacityTexture: Nullable<BaseTexture>;
  42129. private _reflectionTexture;
  42130. /**
  42131. * Define the texture used to display the reflection.
  42132. * @see http://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  42133. */
  42134. reflectionTexture: Nullable<BaseTexture>;
  42135. private _emissiveTexture;
  42136. /**
  42137. * Define texture of the material as if self lit.
  42138. * This will be mixed in the final result even in the absence of light.
  42139. */
  42140. emissiveTexture: Nullable<BaseTexture>;
  42141. private _specularTexture;
  42142. /**
  42143. * Define how the color and intensity of the highlight given by the light in the material.
  42144. */
  42145. specularTexture: Nullable<BaseTexture>;
  42146. private _bumpTexture;
  42147. /**
  42148. * Bump mapping is a technique to simulate bump and dents on a rendered surface.
  42149. * 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.
  42150. * @see http://doc.babylonjs.com/how_to/more_materials#bump-map
  42151. */
  42152. bumpTexture: Nullable<BaseTexture>;
  42153. private _lightmapTexture;
  42154. /**
  42155. * Complex lighting can be computationally expensive to compute at runtime.
  42156. * To save on computation, lightmaps may be used to store calculated lighting in a texture which will be applied to a given mesh.
  42157. * @see http://doc.babylonjs.com/babylon101/lights#lightmaps
  42158. */
  42159. lightmapTexture: Nullable<BaseTexture>;
  42160. private _refractionTexture;
  42161. /**
  42162. * Define the texture used to display the refraction.
  42163. * @see http://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  42164. */
  42165. refractionTexture: Nullable<BaseTexture>;
  42166. /**
  42167. * The color of the material lit by the environmental background lighting.
  42168. * @see http://doc.babylonjs.com/babylon101/materials#ambient-color-example
  42169. */
  42170. ambientColor: Color3;
  42171. /**
  42172. * The basic color of the material as viewed under a light.
  42173. */
  42174. diffuseColor: Color3;
  42175. /**
  42176. * Define how the color and intensity of the highlight given by the light in the material.
  42177. */
  42178. specularColor: Color3;
  42179. /**
  42180. * Define the color of the material as if self lit.
  42181. * This will be mixed in the final result even in the absence of light.
  42182. */
  42183. emissiveColor: Color3;
  42184. /**
  42185. * Defines how sharp are the highlights in the material.
  42186. * The bigger the value the sharper giving a more glossy feeling to the result.
  42187. * Reversely, the smaller the value the blurrier giving a more rough feeling to the result.
  42188. */
  42189. specularPower: number;
  42190. private _useAlphaFromDiffuseTexture;
  42191. /**
  42192. * Does the transparency come from the diffuse texture alpha channel.
  42193. */
  42194. useAlphaFromDiffuseTexture: boolean;
  42195. private _useEmissiveAsIllumination;
  42196. /**
  42197. * If true, the emissive value is added into the end result, otherwise it is multiplied in.
  42198. */
  42199. useEmissiveAsIllumination: boolean;
  42200. private _linkEmissiveWithDiffuse;
  42201. /**
  42202. * If true, some kind of energy conservation will prevent the end result to be more than 1 by reducing
  42203. * the emissive level when the final color is close to one.
  42204. */
  42205. linkEmissiveWithDiffuse: boolean;
  42206. private _useSpecularOverAlpha;
  42207. /**
  42208. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  42209. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  42210. */
  42211. useSpecularOverAlpha: boolean;
  42212. private _useReflectionOverAlpha;
  42213. /**
  42214. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  42215. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  42216. */
  42217. useReflectionOverAlpha: boolean;
  42218. private _disableLighting;
  42219. /**
  42220. * Does lights from the scene impacts this material.
  42221. * It can be a nice trick for performance to disable lighting on a fully emissive material.
  42222. */
  42223. disableLighting: boolean;
  42224. private _useObjectSpaceNormalMap;
  42225. /**
  42226. * Allows using an object space normal map (instead of tangent space).
  42227. */
  42228. useObjectSpaceNormalMap: boolean;
  42229. private _useParallax;
  42230. /**
  42231. * Is parallax enabled or not.
  42232. * @see http://doc.babylonjs.com/how_to/using_parallax_mapping
  42233. */
  42234. useParallax: boolean;
  42235. private _useParallaxOcclusion;
  42236. /**
  42237. * Is parallax occlusion enabled or not.
  42238. * If true, the outcome is way more realistic than traditional Parallax but you can expect a performance hit that worthes consideration.
  42239. * @see http://doc.babylonjs.com/how_to/using_parallax_mapping
  42240. */
  42241. useParallaxOcclusion: boolean;
  42242. /**
  42243. * 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.
  42244. */
  42245. parallaxScaleBias: number;
  42246. private _roughness;
  42247. /**
  42248. * Helps to define how blurry the reflections should appears in the material.
  42249. */
  42250. roughness: number;
  42251. /**
  42252. * In case of refraction, define the value of the index of refraction.
  42253. * @see http://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  42254. */
  42255. indexOfRefraction: number;
  42256. /**
  42257. * Invert the refraction texture alongside the y axis.
  42258. * It can be useful with procedural textures or probe for instance.
  42259. * @see http://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  42260. */
  42261. invertRefractionY: boolean;
  42262. /**
  42263. * Defines the alpha limits in alpha test mode.
  42264. */
  42265. alphaCutOff: number;
  42266. private _useLightmapAsShadowmap;
  42267. /**
  42268. * In case of light mapping, define whether the map contains light or shadow informations.
  42269. */
  42270. useLightmapAsShadowmap: boolean;
  42271. private _diffuseFresnelParameters;
  42272. /**
  42273. * Define the diffuse fresnel parameters of the material.
  42274. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  42275. */
  42276. diffuseFresnelParameters: FresnelParameters;
  42277. private _opacityFresnelParameters;
  42278. /**
  42279. * Define the opacity fresnel parameters of the material.
  42280. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  42281. */
  42282. opacityFresnelParameters: FresnelParameters;
  42283. private _reflectionFresnelParameters;
  42284. /**
  42285. * Define the reflection fresnel parameters of the material.
  42286. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  42287. */
  42288. reflectionFresnelParameters: FresnelParameters;
  42289. private _refractionFresnelParameters;
  42290. /**
  42291. * Define the refraction fresnel parameters of the material.
  42292. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  42293. */
  42294. refractionFresnelParameters: FresnelParameters;
  42295. private _emissiveFresnelParameters;
  42296. /**
  42297. * Define the emissive fresnel parameters of the material.
  42298. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  42299. */
  42300. emissiveFresnelParameters: FresnelParameters;
  42301. private _useReflectionFresnelFromSpecular;
  42302. /**
  42303. * If true automatically deducts the fresnels values from the material specularity.
  42304. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  42305. */
  42306. useReflectionFresnelFromSpecular: boolean;
  42307. private _useGlossinessFromSpecularMapAlpha;
  42308. /**
  42309. * Defines if the glossiness/roughness of the material should be read from the specular map alpha channel
  42310. */
  42311. useGlossinessFromSpecularMapAlpha: boolean;
  42312. private _maxSimultaneousLights;
  42313. /**
  42314. * Defines the maximum number of lights that can be used in the material
  42315. */
  42316. maxSimultaneousLights: number;
  42317. private _invertNormalMapX;
  42318. /**
  42319. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  42320. */
  42321. invertNormalMapX: boolean;
  42322. private _invertNormalMapY;
  42323. /**
  42324. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  42325. */
  42326. invertNormalMapY: boolean;
  42327. private _twoSidedLighting;
  42328. /**
  42329. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  42330. */
  42331. twoSidedLighting: boolean;
  42332. /**
  42333. * Default configuration related to image processing available in the standard Material.
  42334. */
  42335. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  42336. /**
  42337. * Gets the image processing configuration used either in this material.
  42338. */
  42339. /**
  42340. * Sets the Default image processing configuration used either in the this material.
  42341. *
  42342. * If sets to null, the scene one is in use.
  42343. */
  42344. imageProcessingConfiguration: ImageProcessingConfiguration;
  42345. /**
  42346. * Keep track of the image processing observer to allow dispose and replace.
  42347. */
  42348. private _imageProcessingObserver;
  42349. /**
  42350. * Attaches a new image processing configuration to the Standard Material.
  42351. * @param configuration
  42352. */
  42353. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  42354. /**
  42355. * Gets wether the color curves effect is enabled.
  42356. */
  42357. /**
  42358. * Sets wether the color curves effect is enabled.
  42359. */
  42360. cameraColorCurvesEnabled: boolean;
  42361. /**
  42362. * Gets wether the color grading effect is enabled.
  42363. */
  42364. /**
  42365. * Gets wether the color grading effect is enabled.
  42366. */
  42367. cameraColorGradingEnabled: boolean;
  42368. /**
  42369. * Gets wether tonemapping is enabled or not.
  42370. */
  42371. /**
  42372. * Sets wether tonemapping is enabled or not
  42373. */
  42374. cameraToneMappingEnabled: boolean;
  42375. /**
  42376. * The camera exposure used on this material.
  42377. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  42378. * This corresponds to a photographic exposure.
  42379. */
  42380. /**
  42381. * The camera exposure used on this material.
  42382. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  42383. * This corresponds to a photographic exposure.
  42384. */
  42385. cameraExposure: number;
  42386. /**
  42387. * Gets The camera contrast used on this material.
  42388. */
  42389. /**
  42390. * Sets The camera contrast used on this material.
  42391. */
  42392. cameraContrast: number;
  42393. /**
  42394. * Gets the Color Grading 2D Lookup Texture.
  42395. */
  42396. /**
  42397. * Sets the Color Grading 2D Lookup Texture.
  42398. */
  42399. cameraColorGradingTexture: Nullable<BaseTexture>;
  42400. /**
  42401. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  42402. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  42403. * 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;
  42404. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  42405. */
  42406. /**
  42407. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  42408. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  42409. * 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;
  42410. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  42411. */
  42412. cameraColorCurves: Nullable<ColorCurves>;
  42413. /**
  42414. * Custom callback helping to override the default shader used in the material.
  42415. */
  42416. customShaderNameResolve: (shaderName: string, uniforms: string[], uniformBuffers: string[], samplers: string[], defines: StandardMaterialDefines) => string;
  42417. protected _renderTargets: SmartArray<RenderTargetTexture>;
  42418. protected _worldViewProjectionMatrix: Matrix;
  42419. protected _globalAmbientColor: Color3;
  42420. protected _useLogarithmicDepth: boolean;
  42421. protected _rebuildInParallel: boolean;
  42422. /**
  42423. * Instantiates a new standard material.
  42424. * This is the default material used in Babylon. It is the best trade off between quality
  42425. * and performances.
  42426. * @see http://doc.babylonjs.com/babylon101/materials
  42427. * @param name Define the name of the material in the scene
  42428. * @param scene Define the scene the material belong to
  42429. */
  42430. constructor(name: string, scene: Scene);
  42431. /**
  42432. * Gets a boolean indicating that current material needs to register RTT
  42433. */
  42434. readonly hasRenderTargetTextures: boolean;
  42435. /**
  42436. * Gets the current class name of the material e.g. "StandardMaterial"
  42437. * Mainly use in serialization.
  42438. * @returns the class name
  42439. */
  42440. getClassName(): string;
  42441. /**
  42442. * In case the depth buffer does not allow enough depth precision for your scene (might be the case in large scenes)
  42443. * You can try switching to logarithmic depth.
  42444. * @see http://doc.babylonjs.com/how_to/using_logarithmic_depth_buffer
  42445. */
  42446. useLogarithmicDepth: boolean;
  42447. /**
  42448. * Specifies if the material will require alpha blending
  42449. * @returns a boolean specifying if alpha blending is needed
  42450. */
  42451. needAlphaBlending(): boolean;
  42452. /**
  42453. * Specifies if this material should be rendered in alpha test mode
  42454. * @returns a boolean specifying if an alpha test is needed.
  42455. */
  42456. needAlphaTesting(): boolean;
  42457. protected _shouldUseAlphaFromDiffuseTexture(): boolean;
  42458. /**
  42459. * Get the texture used for alpha test purpose.
  42460. * @returns the diffuse texture in case of the standard material.
  42461. */
  42462. getAlphaTestTexture(): Nullable<BaseTexture>;
  42463. /**
  42464. * Get if the submesh is ready to be used and all its information available.
  42465. * Child classes can use it to update shaders
  42466. * @param mesh defines the mesh to check
  42467. * @param subMesh defines which submesh to check
  42468. * @param useInstances specifies that instances should be used
  42469. * @returns a boolean indicating that the submesh is ready or not
  42470. */
  42471. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  42472. /**
  42473. * Builds the material UBO layouts.
  42474. * Used internally during the effect preparation.
  42475. */
  42476. buildUniformLayout(): void;
  42477. /**
  42478. * Unbinds the material from the mesh
  42479. */
  42480. unbind(): void;
  42481. /**
  42482. * Binds the submesh to this material by preparing the effect and shader to draw
  42483. * @param world defines the world transformation matrix
  42484. * @param mesh defines the mesh containing the submesh
  42485. * @param subMesh defines the submesh to bind the material to
  42486. */
  42487. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  42488. /**
  42489. * Get the list of animatables in the material.
  42490. * @returns the list of animatables object used in the material
  42491. */
  42492. getAnimatables(): IAnimatable[];
  42493. /**
  42494. * Gets the active textures from the material
  42495. * @returns an array of textures
  42496. */
  42497. getActiveTextures(): BaseTexture[];
  42498. /**
  42499. * Specifies if the material uses a texture
  42500. * @param texture defines the texture to check against the material
  42501. * @returns a boolean specifying if the material uses the texture
  42502. */
  42503. hasTexture(texture: BaseTexture): boolean;
  42504. /**
  42505. * Disposes the material
  42506. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  42507. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  42508. */
  42509. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  42510. /**
  42511. * Makes a duplicate of the material, and gives it a new name
  42512. * @param name defines the new name for the duplicated material
  42513. * @returns the cloned material
  42514. */
  42515. clone(name: string): StandardMaterial;
  42516. /**
  42517. * Serializes this material in a JSON representation
  42518. * @returns the serialized material object
  42519. */
  42520. serialize(): any;
  42521. /**
  42522. * Creates a standard material from parsed material data
  42523. * @param source defines the JSON representation of the material
  42524. * @param scene defines the hosting scene
  42525. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  42526. * @returns a new standard material
  42527. */
  42528. static Parse(source: any, scene: Scene, rootUrl: string): StandardMaterial;
  42529. /**
  42530. * Are diffuse textures enabled in the application.
  42531. */
  42532. static DiffuseTextureEnabled: boolean;
  42533. /**
  42534. * Are ambient textures enabled in the application.
  42535. */
  42536. static AmbientTextureEnabled: boolean;
  42537. /**
  42538. * Are opacity textures enabled in the application.
  42539. */
  42540. static OpacityTextureEnabled: boolean;
  42541. /**
  42542. * Are reflection textures enabled in the application.
  42543. */
  42544. static ReflectionTextureEnabled: boolean;
  42545. /**
  42546. * Are emissive textures enabled in the application.
  42547. */
  42548. static EmissiveTextureEnabled: boolean;
  42549. /**
  42550. * Are specular textures enabled in the application.
  42551. */
  42552. static SpecularTextureEnabled: boolean;
  42553. /**
  42554. * Are bump textures enabled in the application.
  42555. */
  42556. static BumpTextureEnabled: boolean;
  42557. /**
  42558. * Are lightmap textures enabled in the application.
  42559. */
  42560. static LightmapTextureEnabled: boolean;
  42561. /**
  42562. * Are refraction textures enabled in the application.
  42563. */
  42564. static RefractionTextureEnabled: boolean;
  42565. /**
  42566. * Are color grading textures enabled in the application.
  42567. */
  42568. static ColorGradingTextureEnabled: boolean;
  42569. /**
  42570. * Are fresnels enabled in the application.
  42571. */
  42572. static FresnelEnabled: boolean;
  42573. }
  42574. }
  42575. declare module "babylonjs/Shaders/imageProcessing.fragment" {
  42576. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  42577. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  42578. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  42579. /** @hidden */
  42580. export var imageProcessingPixelShader: {
  42581. name: string;
  42582. shader: string;
  42583. };
  42584. }
  42585. declare module "babylonjs/PostProcesses/imageProcessingPostProcess" {
  42586. import { Nullable } from "babylonjs/types";
  42587. import { Color4 } from "babylonjs/Maths/math.color";
  42588. import { Camera } from "babylonjs/Cameras/camera";
  42589. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  42590. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  42591. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  42592. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  42593. import { Engine } from "babylonjs/Engines/engine";
  42594. import "babylonjs/Shaders/imageProcessing.fragment";
  42595. import "babylonjs/Shaders/postprocess.vertex";
  42596. /**
  42597. * ImageProcessingPostProcess
  42598. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#imageprocessing
  42599. */
  42600. export class ImageProcessingPostProcess extends PostProcess {
  42601. /**
  42602. * Default configuration related to image processing available in the PBR Material.
  42603. */
  42604. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  42605. /**
  42606. * Gets the image processing configuration used either in this material.
  42607. */
  42608. /**
  42609. * Sets the Default image processing configuration used either in the this material.
  42610. *
  42611. * If sets to null, the scene one is in use.
  42612. */
  42613. imageProcessingConfiguration: ImageProcessingConfiguration;
  42614. /**
  42615. * Keep track of the image processing observer to allow dispose and replace.
  42616. */
  42617. private _imageProcessingObserver;
  42618. /**
  42619. * Attaches a new image processing configuration to the PBR Material.
  42620. * @param configuration
  42621. */
  42622. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>, doNotBuild?: boolean): void;
  42623. /**
  42624. * Gets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  42625. */
  42626. /**
  42627. * Sets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  42628. */
  42629. colorCurves: Nullable<ColorCurves>;
  42630. /**
  42631. * Gets wether the color curves effect is enabled.
  42632. */
  42633. /**
  42634. * Sets wether the color curves effect is enabled.
  42635. */
  42636. colorCurvesEnabled: boolean;
  42637. /**
  42638. * Gets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  42639. */
  42640. /**
  42641. * Sets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  42642. */
  42643. colorGradingTexture: Nullable<BaseTexture>;
  42644. /**
  42645. * Gets wether the color grading effect is enabled.
  42646. */
  42647. /**
  42648. * Gets wether the color grading effect is enabled.
  42649. */
  42650. colorGradingEnabled: boolean;
  42651. /**
  42652. * Gets exposure used in the effect.
  42653. */
  42654. /**
  42655. * Sets exposure used in the effect.
  42656. */
  42657. exposure: number;
  42658. /**
  42659. * Gets wether tonemapping is enabled or not.
  42660. */
  42661. /**
  42662. * Sets wether tonemapping is enabled or not
  42663. */
  42664. toneMappingEnabled: boolean;
  42665. /**
  42666. * Gets the type of tone mapping effect.
  42667. */
  42668. /**
  42669. * Sets the type of tone mapping effect.
  42670. */
  42671. toneMappingType: number;
  42672. /**
  42673. * Gets contrast used in the effect.
  42674. */
  42675. /**
  42676. * Sets contrast used in the effect.
  42677. */
  42678. contrast: number;
  42679. /**
  42680. * Gets Vignette stretch size.
  42681. */
  42682. /**
  42683. * Sets Vignette stretch size.
  42684. */
  42685. vignetteStretch: number;
  42686. /**
  42687. * Gets Vignette centre X Offset.
  42688. */
  42689. /**
  42690. * Sets Vignette centre X Offset.
  42691. */
  42692. vignetteCentreX: number;
  42693. /**
  42694. * Gets Vignette centre Y Offset.
  42695. */
  42696. /**
  42697. * Sets Vignette centre Y Offset.
  42698. */
  42699. vignetteCentreY: number;
  42700. /**
  42701. * Gets Vignette weight or intensity of the vignette effect.
  42702. */
  42703. /**
  42704. * Sets Vignette weight or intensity of the vignette effect.
  42705. */
  42706. vignetteWeight: number;
  42707. /**
  42708. * Gets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  42709. * if vignetteEnabled is set to true.
  42710. */
  42711. /**
  42712. * Sets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  42713. * if vignetteEnabled is set to true.
  42714. */
  42715. vignetteColor: Color4;
  42716. /**
  42717. * Gets Camera field of view used by the Vignette effect.
  42718. */
  42719. /**
  42720. * Sets Camera field of view used by the Vignette effect.
  42721. */
  42722. vignetteCameraFov: number;
  42723. /**
  42724. * Gets the vignette blend mode allowing different kind of effect.
  42725. */
  42726. /**
  42727. * Sets the vignette blend mode allowing different kind of effect.
  42728. */
  42729. vignetteBlendMode: number;
  42730. /**
  42731. * Gets wether the vignette effect is enabled.
  42732. */
  42733. /**
  42734. * Sets wether the vignette effect is enabled.
  42735. */
  42736. vignetteEnabled: boolean;
  42737. private _fromLinearSpace;
  42738. /**
  42739. * Gets wether the input of the processing is in Gamma or Linear Space.
  42740. */
  42741. /**
  42742. * Sets wether the input of the processing is in Gamma or Linear Space.
  42743. */
  42744. fromLinearSpace: boolean;
  42745. /**
  42746. * Defines cache preventing GC.
  42747. */
  42748. private _defines;
  42749. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, imageProcessingConfiguration?: ImageProcessingConfiguration);
  42750. /**
  42751. * "ImageProcessingPostProcess"
  42752. * @returns "ImageProcessingPostProcess"
  42753. */
  42754. getClassName(): string;
  42755. protected _updateParameters(): void;
  42756. dispose(camera?: Camera): void;
  42757. }
  42758. }
  42759. declare module "babylonjs/Meshes/Builders/groundBuilder" {
  42760. import { Scene } from "babylonjs/scene";
  42761. import { Color3 } from "babylonjs/Maths/math.color";
  42762. import { Mesh } from "babylonjs/Meshes/mesh";
  42763. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  42764. import { Nullable } from "babylonjs/types";
  42765. /**
  42766. * Class containing static functions to help procedurally build meshes
  42767. */
  42768. export class GroundBuilder {
  42769. /**
  42770. * Creates a ground mesh
  42771. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  42772. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  42773. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  42774. * @param name defines the name of the mesh
  42775. * @param options defines the options used to create the mesh
  42776. * @param scene defines the hosting scene
  42777. * @returns the ground mesh
  42778. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  42779. */
  42780. static CreateGround(name: string, options: {
  42781. width?: number;
  42782. height?: number;
  42783. subdivisions?: number;
  42784. subdivisionsX?: number;
  42785. subdivisionsY?: number;
  42786. updatable?: boolean;
  42787. }, scene: any): Mesh;
  42788. /**
  42789. * Creates a tiled ground mesh
  42790. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  42791. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  42792. * * 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
  42793. * * 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
  42794. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  42795. * @param name defines the name of the mesh
  42796. * @param options defines the options used to create the mesh
  42797. * @param scene defines the hosting scene
  42798. * @returns the tiled ground mesh
  42799. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  42800. */
  42801. static CreateTiledGround(name: string, options: {
  42802. xmin: number;
  42803. zmin: number;
  42804. xmax: number;
  42805. zmax: number;
  42806. subdivisions?: {
  42807. w: number;
  42808. h: number;
  42809. };
  42810. precision?: {
  42811. w: number;
  42812. h: number;
  42813. };
  42814. updatable?: boolean;
  42815. }, scene?: Nullable<Scene>): Mesh;
  42816. /**
  42817. * Creates a ground mesh from a height map
  42818. * * The parameter `url` sets the URL of the height map image resource.
  42819. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  42820. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  42821. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  42822. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  42823. * * 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.
  42824. * * 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).
  42825. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  42826. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  42827. * @param name defines the name of the mesh
  42828. * @param url defines the url to the height map
  42829. * @param options defines the options used to create the mesh
  42830. * @param scene defines the hosting scene
  42831. * @returns the ground mesh
  42832. * @see https://doc.babylonjs.com/babylon101/height_map
  42833. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  42834. */
  42835. static CreateGroundFromHeightMap(name: string, url: string, options: {
  42836. width?: number;
  42837. height?: number;
  42838. subdivisions?: number;
  42839. minHeight?: number;
  42840. maxHeight?: number;
  42841. colorFilter?: Color3;
  42842. alphaFilter?: number;
  42843. updatable?: boolean;
  42844. onReady?: (mesh: GroundMesh) => void;
  42845. }, scene?: Nullable<Scene>): GroundMesh;
  42846. }
  42847. }
  42848. declare module "babylonjs/Meshes/Builders/torusBuilder" {
  42849. import { Vector4 } from "babylonjs/Maths/math.vector";
  42850. import { Mesh } from "babylonjs/Meshes/mesh";
  42851. /**
  42852. * Class containing static functions to help procedurally build meshes
  42853. */
  42854. export class TorusBuilder {
  42855. /**
  42856. * Creates a torus mesh
  42857. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  42858. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  42859. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  42860. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  42861. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  42862. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  42863. * @param name defines the name of the mesh
  42864. * @param options defines the options used to create the mesh
  42865. * @param scene defines the hosting scene
  42866. * @returns the torus mesh
  42867. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  42868. */
  42869. static CreateTorus(name: string, options: {
  42870. diameter?: number;
  42871. thickness?: number;
  42872. tessellation?: number;
  42873. updatable?: boolean;
  42874. sideOrientation?: number;
  42875. frontUVs?: Vector4;
  42876. backUVs?: Vector4;
  42877. }, scene: any): Mesh;
  42878. }
  42879. }
  42880. declare module "babylonjs/Meshes/Builders/cylinderBuilder" {
  42881. import { Vector4 } from "babylonjs/Maths/math.vector";
  42882. import { Color4 } from "babylonjs/Maths/math.color";
  42883. import { Mesh } from "babylonjs/Meshes/mesh";
  42884. /**
  42885. * Class containing static functions to help procedurally build meshes
  42886. */
  42887. export class CylinderBuilder {
  42888. /**
  42889. * Creates a cylinder or a cone mesh
  42890. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  42891. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  42892. * * 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.
  42893. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  42894. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  42895. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  42896. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  42897. * * 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).
  42898. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  42899. * * 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).
  42900. * * 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
  42901. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  42902. * * 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
  42903. * * 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.
  42904. * * If `enclose` is false, a ring surface is one element.
  42905. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  42906. * * 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
  42907. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  42908. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  42909. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  42910. * @param name defines the name of the mesh
  42911. * @param options defines the options used to create the mesh
  42912. * @param scene defines the hosting scene
  42913. * @returns the cylinder mesh
  42914. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  42915. */
  42916. static CreateCylinder(name: string, options: {
  42917. height?: number;
  42918. diameterTop?: number;
  42919. diameterBottom?: number;
  42920. diameter?: number;
  42921. tessellation?: number;
  42922. subdivisions?: number;
  42923. arc?: number;
  42924. faceColors?: Color4[];
  42925. faceUV?: Vector4[];
  42926. updatable?: boolean;
  42927. hasRings?: boolean;
  42928. enclose?: boolean;
  42929. cap?: number;
  42930. sideOrientation?: number;
  42931. frontUVs?: Vector4;
  42932. backUVs?: Vector4;
  42933. }, scene: any): Mesh;
  42934. }
  42935. }
  42936. declare module "babylonjs/Cameras/VR/vrExperienceHelper" {
  42937. import { Observable } from "babylonjs/Misc/observable";
  42938. import { Nullable } from "babylonjs/types";
  42939. import { Camera } from "babylonjs/Cameras/camera";
  42940. import { DeviceOrientationCamera } from "babylonjs/Cameras/deviceOrientationCamera";
  42941. import { VRDeviceOrientationFreeCamera } from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  42942. import { WebVROptions, WebVRFreeCamera } from "babylonjs/Cameras/VR/webVRCamera";
  42943. import { Scene } from "babylonjs/scene";
  42944. import { Vector3 } from "babylonjs/Maths/math.vector";
  42945. import { Color3 } from "babylonjs/Maths/math.color";
  42946. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  42947. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  42948. import { Mesh } from "babylonjs/Meshes/mesh";
  42949. import { PickingInfo } from "babylonjs/Collisions/pickingInfo";
  42950. import { VRCameraMetrics } from "babylonjs/Cameras/VR/vrCameraMetrics";
  42951. import "babylonjs/Meshes/Builders/groundBuilder";
  42952. import "babylonjs/Meshes/Builders/torusBuilder";
  42953. import "babylonjs/Meshes/Builders/cylinderBuilder";
  42954. import "babylonjs/Gamepads/gamepadSceneComponent";
  42955. import "babylonjs/Animations/animatable";
  42956. /**
  42957. * Options to modify the vr teleportation behavior.
  42958. */
  42959. export interface VRTeleportationOptions {
  42960. /**
  42961. * The name of the mesh which should be used as the teleportation floor. (default: null)
  42962. */
  42963. floorMeshName?: string;
  42964. /**
  42965. * A list of meshes to be used as the teleportation floor. (default: empty)
  42966. */
  42967. floorMeshes?: Mesh[];
  42968. }
  42969. /**
  42970. * Options to modify the vr experience helper's behavior.
  42971. */
  42972. export interface VRExperienceHelperOptions extends WebVROptions {
  42973. /**
  42974. * Create a DeviceOrientationCamera to be used as your out of vr camera. (default: true)
  42975. */
  42976. createDeviceOrientationCamera?: boolean;
  42977. /**
  42978. * Create a VRDeviceOrientationFreeCamera to be used for VR when no external HMD is found. (default: true)
  42979. */
  42980. createFallbackVRDeviceOrientationFreeCamera?: boolean;
  42981. /**
  42982. * Uses the main button on the controller to toggle the laser casted. (default: true)
  42983. */
  42984. laserToggle?: boolean;
  42985. /**
  42986. * A list of meshes to be used as the teleportation floor. If specified, teleportation will be enabled (default: undefined)
  42987. */
  42988. floorMeshes?: Mesh[];
  42989. /**
  42990. * Distortion metrics for the fallback vrDeviceOrientationCamera (default: VRCameraMetrics.Default)
  42991. */
  42992. vrDeviceOrientationCameraMetrics?: VRCameraMetrics;
  42993. }
  42994. /**
  42995. * Event containing information after VR has been entered
  42996. */
  42997. export class OnAfterEnteringVRObservableEvent {
  42998. /**
  42999. * If entering vr was successful
  43000. */
  43001. success: boolean;
  43002. }
  43003. /**
  43004. * Helps to quickly add VR support to an existing scene.
  43005. * See http://doc.babylonjs.com/how_to/webvr_helper
  43006. */
  43007. export class VRExperienceHelper {
  43008. /** Options to modify the vr experience helper's behavior. */
  43009. webVROptions: VRExperienceHelperOptions;
  43010. private _scene;
  43011. private _position;
  43012. private _btnVR;
  43013. private _btnVRDisplayed;
  43014. private _webVRsupported;
  43015. private _webVRready;
  43016. private _webVRrequesting;
  43017. private _webVRpresenting;
  43018. private _hasEnteredVR;
  43019. private _fullscreenVRpresenting;
  43020. private _inputElement;
  43021. private _webVRCamera;
  43022. private _vrDeviceOrientationCamera;
  43023. private _deviceOrientationCamera;
  43024. private _existingCamera;
  43025. private _onKeyDown;
  43026. private _onVrDisplayPresentChange;
  43027. private _onVRDisplayChanged;
  43028. private _onVRRequestPresentStart;
  43029. private _onVRRequestPresentComplete;
  43030. /**
  43031. * 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)
  43032. */
  43033. enableGazeEvenWhenNoPointerLock: boolean;
  43034. /**
  43035. * Gets or sets a boolean indicating that the VREXperienceHelper will exit VR if double tap is detected
  43036. */
  43037. exitVROnDoubleTap: boolean;
  43038. /**
  43039. * Observable raised right before entering VR.
  43040. */
  43041. onEnteringVRObservable: Observable<VRExperienceHelper>;
  43042. /**
  43043. * Observable raised when entering VR has completed.
  43044. */
  43045. onAfterEnteringVRObservable: Observable<OnAfterEnteringVRObservableEvent>;
  43046. /**
  43047. * Observable raised when exiting VR.
  43048. */
  43049. onExitingVRObservable: Observable<VRExperienceHelper>;
  43050. /**
  43051. * Observable raised when controller mesh is loaded.
  43052. */
  43053. onControllerMeshLoadedObservable: Observable<WebVRController>;
  43054. /** Return this.onEnteringVRObservable
  43055. * Note: This one is for backward compatibility. Please use onEnteringVRObservable directly
  43056. */
  43057. readonly onEnteringVR: Observable<VRExperienceHelper>;
  43058. /** Return this.onExitingVRObservable
  43059. * Note: This one is for backward compatibility. Please use onExitingVRObservable directly
  43060. */
  43061. readonly onExitingVR: Observable<VRExperienceHelper>;
  43062. /** Return this.onControllerMeshLoadedObservable
  43063. * Note: This one is for backward compatibility. Please use onControllerMeshLoadedObservable directly
  43064. */
  43065. readonly onControllerMeshLoaded: Observable<WebVRController>;
  43066. private _rayLength;
  43067. private _useCustomVRButton;
  43068. private _teleportationRequested;
  43069. private _teleportActive;
  43070. private _floorMeshName;
  43071. private _floorMeshesCollection;
  43072. private _rotationAllowed;
  43073. private _teleportBackwardsVector;
  43074. private _teleportationTarget;
  43075. private _isDefaultTeleportationTarget;
  43076. private _postProcessMove;
  43077. private _teleportationFillColor;
  43078. private _teleportationBorderColor;
  43079. private _rotationAngle;
  43080. private _haloCenter;
  43081. private _cameraGazer;
  43082. private _padSensibilityUp;
  43083. private _padSensibilityDown;
  43084. private _leftController;
  43085. private _rightController;
  43086. /**
  43087. * Observable raised when a new mesh is selected based on meshSelectionPredicate
  43088. */
  43089. onNewMeshSelected: Observable<AbstractMesh>;
  43090. /**
  43091. * Observable raised when a new mesh is selected based on meshSelectionPredicate.
  43092. * This observable will provide the mesh and the controller used to select the mesh
  43093. */
  43094. onMeshSelectedWithController: Observable<{
  43095. mesh: AbstractMesh;
  43096. controller: WebVRController;
  43097. }>;
  43098. /**
  43099. * Observable raised when a new mesh is picked based on meshSelectionPredicate
  43100. */
  43101. onNewMeshPicked: Observable<PickingInfo>;
  43102. private _circleEase;
  43103. /**
  43104. * Observable raised before camera teleportation
  43105. */
  43106. onBeforeCameraTeleport: Observable<Vector3>;
  43107. /**
  43108. * Observable raised after camera teleportation
  43109. */
  43110. onAfterCameraTeleport: Observable<Vector3>;
  43111. /**
  43112. * Observable raised when current selected mesh gets unselected
  43113. */
  43114. onSelectedMeshUnselected: Observable<AbstractMesh>;
  43115. private _raySelectionPredicate;
  43116. /**
  43117. * To be optionaly changed by user to define custom ray selection
  43118. */
  43119. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  43120. /**
  43121. * To be optionaly changed by user to define custom selection logic (after ray selection)
  43122. */
  43123. meshSelectionPredicate: (mesh: AbstractMesh) => boolean;
  43124. /**
  43125. * Set teleportation enabled. If set to false camera teleportation will be disabled but camera rotation will be kept.
  43126. */
  43127. teleportationEnabled: boolean;
  43128. private _defaultHeight;
  43129. private _teleportationInitialized;
  43130. private _interactionsEnabled;
  43131. private _interactionsRequested;
  43132. private _displayGaze;
  43133. private _displayLaserPointer;
  43134. /**
  43135. * The mesh used to display where the user is going to teleport.
  43136. */
  43137. /**
  43138. * Sets the mesh to be used to display where the user is going to teleport.
  43139. */
  43140. teleportationTarget: Mesh;
  43141. /**
  43142. * 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
  43143. * when set bakeCurrentTransformIntoVertices will be called on the mesh.
  43144. * See http://doc.babylonjs.com/resources/baking_transformations
  43145. */
  43146. gazeTrackerMesh: Mesh;
  43147. /**
  43148. * If the gaze trackers scale should be updated to be constant size when pointing at near/far meshes
  43149. */
  43150. updateGazeTrackerScale: boolean;
  43151. /**
  43152. * If the gaze trackers color should be updated when selecting meshes
  43153. */
  43154. updateGazeTrackerColor: boolean;
  43155. /**
  43156. * If the controller laser color should be updated when selecting meshes
  43157. */
  43158. updateControllerLaserColor: boolean;
  43159. /**
  43160. * The gaze tracking mesh corresponding to the left controller
  43161. */
  43162. readonly leftControllerGazeTrackerMesh: Nullable<Mesh>;
  43163. /**
  43164. * The gaze tracking mesh corresponding to the right controller
  43165. */
  43166. readonly rightControllerGazeTrackerMesh: Nullable<Mesh>;
  43167. /**
  43168. * If the ray of the gaze should be displayed.
  43169. */
  43170. /**
  43171. * Sets if the ray of the gaze should be displayed.
  43172. */
  43173. displayGaze: boolean;
  43174. /**
  43175. * If the ray of the LaserPointer should be displayed.
  43176. */
  43177. /**
  43178. * Sets if the ray of the LaserPointer should be displayed.
  43179. */
  43180. displayLaserPointer: boolean;
  43181. /**
  43182. * The deviceOrientationCamera used as the camera when not in VR.
  43183. */
  43184. readonly deviceOrientationCamera: Nullable<DeviceOrientationCamera>;
  43185. /**
  43186. * Based on the current WebVR support, returns the current VR camera used.
  43187. */
  43188. readonly currentVRCamera: Nullable<Camera>;
  43189. /**
  43190. * The webVRCamera which is used when in VR.
  43191. */
  43192. readonly webVRCamera: WebVRFreeCamera;
  43193. /**
  43194. * The deviceOrientationCamera that is used as a fallback when vr device is not connected.
  43195. */
  43196. readonly vrDeviceOrientationCamera: Nullable<VRDeviceOrientationFreeCamera>;
  43197. /**
  43198. * The html button that is used to trigger entering into VR.
  43199. */
  43200. readonly vrButton: Nullable<HTMLButtonElement>;
  43201. private readonly _teleportationRequestInitiated;
  43202. /**
  43203. * Defines wether or not Pointer lock should be requested when switching to
  43204. * full screen.
  43205. */
  43206. requestPointerLockOnFullScreen: boolean;
  43207. /**
  43208. * Instantiates a VRExperienceHelper.
  43209. * Helps to quickly add VR support to an existing scene.
  43210. * @param scene The scene the VRExperienceHelper belongs to.
  43211. * @param webVROptions Options to modify the vr experience helper's behavior.
  43212. */
  43213. constructor(scene: Scene,
  43214. /** Options to modify the vr experience helper's behavior. */
  43215. webVROptions?: VRExperienceHelperOptions);
  43216. private _onDefaultMeshLoaded;
  43217. private _onResize;
  43218. private _onFullscreenChange;
  43219. /**
  43220. * Gets a value indicating if we are currently in VR mode.
  43221. */
  43222. readonly isInVRMode: boolean;
  43223. private onVrDisplayPresentChange;
  43224. private onVRDisplayChanged;
  43225. private moveButtonToBottomRight;
  43226. private displayVRButton;
  43227. private updateButtonVisibility;
  43228. private _cachedAngularSensibility;
  43229. /**
  43230. * Attempt to enter VR. If a headset is connected and ready, will request present on that.
  43231. * Otherwise, will use the fullscreen API.
  43232. */
  43233. enterVR(): void;
  43234. /**
  43235. * Attempt to exit VR, or fullscreen.
  43236. */
  43237. exitVR(): void;
  43238. /**
  43239. * The position of the vr experience helper.
  43240. */
  43241. /**
  43242. * Sets the position of the vr experience helper.
  43243. */
  43244. position: Vector3;
  43245. /**
  43246. * Enables controllers and user interactions such as selecting and object or clicking on an object.
  43247. */
  43248. enableInteractions(): void;
  43249. private readonly _noControllerIsActive;
  43250. private beforeRender;
  43251. private _isTeleportationFloor;
  43252. /**
  43253. * Adds a floor mesh to be used for teleportation.
  43254. * @param floorMesh the mesh to be used for teleportation.
  43255. */
  43256. addFloorMesh(floorMesh: Mesh): void;
  43257. /**
  43258. * Removes a floor mesh from being used for teleportation.
  43259. * @param floorMesh the mesh to be removed.
  43260. */
  43261. removeFloorMesh(floorMesh: Mesh): void;
  43262. /**
  43263. * Enables interactions and teleportation using the VR controllers and gaze.
  43264. * @param vrTeleportationOptions options to modify teleportation behavior.
  43265. */
  43266. enableTeleportation(vrTeleportationOptions?: VRTeleportationOptions): void;
  43267. private _onNewGamepadConnected;
  43268. private _tryEnableInteractionOnController;
  43269. private _onNewGamepadDisconnected;
  43270. private _enableInteractionOnController;
  43271. private _checkTeleportWithRay;
  43272. private _checkRotate;
  43273. private _checkTeleportBackwards;
  43274. private _enableTeleportationOnController;
  43275. private _createTeleportationCircles;
  43276. private _displayTeleportationTarget;
  43277. private _hideTeleportationTarget;
  43278. private _rotateCamera;
  43279. private _moveTeleportationSelectorTo;
  43280. private _workingVector;
  43281. private _workingQuaternion;
  43282. private _workingMatrix;
  43283. /**
  43284. * Teleports the users feet to the desired location
  43285. * @param location The location where the user's feet should be placed
  43286. */
  43287. teleportCamera(location: Vector3): void;
  43288. private _convertNormalToDirectionOfRay;
  43289. private _castRayAndSelectObject;
  43290. private _notifySelectedMeshUnselected;
  43291. /**
  43292. * Sets the color of the laser ray from the vr controllers.
  43293. * @param color new color for the ray.
  43294. */
  43295. changeLaserColor(color: Color3): void;
  43296. /**
  43297. * Sets the color of the ray from the vr headsets gaze.
  43298. * @param color new color for the ray.
  43299. */
  43300. changeGazeColor(color: Color3): void;
  43301. /**
  43302. * Exits VR and disposes of the vr experience helper
  43303. */
  43304. dispose(): void;
  43305. /**
  43306. * Gets the name of the VRExperienceHelper class
  43307. * @returns "VRExperienceHelper"
  43308. */
  43309. getClassName(): string;
  43310. }
  43311. }
  43312. declare module "babylonjs/Cameras/VR/index" {
  43313. export * from "babylonjs/Cameras/VR/vrCameraMetrics";
  43314. export * from "babylonjs/Cameras/VR/vrDeviceOrientationArcRotateCamera";
  43315. export * from "babylonjs/Cameras/VR/vrDeviceOrientationFreeCamera";
  43316. export * from "babylonjs/Cameras/VR/vrDeviceOrientationGamepadCamera";
  43317. export * from "babylonjs/Cameras/VR/vrExperienceHelper";
  43318. export * from "babylonjs/Cameras/VR/webVRCamera";
  43319. }
  43320. declare module "babylonjs/Cameras/XR/webXRTypes" {
  43321. import { Nullable } from "babylonjs/types";
  43322. import { IDisposable } from "babylonjs/scene";
  43323. /**
  43324. * States of the webXR experience
  43325. */
  43326. export enum WebXRState {
  43327. /**
  43328. * Transitioning to being in XR mode
  43329. */
  43330. ENTERING_XR = 0,
  43331. /**
  43332. * Transitioning to non XR mode
  43333. */
  43334. EXITING_XR = 1,
  43335. /**
  43336. * In XR mode and presenting
  43337. */
  43338. IN_XR = 2,
  43339. /**
  43340. * Not entered XR mode
  43341. */
  43342. NOT_IN_XR = 3
  43343. }
  43344. /**
  43345. * Abstraction of the XR render target
  43346. */
  43347. export interface WebXRRenderTarget extends IDisposable {
  43348. /**
  43349. * xrpresent context of the canvas which can be used to display/mirror xr content
  43350. */
  43351. canvasContext: WebGLRenderingContext;
  43352. /**
  43353. * xr layer for the canvas
  43354. */
  43355. xrLayer: Nullable<XRWebGLLayer>;
  43356. /**
  43357. * Initializes the xr layer for the session
  43358. * @param xrSession xr session
  43359. * @returns a promise that will resolve once the XR Layer has been created
  43360. */
  43361. initializeXRLayerAsync(xrSession: XRSession): Promise<void>;
  43362. }
  43363. }
  43364. declare module "babylonjs/Cameras/XR/webXRManagedOutputCanvas" {
  43365. import { Nullable } from "babylonjs/types";
  43366. import { Observable } from "babylonjs/Misc/observable";
  43367. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  43368. import { WebXRState, WebXRRenderTarget } from "babylonjs/Cameras/XR/webXRTypes";
  43369. /**
  43370. * COnfiguration object for WebXR output canvas
  43371. */
  43372. export class WebXRManagedOutputCanvasOptions {
  43373. /**
  43374. * Options for this XR Layer output
  43375. */
  43376. canvasOptions: XRWebGLLayerOptions;
  43377. /**
  43378. * CSS styling for a newly created canvas (if not provided)
  43379. */
  43380. newCanvasCssStyle?: string;
  43381. /**
  43382. * Get the default values of the configuration object
  43383. * @returns default values of this configuration object
  43384. */
  43385. static GetDefaults(): WebXRManagedOutputCanvasOptions;
  43386. }
  43387. /**
  43388. * Creates a canvas that is added/removed from the webpage when entering/exiting XR
  43389. */
  43390. export class WebXRManagedOutputCanvas implements WebXRRenderTarget {
  43391. private configuration;
  43392. private _engine;
  43393. private _canvas;
  43394. /**
  43395. * xrpresent context of the canvas which can be used to display/mirror xr content
  43396. */
  43397. canvasContext: WebGLRenderingContext;
  43398. /**
  43399. * xr layer for the canvas
  43400. */
  43401. xrLayer: Nullable<XRWebGLLayer>;
  43402. /**
  43403. * Initializes the xr layer for the session
  43404. * @param xrSession xr session
  43405. * @returns a promise that will resolve once the XR Layer has been created
  43406. */
  43407. initializeXRLayerAsync(xrSession: any): any;
  43408. /**
  43409. * Initializes the canvas to be added/removed upon entering/exiting xr
  43410. * @param engine the Babylon engine
  43411. * @param canvas The canvas to be added/removed (If not specified a full screen canvas will be created)
  43412. * @param onStateChangedObservable the mechanism by which the canvas will be added/removed based on XR state
  43413. * @param configuration optional configuration for this canvas output. defaults will be used if not provided
  43414. */
  43415. constructor(engine: ThinEngine, canvas?: HTMLCanvasElement, onStateChangedObservable?: Observable<WebXRState>, configuration?: WebXRManagedOutputCanvasOptions);
  43416. /**
  43417. * Disposes of the object
  43418. */
  43419. dispose(): void;
  43420. private _setManagedOutputCanvas;
  43421. private _addCanvas;
  43422. private _removeCanvas;
  43423. }
  43424. }
  43425. declare module "babylonjs/Cameras/XR/webXRSessionManager" {
  43426. import { Observable } from "babylonjs/Misc/observable";
  43427. import { Nullable } from "babylonjs/types";
  43428. import { IDisposable, Scene } from "babylonjs/scene";
  43429. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  43430. import { WebXRRenderTarget, WebXRState } from "babylonjs/Cameras/XR/webXRTypes";
  43431. import { WebXRManagedOutputCanvasOptions } from "babylonjs/Cameras/XR/webXRManagedOutputCanvas";
  43432. /**
  43433. * Manages an XRSession to work with Babylon's engine
  43434. * @see https://doc.babylonjs.com/how_to/webxr
  43435. */
  43436. export class WebXRSessionManager implements IDisposable {
  43437. private scene;
  43438. /**
  43439. * Fires every time a new xrFrame arrives which can be used to update the camera
  43440. */
  43441. onXRFrameObservable: Observable<any>;
  43442. /**
  43443. * Fires when the xr session is ended either by the device or manually done
  43444. */
  43445. onXRSessionEnded: Observable<any>;
  43446. /**
  43447. * Underlying xr session
  43448. */
  43449. session: XRSession;
  43450. /**
  43451. * Type of reference space used when creating the session
  43452. */
  43453. referenceSpace: XRReferenceSpace;
  43454. /**
  43455. * Current XR frame
  43456. */
  43457. currentFrame: Nullable<XRFrame>;
  43458. private _xrNavigator;
  43459. private baseLayer;
  43460. private _rttProvider;
  43461. private _sessionEnded;
  43462. /**
  43463. * Constructs a WebXRSessionManager, this must be initialized within a user action before usage
  43464. * @param scene The scene which the session should be created for
  43465. */
  43466. constructor(scene: Scene);
  43467. /**
  43468. * Initializes the manager
  43469. * After initialization enterXR can be called to start an XR session
  43470. * @returns Promise which resolves after it is initialized
  43471. */
  43472. initializeAsync(): Promise<void>;
  43473. /**
  43474. * Initializes an xr session
  43475. * @param xrSessionMode mode to initialize
  43476. * @param optionalFeatures defines optional values to pass to the session builder
  43477. * @returns a promise which will resolve once the session has been initialized
  43478. */
  43479. initializeSessionAsync(xrSessionMode: XRSessionMode, optionalFeatures?: any): any;
  43480. /**
  43481. * Sets the reference space on the xr session
  43482. * @param referenceSpace space to set
  43483. * @returns a promise that will resolve once the reference space has been set
  43484. */
  43485. setReferenceSpaceAsync(referenceSpace: XRReferenceSpaceType): Promise<void>;
  43486. /**
  43487. * Updates the render state of the session
  43488. * @param state state to set
  43489. * @returns a promise that resolves once the render state has been updated
  43490. */
  43491. updateRenderStateAsync(state: XRRenderState): Promise<void>;
  43492. /**
  43493. * Starts rendering to the xr layer
  43494. * @returns a promise that will resolve once rendering has started
  43495. */
  43496. startRenderingToXRAsync(): Promise<void>;
  43497. /**
  43498. * Gets the correct render target texture to be rendered this frame for this eye
  43499. * @param eye the eye for which to get the render target
  43500. * @returns the render target for the specified eye
  43501. */
  43502. getRenderTargetTextureForEye(eye: XREye): RenderTargetTexture;
  43503. /**
  43504. * Stops the xrSession and restores the renderloop
  43505. * @returns Promise which resolves after it exits XR
  43506. */
  43507. exitXRAsync(): Promise<void>;
  43508. /**
  43509. * Checks if a session would be supported for the creation options specified
  43510. * @param sessionMode session mode to check if supported eg. immersive-vr
  43511. * @returns true if supported
  43512. */
  43513. supportsSessionAsync(sessionMode: XRSessionMode): any;
  43514. /**
  43515. * Creates a WebXRRenderTarget object for the XR session
  43516. * @param onStateChangedObservable optional, mechanism for enabling/disabling XR rendering canvas, used only on Web
  43517. * @param options optional options to provide when creating a new render target
  43518. * @returns a WebXR render target to which the session can render
  43519. */
  43520. getWebXRRenderTarget(onStateChangedObservable?: Observable<WebXRState>, options?: WebXRManagedOutputCanvasOptions): WebXRRenderTarget;
  43521. /**
  43522. * @hidden
  43523. * Converts the render layer of xrSession to a render target
  43524. * @param session session to create render target for
  43525. * @param scene scene the new render target should be created for
  43526. */
  43527. static _CreateRenderTargetTextureFromSession(session: XRSession, scene: Scene, baseLayer: XRWebGLLayer): RenderTargetTexture;
  43528. /**
  43529. * Disposes of the session manager
  43530. */
  43531. dispose(): void;
  43532. }
  43533. }
  43534. declare module "babylonjs/Cameras/XR/webXRCamera" {
  43535. import { Scene } from "babylonjs/scene";
  43536. import { FreeCamera } from "babylonjs/Cameras/freeCamera";
  43537. import { WebXRSessionManager } from "babylonjs/Cameras/XR/webXRSessionManager";
  43538. /**
  43539. * WebXR Camera which holds the views for the xrSession
  43540. * @see https://doc.babylonjs.com/how_to/webxr
  43541. */
  43542. export class WebXRCamera extends FreeCamera {
  43543. /**
  43544. * Is the camera in debug mode. Used when using an emulator
  43545. */
  43546. debugMode: boolean;
  43547. /**
  43548. * Creates a new webXRCamera, this should only be set at the camera after it has been updated by the xrSessionManager
  43549. * @param name the name of the camera
  43550. * @param scene the scene to add the camera to
  43551. */
  43552. constructor(name: string, scene: Scene);
  43553. private _updateNumberOfRigCameras;
  43554. /** @hidden */
  43555. _updateForDualEyeDebugging(): void;
  43556. /**
  43557. * Updates the cameras position from the current pose information of the XR session
  43558. * @param xrSessionManager the session containing pose information
  43559. * @returns true if the camera has been updated, false if the session did not contain pose or frame data
  43560. */
  43561. updateFromXRSessionManager(xrSessionManager: WebXRSessionManager): boolean;
  43562. }
  43563. }
  43564. declare module "babylonjs/Cameras/XR/webXRExperienceHelper" {
  43565. import { Observable } from "babylonjs/Misc/observable";
  43566. import { IDisposable, Scene } from "babylonjs/scene";
  43567. import { Quaternion, Vector3 } from "babylonjs/Maths/math.vector";
  43568. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  43569. import { WebXRSessionManager } from "babylonjs/Cameras/XR/webXRSessionManager";
  43570. import { WebXRCamera } from "babylonjs/Cameras/XR/webXRCamera";
  43571. import { WebXRState, WebXRRenderTarget } from "babylonjs/Cameras/XR/webXRTypes";
  43572. /**
  43573. * Base set of functionality needed to create an XR experince (WebXRSessionManager, Camera, StateManagement, etc.)
  43574. * @see https://doc.babylonjs.com/how_to/webxr
  43575. */
  43576. export class WebXRExperienceHelper implements IDisposable {
  43577. private scene;
  43578. /**
  43579. * 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
  43580. */
  43581. container: AbstractMesh;
  43582. /**
  43583. * Camera used to render xr content
  43584. */
  43585. camera: WebXRCamera;
  43586. /**
  43587. * The current state of the XR experience (eg. transitioning, in XR or not in XR)
  43588. */
  43589. state: WebXRState;
  43590. private _setState;
  43591. private static _TmpVector;
  43592. /**
  43593. * Fires when the state of the experience helper has changed
  43594. */
  43595. onStateChangedObservable: Observable<WebXRState>;
  43596. /** Session manager used to keep track of xr session */
  43597. sessionManager: WebXRSessionManager;
  43598. private _nonVRCamera;
  43599. private _originalSceneAutoClear;
  43600. private _supported;
  43601. /**
  43602. * Creates the experience helper
  43603. * @param scene the scene to attach the experience helper to
  43604. * @returns a promise for the experience helper
  43605. */
  43606. static CreateAsync(scene: Scene): Promise<WebXRExperienceHelper>;
  43607. /**
  43608. * Creates a WebXRExperienceHelper
  43609. * @param scene The scene the helper should be created in
  43610. */
  43611. private constructor();
  43612. /**
  43613. * Exits XR mode and returns the scene to its original state
  43614. * @returns promise that resolves after xr mode has exited
  43615. */
  43616. exitXRAsync(): Promise<void>;
  43617. /**
  43618. * Enters XR mode (This must be done within a user interaction in most browsers eg. button click)
  43619. * @param sessionMode options for the XR session
  43620. * @param referenceSpaceType frame of reference of the XR session
  43621. * @param renderTarget the output canvas that will be used to enter XR mode
  43622. * @returns promise that resolves after xr mode has entered
  43623. */
  43624. enterXRAsync(sessionMode: XRSessionMode, referenceSpaceType: XRReferenceSpaceType, renderTarget: WebXRRenderTarget): any;
  43625. /**
  43626. * Updates the global position of the camera by moving the camera's container
  43627. * This should be used instead of modifying the camera's position as it will be overwritten by an xrSessions's update frame
  43628. * @param position The desired global position of the camera
  43629. */
  43630. setPositionOfCameraUsingContainer(position: Vector3): void;
  43631. /**
  43632. * Rotates the xr camera by rotating the camera's container around the camera's position
  43633. * This should be used instead of modifying the camera's rotation as it will be overwritten by an xrSessions's update frame
  43634. * @param rotation the desired quaternion rotation to apply to the camera
  43635. */
  43636. rotateCameraByQuaternionUsingContainer(rotation: Quaternion): void;
  43637. /**
  43638. * Disposes of the experience helper
  43639. */
  43640. dispose(): void;
  43641. }
  43642. }
  43643. declare module "babylonjs/Cameras/XR/webXREnterExitUI" {
  43644. import { Nullable } from "babylonjs/types";
  43645. import { Observable } from "babylonjs/Misc/observable";
  43646. import { IDisposable, Scene } from "babylonjs/scene";
  43647. import { WebXRExperienceHelper } from "babylonjs/Cameras/XR/webXRExperienceHelper";
  43648. import { WebXRRenderTarget } from "babylonjs/Cameras/XR/webXRTypes";
  43649. /**
  43650. * Button which can be used to enter a different mode of XR
  43651. */
  43652. export class WebXREnterExitUIButton {
  43653. /** button element */
  43654. element: HTMLElement;
  43655. /** XR initialization options for the button */
  43656. sessionMode: XRSessionMode;
  43657. /** Reference space type */
  43658. referenceSpaceType: XRReferenceSpaceType;
  43659. /**
  43660. * Creates a WebXREnterExitUIButton
  43661. * @param element button element
  43662. * @param sessionMode XR initialization session mode
  43663. * @param referenceSpaceType the type of reference space to be used
  43664. */
  43665. constructor(
  43666. /** button element */
  43667. element: HTMLElement,
  43668. /** XR initialization options for the button */
  43669. sessionMode: XRSessionMode,
  43670. /** Reference space type */
  43671. referenceSpaceType: XRReferenceSpaceType);
  43672. /**
  43673. * Overwritable function which can be used to update the button's visuals when the state changes
  43674. * @param activeButton the current active button in the UI
  43675. */
  43676. update(activeButton: Nullable<WebXREnterExitUIButton>): void;
  43677. }
  43678. /**
  43679. * Options to create the webXR UI
  43680. */
  43681. export class WebXREnterExitUIOptions {
  43682. /**
  43683. * Context to enter xr with
  43684. */
  43685. renderTarget?: Nullable<WebXRRenderTarget>;
  43686. /**
  43687. * User provided buttons to enable/disable WebXR. The system will provide default if not set
  43688. */
  43689. customButtons?: Array<WebXREnterExitUIButton>;
  43690. }
  43691. /**
  43692. * UI to allow the user to enter/exit XR mode
  43693. */
  43694. export class WebXREnterExitUI implements IDisposable {
  43695. private scene;
  43696. private _overlay;
  43697. private _buttons;
  43698. private _activeButton;
  43699. /**
  43700. * Fired every time the active button is changed.
  43701. *
  43702. * When xr is entered via a button that launches xr that button will be the callback parameter
  43703. *
  43704. * When exiting xr the callback parameter will be null)
  43705. */
  43706. activeButtonChangedObservable: Observable<Nullable<WebXREnterExitUIButton>>;
  43707. /**
  43708. * Creates UI to allow the user to enter/exit XR mode
  43709. * @param scene the scene to add the ui to
  43710. * @param helper the xr experience helper to enter/exit xr with
  43711. * @param options options to configure the UI
  43712. * @returns the created ui
  43713. */
  43714. static CreateAsync(scene: Scene, helper: WebXRExperienceHelper, options: WebXREnterExitUIOptions): Promise<WebXREnterExitUI>;
  43715. private constructor();
  43716. private _updateButtons;
  43717. /**
  43718. * Disposes of the object
  43719. */
  43720. dispose(): void;
  43721. }
  43722. }
  43723. declare module "babylonjs/Cameras/XR/webXRController" {
  43724. import { Nullable } from "babylonjs/types";
  43725. import { Observable } from "babylonjs/Misc/observable";
  43726. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  43727. import { Ray } from "babylonjs/Culling/ray";
  43728. import { Scene } from "babylonjs/scene";
  43729. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  43730. /**
  43731. * Represents an XR input
  43732. */
  43733. export class WebXRController {
  43734. private scene;
  43735. /** The underlying input source for the controller */
  43736. inputSource: XRInputSource;
  43737. private parentContainer;
  43738. /**
  43739. * 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
  43740. */
  43741. grip?: AbstractMesh;
  43742. /**
  43743. * Pointer which can be used to select objects or attach a visible laser to
  43744. */
  43745. pointer: AbstractMesh;
  43746. private _gamepadMode;
  43747. /**
  43748. * If available, this is the gamepad object related to this controller.
  43749. * Using this object it is possible to get click events and trackpad changes of the
  43750. * webxr controller that is currently being used.
  43751. */
  43752. gamepadController?: WebVRController;
  43753. /**
  43754. * Event that fires when the controller is removed/disposed
  43755. */
  43756. onDisposeObservable: Observable<{}>;
  43757. private _tmpMatrix;
  43758. private _tmpQuaternion;
  43759. private _tmpVector;
  43760. /**
  43761. * Creates the controller
  43762. * @see https://doc.babylonjs.com/how_to/webxr
  43763. * @param scene the scene which the controller should be associated to
  43764. * @param inputSource the underlying input source for the controller
  43765. * @param parentContainer parent that the controller meshes should be children of
  43766. */
  43767. constructor(scene: Scene,
  43768. /** The underlying input source for the controller */
  43769. inputSource: XRInputSource, parentContainer?: Nullable<AbstractMesh>);
  43770. /**
  43771. * Updates the controller pose based on the given XRFrame
  43772. * @param xrFrame xr frame to update the pose with
  43773. * @param referenceSpace reference space to use
  43774. */
  43775. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace): void;
  43776. /**
  43777. * Gets a world space ray coming from the controller
  43778. * @param result the resulting ray
  43779. */
  43780. getWorldPointerRayToRef(result: Ray): void;
  43781. /**
  43782. * Get the scene associated with this controller
  43783. * @returns the scene object
  43784. */
  43785. getScene(): Scene;
  43786. /**
  43787. * Disposes of the object
  43788. */
  43789. dispose(): void;
  43790. }
  43791. }
  43792. declare module "babylonjs/Cameras/XR/webXRInput" {
  43793. import { Observable } from "babylonjs/Misc/observable";
  43794. import { IDisposable } from "babylonjs/scene";
  43795. import { WebXRExperienceHelper } from "babylonjs/Cameras/XR/webXRExperienceHelper";
  43796. import { WebXRController } from "babylonjs/Cameras/XR/webXRController";
  43797. /**
  43798. * XR input used to track XR inputs such as controllers/rays
  43799. */
  43800. export class WebXRInput implements IDisposable {
  43801. /**
  43802. * Base experience the input listens to
  43803. */
  43804. baseExperience: WebXRExperienceHelper;
  43805. /**
  43806. * XR controllers being tracked
  43807. */
  43808. controllers: Array<WebXRController>;
  43809. private _frameObserver;
  43810. private _stateObserver;
  43811. /**
  43812. * Event when a controller has been connected/added
  43813. */
  43814. onControllerAddedObservable: Observable<WebXRController>;
  43815. /**
  43816. * Event when a controller has been removed/disconnected
  43817. */
  43818. onControllerRemovedObservable: Observable<WebXRController>;
  43819. /**
  43820. * Initializes the WebXRInput
  43821. * @param baseExperience experience helper which the input should be created for
  43822. */
  43823. constructor(
  43824. /**
  43825. * Base experience the input listens to
  43826. */
  43827. baseExperience: WebXRExperienceHelper);
  43828. private _onInputSourcesChange;
  43829. private _addAndRemoveControllers;
  43830. /**
  43831. * Disposes of the object
  43832. */
  43833. dispose(): void;
  43834. }
  43835. }
  43836. declare module "babylonjs/Cameras/XR/webXRControllerTeleportation" {
  43837. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  43838. import { WebXRInput } from "babylonjs/Cameras/XR/webXRInput";
  43839. /**
  43840. * Enables teleportation
  43841. */
  43842. export class WebXRControllerTeleportation {
  43843. private _teleportationFillColor;
  43844. private _teleportationBorderColor;
  43845. private _tmpRay;
  43846. private _tmpVector;
  43847. /**
  43848. * Creates a WebXRControllerTeleportation
  43849. * @param input input manager to add teleportation to
  43850. * @param floorMeshes floormeshes which can be teleported to
  43851. */
  43852. constructor(input: WebXRInput, floorMeshes?: Array<AbstractMesh>);
  43853. }
  43854. }
  43855. declare module "babylonjs/Cameras/XR/webXRControllerPointerSelection" {
  43856. import { WebXRInput } from "babylonjs/Cameras/XR/webXRInput";
  43857. /**
  43858. * Handles pointer input automatically for the pointer of XR controllers
  43859. */
  43860. export class WebXRControllerPointerSelection {
  43861. private static _idCounter;
  43862. private _tmpRay;
  43863. /**
  43864. * Creates a WebXRControllerPointerSelection
  43865. * @param input input manager to setup pointer selection
  43866. */
  43867. constructor(input: WebXRInput);
  43868. private _convertNormalToDirectionOfRay;
  43869. private _updatePointerDistance;
  43870. }
  43871. }
  43872. declare module "babylonjs/Loading/sceneLoader" {
  43873. import { Observable } from "babylonjs/Misc/observable";
  43874. import { Nullable } from "babylonjs/types";
  43875. import { Scene } from "babylonjs/scene";
  43876. import { Engine } from "babylonjs/Engines/engine";
  43877. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  43878. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  43879. import { AssetContainer } from "babylonjs/assetContainer";
  43880. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  43881. import { Skeleton } from "babylonjs/Bones/skeleton";
  43882. import { IFileRequest } from "babylonjs/Misc/fileRequest";
  43883. import { WebRequest } from "babylonjs/Misc/webRequest";
  43884. /**
  43885. * Class used to represent data loading progression
  43886. */
  43887. export class SceneLoaderProgressEvent {
  43888. /** defines if data length to load can be evaluated */
  43889. readonly lengthComputable: boolean;
  43890. /** defines the loaded data length */
  43891. readonly loaded: number;
  43892. /** defines the data length to load */
  43893. readonly total: number;
  43894. /**
  43895. * Create a new progress event
  43896. * @param lengthComputable defines if data length to load can be evaluated
  43897. * @param loaded defines the loaded data length
  43898. * @param total defines the data length to load
  43899. */
  43900. constructor(
  43901. /** defines if data length to load can be evaluated */
  43902. lengthComputable: boolean,
  43903. /** defines the loaded data length */
  43904. loaded: number,
  43905. /** defines the data length to load */
  43906. total: number);
  43907. /**
  43908. * Creates a new SceneLoaderProgressEvent from a ProgressEvent
  43909. * @param event defines the source event
  43910. * @returns a new SceneLoaderProgressEvent
  43911. */
  43912. static FromProgressEvent(event: ProgressEvent): SceneLoaderProgressEvent;
  43913. }
  43914. /**
  43915. * Interface used by SceneLoader plugins to define supported file extensions
  43916. */
  43917. export interface ISceneLoaderPluginExtensions {
  43918. /**
  43919. * Defines the list of supported extensions
  43920. */
  43921. [extension: string]: {
  43922. isBinary: boolean;
  43923. };
  43924. }
  43925. /**
  43926. * Interface used by SceneLoader plugin factory
  43927. */
  43928. export interface ISceneLoaderPluginFactory {
  43929. /**
  43930. * Defines the name of the factory
  43931. */
  43932. name: string;
  43933. /**
  43934. * Function called to create a new plugin
  43935. * @return the new plugin
  43936. */
  43937. createPlugin(): ISceneLoaderPlugin | ISceneLoaderPluginAsync;
  43938. /**
  43939. * The callback that returns true if the data can be directly loaded.
  43940. * @param data string containing the file data
  43941. * @returns if the data can be loaded directly
  43942. */
  43943. canDirectLoad?(data: string): boolean;
  43944. }
  43945. /**
  43946. * Interface used to define the base of ISceneLoaderPlugin and ISceneLoaderPluginAsync
  43947. */
  43948. export interface ISceneLoaderPluginBase {
  43949. /**
  43950. * The friendly name of this plugin.
  43951. */
  43952. name: string;
  43953. /**
  43954. * The file extensions supported by this plugin.
  43955. */
  43956. extensions: string | ISceneLoaderPluginExtensions;
  43957. /**
  43958. * The callback called when loading from a url.
  43959. * @param scene scene loading this url
  43960. * @param url url to load
  43961. * @param onSuccess callback called when the file successfully loads
  43962. * @param onProgress callback called while file is loading (if the server supports this mode)
  43963. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  43964. * @param onError callback called when the file fails to load
  43965. * @returns a file request object
  43966. */
  43967. requestFile?(scene: Scene, url: string, onSuccess: (data: any, request?: WebRequest) => void, onProgress?: (ev: ProgressEvent) => void, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  43968. /**
  43969. * The callback called when loading from a file object.
  43970. * @param scene scene loading this file
  43971. * @param file defines the file to load
  43972. * @param onSuccess defines the callback to call when data is loaded
  43973. * @param onProgress defines the callback to call during loading process
  43974. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  43975. * @param onError defines the callback to call when an error occurs
  43976. * @returns a file request object
  43977. */
  43978. readFile?(scene: Scene, file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  43979. /**
  43980. * The callback that returns true if the data can be directly loaded.
  43981. * @param data string containing the file data
  43982. * @returns if the data can be loaded directly
  43983. */
  43984. canDirectLoad?(data: string): boolean;
  43985. /**
  43986. * The callback that returns the data to pass to the plugin if the data can be directly loaded.
  43987. * @param scene scene loading this data
  43988. * @param data string containing the data
  43989. * @returns data to pass to the plugin
  43990. */
  43991. directLoad?(scene: Scene, data: string): any;
  43992. /**
  43993. * The callback that allows custom handling of the root url based on the response url.
  43994. * @param rootUrl the original root url
  43995. * @param responseURL the response url if available
  43996. * @returns the new root url
  43997. */
  43998. rewriteRootURL?(rootUrl: string, responseURL?: string): string;
  43999. }
  44000. /**
  44001. * Interface used to define a SceneLoader plugin
  44002. */
  44003. export interface ISceneLoaderPlugin extends ISceneLoaderPluginBase {
  44004. /**
  44005. * Import meshes into a scene.
  44006. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  44007. * @param scene The scene to import into
  44008. * @param data The data to import
  44009. * @param rootUrl The root url for scene and resources
  44010. * @param meshes The meshes array to import into
  44011. * @param particleSystems The particle systems array to import into
  44012. * @param skeletons The skeletons array to import into
  44013. * @param onError The callback when import fails
  44014. * @returns True if successful or false otherwise
  44015. */
  44016. importMesh(meshesNames: any, scene: Scene, data: any, rootUrl: string, meshes: AbstractMesh[], particleSystems: IParticleSystem[], skeletons: Skeleton[], onError?: (message: string, exception?: any) => void): boolean;
  44017. /**
  44018. * Load into a scene.
  44019. * @param scene The scene to load into
  44020. * @param data The data to import
  44021. * @param rootUrl The root url for scene and resources
  44022. * @param onError The callback when import fails
  44023. * @returns True if successful or false otherwise
  44024. */
  44025. load(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): boolean;
  44026. /**
  44027. * Load into an asset container.
  44028. * @param scene The scene to load into
  44029. * @param data The data to import
  44030. * @param rootUrl The root url for scene and resources
  44031. * @param onError The callback when import fails
  44032. * @returns The loaded asset container
  44033. */
  44034. loadAssetContainer(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): AssetContainer;
  44035. }
  44036. /**
  44037. * Interface used to define an async SceneLoader plugin
  44038. */
  44039. export interface ISceneLoaderPluginAsync extends ISceneLoaderPluginBase {
  44040. /**
  44041. * Import meshes into a scene.
  44042. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  44043. * @param scene The scene to import into
  44044. * @param data The data to import
  44045. * @param rootUrl The root url for scene and resources
  44046. * @param onProgress The callback when the load progresses
  44047. * @param fileName Defines the name of the file to load
  44048. * @returns The loaded meshes, particle systems, skeletons, and animation groups
  44049. */
  44050. importMeshAsync(meshesNames: any, scene: Scene, data: any, rootUrl: string, onProgress?: (event: SceneLoaderProgressEvent) => void, fileName?: string): Promise<{
  44051. meshes: AbstractMesh[];
  44052. particleSystems: IParticleSystem[];
  44053. skeletons: Skeleton[];
  44054. animationGroups: AnimationGroup[];
  44055. }>;
  44056. /**
  44057. * Load into a scene.
  44058. * @param scene The scene to load into
  44059. * @param data The data to import
  44060. * @param rootUrl The root url for scene and resources
  44061. * @param onProgress The callback when the load progresses
  44062. * @param fileName Defines the name of the file to load
  44063. * @returns Nothing
  44064. */
  44065. loadAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: SceneLoaderProgressEvent) => void, fileName?: string): Promise<void>;
  44066. /**
  44067. * Load into an asset container.
  44068. * @param scene The scene to load into
  44069. * @param data The data to import
  44070. * @param rootUrl The root url for scene and resources
  44071. * @param onProgress The callback when the load progresses
  44072. * @param fileName Defines the name of the file to load
  44073. * @returns The loaded asset container
  44074. */
  44075. loadAssetContainerAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: SceneLoaderProgressEvent) => void, fileName?: string): Promise<AssetContainer>;
  44076. }
  44077. /**
  44078. * Class used to load scene from various file formats using registered plugins
  44079. * @see http://doc.babylonjs.com/how_to/load_from_any_file_type
  44080. */
  44081. export class SceneLoader {
  44082. /**
  44083. * No logging while loading
  44084. */
  44085. static readonly NO_LOGGING: number;
  44086. /**
  44087. * Minimal logging while loading
  44088. */
  44089. static readonly MINIMAL_LOGGING: number;
  44090. /**
  44091. * Summary logging while loading
  44092. */
  44093. static readonly SUMMARY_LOGGING: number;
  44094. /**
  44095. * Detailled logging while loading
  44096. */
  44097. static readonly DETAILED_LOGGING: number;
  44098. /**
  44099. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  44100. */
  44101. static ForceFullSceneLoadingForIncremental: boolean;
  44102. /**
  44103. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  44104. */
  44105. static ShowLoadingScreen: boolean;
  44106. /**
  44107. * Defines the current logging level (while loading the scene)
  44108. * @ignorenaming
  44109. */
  44110. static loggingLevel: number;
  44111. /**
  44112. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  44113. */
  44114. static CleanBoneMatrixWeights: boolean;
  44115. /**
  44116. * Event raised when a plugin is used to load a scene
  44117. */
  44118. static OnPluginActivatedObservable: Observable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  44119. private static _registeredPlugins;
  44120. private static _getDefaultPlugin;
  44121. private static _getPluginForExtension;
  44122. private static _getPluginForDirectLoad;
  44123. private static _getPluginForFilename;
  44124. private static _getDirectLoad;
  44125. private static _loadData;
  44126. private static _getFileInfo;
  44127. /**
  44128. * Gets a plugin that can load the given extension
  44129. * @param extension defines the extension to load
  44130. * @returns a plugin or null if none works
  44131. */
  44132. static GetPluginForExtension(extension: string): ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  44133. /**
  44134. * Gets a boolean indicating that the given extension can be loaded
  44135. * @param extension defines the extension to load
  44136. * @returns true if the extension is supported
  44137. */
  44138. static IsPluginForExtensionAvailable(extension: string): boolean;
  44139. /**
  44140. * Adds a new plugin to the list of registered plugins
  44141. * @param plugin defines the plugin to add
  44142. */
  44143. static RegisterPlugin(plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync): void;
  44144. /**
  44145. * Import meshes into a scene
  44146. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  44147. * @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)
  44148. * @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)
  44149. * @param scene the instance of BABYLON.Scene to append to
  44150. * @param onSuccess a callback with a list of imported meshes, particleSystems, and skeletons when import succeeds
  44151. * @param onProgress a callback with a progress event for each file being loaded
  44152. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  44153. * @param pluginExtension the extension used to determine the plugin
  44154. * @returns The loaded plugin
  44155. */
  44156. 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>;
  44157. /**
  44158. * Import meshes into a scene
  44159. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  44160. * @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)
  44161. * @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)
  44162. * @param scene the instance of BABYLON.Scene to append to
  44163. * @param onProgress a callback with a progress event for each file being loaded
  44164. * @param pluginExtension the extension used to determine the plugin
  44165. * @returns The loaded list of imported meshes, particle systems, skeletons, and animation groups
  44166. */
  44167. static ImportMeshAsync(meshNames: any, rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<{
  44168. meshes: AbstractMesh[];
  44169. particleSystems: IParticleSystem[];
  44170. skeletons: Skeleton[];
  44171. animationGroups: AnimationGroup[];
  44172. }>;
  44173. /**
  44174. * Load a scene
  44175. * @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)
  44176. * @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)
  44177. * @param engine is the instance of BABYLON.Engine to use to create the scene
  44178. * @param onSuccess a callback with the scene when import succeeds
  44179. * @param onProgress a callback with a progress event for each file being loaded
  44180. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  44181. * @param pluginExtension the extension used to determine the plugin
  44182. * @returns The loaded plugin
  44183. */
  44184. 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>;
  44185. /**
  44186. * Load a scene
  44187. * @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)
  44188. * @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)
  44189. * @param engine is the instance of BABYLON.Engine to use to create the scene
  44190. * @param onProgress a callback with a progress event for each file being loaded
  44191. * @param pluginExtension the extension used to determine the plugin
  44192. * @returns The loaded scene
  44193. */
  44194. static LoadAsync(rootUrl: string, sceneFilename?: string | File, engine?: Nullable<Engine>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  44195. /**
  44196. * Append a scene
  44197. * @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)
  44198. * @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)
  44199. * @param scene is the instance of BABYLON.Scene to append to
  44200. * @param onSuccess a callback with the scene when import succeeds
  44201. * @param onProgress a callback with a progress event for each file being loaded
  44202. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  44203. * @param pluginExtension the extension used to determine the plugin
  44204. * @returns The loaded plugin
  44205. */
  44206. 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>;
  44207. /**
  44208. * Append a scene
  44209. * @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)
  44210. * @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)
  44211. * @param scene is the instance of BABYLON.Scene to append to
  44212. * @param onProgress a callback with a progress event for each file being loaded
  44213. * @param pluginExtension the extension used to determine the plugin
  44214. * @returns The given scene
  44215. */
  44216. static AppendAsync(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  44217. /**
  44218. * Load a scene into an asset container
  44219. * @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)
  44220. * @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)
  44221. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  44222. * @param onSuccess a callback with the scene when import succeeds
  44223. * @param onProgress a callback with a progress event for each file being loaded
  44224. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  44225. * @param pluginExtension the extension used to determine the plugin
  44226. * @returns The loaded plugin
  44227. */
  44228. 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>;
  44229. /**
  44230. * Load a scene into an asset container
  44231. * @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)
  44232. * @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)
  44233. * @param scene is the instance of Scene to append to
  44234. * @param onProgress a callback with a progress event for each file being loaded
  44235. * @param pluginExtension the extension used to determine the plugin
  44236. * @returns The loaded asset container
  44237. */
  44238. static LoadAssetContainerAsync(rootUrl: string, sceneFilename?: string, scene?: Nullable<Scene>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<AssetContainer>;
  44239. }
  44240. }
  44241. declare module "babylonjs/Gamepads/Controllers/genericController" {
  44242. import { Scene } from "babylonjs/scene";
  44243. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44244. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  44245. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  44246. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  44247. /**
  44248. * Generic Controller
  44249. */
  44250. export class GenericController extends WebVRController {
  44251. /**
  44252. * Base Url for the controller model.
  44253. */
  44254. static readonly MODEL_BASE_URL: string;
  44255. /**
  44256. * File name for the controller model.
  44257. */
  44258. static readonly MODEL_FILENAME: string;
  44259. /**
  44260. * Creates a new GenericController from a gamepad
  44261. * @param vrGamepad the gamepad that the controller should be created from
  44262. */
  44263. constructor(vrGamepad: any);
  44264. /**
  44265. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  44266. * @param scene scene in which to add meshes
  44267. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  44268. */
  44269. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  44270. /**
  44271. * Called once for each button that changed state since the last frame
  44272. * @param buttonIdx Which button index changed
  44273. * @param state New state of the button
  44274. * @param changes Which properties on the state changed since last frame
  44275. */
  44276. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  44277. }
  44278. }
  44279. declare module "babylonjs/Gamepads/Controllers/windowsMotionController" {
  44280. import { Observable } from "babylonjs/Misc/observable";
  44281. import { Scene } from "babylonjs/scene";
  44282. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44283. import { Ray } from "babylonjs/Culling/ray";
  44284. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  44285. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  44286. import { StickValues, GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  44287. /**
  44288. * Defines the WindowsMotionController object that the state of the windows motion controller
  44289. */
  44290. export class WindowsMotionController extends WebVRController {
  44291. /**
  44292. * The base url used to load the left and right controller models
  44293. */
  44294. static MODEL_BASE_URL: string;
  44295. /**
  44296. * The name of the left controller model file
  44297. */
  44298. static MODEL_LEFT_FILENAME: string;
  44299. /**
  44300. * The name of the right controller model file
  44301. */
  44302. static MODEL_RIGHT_FILENAME: string;
  44303. /**
  44304. * The controller name prefix for this controller type
  44305. */
  44306. static readonly GAMEPAD_ID_PREFIX: string;
  44307. /**
  44308. * The controller id pattern for this controller type
  44309. */
  44310. private static readonly GAMEPAD_ID_PATTERN;
  44311. private _loadedMeshInfo;
  44312. private readonly _mapping;
  44313. /**
  44314. * Fired when the trackpad on this controller is clicked
  44315. */
  44316. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  44317. /**
  44318. * Fired when the trackpad on this controller is modified
  44319. */
  44320. onTrackpadValuesChangedObservable: Observable<StickValues>;
  44321. /**
  44322. * The current x and y values of this controller's trackpad
  44323. */
  44324. trackpad: StickValues;
  44325. /**
  44326. * Creates a new WindowsMotionController from a gamepad
  44327. * @param vrGamepad the gamepad that the controller should be created from
  44328. */
  44329. constructor(vrGamepad: any);
  44330. /**
  44331. * Fired when the trigger on this controller is modified
  44332. */
  44333. readonly onTriggerButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  44334. /**
  44335. * Fired when the menu button on this controller is modified
  44336. */
  44337. readonly onMenuButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  44338. /**
  44339. * Fired when the grip button on this controller is modified
  44340. */
  44341. readonly onGripButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  44342. /**
  44343. * Fired when the thumbstick button on this controller is modified
  44344. */
  44345. readonly onThumbstickButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  44346. /**
  44347. * Fired when the touchpad button on this controller is modified
  44348. */
  44349. readonly onTouchpadButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  44350. /**
  44351. * Fired when the touchpad values on this controller are modified
  44352. */
  44353. readonly onTouchpadValuesChangedObservable: Observable<StickValues>;
  44354. private _updateTrackpad;
  44355. /**
  44356. * Called once per frame by the engine.
  44357. */
  44358. update(): void;
  44359. /**
  44360. * Called once for each button that changed state since the last frame
  44361. * @param buttonIdx Which button index changed
  44362. * @param state New state of the button
  44363. * @param changes Which properties on the state changed since last frame
  44364. */
  44365. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  44366. /**
  44367. * Moves the buttons on the controller mesh based on their current state
  44368. * @param buttonName the name of the button to move
  44369. * @param buttonValue the value of the button which determines the buttons new position
  44370. */
  44371. protected _lerpButtonTransform(buttonName: string, buttonValue: number): void;
  44372. /**
  44373. * Moves the axis on the controller mesh based on its current state
  44374. * @param axis the index of the axis
  44375. * @param axisValue the value of the axis which determines the meshes new position
  44376. * @hidden
  44377. */
  44378. protected _lerpAxisTransform(axis: number, axisValue: number): void;
  44379. /**
  44380. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  44381. * @param scene scene in which to add meshes
  44382. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  44383. */
  44384. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void, forceDefault?: boolean): void;
  44385. /**
  44386. * Takes a list of meshes (as loaded from the glTF file) and finds the root node, as well as nodes that
  44387. * can be transformed by button presses and axes values, based on this._mapping.
  44388. *
  44389. * @param scene scene in which the meshes exist
  44390. * @param meshes list of meshes that make up the controller model to process
  44391. * @return structured view of the given meshes, with mapping of buttons and axes to meshes that can be transformed.
  44392. */
  44393. private processModel;
  44394. private createMeshInfo;
  44395. /**
  44396. * Gets the ray of the controller in the direction the controller is pointing
  44397. * @param length the length the resulting ray should be
  44398. * @returns a ray in the direction the controller is pointing
  44399. */
  44400. getForwardRay(length?: number): Ray;
  44401. /**
  44402. * Disposes of the controller
  44403. */
  44404. dispose(): void;
  44405. }
  44406. }
  44407. declare module "babylonjs/Gamepads/Controllers/oculusTouchController" {
  44408. import { Observable } from "babylonjs/Misc/observable";
  44409. import { Scene } from "babylonjs/scene";
  44410. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44411. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  44412. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  44413. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  44414. /**
  44415. * Oculus Touch Controller
  44416. */
  44417. export class OculusTouchController extends WebVRController {
  44418. /**
  44419. * Base Url for the controller model.
  44420. */
  44421. static MODEL_BASE_URL: string;
  44422. /**
  44423. * File name for the left controller model.
  44424. */
  44425. static MODEL_LEFT_FILENAME: string;
  44426. /**
  44427. * File name for the right controller model.
  44428. */
  44429. static MODEL_RIGHT_FILENAME: string;
  44430. /**
  44431. * Base Url for the Quest controller model.
  44432. */
  44433. static QUEST_MODEL_BASE_URL: string;
  44434. /**
  44435. * @hidden
  44436. * If the controllers are running on a device that needs the updated Quest controller models
  44437. */
  44438. static _IsQuest: boolean;
  44439. /**
  44440. * Fired when the secondary trigger on this controller is modified
  44441. */
  44442. onSecondaryTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  44443. /**
  44444. * Fired when the thumb rest on this controller is modified
  44445. */
  44446. onThumbRestChangedObservable: Observable<ExtendedGamepadButton>;
  44447. /**
  44448. * Creates a new OculusTouchController from a gamepad
  44449. * @param vrGamepad the gamepad that the controller should be created from
  44450. */
  44451. constructor(vrGamepad: any);
  44452. /**
  44453. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  44454. * @param scene scene in which to add meshes
  44455. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  44456. */
  44457. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  44458. /**
  44459. * Fired when the A button on this controller is modified
  44460. */
  44461. readonly onAButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  44462. /**
  44463. * Fired when the B button on this controller is modified
  44464. */
  44465. readonly onBButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  44466. /**
  44467. * Fired when the X button on this controller is modified
  44468. */
  44469. readonly onXButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  44470. /**
  44471. * Fired when the Y button on this controller is modified
  44472. */
  44473. readonly onYButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  44474. /**
  44475. * Called once for each button that changed state since the last frame
  44476. * 0) thumb stick (touch, press, value = pressed (0,1)). value is in this.leftStick
  44477. * 1) index trigger (touch (?), press (only when value > 0.1), value 0 to 1)
  44478. * 2) secondary trigger (same)
  44479. * 3) A (right) X (left), touch, pressed = value
  44480. * 4) B / Y
  44481. * 5) thumb rest
  44482. * @param buttonIdx Which button index changed
  44483. * @param state New state of the button
  44484. * @param changes Which properties on the state changed since last frame
  44485. */
  44486. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  44487. }
  44488. }
  44489. declare module "babylonjs/Gamepads/Controllers/viveController" {
  44490. import { Scene } from "babylonjs/scene";
  44491. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44492. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  44493. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  44494. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  44495. import { Observable } from "babylonjs/Misc/observable";
  44496. /**
  44497. * Vive Controller
  44498. */
  44499. export class ViveController extends WebVRController {
  44500. /**
  44501. * Base Url for the controller model.
  44502. */
  44503. static MODEL_BASE_URL: string;
  44504. /**
  44505. * File name for the controller model.
  44506. */
  44507. static MODEL_FILENAME: string;
  44508. /**
  44509. * Creates a new ViveController from a gamepad
  44510. * @param vrGamepad the gamepad that the controller should be created from
  44511. */
  44512. constructor(vrGamepad: any);
  44513. /**
  44514. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  44515. * @param scene scene in which to add meshes
  44516. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  44517. */
  44518. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  44519. /**
  44520. * Fired when the left button on this controller is modified
  44521. */
  44522. readonly onLeftButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  44523. /**
  44524. * Fired when the right button on this controller is modified
  44525. */
  44526. readonly onRightButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  44527. /**
  44528. * Fired when the menu button on this controller is modified
  44529. */
  44530. readonly onMenuButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  44531. /**
  44532. * Called once for each button that changed state since the last frame
  44533. * Vive mapping:
  44534. * 0: touchpad
  44535. * 1: trigger
  44536. * 2: left AND right buttons
  44537. * 3: menu button
  44538. * @param buttonIdx Which button index changed
  44539. * @param state New state of the button
  44540. * @param changes Which properties on the state changed since last frame
  44541. */
  44542. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  44543. }
  44544. }
  44545. declare module "babylonjs/Cameras/XR/webXRControllerModelLoader" {
  44546. import { WebXRInput } from "babylonjs/Cameras/XR/webXRInput";
  44547. /**
  44548. * Loads a controller model and adds it as a child of the WebXRControllers grip when the controller is created
  44549. */
  44550. export class WebXRControllerModelLoader {
  44551. /**
  44552. * Creates the WebXRControllerModelLoader
  44553. * @param input xr input that creates the controllers
  44554. */
  44555. constructor(input: WebXRInput);
  44556. }
  44557. }
  44558. declare module "babylonjs/Cameras/XR/webXRDefaultExperience" {
  44559. import { WebXRExperienceHelper } from "babylonjs/Cameras/XR/webXRExperienceHelper";
  44560. import { Scene } from "babylonjs/scene";
  44561. import { WebXRInput } from "babylonjs/Cameras/XR/webXRInput";
  44562. import { WebXRControllerModelLoader } from "babylonjs/Cameras/XR/webXRControllerModelLoader";
  44563. import { WebXRControllerPointerSelection } from "babylonjs/Cameras/XR/webXRControllerPointerSelection";
  44564. import { WebXRControllerTeleportation } from "babylonjs/Cameras/XR/webXRControllerTeleportation";
  44565. import { WebXRRenderTarget } from "babylonjs/Cameras/XR/webXRTypes";
  44566. import { WebXREnterExitUI } from "babylonjs/Cameras/XR/webXREnterExitUI";
  44567. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44568. import { WebXRManagedOutputCanvasOptions } from "babylonjs/Cameras/XR/webXRManagedOutputCanvas";
  44569. /**
  44570. * Options for the default xr helper
  44571. */
  44572. export class WebXRDefaultExperienceOptions {
  44573. /**
  44574. * Floor meshes that should be used for teleporting
  44575. */
  44576. floorMeshes: Array<AbstractMesh>;
  44577. /**
  44578. * Enable or disable default UI to enter XR
  44579. */
  44580. disableDefaultUI: boolean;
  44581. /**
  44582. * optional configuration for the output canvas
  44583. */
  44584. outputCanvasOptions?: WebXRManagedOutputCanvasOptions;
  44585. }
  44586. /**
  44587. * Default experience which provides a similar setup to the previous webVRExperience
  44588. */
  44589. export class WebXRDefaultExperience {
  44590. /**
  44591. * Base experience
  44592. */
  44593. baseExperience: WebXRExperienceHelper;
  44594. /**
  44595. * Input experience extension
  44596. */
  44597. input: WebXRInput;
  44598. /**
  44599. * Loads the controller models
  44600. */
  44601. controllerModelLoader: WebXRControllerModelLoader;
  44602. /**
  44603. * Enables laser pointer and selection
  44604. */
  44605. pointerSelection: WebXRControllerPointerSelection;
  44606. /**
  44607. * Enables teleportation
  44608. */
  44609. teleportation: WebXRControllerTeleportation;
  44610. /**
  44611. * Enables ui for enetering/exiting xr
  44612. */
  44613. enterExitUI: WebXREnterExitUI;
  44614. /**
  44615. * Default target xr should render to
  44616. */
  44617. renderTarget: WebXRRenderTarget;
  44618. /**
  44619. * Creates the default xr experience
  44620. * @param scene scene
  44621. * @param options options for basic configuration
  44622. * @returns resulting WebXRDefaultExperience
  44623. */
  44624. static CreateAsync(scene: Scene, options: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  44625. private constructor();
  44626. /**
  44627. * DIsposes of the experience helper
  44628. */
  44629. dispose(): void;
  44630. }
  44631. }
  44632. declare module "babylonjs/Cameras/XR/index" {
  44633. export * from "babylonjs/Cameras/XR/webXRCamera";
  44634. export * from "babylonjs/Cameras/XR/webXREnterExitUI";
  44635. export * from "babylonjs/Cameras/XR/webXRExperienceHelper";
  44636. export * from "babylonjs/Cameras/XR/webXRInput";
  44637. export * from "babylonjs/Cameras/XR/webXRControllerTeleportation";
  44638. export * from "babylonjs/Cameras/XR/webXRControllerPointerSelection";
  44639. export * from "babylonjs/Cameras/XR/webXRControllerModelLoader";
  44640. export * from "babylonjs/Cameras/XR/webXRController";
  44641. export * from "babylonjs/Cameras/XR/webXRManagedOutputCanvas";
  44642. export * from "babylonjs/Cameras/XR/webXRTypes";
  44643. export * from "babylonjs/Cameras/XR/webXRSessionManager";
  44644. export * from "babylonjs/Cameras/XR/webXRDefaultExperience";
  44645. }
  44646. declare module "babylonjs/Cameras/RigModes/index" {
  44647. export * from "babylonjs/Cameras/RigModes/stereoscopicAnaglyphRigMode";
  44648. export * from "babylonjs/Cameras/RigModes/stereoscopicRigMode";
  44649. export * from "babylonjs/Cameras/RigModes/vrRigMode";
  44650. export * from "babylonjs/Cameras/RigModes/webVRRigMode";
  44651. }
  44652. declare module "babylonjs/Cameras/index" {
  44653. export * from "babylonjs/Cameras/Inputs/index";
  44654. export * from "babylonjs/Cameras/cameraInputsManager";
  44655. export * from "babylonjs/Cameras/camera";
  44656. export * from "babylonjs/Cameras/targetCamera";
  44657. export * from "babylonjs/Cameras/freeCamera";
  44658. export * from "babylonjs/Cameras/freeCameraInputsManager";
  44659. export * from "babylonjs/Cameras/touchCamera";
  44660. export * from "babylonjs/Cameras/arcRotateCamera";
  44661. export * from "babylonjs/Cameras/arcRotateCameraInputsManager";
  44662. export * from "babylonjs/Cameras/deviceOrientationCamera";
  44663. export * from "babylonjs/Cameras/flyCamera";
  44664. export * from "babylonjs/Cameras/flyCameraInputsManager";
  44665. export * from "babylonjs/Cameras/followCamera";
  44666. export * from "babylonjs/Cameras/followCameraInputsManager";
  44667. export * from "babylonjs/Cameras/gamepadCamera";
  44668. export * from "babylonjs/Cameras/Stereoscopic/index";
  44669. export * from "babylonjs/Cameras/universalCamera";
  44670. export * from "babylonjs/Cameras/virtualJoysticksCamera";
  44671. export * from "babylonjs/Cameras/VR/index";
  44672. export * from "babylonjs/Cameras/XR/index";
  44673. export * from "babylonjs/Cameras/RigModes/index";
  44674. }
  44675. declare module "babylonjs/Collisions/index" {
  44676. export * from "babylonjs/Collisions/collider";
  44677. export * from "babylonjs/Collisions/collisionCoordinator";
  44678. export * from "babylonjs/Collisions/pickingInfo";
  44679. export * from "babylonjs/Collisions/intersectionInfo";
  44680. export * from "babylonjs/Collisions/meshCollisionData";
  44681. }
  44682. declare module "babylonjs/Culling/Octrees/octreeBlock" {
  44683. import { SmartArrayNoDuplicate } from "babylonjs/Misc/smartArray";
  44684. import { Vector3 } from "babylonjs/Maths/math.vector";
  44685. import { Ray } from "babylonjs/Culling/ray";
  44686. import { Plane } from "babylonjs/Maths/math.plane";
  44687. /**
  44688. * Contains an array of blocks representing the octree
  44689. */
  44690. export interface IOctreeContainer<T> {
  44691. /**
  44692. * Blocks within the octree
  44693. */
  44694. blocks: Array<OctreeBlock<T>>;
  44695. }
  44696. /**
  44697. * Class used to store a cell in an octree
  44698. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  44699. */
  44700. export class OctreeBlock<T> {
  44701. /**
  44702. * Gets the content of the current block
  44703. */
  44704. entries: T[];
  44705. /**
  44706. * Gets the list of block children
  44707. */
  44708. blocks: Array<OctreeBlock<T>>;
  44709. private _depth;
  44710. private _maxDepth;
  44711. private _capacity;
  44712. private _minPoint;
  44713. private _maxPoint;
  44714. private _boundingVectors;
  44715. private _creationFunc;
  44716. /**
  44717. * Creates a new block
  44718. * @param minPoint defines the minimum vector (in world space) of the block's bounding box
  44719. * @param maxPoint defines the maximum vector (in world space) of the block's bounding box
  44720. * @param capacity defines the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  44721. * @param depth defines the current depth of this block in the octree
  44722. * @param maxDepth defines the maximal depth allowed (beyond this value, the capacity is ignored)
  44723. * @param creationFunc defines a callback to call when an element is added to the block
  44724. */
  44725. constructor(minPoint: Vector3, maxPoint: Vector3, capacity: number, depth: number, maxDepth: number, creationFunc: (entry: T, block: OctreeBlock<T>) => void);
  44726. /**
  44727. * Gets the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  44728. */
  44729. readonly capacity: number;
  44730. /**
  44731. * Gets the minimum vector (in world space) of the block's bounding box
  44732. */
  44733. readonly minPoint: Vector3;
  44734. /**
  44735. * Gets the maximum vector (in world space) of the block's bounding box
  44736. */
  44737. readonly maxPoint: Vector3;
  44738. /**
  44739. * Add a new element to this block
  44740. * @param entry defines the element to add
  44741. */
  44742. addEntry(entry: T): void;
  44743. /**
  44744. * Remove an element from this block
  44745. * @param entry defines the element to remove
  44746. */
  44747. removeEntry(entry: T): void;
  44748. /**
  44749. * Add an array of elements to this block
  44750. * @param entries defines the array of elements to add
  44751. */
  44752. addEntries(entries: T[]): void;
  44753. /**
  44754. * Test if the current block intersects the furstum planes and if yes, then add its content to the selection array
  44755. * @param frustumPlanes defines the frustum planes to test
  44756. * @param selection defines the array to store current content if selection is positive
  44757. * @param allowDuplicate defines if the selection array can contains duplicated entries
  44758. */
  44759. select(frustumPlanes: Plane[], selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  44760. /**
  44761. * Test if the current block intersect with the given bounding sphere and if yes, then add its content to the selection array
  44762. * @param sphereCenter defines the bounding sphere center
  44763. * @param sphereRadius defines the bounding sphere radius
  44764. * @param selection defines the array to store current content if selection is positive
  44765. * @param allowDuplicate defines if the selection array can contains duplicated entries
  44766. */
  44767. intersects(sphereCenter: Vector3, sphereRadius: number, selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  44768. /**
  44769. * Test if the current block intersect with the given ray and if yes, then add its content to the selection array
  44770. * @param ray defines the ray to test with
  44771. * @param selection defines the array to store current content if selection is positive
  44772. */
  44773. intersectsRay(ray: Ray, selection: SmartArrayNoDuplicate<T>): void;
  44774. /**
  44775. * Subdivide the content into child blocks (this block will then be empty)
  44776. */
  44777. createInnerBlocks(): void;
  44778. /**
  44779. * @hidden
  44780. */
  44781. 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;
  44782. }
  44783. }
  44784. declare module "babylonjs/Culling/Octrees/octree" {
  44785. import { SmartArray } from "babylonjs/Misc/smartArray";
  44786. import { Vector3 } from "babylonjs/Maths/math.vector";
  44787. import { SubMesh } from "babylonjs/Meshes/subMesh";
  44788. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44789. import { Ray } from "babylonjs/Culling/ray";
  44790. import { OctreeBlock } from "babylonjs/Culling/Octrees/octreeBlock";
  44791. import { Plane } from "babylonjs/Maths/math.plane";
  44792. /**
  44793. * Octrees are a really powerful data structure that can quickly select entities based on space coordinates.
  44794. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  44795. */
  44796. export class Octree<T> {
  44797. /** 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.) */
  44798. maxDepth: number;
  44799. /**
  44800. * Blocks within the octree containing objects
  44801. */
  44802. blocks: Array<OctreeBlock<T>>;
  44803. /**
  44804. * Content stored in the octree
  44805. */
  44806. dynamicContent: T[];
  44807. private _maxBlockCapacity;
  44808. private _selectionContent;
  44809. private _creationFunc;
  44810. /**
  44811. * Creates a octree
  44812. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  44813. * @param creationFunc function to be used to instatiate the octree
  44814. * @param maxBlockCapacity defines the maximum number of meshes you want on your octree's leaves (default: 64)
  44815. * @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.)
  44816. */
  44817. constructor(creationFunc: (entry: T, block: OctreeBlock<T>) => void, maxBlockCapacity?: number,
  44818. /** 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.) */
  44819. maxDepth?: number);
  44820. /**
  44821. * Updates the octree by adding blocks for the passed in meshes within the min and max world parameters
  44822. * @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);
  44823. * @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);
  44824. * @param entries meshes to be added to the octree blocks
  44825. */
  44826. update(worldMin: Vector3, worldMax: Vector3, entries: T[]): void;
  44827. /**
  44828. * Adds a mesh to the octree
  44829. * @param entry Mesh to add to the octree
  44830. */
  44831. addMesh(entry: T): void;
  44832. /**
  44833. * Remove an element from the octree
  44834. * @param entry defines the element to remove
  44835. */
  44836. removeMesh(entry: T): void;
  44837. /**
  44838. * Selects an array of meshes within the frustum
  44839. * @param frustumPlanes The frustum planes to use which will select all meshes within it
  44840. * @param allowDuplicate If duplicate objects are allowed in the resulting object array
  44841. * @returns array of meshes within the frustum
  44842. */
  44843. select(frustumPlanes: Plane[], allowDuplicate?: boolean): SmartArray<T>;
  44844. /**
  44845. * Test if the octree intersect with the given bounding sphere and if yes, then add its content to the selection array
  44846. * @param sphereCenter defines the bounding sphere center
  44847. * @param sphereRadius defines the bounding sphere radius
  44848. * @param allowDuplicate defines if the selection array can contains duplicated entries
  44849. * @returns an array of objects that intersect the sphere
  44850. */
  44851. intersects(sphereCenter: Vector3, sphereRadius: number, allowDuplicate?: boolean): SmartArray<T>;
  44852. /**
  44853. * Test if the octree intersect with the given ray and if yes, then add its content to resulting array
  44854. * @param ray defines the ray to test with
  44855. * @returns array of intersected objects
  44856. */
  44857. intersectsRay(ray: Ray): SmartArray<T>;
  44858. /**
  44859. * Adds a mesh into the octree block if it intersects the block
  44860. */
  44861. static CreationFuncForMeshes: (entry: AbstractMesh, block: OctreeBlock<AbstractMesh>) => void;
  44862. /**
  44863. * Adds a submesh into the octree block if it intersects the block
  44864. */
  44865. static CreationFuncForSubMeshes: (entry: SubMesh, block: OctreeBlock<SubMesh>) => void;
  44866. }
  44867. }
  44868. declare module "babylonjs/Culling/Octrees/octreeSceneComponent" {
  44869. import { ISmartArrayLike } from "babylonjs/Misc/smartArray";
  44870. import { Scene } from "babylonjs/scene";
  44871. import { SubMesh } from "babylonjs/Meshes/subMesh";
  44872. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44873. import { Ray } from "babylonjs/Culling/ray";
  44874. import { Octree } from "babylonjs/Culling/Octrees/octree";
  44875. import { Collider } from "babylonjs/Collisions/collider";
  44876. module "babylonjs/scene" {
  44877. interface Scene {
  44878. /**
  44879. * @hidden
  44880. * Backing Filed
  44881. */
  44882. _selectionOctree: Octree<AbstractMesh>;
  44883. /**
  44884. * Gets the octree used to boost mesh selection (picking)
  44885. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  44886. */
  44887. selectionOctree: Octree<AbstractMesh>;
  44888. /**
  44889. * Creates or updates the octree used to boost selection (picking)
  44890. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  44891. * @param maxCapacity defines the maximum capacity per leaf
  44892. * @param maxDepth defines the maximum depth of the octree
  44893. * @returns an octree of AbstractMesh
  44894. */
  44895. createOrUpdateSelectionOctree(maxCapacity?: number, maxDepth?: number): Octree<AbstractMesh>;
  44896. }
  44897. }
  44898. module "babylonjs/Meshes/abstractMesh" {
  44899. interface AbstractMesh {
  44900. /**
  44901. * @hidden
  44902. * Backing Field
  44903. */
  44904. _submeshesOctree: Octree<SubMesh>;
  44905. /**
  44906. * This function will create an octree to help to select the right submeshes for rendering, picking and collision computations.
  44907. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  44908. * @param maxCapacity defines the maximum size of each block (64 by default)
  44909. * @param maxDepth defines the maximum depth to use (no more than 2 levels by default)
  44910. * @returns the new octree
  44911. * @see https://www.babylonjs-playground.com/#NA4OQ#12
  44912. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  44913. */
  44914. createOrUpdateSubmeshesOctree(maxCapacity?: number, maxDepth?: number): Octree<SubMesh>;
  44915. }
  44916. }
  44917. /**
  44918. * Defines the octree scene component responsible to manage any octrees
  44919. * in a given scene.
  44920. */
  44921. export class OctreeSceneComponent {
  44922. /**
  44923. * The component name help to identify the component in the list of scene components.
  44924. */
  44925. readonly name: string;
  44926. /**
  44927. * The scene the component belongs to.
  44928. */
  44929. scene: Scene;
  44930. /**
  44931. * Indicates if the meshes have been checked to make sure they are isEnabled()
  44932. */
  44933. readonly checksIsEnabled: boolean;
  44934. /**
  44935. * Creates a new instance of the component for the given scene
  44936. * @param scene Defines the scene to register the component in
  44937. */
  44938. constructor(scene: Scene);
  44939. /**
  44940. * Registers the component in a given scene
  44941. */
  44942. register(): void;
  44943. /**
  44944. * Return the list of active meshes
  44945. * @returns the list of active meshes
  44946. */
  44947. getActiveMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  44948. /**
  44949. * Return the list of active sub meshes
  44950. * @param mesh The mesh to get the candidates sub meshes from
  44951. * @returns the list of active sub meshes
  44952. */
  44953. getActiveSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  44954. private _tempRay;
  44955. /**
  44956. * Return the list of sub meshes intersecting with a given local ray
  44957. * @param mesh defines the mesh to find the submesh for
  44958. * @param localRay defines the ray in local space
  44959. * @returns the list of intersecting sub meshes
  44960. */
  44961. getIntersectingSubMeshCandidates(mesh: AbstractMesh, localRay: Ray): ISmartArrayLike<SubMesh>;
  44962. /**
  44963. * Return the list of sub meshes colliding with a collider
  44964. * @param mesh defines the mesh to find the submesh for
  44965. * @param collider defines the collider to evaluate the collision against
  44966. * @returns the list of colliding sub meshes
  44967. */
  44968. getCollidingSubMeshCandidates(mesh: AbstractMesh, collider: Collider): ISmartArrayLike<SubMesh>;
  44969. /**
  44970. * Rebuilds the elements related to this component in case of
  44971. * context lost for instance.
  44972. */
  44973. rebuild(): void;
  44974. /**
  44975. * Disposes the component and the associated ressources.
  44976. */
  44977. dispose(): void;
  44978. }
  44979. }
  44980. declare module "babylonjs/Culling/Octrees/index" {
  44981. export * from "babylonjs/Culling/Octrees/octree";
  44982. export * from "babylonjs/Culling/Octrees/octreeBlock";
  44983. export * from "babylonjs/Culling/Octrees/octreeSceneComponent";
  44984. }
  44985. declare module "babylonjs/Culling/index" {
  44986. export * from "babylonjs/Culling/boundingBox";
  44987. export * from "babylonjs/Culling/boundingInfo";
  44988. export * from "babylonjs/Culling/boundingSphere";
  44989. export * from "babylonjs/Culling/Octrees/index";
  44990. export * from "babylonjs/Culling/ray";
  44991. }
  44992. declare module "babylonjs/Rendering/utilityLayerRenderer" {
  44993. import { IDisposable, Scene } from "babylonjs/scene";
  44994. import { Nullable } from "babylonjs/types";
  44995. import { Observable } from "babylonjs/Misc/observable";
  44996. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  44997. import { HemisphericLight } from "babylonjs/Lights/hemisphericLight";
  44998. import { Camera } from "babylonjs/Cameras/camera";
  44999. /**
  45000. * Renders a layer on top of an existing scene
  45001. */
  45002. export class UtilityLayerRenderer implements IDisposable {
  45003. /** the original scene that will be rendered on top of */
  45004. originalScene: Scene;
  45005. private _pointerCaptures;
  45006. private _lastPointerEvents;
  45007. private static _DefaultUtilityLayer;
  45008. private static _DefaultKeepDepthUtilityLayer;
  45009. private _sharedGizmoLight;
  45010. private _renderCamera;
  45011. /**
  45012. * Gets the camera that is used to render the utility layer (when not set, this will be the last active camera)
  45013. * @returns the camera that is used when rendering the utility layer
  45014. */
  45015. getRenderCamera(): Nullable<Camera>;
  45016. /**
  45017. * Sets the camera that should be used when rendering the utility layer (If set to null the last active camera will be used)
  45018. * @param cam the camera that should be used when rendering the utility layer
  45019. */
  45020. setRenderCamera(cam: Nullable<Camera>): void;
  45021. /**
  45022. * @hidden
  45023. * Light which used by gizmos to get light shading
  45024. */
  45025. _getSharedGizmoLight(): HemisphericLight;
  45026. /**
  45027. * If the picking should be done on the utility layer prior to the actual scene (Default: true)
  45028. */
  45029. pickUtilitySceneFirst: boolean;
  45030. /**
  45031. * 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)
  45032. */
  45033. static readonly DefaultUtilityLayer: UtilityLayerRenderer;
  45034. /**
  45035. * 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)
  45036. */
  45037. static readonly DefaultKeepDepthUtilityLayer: UtilityLayerRenderer;
  45038. /**
  45039. * The scene that is rendered on top of the original scene
  45040. */
  45041. utilityLayerScene: Scene;
  45042. /**
  45043. * If the utility layer should automatically be rendered on top of existing scene
  45044. */
  45045. shouldRender: boolean;
  45046. /**
  45047. * If set to true, only pointer down onPointerObservable events will be blocked when picking is occluded by original scene
  45048. */
  45049. onlyCheckPointerDownEvents: boolean;
  45050. /**
  45051. * If set to false, only pointerUp, pointerDown and pointerMove will be sent to the utilityLayerScene (false by default)
  45052. */
  45053. processAllEvents: boolean;
  45054. /**
  45055. * Observable raised when the pointer move from the utility layer scene to the main scene
  45056. */
  45057. onPointerOutObservable: Observable<number>;
  45058. /** Gets or sets a predicate that will be used to indicate utility meshes present in the main scene */
  45059. mainSceneTrackerPredicate: (mesh: Nullable<AbstractMesh>) => boolean;
  45060. private _afterRenderObserver;
  45061. private _sceneDisposeObserver;
  45062. private _originalPointerObserver;
  45063. /**
  45064. * Instantiates a UtilityLayerRenderer
  45065. * @param originalScene the original scene that will be rendered on top of
  45066. * @param handleEvents boolean indicating if the utility layer should handle events
  45067. */
  45068. constructor(
  45069. /** the original scene that will be rendered on top of */
  45070. originalScene: Scene, handleEvents?: boolean);
  45071. private _notifyObservers;
  45072. /**
  45073. * Renders the utility layers scene on top of the original scene
  45074. */
  45075. render(): void;
  45076. /**
  45077. * Disposes of the renderer
  45078. */
  45079. dispose(): void;
  45080. private _updateCamera;
  45081. }
  45082. }
  45083. declare module "babylonjs/Gizmos/gizmo" {
  45084. import { Nullable } from "babylonjs/types";
  45085. import { IDisposable } from "babylonjs/scene";
  45086. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45087. import { Mesh } from "babylonjs/Meshes/mesh";
  45088. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  45089. /**
  45090. * Renders gizmos on top of an existing scene which provide controls for position, rotation, etc.
  45091. */
  45092. export class Gizmo implements IDisposable {
  45093. /** The utility layer the gizmo will be added to */
  45094. gizmoLayer: UtilityLayerRenderer;
  45095. /**
  45096. * The root mesh of the gizmo
  45097. */
  45098. _rootMesh: Mesh;
  45099. private _attachedMesh;
  45100. /**
  45101. * Ratio for the scale of the gizmo (Default: 1)
  45102. */
  45103. scaleRatio: number;
  45104. /**
  45105. * If a custom mesh has been set (Default: false)
  45106. */
  45107. protected _customMeshSet: boolean;
  45108. /**
  45109. * Mesh that the gizmo will be attached to. (eg. on a drag gizmo the mesh that will be dragged)
  45110. * * When set, interactions will be enabled
  45111. */
  45112. attachedMesh: Nullable<AbstractMesh>;
  45113. /**
  45114. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  45115. * @param mesh The mesh to replace the default mesh of the gizmo
  45116. */
  45117. setCustomMesh(mesh: Mesh): void;
  45118. /**
  45119. * If set the gizmo's rotation will be updated to match the attached mesh each frame (Default: true)
  45120. */
  45121. updateGizmoRotationToMatchAttachedMesh: boolean;
  45122. /**
  45123. * If set the gizmo's position will be updated to match the attached mesh each frame (Default: true)
  45124. */
  45125. updateGizmoPositionToMatchAttachedMesh: boolean;
  45126. /**
  45127. * When set, the gizmo will always appear the same size no matter where the camera is (default: true)
  45128. */
  45129. updateScale: boolean;
  45130. protected _interactionsEnabled: boolean;
  45131. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  45132. private _beforeRenderObserver;
  45133. private _tempVector;
  45134. /**
  45135. * Creates a gizmo
  45136. * @param gizmoLayer The utility layer the gizmo will be added to
  45137. */
  45138. constructor(
  45139. /** The utility layer the gizmo will be added to */
  45140. gizmoLayer?: UtilityLayerRenderer);
  45141. /**
  45142. * Updates the gizmo to match the attached mesh's position/rotation
  45143. */
  45144. protected _update(): void;
  45145. /**
  45146. * Disposes of the gizmo
  45147. */
  45148. dispose(): void;
  45149. }
  45150. }
  45151. declare module "babylonjs/Gizmos/planeDragGizmo" {
  45152. import { Observable } from "babylonjs/Misc/observable";
  45153. import { Nullable } from "babylonjs/types";
  45154. import { Vector3 } from "babylonjs/Maths/math.vector";
  45155. import { Color3 } from "babylonjs/Maths/math.color";
  45156. import { TransformNode } from "babylonjs/Meshes/transformNode";
  45157. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45158. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  45159. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  45160. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  45161. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  45162. import { Scene } from "babylonjs/scene";
  45163. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  45164. /**
  45165. * Single plane drag gizmo
  45166. */
  45167. export class PlaneDragGizmo extends Gizmo {
  45168. /**
  45169. * Drag behavior responsible for the gizmos dragging interactions
  45170. */
  45171. dragBehavior: PointerDragBehavior;
  45172. private _pointerObserver;
  45173. /**
  45174. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  45175. */
  45176. snapDistance: number;
  45177. /**
  45178. * Event that fires each time the gizmo snaps to a new location.
  45179. * * snapDistance is the the change in distance
  45180. */
  45181. onSnapObservable: Observable<{
  45182. snapDistance: number;
  45183. }>;
  45184. private _plane;
  45185. private _coloredMaterial;
  45186. private _hoverMaterial;
  45187. private _isEnabled;
  45188. private _parent;
  45189. /** @hidden */
  45190. static _CreatePlane(scene: Scene, material: StandardMaterial): TransformNode;
  45191. /** @hidden */
  45192. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  45193. /**
  45194. * Creates a PlaneDragGizmo
  45195. * @param gizmoLayer The utility layer the gizmo will be added to
  45196. * @param dragPlaneNormal The axis normal to which the gizmo will be able to drag on
  45197. * @param color The color of the gizmo
  45198. */
  45199. constructor(dragPlaneNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>);
  45200. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  45201. /**
  45202. * If the gizmo is enabled
  45203. */
  45204. isEnabled: boolean;
  45205. /**
  45206. * Disposes of the gizmo
  45207. */
  45208. dispose(): void;
  45209. }
  45210. }
  45211. declare module "babylonjs/Gizmos/positionGizmo" {
  45212. import { Observable } from "babylonjs/Misc/observable";
  45213. import { Nullable } from "babylonjs/types";
  45214. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45215. import { Mesh } from "babylonjs/Meshes/mesh";
  45216. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  45217. import { AxisDragGizmo } from "babylonjs/Gizmos/axisDragGizmo";
  45218. import { PlaneDragGizmo } from "babylonjs/Gizmos/planeDragGizmo";
  45219. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  45220. /**
  45221. * Gizmo that enables dragging a mesh along 3 axis
  45222. */
  45223. export class PositionGizmo extends Gizmo {
  45224. /**
  45225. * Internal gizmo used for interactions on the x axis
  45226. */
  45227. xGizmo: AxisDragGizmo;
  45228. /**
  45229. * Internal gizmo used for interactions on the y axis
  45230. */
  45231. yGizmo: AxisDragGizmo;
  45232. /**
  45233. * Internal gizmo used for interactions on the z axis
  45234. */
  45235. zGizmo: AxisDragGizmo;
  45236. /**
  45237. * Internal gizmo used for interactions on the yz plane
  45238. */
  45239. xPlaneGizmo: PlaneDragGizmo;
  45240. /**
  45241. * Internal gizmo used for interactions on the xz plane
  45242. */
  45243. yPlaneGizmo: PlaneDragGizmo;
  45244. /**
  45245. * Internal gizmo used for interactions on the xy plane
  45246. */
  45247. zPlaneGizmo: PlaneDragGizmo;
  45248. /**
  45249. * private variables
  45250. */
  45251. private _meshAttached;
  45252. private _updateGizmoRotationToMatchAttachedMesh;
  45253. private _snapDistance;
  45254. private _scaleRatio;
  45255. /** Fires an event when any of it's sub gizmos are dragged */
  45256. onDragStartObservable: Observable<unknown>;
  45257. /** Fires an event when any of it's sub gizmos are released from dragging */
  45258. onDragEndObservable: Observable<unknown>;
  45259. /**
  45260. * If set to true, planar drag is enabled
  45261. */
  45262. private _planarGizmoEnabled;
  45263. attachedMesh: Nullable<AbstractMesh>;
  45264. /**
  45265. * Creates a PositionGizmo
  45266. * @param gizmoLayer The utility layer the gizmo will be added to
  45267. */
  45268. constructor(gizmoLayer?: UtilityLayerRenderer);
  45269. /**
  45270. * If the planar drag gizmo is enabled
  45271. * setting this will enable/disable XY, XZ and YZ planes regardless of individual gizmo settings.
  45272. */
  45273. planarGizmoEnabled: boolean;
  45274. updateGizmoRotationToMatchAttachedMesh: boolean;
  45275. /**
  45276. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  45277. */
  45278. snapDistance: number;
  45279. /**
  45280. * Ratio for the scale of the gizmo (Default: 1)
  45281. */
  45282. scaleRatio: number;
  45283. /**
  45284. * Disposes of the gizmo
  45285. */
  45286. dispose(): void;
  45287. /**
  45288. * CustomMeshes are not supported by this gizmo
  45289. * @param mesh The mesh to replace the default mesh of the gizmo
  45290. */
  45291. setCustomMesh(mesh: Mesh): void;
  45292. }
  45293. }
  45294. declare module "babylonjs/Gizmos/axisDragGizmo" {
  45295. import { Observable } from "babylonjs/Misc/observable";
  45296. import { Nullable } from "babylonjs/types";
  45297. import { Vector3 } from "babylonjs/Maths/math.vector";
  45298. import { TransformNode } from "babylonjs/Meshes/transformNode";
  45299. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45300. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  45301. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  45302. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  45303. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  45304. import { Scene } from "babylonjs/scene";
  45305. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  45306. import { Color3 } from "babylonjs/Maths/math.color";
  45307. /**
  45308. * Single axis drag gizmo
  45309. */
  45310. export class AxisDragGizmo extends Gizmo {
  45311. /**
  45312. * Drag behavior responsible for the gizmos dragging interactions
  45313. */
  45314. dragBehavior: PointerDragBehavior;
  45315. private _pointerObserver;
  45316. /**
  45317. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  45318. */
  45319. snapDistance: number;
  45320. /**
  45321. * Event that fires each time the gizmo snaps to a new location.
  45322. * * snapDistance is the the change in distance
  45323. */
  45324. onSnapObservable: Observable<{
  45325. snapDistance: number;
  45326. }>;
  45327. private _isEnabled;
  45328. private _parent;
  45329. private _arrow;
  45330. private _coloredMaterial;
  45331. private _hoverMaterial;
  45332. /** @hidden */
  45333. static _CreateArrow(scene: Scene, material: StandardMaterial): TransformNode;
  45334. /** @hidden */
  45335. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  45336. /**
  45337. * Creates an AxisDragGizmo
  45338. * @param gizmoLayer The utility layer the gizmo will be added to
  45339. * @param dragAxis The axis which the gizmo will be able to drag on
  45340. * @param color The color of the gizmo
  45341. */
  45342. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>);
  45343. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  45344. /**
  45345. * If the gizmo is enabled
  45346. */
  45347. isEnabled: boolean;
  45348. /**
  45349. * Disposes of the gizmo
  45350. */
  45351. dispose(): void;
  45352. }
  45353. }
  45354. declare module "babylonjs/Debug/axesViewer" {
  45355. import { Vector3 } from "babylonjs/Maths/math.vector";
  45356. import { Nullable } from "babylonjs/types";
  45357. import { Scene } from "babylonjs/scene";
  45358. import { TransformNode } from "babylonjs/Meshes/transformNode";
  45359. /**
  45360. * The Axes viewer will show 3 axes in a specific point in space
  45361. */
  45362. export class AxesViewer {
  45363. private _xAxis;
  45364. private _yAxis;
  45365. private _zAxis;
  45366. private _scaleLinesFactor;
  45367. private _instanced;
  45368. /**
  45369. * Gets the hosting scene
  45370. */
  45371. scene: Scene;
  45372. /**
  45373. * Gets or sets a number used to scale line length
  45374. */
  45375. scaleLines: number;
  45376. /** Gets the node hierarchy used to render x-axis */
  45377. readonly xAxis: TransformNode;
  45378. /** Gets the node hierarchy used to render y-axis */
  45379. readonly yAxis: TransformNode;
  45380. /** Gets the node hierarchy used to render z-axis */
  45381. readonly zAxis: TransformNode;
  45382. /**
  45383. * Creates a new AxesViewer
  45384. * @param scene defines the hosting scene
  45385. * @param scaleLines defines a number used to scale line length (1 by default)
  45386. * @param renderingGroupId defines a number used to set the renderingGroupId of the meshes (2 by default)
  45387. * @param xAxis defines the node hierarchy used to render the x-axis
  45388. * @param yAxis defines the node hierarchy used to render the y-axis
  45389. * @param zAxis defines the node hierarchy used to render the z-axis
  45390. */
  45391. constructor(scene: Scene, scaleLines?: number, renderingGroupId?: Nullable<number>, xAxis?: TransformNode, yAxis?: TransformNode, zAxis?: TransformNode);
  45392. /**
  45393. * Force the viewer to update
  45394. * @param position defines the position of the viewer
  45395. * @param xaxis defines the x axis of the viewer
  45396. * @param yaxis defines the y axis of the viewer
  45397. * @param zaxis defines the z axis of the viewer
  45398. */
  45399. update(position: Vector3, xaxis: Vector3, yaxis: Vector3, zaxis: Vector3): void;
  45400. /**
  45401. * Creates an instance of this axes viewer.
  45402. * @returns a new axes viewer with instanced meshes
  45403. */
  45404. createInstance(): AxesViewer;
  45405. /** Releases resources */
  45406. dispose(): void;
  45407. private static _SetRenderingGroupId;
  45408. }
  45409. }
  45410. declare module "babylonjs/Debug/boneAxesViewer" {
  45411. import { Nullable } from "babylonjs/types";
  45412. import { AxesViewer } from "babylonjs/Debug/axesViewer";
  45413. import { Vector3 } from "babylonjs/Maths/math.vector";
  45414. import { Mesh } from "babylonjs/Meshes/mesh";
  45415. import { Bone } from "babylonjs/Bones/bone";
  45416. import { Scene } from "babylonjs/scene";
  45417. /**
  45418. * The BoneAxesViewer will attach 3 axes to a specific bone of a specific mesh
  45419. * @see demo here: https://www.babylonjs-playground.com/#0DE8F4#8
  45420. */
  45421. export class BoneAxesViewer extends AxesViewer {
  45422. /**
  45423. * Gets or sets the target mesh where to display the axes viewer
  45424. */
  45425. mesh: Nullable<Mesh>;
  45426. /**
  45427. * Gets or sets the target bone where to display the axes viewer
  45428. */
  45429. bone: Nullable<Bone>;
  45430. /** Gets current position */
  45431. pos: Vector3;
  45432. /** Gets direction of X axis */
  45433. xaxis: Vector3;
  45434. /** Gets direction of Y axis */
  45435. yaxis: Vector3;
  45436. /** Gets direction of Z axis */
  45437. zaxis: Vector3;
  45438. /**
  45439. * Creates a new BoneAxesViewer
  45440. * @param scene defines the hosting scene
  45441. * @param bone defines the target bone
  45442. * @param mesh defines the target mesh
  45443. * @param scaleLines defines a scaling factor for line length (1 by default)
  45444. */
  45445. constructor(scene: Scene, bone: Bone, mesh: Mesh, scaleLines?: number);
  45446. /**
  45447. * Force the viewer to update
  45448. */
  45449. update(): void;
  45450. /** Releases resources */
  45451. dispose(): void;
  45452. }
  45453. }
  45454. declare module "babylonjs/Debug/debugLayer" {
  45455. import { Scene } from "babylonjs/scene";
  45456. /**
  45457. * Interface used to define scene explorer extensibility option
  45458. */
  45459. export interface IExplorerExtensibilityOption {
  45460. /**
  45461. * Define the option label
  45462. */
  45463. label: string;
  45464. /**
  45465. * Defines the action to execute on click
  45466. */
  45467. action: (entity: any) => void;
  45468. }
  45469. /**
  45470. * Defines a group of actions associated with a predicate to use when extending the Inspector scene explorer
  45471. */
  45472. export interface IExplorerExtensibilityGroup {
  45473. /**
  45474. * Defines a predicate to test if a given type mut be extended
  45475. */
  45476. predicate: (entity: any) => boolean;
  45477. /**
  45478. * Gets the list of options added to a type
  45479. */
  45480. entries: IExplorerExtensibilityOption[];
  45481. }
  45482. /**
  45483. * Interface used to define the options to use to create the Inspector
  45484. */
  45485. export interface IInspectorOptions {
  45486. /**
  45487. * Display in overlay mode (default: false)
  45488. */
  45489. overlay?: boolean;
  45490. /**
  45491. * HTML element to use as root (the parent of the rendering canvas will be used as default value)
  45492. */
  45493. globalRoot?: HTMLElement;
  45494. /**
  45495. * Display the Scene explorer
  45496. */
  45497. showExplorer?: boolean;
  45498. /**
  45499. * Display the property inspector
  45500. */
  45501. showInspector?: boolean;
  45502. /**
  45503. * Display in embed mode (both panes on the right)
  45504. */
  45505. embedMode?: boolean;
  45506. /**
  45507. * let the Inspector handles resize of the canvas when panes are resized (default to true)
  45508. */
  45509. handleResize?: boolean;
  45510. /**
  45511. * Allow the panes to popup (default: true)
  45512. */
  45513. enablePopup?: boolean;
  45514. /**
  45515. * Allow the panes to be closed by users (default: true)
  45516. */
  45517. enableClose?: boolean;
  45518. /**
  45519. * Optional list of extensibility entries
  45520. */
  45521. explorerExtensibility?: IExplorerExtensibilityGroup[];
  45522. /**
  45523. * Optional URL to get the inspector script from (by default it uses the babylonjs CDN).
  45524. */
  45525. inspectorURL?: string;
  45526. }
  45527. module "babylonjs/scene" {
  45528. interface Scene {
  45529. /**
  45530. * @hidden
  45531. * Backing field
  45532. */
  45533. _debugLayer: DebugLayer;
  45534. /**
  45535. * Gets the debug layer (aka Inspector) associated with the scene
  45536. * @see http://doc.babylonjs.com/features/playground_debuglayer
  45537. */
  45538. debugLayer: DebugLayer;
  45539. }
  45540. }
  45541. /**
  45542. * The debug layer (aka Inspector) is the go to tool in order to better understand
  45543. * what is happening in your scene
  45544. * @see http://doc.babylonjs.com/features/playground_debuglayer
  45545. */
  45546. export class DebugLayer {
  45547. /**
  45548. * Define the url to get the inspector script from.
  45549. * By default it uses the babylonjs CDN.
  45550. * @ignoreNaming
  45551. */
  45552. static InspectorURL: string;
  45553. private _scene;
  45554. private BJSINSPECTOR;
  45555. private _onPropertyChangedObservable?;
  45556. /**
  45557. * Observable triggered when a property is changed through the inspector.
  45558. */
  45559. readonly onPropertyChangedObservable: any;
  45560. /**
  45561. * Instantiates a new debug layer.
  45562. * The debug layer (aka Inspector) is the go to tool in order to better understand
  45563. * what is happening in your scene
  45564. * @see http://doc.babylonjs.com/features/playground_debuglayer
  45565. * @param scene Defines the scene to inspect
  45566. */
  45567. constructor(scene: Scene);
  45568. /** Creates the inspector window. */
  45569. private _createInspector;
  45570. /**
  45571. * Select a specific entity in the scene explorer and highlight a specific block in that entity property grid
  45572. * @param entity defines the entity to select
  45573. * @param lineContainerTitle defines the specific block to highlight
  45574. */
  45575. select(entity: any, lineContainerTitle?: string): void;
  45576. /** Get the inspector from bundle or global */
  45577. private _getGlobalInspector;
  45578. /**
  45579. * Get if the inspector is visible or not.
  45580. * @returns true if visible otherwise, false
  45581. */
  45582. isVisible(): boolean;
  45583. /**
  45584. * Hide the inspector and close its window.
  45585. */
  45586. hide(): void;
  45587. /**
  45588. * Launch the debugLayer.
  45589. * @param config Define the configuration of the inspector
  45590. * @return a promise fulfilled when the debug layer is visible
  45591. */
  45592. show(config?: IInspectorOptions): Promise<DebugLayer>;
  45593. }
  45594. }
  45595. declare module "babylonjs/Meshes/Builders/boxBuilder" {
  45596. import { Nullable } from "babylonjs/types";
  45597. import { Scene } from "babylonjs/scene";
  45598. import { Vector4 } from "babylonjs/Maths/math.vector";
  45599. import { Color4 } from "babylonjs/Maths/math.color";
  45600. import { Mesh } from "babylonjs/Meshes/mesh";
  45601. /**
  45602. * Class containing static functions to help procedurally build meshes
  45603. */
  45604. export class BoxBuilder {
  45605. /**
  45606. * Creates a box mesh
  45607. * * The parameter `size` sets the size (float) of each box side (default 1)
  45608. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  45609. * * 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)
  45610. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  45611. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  45612. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  45613. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  45614. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  45615. * @param name defines the name of the mesh
  45616. * @param options defines the options used to create the mesh
  45617. * @param scene defines the hosting scene
  45618. * @returns the box mesh
  45619. */
  45620. static CreateBox(name: string, options: {
  45621. size?: number;
  45622. width?: number;
  45623. height?: number;
  45624. depth?: number;
  45625. faceUV?: Vector4[];
  45626. faceColors?: Color4[];
  45627. sideOrientation?: number;
  45628. frontUVs?: Vector4;
  45629. backUVs?: Vector4;
  45630. wrap?: boolean;
  45631. topBaseAt?: number;
  45632. bottomBaseAt?: number;
  45633. updatable?: boolean;
  45634. }, scene?: Nullable<Scene>): Mesh;
  45635. }
  45636. }
  45637. declare module "babylonjs/Meshes/Builders/sphereBuilder" {
  45638. import { Vector4 } from "babylonjs/Maths/math.vector";
  45639. import { Mesh } from "babylonjs/Meshes/mesh";
  45640. import { Scene } from "babylonjs/scene";
  45641. import { Nullable } from "babylonjs/types";
  45642. /**
  45643. * Class containing static functions to help procedurally build meshes
  45644. */
  45645. export class SphereBuilder {
  45646. /**
  45647. * Creates a sphere mesh
  45648. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  45649. * * 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`)
  45650. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  45651. * * 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
  45652. * * 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)
  45653. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  45654. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  45655. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  45656. * @param name defines the name of the mesh
  45657. * @param options defines the options used to create the mesh
  45658. * @param scene defines the hosting scene
  45659. * @returns the sphere mesh
  45660. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  45661. */
  45662. static CreateSphere(name: string, options: {
  45663. segments?: number;
  45664. diameter?: number;
  45665. diameterX?: number;
  45666. diameterY?: number;
  45667. diameterZ?: number;
  45668. arc?: number;
  45669. slice?: number;
  45670. sideOrientation?: number;
  45671. frontUVs?: Vector4;
  45672. backUVs?: Vector4;
  45673. updatable?: boolean;
  45674. }, scene?: Nullable<Scene>): Mesh;
  45675. }
  45676. }
  45677. declare module "babylonjs/Debug/physicsViewer" {
  45678. import { Nullable } from "babylonjs/types";
  45679. import { Scene } from "babylonjs/scene";
  45680. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45681. import { Mesh } from "babylonjs/Meshes/mesh";
  45682. import { IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  45683. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  45684. /**
  45685. * Used to show the physics impostor around the specific mesh
  45686. */
  45687. export class PhysicsViewer {
  45688. /** @hidden */
  45689. protected _impostors: Array<Nullable<PhysicsImpostor>>;
  45690. /** @hidden */
  45691. protected _meshes: Array<Nullable<AbstractMesh>>;
  45692. /** @hidden */
  45693. protected _scene: Nullable<Scene>;
  45694. /** @hidden */
  45695. protected _numMeshes: number;
  45696. /** @hidden */
  45697. protected _physicsEnginePlugin: Nullable<IPhysicsEnginePlugin>;
  45698. private _renderFunction;
  45699. private _utilityLayer;
  45700. private _debugBoxMesh;
  45701. private _debugSphereMesh;
  45702. private _debugCylinderMesh;
  45703. private _debugMaterial;
  45704. private _debugMeshMeshes;
  45705. /**
  45706. * Creates a new PhysicsViewer
  45707. * @param scene defines the hosting scene
  45708. */
  45709. constructor(scene: Scene);
  45710. /** @hidden */
  45711. protected _updateDebugMeshes(): void;
  45712. /**
  45713. * Renders a specified physic impostor
  45714. * @param impostor defines the impostor to render
  45715. * @param targetMesh defines the mesh represented by the impostor
  45716. * @returns the new debug mesh used to render the impostor
  45717. */
  45718. showImpostor(impostor: PhysicsImpostor, targetMesh?: Mesh): Nullable<AbstractMesh>;
  45719. /**
  45720. * Hides a specified physic impostor
  45721. * @param impostor defines the impostor to hide
  45722. */
  45723. hideImpostor(impostor: Nullable<PhysicsImpostor>): void;
  45724. private _getDebugMaterial;
  45725. private _getDebugBoxMesh;
  45726. private _getDebugSphereMesh;
  45727. private _getDebugCylinderMesh;
  45728. private _getDebugMeshMesh;
  45729. private _getDebugMesh;
  45730. /** Releases all resources */
  45731. dispose(): void;
  45732. }
  45733. }
  45734. declare module "babylonjs/Meshes/Builders/linesBuilder" {
  45735. import { Vector3 } from "babylonjs/Maths/math.vector";
  45736. import { Color4 } from "babylonjs/Maths/math.color";
  45737. import { Nullable } from "babylonjs/types";
  45738. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  45739. import { Scene } from "babylonjs/scene";
  45740. /**
  45741. * Class containing static functions to help procedurally build meshes
  45742. */
  45743. export class LinesBuilder {
  45744. /**
  45745. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  45746. * * 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
  45747. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  45748. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  45749. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  45750. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  45751. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  45752. * * 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
  45753. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  45754. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  45755. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  45756. * @param name defines the name of the new line system
  45757. * @param options defines the options used to create the line system
  45758. * @param scene defines the hosting scene
  45759. * @returns a new line system mesh
  45760. */
  45761. static CreateLineSystem(name: string, options: {
  45762. lines: Vector3[][];
  45763. updatable?: boolean;
  45764. instance?: Nullable<LinesMesh>;
  45765. colors?: Nullable<Color4[][]>;
  45766. useVertexAlpha?: boolean;
  45767. }, scene: Nullable<Scene>): LinesMesh;
  45768. /**
  45769. * Creates a line mesh
  45770. * 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
  45771. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  45772. * * The parameter `points` is an array successive Vector3
  45773. * * 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
  45774. * * The optional parameter `colors` is an array of successive Color4, one per line point
  45775. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  45776. * * When updating an instance, remember that only point positions can change, not the number of points
  45777. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  45778. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  45779. * @param name defines the name of the new line system
  45780. * @param options defines the options used to create the line system
  45781. * @param scene defines the hosting scene
  45782. * @returns a new line mesh
  45783. */
  45784. static CreateLines(name: string, options: {
  45785. points: Vector3[];
  45786. updatable?: boolean;
  45787. instance?: Nullable<LinesMesh>;
  45788. colors?: Color4[];
  45789. useVertexAlpha?: boolean;
  45790. }, scene?: Nullable<Scene>): LinesMesh;
  45791. /**
  45792. * Creates a dashed line mesh
  45793. * * 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
  45794. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  45795. * * The parameter `points` is an array successive Vector3
  45796. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  45797. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  45798. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  45799. * * 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
  45800. * * When updating an instance, remember that only point positions can change, not the number of points
  45801. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  45802. * @param name defines the name of the mesh
  45803. * @param options defines the options used to create the mesh
  45804. * @param scene defines the hosting scene
  45805. * @returns the dashed line mesh
  45806. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  45807. */
  45808. static CreateDashedLines(name: string, options: {
  45809. points: Vector3[];
  45810. dashSize?: number;
  45811. gapSize?: number;
  45812. dashNb?: number;
  45813. updatable?: boolean;
  45814. instance?: LinesMesh;
  45815. }, scene?: Nullable<Scene>): LinesMesh;
  45816. }
  45817. }
  45818. declare module "babylonjs/Debug/rayHelper" {
  45819. import { Nullable } from "babylonjs/types";
  45820. import { Ray } from "babylonjs/Culling/ray";
  45821. import { Vector3 } from "babylonjs/Maths/math.vector";
  45822. import { Color3 } from "babylonjs/Maths/math.color";
  45823. import { Scene } from "babylonjs/scene";
  45824. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45825. import "babylonjs/Meshes/Builders/linesBuilder";
  45826. /**
  45827. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  45828. * in order to better appreciate the issue one might have.
  45829. * @see http://doc.babylonjs.com/babylon101/raycasts#debugging
  45830. */
  45831. export class RayHelper {
  45832. /**
  45833. * Defines the ray we are currently tryin to visualize.
  45834. */
  45835. ray: Nullable<Ray>;
  45836. private _renderPoints;
  45837. private _renderLine;
  45838. private _renderFunction;
  45839. private _scene;
  45840. private _updateToMeshFunction;
  45841. private _attachedToMesh;
  45842. private _meshSpaceDirection;
  45843. private _meshSpaceOrigin;
  45844. /**
  45845. * Helper function to create a colored helper in a scene in one line.
  45846. * @param ray Defines the ray we are currently tryin to visualize
  45847. * @param scene Defines the scene the ray is used in
  45848. * @param color Defines the color we want to see the ray in
  45849. * @returns The newly created ray helper.
  45850. */
  45851. static CreateAndShow(ray: Ray, scene: Scene, color: Color3): RayHelper;
  45852. /**
  45853. * Instantiate a new ray helper.
  45854. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  45855. * in order to better appreciate the issue one might have.
  45856. * @see http://doc.babylonjs.com/babylon101/raycasts#debugging
  45857. * @param ray Defines the ray we are currently tryin to visualize
  45858. */
  45859. constructor(ray: Ray);
  45860. /**
  45861. * Shows the ray we are willing to debug.
  45862. * @param scene Defines the scene the ray needs to be rendered in
  45863. * @param color Defines the color the ray needs to be rendered in
  45864. */
  45865. show(scene: Scene, color?: Color3): void;
  45866. /**
  45867. * Hides the ray we are debugging.
  45868. */
  45869. hide(): void;
  45870. private _render;
  45871. /**
  45872. * Attach a ray helper to a mesh so that we can easily see its orientation for instance or information like its normals.
  45873. * @param mesh Defines the mesh we want the helper attached to
  45874. * @param meshSpaceDirection Defines the direction of the Ray in mesh space (local space of the mesh node)
  45875. * @param meshSpaceOrigin Defines the origin of the Ray in mesh space (local space of the mesh node)
  45876. * @param length Defines the length of the ray
  45877. */
  45878. attachToMesh(mesh: AbstractMesh, meshSpaceDirection?: Vector3, meshSpaceOrigin?: Vector3, length?: number): void;
  45879. /**
  45880. * Detach the ray helper from the mesh it has previously been attached to.
  45881. */
  45882. detachFromMesh(): void;
  45883. private _updateToMesh;
  45884. /**
  45885. * Dispose the helper and release its associated resources.
  45886. */
  45887. dispose(): void;
  45888. }
  45889. }
  45890. declare module "babylonjs/Debug/skeletonViewer" {
  45891. import { Color3 } from "babylonjs/Maths/math.color";
  45892. import { Scene } from "babylonjs/scene";
  45893. import { Nullable } from "babylonjs/types";
  45894. import { Skeleton } from "babylonjs/Bones/skeleton";
  45895. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  45896. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  45897. /**
  45898. * Class used to render a debug view of a given skeleton
  45899. * @see http://www.babylonjs-playground.com/#1BZJVJ#8
  45900. */
  45901. export class SkeletonViewer {
  45902. /** defines the skeleton to render */
  45903. skeleton: Skeleton;
  45904. /** defines the mesh attached to the skeleton */
  45905. mesh: AbstractMesh;
  45906. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  45907. autoUpdateBonesMatrices: boolean;
  45908. /** defines the rendering group id to use with the viewer */
  45909. renderingGroupId: number;
  45910. /** Gets or sets the color used to render the skeleton */
  45911. color: Color3;
  45912. private _scene;
  45913. private _debugLines;
  45914. private _debugMesh;
  45915. private _isEnabled;
  45916. private _renderFunction;
  45917. private _utilityLayer;
  45918. /**
  45919. * Returns the mesh used to render the bones
  45920. */
  45921. readonly debugMesh: Nullable<LinesMesh>;
  45922. /**
  45923. * Creates a new SkeletonViewer
  45924. * @param skeleton defines the skeleton to render
  45925. * @param mesh defines the mesh attached to the skeleton
  45926. * @param scene defines the hosting scene
  45927. * @param autoUpdateBonesMatrices defines a boolean indicating if bones matrices must be forced to update before rendering (true by default)
  45928. * @param renderingGroupId defines the rendering group id to use with the viewer
  45929. */
  45930. constructor(
  45931. /** defines the skeleton to render */
  45932. skeleton: Skeleton,
  45933. /** defines the mesh attached to the skeleton */
  45934. mesh: AbstractMesh, scene: Scene,
  45935. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  45936. autoUpdateBonesMatrices?: boolean,
  45937. /** defines the rendering group id to use with the viewer */
  45938. renderingGroupId?: number);
  45939. /** Gets or sets a boolean indicating if the viewer is enabled */
  45940. isEnabled: boolean;
  45941. private _getBonePosition;
  45942. private _getLinesForBonesWithLength;
  45943. private _getLinesForBonesNoLength;
  45944. /** Update the viewer to sync with current skeleton state */
  45945. update(): void;
  45946. /** Release associated resources */
  45947. dispose(): void;
  45948. }
  45949. }
  45950. declare module "babylonjs/Debug/index" {
  45951. export * from "babylonjs/Debug/axesViewer";
  45952. export * from "babylonjs/Debug/boneAxesViewer";
  45953. export * from "babylonjs/Debug/debugLayer";
  45954. export * from "babylonjs/Debug/physicsViewer";
  45955. export * from "babylonjs/Debug/rayHelper";
  45956. export * from "babylonjs/Debug/skeletonViewer";
  45957. }
  45958. declare module "babylonjs/Engines/nullEngine" {
  45959. import { Nullable, FloatArray, IndicesArray } from "babylonjs/types";
  45960. import { Scene } from "babylonjs/scene";
  45961. import { Engine } from "babylonjs/Engines/engine";
  45962. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  45963. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  45964. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  45965. import { Effect } from "babylonjs/Materials/effect";
  45966. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  45967. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  45968. import { IColor4Like, IViewportLike } from "babylonjs/Maths/math.like";
  45969. /**
  45970. * Options to create the null engine
  45971. */
  45972. export class NullEngineOptions {
  45973. /**
  45974. * Render width (Default: 512)
  45975. */
  45976. renderWidth: number;
  45977. /**
  45978. * Render height (Default: 256)
  45979. */
  45980. renderHeight: number;
  45981. /**
  45982. * Texture size (Default: 512)
  45983. */
  45984. textureSize: number;
  45985. /**
  45986. * If delta time between frames should be constant
  45987. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  45988. */
  45989. deterministicLockstep: boolean;
  45990. /**
  45991. * Maximum about of steps between frames (Default: 4)
  45992. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  45993. */
  45994. lockstepMaxSteps: number;
  45995. }
  45996. /**
  45997. * The null engine class provides support for headless version of babylon.js.
  45998. * This can be used in server side scenario or for testing purposes
  45999. */
  46000. export class NullEngine extends Engine {
  46001. private _options;
  46002. /**
  46003. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  46004. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  46005. * @returns true if engine is in deterministic lock step mode
  46006. */
  46007. isDeterministicLockStep(): boolean;
  46008. /**
  46009. * Gets the max steps when engine is running in deterministic lock step
  46010. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  46011. * @returns the max steps
  46012. */
  46013. getLockstepMaxSteps(): number;
  46014. /**
  46015. * Gets the current hardware scaling level.
  46016. * By default the hardware scaling level is computed from the window device ratio.
  46017. * 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.
  46018. * @returns a number indicating the current hardware scaling level
  46019. */
  46020. getHardwareScalingLevel(): number;
  46021. constructor(options?: NullEngineOptions);
  46022. /**
  46023. * Creates a vertex buffer
  46024. * @param vertices the data for the vertex buffer
  46025. * @returns the new WebGL static buffer
  46026. */
  46027. createVertexBuffer(vertices: FloatArray): DataBuffer;
  46028. /**
  46029. * Creates a new index buffer
  46030. * @param indices defines the content of the index buffer
  46031. * @param updatable defines if the index buffer must be updatable
  46032. * @returns a new webGL buffer
  46033. */
  46034. createIndexBuffer(indices: IndicesArray): DataBuffer;
  46035. /**
  46036. * Clear the current render buffer or the current render target (if any is set up)
  46037. * @param color defines the color to use
  46038. * @param backBuffer defines if the back buffer must be cleared
  46039. * @param depth defines if the depth buffer must be cleared
  46040. * @param stencil defines if the stencil buffer must be cleared
  46041. */
  46042. clear(color: IColor4Like, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  46043. /**
  46044. * Gets the current render width
  46045. * @param useScreen defines if screen size must be used (or the current render target if any)
  46046. * @returns a number defining the current render width
  46047. */
  46048. getRenderWidth(useScreen?: boolean): number;
  46049. /**
  46050. * Gets the current render height
  46051. * @param useScreen defines if screen size must be used (or the current render target if any)
  46052. * @returns a number defining the current render height
  46053. */
  46054. getRenderHeight(useScreen?: boolean): number;
  46055. /**
  46056. * Set the WebGL's viewport
  46057. * @param viewport defines the viewport element to be used
  46058. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  46059. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  46060. */
  46061. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  46062. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: string, context?: WebGLRenderingContext): WebGLProgram;
  46063. /**
  46064. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  46065. * @param pipelineContext defines the pipeline context to use
  46066. * @param uniformsNames defines the list of uniform names
  46067. * @returns an array of webGL uniform locations
  46068. */
  46069. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  46070. /**
  46071. * Gets the lsit of active attributes for a given webGL program
  46072. * @param pipelineContext defines the pipeline context to use
  46073. * @param attributesNames defines the list of attribute names to get
  46074. * @returns an array of indices indicating the offset of each attribute
  46075. */
  46076. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  46077. /**
  46078. * Binds an effect to the webGL context
  46079. * @param effect defines the effect to bind
  46080. */
  46081. bindSamplers(effect: Effect): void;
  46082. /**
  46083. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  46084. * @param effect defines the effect to activate
  46085. */
  46086. enableEffect(effect: Effect): void;
  46087. /**
  46088. * Set various states to the webGL context
  46089. * @param culling defines backface culling state
  46090. * @param zOffset defines the value to apply to zOffset (0 by default)
  46091. * @param force defines if states must be applied even if cache is up to date
  46092. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  46093. */
  46094. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  46095. /**
  46096. * Set the value of an uniform to an array of int32
  46097. * @param uniform defines the webGL uniform location where to store the value
  46098. * @param array defines the array of int32 to store
  46099. */
  46100. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  46101. /**
  46102. * Set the value of an uniform to an array of int32 (stored as vec2)
  46103. * @param uniform defines the webGL uniform location where to store the value
  46104. * @param array defines the array of int32 to store
  46105. */
  46106. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  46107. /**
  46108. * Set the value of an uniform to an array of int32 (stored as vec3)
  46109. * @param uniform defines the webGL uniform location where to store the value
  46110. * @param array defines the array of int32 to store
  46111. */
  46112. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  46113. /**
  46114. * Set the value of an uniform to an array of int32 (stored as vec4)
  46115. * @param uniform defines the webGL uniform location where to store the value
  46116. * @param array defines the array of int32 to store
  46117. */
  46118. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  46119. /**
  46120. * Set the value of an uniform to an array of float32
  46121. * @param uniform defines the webGL uniform location where to store the value
  46122. * @param array defines the array of float32 to store
  46123. */
  46124. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  46125. /**
  46126. * Set the value of an uniform to an array of float32 (stored as vec2)
  46127. * @param uniform defines the webGL uniform location where to store the value
  46128. * @param array defines the array of float32 to store
  46129. */
  46130. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  46131. /**
  46132. * Set the value of an uniform to an array of float32 (stored as vec3)
  46133. * @param uniform defines the webGL uniform location where to store the value
  46134. * @param array defines the array of float32 to store
  46135. */
  46136. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  46137. /**
  46138. * Set the value of an uniform to an array of float32 (stored as vec4)
  46139. * @param uniform defines the webGL uniform location where to store the value
  46140. * @param array defines the array of float32 to store
  46141. */
  46142. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  46143. /**
  46144. * Set the value of an uniform to an array of number
  46145. * @param uniform defines the webGL uniform location where to store the value
  46146. * @param array defines the array of number to store
  46147. */
  46148. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  46149. /**
  46150. * Set the value of an uniform to an array of number (stored as vec2)
  46151. * @param uniform defines the webGL uniform location where to store the value
  46152. * @param array defines the array of number to store
  46153. */
  46154. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  46155. /**
  46156. * Set the value of an uniform to an array of number (stored as vec3)
  46157. * @param uniform defines the webGL uniform location where to store the value
  46158. * @param array defines the array of number to store
  46159. */
  46160. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  46161. /**
  46162. * Set the value of an uniform to an array of number (stored as vec4)
  46163. * @param uniform defines the webGL uniform location where to store the value
  46164. * @param array defines the array of number to store
  46165. */
  46166. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  46167. /**
  46168. * Set the value of an uniform to an array of float32 (stored as matrices)
  46169. * @param uniform defines the webGL uniform location where to store the value
  46170. * @param matrices defines the array of float32 to store
  46171. */
  46172. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  46173. /**
  46174. * Set the value of an uniform to a matrix (3x3)
  46175. * @param uniform defines the webGL uniform location where to store the value
  46176. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  46177. */
  46178. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  46179. /**
  46180. * Set the value of an uniform to a matrix (2x2)
  46181. * @param uniform defines the webGL uniform location where to store the value
  46182. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  46183. */
  46184. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  46185. /**
  46186. * Set the value of an uniform to a number (float)
  46187. * @param uniform defines the webGL uniform location where to store the value
  46188. * @param value defines the float number to store
  46189. */
  46190. setFloat(uniform: WebGLUniformLocation, value: number): void;
  46191. /**
  46192. * Set the value of an uniform to a vec2
  46193. * @param uniform defines the webGL uniform location where to store the value
  46194. * @param x defines the 1st component of the value
  46195. * @param y defines the 2nd component of the value
  46196. */
  46197. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  46198. /**
  46199. * Set the value of an uniform to a vec3
  46200. * @param uniform defines the webGL uniform location where to store the value
  46201. * @param x defines the 1st component of the value
  46202. * @param y defines the 2nd component of the value
  46203. * @param z defines the 3rd component of the value
  46204. */
  46205. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  46206. /**
  46207. * Set the value of an uniform to a boolean
  46208. * @param uniform defines the webGL uniform location where to store the value
  46209. * @param bool defines the boolean to store
  46210. */
  46211. setBool(uniform: WebGLUniformLocation, bool: number): void;
  46212. /**
  46213. * Set the value of an uniform to a vec4
  46214. * @param uniform defines the webGL uniform location where to store the value
  46215. * @param x defines the 1st component of the value
  46216. * @param y defines the 2nd component of the value
  46217. * @param z defines the 3rd component of the value
  46218. * @param w defines the 4th component of the value
  46219. */
  46220. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  46221. /**
  46222. * Sets the current alpha mode
  46223. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  46224. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  46225. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  46226. */
  46227. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  46228. /**
  46229. * Bind webGl buffers directly to the webGL context
  46230. * @param vertexBuffers defines the vertex buffer to bind
  46231. * @param indexBuffer defines the index buffer to bind
  46232. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  46233. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  46234. * @param effect defines the effect associated with the vertex buffer
  46235. */
  46236. bindBuffers(vertexBuffers: {
  46237. [key: string]: VertexBuffer;
  46238. }, indexBuffer: DataBuffer, effect: Effect): void;
  46239. /**
  46240. * Force the entire cache to be cleared
  46241. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  46242. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  46243. */
  46244. wipeCaches(bruteForce?: boolean): void;
  46245. /**
  46246. * Send a draw order
  46247. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  46248. * @param indexStart defines the starting index
  46249. * @param indexCount defines the number of index to draw
  46250. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  46251. */
  46252. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  46253. /**
  46254. * Draw a list of indexed primitives
  46255. * @param fillMode defines the primitive to use
  46256. * @param indexStart defines the starting index
  46257. * @param indexCount defines the number of index to draw
  46258. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  46259. */
  46260. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  46261. /**
  46262. * Draw a list of unindexed primitives
  46263. * @param fillMode defines the primitive to use
  46264. * @param verticesStart defines the index of first vertex to draw
  46265. * @param verticesCount defines the count of vertices to draw
  46266. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  46267. */
  46268. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  46269. /** @hidden */
  46270. _createTexture(): WebGLTexture;
  46271. /** @hidden */
  46272. _releaseTexture(texture: InternalTexture): void;
  46273. /**
  46274. * Usually called from Texture.ts.
  46275. * Passed information to create a WebGLTexture
  46276. * @param urlArg defines a value which contains one of the following:
  46277. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  46278. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  46279. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  46280. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  46281. * @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)
  46282. * @param scene needed for loading to the correct scene
  46283. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  46284. * @param onLoad optional callback to be called upon successful completion
  46285. * @param onError optional callback to be called upon failure
  46286. * @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
  46287. * @param fallBack an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  46288. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  46289. * @param forcedExtension defines the extension to use to pick the right loader
  46290. * @param excludeLoaders array of texture loaders that should be excluded when picking a loader for the texture (default: empty array)
  46291. * @returns a InternalTexture for assignment back into BABYLON.Texture
  46292. */
  46293. 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;
  46294. /**
  46295. * Creates a new render target texture
  46296. * @param size defines the size of the texture
  46297. * @param options defines the options used to create the texture
  46298. * @returns a new render target texture stored in an InternalTexture
  46299. */
  46300. createRenderTargetTexture(size: any, options: boolean | RenderTargetCreationOptions): InternalTexture;
  46301. /**
  46302. * Update the sampling mode of a given texture
  46303. * @param samplingMode defines the required sampling mode
  46304. * @param texture defines the texture to update
  46305. */
  46306. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  46307. /**
  46308. * Binds the frame buffer to the specified texture.
  46309. * @param texture The texture to render to or null for the default canvas
  46310. * @param faceIndex The face of the texture to render to in case of cube texture
  46311. * @param requiredWidth The width of the target to render to
  46312. * @param requiredHeight The height of the target to render to
  46313. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  46314. * @param depthStencilTexture The depth stencil texture to use to render
  46315. * @param lodLevel defines le lod level to bind to the frame buffer
  46316. */
  46317. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  46318. /**
  46319. * Unbind the current render target texture from the webGL context
  46320. * @param texture defines the render target texture to unbind
  46321. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  46322. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  46323. */
  46324. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  46325. /**
  46326. * Creates a dynamic vertex buffer
  46327. * @param vertices the data for the dynamic vertex buffer
  46328. * @returns the new WebGL dynamic buffer
  46329. */
  46330. createDynamicVertexBuffer(vertices: FloatArray): DataBuffer;
  46331. /**
  46332. * Update the content of a dynamic texture
  46333. * @param texture defines the texture to update
  46334. * @param canvas defines the canvas containing the source
  46335. * @param invertY defines if data must be stored with Y axis inverted
  46336. * @param premulAlpha defines if alpha is stored as premultiplied
  46337. * @param format defines the format of the data
  46338. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  46339. */
  46340. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement, invertY: boolean, premulAlpha?: boolean, format?: number): void;
  46341. /**
  46342. * Gets a boolean indicating if all created effects are ready
  46343. * @returns true if all effects are ready
  46344. */
  46345. areAllEffectsReady(): boolean;
  46346. /**
  46347. * @hidden
  46348. * Get the current error code of the webGL context
  46349. * @returns the error code
  46350. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  46351. */
  46352. getError(): number;
  46353. /** @hidden */
  46354. _getUnpackAlignement(): number;
  46355. /** @hidden */
  46356. _unpackFlipY(value: boolean): void;
  46357. /**
  46358. * Update a dynamic index buffer
  46359. * @param indexBuffer defines the target index buffer
  46360. * @param indices defines the data to update
  46361. * @param offset defines the offset in the target index buffer where update should start
  46362. */
  46363. updateDynamicIndexBuffer(indexBuffer: WebGLBuffer, indices: IndicesArray, offset?: number): void;
  46364. /**
  46365. * Updates a dynamic vertex buffer.
  46366. * @param vertexBuffer the vertex buffer to update
  46367. * @param vertices the data used to update the vertex buffer
  46368. * @param byteOffset the byte offset of the data (optional)
  46369. * @param byteLength the byte length of the data (optional)
  46370. */
  46371. updateDynamicVertexBuffer(vertexBuffer: WebGLBuffer, vertices: FloatArray, byteOffset?: number, byteLength?: number): void;
  46372. /** @hidden */
  46373. _bindTextureDirectly(target: number, texture: InternalTexture): boolean;
  46374. /** @hidden */
  46375. _bindTexture(channel: number, texture: InternalTexture): void;
  46376. protected _deleteBuffer(buffer: WebGLBuffer): void;
  46377. /**
  46378. * 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
  46379. */
  46380. releaseEffects(): void;
  46381. displayLoadingUI(): void;
  46382. hideLoadingUI(): void;
  46383. /** @hidden */
  46384. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  46385. /** @hidden */
  46386. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  46387. /** @hidden */
  46388. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  46389. /** @hidden */
  46390. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  46391. }
  46392. }
  46393. declare module "babylonjs/Engines/Extensions/engine.occlusionQuery" {
  46394. import { Nullable, int } from "babylonjs/types";
  46395. import { _TimeToken } from "babylonjs/Instrumentation/timeToken";
  46396. /** @hidden */
  46397. export class _OcclusionDataStorage {
  46398. /** @hidden */
  46399. occlusionInternalRetryCounter: number;
  46400. /** @hidden */
  46401. isOcclusionQueryInProgress: boolean;
  46402. /** @hidden */
  46403. isOccluded: boolean;
  46404. /** @hidden */
  46405. occlusionRetryCount: number;
  46406. /** @hidden */
  46407. occlusionType: number;
  46408. /** @hidden */
  46409. occlusionQueryAlgorithmType: number;
  46410. }
  46411. module "babylonjs/Engines/engine" {
  46412. interface Engine {
  46413. /**
  46414. * Create a new webGL query (you must be sure that queries are supported by checking getCaps() function)
  46415. * @return the new query
  46416. */
  46417. createQuery(): WebGLQuery;
  46418. /**
  46419. * Delete and release a webGL query
  46420. * @param query defines the query to delete
  46421. * @return the current engine
  46422. */
  46423. deleteQuery(query: WebGLQuery): Engine;
  46424. /**
  46425. * Check if a given query has resolved and got its value
  46426. * @param query defines the query to check
  46427. * @returns true if the query got its value
  46428. */
  46429. isQueryResultAvailable(query: WebGLQuery): boolean;
  46430. /**
  46431. * Gets the value of a given query
  46432. * @param query defines the query to check
  46433. * @returns the value of the query
  46434. */
  46435. getQueryResult(query: WebGLQuery): number;
  46436. /**
  46437. * Initiates an occlusion query
  46438. * @param algorithmType defines the algorithm to use
  46439. * @param query defines the query to use
  46440. * @returns the current engine
  46441. * @see http://doc.babylonjs.com/features/occlusionquery
  46442. */
  46443. beginOcclusionQuery(algorithmType: number, query: WebGLQuery): Engine;
  46444. /**
  46445. * Ends an occlusion query
  46446. * @see http://doc.babylonjs.com/features/occlusionquery
  46447. * @param algorithmType defines the algorithm to use
  46448. * @returns the current engine
  46449. */
  46450. endOcclusionQuery(algorithmType: number): Engine;
  46451. /**
  46452. * Starts a time query (used to measure time spent by the GPU on a specific frame)
  46453. * Please note that only one query can be issued at a time
  46454. * @returns a time token used to track the time span
  46455. */
  46456. startTimeQuery(): Nullable<_TimeToken>;
  46457. /**
  46458. * Ends a time query
  46459. * @param token defines the token used to measure the time span
  46460. * @returns the time spent (in ns)
  46461. */
  46462. endTimeQuery(token: _TimeToken): int;
  46463. /** @hidden */
  46464. _currentNonTimestampToken: Nullable<_TimeToken>;
  46465. /** @hidden */
  46466. _createTimeQuery(): WebGLQuery;
  46467. /** @hidden */
  46468. _deleteTimeQuery(query: WebGLQuery): void;
  46469. /** @hidden */
  46470. _getGlAlgorithmType(algorithmType: number): number;
  46471. /** @hidden */
  46472. _getTimeQueryResult(query: WebGLQuery): any;
  46473. /** @hidden */
  46474. _getTimeQueryAvailability(query: WebGLQuery): any;
  46475. }
  46476. }
  46477. module "babylonjs/Meshes/abstractMesh" {
  46478. interface AbstractMesh {
  46479. /**
  46480. * Backing filed
  46481. * @hidden
  46482. */
  46483. __occlusionDataStorage: _OcclusionDataStorage;
  46484. /**
  46485. * Access property
  46486. * @hidden
  46487. */
  46488. _occlusionDataStorage: _OcclusionDataStorage;
  46489. /**
  46490. * 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.
  46491. * The default value is -1 which means don't break the query and wait till the result
  46492. * @see http://doc.babylonjs.com/features/occlusionquery
  46493. */
  46494. occlusionRetryCount: number;
  46495. /**
  46496. * 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:
  46497. * * OCCLUSION_TYPE_NONE (Default Value): this option means no occlusion query whith the Mesh.
  46498. * * OCCLUSION_TYPE_OPTIMISTIC: this option is means use occlusion query and if occlusionRetryCount is reached and the query is broken show the mesh.
  46499. * * 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.
  46500. * @see http://doc.babylonjs.com/features/occlusionquery
  46501. */
  46502. occlusionType: number;
  46503. /**
  46504. * This property determines the type of occlusion query algorithm to run in WebGl, you can use:
  46505. * * AbstractMesh.OCCLUSION_ALGORITHM_TYPE_ACCURATE which is mapped to GL_ANY_SAMPLES_PASSED.
  46506. * * 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.
  46507. * @see http://doc.babylonjs.com/features/occlusionquery
  46508. */
  46509. occlusionQueryAlgorithmType: number;
  46510. /**
  46511. * 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
  46512. * @see http://doc.babylonjs.com/features/occlusionquery
  46513. */
  46514. isOccluded: boolean;
  46515. /**
  46516. * Flag to check the progress status of the query
  46517. * @see http://doc.babylonjs.com/features/occlusionquery
  46518. */
  46519. isOcclusionQueryInProgress: boolean;
  46520. }
  46521. }
  46522. }
  46523. declare module "babylonjs/Engines/Extensions/engine.transformFeedback" {
  46524. import { Nullable } from "babylonjs/types";
  46525. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  46526. /** @hidden */
  46527. export var _forceTransformFeedbackToBundle: boolean;
  46528. module "babylonjs/Engines/engine" {
  46529. interface Engine {
  46530. /**
  46531. * Creates a webGL transform feedback object
  46532. * Please makes sure to check webGLVersion property to check if you are running webGL 2+
  46533. * @returns the webGL transform feedback object
  46534. */
  46535. createTransformFeedback(): WebGLTransformFeedback;
  46536. /**
  46537. * Delete a webGL transform feedback object
  46538. * @param value defines the webGL transform feedback object to delete
  46539. */
  46540. deleteTransformFeedback(value: WebGLTransformFeedback): void;
  46541. /**
  46542. * Bind a webGL transform feedback object to the webgl context
  46543. * @param value defines the webGL transform feedback object to bind
  46544. */
  46545. bindTransformFeedback(value: Nullable<WebGLTransformFeedback>): void;
  46546. /**
  46547. * Begins a transform feedback operation
  46548. * @param usePoints defines if points or triangles must be used
  46549. */
  46550. beginTransformFeedback(usePoints: boolean): void;
  46551. /**
  46552. * Ends a transform feedback operation
  46553. */
  46554. endTransformFeedback(): void;
  46555. /**
  46556. * Specify the varyings to use with transform feedback
  46557. * @param program defines the associated webGL program
  46558. * @param value defines the list of strings representing the varying names
  46559. */
  46560. setTranformFeedbackVaryings(program: WebGLProgram, value: string[]): void;
  46561. /**
  46562. * Bind a webGL buffer for a transform feedback operation
  46563. * @param value defines the webGL buffer to bind
  46564. */
  46565. bindTransformFeedbackBuffer(value: Nullable<DataBuffer>): void;
  46566. }
  46567. }
  46568. }
  46569. declare module "babylonjs/Materials/Textures/multiRenderTarget" {
  46570. import { Scene } from "babylonjs/scene";
  46571. import { Engine } from "babylonjs/Engines/engine";
  46572. import { Texture } from "babylonjs/Materials/Textures/texture";
  46573. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  46574. import "babylonjs/Engines/Extensions/engine.multiRender";
  46575. /**
  46576. * Creation options of the multi render target texture.
  46577. */
  46578. export interface IMultiRenderTargetOptions {
  46579. /**
  46580. * Define if the texture needs to create mip maps after render.
  46581. */
  46582. generateMipMaps?: boolean;
  46583. /**
  46584. * Define the types of all the draw buffers we want to create
  46585. */
  46586. types?: number[];
  46587. /**
  46588. * Define the sampling modes of all the draw buffers we want to create
  46589. */
  46590. samplingModes?: number[];
  46591. /**
  46592. * Define if a depth buffer is required
  46593. */
  46594. generateDepthBuffer?: boolean;
  46595. /**
  46596. * Define if a stencil buffer is required
  46597. */
  46598. generateStencilBuffer?: boolean;
  46599. /**
  46600. * Define if a depth texture is required instead of a depth buffer
  46601. */
  46602. generateDepthTexture?: boolean;
  46603. /**
  46604. * Define the number of desired draw buffers
  46605. */
  46606. textureCount?: number;
  46607. /**
  46608. * Define if aspect ratio should be adapted to the texture or stay the scene one
  46609. */
  46610. doNotChangeAspectRatio?: boolean;
  46611. /**
  46612. * Define the default type of the buffers we are creating
  46613. */
  46614. defaultType?: number;
  46615. }
  46616. /**
  46617. * A multi render target, like a render target provides the ability to render to a texture.
  46618. * Unlike the render target, it can render to several draw buffers in one draw.
  46619. * This is specially interesting in deferred rendering or for any effects requiring more than
  46620. * just one color from a single pass.
  46621. */
  46622. export class MultiRenderTarget extends RenderTargetTexture {
  46623. private _internalTextures;
  46624. private _textures;
  46625. private _multiRenderTargetOptions;
  46626. /**
  46627. * Get if draw buffers are currently supported by the used hardware and browser.
  46628. */
  46629. readonly isSupported: boolean;
  46630. /**
  46631. * Get the list of textures generated by the multi render target.
  46632. */
  46633. readonly textures: Texture[];
  46634. /**
  46635. * Get the depth texture generated by the multi render target if options.generateDepthTexture has been set
  46636. */
  46637. readonly depthTexture: Texture;
  46638. /**
  46639. * Set the wrapping mode on U of all the textures we are rendering to.
  46640. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  46641. */
  46642. wrapU: number;
  46643. /**
  46644. * Set the wrapping mode on V of all the textures we are rendering to.
  46645. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  46646. */
  46647. wrapV: number;
  46648. /**
  46649. * Instantiate a new multi render target texture.
  46650. * A multi render target, like a render target provides the ability to render to a texture.
  46651. * Unlike the render target, it can render to several draw buffers in one draw.
  46652. * This is specially interesting in deferred rendering or for any effects requiring more than
  46653. * just one color from a single pass.
  46654. * @param name Define the name of the texture
  46655. * @param size Define the size of the buffers to render to
  46656. * @param count Define the number of target we are rendering into
  46657. * @param scene Define the scene the texture belongs to
  46658. * @param options Define the options used to create the multi render target
  46659. */
  46660. constructor(name: string, size: any, count: number, scene: Scene, options?: IMultiRenderTargetOptions);
  46661. /** @hidden */
  46662. _rebuild(): void;
  46663. private _createInternalTextures;
  46664. private _createTextures;
  46665. /**
  46666. * Define the number of samples used if MSAA is enabled.
  46667. */
  46668. samples: number;
  46669. /**
  46670. * Resize all the textures in the multi render target.
  46671. * Be carrefull as it will recreate all the data in the new texture.
  46672. * @param size Define the new size
  46673. */
  46674. resize(size: any): void;
  46675. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  46676. /**
  46677. * Dispose the render targets and their associated resources
  46678. */
  46679. dispose(): void;
  46680. /**
  46681. * Release all the underlying texture used as draw buffers.
  46682. */
  46683. releaseInternalTextures(): void;
  46684. }
  46685. }
  46686. declare module "babylonjs/Engines/Extensions/engine.multiRender" {
  46687. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  46688. import { IMultiRenderTargetOptions } from "babylonjs/Materials/Textures/multiRenderTarget";
  46689. import { Nullable } from "babylonjs/types";
  46690. module "babylonjs/Engines/thinEngine" {
  46691. interface ThinEngine {
  46692. /**
  46693. * Unbind a list of render target textures from the webGL context
  46694. * This is used only when drawBuffer extension or webGL2 are active
  46695. * @param textures defines the render target textures to unbind
  46696. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  46697. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  46698. */
  46699. unBindMultiColorAttachmentFramebuffer(textures: InternalTexture[], disableGenerateMipMaps: boolean, onBeforeUnbind?: () => void): void;
  46700. /**
  46701. * Create a multi render target texture
  46702. * @see http://doc.babylonjs.com/features/webgl2#multiple-render-target
  46703. * @param size defines the size of the texture
  46704. * @param options defines the creation options
  46705. * @returns the cube texture as an InternalTexture
  46706. */
  46707. createMultipleRenderTarget(size: any, options: IMultiRenderTargetOptions): InternalTexture[];
  46708. /**
  46709. * Update the sample count for a given multiple render target texture
  46710. * @see http://doc.babylonjs.com/features/webgl2#multisample-render-targets
  46711. * @param textures defines the textures to update
  46712. * @param samples defines the sample count to set
  46713. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  46714. */
  46715. updateMultipleRenderTargetTextureSampleCount(textures: Nullable<InternalTexture[]>, samples: number): number;
  46716. }
  46717. }
  46718. }
  46719. declare module "babylonjs/Engines/Extensions/engine.views" {
  46720. import { Camera } from "babylonjs/Cameras/camera";
  46721. import { Nullable } from "babylonjs/types";
  46722. /**
  46723. * Class used to define an additional view for the engine
  46724. * @see https://doc.babylonjs.com/how_to/multi_canvases
  46725. */
  46726. export class EngineView {
  46727. /** Defines the canvas where to render the view */
  46728. target: HTMLCanvasElement;
  46729. /** Defines an optional camera used to render the view (will use active camera else) */
  46730. camera?: Camera;
  46731. }
  46732. module "babylonjs/Engines/engine" {
  46733. interface Engine {
  46734. /**
  46735. * Gets or sets the HTML element to use for attaching events
  46736. */
  46737. inputElement: Nullable<HTMLElement>;
  46738. /**
  46739. * Gets the current engine view
  46740. * @see https://doc.babylonjs.com/how_to/multi_canvases
  46741. */
  46742. activeView: Nullable<EngineView>;
  46743. /** Gets or sets the list of views */
  46744. views: EngineView[];
  46745. /**
  46746. * Register a new child canvas
  46747. * @param canvas defines the canvas to register
  46748. * @param camera defines an optional camera to use with this canvas (it will overwrite the scene.camera for this view)
  46749. * @returns the associated view
  46750. */
  46751. registerView(canvas: HTMLCanvasElement, camera?: Camera): EngineView;
  46752. /**
  46753. * Remove a registered child canvas
  46754. * @param canvas defines the canvas to remove
  46755. * @returns the current engine
  46756. */
  46757. unRegisterView(canvas: HTMLCanvasElement): Engine;
  46758. }
  46759. }
  46760. }
  46761. declare module "babylonjs/Engines/Extensions/index" {
  46762. export * from "babylonjs/Engines/Extensions/engine.occlusionQuery";
  46763. export * from "babylonjs/Engines/Extensions/engine.transformFeedback";
  46764. export * from "babylonjs/Engines/Extensions/engine.multiview";
  46765. export * from "babylonjs/Engines/Extensions/engine.rawTexture";
  46766. export * from "babylonjs/Engines/Extensions/engine.dynamicTexture";
  46767. export * from "babylonjs/Engines/Extensions/engine.videoTexture";
  46768. export * from "babylonjs/Engines/Extensions/engine.multiRender";
  46769. export * from "babylonjs/Engines/Extensions/engine.cubeTexture";
  46770. export * from "babylonjs/Engines/Extensions/engine.renderTarget";
  46771. export * from "babylonjs/Engines/Extensions/engine.renderTargetCube";
  46772. export * from "babylonjs/Engines/Extensions/engine.webVR";
  46773. export * from "babylonjs/Engines/Extensions/engine.uniformBuffer";
  46774. export * from "babylonjs/Engines/Extensions/engine.views";
  46775. }
  46776. declare module "babylonjs/Misc/HighDynamicRange/panoramaToCubemap" {
  46777. import { Nullable } from "babylonjs/types";
  46778. /**
  46779. * CubeMap information grouping all the data for each faces as well as the cubemap size.
  46780. */
  46781. export interface CubeMapInfo {
  46782. /**
  46783. * The pixel array for the front face.
  46784. * This is stored in format, left to right, up to down format.
  46785. */
  46786. front: Nullable<ArrayBufferView>;
  46787. /**
  46788. * The pixel array for the back face.
  46789. * This is stored in format, left to right, up to down format.
  46790. */
  46791. back: Nullable<ArrayBufferView>;
  46792. /**
  46793. * The pixel array for the left face.
  46794. * This is stored in format, left to right, up to down format.
  46795. */
  46796. left: Nullable<ArrayBufferView>;
  46797. /**
  46798. * The pixel array for the right face.
  46799. * This is stored in format, left to right, up to down format.
  46800. */
  46801. right: Nullable<ArrayBufferView>;
  46802. /**
  46803. * The pixel array for the up face.
  46804. * This is stored in format, left to right, up to down format.
  46805. */
  46806. up: Nullable<ArrayBufferView>;
  46807. /**
  46808. * The pixel array for the down face.
  46809. * This is stored in format, left to right, up to down format.
  46810. */
  46811. down: Nullable<ArrayBufferView>;
  46812. /**
  46813. * The size of the cubemap stored.
  46814. *
  46815. * Each faces will be size * size pixels.
  46816. */
  46817. size: number;
  46818. /**
  46819. * The format of the texture.
  46820. *
  46821. * RGBA, RGB.
  46822. */
  46823. format: number;
  46824. /**
  46825. * The type of the texture data.
  46826. *
  46827. * UNSIGNED_INT, FLOAT.
  46828. */
  46829. type: number;
  46830. /**
  46831. * Specifies whether the texture is in gamma space.
  46832. */
  46833. gammaSpace: boolean;
  46834. }
  46835. /**
  46836. * Helper class useful to convert panorama picture to their cubemap representation in 6 faces.
  46837. */
  46838. export class PanoramaToCubeMapTools {
  46839. private static FACE_FRONT;
  46840. private static FACE_BACK;
  46841. private static FACE_RIGHT;
  46842. private static FACE_LEFT;
  46843. private static FACE_DOWN;
  46844. private static FACE_UP;
  46845. /**
  46846. * Converts a panorma stored in RGB right to left up to down format into a cubemap (6 faces).
  46847. *
  46848. * @param float32Array The source data.
  46849. * @param inputWidth The width of the input panorama.
  46850. * @param inputHeight The height of the input panorama.
  46851. * @param size The willing size of the generated cubemap (each faces will be size * size pixels)
  46852. * @return The cubemap data
  46853. */
  46854. static ConvertPanoramaToCubemap(float32Array: Float32Array, inputWidth: number, inputHeight: number, size: number): CubeMapInfo;
  46855. private static CreateCubemapTexture;
  46856. private static CalcProjectionSpherical;
  46857. }
  46858. }
  46859. declare module "babylonjs/Misc/HighDynamicRange/cubemapToSphericalPolynomial" {
  46860. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  46861. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  46862. import { Nullable } from "babylonjs/types";
  46863. import { CubeMapInfo } from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  46864. /**
  46865. * Helper class dealing with the extraction of spherical polynomial dataArray
  46866. * from a cube map.
  46867. */
  46868. export class CubeMapToSphericalPolynomialTools {
  46869. private static FileFaces;
  46870. /**
  46871. * Converts a texture to the according Spherical Polynomial data.
  46872. * This extracts the first 3 orders only as they are the only one used in the lighting.
  46873. *
  46874. * @param texture The texture to extract the information from.
  46875. * @return The Spherical Polynomial data.
  46876. */
  46877. static ConvertCubeMapTextureToSphericalPolynomial(texture: BaseTexture): Nullable<SphericalPolynomial>;
  46878. /**
  46879. * Converts a cubemap to the according Spherical Polynomial data.
  46880. * This extracts the first 3 orders only as they are the only one used in the lighting.
  46881. *
  46882. * @param cubeInfo The Cube map to extract the information from.
  46883. * @return The Spherical Polynomial data.
  46884. */
  46885. static ConvertCubeMapToSphericalPolynomial(cubeInfo: CubeMapInfo): SphericalPolynomial;
  46886. }
  46887. }
  46888. declare module "babylonjs/Materials/Textures/baseTexture.polynomial" {
  46889. import { Nullable } from "babylonjs/types";
  46890. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  46891. module "babylonjs/Materials/Textures/baseTexture" {
  46892. interface BaseTexture {
  46893. /**
  46894. * Get the polynomial representation of the texture data.
  46895. * This is mainly use as a fast way to recover IBL Diffuse irradiance data.
  46896. * @see https://learnopengl.com/PBR/IBL/Diffuse-irradiance
  46897. */
  46898. sphericalPolynomial: Nullable<SphericalPolynomial>;
  46899. }
  46900. }
  46901. }
  46902. declare module "babylonjs/Shaders/rgbdEncode.fragment" {
  46903. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  46904. /** @hidden */
  46905. export var rgbdEncodePixelShader: {
  46906. name: string;
  46907. shader: string;
  46908. };
  46909. }
  46910. declare module "babylonjs/Shaders/rgbdDecode.fragment" {
  46911. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  46912. /** @hidden */
  46913. export var rgbdDecodePixelShader: {
  46914. name: string;
  46915. shader: string;
  46916. };
  46917. }
  46918. declare module "babylonjs/Misc/environmentTextureTools" {
  46919. import { Nullable } from "babylonjs/types";
  46920. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  46921. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  46922. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  46923. import "babylonjs/Engines/Extensions/engine.renderTargetCube";
  46924. import "babylonjs/Materials/Textures/baseTexture.polynomial";
  46925. import "babylonjs/Shaders/rgbdEncode.fragment";
  46926. import "babylonjs/Shaders/rgbdDecode.fragment";
  46927. /**
  46928. * Raw texture data and descriptor sufficient for WebGL texture upload
  46929. */
  46930. export interface EnvironmentTextureInfo {
  46931. /**
  46932. * Version of the environment map
  46933. */
  46934. version: number;
  46935. /**
  46936. * Width of image
  46937. */
  46938. width: number;
  46939. /**
  46940. * Irradiance information stored in the file.
  46941. */
  46942. irradiance: any;
  46943. /**
  46944. * Specular information stored in the file.
  46945. */
  46946. specular: any;
  46947. }
  46948. /**
  46949. * Defines One Image in the file. It requires only the position in the file
  46950. * as well as the length.
  46951. */
  46952. interface BufferImageData {
  46953. /**
  46954. * Length of the image data.
  46955. */
  46956. length: number;
  46957. /**
  46958. * Position of the data from the null terminator delimiting the end of the JSON.
  46959. */
  46960. position: number;
  46961. }
  46962. /**
  46963. * Defines the specular data enclosed in the file.
  46964. * This corresponds to the version 1 of the data.
  46965. */
  46966. export interface EnvironmentTextureSpecularInfoV1 {
  46967. /**
  46968. * Defines where the specular Payload is located. It is a runtime value only not stored in the file.
  46969. */
  46970. specularDataPosition?: number;
  46971. /**
  46972. * This contains all the images data needed to reconstruct the cubemap.
  46973. */
  46974. mipmaps: Array<BufferImageData>;
  46975. /**
  46976. * Defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness.
  46977. */
  46978. lodGenerationScale: number;
  46979. }
  46980. /**
  46981. * Sets of helpers addressing the serialization and deserialization of environment texture
  46982. * stored in a BabylonJS env file.
  46983. * Those files are usually stored as .env files.
  46984. */
  46985. export class EnvironmentTextureTools {
  46986. /**
  46987. * Magic number identifying the env file.
  46988. */
  46989. private static _MagicBytes;
  46990. /**
  46991. * Gets the environment info from an env file.
  46992. * @param data The array buffer containing the .env bytes.
  46993. * @returns the environment file info (the json header) if successfully parsed.
  46994. */
  46995. static GetEnvInfo(data: ArrayBuffer): Nullable<EnvironmentTextureInfo>;
  46996. /**
  46997. * Creates an environment texture from a loaded cube texture.
  46998. * @param texture defines the cube texture to convert in env file
  46999. * @return a promise containing the environment data if succesfull.
  47000. */
  47001. static CreateEnvTextureAsync(texture: CubeTexture): Promise<ArrayBuffer>;
  47002. /**
  47003. * Creates a JSON representation of the spherical data.
  47004. * @param texture defines the texture containing the polynomials
  47005. * @return the JSON representation of the spherical info
  47006. */
  47007. private static _CreateEnvTextureIrradiance;
  47008. /**
  47009. * Creates the ArrayBufferViews used for initializing environment texture image data.
  47010. * @param arrayBuffer the underlying ArrayBuffer to which the views refer
  47011. * @param info parameters that determine what views will be created for accessing the underlying buffer
  47012. * @return the views described by info providing access to the underlying buffer
  47013. */
  47014. static CreateImageDataArrayBufferViews(arrayBuffer: any, info: EnvironmentTextureInfo): Array<Array<ArrayBufferView>>;
  47015. /**
  47016. * Uploads the texture info contained in the env file to the GPU.
  47017. * @param texture defines the internal texture to upload to
  47018. * @param arrayBuffer defines the buffer cotaining the data to load
  47019. * @param info defines the texture info retrieved through the GetEnvInfo method
  47020. * @returns a promise
  47021. */
  47022. static UploadEnvLevelsAsync(texture: InternalTexture, arrayBuffer: any, info: EnvironmentTextureInfo): Promise<void>;
  47023. private static _OnImageReadyAsync;
  47024. /**
  47025. * Uploads the levels of image data to the GPU.
  47026. * @param texture defines the internal texture to upload to
  47027. * @param imageData defines the array buffer views of image data [mipmap][face]
  47028. * @returns a promise
  47029. */
  47030. static UploadLevelsAsync(texture: InternalTexture, imageData: ArrayBufferView[][]): Promise<void>;
  47031. /**
  47032. * Uploads spherical polynomials information to the texture.
  47033. * @param texture defines the texture we are trying to upload the information to
  47034. * @param info defines the environment texture info retrieved through the GetEnvInfo method
  47035. */
  47036. static UploadEnvSpherical(texture: InternalTexture, info: EnvironmentTextureInfo): void;
  47037. /** @hidden */
  47038. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  47039. }
  47040. }
  47041. declare module "babylonjs/Maths/math.vertexFormat" {
  47042. import { Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  47043. /**
  47044. * Contains position and normal vectors for a vertex
  47045. */
  47046. export class PositionNormalVertex {
  47047. /** the position of the vertex (defaut: 0,0,0) */
  47048. position: Vector3;
  47049. /** the normal of the vertex (defaut: 0,1,0) */
  47050. normal: Vector3;
  47051. /**
  47052. * Creates a PositionNormalVertex
  47053. * @param position the position of the vertex (defaut: 0,0,0)
  47054. * @param normal the normal of the vertex (defaut: 0,1,0)
  47055. */
  47056. constructor(
  47057. /** the position of the vertex (defaut: 0,0,0) */
  47058. position?: Vector3,
  47059. /** the normal of the vertex (defaut: 0,1,0) */
  47060. normal?: Vector3);
  47061. /**
  47062. * Clones the PositionNormalVertex
  47063. * @returns the cloned PositionNormalVertex
  47064. */
  47065. clone(): PositionNormalVertex;
  47066. }
  47067. /**
  47068. * Contains position, normal and uv vectors for a vertex
  47069. */
  47070. export class PositionNormalTextureVertex {
  47071. /** the position of the vertex (defaut: 0,0,0) */
  47072. position: Vector3;
  47073. /** the normal of the vertex (defaut: 0,1,0) */
  47074. normal: Vector3;
  47075. /** the uv of the vertex (default: 0,0) */
  47076. uv: Vector2;
  47077. /**
  47078. * Creates a PositionNormalTextureVertex
  47079. * @param position the position of the vertex (defaut: 0,0,0)
  47080. * @param normal the normal of the vertex (defaut: 0,1,0)
  47081. * @param uv the uv of the vertex (default: 0,0)
  47082. */
  47083. constructor(
  47084. /** the position of the vertex (defaut: 0,0,0) */
  47085. position?: Vector3,
  47086. /** the normal of the vertex (defaut: 0,1,0) */
  47087. normal?: Vector3,
  47088. /** the uv of the vertex (default: 0,0) */
  47089. uv?: Vector2);
  47090. /**
  47091. * Clones the PositionNormalTextureVertex
  47092. * @returns the cloned PositionNormalTextureVertex
  47093. */
  47094. clone(): PositionNormalTextureVertex;
  47095. }
  47096. }
  47097. declare module "babylonjs/Maths/math" {
  47098. export * from "babylonjs/Maths/math.axis";
  47099. export * from "babylonjs/Maths/math.color";
  47100. export * from "babylonjs/Maths/math.constants";
  47101. export * from "babylonjs/Maths/math.frustum";
  47102. export * from "babylonjs/Maths/math.path";
  47103. export * from "babylonjs/Maths/math.plane";
  47104. export * from "babylonjs/Maths/math.size";
  47105. export * from "babylonjs/Maths/math.vector";
  47106. export * from "babylonjs/Maths/math.vertexFormat";
  47107. export * from "babylonjs/Maths/math.viewport";
  47108. }
  47109. declare module "babylonjs/Engines/Native/nativeShaderProcessor" {
  47110. import { WebGL2ShaderProcessor } from "babylonjs/Engines/WebGL/webGL2ShaderProcessors";
  47111. /** @hidden */
  47112. export class NativeShaderProcessor extends WebGL2ShaderProcessor {
  47113. private _genericAttributeLocation;
  47114. private _varyingLocationCount;
  47115. private _varyingLocationMap;
  47116. private _replacements;
  47117. private _textureCount;
  47118. private _uniforms;
  47119. lineProcessor(line: string): string;
  47120. attributeProcessor(attribute: string): string;
  47121. varyingProcessor(varying: string, isFragment: boolean): string;
  47122. uniformProcessor(uniform: string): string;
  47123. preProcessor(code: string, defines: string[], isFragment: boolean): string;
  47124. postProcessor(code: string, defines: string[], isFragment: boolean): string;
  47125. }
  47126. }
  47127. declare module "babylonjs/Engines/nativeEngine" {
  47128. import { Nullable, IndicesArray, DataArray } from "babylonjs/types";
  47129. import { Engine } from "babylonjs/Engines/engine";
  47130. import { VertexBuffer } from "babylonjs/Meshes/buffer";
  47131. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  47132. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  47133. import { Effect } from "babylonjs/Materials/effect";
  47134. import { DataBuffer } from "babylonjs/Meshes/dataBuffer";
  47135. import { Matrix, Viewport, Color3 } from "babylonjs/Maths/math";
  47136. import { IColor4Like } from "babylonjs/Maths/math.like";
  47137. import { Scene } from "babylonjs/scene";
  47138. import { RenderTargetCreationOptions } from "babylonjs/Materials/Textures/renderTargetCreationOptions";
  47139. import { IPipelineContext } from "babylonjs/Engines/IPipelineContext";
  47140. /**
  47141. * Container for accessors for natively-stored mesh data buffers.
  47142. */
  47143. class NativeDataBuffer extends DataBuffer {
  47144. /**
  47145. * Accessor value used to identify/retrieve a natively-stored index buffer.
  47146. */
  47147. nativeIndexBuffer?: any;
  47148. /**
  47149. * Accessor value used to identify/retrieve a natively-stored vertex buffer.
  47150. */
  47151. nativeVertexBuffer?: any;
  47152. }
  47153. /** @hidden */
  47154. class NativeTexture extends InternalTexture {
  47155. getInternalTexture(): InternalTexture;
  47156. getViewCount(): number;
  47157. }
  47158. /** @hidden */
  47159. export class NativeEngine extends Engine {
  47160. private readonly _native;
  47161. /** Defines the invalid handle returned by bgfx when resource creation goes wrong */
  47162. private readonly INVALID_HANDLE;
  47163. getHardwareScalingLevel(): number;
  47164. constructor();
  47165. /**
  47166. * Can be used to override the current requestAnimationFrame requester.
  47167. * @hidden
  47168. */
  47169. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  47170. /**
  47171. * Override default engine behavior.
  47172. * @param color
  47173. * @param backBuffer
  47174. * @param depth
  47175. * @param stencil
  47176. */
  47177. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  47178. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  47179. createIndexBuffer(indices: IndicesArray): NativeDataBuffer;
  47180. createVertexBuffer(data: DataArray): NativeDataBuffer;
  47181. recordVertexArrayObject(vertexBuffers: {
  47182. [key: string]: VertexBuffer;
  47183. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): WebGLVertexArrayObject;
  47184. bindVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  47185. releaseVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  47186. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  47187. /**
  47188. * Draw a list of indexed primitives
  47189. * @param fillMode defines the primitive to use
  47190. * @param indexStart defines the starting index
  47191. * @param indexCount defines the number of index to draw
  47192. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  47193. */
  47194. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  47195. /**
  47196. * Draw a list of unindexed primitives
  47197. * @param fillMode defines the primitive to use
  47198. * @param verticesStart defines the index of first vertex to draw
  47199. * @param verticesCount defines the count of vertices to draw
  47200. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  47201. */
  47202. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  47203. createPipelineContext(): IPipelineContext;
  47204. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  47205. /** @hidden */
  47206. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  47207. /** @hidden */
  47208. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  47209. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  47210. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  47211. protected _setProgram(program: WebGLProgram): void;
  47212. _releaseEffect(effect: Effect): void;
  47213. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  47214. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): WebGLUniformLocation[];
  47215. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  47216. bindSamplers(effect: Effect): void;
  47217. setMatrix(uniform: WebGLUniformLocation, matrix: Matrix): void;
  47218. getRenderWidth(useScreen?: boolean): number;
  47219. getRenderHeight(useScreen?: boolean): number;
  47220. setViewport(viewport: Viewport, requiredWidth?: number, requiredHeight?: number): void;
  47221. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  47222. /**
  47223. * Set the z offset to apply to current rendering
  47224. * @param value defines the offset to apply
  47225. */
  47226. setZOffset(value: number): void;
  47227. /**
  47228. * Gets the current value of the zOffset
  47229. * @returns the current zOffset state
  47230. */
  47231. getZOffset(): number;
  47232. /**
  47233. * Enable or disable depth buffering
  47234. * @param enable defines the state to set
  47235. */
  47236. setDepthBuffer(enable: boolean): void;
  47237. /**
  47238. * Gets a boolean indicating if depth writing is enabled
  47239. * @returns the current depth writing state
  47240. */
  47241. getDepthWrite(): boolean;
  47242. /**
  47243. * Enable or disable depth writing
  47244. * @param enable defines the state to set
  47245. */
  47246. setDepthWrite(enable: boolean): void;
  47247. /**
  47248. * Enable or disable color writing
  47249. * @param enable defines the state to set
  47250. */
  47251. setColorWrite(enable: boolean): void;
  47252. /**
  47253. * Gets a boolean indicating if color writing is enabled
  47254. * @returns the current color writing state
  47255. */
  47256. getColorWrite(): boolean;
  47257. /**
  47258. * Sets alpha constants used by some alpha blending modes
  47259. * @param r defines the red component
  47260. * @param g defines the green component
  47261. * @param b defines the blue component
  47262. * @param a defines the alpha component
  47263. */
  47264. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  47265. /**
  47266. * Sets the current alpha mode
  47267. * @param mode defines the mode to use (one of the BABYLON.Constants.ALPHA_XXX)
  47268. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  47269. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  47270. */
  47271. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  47272. /**
  47273. * Gets the current alpha mode
  47274. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  47275. * @returns the current alpha mode
  47276. */
  47277. getAlphaMode(): number;
  47278. setInt(uniform: WebGLUniformLocation, int: number): void;
  47279. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  47280. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  47281. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  47282. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  47283. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  47284. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  47285. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  47286. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  47287. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  47288. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  47289. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  47290. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  47291. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  47292. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  47293. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  47294. setFloat(uniform: WebGLUniformLocation, value: number): void;
  47295. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  47296. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  47297. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  47298. setColor3(uniform: WebGLUniformLocation, color3: Color3): void;
  47299. setColor4(uniform: WebGLUniformLocation, color3: Color3, alpha: number): void;
  47300. wipeCaches(bruteForce?: boolean): void;
  47301. _createTexture(): WebGLTexture;
  47302. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  47303. /**
  47304. * Usually called from BABYLON.Texture.ts.
  47305. * Passed information to create a WebGLTexture
  47306. * @param urlArg defines a value which contains one of the following:
  47307. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  47308. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  47309. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  47310. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  47311. * @param invertY when true, image is flipped when loaded. You probably want true. Ignored for compressed textures. Must be flipped in the file
  47312. * @param scene needed for loading to the correct scene
  47313. * @param samplingMode mode with should be used sample / access the texture (Default: BABYLON.Texture.TRILINEAR_SAMPLINGMODE)
  47314. * @param onLoad optional callback to be called upon successful completion
  47315. * @param onError optional callback to be called upon failure
  47316. * @param buffer a source of a file previously fetched as either a base64 string, an ArrayBuffer (compressed or image format), or a Blob
  47317. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  47318. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  47319. * @param forcedExtension defines the extension to use to pick the right loader
  47320. * @returns a InternalTexture for assignment back into BABYLON.Texture
  47321. */
  47322. 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;
  47323. /**
  47324. * Creates a cube texture
  47325. * @param rootUrl defines the url where the files to load is located
  47326. * @param scene defines the current scene
  47327. * @param files defines the list of files to load (1 per face)
  47328. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  47329. * @param onLoad defines an optional callback raised when the texture is loaded
  47330. * @param onError defines an optional callback raised if there is an issue to load the texture
  47331. * @param format defines the format of the data
  47332. * @param forcedExtension defines the extension to use to pick the right loader
  47333. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  47334. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  47335. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  47336. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  47337. * @returns the cube texture as an InternalTexture
  47338. */
  47339. 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;
  47340. private _getSamplingFilter;
  47341. private static _GetNativeTextureFormat;
  47342. createRenderTargetTexture(size: number | {
  47343. width: number;
  47344. height: number;
  47345. }, options: boolean | RenderTargetCreationOptions): NativeTexture;
  47346. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  47347. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  47348. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  47349. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  47350. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  47351. /**
  47352. * Updates a dynamic vertex buffer.
  47353. * @param vertexBuffer the vertex buffer to update
  47354. * @param data the data used to update the vertex buffer
  47355. * @param byteOffset the byte offset of the data (optional)
  47356. * @param byteLength the byte length of the data (optional)
  47357. */
  47358. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  47359. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  47360. private _updateAnisotropicLevel;
  47361. private _getAddressMode;
  47362. /** @hidden */
  47363. _bindTexture(channel: number, texture: InternalTexture): void;
  47364. protected _deleteBuffer(buffer: NativeDataBuffer): void;
  47365. releaseEffects(): void;
  47366. /** @hidden */
  47367. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  47368. /** @hidden */
  47369. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  47370. /** @hidden */
  47371. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  47372. /** @hidden */
  47373. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  47374. }
  47375. }
  47376. declare module "babylonjs/Engines/index" {
  47377. export * from "babylonjs/Engines/constants";
  47378. export * from "babylonjs/Engines/engineCapabilities";
  47379. export * from "babylonjs/Engines/instancingAttributeInfo";
  47380. export * from "babylonjs/Engines/thinEngine";
  47381. export * from "babylonjs/Engines/engine";
  47382. export * from "babylonjs/Engines/engineStore";
  47383. export * from "babylonjs/Engines/nullEngine";
  47384. export * from "babylonjs/Engines/Extensions/index";
  47385. export * from "babylonjs/Engines/IPipelineContext";
  47386. export * from "babylonjs/Engines/WebGL/webGLPipelineContext";
  47387. export * from "babylonjs/Engines/WebGL/webGL2ShaderProcessors";
  47388. export * from "babylonjs/Engines/nativeEngine";
  47389. }
  47390. declare module "babylonjs/Events/clipboardEvents" {
  47391. /**
  47392. * Gather the list of clipboard event types as constants.
  47393. */
  47394. export class ClipboardEventTypes {
  47395. /**
  47396. * The clipboard event is fired when a copy command is active (pressed).
  47397. */
  47398. static readonly COPY: number;
  47399. /**
  47400. * The clipboard event is fired when a cut command is active (pressed).
  47401. */
  47402. static readonly CUT: number;
  47403. /**
  47404. * The clipboard event is fired when a paste command is active (pressed).
  47405. */
  47406. static readonly PASTE: number;
  47407. }
  47408. /**
  47409. * This class is used to store clipboard related info for the onClipboardObservable event.
  47410. */
  47411. export class ClipboardInfo {
  47412. /**
  47413. * Defines the type of event (BABYLON.ClipboardEventTypes)
  47414. */
  47415. type: number;
  47416. /**
  47417. * Defines the related dom event
  47418. */
  47419. event: ClipboardEvent;
  47420. /**
  47421. *Creates an instance of ClipboardInfo.
  47422. * @param type Defines the type of event (BABYLON.ClipboardEventTypes)
  47423. * @param event Defines the related dom event
  47424. */
  47425. constructor(
  47426. /**
  47427. * Defines the type of event (BABYLON.ClipboardEventTypes)
  47428. */
  47429. type: number,
  47430. /**
  47431. * Defines the related dom event
  47432. */
  47433. event: ClipboardEvent);
  47434. /**
  47435. * Get the clipboard event's type from the keycode.
  47436. * @param keyCode Defines the keyCode for the current keyboard event.
  47437. * @return {number}
  47438. */
  47439. static GetTypeFromCharacter(keyCode: number): number;
  47440. }
  47441. }
  47442. declare module "babylonjs/Events/index" {
  47443. export * from "babylonjs/Events/keyboardEvents";
  47444. export * from "babylonjs/Events/pointerEvents";
  47445. export * from "babylonjs/Events/clipboardEvents";
  47446. }
  47447. declare module "babylonjs/Gamepads/Controllers/daydreamController" {
  47448. import { Scene } from "babylonjs/scene";
  47449. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  47450. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  47451. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  47452. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  47453. /**
  47454. * Google Daydream controller
  47455. */
  47456. export class DaydreamController extends WebVRController {
  47457. /**
  47458. * Base Url for the controller model.
  47459. */
  47460. static MODEL_BASE_URL: string;
  47461. /**
  47462. * File name for the controller model.
  47463. */
  47464. static MODEL_FILENAME: string;
  47465. /**
  47466. * Gamepad Id prefix used to identify Daydream Controller.
  47467. */
  47468. static readonly GAMEPAD_ID_PREFIX: string;
  47469. /**
  47470. * Creates a new DaydreamController from a gamepad
  47471. * @param vrGamepad the gamepad that the controller should be created from
  47472. */
  47473. constructor(vrGamepad: any);
  47474. /**
  47475. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  47476. * @param scene scene in which to add meshes
  47477. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  47478. */
  47479. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  47480. /**
  47481. * Called once for each button that changed state since the last frame
  47482. * @param buttonIdx Which button index changed
  47483. * @param state New state of the button
  47484. * @param changes Which properties on the state changed since last frame
  47485. */
  47486. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  47487. }
  47488. }
  47489. declare module "babylonjs/Gamepads/Controllers/gearVRController" {
  47490. import { Scene } from "babylonjs/scene";
  47491. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  47492. import { GamepadButtonChanges } from "babylonjs/Gamepads/gamepad";
  47493. import { WebVRController } from "babylonjs/Gamepads/Controllers/webVRController";
  47494. import { ExtendedGamepadButton } from "babylonjs/Gamepads/Controllers/poseEnabledController";
  47495. /**
  47496. * Gear VR Controller
  47497. */
  47498. export class GearVRController extends WebVRController {
  47499. /**
  47500. * Base Url for the controller model.
  47501. */
  47502. static MODEL_BASE_URL: string;
  47503. /**
  47504. * File name for the controller model.
  47505. */
  47506. static MODEL_FILENAME: string;
  47507. /**
  47508. * Gamepad Id prefix used to identify this controller.
  47509. */
  47510. static readonly GAMEPAD_ID_PREFIX: string;
  47511. private readonly _buttonIndexToObservableNameMap;
  47512. /**
  47513. * Creates a new GearVRController from a gamepad
  47514. * @param vrGamepad the gamepad that the controller should be created from
  47515. */
  47516. constructor(vrGamepad: any);
  47517. /**
  47518. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  47519. * @param scene scene in which to add meshes
  47520. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  47521. */
  47522. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  47523. /**
  47524. * Called once for each button that changed state since the last frame
  47525. * @param buttonIdx Which button index changed
  47526. * @param state New state of the button
  47527. * @param changes Which properties on the state changed since last frame
  47528. */
  47529. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  47530. }
  47531. }
  47532. declare module "babylonjs/Gamepads/Controllers/index" {
  47533. export * from "babylonjs/Gamepads/Controllers/daydreamController";
  47534. export * from "babylonjs/Gamepads/Controllers/gearVRController";
  47535. export * from "babylonjs/Gamepads/Controllers/genericController";
  47536. export * from "babylonjs/Gamepads/Controllers/oculusTouchController";
  47537. export * from "babylonjs/Gamepads/Controllers/poseEnabledController";
  47538. export * from "babylonjs/Gamepads/Controllers/viveController";
  47539. export * from "babylonjs/Gamepads/Controllers/webVRController";
  47540. export * from "babylonjs/Gamepads/Controllers/windowsMotionController";
  47541. }
  47542. declare module "babylonjs/Gamepads/index" {
  47543. export * from "babylonjs/Gamepads/Controllers/index";
  47544. export * from "babylonjs/Gamepads/gamepad";
  47545. export * from "babylonjs/Gamepads/gamepadManager";
  47546. export * from "babylonjs/Gamepads/gamepadSceneComponent";
  47547. export * from "babylonjs/Gamepads/xboxGamepad";
  47548. export * from "babylonjs/Gamepads/dualShockGamepad";
  47549. }
  47550. declare module "babylonjs/Meshes/Builders/polyhedronBuilder" {
  47551. import { Scene } from "babylonjs/scene";
  47552. import { Vector4 } from "babylonjs/Maths/math.vector";
  47553. import { Color4 } from "babylonjs/Maths/math.color";
  47554. import { Mesh } from "babylonjs/Meshes/mesh";
  47555. import { Nullable } from "babylonjs/types";
  47556. /**
  47557. * Class containing static functions to help procedurally build meshes
  47558. */
  47559. export class PolyhedronBuilder {
  47560. /**
  47561. * Creates a polyhedron mesh
  47562. * * 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
  47563. * * The parameter `size` (positive float, default 1) sets the polygon size
  47564. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  47565. * * 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`
  47566. * * 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
  47567. * * 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)`)
  47568. * * 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
  47569. * * 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
  47570. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  47571. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  47572. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  47573. * @param name defines the name of the mesh
  47574. * @param options defines the options used to create the mesh
  47575. * @param scene defines the hosting scene
  47576. * @returns the polyhedron mesh
  47577. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  47578. */
  47579. static CreatePolyhedron(name: string, options: {
  47580. type?: number;
  47581. size?: number;
  47582. sizeX?: number;
  47583. sizeY?: number;
  47584. sizeZ?: number;
  47585. custom?: any;
  47586. faceUV?: Vector4[];
  47587. faceColors?: Color4[];
  47588. flat?: boolean;
  47589. updatable?: boolean;
  47590. sideOrientation?: number;
  47591. frontUVs?: Vector4;
  47592. backUVs?: Vector4;
  47593. }, scene?: Nullable<Scene>): Mesh;
  47594. }
  47595. }
  47596. declare module "babylonjs/Gizmos/scaleGizmo" {
  47597. import { Observable } from "babylonjs/Misc/observable";
  47598. import { Nullable } from "babylonjs/types";
  47599. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  47600. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  47601. import { AxisScaleGizmo } from "babylonjs/Gizmos/axisScaleGizmo";
  47602. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  47603. /**
  47604. * Gizmo that enables scaling a mesh along 3 axis
  47605. */
  47606. export class ScaleGizmo extends Gizmo {
  47607. /**
  47608. * Internal gizmo used for interactions on the x axis
  47609. */
  47610. xGizmo: AxisScaleGizmo;
  47611. /**
  47612. * Internal gizmo used for interactions on the y axis
  47613. */
  47614. yGizmo: AxisScaleGizmo;
  47615. /**
  47616. * Internal gizmo used for interactions on the z axis
  47617. */
  47618. zGizmo: AxisScaleGizmo;
  47619. /**
  47620. * Internal gizmo used to scale all axis equally
  47621. */
  47622. uniformScaleGizmo: AxisScaleGizmo;
  47623. private _meshAttached;
  47624. private _updateGizmoRotationToMatchAttachedMesh;
  47625. private _snapDistance;
  47626. private _scaleRatio;
  47627. private _uniformScalingMesh;
  47628. private _octahedron;
  47629. private _sensitivity;
  47630. /** Fires an event when any of it's sub gizmos are dragged */
  47631. onDragStartObservable: Observable<unknown>;
  47632. /** Fires an event when any of it's sub gizmos are released from dragging */
  47633. onDragEndObservable: Observable<unknown>;
  47634. attachedMesh: Nullable<AbstractMesh>;
  47635. /**
  47636. * Creates a ScaleGizmo
  47637. * @param gizmoLayer The utility layer the gizmo will be added to
  47638. */
  47639. constructor(gizmoLayer?: UtilityLayerRenderer);
  47640. updateGizmoRotationToMatchAttachedMesh: boolean;
  47641. /**
  47642. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  47643. */
  47644. snapDistance: number;
  47645. /**
  47646. * Ratio for the scale of the gizmo (Default: 1)
  47647. */
  47648. scaleRatio: number;
  47649. /**
  47650. * Sensitivity factor for dragging (Default: 1)
  47651. */
  47652. sensitivity: number;
  47653. /**
  47654. * Disposes of the gizmo
  47655. */
  47656. dispose(): void;
  47657. }
  47658. }
  47659. declare module "babylonjs/Gizmos/axisScaleGizmo" {
  47660. import { Observable } from "babylonjs/Misc/observable";
  47661. import { Nullable } from "babylonjs/types";
  47662. import { Vector3 } from "babylonjs/Maths/math.vector";
  47663. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  47664. import { Mesh } from "babylonjs/Meshes/mesh";
  47665. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  47666. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  47667. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  47668. import { ScaleGizmo } from "babylonjs/Gizmos/scaleGizmo";
  47669. import { Color3 } from "babylonjs/Maths/math.color";
  47670. /**
  47671. * Single axis scale gizmo
  47672. */
  47673. export class AxisScaleGizmo extends Gizmo {
  47674. /**
  47675. * Drag behavior responsible for the gizmos dragging interactions
  47676. */
  47677. dragBehavior: PointerDragBehavior;
  47678. private _pointerObserver;
  47679. /**
  47680. * Scale distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  47681. */
  47682. snapDistance: number;
  47683. /**
  47684. * Event that fires each time the gizmo snaps to a new location.
  47685. * * snapDistance is the the change in distance
  47686. */
  47687. onSnapObservable: Observable<{
  47688. snapDistance: number;
  47689. }>;
  47690. /**
  47691. * If the scaling operation should be done on all axis (default: false)
  47692. */
  47693. uniformScaling: boolean;
  47694. /**
  47695. * Custom sensitivity value for the drag strength
  47696. */
  47697. sensitivity: number;
  47698. private _isEnabled;
  47699. private _parent;
  47700. private _arrow;
  47701. private _coloredMaterial;
  47702. private _hoverMaterial;
  47703. /**
  47704. * Creates an AxisScaleGizmo
  47705. * @param gizmoLayer The utility layer the gizmo will be added to
  47706. * @param dragAxis The axis which the gizmo will be able to scale on
  47707. * @param color The color of the gizmo
  47708. */
  47709. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<ScaleGizmo>);
  47710. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  47711. /**
  47712. * If the gizmo is enabled
  47713. */
  47714. isEnabled: boolean;
  47715. /**
  47716. * Disposes of the gizmo
  47717. */
  47718. dispose(): void;
  47719. /**
  47720. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  47721. * @param mesh The mesh to replace the default mesh of the gizmo
  47722. * @param useGizmoMaterial If the gizmo's default material should be used (default: false)
  47723. */
  47724. setCustomMesh(mesh: Mesh, useGizmoMaterial?: boolean): void;
  47725. }
  47726. }
  47727. declare module "babylonjs/Gizmos/boundingBoxGizmo" {
  47728. import { Observable } from "babylonjs/Misc/observable";
  47729. import { Nullable } from "babylonjs/types";
  47730. import { Vector3 } from "babylonjs/Maths/math.vector";
  47731. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  47732. import { Mesh } from "babylonjs/Meshes/mesh";
  47733. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  47734. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  47735. import { Color3 } from "babylonjs/Maths/math.color";
  47736. import "babylonjs/Meshes/Builders/boxBuilder";
  47737. /**
  47738. * Bounding box gizmo
  47739. */
  47740. export class BoundingBoxGizmo extends Gizmo {
  47741. private _lineBoundingBox;
  47742. private _rotateSpheresParent;
  47743. private _scaleBoxesParent;
  47744. private _boundingDimensions;
  47745. private _renderObserver;
  47746. private _pointerObserver;
  47747. private _scaleDragSpeed;
  47748. private _tmpQuaternion;
  47749. private _tmpVector;
  47750. private _tmpRotationMatrix;
  47751. /**
  47752. * 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)
  47753. */
  47754. ignoreChildren: boolean;
  47755. /**
  47756. * 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)
  47757. */
  47758. includeChildPredicate: Nullable<(abstractMesh: AbstractMesh) => boolean>;
  47759. /**
  47760. * The size of the rotation spheres attached to the bounding box (Default: 0.1)
  47761. */
  47762. rotationSphereSize: number;
  47763. /**
  47764. * The size of the scale boxes attached to the bounding box (Default: 0.1)
  47765. */
  47766. scaleBoxSize: number;
  47767. /**
  47768. * 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)
  47769. */
  47770. fixedDragMeshScreenSize: boolean;
  47771. /**
  47772. * The distance away from the object which the draggable meshes should appear world sized when fixedDragMeshScreenSize is set to true (default: 10)
  47773. */
  47774. fixedDragMeshScreenSizeDistanceFactor: number;
  47775. /**
  47776. * Fired when a rotation sphere or scale box is dragged
  47777. */
  47778. onDragStartObservable: Observable<{}>;
  47779. /**
  47780. * Fired when a scale box is dragged
  47781. */
  47782. onScaleBoxDragObservable: Observable<{}>;
  47783. /**
  47784. * Fired when a scale box drag is ended
  47785. */
  47786. onScaleBoxDragEndObservable: Observable<{}>;
  47787. /**
  47788. * Fired when a rotation sphere is dragged
  47789. */
  47790. onRotationSphereDragObservable: Observable<{}>;
  47791. /**
  47792. * Fired when a rotation sphere drag is ended
  47793. */
  47794. onRotationSphereDragEndObservable: Observable<{}>;
  47795. /**
  47796. * 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)
  47797. */
  47798. scalePivot: Nullable<Vector3>;
  47799. /**
  47800. * Mesh used as a pivot to rotate the attached mesh
  47801. */
  47802. private _anchorMesh;
  47803. private _existingMeshScale;
  47804. private _dragMesh;
  47805. private pointerDragBehavior;
  47806. private coloredMaterial;
  47807. private hoverColoredMaterial;
  47808. /**
  47809. * Sets the color of the bounding box gizmo
  47810. * @param color the color to set
  47811. */
  47812. setColor(color: Color3): void;
  47813. /**
  47814. * Creates an BoundingBoxGizmo
  47815. * @param gizmoLayer The utility layer the gizmo will be added to
  47816. * @param color The color of the gizmo
  47817. */
  47818. constructor(color?: Color3, gizmoLayer?: UtilityLayerRenderer);
  47819. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  47820. private _selectNode;
  47821. /**
  47822. * Updates the bounding box information for the Gizmo
  47823. */
  47824. updateBoundingBox(): void;
  47825. private _updateRotationSpheres;
  47826. private _updateScaleBoxes;
  47827. /**
  47828. * Enables rotation on the specified axis and disables rotation on the others
  47829. * @param axis The list of axis that should be enabled (eg. "xy" or "xyz")
  47830. */
  47831. setEnabledRotationAxis(axis: string): void;
  47832. /**
  47833. * Enables/disables scaling
  47834. * @param enable if scaling should be enabled
  47835. */
  47836. setEnabledScaling(enable: boolean): void;
  47837. private _updateDummy;
  47838. /**
  47839. * Enables a pointer drag behavior on the bounding box of the gizmo
  47840. */
  47841. enableDragBehavior(): void;
  47842. /**
  47843. * Disposes of the gizmo
  47844. */
  47845. dispose(): void;
  47846. /**
  47847. * 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)
  47848. * @param mesh the mesh to wrap in the bounding box mesh and make not pickable
  47849. * @returns the bounding box mesh with the passed in mesh as a child
  47850. */
  47851. static MakeNotPickableAndWrapInBoundingBox(mesh: Mesh): Mesh;
  47852. /**
  47853. * CustomMeshes are not supported by this gizmo
  47854. * @param mesh The mesh to replace the default mesh of the gizmo
  47855. */
  47856. setCustomMesh(mesh: Mesh): void;
  47857. }
  47858. }
  47859. declare module "babylonjs/Gizmos/planeRotationGizmo" {
  47860. import { Observable } from "babylonjs/Misc/observable";
  47861. import { Nullable } from "babylonjs/types";
  47862. import { Vector3 } from "babylonjs/Maths/math.vector";
  47863. import { Color3 } from "babylonjs/Maths/math.color";
  47864. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  47865. import { PointerDragBehavior } from "babylonjs/Behaviors/Meshes/pointerDragBehavior";
  47866. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  47867. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  47868. import "babylonjs/Meshes/Builders/linesBuilder";
  47869. import { RotationGizmo } from "babylonjs/Gizmos/rotationGizmo";
  47870. /**
  47871. * Single plane rotation gizmo
  47872. */
  47873. export class PlaneRotationGizmo extends Gizmo {
  47874. /**
  47875. * Drag behavior responsible for the gizmos dragging interactions
  47876. */
  47877. dragBehavior: PointerDragBehavior;
  47878. private _pointerObserver;
  47879. /**
  47880. * Rotation distance in radians that the gizmo will snap to (Default: 0)
  47881. */
  47882. snapDistance: number;
  47883. /**
  47884. * Event that fires each time the gizmo snaps to a new location.
  47885. * * snapDistance is the the change in distance
  47886. */
  47887. onSnapObservable: Observable<{
  47888. snapDistance: number;
  47889. }>;
  47890. private _isEnabled;
  47891. private _parent;
  47892. /**
  47893. * Creates a PlaneRotationGizmo
  47894. * @param gizmoLayer The utility layer the gizmo will be added to
  47895. * @param planeNormal The normal of the plane which the gizmo will be able to rotate on
  47896. * @param color The color of the gizmo
  47897. * @param tessellation Amount of tessellation to be used when creating rotation circles
  47898. * @param useEulerRotation Use and update Euler angle instead of quaternion
  47899. */
  47900. constructor(planeNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, tessellation?: number, parent?: Nullable<RotationGizmo>, useEulerRotation?: boolean);
  47901. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  47902. /**
  47903. * If the gizmo is enabled
  47904. */
  47905. isEnabled: boolean;
  47906. /**
  47907. * Disposes of the gizmo
  47908. */
  47909. dispose(): void;
  47910. }
  47911. }
  47912. declare module "babylonjs/Gizmos/rotationGizmo" {
  47913. import { Observable } from "babylonjs/Misc/observable";
  47914. import { Nullable } from "babylonjs/types";
  47915. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  47916. import { Mesh } from "babylonjs/Meshes/mesh";
  47917. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  47918. import { PlaneRotationGizmo } from "babylonjs/Gizmos/planeRotationGizmo";
  47919. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  47920. /**
  47921. * Gizmo that enables rotating a mesh along 3 axis
  47922. */
  47923. export class RotationGizmo extends Gizmo {
  47924. /**
  47925. * Internal gizmo used for interactions on the x axis
  47926. */
  47927. xGizmo: PlaneRotationGizmo;
  47928. /**
  47929. * Internal gizmo used for interactions on the y axis
  47930. */
  47931. yGizmo: PlaneRotationGizmo;
  47932. /**
  47933. * Internal gizmo used for interactions on the z axis
  47934. */
  47935. zGizmo: PlaneRotationGizmo;
  47936. /** Fires an event when any of it's sub gizmos are dragged */
  47937. onDragStartObservable: Observable<unknown>;
  47938. /** Fires an event when any of it's sub gizmos are released from dragging */
  47939. onDragEndObservable: Observable<unknown>;
  47940. private _meshAttached;
  47941. attachedMesh: Nullable<AbstractMesh>;
  47942. /**
  47943. * Creates a RotationGizmo
  47944. * @param gizmoLayer The utility layer the gizmo will be added to
  47945. * @param tessellation Amount of tessellation to be used when creating rotation circles
  47946. * @param useEulerRotation Use and update Euler angle instead of quaternion
  47947. */
  47948. constructor(gizmoLayer?: UtilityLayerRenderer, tessellation?: number, useEulerRotation?: boolean);
  47949. updateGizmoRotationToMatchAttachedMesh: boolean;
  47950. /**
  47951. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  47952. */
  47953. snapDistance: number;
  47954. /**
  47955. * Ratio for the scale of the gizmo (Default: 1)
  47956. */
  47957. scaleRatio: number;
  47958. /**
  47959. * Disposes of the gizmo
  47960. */
  47961. dispose(): void;
  47962. /**
  47963. * CustomMeshes are not supported by this gizmo
  47964. * @param mesh The mesh to replace the default mesh of the gizmo
  47965. */
  47966. setCustomMesh(mesh: Mesh): void;
  47967. }
  47968. }
  47969. declare module "babylonjs/Gizmos/gizmoManager" {
  47970. import { Observable } from "babylonjs/Misc/observable";
  47971. import { Nullable } from "babylonjs/types";
  47972. import { Scene, IDisposable } from "babylonjs/scene";
  47973. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  47974. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  47975. import { SixDofDragBehavior } from "babylonjs/Behaviors/Meshes/sixDofDragBehavior";
  47976. import { RotationGizmo } from "babylonjs/Gizmos/rotationGizmo";
  47977. import { PositionGizmo } from "babylonjs/Gizmos/positionGizmo";
  47978. import { ScaleGizmo } from "babylonjs/Gizmos/scaleGizmo";
  47979. import { BoundingBoxGizmo } from "babylonjs/Gizmos/boundingBoxGizmo";
  47980. /**
  47981. * Helps setup gizmo's in the scene to rotate/scale/position meshes
  47982. */
  47983. export class GizmoManager implements IDisposable {
  47984. private scene;
  47985. /**
  47986. * Gizmo's created by the gizmo manager, gizmo will be null until gizmo has been enabled for the first time
  47987. */
  47988. gizmos: {
  47989. positionGizmo: Nullable<PositionGizmo>;
  47990. rotationGizmo: Nullable<RotationGizmo>;
  47991. scaleGizmo: Nullable<ScaleGizmo>;
  47992. boundingBoxGizmo: Nullable<BoundingBoxGizmo>;
  47993. };
  47994. /** When true, the gizmo will be detached from the current object when a pointer down occurs with an empty picked mesh */
  47995. clearGizmoOnEmptyPointerEvent: boolean;
  47996. /** Fires an event when the manager is attached to a mesh */
  47997. onAttachedToMeshObservable: Observable<Nullable<AbstractMesh>>;
  47998. private _gizmosEnabled;
  47999. private _pointerObserver;
  48000. private _attachedMesh;
  48001. private _boundingBoxColor;
  48002. private _defaultUtilityLayer;
  48003. private _defaultKeepDepthUtilityLayer;
  48004. /**
  48005. * When bounding box gizmo is enabled, this can be used to track drag/end events
  48006. */
  48007. boundingBoxDragBehavior: SixDofDragBehavior;
  48008. /**
  48009. * Array of meshes which will have the gizmo attached when a pointer selected them. If null, all meshes are attachable. (Default: null)
  48010. */
  48011. attachableMeshes: Nullable<Array<AbstractMesh>>;
  48012. /**
  48013. * If pointer events should perform attaching/detaching a gizmo, if false this can be done manually via attachToMesh. (Default: true)
  48014. */
  48015. usePointerToAttachGizmos: boolean;
  48016. /**
  48017. * Utility layer that the bounding box gizmo belongs to
  48018. */
  48019. readonly keepDepthUtilityLayer: UtilityLayerRenderer;
  48020. /**
  48021. * Utility layer that all gizmos besides bounding box belong to
  48022. */
  48023. readonly utilityLayer: UtilityLayerRenderer;
  48024. /**
  48025. * Instatiates a gizmo manager
  48026. * @param scene the scene to overlay the gizmos on top of
  48027. */
  48028. constructor(scene: Scene);
  48029. /**
  48030. * Attaches a set of gizmos to the specified mesh
  48031. * @param mesh The mesh the gizmo's should be attached to
  48032. */
  48033. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  48034. /**
  48035. * If the position gizmo is enabled
  48036. */
  48037. positionGizmoEnabled: boolean;
  48038. /**
  48039. * If the rotation gizmo is enabled
  48040. */
  48041. rotationGizmoEnabled: boolean;
  48042. /**
  48043. * If the scale gizmo is enabled
  48044. */
  48045. scaleGizmoEnabled: boolean;
  48046. /**
  48047. * If the boundingBox gizmo is enabled
  48048. */
  48049. boundingBoxGizmoEnabled: boolean;
  48050. /**
  48051. * Disposes of the gizmo manager
  48052. */
  48053. dispose(): void;
  48054. }
  48055. }
  48056. declare module "babylonjs/Lights/directionalLight" {
  48057. import { Camera } from "babylonjs/Cameras/camera";
  48058. import { Scene } from "babylonjs/scene";
  48059. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  48060. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  48061. import { Light } from "babylonjs/Lights/light";
  48062. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  48063. import { Effect } from "babylonjs/Materials/effect";
  48064. /**
  48065. * A directional light is defined by a direction (what a surprise!).
  48066. * The light is emitted from everywhere in the specified direction, and has an infinite range.
  48067. * 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.
  48068. * Documentation: https://doc.babylonjs.com/babylon101/lights
  48069. */
  48070. export class DirectionalLight extends ShadowLight {
  48071. private _shadowFrustumSize;
  48072. /**
  48073. * Fix frustum size for the shadow generation. This is disabled if the value is 0.
  48074. */
  48075. /**
  48076. * Specifies a fix frustum size for the shadow generation.
  48077. */
  48078. shadowFrustumSize: number;
  48079. private _shadowOrthoScale;
  48080. /**
  48081. * Gets the shadow projection scale against the optimal computed one.
  48082. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  48083. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  48084. */
  48085. /**
  48086. * Sets the shadow projection scale against the optimal computed one.
  48087. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  48088. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  48089. */
  48090. shadowOrthoScale: number;
  48091. /**
  48092. * Automatically compute the projection matrix to best fit (including all the casters)
  48093. * on each frame.
  48094. */
  48095. autoUpdateExtends: boolean;
  48096. private _orthoLeft;
  48097. private _orthoRight;
  48098. private _orthoTop;
  48099. private _orthoBottom;
  48100. /**
  48101. * Creates a DirectionalLight object in the scene, oriented towards the passed direction (Vector3).
  48102. * The directional light is emitted from everywhere in the given direction.
  48103. * It can cast shadows.
  48104. * Documentation : https://doc.babylonjs.com/babylon101/lights
  48105. * @param name The friendly name of the light
  48106. * @param direction The direction of the light
  48107. * @param scene The scene the light belongs to
  48108. */
  48109. constructor(name: string, direction: Vector3, scene: Scene);
  48110. /**
  48111. * Returns the string "DirectionalLight".
  48112. * @return The class name
  48113. */
  48114. getClassName(): string;
  48115. /**
  48116. * Returns the integer 1.
  48117. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  48118. */
  48119. getTypeID(): number;
  48120. /**
  48121. * Sets the passed matrix "matrix" as projection matrix for the shadows cast by the light according to the passed view matrix.
  48122. * Returns the DirectionalLight Shadow projection matrix.
  48123. */
  48124. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  48125. /**
  48126. * Sets the passed matrix "matrix" as fixed frustum projection matrix for the shadows cast by the light according to the passed view matrix.
  48127. * Returns the DirectionalLight Shadow projection matrix.
  48128. */
  48129. protected _setDefaultFixedFrustumShadowProjectionMatrix(matrix: Matrix): void;
  48130. /**
  48131. * Sets the passed matrix "matrix" as auto extend projection matrix for the shadows cast by the light according to the passed view matrix.
  48132. * Returns the DirectionalLight Shadow projection matrix.
  48133. */
  48134. protected _setDefaultAutoExtendShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  48135. protected _buildUniformLayout(): void;
  48136. /**
  48137. * Sets the passed Effect object with the DirectionalLight transformed position (or position if not parented) and the passed name.
  48138. * @param effect The effect to update
  48139. * @param lightIndex The index of the light in the effect to update
  48140. * @returns The directional light
  48141. */
  48142. transferToEffect(effect: Effect, lightIndex: string): DirectionalLight;
  48143. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  48144. /**
  48145. * Gets the minZ used for shadow according to both the scene and the light.
  48146. *
  48147. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  48148. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  48149. * @param activeCamera The camera we are returning the min for
  48150. * @returns the depth min z
  48151. */
  48152. getDepthMinZ(activeCamera: Camera): number;
  48153. /**
  48154. * Gets the maxZ used for shadow according to both the scene and the light.
  48155. *
  48156. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  48157. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  48158. * @param activeCamera The camera we are returning the max for
  48159. * @returns the depth max z
  48160. */
  48161. getDepthMaxZ(activeCamera: Camera): number;
  48162. /**
  48163. * Prepares the list of defines specific to the light type.
  48164. * @param defines the list of defines
  48165. * @param lightIndex defines the index of the light for the effect
  48166. */
  48167. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  48168. }
  48169. }
  48170. declare module "babylonjs/Meshes/Builders/hemisphereBuilder" {
  48171. import { Mesh } from "babylonjs/Meshes/mesh";
  48172. /**
  48173. * Class containing static functions to help procedurally build meshes
  48174. */
  48175. export class HemisphereBuilder {
  48176. /**
  48177. * Creates a hemisphere mesh
  48178. * @param name defines the name of the mesh
  48179. * @param options defines the options used to create the mesh
  48180. * @param scene defines the hosting scene
  48181. * @returns the hemisphere mesh
  48182. */
  48183. static CreateHemisphere(name: string, options: {
  48184. segments?: number;
  48185. diameter?: number;
  48186. sideOrientation?: number;
  48187. }, scene: any): Mesh;
  48188. }
  48189. }
  48190. declare module "babylonjs/Lights/spotLight" {
  48191. import { Nullable } from "babylonjs/types";
  48192. import { Scene } from "babylonjs/scene";
  48193. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  48194. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  48195. import { Effect } from "babylonjs/Materials/effect";
  48196. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  48197. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  48198. /**
  48199. * A spot light is defined by a position, a direction, an angle, and an exponent.
  48200. * These values define a cone of light starting from the position, emitting toward the direction.
  48201. * The angle, in radians, defines the size (field of illumination) of the spotlight's conical beam,
  48202. * and the exponent defines the speed of the decay of the light with distance (reach).
  48203. * Documentation: https://doc.babylonjs.com/babylon101/lights
  48204. */
  48205. export class SpotLight extends ShadowLight {
  48206. private _angle;
  48207. private _innerAngle;
  48208. private _cosHalfAngle;
  48209. private _lightAngleScale;
  48210. private _lightAngleOffset;
  48211. /**
  48212. * Gets the cone angle of the spot light in Radians.
  48213. */
  48214. /**
  48215. * Sets the cone angle of the spot light in Radians.
  48216. */
  48217. angle: number;
  48218. /**
  48219. * Only used in gltf falloff mode, this defines the angle where
  48220. * the directional falloff will start before cutting at angle which could be seen
  48221. * as outer angle.
  48222. */
  48223. /**
  48224. * Only used in gltf falloff mode, this defines the angle where
  48225. * the directional falloff will start before cutting at angle which could be seen
  48226. * as outer angle.
  48227. */
  48228. innerAngle: number;
  48229. private _shadowAngleScale;
  48230. /**
  48231. * Allows scaling the angle of the light for shadow generation only.
  48232. */
  48233. /**
  48234. * Allows scaling the angle of the light for shadow generation only.
  48235. */
  48236. shadowAngleScale: number;
  48237. /**
  48238. * The light decay speed with the distance from the emission spot.
  48239. */
  48240. exponent: number;
  48241. private _projectionTextureMatrix;
  48242. /**
  48243. * Allows reading the projecton texture
  48244. */
  48245. readonly projectionTextureMatrix: Matrix;
  48246. protected _projectionTextureLightNear: number;
  48247. /**
  48248. * Gets the near clip of the Spotlight for texture projection.
  48249. */
  48250. /**
  48251. * Sets the near clip of the Spotlight for texture projection.
  48252. */
  48253. projectionTextureLightNear: number;
  48254. protected _projectionTextureLightFar: number;
  48255. /**
  48256. * Gets the far clip of the Spotlight for texture projection.
  48257. */
  48258. /**
  48259. * Sets the far clip of the Spotlight for texture projection.
  48260. */
  48261. projectionTextureLightFar: number;
  48262. protected _projectionTextureUpDirection: Vector3;
  48263. /**
  48264. * Gets the Up vector of the Spotlight for texture projection.
  48265. */
  48266. /**
  48267. * Sets the Up vector of the Spotlight for texture projection.
  48268. */
  48269. projectionTextureUpDirection: Vector3;
  48270. private _projectionTexture;
  48271. /**
  48272. * Gets the projection texture of the light.
  48273. */
  48274. /**
  48275. * Sets the projection texture of the light.
  48276. */
  48277. projectionTexture: Nullable<BaseTexture>;
  48278. private _projectionTextureViewLightDirty;
  48279. private _projectionTextureProjectionLightDirty;
  48280. private _projectionTextureDirty;
  48281. private _projectionTextureViewTargetVector;
  48282. private _projectionTextureViewLightMatrix;
  48283. private _projectionTextureProjectionLightMatrix;
  48284. private _projectionTextureScalingMatrix;
  48285. /**
  48286. * Creates a SpotLight object in the scene. A spot light is a simply light oriented cone.
  48287. * It can cast shadows.
  48288. * Documentation : https://doc.babylonjs.com/babylon101/lights
  48289. * @param name The light friendly name
  48290. * @param position The position of the spot light in the scene
  48291. * @param direction The direction of the light in the scene
  48292. * @param angle The cone angle of the light in Radians
  48293. * @param exponent The light decay speed with the distance from the emission spot
  48294. * @param scene The scene the lights belongs to
  48295. */
  48296. constructor(name: string, position: Vector3, direction: Vector3, angle: number, exponent: number, scene: Scene);
  48297. /**
  48298. * Returns the string "SpotLight".
  48299. * @returns the class name
  48300. */
  48301. getClassName(): string;
  48302. /**
  48303. * Returns the integer 2.
  48304. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  48305. */
  48306. getTypeID(): number;
  48307. /**
  48308. * Overrides the direction setter to recompute the projection texture view light Matrix.
  48309. */
  48310. protected _setDirection(value: Vector3): void;
  48311. /**
  48312. * Overrides the position setter to recompute the projection texture view light Matrix.
  48313. */
  48314. protected _setPosition(value: Vector3): void;
  48315. /**
  48316. * 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.
  48317. * Returns the SpotLight.
  48318. */
  48319. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  48320. protected _computeProjectionTextureViewLightMatrix(): void;
  48321. protected _computeProjectionTextureProjectionLightMatrix(): void;
  48322. /**
  48323. * Main function for light texture projection matrix computing.
  48324. */
  48325. protected _computeProjectionTextureMatrix(): void;
  48326. protected _buildUniformLayout(): void;
  48327. private _computeAngleValues;
  48328. /**
  48329. * Sets the passed Effect object with the SpotLight transfomed position (or position if not parented) and normalized direction.
  48330. * @param effect The effect to update
  48331. * @param lightIndex The index of the light in the effect to update
  48332. * @returns The spot light
  48333. */
  48334. transferToEffect(effect: Effect, lightIndex: string): SpotLight;
  48335. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  48336. /**
  48337. * Disposes the light and the associated resources.
  48338. */
  48339. dispose(): void;
  48340. /**
  48341. * Prepares the list of defines specific to the light type.
  48342. * @param defines the list of defines
  48343. * @param lightIndex defines the index of the light for the effect
  48344. */
  48345. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  48346. }
  48347. }
  48348. declare module "babylonjs/Gizmos/lightGizmo" {
  48349. import { Nullable } from "babylonjs/types";
  48350. import { Gizmo } from "babylonjs/Gizmos/gizmo";
  48351. import { UtilityLayerRenderer } from "babylonjs/Rendering/utilityLayerRenderer";
  48352. import { StandardMaterial } from "babylonjs/Materials/standardMaterial";
  48353. import { Light } from "babylonjs/Lights/light";
  48354. /**
  48355. * Gizmo that enables viewing a light
  48356. */
  48357. export class LightGizmo extends Gizmo {
  48358. private _lightMesh;
  48359. private _material;
  48360. private _cachedPosition;
  48361. private _cachedForward;
  48362. private _attachedMeshParent;
  48363. /**
  48364. * Creates a LightGizmo
  48365. * @param gizmoLayer The utility layer the gizmo will be added to
  48366. */
  48367. constructor(gizmoLayer?: UtilityLayerRenderer);
  48368. private _light;
  48369. /**
  48370. * The light that the gizmo is attached to
  48371. */
  48372. light: Nullable<Light>;
  48373. /**
  48374. * Gets the material used to render the light gizmo
  48375. */
  48376. readonly material: StandardMaterial;
  48377. /**
  48378. * @hidden
  48379. * Updates the gizmo to match the attached mesh's position/rotation
  48380. */
  48381. protected _update(): void;
  48382. private static _Scale;
  48383. /**
  48384. * Creates the lines for a light mesh
  48385. */
  48386. private static _CreateLightLines;
  48387. /**
  48388. * Disposes of the light gizmo
  48389. */
  48390. dispose(): void;
  48391. private static _CreateHemisphericLightMesh;
  48392. private static _CreatePointLightMesh;
  48393. private static _CreateSpotLightMesh;
  48394. private static _CreateDirectionalLightMesh;
  48395. }
  48396. }
  48397. declare module "babylonjs/Gizmos/index" {
  48398. export * from "babylonjs/Gizmos/axisDragGizmo";
  48399. export * from "babylonjs/Gizmos/axisScaleGizmo";
  48400. export * from "babylonjs/Gizmos/boundingBoxGizmo";
  48401. export * from "babylonjs/Gizmos/gizmo";
  48402. export * from "babylonjs/Gizmos/gizmoManager";
  48403. export * from "babylonjs/Gizmos/planeRotationGizmo";
  48404. export * from "babylonjs/Gizmos/positionGizmo";
  48405. export * from "babylonjs/Gizmos/rotationGizmo";
  48406. export * from "babylonjs/Gizmos/scaleGizmo";
  48407. export * from "babylonjs/Gizmos/lightGizmo";
  48408. export * from "babylonjs/Gizmos/planeDragGizmo";
  48409. }
  48410. declare module "babylonjs/Shaders/ShadersInclude/backgroundFragmentDeclaration" {
  48411. /** @hidden */
  48412. export var backgroundFragmentDeclaration: {
  48413. name: string;
  48414. shader: string;
  48415. };
  48416. }
  48417. declare module "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration" {
  48418. /** @hidden */
  48419. export var backgroundUboDeclaration: {
  48420. name: string;
  48421. shader: string;
  48422. };
  48423. }
  48424. declare module "babylonjs/Shaders/background.fragment" {
  48425. import "babylonjs/Shaders/ShadersInclude/backgroundFragmentDeclaration";
  48426. import "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration";
  48427. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  48428. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  48429. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  48430. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  48431. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  48432. import "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions";
  48433. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  48434. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  48435. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  48436. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  48437. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  48438. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  48439. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  48440. /** @hidden */
  48441. export var backgroundPixelShader: {
  48442. name: string;
  48443. shader: string;
  48444. };
  48445. }
  48446. declare module "babylonjs/Shaders/ShadersInclude/backgroundVertexDeclaration" {
  48447. /** @hidden */
  48448. export var backgroundVertexDeclaration: {
  48449. name: string;
  48450. shader: string;
  48451. };
  48452. }
  48453. declare module "babylonjs/Shaders/background.vertex" {
  48454. import "babylonjs/Shaders/ShadersInclude/backgroundVertexDeclaration";
  48455. import "babylonjs/Shaders/ShadersInclude/backgroundUboDeclaration";
  48456. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  48457. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  48458. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  48459. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  48460. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  48461. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  48462. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  48463. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  48464. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  48465. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  48466. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  48467. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  48468. /** @hidden */
  48469. export var backgroundVertexShader: {
  48470. name: string;
  48471. shader: string;
  48472. };
  48473. }
  48474. declare module "babylonjs/Materials/Background/backgroundMaterial" {
  48475. import { Nullable, int, float } from "babylonjs/types";
  48476. import { Scene } from "babylonjs/scene";
  48477. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  48478. import { SubMesh } from "babylonjs/Meshes/subMesh";
  48479. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  48480. import { Mesh } from "babylonjs/Meshes/mesh";
  48481. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  48482. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  48483. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  48484. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  48485. import { IShadowLight } from "babylonjs/Lights/shadowLight";
  48486. import { Color3 } from "babylonjs/Maths/math.color";
  48487. import "babylonjs/Shaders/background.fragment";
  48488. import "babylonjs/Shaders/background.vertex";
  48489. /**
  48490. * Background material used to create an efficient environement around your scene.
  48491. */
  48492. export class BackgroundMaterial extends PushMaterial {
  48493. /**
  48494. * Standard reflectance value at parallel view angle.
  48495. */
  48496. static StandardReflectance0: number;
  48497. /**
  48498. * Standard reflectance value at grazing angle.
  48499. */
  48500. static StandardReflectance90: number;
  48501. protected _primaryColor: Color3;
  48502. /**
  48503. * Key light Color (multiply against the environement texture)
  48504. */
  48505. primaryColor: Color3;
  48506. protected __perceptualColor: Nullable<Color3>;
  48507. /**
  48508. * Experimental Internal Use Only.
  48509. *
  48510. * Key light Color in "perceptual value" meaning the color you would like to see on screen.
  48511. * This acts as a helper to set the primary color to a more "human friendly" value.
  48512. * Conversion to linear space as well as exposure and tone mapping correction will be applied to keep the
  48513. * output color as close as possible from the chosen value.
  48514. * (This does not account for contrast color grading and color curves as they are considered post effect and not directly
  48515. * part of lighting setup.)
  48516. */
  48517. _perceptualColor: Nullable<Color3>;
  48518. protected _primaryColorShadowLevel: float;
  48519. /**
  48520. * Defines the level of the shadows (dark area of the reflection map) in order to help scaling the colors.
  48521. * The color opposite to the primary color is used at the level chosen to define what the black area would look.
  48522. */
  48523. primaryColorShadowLevel: float;
  48524. protected _primaryColorHighlightLevel: float;
  48525. /**
  48526. * Defines the level of the highliights (highlight area of the reflection map) in order to help scaling the colors.
  48527. * The primary color is used at the level chosen to define what the white area would look.
  48528. */
  48529. primaryColorHighlightLevel: float;
  48530. protected _reflectionTexture: Nullable<BaseTexture>;
  48531. /**
  48532. * Reflection Texture used in the material.
  48533. * Should be author in a specific way for the best result (refer to the documentation).
  48534. */
  48535. reflectionTexture: Nullable<BaseTexture>;
  48536. protected _reflectionBlur: float;
  48537. /**
  48538. * Reflection Texture level of blur.
  48539. *
  48540. * Can be use to reuse an existing HDR Texture and target a specific LOD to prevent authoring the
  48541. * texture twice.
  48542. */
  48543. reflectionBlur: float;
  48544. protected _diffuseTexture: Nullable<BaseTexture>;
  48545. /**
  48546. * Diffuse Texture used in the material.
  48547. * Should be author in a specific way for the best result (refer to the documentation).
  48548. */
  48549. diffuseTexture: Nullable<BaseTexture>;
  48550. protected _shadowLights: Nullable<IShadowLight[]>;
  48551. /**
  48552. * Specify the list of lights casting shadow on the material.
  48553. * All scene shadow lights will be included if null.
  48554. */
  48555. shadowLights: Nullable<IShadowLight[]>;
  48556. protected _shadowLevel: float;
  48557. /**
  48558. * Helps adjusting the shadow to a softer level if required.
  48559. * 0 means black shadows and 1 means no shadows.
  48560. */
  48561. shadowLevel: float;
  48562. protected _sceneCenter: Vector3;
  48563. /**
  48564. * In case of opacity Fresnel or reflection falloff, this is use as a scene center.
  48565. * It is usually zero but might be interesting to modify according to your setup.
  48566. */
  48567. sceneCenter: Vector3;
  48568. protected _opacityFresnel: boolean;
  48569. /**
  48570. * This helps specifying that the material is falling off to the sky box at grazing angle.
  48571. * This helps ensuring a nice transition when the camera goes under the ground.
  48572. */
  48573. opacityFresnel: boolean;
  48574. protected _reflectionFresnel: boolean;
  48575. /**
  48576. * This helps specifying that the material is falling off from diffuse to the reflection texture at grazing angle.
  48577. * This helps adding a mirror texture on the ground.
  48578. */
  48579. reflectionFresnel: boolean;
  48580. protected _reflectionFalloffDistance: number;
  48581. /**
  48582. * This helps specifying the falloff radius off the reflection texture from the sceneCenter.
  48583. * This helps adding a nice falloff effect to the reflection if used as a mirror for instance.
  48584. */
  48585. reflectionFalloffDistance: number;
  48586. protected _reflectionAmount: number;
  48587. /**
  48588. * This specifies the weight of the reflection against the background in case of reflection Fresnel.
  48589. */
  48590. reflectionAmount: number;
  48591. protected _reflectionReflectance0: number;
  48592. /**
  48593. * This specifies the weight of the reflection at grazing angle.
  48594. */
  48595. reflectionReflectance0: number;
  48596. protected _reflectionReflectance90: number;
  48597. /**
  48598. * This specifies the weight of the reflection at a perpendicular point of view.
  48599. */
  48600. reflectionReflectance90: number;
  48601. /**
  48602. * Sets the reflection reflectance fresnel values according to the default standard
  48603. * empirically know to work well :-)
  48604. */
  48605. reflectionStandardFresnelWeight: number;
  48606. protected _useRGBColor: boolean;
  48607. /**
  48608. * Helps to directly use the maps channels instead of their level.
  48609. */
  48610. useRGBColor: boolean;
  48611. protected _enableNoise: boolean;
  48612. /**
  48613. * This helps reducing the banding effect that could occur on the background.
  48614. */
  48615. enableNoise: boolean;
  48616. /**
  48617. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  48618. * Best used when trying to implement visual zoom effects like fish-eye or binoculars while not adjusting camera fov.
  48619. * Recommended to be keep at 1.0 except for special cases.
  48620. */
  48621. fovMultiplier: number;
  48622. private _fovMultiplier;
  48623. /**
  48624. * Enable the FOV adjustment feature controlled by fovMultiplier.
  48625. */
  48626. useEquirectangularFOV: boolean;
  48627. private _maxSimultaneousLights;
  48628. /**
  48629. * Number of Simultaneous lights allowed on the material.
  48630. */
  48631. maxSimultaneousLights: int;
  48632. /**
  48633. * Default configuration related to image processing available in the Background Material.
  48634. */
  48635. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  48636. /**
  48637. * Keep track of the image processing observer to allow dispose and replace.
  48638. */
  48639. private _imageProcessingObserver;
  48640. /**
  48641. * Attaches a new image processing configuration to the PBR Material.
  48642. * @param configuration (if null the scene configuration will be use)
  48643. */
  48644. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  48645. /**
  48646. * Gets the image processing configuration used either in this material.
  48647. */
  48648. /**
  48649. * Sets the Default image processing configuration used either in the this material.
  48650. *
  48651. * If sets to null, the scene one is in use.
  48652. */
  48653. imageProcessingConfiguration: Nullable<ImageProcessingConfiguration>;
  48654. /**
  48655. * Gets wether the color curves effect is enabled.
  48656. */
  48657. /**
  48658. * Sets wether the color curves effect is enabled.
  48659. */
  48660. cameraColorCurvesEnabled: boolean;
  48661. /**
  48662. * Gets wether the color grading effect is enabled.
  48663. */
  48664. /**
  48665. * Gets wether the color grading effect is enabled.
  48666. */
  48667. cameraColorGradingEnabled: boolean;
  48668. /**
  48669. * Gets wether tonemapping is enabled or not.
  48670. */
  48671. /**
  48672. * Sets wether tonemapping is enabled or not
  48673. */
  48674. cameraToneMappingEnabled: boolean;
  48675. /**
  48676. * The camera exposure used on this material.
  48677. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  48678. * This corresponds to a photographic exposure.
  48679. */
  48680. /**
  48681. * The camera exposure used on this material.
  48682. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  48683. * This corresponds to a photographic exposure.
  48684. */
  48685. cameraExposure: float;
  48686. /**
  48687. * Gets The camera contrast used on this material.
  48688. */
  48689. /**
  48690. * Sets The camera contrast used on this material.
  48691. */
  48692. cameraContrast: float;
  48693. /**
  48694. * Gets the Color Grading 2D Lookup Texture.
  48695. */
  48696. /**
  48697. * Sets the Color Grading 2D Lookup Texture.
  48698. */
  48699. cameraColorGradingTexture: Nullable<BaseTexture>;
  48700. /**
  48701. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  48702. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  48703. * 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;
  48704. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  48705. */
  48706. /**
  48707. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  48708. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  48709. * 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;
  48710. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  48711. */
  48712. cameraColorCurves: Nullable<ColorCurves>;
  48713. /**
  48714. * Due to a bug in iOS10, video tags (which are using the background material) are in BGR and not RGB.
  48715. * Setting this flag to true (not done automatically!) will convert it back to RGB.
  48716. */
  48717. switchToBGR: boolean;
  48718. private _renderTargets;
  48719. private _reflectionControls;
  48720. private _white;
  48721. private _primaryShadowColor;
  48722. private _primaryHighlightColor;
  48723. /**
  48724. * Instantiates a Background Material in the given scene
  48725. * @param name The friendly name of the material
  48726. * @param scene The scene to add the material to
  48727. */
  48728. constructor(name: string, scene: Scene);
  48729. /**
  48730. * Gets a boolean indicating that current material needs to register RTT
  48731. */
  48732. readonly hasRenderTargetTextures: boolean;
  48733. /**
  48734. * The entire material has been created in order to prevent overdraw.
  48735. * @returns false
  48736. */
  48737. needAlphaTesting(): boolean;
  48738. /**
  48739. * The entire material has been created in order to prevent overdraw.
  48740. * @returns true if blending is enable
  48741. */
  48742. needAlphaBlending(): boolean;
  48743. /**
  48744. * Checks wether the material is ready to be rendered for a given mesh.
  48745. * @param mesh The mesh to render
  48746. * @param subMesh The submesh to check against
  48747. * @param useInstances Specify wether or not the material is used with instances
  48748. * @returns true if all the dependencies are ready (Textures, Effects...)
  48749. */
  48750. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  48751. /**
  48752. * Compute the primary color according to the chosen perceptual color.
  48753. */
  48754. private _computePrimaryColorFromPerceptualColor;
  48755. /**
  48756. * Compute the highlights and shadow colors according to their chosen levels.
  48757. */
  48758. private _computePrimaryColors;
  48759. /**
  48760. * Build the uniform buffer used in the material.
  48761. */
  48762. buildUniformLayout(): void;
  48763. /**
  48764. * Unbind the material.
  48765. */
  48766. unbind(): void;
  48767. /**
  48768. * Bind only the world matrix to the material.
  48769. * @param world The world matrix to bind.
  48770. */
  48771. bindOnlyWorldMatrix(world: Matrix): void;
  48772. /**
  48773. * Bind the material for a dedicated submeh (every used meshes will be considered opaque).
  48774. * @param world The world matrix to bind.
  48775. * @param subMesh The submesh to bind for.
  48776. */
  48777. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  48778. /**
  48779. * Checks to see if a texture is used in the material.
  48780. * @param texture - Base texture to use.
  48781. * @returns - Boolean specifying if a texture is used in the material.
  48782. */
  48783. hasTexture(texture: BaseTexture): boolean;
  48784. /**
  48785. * Dispose the material.
  48786. * @param forceDisposeEffect Force disposal of the associated effect.
  48787. * @param forceDisposeTextures Force disposal of the associated textures.
  48788. */
  48789. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  48790. /**
  48791. * Clones the material.
  48792. * @param name The cloned name.
  48793. * @returns The cloned material.
  48794. */
  48795. clone(name: string): BackgroundMaterial;
  48796. /**
  48797. * Serializes the current material to its JSON representation.
  48798. * @returns The JSON representation.
  48799. */
  48800. serialize(): any;
  48801. /**
  48802. * Gets the class name of the material
  48803. * @returns "BackgroundMaterial"
  48804. */
  48805. getClassName(): string;
  48806. /**
  48807. * Parse a JSON input to create back a background material.
  48808. * @param source The JSON data to parse
  48809. * @param scene The scene to create the parsed material in
  48810. * @param rootUrl The root url of the assets the material depends upon
  48811. * @returns the instantiated BackgroundMaterial.
  48812. */
  48813. static Parse(source: any, scene: Scene, rootUrl: string): BackgroundMaterial;
  48814. }
  48815. }
  48816. declare module "babylonjs/Helpers/environmentHelper" {
  48817. import { Observable } from "babylonjs/Misc/observable";
  48818. import { Nullable } from "babylonjs/types";
  48819. import { Scene } from "babylonjs/scene";
  48820. import { Vector3 } from "babylonjs/Maths/math.vector";
  48821. import { Color3 } from "babylonjs/Maths/math.color";
  48822. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  48823. import { Mesh } from "babylonjs/Meshes/mesh";
  48824. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  48825. import { MirrorTexture } from "babylonjs/Materials/Textures/mirrorTexture";
  48826. import { BackgroundMaterial } from "babylonjs/Materials/Background/backgroundMaterial";
  48827. import "babylonjs/Meshes/Builders/planeBuilder";
  48828. import "babylonjs/Meshes/Builders/boxBuilder";
  48829. /**
  48830. * Represents the different options available during the creation of
  48831. * a Environment helper.
  48832. *
  48833. * This can control the default ground, skybox and image processing setup of your scene.
  48834. */
  48835. export interface IEnvironmentHelperOptions {
  48836. /**
  48837. * Specifies wether or not to create a ground.
  48838. * True by default.
  48839. */
  48840. createGround: boolean;
  48841. /**
  48842. * Specifies the ground size.
  48843. * 15 by default.
  48844. */
  48845. groundSize: number;
  48846. /**
  48847. * The texture used on the ground for the main color.
  48848. * Comes from the BabylonJS CDN by default.
  48849. *
  48850. * Remarks: Can be either a texture or a url.
  48851. */
  48852. groundTexture: string | BaseTexture;
  48853. /**
  48854. * The color mixed in the ground texture by default.
  48855. * BabylonJS clearColor by default.
  48856. */
  48857. groundColor: Color3;
  48858. /**
  48859. * Specifies the ground opacity.
  48860. * 1 by default.
  48861. */
  48862. groundOpacity: number;
  48863. /**
  48864. * Enables the ground to receive shadows.
  48865. * True by default.
  48866. */
  48867. enableGroundShadow: boolean;
  48868. /**
  48869. * Helps preventing the shadow to be fully black on the ground.
  48870. * 0.5 by default.
  48871. */
  48872. groundShadowLevel: number;
  48873. /**
  48874. * Creates a mirror texture attach to the ground.
  48875. * false by default.
  48876. */
  48877. enableGroundMirror: boolean;
  48878. /**
  48879. * Specifies the ground mirror size ratio.
  48880. * 0.3 by default as the default kernel is 64.
  48881. */
  48882. groundMirrorSizeRatio: number;
  48883. /**
  48884. * Specifies the ground mirror blur kernel size.
  48885. * 64 by default.
  48886. */
  48887. groundMirrorBlurKernel: number;
  48888. /**
  48889. * Specifies the ground mirror visibility amount.
  48890. * 1 by default
  48891. */
  48892. groundMirrorAmount: number;
  48893. /**
  48894. * Specifies the ground mirror reflectance weight.
  48895. * This uses the standard weight of the background material to setup the fresnel effect
  48896. * of the mirror.
  48897. * 1 by default.
  48898. */
  48899. groundMirrorFresnelWeight: number;
  48900. /**
  48901. * Specifies the ground mirror Falloff distance.
  48902. * This can helps reducing the size of the reflection.
  48903. * 0 by Default.
  48904. */
  48905. groundMirrorFallOffDistance: number;
  48906. /**
  48907. * Specifies the ground mirror texture type.
  48908. * Unsigned Int by Default.
  48909. */
  48910. groundMirrorTextureType: number;
  48911. /**
  48912. * Specifies a bias applied to the ground vertical position to prevent z-fighting with
  48913. * the shown objects.
  48914. */
  48915. groundYBias: number;
  48916. /**
  48917. * Specifies wether or not to create a skybox.
  48918. * True by default.
  48919. */
  48920. createSkybox: boolean;
  48921. /**
  48922. * Specifies the skybox size.
  48923. * 20 by default.
  48924. */
  48925. skyboxSize: number;
  48926. /**
  48927. * The texture used on the skybox for the main color.
  48928. * Comes from the BabylonJS CDN by default.
  48929. *
  48930. * Remarks: Can be either a texture or a url.
  48931. */
  48932. skyboxTexture: string | BaseTexture;
  48933. /**
  48934. * The color mixed in the skybox texture by default.
  48935. * BabylonJS clearColor by default.
  48936. */
  48937. skyboxColor: Color3;
  48938. /**
  48939. * The background rotation around the Y axis of the scene.
  48940. * This helps aligning the key lights of your scene with the background.
  48941. * 0 by default.
  48942. */
  48943. backgroundYRotation: number;
  48944. /**
  48945. * Compute automatically the size of the elements to best fit with the scene.
  48946. */
  48947. sizeAuto: boolean;
  48948. /**
  48949. * Default position of the rootMesh if autoSize is not true.
  48950. */
  48951. rootPosition: Vector3;
  48952. /**
  48953. * Sets up the image processing in the scene.
  48954. * true by default.
  48955. */
  48956. setupImageProcessing: boolean;
  48957. /**
  48958. * The texture used as your environment texture in the scene.
  48959. * Comes from the BabylonJS CDN by default and in use if setupImageProcessing is true.
  48960. *
  48961. * Remarks: Can be either a texture or a url.
  48962. */
  48963. environmentTexture: string | BaseTexture;
  48964. /**
  48965. * The value of the exposure to apply to the scene.
  48966. * 0.6 by default if setupImageProcessing is true.
  48967. */
  48968. cameraExposure: number;
  48969. /**
  48970. * The value of the contrast to apply to the scene.
  48971. * 1.6 by default if setupImageProcessing is true.
  48972. */
  48973. cameraContrast: number;
  48974. /**
  48975. * Specifies wether or not tonemapping should be enabled in the scene.
  48976. * true by default if setupImageProcessing is true.
  48977. */
  48978. toneMappingEnabled: boolean;
  48979. }
  48980. /**
  48981. * The Environment helper class can be used to add a fully featuread none expensive background to your scene.
  48982. * It includes by default a skybox and a ground relying on the BackgroundMaterial.
  48983. * It also helps with the default setup of your imageProcessing configuration.
  48984. */
  48985. export class EnvironmentHelper {
  48986. /**
  48987. * Default ground texture URL.
  48988. */
  48989. private static _groundTextureCDNUrl;
  48990. /**
  48991. * Default skybox texture URL.
  48992. */
  48993. private static _skyboxTextureCDNUrl;
  48994. /**
  48995. * Default environment texture URL.
  48996. */
  48997. private static _environmentTextureCDNUrl;
  48998. /**
  48999. * Creates the default options for the helper.
  49000. */
  49001. private static _getDefaultOptions;
  49002. private _rootMesh;
  49003. /**
  49004. * Gets the root mesh created by the helper.
  49005. */
  49006. readonly rootMesh: Mesh;
  49007. private _skybox;
  49008. /**
  49009. * Gets the skybox created by the helper.
  49010. */
  49011. readonly skybox: Nullable<Mesh>;
  49012. private _skyboxTexture;
  49013. /**
  49014. * Gets the skybox texture created by the helper.
  49015. */
  49016. readonly skyboxTexture: Nullable<BaseTexture>;
  49017. private _skyboxMaterial;
  49018. /**
  49019. * Gets the skybox material created by the helper.
  49020. */
  49021. readonly skyboxMaterial: Nullable<BackgroundMaterial>;
  49022. private _ground;
  49023. /**
  49024. * Gets the ground mesh created by the helper.
  49025. */
  49026. readonly ground: Nullable<Mesh>;
  49027. private _groundTexture;
  49028. /**
  49029. * Gets the ground texture created by the helper.
  49030. */
  49031. readonly groundTexture: Nullable<BaseTexture>;
  49032. private _groundMirror;
  49033. /**
  49034. * Gets the ground mirror created by the helper.
  49035. */
  49036. readonly groundMirror: Nullable<MirrorTexture>;
  49037. /**
  49038. * Gets the ground mirror render list to helps pushing the meshes
  49039. * you wish in the ground reflection.
  49040. */
  49041. readonly groundMirrorRenderList: Nullable<AbstractMesh[]>;
  49042. private _groundMaterial;
  49043. /**
  49044. * Gets the ground material created by the helper.
  49045. */
  49046. readonly groundMaterial: Nullable<BackgroundMaterial>;
  49047. /**
  49048. * Stores the creation options.
  49049. */
  49050. private readonly _scene;
  49051. private _options;
  49052. /**
  49053. * This observable will be notified with any error during the creation of the environment,
  49054. * mainly texture creation errors.
  49055. */
  49056. onErrorObservable: Observable<{
  49057. message?: string;
  49058. exception?: any;
  49059. }>;
  49060. /**
  49061. * constructor
  49062. * @param options Defines the options we want to customize the helper
  49063. * @param scene The scene to add the material to
  49064. */
  49065. constructor(options: Partial<IEnvironmentHelperOptions>, scene: Scene);
  49066. /**
  49067. * Updates the background according to the new options
  49068. * @param options
  49069. */
  49070. updateOptions(options: Partial<IEnvironmentHelperOptions>): void;
  49071. /**
  49072. * Sets the primary color of all the available elements.
  49073. * @param color the main color to affect to the ground and the background
  49074. */
  49075. setMainColor(color: Color3): void;
  49076. /**
  49077. * Setup the image processing according to the specified options.
  49078. */
  49079. private _setupImageProcessing;
  49080. /**
  49081. * Setup the environment texture according to the specified options.
  49082. */
  49083. private _setupEnvironmentTexture;
  49084. /**
  49085. * Setup the background according to the specified options.
  49086. */
  49087. private _setupBackground;
  49088. /**
  49089. * Get the scene sizes according to the setup.
  49090. */
  49091. private _getSceneSize;
  49092. /**
  49093. * Setup the ground according to the specified options.
  49094. */
  49095. private _setupGround;
  49096. /**
  49097. * Setup the ground material according to the specified options.
  49098. */
  49099. private _setupGroundMaterial;
  49100. /**
  49101. * Setup the ground diffuse texture according to the specified options.
  49102. */
  49103. private _setupGroundDiffuseTexture;
  49104. /**
  49105. * Setup the ground mirror texture according to the specified options.
  49106. */
  49107. private _setupGroundMirrorTexture;
  49108. /**
  49109. * Setup the ground to receive the mirror texture.
  49110. */
  49111. private _setupMirrorInGroundMaterial;
  49112. /**
  49113. * Setup the skybox according to the specified options.
  49114. */
  49115. private _setupSkybox;
  49116. /**
  49117. * Setup the skybox material according to the specified options.
  49118. */
  49119. private _setupSkyboxMaterial;
  49120. /**
  49121. * Setup the skybox reflection texture according to the specified options.
  49122. */
  49123. private _setupSkyboxReflectionTexture;
  49124. private _errorHandler;
  49125. /**
  49126. * Dispose all the elements created by the Helper.
  49127. */
  49128. dispose(): void;
  49129. }
  49130. }
  49131. declare module "babylonjs/Helpers/photoDome" {
  49132. import { Observable } from "babylonjs/Misc/observable";
  49133. import { Nullable } from "babylonjs/types";
  49134. import { Scene } from "babylonjs/scene";
  49135. import { TransformNode } from "babylonjs/Meshes/transformNode";
  49136. import { Mesh } from "babylonjs/Meshes/mesh";
  49137. import { Texture } from "babylonjs/Materials/Textures/texture";
  49138. import { BackgroundMaterial } from "babylonjs/Materials/Background/backgroundMaterial";
  49139. import "babylonjs/Meshes/Builders/sphereBuilder";
  49140. /**
  49141. * Display a 360 degree photo on an approximately spherical surface, useful for VR applications or skyboxes.
  49142. * As a subclass of TransformNode, this allow parenting to the camera with different locations in the scene.
  49143. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  49144. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  49145. */
  49146. export class PhotoDome extends TransformNode {
  49147. /**
  49148. * Define the image as a Monoscopic panoramic 360 image.
  49149. */
  49150. static readonly MODE_MONOSCOPIC: number;
  49151. /**
  49152. * Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  49153. */
  49154. static readonly MODE_TOPBOTTOM: number;
  49155. /**
  49156. * Define the image as a Stereoscopic Side by Side panoramic 360 image.
  49157. */
  49158. static readonly MODE_SIDEBYSIDE: number;
  49159. private _useDirectMapping;
  49160. /**
  49161. * The texture being displayed on the sphere
  49162. */
  49163. protected _photoTexture: Texture;
  49164. /**
  49165. * Gets or sets the texture being displayed on the sphere
  49166. */
  49167. photoTexture: Texture;
  49168. /**
  49169. * Observable raised when an error occured while loading the 360 image
  49170. */
  49171. onLoadErrorObservable: Observable<string>;
  49172. /**
  49173. * The skybox material
  49174. */
  49175. protected _material: BackgroundMaterial;
  49176. /**
  49177. * The surface used for the skybox
  49178. */
  49179. protected _mesh: Mesh;
  49180. /**
  49181. * Gets the mesh used for the skybox.
  49182. */
  49183. readonly mesh: Mesh;
  49184. /**
  49185. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  49186. * Also see the options.resolution property.
  49187. */
  49188. fovMultiplier: number;
  49189. private _imageMode;
  49190. /**
  49191. * Gets or set the current video mode for the video. It can be:
  49192. * * PhotoDome.MODE_MONOSCOPIC : Define the image as a Monoscopic panoramic 360 image.
  49193. * * PhotoDome.MODE_TOPBOTTOM : Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  49194. * * PhotoDome.MODE_SIDEBYSIDE : Define the image as a Stereoscopic Side by Side panoramic 360 image.
  49195. */
  49196. imageMode: number;
  49197. /**
  49198. * Create an instance of this class and pass through the parameters to the relevant classes, Texture, StandardMaterial, and Mesh.
  49199. * @param name Element's name, child elements will append suffixes for their own names.
  49200. * @param urlsOfPhoto defines the url of the photo to display
  49201. * @param options defines an object containing optional or exposed sub element properties
  49202. * @param onError defines a callback called when an error occured while loading the texture
  49203. */
  49204. constructor(name: string, urlOfPhoto: string, options: {
  49205. resolution?: number;
  49206. size?: number;
  49207. useDirectMapping?: boolean;
  49208. faceForward?: boolean;
  49209. }, scene: Scene, onError?: Nullable<(message?: string, exception?: any) => void>);
  49210. private _onBeforeCameraRenderObserver;
  49211. private _changeImageMode;
  49212. /**
  49213. * Releases resources associated with this node.
  49214. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  49215. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  49216. */
  49217. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  49218. }
  49219. }
  49220. declare module "babylonjs/Misc/rgbdTextureTools" {
  49221. import "babylonjs/Shaders/rgbdDecode.fragment";
  49222. import "babylonjs/Engines/Extensions/engine.renderTarget";
  49223. import { Texture } from "babylonjs/Materials/Textures/texture";
  49224. /**
  49225. * Class used to host RGBD texture specific utilities
  49226. */
  49227. export class RGBDTextureTools {
  49228. /**
  49229. * Expand the RGBD Texture from RGBD to Half Float if possible.
  49230. * @param texture the texture to expand.
  49231. */
  49232. static ExpandRGBDTexture(texture: Texture): void;
  49233. }
  49234. }
  49235. declare module "babylonjs/Misc/brdfTextureTools" {
  49236. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  49237. import { Scene } from "babylonjs/scene";
  49238. /**
  49239. * Class used to host texture specific utilities
  49240. */
  49241. export class BRDFTextureTools {
  49242. /**
  49243. * Gets a default environment BRDF for MS-BRDF Height Correlated BRDF
  49244. * @param scene defines the hosting scene
  49245. * @returns the environment BRDF texture
  49246. */
  49247. static GetEnvironmentBRDFTexture(scene: Scene): BaseTexture;
  49248. private static _environmentBRDFBase64Texture;
  49249. }
  49250. }
  49251. declare module "babylonjs/Materials/PBR/pbrClearCoatConfiguration" {
  49252. import { Nullable } from "babylonjs/types";
  49253. import { Color3 } from "babylonjs/Maths/math.color";
  49254. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  49255. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  49256. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  49257. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  49258. import { Engine } from "babylonjs/Engines/engine";
  49259. import { Scene } from "babylonjs/scene";
  49260. /**
  49261. * @hidden
  49262. */
  49263. export interface IMaterialClearCoatDefines {
  49264. CLEARCOAT: boolean;
  49265. CLEARCOAT_DEFAULTIOR: boolean;
  49266. CLEARCOAT_TEXTURE: boolean;
  49267. CLEARCOAT_TEXTUREDIRECTUV: number;
  49268. CLEARCOAT_BUMP: boolean;
  49269. CLEARCOAT_BUMPDIRECTUV: number;
  49270. CLEARCOAT_TINT: boolean;
  49271. CLEARCOAT_TINT_TEXTURE: boolean;
  49272. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  49273. /** @hidden */
  49274. _areTexturesDirty: boolean;
  49275. }
  49276. /**
  49277. * Define the code related to the clear coat parameters of the pbr material.
  49278. */
  49279. export class PBRClearCoatConfiguration {
  49280. /**
  49281. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  49282. * The default fits with a polyurethane material.
  49283. */
  49284. private static readonly _DefaultIndexOfRefraction;
  49285. private _isEnabled;
  49286. /**
  49287. * Defines if the clear coat is enabled in the material.
  49288. */
  49289. isEnabled: boolean;
  49290. /**
  49291. * Defines the clear coat layer strength (between 0 and 1) it defaults to 1.
  49292. */
  49293. intensity: number;
  49294. /**
  49295. * Defines the clear coat layer roughness.
  49296. */
  49297. roughness: number;
  49298. private _indexOfRefraction;
  49299. /**
  49300. * Defines the index of refraction of the clear coat.
  49301. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  49302. * The default fits with a polyurethane material.
  49303. * Changing the default value is more performance intensive.
  49304. */
  49305. indexOfRefraction: number;
  49306. private _texture;
  49307. /**
  49308. * Stores the clear coat values in a texture.
  49309. */
  49310. texture: Nullable<BaseTexture>;
  49311. private _bumpTexture;
  49312. /**
  49313. * Define the clear coat specific bump texture.
  49314. */
  49315. bumpTexture: Nullable<BaseTexture>;
  49316. private _isTintEnabled;
  49317. /**
  49318. * Defines if the clear coat tint is enabled in the material.
  49319. */
  49320. isTintEnabled: boolean;
  49321. /**
  49322. * Defines the clear coat tint of the material.
  49323. * This is only use if tint is enabled
  49324. */
  49325. tintColor: Color3;
  49326. /**
  49327. * Defines the distance at which the tint color should be found in the
  49328. * clear coat media.
  49329. * This is only use if tint is enabled
  49330. */
  49331. tintColorAtDistance: number;
  49332. /**
  49333. * Defines the clear coat layer thickness.
  49334. * This is only use if tint is enabled
  49335. */
  49336. tintThickness: number;
  49337. private _tintTexture;
  49338. /**
  49339. * Stores the clear tint values in a texture.
  49340. * rgb is tint
  49341. * a is a thickness factor
  49342. */
  49343. tintTexture: Nullable<BaseTexture>;
  49344. /** @hidden */
  49345. private _internalMarkAllSubMeshesAsTexturesDirty;
  49346. /** @hidden */
  49347. _markAllSubMeshesAsTexturesDirty(): void;
  49348. /**
  49349. * Instantiate a new istance of clear coat configuration.
  49350. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  49351. */
  49352. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  49353. /**
  49354. * Gets wehter the submesh is ready to be used or not.
  49355. * @param defines the list of "defines" to update.
  49356. * @param scene defines the scene the material belongs to.
  49357. * @param engine defines the engine the material belongs to.
  49358. * @param disableBumpMap defines wether the material disables bump or not.
  49359. * @returns - boolean indicating that the submesh is ready or not.
  49360. */
  49361. isReadyForSubMesh(defines: IMaterialClearCoatDefines, scene: Scene, engine: Engine, disableBumpMap: boolean): boolean;
  49362. /**
  49363. * Checks to see if a texture is used in the material.
  49364. * @param defines the list of "defines" to update.
  49365. * @param scene defines the scene to the material belongs to.
  49366. */
  49367. prepareDefines(defines: IMaterialClearCoatDefines, scene: Scene): void;
  49368. /**
  49369. * Binds the material data.
  49370. * @param uniformBuffer defines the Uniform buffer to fill in.
  49371. * @param scene defines the scene the material belongs to.
  49372. * @param engine defines the engine the material belongs to.
  49373. * @param disableBumpMap defines wether the material disables bump or not.
  49374. * @param isFrozen defines wether the material is frozen or not.
  49375. * @param invertNormalMapX If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  49376. * @param invertNormalMapY If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  49377. */
  49378. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, disableBumpMap: boolean, isFrozen: boolean, invertNormalMapX: boolean, invertNormalMapY: boolean): void;
  49379. /**
  49380. * Checks to see if a texture is used in the material.
  49381. * @param texture - Base texture to use.
  49382. * @returns - Boolean specifying if a texture is used in the material.
  49383. */
  49384. hasTexture(texture: BaseTexture): boolean;
  49385. /**
  49386. * Returns an array of the actively used textures.
  49387. * @param activeTextures Array of BaseTextures
  49388. */
  49389. getActiveTextures(activeTextures: BaseTexture[]): void;
  49390. /**
  49391. * Returns the animatable textures.
  49392. * @param animatables Array of animatable textures.
  49393. */
  49394. getAnimatables(animatables: IAnimatable[]): void;
  49395. /**
  49396. * Disposes the resources of the material.
  49397. * @param forceDisposeTextures - Forces the disposal of all textures.
  49398. */
  49399. dispose(forceDisposeTextures?: boolean): void;
  49400. /**
  49401. * Get the current class name of the texture useful for serialization or dynamic coding.
  49402. * @returns "PBRClearCoatConfiguration"
  49403. */
  49404. getClassName(): string;
  49405. /**
  49406. * Add fallbacks to the effect fallbacks list.
  49407. * @param defines defines the Base texture to use.
  49408. * @param fallbacks defines the current fallback list.
  49409. * @param currentRank defines the current fallback rank.
  49410. * @returns the new fallback rank.
  49411. */
  49412. static AddFallbacks(defines: IMaterialClearCoatDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  49413. /**
  49414. * Add the required uniforms to the current list.
  49415. * @param uniforms defines the current uniform list.
  49416. */
  49417. static AddUniforms(uniforms: string[]): void;
  49418. /**
  49419. * Add the required samplers to the current list.
  49420. * @param samplers defines the current sampler list.
  49421. */
  49422. static AddSamplers(samplers: string[]): void;
  49423. /**
  49424. * Add the required uniforms to the current buffer.
  49425. * @param uniformBuffer defines the current uniform buffer.
  49426. */
  49427. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  49428. /**
  49429. * Makes a duplicate of the current configuration into another one.
  49430. * @param clearCoatConfiguration define the config where to copy the info
  49431. */
  49432. copyTo(clearCoatConfiguration: PBRClearCoatConfiguration): void;
  49433. /**
  49434. * Serializes this clear coat configuration.
  49435. * @returns - An object with the serialized config.
  49436. */
  49437. serialize(): any;
  49438. /**
  49439. * Parses a anisotropy Configuration from a serialized object.
  49440. * @param source - Serialized object.
  49441. * @param scene Defines the scene we are parsing for
  49442. * @param rootUrl Defines the rootUrl to load from
  49443. */
  49444. parse(source: any, scene: Scene, rootUrl: string): void;
  49445. }
  49446. }
  49447. declare module "babylonjs/Materials/PBR/pbrAnisotropicConfiguration" {
  49448. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  49449. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  49450. import { Vector2 } from "babylonjs/Maths/math.vector";
  49451. import { Scene } from "babylonjs/scene";
  49452. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  49453. import { Nullable } from "babylonjs/types";
  49454. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  49455. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  49456. /**
  49457. * @hidden
  49458. */
  49459. export interface IMaterialAnisotropicDefines {
  49460. ANISOTROPIC: boolean;
  49461. ANISOTROPIC_TEXTURE: boolean;
  49462. ANISOTROPIC_TEXTUREDIRECTUV: number;
  49463. MAINUV1: boolean;
  49464. _areTexturesDirty: boolean;
  49465. _needUVs: boolean;
  49466. }
  49467. /**
  49468. * Define the code related to the anisotropic parameters of the pbr material.
  49469. */
  49470. export class PBRAnisotropicConfiguration {
  49471. private _isEnabled;
  49472. /**
  49473. * Defines if the anisotropy is enabled in the material.
  49474. */
  49475. isEnabled: boolean;
  49476. /**
  49477. * Defines the anisotropy strength (between 0 and 1) it defaults to 1.
  49478. */
  49479. intensity: number;
  49480. /**
  49481. * Defines if the effect is along the tangents, bitangents or in between.
  49482. * By default, the effect is "strectching" the highlights along the tangents.
  49483. */
  49484. direction: Vector2;
  49485. private _texture;
  49486. /**
  49487. * Stores the anisotropy values in a texture.
  49488. * rg is direction (like normal from -1 to 1)
  49489. * b is a intensity
  49490. */
  49491. texture: Nullable<BaseTexture>;
  49492. /** @hidden */
  49493. private _internalMarkAllSubMeshesAsTexturesDirty;
  49494. /** @hidden */
  49495. _markAllSubMeshesAsTexturesDirty(): void;
  49496. /**
  49497. * Instantiate a new istance of anisotropy configuration.
  49498. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  49499. */
  49500. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  49501. /**
  49502. * Specifies that the submesh is ready to be used.
  49503. * @param defines the list of "defines" to update.
  49504. * @param scene defines the scene the material belongs to.
  49505. * @returns - boolean indicating that the submesh is ready or not.
  49506. */
  49507. isReadyForSubMesh(defines: IMaterialAnisotropicDefines, scene: Scene): boolean;
  49508. /**
  49509. * Checks to see if a texture is used in the material.
  49510. * @param defines the list of "defines" to update.
  49511. * @param mesh the mesh we are preparing the defines for.
  49512. * @param scene defines the scene the material belongs to.
  49513. */
  49514. prepareDefines(defines: IMaterialAnisotropicDefines, mesh: AbstractMesh, 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 isFrozen defines wether the material is frozen or not.
  49520. */
  49521. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  49522. /**
  49523. * Checks to see if a texture is used in the material.
  49524. * @param texture - Base texture to use.
  49525. * @returns - Boolean specifying if a texture is used in the material.
  49526. */
  49527. hasTexture(texture: BaseTexture): boolean;
  49528. /**
  49529. * Returns an array of the actively used textures.
  49530. * @param activeTextures Array of BaseTextures
  49531. */
  49532. getActiveTextures(activeTextures: BaseTexture[]): void;
  49533. /**
  49534. * Returns the animatable textures.
  49535. * @param animatables Array of animatable textures.
  49536. */
  49537. getAnimatables(animatables: IAnimatable[]): void;
  49538. /**
  49539. * Disposes the resources of the material.
  49540. * @param forceDisposeTextures - Forces the disposal of all textures.
  49541. */
  49542. dispose(forceDisposeTextures?: boolean): void;
  49543. /**
  49544. * Get the current class name of the texture useful for serialization or dynamic coding.
  49545. * @returns "PBRAnisotropicConfiguration"
  49546. */
  49547. getClassName(): string;
  49548. /**
  49549. * Add fallbacks to the effect fallbacks list.
  49550. * @param defines defines the Base texture to use.
  49551. * @param fallbacks defines the current fallback list.
  49552. * @param currentRank defines the current fallback rank.
  49553. * @returns the new fallback rank.
  49554. */
  49555. static AddFallbacks(defines: IMaterialAnisotropicDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  49556. /**
  49557. * Add the required uniforms to the current list.
  49558. * @param uniforms defines the current uniform list.
  49559. */
  49560. static AddUniforms(uniforms: string[]): void;
  49561. /**
  49562. * Add the required uniforms to the current buffer.
  49563. * @param uniformBuffer defines the current uniform buffer.
  49564. */
  49565. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  49566. /**
  49567. * Add the required samplers to the current list.
  49568. * @param samplers defines the current sampler list.
  49569. */
  49570. static AddSamplers(samplers: string[]): void;
  49571. /**
  49572. * Makes a duplicate of the current configuration into another one.
  49573. * @param anisotropicConfiguration define the config where to copy the info
  49574. */
  49575. copyTo(anisotropicConfiguration: PBRAnisotropicConfiguration): void;
  49576. /**
  49577. * Serializes this anisotropy configuration.
  49578. * @returns - An object with the serialized config.
  49579. */
  49580. serialize(): any;
  49581. /**
  49582. * Parses a anisotropy Configuration from a serialized object.
  49583. * @param source - Serialized object.
  49584. * @param scene Defines the scene we are parsing for
  49585. * @param rootUrl Defines the rootUrl to load from
  49586. */
  49587. parse(source: any, scene: Scene, rootUrl: string): void;
  49588. }
  49589. }
  49590. declare module "babylonjs/Materials/PBR/pbrBRDFConfiguration" {
  49591. import { Scene } from "babylonjs/scene";
  49592. /**
  49593. * @hidden
  49594. */
  49595. export interface IMaterialBRDFDefines {
  49596. BRDF_V_HEIGHT_CORRELATED: boolean;
  49597. MS_BRDF_ENERGY_CONSERVATION: boolean;
  49598. SPHERICAL_HARMONICS: boolean;
  49599. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  49600. /** @hidden */
  49601. _areMiscDirty: boolean;
  49602. }
  49603. /**
  49604. * Define the code related to the BRDF parameters of the pbr material.
  49605. */
  49606. export class PBRBRDFConfiguration {
  49607. /**
  49608. * Default value used for the energy conservation.
  49609. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  49610. */
  49611. static DEFAULT_USE_ENERGY_CONSERVATION: boolean;
  49612. /**
  49613. * Default value used for the Smith Visibility Height Correlated mode.
  49614. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  49615. */
  49616. static DEFAULT_USE_SMITH_VISIBILITY_HEIGHT_CORRELATED: boolean;
  49617. /**
  49618. * Default value used for the IBL diffuse part.
  49619. * This can help switching back to the polynomials mode globally which is a tiny bit
  49620. * less GPU intensive at the drawback of a lower quality.
  49621. */
  49622. static DEFAULT_USE_SPHERICAL_HARMONICS: boolean;
  49623. /**
  49624. * Default value used for activating energy conservation for the specular workflow.
  49625. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  49626. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  49627. */
  49628. static DEFAULT_USE_SPECULAR_GLOSSINESS_INPUT_ENERGY_CONSERVATION: boolean;
  49629. private _useEnergyConservation;
  49630. /**
  49631. * Defines if the material uses energy conservation.
  49632. */
  49633. useEnergyConservation: boolean;
  49634. private _useSmithVisibilityHeightCorrelated;
  49635. /**
  49636. * LEGACY Mode set to false
  49637. * Defines if the material uses height smith correlated visibility term.
  49638. * If you intent to not use our default BRDF, you need to load a separate BRDF Texture for the PBR
  49639. * You can either load https://assets.babylonjs.com/environments/uncorrelatedBRDF.png
  49640. * or https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds to have more precision
  49641. * Not relying on height correlated will also disable energy conservation.
  49642. */
  49643. useSmithVisibilityHeightCorrelated: boolean;
  49644. private _useSphericalHarmonics;
  49645. /**
  49646. * LEGACY Mode set to false
  49647. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  49648. * diffuse part of the IBL.
  49649. * The harmonics despite a tiny bigger cost has been proven to provide closer results
  49650. * to the ground truth.
  49651. */
  49652. useSphericalHarmonics: boolean;
  49653. private _useSpecularGlossinessInputEnergyConservation;
  49654. /**
  49655. * Defines if the material uses energy conservation, when the specular workflow is active.
  49656. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  49657. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  49658. * In the deactivated case, the material author has to ensure energy conservation, for a physically plausible rendering.
  49659. */
  49660. useSpecularGlossinessInputEnergyConservation: boolean;
  49661. /** @hidden */
  49662. private _internalMarkAllSubMeshesAsMiscDirty;
  49663. /** @hidden */
  49664. _markAllSubMeshesAsMiscDirty(): void;
  49665. /**
  49666. * Instantiate a new istance of clear coat configuration.
  49667. * @param markAllSubMeshesAsMiscDirty Callback to flag the material to dirty
  49668. */
  49669. constructor(markAllSubMeshesAsMiscDirty: () => void);
  49670. /**
  49671. * Checks to see if a texture is used in the material.
  49672. * @param defines the list of "defines" to update.
  49673. */
  49674. prepareDefines(defines: IMaterialBRDFDefines): void;
  49675. /**
  49676. * Get the current class name of the texture useful for serialization or dynamic coding.
  49677. * @returns "PBRClearCoatConfiguration"
  49678. */
  49679. getClassName(): string;
  49680. /**
  49681. * Makes a duplicate of the current configuration into another one.
  49682. * @param brdfConfiguration define the config where to copy the info
  49683. */
  49684. copyTo(brdfConfiguration: PBRBRDFConfiguration): void;
  49685. /**
  49686. * Serializes this BRDF configuration.
  49687. * @returns - An object with the serialized config.
  49688. */
  49689. serialize(): any;
  49690. /**
  49691. * Parses a anisotropy Configuration from a serialized object.
  49692. * @param source - Serialized object.
  49693. * @param scene Defines the scene we are parsing for
  49694. * @param rootUrl Defines the rootUrl to load from
  49695. */
  49696. parse(source: any, scene: Scene, rootUrl: string): void;
  49697. }
  49698. }
  49699. declare module "babylonjs/Materials/PBR/pbrSheenConfiguration" {
  49700. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  49701. import { Color3 } from "babylonjs/Maths/math.color";
  49702. import { Scene } from "babylonjs/scene";
  49703. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  49704. import { Nullable } from "babylonjs/types";
  49705. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  49706. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  49707. /**
  49708. * @hidden
  49709. */
  49710. export interface IMaterialSheenDefines {
  49711. SHEEN: boolean;
  49712. SHEEN_TEXTURE: boolean;
  49713. SHEEN_TEXTUREDIRECTUV: number;
  49714. SHEEN_LINKWITHALBEDO: boolean;
  49715. /** @hidden */
  49716. _areTexturesDirty: boolean;
  49717. }
  49718. /**
  49719. * Define the code related to the Sheen parameters of the pbr material.
  49720. */
  49721. export class PBRSheenConfiguration {
  49722. private _isEnabled;
  49723. /**
  49724. * Defines if the material uses sheen.
  49725. */
  49726. isEnabled: boolean;
  49727. private _linkSheenWithAlbedo;
  49728. /**
  49729. * Defines if the sheen is linked to the sheen color.
  49730. */
  49731. linkSheenWithAlbedo: boolean;
  49732. /**
  49733. * Defines the sheen intensity.
  49734. */
  49735. intensity: number;
  49736. /**
  49737. * Defines the sheen color.
  49738. */
  49739. color: Color3;
  49740. private _texture;
  49741. /**
  49742. * Stores the sheen tint values in a texture.
  49743. * rgb is tint
  49744. * a is a intensity
  49745. */
  49746. texture: Nullable<BaseTexture>;
  49747. /** @hidden */
  49748. private _internalMarkAllSubMeshesAsTexturesDirty;
  49749. /** @hidden */
  49750. _markAllSubMeshesAsTexturesDirty(): void;
  49751. /**
  49752. * Instantiate a new istance of clear coat configuration.
  49753. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  49754. */
  49755. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  49756. /**
  49757. * Specifies that the submesh is ready to be used.
  49758. * @param defines the list of "defines" to update.
  49759. * @param scene defines the scene the material belongs to.
  49760. * @returns - boolean indicating that the submesh is ready or not.
  49761. */
  49762. isReadyForSubMesh(defines: IMaterialSheenDefines, scene: Scene): boolean;
  49763. /**
  49764. * Checks to see if a texture is used in the material.
  49765. * @param defines the list of "defines" to update.
  49766. * @param scene defines the scene the material belongs to.
  49767. */
  49768. prepareDefines(defines: IMaterialSheenDefines, scene: Scene): void;
  49769. /**
  49770. * Binds the material data.
  49771. * @param uniformBuffer defines the Uniform buffer to fill in.
  49772. * @param scene defines the scene the material belongs to.
  49773. * @param isFrozen defines wether the material is frozen or not.
  49774. */
  49775. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  49776. /**
  49777. * Checks to see if a texture is used in the material.
  49778. * @param texture - Base texture to use.
  49779. * @returns - Boolean specifying if a texture is used in the material.
  49780. */
  49781. hasTexture(texture: BaseTexture): boolean;
  49782. /**
  49783. * Returns an array of the actively used textures.
  49784. * @param activeTextures Array of BaseTextures
  49785. */
  49786. getActiveTextures(activeTextures: BaseTexture[]): void;
  49787. /**
  49788. * Returns the animatable textures.
  49789. * @param animatables Array of animatable textures.
  49790. */
  49791. getAnimatables(animatables: IAnimatable[]): void;
  49792. /**
  49793. * Disposes the resources of the material.
  49794. * @param forceDisposeTextures - Forces the disposal of all textures.
  49795. */
  49796. dispose(forceDisposeTextures?: boolean): void;
  49797. /**
  49798. * Get the current class name of the texture useful for serialization or dynamic coding.
  49799. * @returns "PBRSheenConfiguration"
  49800. */
  49801. getClassName(): string;
  49802. /**
  49803. * Add fallbacks to the effect fallbacks list.
  49804. * @param defines defines the Base texture to use.
  49805. * @param fallbacks defines the current fallback list.
  49806. * @param currentRank defines the current fallback rank.
  49807. * @returns the new fallback rank.
  49808. */
  49809. static AddFallbacks(defines: IMaterialSheenDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  49810. /**
  49811. * Add the required uniforms to the current list.
  49812. * @param uniforms defines the current uniform list.
  49813. */
  49814. static AddUniforms(uniforms: string[]): void;
  49815. /**
  49816. * Add the required uniforms to the current buffer.
  49817. * @param uniformBuffer defines the current uniform buffer.
  49818. */
  49819. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  49820. /**
  49821. * Add the required samplers to the current list.
  49822. * @param samplers defines the current sampler list.
  49823. */
  49824. static AddSamplers(samplers: string[]): void;
  49825. /**
  49826. * Makes a duplicate of the current configuration into another one.
  49827. * @param sheenConfiguration define the config where to copy the info
  49828. */
  49829. copyTo(sheenConfiguration: PBRSheenConfiguration): void;
  49830. /**
  49831. * Serializes this BRDF configuration.
  49832. * @returns - An object with the serialized config.
  49833. */
  49834. serialize(): any;
  49835. /**
  49836. * Parses a anisotropy Configuration from a serialized object.
  49837. * @param source - Serialized object.
  49838. * @param scene Defines the scene we are parsing for
  49839. * @param rootUrl Defines the rootUrl to load from
  49840. */
  49841. parse(source: any, scene: Scene, rootUrl: string): void;
  49842. }
  49843. }
  49844. declare module "babylonjs/Materials/PBR/pbrSubSurfaceConfiguration" {
  49845. import { Nullable } from "babylonjs/types";
  49846. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  49847. import { Color3 } from "babylonjs/Maths/math.color";
  49848. import { SmartArray } from "babylonjs/Misc/smartArray";
  49849. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  49850. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  49851. import { Effect } from "babylonjs/Materials/effect";
  49852. import { UniformBuffer } from "babylonjs/Materials/uniformBuffer";
  49853. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  49854. import { Engine } from "babylonjs/Engines/engine";
  49855. import { Scene } from "babylonjs/scene";
  49856. /**
  49857. * @hidden
  49858. */
  49859. export interface IMaterialSubSurfaceDefines {
  49860. SUBSURFACE: boolean;
  49861. SS_REFRACTION: boolean;
  49862. SS_TRANSLUCENCY: boolean;
  49863. SS_SCATERRING: boolean;
  49864. SS_THICKNESSANDMASK_TEXTURE: boolean;
  49865. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  49866. SS_REFRACTIONMAP_3D: boolean;
  49867. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  49868. SS_LODINREFRACTIONALPHA: boolean;
  49869. SS_GAMMAREFRACTION: boolean;
  49870. SS_RGBDREFRACTION: boolean;
  49871. SS_LINEARSPECULARREFRACTION: boolean;
  49872. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  49873. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  49874. /** @hidden */
  49875. _areTexturesDirty: boolean;
  49876. }
  49877. /**
  49878. * Define the code related to the sub surface parameters of the pbr material.
  49879. */
  49880. export class PBRSubSurfaceConfiguration {
  49881. private _isRefractionEnabled;
  49882. /**
  49883. * Defines if the refraction is enabled in the material.
  49884. */
  49885. isRefractionEnabled: boolean;
  49886. private _isTranslucencyEnabled;
  49887. /**
  49888. * Defines if the translucency is enabled in the material.
  49889. */
  49890. isTranslucencyEnabled: boolean;
  49891. private _isScatteringEnabled;
  49892. /**
  49893. * Defines the refraction intensity of the material.
  49894. * The refraction when enabled replaces the Diffuse part of the material.
  49895. * The intensity helps transitionning between diffuse and refraction.
  49896. */
  49897. refractionIntensity: number;
  49898. /**
  49899. * Defines the translucency intensity of the material.
  49900. * When translucency has been enabled, this defines how much of the "translucency"
  49901. * is addded to the diffuse part of the material.
  49902. */
  49903. translucencyIntensity: number;
  49904. /**
  49905. * Defines the scattering intensity of the material.
  49906. * When scattering has been enabled, this defines how much of the "scattered light"
  49907. * is addded to the diffuse part of the material.
  49908. */
  49909. scatteringIntensity: number;
  49910. private _thicknessTexture;
  49911. /**
  49912. * Stores the average thickness of a mesh in a texture (The texture is holding the values linearly).
  49913. * The red channel of the texture should contain the thickness remapped between 0 and 1.
  49914. * 0 would mean minimumThickness
  49915. * 1 would mean maximumThickness
  49916. * The other channels might be use as a mask to vary the different effects intensity.
  49917. */
  49918. thicknessTexture: Nullable<BaseTexture>;
  49919. private _refractionTexture;
  49920. /**
  49921. * Defines the texture to use for refraction.
  49922. */
  49923. refractionTexture: Nullable<BaseTexture>;
  49924. private _indexOfRefraction;
  49925. /**
  49926. * Defines the index of refraction used in the material.
  49927. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  49928. */
  49929. indexOfRefraction: number;
  49930. private _invertRefractionY;
  49931. /**
  49932. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  49933. */
  49934. invertRefractionY: boolean;
  49935. private _linkRefractionWithTransparency;
  49936. /**
  49937. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  49938. * Materials half opaque for instance using refraction could benefit from this control.
  49939. */
  49940. linkRefractionWithTransparency: boolean;
  49941. /**
  49942. * Defines the minimum thickness stored in the thickness map.
  49943. * If no thickness map is defined, this value will be used to simulate thickness.
  49944. */
  49945. minimumThickness: number;
  49946. /**
  49947. * Defines the maximum thickness stored in the thickness map.
  49948. */
  49949. maximumThickness: number;
  49950. /**
  49951. * Defines the volume tint of the material.
  49952. * This is used for both translucency and scattering.
  49953. */
  49954. tintColor: Color3;
  49955. /**
  49956. * Defines the distance at which the tint color should be found in the media.
  49957. * This is used for refraction only.
  49958. */
  49959. tintColorAtDistance: number;
  49960. /**
  49961. * Defines how far each channel transmit through the media.
  49962. * It is defined as a color to simplify it selection.
  49963. */
  49964. diffusionDistance: Color3;
  49965. private _useMaskFromThicknessTexture;
  49966. /**
  49967. * Stores the intensity of the different subsurface effects in the thickness texture.
  49968. * * the green channel is the translucency intensity.
  49969. * * the blue channel is the scattering intensity.
  49970. * * the alpha channel is the refraction intensity.
  49971. */
  49972. useMaskFromThicknessTexture: boolean;
  49973. /** @hidden */
  49974. private _internalMarkAllSubMeshesAsTexturesDirty;
  49975. /** @hidden */
  49976. _markAllSubMeshesAsTexturesDirty(): void;
  49977. /**
  49978. * Instantiate a new istance of sub surface configuration.
  49979. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  49980. */
  49981. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  49982. /**
  49983. * Gets wehter the submesh is ready to be used or not.
  49984. * @param defines the list of "defines" to update.
  49985. * @param scene defines the scene the material belongs to.
  49986. * @returns - boolean indicating that the submesh is ready or not.
  49987. */
  49988. isReadyForSubMesh(defines: IMaterialSubSurfaceDefines, scene: Scene): boolean;
  49989. /**
  49990. * Checks to see if a texture is used in the material.
  49991. * @param defines the list of "defines" to update.
  49992. * @param scene defines the scene to the material belongs to.
  49993. */
  49994. prepareDefines(defines: IMaterialSubSurfaceDefines, scene: Scene): void;
  49995. /**
  49996. * Binds the material data.
  49997. * @param uniformBuffer defines the Uniform buffer to fill in.
  49998. * @param scene defines the scene the material belongs to.
  49999. * @param engine defines the engine the material belongs to.
  50000. * @param isFrozen defines wether the material is frozen or not.
  50001. * @param lodBasedMicrosurface defines wether the material relies on lod based microsurface or not.
  50002. */
  50003. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, isFrozen: boolean, lodBasedMicrosurface: boolean): void;
  50004. /**
  50005. * Unbinds the material from the mesh.
  50006. * @param activeEffect defines the effect that should be unbound from.
  50007. * @returns true if unbound, otherwise false
  50008. */
  50009. unbind(activeEffect: Effect): boolean;
  50010. /**
  50011. * Returns the texture used for refraction or null if none is used.
  50012. * @param scene defines the scene the material belongs to.
  50013. * @returns - Refraction texture if present. If no refraction texture and refraction
  50014. * is linked with transparency, returns environment texture. Otherwise, returns null.
  50015. */
  50016. private _getRefractionTexture;
  50017. /**
  50018. * Returns true if alpha blending should be disabled.
  50019. */
  50020. readonly disableAlphaBlending: boolean;
  50021. /**
  50022. * Fills the list of render target textures.
  50023. * @param renderTargets the list of render targets to update
  50024. */
  50025. fillRenderTargetTextures(renderTargets: SmartArray<RenderTargetTexture>): void;
  50026. /**
  50027. * Checks to see if a texture is used in the material.
  50028. * @param texture - Base texture to use.
  50029. * @returns - Boolean specifying if a texture is used in the material.
  50030. */
  50031. hasTexture(texture: BaseTexture): boolean;
  50032. /**
  50033. * Gets a boolean indicating that current material needs to register RTT
  50034. * @returns true if this uses a render target otherwise false.
  50035. */
  50036. hasRenderTargetTextures(): boolean;
  50037. /**
  50038. * Returns an array of the actively used textures.
  50039. * @param activeTextures Array of BaseTextures
  50040. */
  50041. getActiveTextures(activeTextures: BaseTexture[]): void;
  50042. /**
  50043. * Returns the animatable textures.
  50044. * @param animatables Array of animatable textures.
  50045. */
  50046. getAnimatables(animatables: IAnimatable[]): void;
  50047. /**
  50048. * Disposes the resources of the material.
  50049. * @param forceDisposeTextures - Forces the disposal of all textures.
  50050. */
  50051. dispose(forceDisposeTextures?: boolean): void;
  50052. /**
  50053. * Get the current class name of the texture useful for serialization or dynamic coding.
  50054. * @returns "PBRSubSurfaceConfiguration"
  50055. */
  50056. getClassName(): string;
  50057. /**
  50058. * Add fallbacks to the effect fallbacks list.
  50059. * @param defines defines the Base texture to use.
  50060. * @param fallbacks defines the current fallback list.
  50061. * @param currentRank defines the current fallback rank.
  50062. * @returns the new fallback rank.
  50063. */
  50064. static AddFallbacks(defines: IMaterialSubSurfaceDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  50065. /**
  50066. * Add the required uniforms to the current list.
  50067. * @param uniforms defines the current uniform list.
  50068. */
  50069. static AddUniforms(uniforms: string[]): void;
  50070. /**
  50071. * Add the required samplers to the current list.
  50072. * @param samplers defines the current sampler list.
  50073. */
  50074. static AddSamplers(samplers: string[]): void;
  50075. /**
  50076. * Add the required uniforms to the current buffer.
  50077. * @param uniformBuffer defines the current uniform buffer.
  50078. */
  50079. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  50080. /**
  50081. * Makes a duplicate of the current configuration into another one.
  50082. * @param configuration define the config where to copy the info
  50083. */
  50084. copyTo(configuration: PBRSubSurfaceConfiguration): void;
  50085. /**
  50086. * Serializes this Sub Surface configuration.
  50087. * @returns - An object with the serialized config.
  50088. */
  50089. serialize(): any;
  50090. /**
  50091. * Parses a anisotropy Configuration from a serialized object.
  50092. * @param source - Serialized object.
  50093. * @param scene Defines the scene we are parsing for
  50094. * @param rootUrl Defines the rootUrl to load from
  50095. */
  50096. parse(source: any, scene: Scene, rootUrl: string): void;
  50097. }
  50098. }
  50099. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentDeclaration" {
  50100. /** @hidden */
  50101. export var pbrFragmentDeclaration: {
  50102. name: string;
  50103. shader: string;
  50104. };
  50105. }
  50106. declare module "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration" {
  50107. /** @hidden */
  50108. export var pbrUboDeclaration: {
  50109. name: string;
  50110. shader: string;
  50111. };
  50112. }
  50113. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentExtraDeclaration" {
  50114. /** @hidden */
  50115. export var pbrFragmentExtraDeclaration: {
  50116. name: string;
  50117. shader: string;
  50118. };
  50119. }
  50120. declare module "babylonjs/Shaders/ShadersInclude/pbrFragmentSamplersDeclaration" {
  50121. /** @hidden */
  50122. export var pbrFragmentSamplersDeclaration: {
  50123. name: string;
  50124. shader: string;
  50125. };
  50126. }
  50127. declare module "babylonjs/Shaders/ShadersInclude/pbrHelperFunctions" {
  50128. /** @hidden */
  50129. export var pbrHelperFunctions: {
  50130. name: string;
  50131. shader: string;
  50132. };
  50133. }
  50134. declare module "babylonjs/Shaders/ShadersInclude/harmonicsFunctions" {
  50135. /** @hidden */
  50136. export var harmonicsFunctions: {
  50137. name: string;
  50138. shader: string;
  50139. };
  50140. }
  50141. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingSetupFunctions" {
  50142. /** @hidden */
  50143. export var pbrDirectLightingSetupFunctions: {
  50144. name: string;
  50145. shader: string;
  50146. };
  50147. }
  50148. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFalloffFunctions" {
  50149. /** @hidden */
  50150. export var pbrDirectLightingFalloffFunctions: {
  50151. name: string;
  50152. shader: string;
  50153. };
  50154. }
  50155. declare module "babylonjs/Shaders/ShadersInclude/pbrBRDFFunctions" {
  50156. /** @hidden */
  50157. export var pbrBRDFFunctions: {
  50158. name: string;
  50159. shader: string;
  50160. };
  50161. }
  50162. declare module "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFunctions" {
  50163. /** @hidden */
  50164. export var pbrDirectLightingFunctions: {
  50165. name: string;
  50166. shader: string;
  50167. };
  50168. }
  50169. declare module "babylonjs/Shaders/ShadersInclude/pbrIBLFunctions" {
  50170. /** @hidden */
  50171. export var pbrIBLFunctions: {
  50172. name: string;
  50173. shader: string;
  50174. };
  50175. }
  50176. declare module "babylonjs/Shaders/ShadersInclude/pbrDebug" {
  50177. /** @hidden */
  50178. export var pbrDebug: {
  50179. name: string;
  50180. shader: string;
  50181. };
  50182. }
  50183. declare module "babylonjs/Shaders/pbr.fragment" {
  50184. import "babylonjs/Shaders/ShadersInclude/pbrFragmentDeclaration";
  50185. import "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration";
  50186. import "babylonjs/Shaders/ShadersInclude/pbrFragmentExtraDeclaration";
  50187. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  50188. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  50189. import "babylonjs/Shaders/ShadersInclude/pbrFragmentSamplersDeclaration";
  50190. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  50191. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration";
  50192. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  50193. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  50194. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  50195. import "babylonjs/Shaders/ShadersInclude/pbrHelperFunctions";
  50196. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  50197. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  50198. import "babylonjs/Shaders/ShadersInclude/harmonicsFunctions";
  50199. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingSetupFunctions";
  50200. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFalloffFunctions";
  50201. import "babylonjs/Shaders/ShadersInclude/pbrBRDFFunctions";
  50202. import "babylonjs/Shaders/ShadersInclude/pbrDirectLightingFunctions";
  50203. import "babylonjs/Shaders/ShadersInclude/pbrIBLFunctions";
  50204. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  50205. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  50206. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  50207. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  50208. import "babylonjs/Shaders/ShadersInclude/depthPrePass";
  50209. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  50210. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  50211. import "babylonjs/Shaders/ShadersInclude/fogFragment";
  50212. import "babylonjs/Shaders/ShadersInclude/pbrDebug";
  50213. /** @hidden */
  50214. export var pbrPixelShader: {
  50215. name: string;
  50216. shader: string;
  50217. };
  50218. }
  50219. declare module "babylonjs/Shaders/ShadersInclude/pbrVertexDeclaration" {
  50220. /** @hidden */
  50221. export var pbrVertexDeclaration: {
  50222. name: string;
  50223. shader: string;
  50224. };
  50225. }
  50226. declare module "babylonjs/Shaders/pbr.vertex" {
  50227. import "babylonjs/Shaders/ShadersInclude/pbrVertexDeclaration";
  50228. import "babylonjs/Shaders/ShadersInclude/pbrUboDeclaration";
  50229. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  50230. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  50231. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  50232. import "babylonjs/Shaders/ShadersInclude/harmonicsFunctions";
  50233. import "babylonjs/Shaders/ShadersInclude/bumpVertexDeclaration";
  50234. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration";
  50235. import "babylonjs/Shaders/ShadersInclude/fogVertexDeclaration";
  50236. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  50237. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  50238. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  50239. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  50240. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  50241. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  50242. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  50243. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  50244. import "babylonjs/Shaders/ShadersInclude/bumpVertex";
  50245. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  50246. import "babylonjs/Shaders/ShadersInclude/fogVertex";
  50247. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  50248. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  50249. /** @hidden */
  50250. export var pbrVertexShader: {
  50251. name: string;
  50252. shader: string;
  50253. };
  50254. }
  50255. declare module "babylonjs/Materials/PBR/pbrBaseMaterial" {
  50256. import { Nullable } from "babylonjs/types";
  50257. import { Scene } from "babylonjs/scene";
  50258. import { Matrix } from "babylonjs/Maths/math.vector";
  50259. import { SubMesh } from "babylonjs/Meshes/subMesh";
  50260. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  50261. import { Mesh } from "babylonjs/Meshes/mesh";
  50262. import { IMaterialClearCoatDefines, PBRClearCoatConfiguration } from "babylonjs/Materials/PBR/pbrClearCoatConfiguration";
  50263. import { IMaterialAnisotropicDefines, PBRAnisotropicConfiguration } from "babylonjs/Materials/PBR/pbrAnisotropicConfiguration";
  50264. import { IMaterialBRDFDefines, PBRBRDFConfiguration } from "babylonjs/Materials/PBR/pbrBRDFConfiguration";
  50265. import { IMaterialSheenDefines, PBRSheenConfiguration } from "babylonjs/Materials/PBR/pbrSheenConfiguration";
  50266. import { IMaterialSubSurfaceDefines, PBRSubSurfaceConfiguration } from "babylonjs/Materials/PBR/pbrSubSurfaceConfiguration";
  50267. import { Color3 } from "babylonjs/Maths/math.color";
  50268. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  50269. import { Material, IMaterialCompilationOptions } from "babylonjs/Materials/material";
  50270. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  50271. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  50272. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  50273. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  50274. import "babylonjs/Materials/Textures/baseTexture.polynomial";
  50275. import "babylonjs/Shaders/pbr.fragment";
  50276. import "babylonjs/Shaders/pbr.vertex";
  50277. /**
  50278. * Manages the defines for the PBR Material.
  50279. * @hidden
  50280. */
  50281. export class PBRMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialClearCoatDefines, IMaterialAnisotropicDefines, IMaterialBRDFDefines, IMaterialSheenDefines, IMaterialSubSurfaceDefines {
  50282. PBR: boolean;
  50283. MAINUV1: boolean;
  50284. MAINUV2: boolean;
  50285. UV1: boolean;
  50286. UV2: boolean;
  50287. ALBEDO: boolean;
  50288. ALBEDODIRECTUV: number;
  50289. VERTEXCOLOR: boolean;
  50290. AMBIENT: boolean;
  50291. AMBIENTDIRECTUV: number;
  50292. AMBIENTINGRAYSCALE: boolean;
  50293. OPACITY: boolean;
  50294. VERTEXALPHA: boolean;
  50295. OPACITYDIRECTUV: number;
  50296. OPACITYRGB: boolean;
  50297. ALPHATEST: boolean;
  50298. DEPTHPREPASS: boolean;
  50299. ALPHABLEND: boolean;
  50300. ALPHAFROMALBEDO: boolean;
  50301. ALPHATESTVALUE: string;
  50302. SPECULAROVERALPHA: boolean;
  50303. RADIANCEOVERALPHA: boolean;
  50304. ALPHAFRESNEL: boolean;
  50305. LINEARALPHAFRESNEL: boolean;
  50306. PREMULTIPLYALPHA: boolean;
  50307. EMISSIVE: boolean;
  50308. EMISSIVEDIRECTUV: number;
  50309. REFLECTIVITY: boolean;
  50310. REFLECTIVITYDIRECTUV: number;
  50311. SPECULARTERM: boolean;
  50312. MICROSURFACEFROMREFLECTIVITYMAP: boolean;
  50313. MICROSURFACEAUTOMATIC: boolean;
  50314. LODBASEDMICROSFURACE: boolean;
  50315. MICROSURFACEMAP: boolean;
  50316. MICROSURFACEMAPDIRECTUV: number;
  50317. METALLICWORKFLOW: boolean;
  50318. ROUGHNESSSTOREINMETALMAPALPHA: boolean;
  50319. ROUGHNESSSTOREINMETALMAPGREEN: boolean;
  50320. METALLNESSSTOREINMETALMAPBLUE: boolean;
  50321. AOSTOREINMETALMAPRED: boolean;
  50322. METALLICF0FACTORFROMMETALLICMAP: boolean;
  50323. ENVIRONMENTBRDF: boolean;
  50324. ENVIRONMENTBRDF_RGBD: boolean;
  50325. NORMAL: boolean;
  50326. TANGENT: boolean;
  50327. BUMP: boolean;
  50328. BUMPDIRECTUV: number;
  50329. OBJECTSPACE_NORMALMAP: boolean;
  50330. PARALLAX: boolean;
  50331. PARALLAXOCCLUSION: boolean;
  50332. NORMALXYSCALE: boolean;
  50333. LIGHTMAP: boolean;
  50334. LIGHTMAPDIRECTUV: number;
  50335. USELIGHTMAPASSHADOWMAP: boolean;
  50336. GAMMALIGHTMAP: boolean;
  50337. RGBDLIGHTMAP: boolean;
  50338. REFLECTION: boolean;
  50339. REFLECTIONMAP_3D: boolean;
  50340. REFLECTIONMAP_SPHERICAL: boolean;
  50341. REFLECTIONMAP_PLANAR: boolean;
  50342. REFLECTIONMAP_CUBIC: boolean;
  50343. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  50344. REFLECTIONMAP_PROJECTION: boolean;
  50345. REFLECTIONMAP_SKYBOX: boolean;
  50346. REFLECTIONMAP_SKYBOX_TRANSFORMED: boolean;
  50347. REFLECTIONMAP_EXPLICIT: boolean;
  50348. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  50349. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  50350. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  50351. INVERTCUBICMAP: boolean;
  50352. USESPHERICALFROMREFLECTIONMAP: boolean;
  50353. USEIRRADIANCEMAP: boolean;
  50354. SPHERICAL_HARMONICS: boolean;
  50355. USESPHERICALINVERTEX: boolean;
  50356. REFLECTIONMAP_OPPOSITEZ: boolean;
  50357. LODINREFLECTIONALPHA: boolean;
  50358. GAMMAREFLECTION: boolean;
  50359. RGBDREFLECTION: boolean;
  50360. LINEARSPECULARREFLECTION: boolean;
  50361. RADIANCEOCCLUSION: boolean;
  50362. HORIZONOCCLUSION: boolean;
  50363. INSTANCES: boolean;
  50364. NUM_BONE_INFLUENCERS: number;
  50365. BonesPerMesh: number;
  50366. BONETEXTURE: boolean;
  50367. NONUNIFORMSCALING: boolean;
  50368. MORPHTARGETS: boolean;
  50369. MORPHTARGETS_NORMAL: boolean;
  50370. MORPHTARGETS_TANGENT: boolean;
  50371. MORPHTARGETS_UV: boolean;
  50372. NUM_MORPH_INFLUENCERS: number;
  50373. IMAGEPROCESSING: boolean;
  50374. VIGNETTE: boolean;
  50375. VIGNETTEBLENDMODEMULTIPLY: boolean;
  50376. VIGNETTEBLENDMODEOPAQUE: boolean;
  50377. TONEMAPPING: boolean;
  50378. TONEMAPPING_ACES: boolean;
  50379. CONTRAST: boolean;
  50380. COLORCURVES: boolean;
  50381. COLORGRADING: boolean;
  50382. COLORGRADING3D: boolean;
  50383. SAMPLER3DGREENDEPTH: boolean;
  50384. SAMPLER3DBGRMAP: boolean;
  50385. IMAGEPROCESSINGPOSTPROCESS: boolean;
  50386. EXPOSURE: boolean;
  50387. MULTIVIEW: boolean;
  50388. USEPHYSICALLIGHTFALLOFF: boolean;
  50389. USEGLTFLIGHTFALLOFF: boolean;
  50390. TWOSIDEDLIGHTING: boolean;
  50391. SHADOWFLOAT: boolean;
  50392. CLIPPLANE: boolean;
  50393. CLIPPLANE2: boolean;
  50394. CLIPPLANE3: boolean;
  50395. CLIPPLANE4: boolean;
  50396. POINTSIZE: boolean;
  50397. FOG: boolean;
  50398. LOGARITHMICDEPTH: boolean;
  50399. FORCENORMALFORWARD: boolean;
  50400. SPECULARAA: boolean;
  50401. CLEARCOAT: boolean;
  50402. CLEARCOAT_DEFAULTIOR: boolean;
  50403. CLEARCOAT_TEXTURE: boolean;
  50404. CLEARCOAT_TEXTUREDIRECTUV: number;
  50405. CLEARCOAT_BUMP: boolean;
  50406. CLEARCOAT_BUMPDIRECTUV: number;
  50407. CLEARCOAT_TINT: boolean;
  50408. CLEARCOAT_TINT_TEXTURE: boolean;
  50409. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  50410. ANISOTROPIC: boolean;
  50411. ANISOTROPIC_TEXTURE: boolean;
  50412. ANISOTROPIC_TEXTUREDIRECTUV: number;
  50413. BRDF_V_HEIGHT_CORRELATED: boolean;
  50414. MS_BRDF_ENERGY_CONSERVATION: boolean;
  50415. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  50416. SHEEN: boolean;
  50417. SHEEN_TEXTURE: boolean;
  50418. SHEEN_TEXTUREDIRECTUV: number;
  50419. SHEEN_LINKWITHALBEDO: boolean;
  50420. SUBSURFACE: boolean;
  50421. SS_REFRACTION: boolean;
  50422. SS_TRANSLUCENCY: boolean;
  50423. SS_SCATERRING: boolean;
  50424. SS_THICKNESSANDMASK_TEXTURE: boolean;
  50425. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  50426. SS_REFRACTIONMAP_3D: boolean;
  50427. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  50428. SS_LODINREFRACTIONALPHA: boolean;
  50429. SS_GAMMAREFRACTION: boolean;
  50430. SS_RGBDREFRACTION: boolean;
  50431. SS_LINEARSPECULARREFRACTION: boolean;
  50432. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  50433. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  50434. UNLIT: boolean;
  50435. DEBUGMODE: number;
  50436. /**
  50437. * Initializes the PBR Material defines.
  50438. */
  50439. constructor();
  50440. /**
  50441. * Resets the PBR Material defines.
  50442. */
  50443. reset(): void;
  50444. }
  50445. /**
  50446. * The Physically based material base class of BJS.
  50447. *
  50448. * This offers the main features of a standard PBR material.
  50449. * For more information, please refer to the documentation :
  50450. * https://doc.babylonjs.com/how_to/physically_based_rendering
  50451. */
  50452. export abstract class PBRBaseMaterial extends PushMaterial {
  50453. /**
  50454. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  50455. */
  50456. static readonly PBRMATERIAL_OPAQUE: number;
  50457. /**
  50458. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  50459. */
  50460. static readonly PBRMATERIAL_ALPHATEST: number;
  50461. /**
  50462. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  50463. */
  50464. static readonly PBRMATERIAL_ALPHABLEND: number;
  50465. /**
  50466. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  50467. * They are also discarded below the alpha cutoff threshold to improve performances.
  50468. */
  50469. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  50470. /**
  50471. * Defines the default value of how much AO map is occluding the analytical lights
  50472. * (point spot...).
  50473. */
  50474. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  50475. /**
  50476. * PBRMaterialLightFalloff Physical: light is falling off following the inverse squared distance law.
  50477. */
  50478. static readonly LIGHTFALLOFF_PHYSICAL: number;
  50479. /**
  50480. * PBRMaterialLightFalloff gltf: light is falling off as described in the gltf moving to PBR document
  50481. * to enhance interoperability with other engines.
  50482. */
  50483. static readonly LIGHTFALLOFF_GLTF: number;
  50484. /**
  50485. * PBRMaterialLightFalloff Standard: light is falling off like in the standard material
  50486. * to enhance interoperability with other materials.
  50487. */
  50488. static readonly LIGHTFALLOFF_STANDARD: number;
  50489. /**
  50490. * Intensity of the direct lights e.g. the four lights available in your scene.
  50491. * This impacts both the direct diffuse and specular highlights.
  50492. */
  50493. protected _directIntensity: number;
  50494. /**
  50495. * Intensity of the emissive part of the material.
  50496. * This helps controlling the emissive effect without modifying the emissive color.
  50497. */
  50498. protected _emissiveIntensity: number;
  50499. /**
  50500. * Intensity of the environment e.g. how much the environment will light the object
  50501. * either through harmonics for rough material or through the refelction for shiny ones.
  50502. */
  50503. protected _environmentIntensity: number;
  50504. /**
  50505. * This is a special control allowing the reduction of the specular highlights coming from the
  50506. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  50507. */
  50508. protected _specularIntensity: number;
  50509. /**
  50510. * This stores the direct, emissive, environment, and specular light intensities into a Vector4.
  50511. */
  50512. private _lightingInfos;
  50513. /**
  50514. * Debug Control allowing disabling the bump map on this material.
  50515. */
  50516. protected _disableBumpMap: boolean;
  50517. /**
  50518. * AKA Diffuse Texture in standard nomenclature.
  50519. */
  50520. protected _albedoTexture: Nullable<BaseTexture>;
  50521. /**
  50522. * AKA Occlusion Texture in other nomenclature.
  50523. */
  50524. protected _ambientTexture: Nullable<BaseTexture>;
  50525. /**
  50526. * AKA Occlusion Texture Intensity in other nomenclature.
  50527. */
  50528. protected _ambientTextureStrength: number;
  50529. /**
  50530. * Defines how much the AO map is occluding the analytical lights (point spot...).
  50531. * 1 means it completely occludes it
  50532. * 0 mean it has no impact
  50533. */
  50534. protected _ambientTextureImpactOnAnalyticalLights: number;
  50535. /**
  50536. * Stores the alpha values in a texture.
  50537. */
  50538. protected _opacityTexture: Nullable<BaseTexture>;
  50539. /**
  50540. * Stores the reflection values in a texture.
  50541. */
  50542. protected _reflectionTexture: Nullable<BaseTexture>;
  50543. /**
  50544. * Stores the emissive values in a texture.
  50545. */
  50546. protected _emissiveTexture: Nullable<BaseTexture>;
  50547. /**
  50548. * AKA Specular texture in other nomenclature.
  50549. */
  50550. protected _reflectivityTexture: Nullable<BaseTexture>;
  50551. /**
  50552. * Used to switch from specular/glossiness to metallic/roughness workflow.
  50553. */
  50554. protected _metallicTexture: Nullable<BaseTexture>;
  50555. /**
  50556. * Specifies the metallic scalar of the metallic/roughness workflow.
  50557. * Can also be used to scale the metalness values of the metallic texture.
  50558. */
  50559. protected _metallic: Nullable<number>;
  50560. /**
  50561. * Specifies the roughness scalar of the metallic/roughness workflow.
  50562. * Can also be used to scale the roughness values of the metallic texture.
  50563. */
  50564. protected _roughness: Nullable<number>;
  50565. /**
  50566. * Specifies the an F0 factor to help configuring the material F0.
  50567. * Instead of the default 4%, 8% * factor will be used. As the factor is defaulting
  50568. * to 0.5 the previously hard coded value stays the same.
  50569. * Can also be used to scale the F0 values of the metallic texture.
  50570. */
  50571. protected _metallicF0Factor: number;
  50572. /**
  50573. * Specifies whether the F0 factor can be fetched from the mettalic texture.
  50574. * If set to true, please adapt the metallicF0Factor to ensure it fits with
  50575. * your expectation as it multiplies with the texture data.
  50576. */
  50577. protected _useMetallicF0FactorFromMetallicTexture: boolean;
  50578. /**
  50579. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  50580. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  50581. */
  50582. protected _microSurfaceTexture: Nullable<BaseTexture>;
  50583. /**
  50584. * Stores surface normal data used to displace a mesh in a texture.
  50585. */
  50586. protected _bumpTexture: Nullable<BaseTexture>;
  50587. /**
  50588. * Stores the pre-calculated light information of a mesh in a texture.
  50589. */
  50590. protected _lightmapTexture: Nullable<BaseTexture>;
  50591. /**
  50592. * The color of a material in ambient lighting.
  50593. */
  50594. protected _ambientColor: Color3;
  50595. /**
  50596. * AKA Diffuse Color in other nomenclature.
  50597. */
  50598. protected _albedoColor: Color3;
  50599. /**
  50600. * AKA Specular Color in other nomenclature.
  50601. */
  50602. protected _reflectivityColor: Color3;
  50603. /**
  50604. * The color applied when light is reflected from a material.
  50605. */
  50606. protected _reflectionColor: Color3;
  50607. /**
  50608. * The color applied when light is emitted from a material.
  50609. */
  50610. protected _emissiveColor: Color3;
  50611. /**
  50612. * AKA Glossiness in other nomenclature.
  50613. */
  50614. protected _microSurface: number;
  50615. /**
  50616. * Specifies that the material will use the light map as a show map.
  50617. */
  50618. protected _useLightmapAsShadowmap: boolean;
  50619. /**
  50620. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  50621. * makes the reflect vector face the model (under horizon).
  50622. */
  50623. protected _useHorizonOcclusion: boolean;
  50624. /**
  50625. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  50626. * too much the area relying on ambient texture to define their ambient occlusion.
  50627. */
  50628. protected _useRadianceOcclusion: boolean;
  50629. /**
  50630. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  50631. */
  50632. protected _useAlphaFromAlbedoTexture: boolean;
  50633. /**
  50634. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most limunous ones).
  50635. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  50636. */
  50637. protected _useSpecularOverAlpha: boolean;
  50638. /**
  50639. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  50640. */
  50641. protected _useMicroSurfaceFromReflectivityMapAlpha: boolean;
  50642. /**
  50643. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  50644. */
  50645. protected _useRoughnessFromMetallicTextureAlpha: boolean;
  50646. /**
  50647. * Specifies if the metallic texture contains the roughness information in its green channel.
  50648. */
  50649. protected _useRoughnessFromMetallicTextureGreen: boolean;
  50650. /**
  50651. * Specifies if the metallic texture contains the metallness information in its blue channel.
  50652. */
  50653. protected _useMetallnessFromMetallicTextureBlue: boolean;
  50654. /**
  50655. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  50656. */
  50657. protected _useAmbientOcclusionFromMetallicTextureRed: boolean;
  50658. /**
  50659. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  50660. */
  50661. protected _useAmbientInGrayScale: boolean;
  50662. /**
  50663. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  50664. * The material will try to infer what glossiness each pixel should be.
  50665. */
  50666. protected _useAutoMicroSurfaceFromReflectivityMap: boolean;
  50667. /**
  50668. * Defines the falloff type used in this material.
  50669. * It by default is Physical.
  50670. */
  50671. protected _lightFalloff: number;
  50672. /**
  50673. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  50674. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  50675. */
  50676. protected _useRadianceOverAlpha: boolean;
  50677. /**
  50678. * Allows using an object space normal map (instead of tangent space).
  50679. */
  50680. protected _useObjectSpaceNormalMap: boolean;
  50681. /**
  50682. * Allows using the bump map in parallax mode.
  50683. */
  50684. protected _useParallax: boolean;
  50685. /**
  50686. * Allows using the bump map in parallax occlusion mode.
  50687. */
  50688. protected _useParallaxOcclusion: boolean;
  50689. /**
  50690. * Controls the scale bias of the parallax mode.
  50691. */
  50692. protected _parallaxScaleBias: number;
  50693. /**
  50694. * If sets to true, disables all the lights affecting the material.
  50695. */
  50696. protected _disableLighting: boolean;
  50697. /**
  50698. * Number of Simultaneous lights allowed on the material.
  50699. */
  50700. protected _maxSimultaneousLights: number;
  50701. /**
  50702. * If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  50703. */
  50704. protected _invertNormalMapX: boolean;
  50705. /**
  50706. * If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  50707. */
  50708. protected _invertNormalMapY: boolean;
  50709. /**
  50710. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  50711. */
  50712. protected _twoSidedLighting: boolean;
  50713. /**
  50714. * Defines the alpha limits in alpha test mode.
  50715. */
  50716. protected _alphaCutOff: number;
  50717. /**
  50718. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  50719. */
  50720. protected _forceAlphaTest: boolean;
  50721. /**
  50722. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  50723. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  50724. */
  50725. protected _useAlphaFresnel: boolean;
  50726. /**
  50727. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  50728. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  50729. */
  50730. protected _useLinearAlphaFresnel: boolean;
  50731. /**
  50732. * The transparency mode of the material.
  50733. */
  50734. protected _transparencyMode: Nullable<number>;
  50735. /**
  50736. * Specifies the environment BRDF texture used to comput the scale and offset roughness values
  50737. * from cos thetav and roughness:
  50738. * http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf
  50739. */
  50740. protected _environmentBRDFTexture: Nullable<BaseTexture>;
  50741. /**
  50742. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  50743. */
  50744. protected _forceIrradianceInFragment: boolean;
  50745. /**
  50746. * Force normal to face away from face.
  50747. */
  50748. protected _forceNormalForward: boolean;
  50749. /**
  50750. * Enables specular anti aliasing in the PBR shader.
  50751. * It will both interacts on the Geometry for analytical and IBL lighting.
  50752. * It also prefilter the roughness map based on the bump values.
  50753. */
  50754. protected _enableSpecularAntiAliasing: boolean;
  50755. /**
  50756. * Default configuration related to image processing available in the PBR Material.
  50757. */
  50758. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  50759. /**
  50760. * Keep track of the image processing observer to allow dispose and replace.
  50761. */
  50762. private _imageProcessingObserver;
  50763. /**
  50764. * Attaches a new image processing configuration to the PBR Material.
  50765. * @param configuration
  50766. */
  50767. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  50768. /**
  50769. * Stores the available render targets.
  50770. */
  50771. private _renderTargets;
  50772. /**
  50773. * Sets the global ambient color for the material used in lighting calculations.
  50774. */
  50775. private _globalAmbientColor;
  50776. /**
  50777. * Enables the use of logarithmic depth buffers, which is good for wide depth buffers.
  50778. */
  50779. private _useLogarithmicDepth;
  50780. /**
  50781. * If set to true, no lighting calculations will be applied.
  50782. */
  50783. private _unlit;
  50784. private _debugMode;
  50785. /**
  50786. * @hidden
  50787. * This is reserved for the inspector.
  50788. * Defines the material debug mode.
  50789. * It helps seeing only some components of the material while troubleshooting.
  50790. */
  50791. debugMode: number;
  50792. /**
  50793. * @hidden
  50794. * This is reserved for the inspector.
  50795. * Specify from where on screen the debug mode should start.
  50796. * The value goes from -1 (full screen) to 1 (not visible)
  50797. * It helps with side by side comparison against the final render
  50798. * This defaults to -1
  50799. */
  50800. private debugLimit;
  50801. /**
  50802. * @hidden
  50803. * This is reserved for the inspector.
  50804. * As the default viewing range might not be enough (if the ambient is really small for instance)
  50805. * You can use the factor to better multiply the final value.
  50806. */
  50807. private debugFactor;
  50808. /**
  50809. * Defines the clear coat layer parameters for the material.
  50810. */
  50811. readonly clearCoat: PBRClearCoatConfiguration;
  50812. /**
  50813. * Defines the anisotropic parameters for the material.
  50814. */
  50815. readonly anisotropy: PBRAnisotropicConfiguration;
  50816. /**
  50817. * Defines the BRDF parameters for the material.
  50818. */
  50819. readonly brdf: PBRBRDFConfiguration;
  50820. /**
  50821. * Defines the Sheen parameters for the material.
  50822. */
  50823. readonly sheen: PBRSheenConfiguration;
  50824. /**
  50825. * Defines the SubSurface parameters for the material.
  50826. */
  50827. readonly subSurface: PBRSubSurfaceConfiguration;
  50828. /**
  50829. * Custom callback helping to override the default shader used in the material.
  50830. */
  50831. customShaderNameResolve: (shaderName: string, uniforms: string[], uniformBuffers: string[], samplers: string[], defines: PBRMaterialDefines) => string;
  50832. protected _rebuildInParallel: boolean;
  50833. /**
  50834. * Instantiates a new PBRMaterial instance.
  50835. *
  50836. * @param name The material name
  50837. * @param scene The scene the material will be use in.
  50838. */
  50839. constructor(name: string, scene: Scene);
  50840. /**
  50841. * Gets a boolean indicating that current material needs to register RTT
  50842. */
  50843. readonly hasRenderTargetTextures: boolean;
  50844. /**
  50845. * Gets the name of the material class.
  50846. */
  50847. getClassName(): string;
  50848. /**
  50849. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  50850. */
  50851. /**
  50852. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  50853. */
  50854. useLogarithmicDepth: boolean;
  50855. /**
  50856. * Gets the current transparency mode.
  50857. */
  50858. /**
  50859. * Sets the transparency mode of the material.
  50860. *
  50861. * | Value | Type | Description |
  50862. * | ----- | ----------------------------------- | ----------- |
  50863. * | 0 | OPAQUE | |
  50864. * | 1 | ALPHATEST | |
  50865. * | 2 | ALPHABLEND | |
  50866. * | 3 | ALPHATESTANDBLEND | |
  50867. *
  50868. */
  50869. transparencyMode: Nullable<number>;
  50870. /**
  50871. * Returns true if alpha blending should be disabled.
  50872. */
  50873. private readonly _disableAlphaBlending;
  50874. /**
  50875. * Specifies whether or not this material should be rendered in alpha blend mode.
  50876. */
  50877. needAlphaBlending(): boolean;
  50878. /**
  50879. * Specifies if the mesh will require alpha blending.
  50880. * @param mesh - BJS mesh.
  50881. */
  50882. needAlphaBlendingForMesh(mesh: AbstractMesh): boolean;
  50883. /**
  50884. * Specifies whether or not this material should be rendered in alpha test mode.
  50885. */
  50886. needAlphaTesting(): boolean;
  50887. /**
  50888. * Specifies whether or not the alpha value of the albedo texture should be used for alpha blending.
  50889. */
  50890. protected _shouldUseAlphaFromAlbedoTexture(): boolean;
  50891. /**
  50892. * Gets the texture used for the alpha test.
  50893. */
  50894. getAlphaTestTexture(): Nullable<BaseTexture>;
  50895. /**
  50896. * Specifies that the submesh is ready to be used.
  50897. * @param mesh - BJS mesh.
  50898. * @param subMesh - A submesh of the BJS mesh. Used to check if it is ready.
  50899. * @param useInstances - Specifies that instances should be used.
  50900. * @returns - boolean indicating that the submesh is ready or not.
  50901. */
  50902. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  50903. /**
  50904. * Specifies if the material uses metallic roughness workflow.
  50905. * @returns boolean specifiying if the material uses metallic roughness workflow.
  50906. */
  50907. isMetallicWorkflow(): boolean;
  50908. private _prepareEffect;
  50909. private _prepareDefines;
  50910. /**
  50911. * Force shader compilation
  50912. */
  50913. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>): void;
  50914. /**
  50915. * Initializes the uniform buffer layout for the shader.
  50916. */
  50917. buildUniformLayout(): void;
  50918. /**
  50919. * Unbinds the material from the mesh
  50920. */
  50921. unbind(): void;
  50922. /**
  50923. * Binds the submesh data.
  50924. * @param world - The world matrix.
  50925. * @param mesh - The BJS mesh.
  50926. * @param subMesh - A submesh of the BJS mesh.
  50927. */
  50928. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  50929. /**
  50930. * Returns the animatable textures.
  50931. * @returns - Array of animatable textures.
  50932. */
  50933. getAnimatables(): IAnimatable[];
  50934. /**
  50935. * Returns the texture used for reflections.
  50936. * @returns - Reflection texture if present. Otherwise, returns the environment texture.
  50937. */
  50938. private _getReflectionTexture;
  50939. /**
  50940. * Returns an array of the actively used textures.
  50941. * @returns - Array of BaseTextures
  50942. */
  50943. getActiveTextures(): BaseTexture[];
  50944. /**
  50945. * Checks to see if a texture is used in the material.
  50946. * @param texture - Base texture to use.
  50947. * @returns - Boolean specifying if a texture is used in the material.
  50948. */
  50949. hasTexture(texture: BaseTexture): boolean;
  50950. /**
  50951. * Disposes the resources of the material.
  50952. * @param forceDisposeEffect - Forces the disposal of effects.
  50953. * @param forceDisposeTextures - Forces the disposal of all textures.
  50954. */
  50955. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  50956. }
  50957. }
  50958. declare module "babylonjs/Materials/PBR/pbrMaterial" {
  50959. import { Nullable } from "babylonjs/types";
  50960. import { Scene } from "babylonjs/scene";
  50961. import { Color3 } from "babylonjs/Maths/math.color";
  50962. import { ImageProcessingConfiguration } from "babylonjs/Materials/imageProcessingConfiguration";
  50963. import { ColorCurves } from "babylonjs/Materials/colorCurves";
  50964. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  50965. import { PBRBaseMaterial } from "babylonjs/Materials/PBR/pbrBaseMaterial";
  50966. /**
  50967. * The Physically based material of BJS.
  50968. *
  50969. * This offers the main features of a standard PBR material.
  50970. * For more information, please refer to the documentation :
  50971. * https://doc.babylonjs.com/how_to/physically_based_rendering
  50972. */
  50973. export class PBRMaterial extends PBRBaseMaterial {
  50974. /**
  50975. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  50976. */
  50977. static readonly PBRMATERIAL_OPAQUE: number;
  50978. /**
  50979. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  50980. */
  50981. static readonly PBRMATERIAL_ALPHATEST: number;
  50982. /**
  50983. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  50984. */
  50985. static readonly PBRMATERIAL_ALPHABLEND: number;
  50986. /**
  50987. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  50988. * They are also discarded below the alpha cutoff threshold to improve performances.
  50989. */
  50990. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  50991. /**
  50992. * Defines the default value of how much AO map is occluding the analytical lights
  50993. * (point spot...).
  50994. */
  50995. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  50996. /**
  50997. * Intensity of the direct lights e.g. the four lights available in your scene.
  50998. * This impacts both the direct diffuse and specular highlights.
  50999. */
  51000. directIntensity: number;
  51001. /**
  51002. * Intensity of the emissive part of the material.
  51003. * This helps controlling the emissive effect without modifying the emissive color.
  51004. */
  51005. emissiveIntensity: number;
  51006. /**
  51007. * Intensity of the environment e.g. how much the environment will light the object
  51008. * either through harmonics for rough material or through the refelction for shiny ones.
  51009. */
  51010. environmentIntensity: number;
  51011. /**
  51012. * This is a special control allowing the reduction of the specular highlights coming from the
  51013. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  51014. */
  51015. specularIntensity: number;
  51016. /**
  51017. * Debug Control allowing disabling the bump map on this material.
  51018. */
  51019. disableBumpMap: boolean;
  51020. /**
  51021. * AKA Diffuse Texture in standard nomenclature.
  51022. */
  51023. albedoTexture: BaseTexture;
  51024. /**
  51025. * AKA Occlusion Texture in other nomenclature.
  51026. */
  51027. ambientTexture: BaseTexture;
  51028. /**
  51029. * AKA Occlusion Texture Intensity in other nomenclature.
  51030. */
  51031. ambientTextureStrength: number;
  51032. /**
  51033. * Defines how much the AO map is occluding the analytical lights (point spot...).
  51034. * 1 means it completely occludes it
  51035. * 0 mean it has no impact
  51036. */
  51037. ambientTextureImpactOnAnalyticalLights: number;
  51038. /**
  51039. * Stores the alpha values in a texture.
  51040. */
  51041. opacityTexture: BaseTexture;
  51042. /**
  51043. * Stores the reflection values in a texture.
  51044. */
  51045. reflectionTexture: Nullable<BaseTexture>;
  51046. /**
  51047. * Stores the emissive values in a texture.
  51048. */
  51049. emissiveTexture: BaseTexture;
  51050. /**
  51051. * AKA Specular texture in other nomenclature.
  51052. */
  51053. reflectivityTexture: BaseTexture;
  51054. /**
  51055. * Used to switch from specular/glossiness to metallic/roughness workflow.
  51056. */
  51057. metallicTexture: BaseTexture;
  51058. /**
  51059. * Specifies the metallic scalar of the metallic/roughness workflow.
  51060. * Can also be used to scale the metalness values of the metallic texture.
  51061. */
  51062. metallic: Nullable<number>;
  51063. /**
  51064. * Specifies the roughness scalar of the metallic/roughness workflow.
  51065. * Can also be used to scale the roughness values of the metallic texture.
  51066. */
  51067. roughness: Nullable<number>;
  51068. /**
  51069. * Specifies the an F0 factor to help configuring the material F0.
  51070. * Instead of the default 4%, 8% * factor will be used. As the factor is defaulting
  51071. * to 0.5 the previously hard coded value stays the same.
  51072. * Can also be used to scale the F0 values of the metallic texture.
  51073. */
  51074. metallicF0Factor: number;
  51075. /**
  51076. * Specifies whether the F0 factor can be fetched from the mettalic texture.
  51077. * If set to true, please adapt the metallicF0Factor to ensure it fits with
  51078. * your expectation as it multiplies with the texture data.
  51079. */
  51080. useMetallicF0FactorFromMetallicTexture: boolean;
  51081. /**
  51082. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  51083. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  51084. */
  51085. microSurfaceTexture: BaseTexture;
  51086. /**
  51087. * Stores surface normal data used to displace a mesh in a texture.
  51088. */
  51089. bumpTexture: BaseTexture;
  51090. /**
  51091. * Stores the pre-calculated light information of a mesh in a texture.
  51092. */
  51093. lightmapTexture: BaseTexture;
  51094. /**
  51095. * Stores the refracted light information in a texture.
  51096. */
  51097. refractionTexture: Nullable<BaseTexture>;
  51098. /**
  51099. * The color of a material in ambient lighting.
  51100. */
  51101. ambientColor: Color3;
  51102. /**
  51103. * AKA Diffuse Color in other nomenclature.
  51104. */
  51105. albedoColor: Color3;
  51106. /**
  51107. * AKA Specular Color in other nomenclature.
  51108. */
  51109. reflectivityColor: Color3;
  51110. /**
  51111. * The color reflected from the material.
  51112. */
  51113. reflectionColor: Color3;
  51114. /**
  51115. * The color emitted from the material.
  51116. */
  51117. emissiveColor: Color3;
  51118. /**
  51119. * AKA Glossiness in other nomenclature.
  51120. */
  51121. microSurface: number;
  51122. /**
  51123. * source material index of refraction (IOR)' / 'destination material IOR.
  51124. */
  51125. indexOfRefraction: number;
  51126. /**
  51127. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  51128. */
  51129. invertRefractionY: boolean;
  51130. /**
  51131. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  51132. * Materials half opaque for instance using refraction could benefit from this control.
  51133. */
  51134. linkRefractionWithTransparency: boolean;
  51135. /**
  51136. * If true, the light map contains occlusion information instead of lighting info.
  51137. */
  51138. useLightmapAsShadowmap: boolean;
  51139. /**
  51140. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  51141. */
  51142. useAlphaFromAlbedoTexture: boolean;
  51143. /**
  51144. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  51145. */
  51146. forceAlphaTest: boolean;
  51147. /**
  51148. * Defines the alpha limits in alpha test mode.
  51149. */
  51150. alphaCutOff: number;
  51151. /**
  51152. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  51153. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  51154. */
  51155. useSpecularOverAlpha: boolean;
  51156. /**
  51157. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  51158. */
  51159. useMicroSurfaceFromReflectivityMapAlpha: boolean;
  51160. /**
  51161. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  51162. */
  51163. useRoughnessFromMetallicTextureAlpha: boolean;
  51164. /**
  51165. * Specifies if the metallic texture contains the roughness information in its green channel.
  51166. */
  51167. useRoughnessFromMetallicTextureGreen: boolean;
  51168. /**
  51169. * Specifies if the metallic texture contains the metallness information in its blue channel.
  51170. */
  51171. useMetallnessFromMetallicTextureBlue: boolean;
  51172. /**
  51173. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  51174. */
  51175. useAmbientOcclusionFromMetallicTextureRed: boolean;
  51176. /**
  51177. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  51178. */
  51179. useAmbientInGrayScale: boolean;
  51180. /**
  51181. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  51182. * The material will try to infer what glossiness each pixel should be.
  51183. */
  51184. useAutoMicroSurfaceFromReflectivityMap: boolean;
  51185. /**
  51186. * BJS is using an harcoded light falloff based on a manually sets up range.
  51187. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  51188. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  51189. */
  51190. /**
  51191. * BJS is using an harcoded light falloff based on a manually sets up range.
  51192. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  51193. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  51194. */
  51195. usePhysicalLightFalloff: boolean;
  51196. /**
  51197. * In order to support the falloff compatibility with gltf, a special mode has been added
  51198. * to reproduce the gltf light falloff.
  51199. */
  51200. /**
  51201. * In order to support the falloff compatibility with gltf, a special mode has been added
  51202. * to reproduce the gltf light falloff.
  51203. */
  51204. useGLTFLightFalloff: boolean;
  51205. /**
  51206. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  51207. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  51208. */
  51209. useRadianceOverAlpha: boolean;
  51210. /**
  51211. * Allows using an object space normal map (instead of tangent space).
  51212. */
  51213. useObjectSpaceNormalMap: boolean;
  51214. /**
  51215. * Allows using the bump map in parallax mode.
  51216. */
  51217. useParallax: boolean;
  51218. /**
  51219. * Allows using the bump map in parallax occlusion mode.
  51220. */
  51221. useParallaxOcclusion: boolean;
  51222. /**
  51223. * Controls the scale bias of the parallax mode.
  51224. */
  51225. parallaxScaleBias: number;
  51226. /**
  51227. * If sets to true, disables all the lights affecting the material.
  51228. */
  51229. disableLighting: boolean;
  51230. /**
  51231. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  51232. */
  51233. forceIrradianceInFragment: boolean;
  51234. /**
  51235. * Number of Simultaneous lights allowed on the material.
  51236. */
  51237. maxSimultaneousLights: number;
  51238. /**
  51239. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  51240. */
  51241. invertNormalMapX: boolean;
  51242. /**
  51243. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  51244. */
  51245. invertNormalMapY: boolean;
  51246. /**
  51247. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  51248. */
  51249. twoSidedLighting: boolean;
  51250. /**
  51251. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  51252. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  51253. */
  51254. useAlphaFresnel: boolean;
  51255. /**
  51256. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  51257. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  51258. */
  51259. useLinearAlphaFresnel: boolean;
  51260. /**
  51261. * Let user defines the brdf lookup texture used for IBL.
  51262. * A default 8bit version is embedded but you could point at :
  51263. * * Default texture: https://assets.babylonjs.com/environments/correlatedMSBRDF_RGBD.png
  51264. * * Default 16bit pixel depth texture: https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  51265. * * LEGACY Default None correlated https://assets.babylonjs.com/environments/uncorrelatedBRDF_RGBD.png
  51266. * * LEGACY Default None correlated 16bit pixel depth https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  51267. */
  51268. environmentBRDFTexture: Nullable<BaseTexture>;
  51269. /**
  51270. * Force normal to face away from face.
  51271. */
  51272. forceNormalForward: boolean;
  51273. /**
  51274. * Enables specular anti aliasing in the PBR shader.
  51275. * It will both interacts on the Geometry for analytical and IBL lighting.
  51276. * It also prefilter the roughness map based on the bump values.
  51277. */
  51278. enableSpecularAntiAliasing: boolean;
  51279. /**
  51280. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  51281. * makes the reflect vector face the model (under horizon).
  51282. */
  51283. useHorizonOcclusion: boolean;
  51284. /**
  51285. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  51286. * too much the area relying on ambient texture to define their ambient occlusion.
  51287. */
  51288. useRadianceOcclusion: boolean;
  51289. /**
  51290. * If set to true, no lighting calculations will be applied.
  51291. */
  51292. unlit: boolean;
  51293. /**
  51294. * Gets the image processing configuration used either in this material.
  51295. */
  51296. /**
  51297. * Sets the Default image processing configuration used either in the this material.
  51298. *
  51299. * If sets to null, the scene one is in use.
  51300. */
  51301. imageProcessingConfiguration: ImageProcessingConfiguration;
  51302. /**
  51303. * Gets wether the color curves effect is enabled.
  51304. */
  51305. /**
  51306. * Sets wether the color curves effect is enabled.
  51307. */
  51308. cameraColorCurvesEnabled: boolean;
  51309. /**
  51310. * Gets wether the color grading effect is enabled.
  51311. */
  51312. /**
  51313. * Gets wether the color grading effect is enabled.
  51314. */
  51315. cameraColorGradingEnabled: boolean;
  51316. /**
  51317. * Gets wether tonemapping is enabled or not.
  51318. */
  51319. /**
  51320. * Sets wether tonemapping is enabled or not
  51321. */
  51322. cameraToneMappingEnabled: boolean;
  51323. /**
  51324. * The camera exposure used on this material.
  51325. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  51326. * This corresponds to a photographic exposure.
  51327. */
  51328. /**
  51329. * The camera exposure used on this material.
  51330. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  51331. * This corresponds to a photographic exposure.
  51332. */
  51333. cameraExposure: number;
  51334. /**
  51335. * Gets The camera contrast used on this material.
  51336. */
  51337. /**
  51338. * Sets The camera contrast used on this material.
  51339. */
  51340. cameraContrast: number;
  51341. /**
  51342. * Gets the Color Grading 2D Lookup Texture.
  51343. */
  51344. /**
  51345. * Sets the Color Grading 2D Lookup Texture.
  51346. */
  51347. cameraColorGradingTexture: Nullable<BaseTexture>;
  51348. /**
  51349. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  51350. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  51351. * 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;
  51352. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  51353. */
  51354. /**
  51355. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  51356. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  51357. * 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;
  51358. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  51359. */
  51360. cameraColorCurves: Nullable<ColorCurves>;
  51361. /**
  51362. * Instantiates a new PBRMaterial instance.
  51363. *
  51364. * @param name The material name
  51365. * @param scene The scene the material will be use in.
  51366. */
  51367. constructor(name: string, scene: Scene);
  51368. /**
  51369. * Returns the name of this material class.
  51370. */
  51371. getClassName(): string;
  51372. /**
  51373. * Makes a duplicate of the current material.
  51374. * @param name - name to use for the new material.
  51375. */
  51376. clone(name: string): PBRMaterial;
  51377. /**
  51378. * Serializes this PBR Material.
  51379. * @returns - An object with the serialized material.
  51380. */
  51381. serialize(): any;
  51382. /**
  51383. * Parses a PBR Material from a serialized object.
  51384. * @param source - Serialized object.
  51385. * @param scene - BJS scene instance.
  51386. * @param rootUrl - url for the scene object
  51387. * @returns - PBRMaterial
  51388. */
  51389. static Parse(source: any, scene: Scene, rootUrl: string): PBRMaterial;
  51390. }
  51391. }
  51392. declare module "babylonjs/Misc/dds" {
  51393. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  51394. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  51395. import { Nullable } from "babylonjs/types";
  51396. import { Scene } from "babylonjs/scene";
  51397. import "babylonjs/Engines/Extensions/engine.cubeTexture";
  51398. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  51399. /**
  51400. * Direct draw surface info
  51401. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dx-graphics-dds-pguide
  51402. */
  51403. export interface DDSInfo {
  51404. /**
  51405. * Width of the texture
  51406. */
  51407. width: number;
  51408. /**
  51409. * Width of the texture
  51410. */
  51411. height: number;
  51412. /**
  51413. * Number of Mipmaps for the texture
  51414. * @see https://en.wikipedia.org/wiki/Mipmap
  51415. */
  51416. mipmapCount: number;
  51417. /**
  51418. * If the textures format is a known fourCC format
  51419. * @see https://www.fourcc.org/
  51420. */
  51421. isFourCC: boolean;
  51422. /**
  51423. * If the texture is an RGB format eg. DXGI_FORMAT_B8G8R8X8_UNORM format
  51424. */
  51425. isRGB: boolean;
  51426. /**
  51427. * If the texture is a lumincance format
  51428. */
  51429. isLuminance: boolean;
  51430. /**
  51431. * If this is a cube texture
  51432. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dds-file-layout-for-cubic-environment-maps
  51433. */
  51434. isCube: boolean;
  51435. /**
  51436. * If the texture is a compressed format eg. FOURCC_DXT1
  51437. */
  51438. isCompressed: boolean;
  51439. /**
  51440. * The dxgiFormat of the texture
  51441. * @see https://docs.microsoft.com/en-us/windows/desktop/api/dxgiformat/ne-dxgiformat-dxgi_format
  51442. */
  51443. dxgiFormat: number;
  51444. /**
  51445. * Texture type eg. Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT
  51446. */
  51447. textureType: number;
  51448. /**
  51449. * Sphericle polynomial created for the dds texture
  51450. */
  51451. sphericalPolynomial?: SphericalPolynomial;
  51452. }
  51453. /**
  51454. * Class used to provide DDS decompression tools
  51455. */
  51456. export class DDSTools {
  51457. /**
  51458. * Gets or sets a boolean indicating that LOD info is stored in alpha channel (false by default)
  51459. */
  51460. static StoreLODInAlphaChannel: boolean;
  51461. /**
  51462. * Gets DDS information from an array buffer
  51463. * @param arrayBuffer defines the array buffer to read data from
  51464. * @returns the DDS information
  51465. */
  51466. static GetDDSInfo(arrayBuffer: any): DDSInfo;
  51467. private static _FloatView;
  51468. private static _Int32View;
  51469. private static _ToHalfFloat;
  51470. private static _FromHalfFloat;
  51471. private static _GetHalfFloatAsFloatRGBAArrayBuffer;
  51472. private static _GetHalfFloatRGBAArrayBuffer;
  51473. private static _GetFloatRGBAArrayBuffer;
  51474. private static _GetFloatAsUIntRGBAArrayBuffer;
  51475. private static _GetHalfFloatAsUIntRGBAArrayBuffer;
  51476. private static _GetRGBAArrayBuffer;
  51477. private static _ExtractLongWordOrder;
  51478. private static _GetRGBArrayBuffer;
  51479. private static _GetLuminanceArrayBuffer;
  51480. /**
  51481. * Uploads DDS Levels to a Babylon Texture
  51482. * @hidden
  51483. */
  51484. static UploadDDSLevels(engine: ThinEngine, texture: InternalTexture, arrayBuffer: any, info: DDSInfo, loadMipmaps: boolean, faces: number, lodIndex?: number, currentFace?: number): void;
  51485. }
  51486. module "babylonjs/Engines/thinEngine" {
  51487. interface ThinEngine {
  51488. /**
  51489. * Create a cube texture from prefiltered data (ie. the mipmaps contain ready to use data for PBR reflection)
  51490. * @param rootUrl defines the url where the file to load is located
  51491. * @param scene defines the current scene
  51492. * @param lodScale defines scale to apply to the mip map selection
  51493. * @param lodOffset defines offset to apply to the mip map selection
  51494. * @param onLoad defines an optional callback raised when the texture is loaded
  51495. * @param onError defines an optional callback raised if there is an issue to load the texture
  51496. * @param format defines the format of the data
  51497. * @param forcedExtension defines the extension to use to pick the right loader
  51498. * @param createPolynomials defines wheter or not to create polynomails harmonics for the texture
  51499. * @returns the cube texture as an InternalTexture
  51500. */
  51501. 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;
  51502. }
  51503. }
  51504. }
  51505. declare module "babylonjs/Materials/Textures/Loaders/ddsTextureLoader" {
  51506. import { Nullable } from "babylonjs/types";
  51507. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  51508. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  51509. /**
  51510. * Implementation of the DDS Texture Loader.
  51511. * @hidden
  51512. */
  51513. export class _DDSTextureLoader implements IInternalTextureLoader {
  51514. /**
  51515. * Defines wether the loader supports cascade loading the different faces.
  51516. */
  51517. readonly supportCascades: boolean;
  51518. /**
  51519. * This returns if the loader support the current file information.
  51520. * @param extension defines the file extension of the file being loaded
  51521. * @param textureFormatInUse defines the current compressed format in use iun the engine
  51522. * @param fallback defines the fallback internal texture if any
  51523. * @param isBase64 defines whether the texture is encoded as a base64
  51524. * @param isBuffer defines whether the texture data are stored as a buffer
  51525. * @returns true if the loader can load the specified file
  51526. */
  51527. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  51528. /**
  51529. * Transform the url before loading if required.
  51530. * @param rootUrl the url of the texture
  51531. * @param textureFormatInUse defines the current compressed format in use iun the engine
  51532. * @returns the transformed texture
  51533. */
  51534. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  51535. /**
  51536. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  51537. * @param rootUrl the url of the texture
  51538. * @param textureFormatInUse defines the current compressed format in use iun the engine
  51539. * @returns the fallback texture
  51540. */
  51541. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  51542. /**
  51543. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  51544. * @param data contains the texture data
  51545. * @param texture defines the BabylonJS internal texture
  51546. * @param createPolynomials will be true if polynomials have been requested
  51547. * @param onLoad defines the callback to trigger once the texture is ready
  51548. * @param onError defines the callback to trigger in case of error
  51549. */
  51550. loadCubeData(imgs: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  51551. /**
  51552. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  51553. * @param data contains the texture data
  51554. * @param texture defines the BabylonJS internal texture
  51555. * @param callback defines the method to call once ready to upload
  51556. */
  51557. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  51558. }
  51559. }
  51560. declare module "babylonjs/Materials/Textures/Loaders/envTextureLoader" {
  51561. import { Nullable } from "babylonjs/types";
  51562. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  51563. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  51564. /**
  51565. * Implementation of the ENV Texture Loader.
  51566. * @hidden
  51567. */
  51568. export class _ENVTextureLoader implements IInternalTextureLoader {
  51569. /**
  51570. * Defines wether the loader supports cascade loading the different faces.
  51571. */
  51572. readonly supportCascades: boolean;
  51573. /**
  51574. * This returns if the loader support the current file information.
  51575. * @param extension defines the file extension of the file being loaded
  51576. * @param textureFormatInUse defines the current compressed format in use iun the engine
  51577. * @param fallback defines the fallback internal texture if any
  51578. * @param isBase64 defines whether the texture is encoded as a base64
  51579. * @param isBuffer defines whether the texture data are stored as a buffer
  51580. * @returns true if the loader can load the specified file
  51581. */
  51582. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  51583. /**
  51584. * Transform the url before loading if required.
  51585. * @param rootUrl the url of the texture
  51586. * @param textureFormatInUse defines the current compressed format in use iun the engine
  51587. * @returns the transformed texture
  51588. */
  51589. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  51590. /**
  51591. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  51592. * @param rootUrl the url of the texture
  51593. * @param textureFormatInUse defines the current compressed format in use iun the engine
  51594. * @returns the fallback texture
  51595. */
  51596. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  51597. /**
  51598. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  51599. * @param data contains the texture data
  51600. * @param texture defines the BabylonJS internal texture
  51601. * @param createPolynomials will be true if polynomials have been requested
  51602. * @param onLoad defines the callback to trigger once the texture is ready
  51603. * @param onError defines the callback to trigger in case of error
  51604. */
  51605. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  51606. /**
  51607. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  51608. * @param data contains the texture data
  51609. * @param texture defines the BabylonJS internal texture
  51610. * @param callback defines the method to call once ready to upload
  51611. */
  51612. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  51613. }
  51614. }
  51615. declare module "babylonjs/Misc/khronosTextureContainer" {
  51616. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  51617. /**
  51618. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  51619. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  51620. */
  51621. export class KhronosTextureContainer {
  51622. /** contents of the KTX container file */
  51623. arrayBuffer: any;
  51624. private static HEADER_LEN;
  51625. private static COMPRESSED_2D;
  51626. private static COMPRESSED_3D;
  51627. private static TEX_2D;
  51628. private static TEX_3D;
  51629. /**
  51630. * Gets the openGL type
  51631. */
  51632. glType: number;
  51633. /**
  51634. * Gets the openGL type size
  51635. */
  51636. glTypeSize: number;
  51637. /**
  51638. * Gets the openGL format
  51639. */
  51640. glFormat: number;
  51641. /**
  51642. * Gets the openGL internal format
  51643. */
  51644. glInternalFormat: number;
  51645. /**
  51646. * Gets the base internal format
  51647. */
  51648. glBaseInternalFormat: number;
  51649. /**
  51650. * Gets image width in pixel
  51651. */
  51652. pixelWidth: number;
  51653. /**
  51654. * Gets image height in pixel
  51655. */
  51656. pixelHeight: number;
  51657. /**
  51658. * Gets image depth in pixels
  51659. */
  51660. pixelDepth: number;
  51661. /**
  51662. * Gets the number of array elements
  51663. */
  51664. numberOfArrayElements: number;
  51665. /**
  51666. * Gets the number of faces
  51667. */
  51668. numberOfFaces: number;
  51669. /**
  51670. * Gets the number of mipmap levels
  51671. */
  51672. numberOfMipmapLevels: number;
  51673. /**
  51674. * Gets the bytes of key value data
  51675. */
  51676. bytesOfKeyValueData: number;
  51677. /**
  51678. * Gets the load type
  51679. */
  51680. loadType: number;
  51681. /**
  51682. * If the container has been made invalid (eg. constructor failed to correctly load array buffer)
  51683. */
  51684. isInvalid: boolean;
  51685. /**
  51686. * Creates a new KhronosTextureContainer
  51687. * @param arrayBuffer contents of the KTX container file
  51688. * @param facesExpected should be either 1 or 6, based whether a cube texture or or
  51689. * @param threeDExpected provision for indicating that data should be a 3D texture, not implemented
  51690. * @param textureArrayExpected provision for indicating that data should be a texture array, not implemented
  51691. */
  51692. constructor(
  51693. /** contents of the KTX container file */
  51694. arrayBuffer: any, facesExpected: number, threeDExpected?: boolean, textureArrayExpected?: boolean);
  51695. /**
  51696. * Uploads KTX content to a Babylon Texture.
  51697. * It is assumed that the texture has already been created & is currently bound
  51698. * @hidden
  51699. */
  51700. uploadLevels(texture: InternalTexture, loadMipmaps: boolean): void;
  51701. private _upload2DCompressedLevels;
  51702. }
  51703. }
  51704. declare module "babylonjs/Materials/Textures/Loaders/ktxTextureLoader" {
  51705. import { Nullable } from "babylonjs/types";
  51706. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  51707. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  51708. /**
  51709. * Implementation of the KTX Texture Loader.
  51710. * @hidden
  51711. */
  51712. export class _KTXTextureLoader implements IInternalTextureLoader {
  51713. /**
  51714. * Defines wether the loader supports cascade loading the different faces.
  51715. */
  51716. readonly supportCascades: boolean;
  51717. /**
  51718. * This returns if the loader support the current file information.
  51719. * @param extension defines the file extension of the file being loaded
  51720. * @param textureFormatInUse defines the current compressed format in use iun the engine
  51721. * @param fallback defines the fallback internal texture if any
  51722. * @param isBase64 defines whether the texture is encoded as a base64
  51723. * @param isBuffer defines whether the texture data are stored as a buffer
  51724. * @returns true if the loader can load the specified file
  51725. */
  51726. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  51727. /**
  51728. * Transform the url before loading if required.
  51729. * @param rootUrl the url of the texture
  51730. * @param textureFormatInUse defines the current compressed format in use iun the engine
  51731. * @returns the transformed texture
  51732. */
  51733. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  51734. /**
  51735. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  51736. * @param rootUrl the url of the texture
  51737. * @param textureFormatInUse defines the current compressed format in use iun the engine
  51738. * @returns the fallback texture
  51739. */
  51740. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  51741. /**
  51742. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  51743. * @param data contains the texture data
  51744. * @param texture defines the BabylonJS internal texture
  51745. * @param createPolynomials will be true if polynomials have been requested
  51746. * @param onLoad defines the callback to trigger once the texture is ready
  51747. * @param onError defines the callback to trigger in case of error
  51748. */
  51749. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  51750. /**
  51751. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  51752. * @param data contains the texture data
  51753. * @param texture defines the BabylonJS internal texture
  51754. * @param callback defines the method to call once ready to upload
  51755. */
  51756. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed: boolean) => void): void;
  51757. }
  51758. }
  51759. declare module "babylonjs/Helpers/sceneHelpers" {
  51760. import { Nullable } from "babylonjs/types";
  51761. import { Mesh } from "babylonjs/Meshes/mesh";
  51762. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  51763. import { IEnvironmentHelperOptions, EnvironmentHelper } from "babylonjs/Helpers/environmentHelper";
  51764. import { VRExperienceHelperOptions, VRExperienceHelper } from "babylonjs/Cameras/VR/vrExperienceHelper";
  51765. import "babylonjs/Materials/Textures/Loaders/ddsTextureLoader";
  51766. import "babylonjs/Materials/Textures/Loaders/envTextureLoader";
  51767. import "babylonjs/Materials/Textures/Loaders/ktxTextureLoader";
  51768. import "babylonjs/Meshes/Builders/boxBuilder";
  51769. import { WebXRDefaultExperience, WebXRDefaultExperienceOptions } from "babylonjs/Cameras/XR/webXRDefaultExperience";
  51770. /** @hidden */
  51771. export var _forceSceneHelpersToBundle: boolean;
  51772. module "babylonjs/scene" {
  51773. interface Scene {
  51774. /**
  51775. * Creates a default light for the scene.
  51776. * @see http://doc.babylonjs.com/How_To/Fast_Build#create-default-light
  51777. * @param replace has the default false, when true replaces the existing lights in the scene with a hemispheric light
  51778. */
  51779. createDefaultLight(replace?: boolean): void;
  51780. /**
  51781. * Creates a default camera for the scene.
  51782. * @see http://doc.babylonjs.com/How_To/Fast_Build#create-default-camera
  51783. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  51784. * @param replace has default false, when true replaces the active camera in the scene
  51785. * @param attachCameraControls has default false, when true attaches camera controls to the canvas.
  51786. */
  51787. createDefaultCamera(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  51788. /**
  51789. * Creates a default camera and a default light.
  51790. * @see http://doc.babylonjs.com/how_to/Fast_Build#create-default-camera-or-light
  51791. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  51792. * @param replace has the default false, when true replaces the active camera/light in the scene
  51793. * @param attachCameraControls has the default false, when true attaches camera controls to the canvas.
  51794. */
  51795. createDefaultCameraOrLight(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  51796. /**
  51797. * Creates a new sky box
  51798. * @see http://doc.babylonjs.com/how_to/Fast_Build#create-default-skybox
  51799. * @param environmentTexture defines the texture to use as environment texture
  51800. * @param pbr has default false which requires the StandardMaterial to be used, when true PBRMaterial must be used
  51801. * @param scale defines the overall scale of the skybox
  51802. * @param blur is only available when pbr is true, default is 0, no blur, maximum value is 1
  51803. * @param setGlobalEnvTexture has default true indicating that scene.environmentTexture must match the current skybox texture
  51804. * @returns a new mesh holding the sky box
  51805. */
  51806. createDefaultSkybox(environmentTexture?: BaseTexture, pbr?: boolean, scale?: number, blur?: number, setGlobalEnvTexture?: boolean): Nullable<Mesh>;
  51807. /**
  51808. * Creates a new environment
  51809. * @see http://doc.babylonjs.com/How_To/Fast_Build#create-default-environment
  51810. * @param options defines the options you can use to configure the environment
  51811. * @returns the new EnvironmentHelper
  51812. */
  51813. createDefaultEnvironment(options?: Partial<IEnvironmentHelperOptions>): Nullable<EnvironmentHelper>;
  51814. /**
  51815. * Creates a new VREXperienceHelper
  51816. * @see http://doc.babylonjs.com/how_to/webvr_helper
  51817. * @param webVROptions defines the options used to create the new VREXperienceHelper
  51818. * @returns a new VREXperienceHelper
  51819. */
  51820. createDefaultVRExperience(webVROptions?: VRExperienceHelperOptions): VRExperienceHelper;
  51821. /**
  51822. * Creates a new WebXRDefaultExperience
  51823. * @see http://doc.babylonjs.com/how_to/webxr
  51824. * @param options experience options
  51825. * @returns a promise for a new WebXRDefaultExperience
  51826. */
  51827. createDefaultXRExperienceAsync(options: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  51828. }
  51829. }
  51830. }
  51831. declare module "babylonjs/Helpers/videoDome" {
  51832. import { Scene } from "babylonjs/scene";
  51833. import { TransformNode } from "babylonjs/Meshes/transformNode";
  51834. import { Mesh } from "babylonjs/Meshes/mesh";
  51835. import { VideoTexture } from "babylonjs/Materials/Textures/videoTexture";
  51836. import { BackgroundMaterial } from "babylonjs/Materials/Background/backgroundMaterial";
  51837. import "babylonjs/Meshes/Builders/sphereBuilder";
  51838. /**
  51839. * Display a 360/180 degree video on an approximately spherical surface, useful for VR applications or skyboxes.
  51840. * As a subclass of TransformNode, this allow parenting to the camera or multiple videos with different locations in the scene.
  51841. * This class achieves its effect with a VideoTexture and a correctly configured BackgroundMaterial on an inverted sphere.
  51842. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  51843. */
  51844. export class VideoDome extends TransformNode {
  51845. /**
  51846. * Define the video source as a Monoscopic panoramic 360 video.
  51847. */
  51848. static readonly MODE_MONOSCOPIC: number;
  51849. /**
  51850. * Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  51851. */
  51852. static readonly MODE_TOPBOTTOM: number;
  51853. /**
  51854. * Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  51855. */
  51856. static readonly MODE_SIDEBYSIDE: number;
  51857. private _halfDome;
  51858. private _useDirectMapping;
  51859. /**
  51860. * The video texture being displayed on the sphere
  51861. */
  51862. protected _videoTexture: VideoTexture;
  51863. /**
  51864. * Gets the video texture being displayed on the sphere
  51865. */
  51866. readonly videoTexture: VideoTexture;
  51867. /**
  51868. * The skybox material
  51869. */
  51870. protected _material: BackgroundMaterial;
  51871. /**
  51872. * The surface used for the skybox
  51873. */
  51874. protected _mesh: Mesh;
  51875. /**
  51876. * A mesh that will be used to mask the back of the video dome in case it is a 180 degree movie.
  51877. */
  51878. private _halfDomeMask;
  51879. /**
  51880. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  51881. * Also see the options.resolution property.
  51882. */
  51883. fovMultiplier: number;
  51884. private _videoMode;
  51885. /**
  51886. * Gets or set the current video mode for the video. It can be:
  51887. * * VideoDome.MODE_MONOSCOPIC : Define the video source as a Monoscopic panoramic 360 video.
  51888. * * VideoDome.MODE_TOPBOTTOM : Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  51889. * * VideoDome.MODE_SIDEBYSIDE : Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  51890. */
  51891. videoMode: number;
  51892. /**
  51893. * Is the video a 180 degrees video (half dome) or 360 video (full dome)
  51894. *
  51895. */
  51896. /**
  51897. * Set the halfDome mode. If set, only the front (180 degrees) will be displayed and the back will be blacked out.
  51898. */
  51899. halfDome: boolean;
  51900. /**
  51901. * Oberserver used in Stereoscopic VR Mode.
  51902. */
  51903. private _onBeforeCameraRenderObserver;
  51904. /**
  51905. * Create an instance of this class and pass through the parameters to the relevant classes, VideoTexture, StandardMaterial, and Mesh.
  51906. * @param name Element's name, child elements will append suffixes for their own names.
  51907. * @param urlsOrVideo defines the url(s) or the video element to use
  51908. * @param options An object containing optional or exposed sub element properties
  51909. */
  51910. constructor(name: string, urlsOrVideo: string | string[] | HTMLVideoElement, options: {
  51911. resolution?: number;
  51912. clickToPlay?: boolean;
  51913. autoPlay?: boolean;
  51914. loop?: boolean;
  51915. size?: number;
  51916. poster?: string;
  51917. faceForward?: boolean;
  51918. useDirectMapping?: boolean;
  51919. halfDomeMode?: boolean;
  51920. }, scene: Scene);
  51921. private _changeVideoMode;
  51922. /**
  51923. * Releases resources associated with this node.
  51924. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  51925. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  51926. */
  51927. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  51928. }
  51929. }
  51930. declare module "babylonjs/Helpers/index" {
  51931. export * from "babylonjs/Helpers/environmentHelper";
  51932. export * from "babylonjs/Helpers/photoDome";
  51933. export * from "babylonjs/Helpers/sceneHelpers";
  51934. export * from "babylonjs/Helpers/videoDome";
  51935. }
  51936. declare module "babylonjs/Instrumentation/engineInstrumentation" {
  51937. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  51938. import { IDisposable } from "babylonjs/scene";
  51939. import { Engine } from "babylonjs/Engines/engine";
  51940. /**
  51941. * This class can be used to get instrumentation data from a Babylon engine
  51942. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  51943. */
  51944. export class EngineInstrumentation implements IDisposable {
  51945. /**
  51946. * Define the instrumented engine.
  51947. */
  51948. engine: Engine;
  51949. private _captureGPUFrameTime;
  51950. private _gpuFrameTimeToken;
  51951. private _gpuFrameTime;
  51952. private _captureShaderCompilationTime;
  51953. private _shaderCompilationTime;
  51954. private _onBeginFrameObserver;
  51955. private _onEndFrameObserver;
  51956. private _onBeforeShaderCompilationObserver;
  51957. private _onAfterShaderCompilationObserver;
  51958. /**
  51959. * Gets the perf counter used for GPU frame time
  51960. */
  51961. readonly gpuFrameTimeCounter: PerfCounter;
  51962. /**
  51963. * Gets the GPU frame time capture status
  51964. */
  51965. /**
  51966. * Enable or disable the GPU frame time capture
  51967. */
  51968. captureGPUFrameTime: boolean;
  51969. /**
  51970. * Gets the perf counter used for shader compilation time
  51971. */
  51972. readonly shaderCompilationTimeCounter: PerfCounter;
  51973. /**
  51974. * Gets the shader compilation time capture status
  51975. */
  51976. /**
  51977. * Enable or disable the shader compilation time capture
  51978. */
  51979. captureShaderCompilationTime: boolean;
  51980. /**
  51981. * Instantiates a new engine instrumentation.
  51982. * This class can be used to get instrumentation data from a Babylon engine
  51983. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  51984. * @param engine Defines the engine to instrument
  51985. */
  51986. constructor(
  51987. /**
  51988. * Define the instrumented engine.
  51989. */
  51990. engine: Engine);
  51991. /**
  51992. * Dispose and release associated resources.
  51993. */
  51994. dispose(): void;
  51995. }
  51996. }
  51997. declare module "babylonjs/Instrumentation/sceneInstrumentation" {
  51998. import { Scene, IDisposable } from "babylonjs/scene";
  51999. import { PerfCounter } from "babylonjs/Misc/perfCounter";
  52000. /**
  52001. * This class can be used to get instrumentation data from a Babylon engine
  52002. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  52003. */
  52004. export class SceneInstrumentation implements IDisposable {
  52005. /**
  52006. * Defines the scene to instrument
  52007. */
  52008. scene: Scene;
  52009. private _captureActiveMeshesEvaluationTime;
  52010. private _activeMeshesEvaluationTime;
  52011. private _captureRenderTargetsRenderTime;
  52012. private _renderTargetsRenderTime;
  52013. private _captureFrameTime;
  52014. private _frameTime;
  52015. private _captureRenderTime;
  52016. private _renderTime;
  52017. private _captureInterFrameTime;
  52018. private _interFrameTime;
  52019. private _captureParticlesRenderTime;
  52020. private _particlesRenderTime;
  52021. private _captureSpritesRenderTime;
  52022. private _spritesRenderTime;
  52023. private _capturePhysicsTime;
  52024. private _physicsTime;
  52025. private _captureAnimationsTime;
  52026. private _animationsTime;
  52027. private _captureCameraRenderTime;
  52028. private _cameraRenderTime;
  52029. private _onBeforeActiveMeshesEvaluationObserver;
  52030. private _onAfterActiveMeshesEvaluationObserver;
  52031. private _onBeforeRenderTargetsRenderObserver;
  52032. private _onAfterRenderTargetsRenderObserver;
  52033. private _onAfterRenderObserver;
  52034. private _onBeforeDrawPhaseObserver;
  52035. private _onAfterDrawPhaseObserver;
  52036. private _onBeforeAnimationsObserver;
  52037. private _onBeforeParticlesRenderingObserver;
  52038. private _onAfterParticlesRenderingObserver;
  52039. private _onBeforeSpritesRenderingObserver;
  52040. private _onAfterSpritesRenderingObserver;
  52041. private _onBeforePhysicsObserver;
  52042. private _onAfterPhysicsObserver;
  52043. private _onAfterAnimationsObserver;
  52044. private _onBeforeCameraRenderObserver;
  52045. private _onAfterCameraRenderObserver;
  52046. /**
  52047. * Gets the perf counter used for active meshes evaluation time
  52048. */
  52049. readonly activeMeshesEvaluationTimeCounter: PerfCounter;
  52050. /**
  52051. * Gets the active meshes evaluation time capture status
  52052. */
  52053. /**
  52054. * Enable or disable the active meshes evaluation time capture
  52055. */
  52056. captureActiveMeshesEvaluationTime: boolean;
  52057. /**
  52058. * Gets the perf counter used for render targets render time
  52059. */
  52060. readonly renderTargetsRenderTimeCounter: PerfCounter;
  52061. /**
  52062. * Gets the render targets render time capture status
  52063. */
  52064. /**
  52065. * Enable or disable the render targets render time capture
  52066. */
  52067. captureRenderTargetsRenderTime: boolean;
  52068. /**
  52069. * Gets the perf counter used for particles render time
  52070. */
  52071. readonly particlesRenderTimeCounter: PerfCounter;
  52072. /**
  52073. * Gets the particles render time capture status
  52074. */
  52075. /**
  52076. * Enable or disable the particles render time capture
  52077. */
  52078. captureParticlesRenderTime: boolean;
  52079. /**
  52080. * Gets the perf counter used for sprites render time
  52081. */
  52082. readonly spritesRenderTimeCounter: PerfCounter;
  52083. /**
  52084. * Gets the sprites render time capture status
  52085. */
  52086. /**
  52087. * Enable or disable the sprites render time capture
  52088. */
  52089. captureSpritesRenderTime: boolean;
  52090. /**
  52091. * Gets the perf counter used for physics time
  52092. */
  52093. readonly physicsTimeCounter: PerfCounter;
  52094. /**
  52095. * Gets the physics time capture status
  52096. */
  52097. /**
  52098. * Enable or disable the physics time capture
  52099. */
  52100. capturePhysicsTime: boolean;
  52101. /**
  52102. * Gets the perf counter used for animations time
  52103. */
  52104. readonly animationsTimeCounter: PerfCounter;
  52105. /**
  52106. * Gets the animations time capture status
  52107. */
  52108. /**
  52109. * Enable or disable the animations time capture
  52110. */
  52111. captureAnimationsTime: boolean;
  52112. /**
  52113. * Gets the perf counter used for frame time capture
  52114. */
  52115. readonly frameTimeCounter: PerfCounter;
  52116. /**
  52117. * Gets the frame time capture status
  52118. */
  52119. /**
  52120. * Enable or disable the frame time capture
  52121. */
  52122. captureFrameTime: boolean;
  52123. /**
  52124. * Gets the perf counter used for inter-frames time capture
  52125. */
  52126. readonly interFrameTimeCounter: PerfCounter;
  52127. /**
  52128. * Gets the inter-frames time capture status
  52129. */
  52130. /**
  52131. * Enable or disable the inter-frames time capture
  52132. */
  52133. captureInterFrameTime: boolean;
  52134. /**
  52135. * Gets the perf counter used for render time capture
  52136. */
  52137. readonly renderTimeCounter: PerfCounter;
  52138. /**
  52139. * Gets the render time capture status
  52140. */
  52141. /**
  52142. * Enable or disable the render time capture
  52143. */
  52144. captureRenderTime: boolean;
  52145. /**
  52146. * Gets the perf counter used for camera render time capture
  52147. */
  52148. readonly cameraRenderTimeCounter: PerfCounter;
  52149. /**
  52150. * Gets the camera render time capture status
  52151. */
  52152. /**
  52153. * Enable or disable the camera render time capture
  52154. */
  52155. captureCameraRenderTime: boolean;
  52156. /**
  52157. * Gets the perf counter used for draw calls
  52158. */
  52159. readonly drawCallsCounter: PerfCounter;
  52160. /**
  52161. * Instantiates a new scene instrumentation.
  52162. * This class can be used to get instrumentation data from a Babylon engine
  52163. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  52164. * @param scene Defines the scene to instrument
  52165. */
  52166. constructor(
  52167. /**
  52168. * Defines the scene to instrument
  52169. */
  52170. scene: Scene);
  52171. /**
  52172. * Dispose and release associated resources.
  52173. */
  52174. dispose(): void;
  52175. }
  52176. }
  52177. declare module "babylonjs/Instrumentation/index" {
  52178. export * from "babylonjs/Instrumentation/engineInstrumentation";
  52179. export * from "babylonjs/Instrumentation/sceneInstrumentation";
  52180. export * from "babylonjs/Instrumentation/timeToken";
  52181. }
  52182. declare module "babylonjs/Shaders/glowMapGeneration.fragment" {
  52183. /** @hidden */
  52184. export var glowMapGenerationPixelShader: {
  52185. name: string;
  52186. shader: string;
  52187. };
  52188. }
  52189. declare module "babylonjs/Shaders/glowMapGeneration.vertex" {
  52190. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  52191. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  52192. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  52193. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  52194. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  52195. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  52196. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  52197. /** @hidden */
  52198. export var glowMapGenerationVertexShader: {
  52199. name: string;
  52200. shader: string;
  52201. };
  52202. }
  52203. declare module "babylonjs/Layers/effectLayer" {
  52204. import { Observable } from "babylonjs/Misc/observable";
  52205. import { Nullable } from "babylonjs/types";
  52206. import { Camera } from "babylonjs/Cameras/camera";
  52207. import { Scene } from "babylonjs/scene";
  52208. import { ISize } from "babylonjs/Maths/math.size";
  52209. import { Color4 } from "babylonjs/Maths/math.color";
  52210. import { Engine } from "babylonjs/Engines/engine";
  52211. import { SubMesh } from "babylonjs/Meshes/subMesh";
  52212. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52213. import { Mesh } from "babylonjs/Meshes/mesh";
  52214. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  52215. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  52216. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  52217. import { Effect } from "babylonjs/Materials/effect";
  52218. import { Material } from "babylonjs/Materials/material";
  52219. import "babylonjs/Shaders/glowMapGeneration.fragment";
  52220. import "babylonjs/Shaders/glowMapGeneration.vertex";
  52221. /**
  52222. * Effect layer options. This helps customizing the behaviour
  52223. * of the effect layer.
  52224. */
  52225. export interface IEffectLayerOptions {
  52226. /**
  52227. * Multiplication factor apply to the canvas size to compute the render target size
  52228. * used to generated the objects (the smaller the faster).
  52229. */
  52230. mainTextureRatio: number;
  52231. /**
  52232. * Enforces a fixed size texture to ensure effect stability across devices.
  52233. */
  52234. mainTextureFixedSize?: number;
  52235. /**
  52236. * Alpha blending mode used to apply the blur. Default depends of the implementation.
  52237. */
  52238. alphaBlendingMode: number;
  52239. /**
  52240. * The camera attached to the layer.
  52241. */
  52242. camera: Nullable<Camera>;
  52243. /**
  52244. * The rendering group to draw the layer in.
  52245. */
  52246. renderingGroupId: number;
  52247. }
  52248. /**
  52249. * The effect layer Helps adding post process effect blended with the main pass.
  52250. *
  52251. * This can be for instance use to generate glow or higlight effects on the scene.
  52252. *
  52253. * The effect layer class can not be used directly and is intented to inherited from to be
  52254. * customized per effects.
  52255. */
  52256. export abstract class EffectLayer {
  52257. private _vertexBuffers;
  52258. private _indexBuffer;
  52259. private _cachedDefines;
  52260. private _effectLayerMapGenerationEffect;
  52261. private _effectLayerOptions;
  52262. private _mergeEffect;
  52263. protected _scene: Scene;
  52264. protected _engine: Engine;
  52265. protected _maxSize: number;
  52266. protected _mainTextureDesiredSize: ISize;
  52267. protected _mainTexture: RenderTargetTexture;
  52268. protected _shouldRender: boolean;
  52269. protected _postProcesses: PostProcess[];
  52270. protected _textures: BaseTexture[];
  52271. protected _emissiveTextureAndColor: {
  52272. texture: Nullable<BaseTexture>;
  52273. color: Color4;
  52274. };
  52275. /**
  52276. * The name of the layer
  52277. */
  52278. name: string;
  52279. /**
  52280. * The clear color of the texture used to generate the glow map.
  52281. */
  52282. neutralColor: Color4;
  52283. /**
  52284. * Specifies wether the highlight layer is enabled or not.
  52285. */
  52286. isEnabled: boolean;
  52287. /**
  52288. * Gets the camera attached to the layer.
  52289. */
  52290. readonly camera: Nullable<Camera>;
  52291. /**
  52292. * Gets the rendering group id the layer should render in.
  52293. */
  52294. renderingGroupId: number;
  52295. /**
  52296. * An event triggered when the effect layer has been disposed.
  52297. */
  52298. onDisposeObservable: Observable<EffectLayer>;
  52299. /**
  52300. * An event triggered when the effect layer is about rendering the main texture with the glowy parts.
  52301. */
  52302. onBeforeRenderMainTextureObservable: Observable<EffectLayer>;
  52303. /**
  52304. * An event triggered when the generated texture is being merged in the scene.
  52305. */
  52306. onBeforeComposeObservable: Observable<EffectLayer>;
  52307. /**
  52308. * An event triggered when the mesh is rendered into the effect render target.
  52309. */
  52310. onBeforeRenderMeshToEffect: Observable<AbstractMesh>;
  52311. /**
  52312. * An event triggered after the mesh has been rendered into the effect render target.
  52313. */
  52314. onAfterRenderMeshToEffect: Observable<AbstractMesh>;
  52315. /**
  52316. * An event triggered when the generated texture has been merged in the scene.
  52317. */
  52318. onAfterComposeObservable: Observable<EffectLayer>;
  52319. /**
  52320. * An event triggered when the efffect layer changes its size.
  52321. */
  52322. onSizeChangedObservable: Observable<EffectLayer>;
  52323. /** @hidden */
  52324. static _SceneComponentInitialization: (scene: Scene) => void;
  52325. /**
  52326. * Instantiates a new effect Layer and references it in the scene.
  52327. * @param name The name of the layer
  52328. * @param scene The scene to use the layer in
  52329. */
  52330. constructor(
  52331. /** The Friendly of the effect in the scene */
  52332. name: string, scene: Scene);
  52333. /**
  52334. * Get the effect name of the layer.
  52335. * @return The effect name
  52336. */
  52337. abstract getEffectName(): string;
  52338. /**
  52339. * Checks for the readiness of the element composing the layer.
  52340. * @param subMesh the mesh to check for
  52341. * @param useInstances specify wether or not to use instances to render the mesh
  52342. * @return true if ready otherwise, false
  52343. */
  52344. abstract isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  52345. /**
  52346. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  52347. * @returns true if the effect requires stencil during the main canvas render pass.
  52348. */
  52349. abstract needStencil(): boolean;
  52350. /**
  52351. * Create the merge effect. This is the shader use to blit the information back
  52352. * to the main canvas at the end of the scene rendering.
  52353. * @returns The effect containing the shader used to merge the effect on the main canvas
  52354. */
  52355. protected abstract _createMergeEffect(): Effect;
  52356. /**
  52357. * Creates the render target textures and post processes used in the effect layer.
  52358. */
  52359. protected abstract _createTextureAndPostProcesses(): void;
  52360. /**
  52361. * Implementation specific of rendering the generating effect on the main canvas.
  52362. * @param effect The effect used to render through
  52363. */
  52364. protected abstract _internalRender(effect: Effect): void;
  52365. /**
  52366. * Sets the required values for both the emissive texture and and the main color.
  52367. */
  52368. protected abstract _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  52369. /**
  52370. * Free any resources and references associated to a mesh.
  52371. * Internal use
  52372. * @param mesh The mesh to free.
  52373. */
  52374. abstract _disposeMesh(mesh: Mesh): void;
  52375. /**
  52376. * Serializes this layer (Glow or Highlight for example)
  52377. * @returns a serialized layer object
  52378. */
  52379. abstract serialize?(): any;
  52380. /**
  52381. * Initializes the effect layer with the required options.
  52382. * @param options Sets of none mandatory options to use with the layer (see IEffectLayerOptions for more information)
  52383. */
  52384. protected _init(options: Partial<IEffectLayerOptions>): void;
  52385. /**
  52386. * Generates the index buffer of the full screen quad blending to the main canvas.
  52387. */
  52388. private _generateIndexBuffer;
  52389. /**
  52390. * Generates the vertex buffer of the full screen quad blending to the main canvas.
  52391. */
  52392. private _generateVertexBuffer;
  52393. /**
  52394. * Sets the main texture desired size which is the closest power of two
  52395. * of the engine canvas size.
  52396. */
  52397. private _setMainTextureSize;
  52398. /**
  52399. * Creates the main texture for the effect layer.
  52400. */
  52401. protected _createMainTexture(): void;
  52402. /**
  52403. * Adds specific effects defines.
  52404. * @param defines The defines to add specifics to.
  52405. */
  52406. protected _addCustomEffectDefines(defines: string[]): void;
  52407. /**
  52408. * Checks for the readiness of the element composing the layer.
  52409. * @param subMesh the mesh to check for
  52410. * @param useInstances specify wether or not to use instances to render the mesh
  52411. * @param emissiveTexture the associated emissive texture used to generate the glow
  52412. * @return true if ready otherwise, false
  52413. */
  52414. protected _isReady(subMesh: SubMesh, useInstances: boolean, emissiveTexture: Nullable<BaseTexture>): boolean;
  52415. /**
  52416. * Renders the glowing part of the scene by blending the blurred glowing meshes on top of the rendered scene.
  52417. */
  52418. render(): void;
  52419. /**
  52420. * Determine if a given mesh will be used in the current effect.
  52421. * @param mesh mesh to test
  52422. * @returns true if the mesh will be used
  52423. */
  52424. hasMesh(mesh: AbstractMesh): boolean;
  52425. /**
  52426. * Returns true if the layer contains information to display, otherwise false.
  52427. * @returns true if the glow layer should be rendered
  52428. */
  52429. shouldRender(): boolean;
  52430. /**
  52431. * Returns true if the mesh should render, otherwise false.
  52432. * @param mesh The mesh to render
  52433. * @returns true if it should render otherwise false
  52434. */
  52435. protected _shouldRenderMesh(mesh: AbstractMesh): boolean;
  52436. /**
  52437. * Returns true if the mesh can be rendered, otherwise false.
  52438. * @param mesh The mesh to render
  52439. * @param material The material used on the mesh
  52440. * @returns true if it can be rendered otherwise false
  52441. */
  52442. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  52443. /**
  52444. * Returns true if the mesh should render, otherwise false.
  52445. * @param mesh The mesh to render
  52446. * @returns true if it should render otherwise false
  52447. */
  52448. protected _shouldRenderEmissiveTextureForMesh(): boolean;
  52449. /**
  52450. * Renders the submesh passed in parameter to the generation map.
  52451. */
  52452. protected _renderSubMesh(subMesh: SubMesh, enableAlphaMode?: boolean): void;
  52453. /**
  52454. * Defines wether the current material of the mesh should be use to render the effect.
  52455. * @param mesh defines the current mesh to render
  52456. */
  52457. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  52458. /**
  52459. * Rebuild the required buffers.
  52460. * @hidden Internal use only.
  52461. */
  52462. _rebuild(): void;
  52463. /**
  52464. * Dispose only the render target textures and post process.
  52465. */
  52466. private _disposeTextureAndPostProcesses;
  52467. /**
  52468. * Dispose the highlight layer and free resources.
  52469. */
  52470. dispose(): void;
  52471. /**
  52472. * Gets the class name of the effect layer
  52473. * @returns the string with the class name of the effect layer
  52474. */
  52475. getClassName(): string;
  52476. /**
  52477. * Creates an effect layer from parsed effect layer data
  52478. * @param parsedEffectLayer defines effect layer data
  52479. * @param scene defines the current scene
  52480. * @param rootUrl defines the root URL containing the effect layer information
  52481. * @returns a parsed effect Layer
  52482. */
  52483. static Parse(parsedEffectLayer: any, scene: Scene, rootUrl: string): EffectLayer;
  52484. }
  52485. }
  52486. declare module "babylonjs/Layers/effectLayerSceneComponent" {
  52487. import { Scene } from "babylonjs/scene";
  52488. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  52489. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  52490. import { AbstractScene } from "babylonjs/abstractScene";
  52491. module "babylonjs/abstractScene" {
  52492. interface AbstractScene {
  52493. /**
  52494. * The list of effect layers (highlights/glow) added to the scene
  52495. * @see http://doc.babylonjs.com/how_to/highlight_layer
  52496. * @see http://doc.babylonjs.com/how_to/glow_layer
  52497. */
  52498. effectLayers: Array<EffectLayer>;
  52499. /**
  52500. * Removes the given effect layer from this scene.
  52501. * @param toRemove defines the effect layer to remove
  52502. * @returns the index of the removed effect layer
  52503. */
  52504. removeEffectLayer(toRemove: EffectLayer): number;
  52505. /**
  52506. * Adds the given effect layer to this scene
  52507. * @param newEffectLayer defines the effect layer to add
  52508. */
  52509. addEffectLayer(newEffectLayer: EffectLayer): void;
  52510. }
  52511. }
  52512. /**
  52513. * Defines the layer scene component responsible to manage any effect layers
  52514. * in a given scene.
  52515. */
  52516. export class EffectLayerSceneComponent implements ISceneSerializableComponent {
  52517. /**
  52518. * The component name helpfull to identify the component in the list of scene components.
  52519. */
  52520. readonly name: string;
  52521. /**
  52522. * The scene the component belongs to.
  52523. */
  52524. scene: Scene;
  52525. private _engine;
  52526. private _renderEffects;
  52527. private _needStencil;
  52528. private _previousStencilState;
  52529. /**
  52530. * Creates a new instance of the component for the given scene
  52531. * @param scene Defines the scene to register the component in
  52532. */
  52533. constructor(scene: Scene);
  52534. /**
  52535. * Registers the component in a given scene
  52536. */
  52537. register(): void;
  52538. /**
  52539. * Rebuilds the elements related to this component in case of
  52540. * context lost for instance.
  52541. */
  52542. rebuild(): void;
  52543. /**
  52544. * Serializes the component data to the specified json object
  52545. * @param serializationObject The object to serialize to
  52546. */
  52547. serialize(serializationObject: any): void;
  52548. /**
  52549. * Adds all the elements from the container to the scene
  52550. * @param container the container holding the elements
  52551. */
  52552. addFromContainer(container: AbstractScene): void;
  52553. /**
  52554. * Removes all the elements in the container from the scene
  52555. * @param container contains the elements to remove
  52556. * @param dispose if the removed element should be disposed (default: false)
  52557. */
  52558. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  52559. /**
  52560. * Disposes the component and the associated ressources.
  52561. */
  52562. dispose(): void;
  52563. private _isReadyForMesh;
  52564. private _renderMainTexture;
  52565. private _setStencil;
  52566. private _setStencilBack;
  52567. private _draw;
  52568. private _drawCamera;
  52569. private _drawRenderingGroup;
  52570. }
  52571. }
  52572. declare module "babylonjs/Shaders/glowMapMerge.fragment" {
  52573. /** @hidden */
  52574. export var glowMapMergePixelShader: {
  52575. name: string;
  52576. shader: string;
  52577. };
  52578. }
  52579. declare module "babylonjs/Shaders/glowMapMerge.vertex" {
  52580. /** @hidden */
  52581. export var glowMapMergeVertexShader: {
  52582. name: string;
  52583. shader: string;
  52584. };
  52585. }
  52586. declare module "babylonjs/Layers/glowLayer" {
  52587. import { Nullable } from "babylonjs/types";
  52588. import { Camera } from "babylonjs/Cameras/camera";
  52589. import { Scene } from "babylonjs/scene";
  52590. import { SubMesh } from "babylonjs/Meshes/subMesh";
  52591. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52592. import { Mesh } from "babylonjs/Meshes/mesh";
  52593. import { Texture } from "babylonjs/Materials/Textures/texture";
  52594. import { Effect } from "babylonjs/Materials/effect";
  52595. import { Material } from "babylonjs/Materials/material";
  52596. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  52597. import { Color4 } from "babylonjs/Maths/math.color";
  52598. import "babylonjs/Shaders/glowMapMerge.fragment";
  52599. import "babylonjs/Shaders/glowMapMerge.vertex";
  52600. import "babylonjs/Layers/effectLayerSceneComponent";
  52601. module "babylonjs/abstractScene" {
  52602. interface AbstractScene {
  52603. /**
  52604. * Return a the first highlight layer of the scene with a given name.
  52605. * @param name The name of the highlight layer to look for.
  52606. * @return The highlight layer if found otherwise null.
  52607. */
  52608. getGlowLayerByName(name: string): Nullable<GlowLayer>;
  52609. }
  52610. }
  52611. /**
  52612. * Glow layer options. This helps customizing the behaviour
  52613. * of the glow layer.
  52614. */
  52615. export interface IGlowLayerOptions {
  52616. /**
  52617. * Multiplication factor apply to the canvas size to compute the render target size
  52618. * used to generated the glowing objects (the smaller the faster).
  52619. */
  52620. mainTextureRatio: number;
  52621. /**
  52622. * Enforces a fixed size texture to ensure resize independant blur.
  52623. */
  52624. mainTextureFixedSize?: number;
  52625. /**
  52626. * How big is the kernel of the blur texture.
  52627. */
  52628. blurKernelSize: number;
  52629. /**
  52630. * The camera attached to the layer.
  52631. */
  52632. camera: Nullable<Camera>;
  52633. /**
  52634. * Enable MSAA by chosing the number of samples.
  52635. */
  52636. mainTextureSamples?: number;
  52637. /**
  52638. * The rendering group to draw the layer in.
  52639. */
  52640. renderingGroupId: number;
  52641. }
  52642. /**
  52643. * The glow layer Helps adding a glow effect around the emissive parts of a mesh.
  52644. *
  52645. * Once instantiated in a scene, by default, all the emissive meshes will glow.
  52646. *
  52647. * Documentation: https://doc.babylonjs.com/how_to/glow_layer
  52648. */
  52649. export class GlowLayer extends EffectLayer {
  52650. /**
  52651. * Effect Name of the layer.
  52652. */
  52653. static readonly EffectName: string;
  52654. /**
  52655. * The default blur kernel size used for the glow.
  52656. */
  52657. static DefaultBlurKernelSize: number;
  52658. /**
  52659. * The default texture size ratio used for the glow.
  52660. */
  52661. static DefaultTextureRatio: number;
  52662. /**
  52663. * Sets the kernel size of the blur.
  52664. */
  52665. /**
  52666. * Gets the kernel size of the blur.
  52667. */
  52668. blurKernelSize: number;
  52669. /**
  52670. * Sets the glow intensity.
  52671. */
  52672. /**
  52673. * Gets the glow intensity.
  52674. */
  52675. intensity: number;
  52676. private _options;
  52677. private _intensity;
  52678. private _horizontalBlurPostprocess1;
  52679. private _verticalBlurPostprocess1;
  52680. private _horizontalBlurPostprocess2;
  52681. private _verticalBlurPostprocess2;
  52682. private _blurTexture1;
  52683. private _blurTexture2;
  52684. private _postProcesses1;
  52685. private _postProcesses2;
  52686. private _includedOnlyMeshes;
  52687. private _excludedMeshes;
  52688. private _meshesUsingTheirOwnMaterials;
  52689. /**
  52690. * Callback used to let the user override the color selection on a per mesh basis
  52691. */
  52692. customEmissiveColorSelector: (mesh: Mesh, subMesh: SubMesh, material: Material, result: Color4) => void;
  52693. /**
  52694. * Callback used to let the user override the texture selection on a per mesh basis
  52695. */
  52696. customEmissiveTextureSelector: (mesh: Mesh, subMesh: SubMesh, material: Material) => Texture;
  52697. /**
  52698. * Instantiates a new glow Layer and references it to the scene.
  52699. * @param name The name of the layer
  52700. * @param scene The scene to use the layer in
  52701. * @param options Sets of none mandatory options to use with the layer (see IGlowLayerOptions for more information)
  52702. */
  52703. constructor(name: string, scene: Scene, options?: Partial<IGlowLayerOptions>);
  52704. /**
  52705. * Get the effect name of the layer.
  52706. * @return The effect name
  52707. */
  52708. getEffectName(): string;
  52709. /**
  52710. * Create the merge effect. This is the shader use to blit the information back
  52711. * to the main canvas at the end of the scene rendering.
  52712. */
  52713. protected _createMergeEffect(): Effect;
  52714. /**
  52715. * Creates the render target textures and post processes used in the glow layer.
  52716. */
  52717. protected _createTextureAndPostProcesses(): void;
  52718. /**
  52719. * Checks for the readiness of the element composing the layer.
  52720. * @param subMesh the mesh to check for
  52721. * @param useInstances specify wether or not to use instances to render the mesh
  52722. * @param emissiveTexture the associated emissive texture used to generate the glow
  52723. * @return true if ready otherwise, false
  52724. */
  52725. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  52726. /**
  52727. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  52728. */
  52729. needStencil(): boolean;
  52730. /**
  52731. * Returns true if the mesh can be rendered, otherwise false.
  52732. * @param mesh The mesh to render
  52733. * @param material The material used on the mesh
  52734. * @returns true if it can be rendered otherwise false
  52735. */
  52736. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  52737. /**
  52738. * Implementation specific of rendering the generating effect on the main canvas.
  52739. * @param effect The effect used to render through
  52740. */
  52741. protected _internalRender(effect: Effect): void;
  52742. /**
  52743. * Sets the required values for both the emissive texture and and the main color.
  52744. */
  52745. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  52746. /**
  52747. * Returns true if the mesh should render, otherwise false.
  52748. * @param mesh The mesh to render
  52749. * @returns true if it should render otherwise false
  52750. */
  52751. protected _shouldRenderMesh(mesh: Mesh): boolean;
  52752. /**
  52753. * Adds specific effects defines.
  52754. * @param defines The defines to add specifics to.
  52755. */
  52756. protected _addCustomEffectDefines(defines: string[]): void;
  52757. /**
  52758. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the glow layer.
  52759. * @param mesh The mesh to exclude from the glow layer
  52760. */
  52761. addExcludedMesh(mesh: Mesh): void;
  52762. /**
  52763. * Remove a mesh from the exclusion list to let it impact or being impacted by the glow layer.
  52764. * @param mesh The mesh to remove
  52765. */
  52766. removeExcludedMesh(mesh: Mesh): void;
  52767. /**
  52768. * Add a mesh in the inclusion list to impact or being impacted by the glow layer.
  52769. * @param mesh The mesh to include in the glow layer
  52770. */
  52771. addIncludedOnlyMesh(mesh: Mesh): void;
  52772. /**
  52773. * Remove a mesh from the Inclusion list to prevent it to impact or being impacted by the glow layer.
  52774. * @param mesh The mesh to remove
  52775. */
  52776. removeIncludedOnlyMesh(mesh: Mesh): void;
  52777. /**
  52778. * Determine if a given mesh will be used in the glow layer
  52779. * @param mesh The mesh to test
  52780. * @returns true if the mesh will be highlighted by the current glow layer
  52781. */
  52782. hasMesh(mesh: AbstractMesh): boolean;
  52783. /**
  52784. * Defines wether the current material of the mesh should be use to render the effect.
  52785. * @param mesh defines the current mesh to render
  52786. */
  52787. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  52788. /**
  52789. * Add a mesh to be rendered through its own material and not with emissive only.
  52790. * @param mesh The mesh for which we need to use its material
  52791. */
  52792. referenceMeshToUseItsOwnMaterial(mesh: AbstractMesh): void;
  52793. /**
  52794. * Remove a mesh from being rendered through its own material and not with emissive only.
  52795. * @param mesh The mesh for which we need to not use its material
  52796. */
  52797. unReferenceMeshFromUsingItsOwnMaterial(mesh: AbstractMesh): void;
  52798. /**
  52799. * Free any resources and references associated to a mesh.
  52800. * Internal use
  52801. * @param mesh The mesh to free.
  52802. * @hidden
  52803. */
  52804. _disposeMesh(mesh: Mesh): void;
  52805. /**
  52806. * Gets the class name of the effect layer
  52807. * @returns the string with the class name of the effect layer
  52808. */
  52809. getClassName(): string;
  52810. /**
  52811. * Serializes this glow layer
  52812. * @returns a serialized glow layer object
  52813. */
  52814. serialize(): any;
  52815. /**
  52816. * Creates a Glow Layer from parsed glow layer data
  52817. * @param parsedGlowLayer defines glow layer data
  52818. * @param scene defines the current scene
  52819. * @param rootUrl defines the root URL containing the glow layer information
  52820. * @returns a parsed Glow Layer
  52821. */
  52822. static Parse(parsedGlowLayer: any, scene: Scene, rootUrl: string): GlowLayer;
  52823. }
  52824. }
  52825. declare module "babylonjs/Shaders/glowBlurPostProcess.fragment" {
  52826. /** @hidden */
  52827. export var glowBlurPostProcessPixelShader: {
  52828. name: string;
  52829. shader: string;
  52830. };
  52831. }
  52832. declare module "babylonjs/Layers/highlightLayer" {
  52833. import { Observable } from "babylonjs/Misc/observable";
  52834. import { Nullable } from "babylonjs/types";
  52835. import { Camera } from "babylonjs/Cameras/camera";
  52836. import { Scene } from "babylonjs/scene";
  52837. import { SubMesh } from "babylonjs/Meshes/subMesh";
  52838. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  52839. import { Mesh } from "babylonjs/Meshes/mesh";
  52840. import { Effect } from "babylonjs/Materials/effect";
  52841. import { Material } from "babylonjs/Materials/material";
  52842. import { EffectLayer } from "babylonjs/Layers/effectLayer";
  52843. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  52844. import "babylonjs/Shaders/glowMapMerge.fragment";
  52845. import "babylonjs/Shaders/glowMapMerge.vertex";
  52846. import "babylonjs/Shaders/glowBlurPostProcess.fragment";
  52847. module "babylonjs/abstractScene" {
  52848. interface AbstractScene {
  52849. /**
  52850. * Return a the first highlight layer of the scene with a given name.
  52851. * @param name The name of the highlight layer to look for.
  52852. * @return The highlight layer if found otherwise null.
  52853. */
  52854. getHighlightLayerByName(name: string): Nullable<HighlightLayer>;
  52855. }
  52856. }
  52857. /**
  52858. * Highlight layer options. This helps customizing the behaviour
  52859. * of the highlight layer.
  52860. */
  52861. export interface IHighlightLayerOptions {
  52862. /**
  52863. * Multiplication factor apply to the canvas size to compute the render target size
  52864. * used to generated the glowing objects (the smaller the faster).
  52865. */
  52866. mainTextureRatio: number;
  52867. /**
  52868. * Enforces a fixed size texture to ensure resize independant blur.
  52869. */
  52870. mainTextureFixedSize?: number;
  52871. /**
  52872. * Multiplication factor apply to the main texture size in the first step of the blur to reduce the size
  52873. * of the picture to blur (the smaller the faster).
  52874. */
  52875. blurTextureSizeRatio: number;
  52876. /**
  52877. * How big in texel of the blur texture is the vertical blur.
  52878. */
  52879. blurVerticalSize: number;
  52880. /**
  52881. * How big in texel of the blur texture is the horizontal blur.
  52882. */
  52883. blurHorizontalSize: number;
  52884. /**
  52885. * Alpha blending mode used to apply the blur. Default is combine.
  52886. */
  52887. alphaBlendingMode: number;
  52888. /**
  52889. * The camera attached to the layer.
  52890. */
  52891. camera: Nullable<Camera>;
  52892. /**
  52893. * Should we display highlight as a solid stroke?
  52894. */
  52895. isStroke?: boolean;
  52896. /**
  52897. * The rendering group to draw the layer in.
  52898. */
  52899. renderingGroupId: number;
  52900. }
  52901. /**
  52902. * The highlight layer Helps adding a glow effect around a mesh.
  52903. *
  52904. * Once instantiated in a scene, simply use the addMesh or removeMesh method to add or remove
  52905. * glowy meshes to your scene.
  52906. *
  52907. * !!! THIS REQUIRES AN ACTIVE STENCIL BUFFER ON THE CANVAS !!!
  52908. */
  52909. export class HighlightLayer extends EffectLayer {
  52910. name: string;
  52911. /**
  52912. * Effect Name of the highlight layer.
  52913. */
  52914. static readonly EffectName: string;
  52915. /**
  52916. * The neutral color used during the preparation of the glow effect.
  52917. * This is black by default as the blend operation is a blend operation.
  52918. */
  52919. static NeutralColor: Color4;
  52920. /**
  52921. * Stencil value used for glowing meshes.
  52922. */
  52923. static GlowingMeshStencilReference: number;
  52924. /**
  52925. * Stencil value used for the other meshes in the scene.
  52926. */
  52927. static NormalMeshStencilReference: number;
  52928. /**
  52929. * Specifies whether or not the inner glow is ACTIVE in the layer.
  52930. */
  52931. innerGlow: boolean;
  52932. /**
  52933. * Specifies whether or not the outer glow is ACTIVE in the layer.
  52934. */
  52935. outerGlow: boolean;
  52936. /**
  52937. * Specifies the horizontal size of the blur.
  52938. */
  52939. /**
  52940. * Gets the horizontal size of the blur.
  52941. */
  52942. blurHorizontalSize: number;
  52943. /**
  52944. * Specifies the vertical size of the blur.
  52945. */
  52946. /**
  52947. * Gets the vertical size of the blur.
  52948. */
  52949. blurVerticalSize: number;
  52950. /**
  52951. * An event triggered when the highlight layer is being blurred.
  52952. */
  52953. onBeforeBlurObservable: Observable<HighlightLayer>;
  52954. /**
  52955. * An event triggered when the highlight layer has been blurred.
  52956. */
  52957. onAfterBlurObservable: Observable<HighlightLayer>;
  52958. private _instanceGlowingMeshStencilReference;
  52959. private _options;
  52960. private _downSamplePostprocess;
  52961. private _horizontalBlurPostprocess;
  52962. private _verticalBlurPostprocess;
  52963. private _blurTexture;
  52964. private _meshes;
  52965. private _excludedMeshes;
  52966. /**
  52967. * Instantiates a new highlight Layer and references it to the scene..
  52968. * @param name The name of the layer
  52969. * @param scene The scene to use the layer in
  52970. * @param options Sets of none mandatory options to use with the layer (see IHighlightLayerOptions for more information)
  52971. */
  52972. constructor(name: string, scene: Scene, options?: Partial<IHighlightLayerOptions>);
  52973. /**
  52974. * Get the effect name of the layer.
  52975. * @return The effect name
  52976. */
  52977. getEffectName(): string;
  52978. /**
  52979. * Create the merge effect. This is the shader use to blit the information back
  52980. * to the main canvas at the end of the scene rendering.
  52981. */
  52982. protected _createMergeEffect(): Effect;
  52983. /**
  52984. * Creates the render target textures and post processes used in the highlight layer.
  52985. */
  52986. protected _createTextureAndPostProcesses(): void;
  52987. /**
  52988. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  52989. */
  52990. needStencil(): boolean;
  52991. /**
  52992. * Checks for the readiness of the element composing the layer.
  52993. * @param subMesh the mesh to check for
  52994. * @param useInstances specify wether or not to use instances to render the mesh
  52995. * @param emissiveTexture the associated emissive texture used to generate the glow
  52996. * @return true if ready otherwise, false
  52997. */
  52998. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  52999. /**
  53000. * Implementation specific of rendering the generating effect on the main canvas.
  53001. * @param effect The effect used to render through
  53002. */
  53003. protected _internalRender(effect: Effect): void;
  53004. /**
  53005. * Returns true if the layer contains information to display, otherwise false.
  53006. */
  53007. shouldRender(): boolean;
  53008. /**
  53009. * Returns true if the mesh should render, otherwise false.
  53010. * @param mesh The mesh to render
  53011. * @returns true if it should render otherwise false
  53012. */
  53013. protected _shouldRenderMesh(mesh: Mesh): boolean;
  53014. /**
  53015. * Sets the required values for both the emissive texture and and the main color.
  53016. */
  53017. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  53018. /**
  53019. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the highlight layer.
  53020. * @param mesh The mesh to exclude from the highlight layer
  53021. */
  53022. addExcludedMesh(mesh: Mesh): void;
  53023. /**
  53024. * Remove a mesh from the exclusion list to let it impact or being impacted by the highlight layer.
  53025. * @param mesh The mesh to highlight
  53026. */
  53027. removeExcludedMesh(mesh: Mesh): void;
  53028. /**
  53029. * Determine if a given mesh will be highlighted by the current HighlightLayer
  53030. * @param mesh mesh to test
  53031. * @returns true if the mesh will be highlighted by the current HighlightLayer
  53032. */
  53033. hasMesh(mesh: AbstractMesh): boolean;
  53034. /**
  53035. * Add a mesh in the highlight layer in order to make it glow with the chosen color.
  53036. * @param mesh The mesh to highlight
  53037. * @param color The color of the highlight
  53038. * @param glowEmissiveOnly Extract the glow from the emissive texture
  53039. */
  53040. addMesh(mesh: Mesh, color: Color3, glowEmissiveOnly?: boolean): void;
  53041. /**
  53042. * Remove a mesh from the highlight layer in order to make it stop glowing.
  53043. * @param mesh The mesh to highlight
  53044. */
  53045. removeMesh(mesh: Mesh): void;
  53046. /**
  53047. * Force the stencil to the normal expected value for none glowing parts
  53048. */
  53049. private _defaultStencilReference;
  53050. /**
  53051. * Free any resources and references associated to a mesh.
  53052. * Internal use
  53053. * @param mesh The mesh to free.
  53054. * @hidden
  53055. */
  53056. _disposeMesh(mesh: Mesh): void;
  53057. /**
  53058. * Dispose the highlight layer and free resources.
  53059. */
  53060. dispose(): void;
  53061. /**
  53062. * Gets the class name of the effect layer
  53063. * @returns the string with the class name of the effect layer
  53064. */
  53065. getClassName(): string;
  53066. /**
  53067. * Serializes this Highlight layer
  53068. * @returns a serialized Highlight layer object
  53069. */
  53070. serialize(): any;
  53071. /**
  53072. * Creates a Highlight layer from parsed Highlight layer data
  53073. * @param parsedHightlightLayer defines the Highlight layer data
  53074. * @param scene defines the current scene
  53075. * @param rootUrl defines the root URL containing the Highlight layer information
  53076. * @returns a parsed Highlight layer
  53077. */
  53078. static Parse(parsedHightlightLayer: any, scene: Scene, rootUrl: string): HighlightLayer;
  53079. }
  53080. }
  53081. declare module "babylonjs/Layers/layerSceneComponent" {
  53082. import { Scene } from "babylonjs/scene";
  53083. import { ISceneComponent } from "babylonjs/sceneComponent";
  53084. import { Layer } from "babylonjs/Layers/layer";
  53085. import { AbstractScene } from "babylonjs/abstractScene";
  53086. module "babylonjs/abstractScene" {
  53087. interface AbstractScene {
  53088. /**
  53089. * The list of layers (background and foreground) of the scene
  53090. */
  53091. layers: Array<Layer>;
  53092. }
  53093. }
  53094. /**
  53095. * Defines the layer scene component responsible to manage any layers
  53096. * in a given scene.
  53097. */
  53098. export class LayerSceneComponent implements ISceneComponent {
  53099. /**
  53100. * The component name helpfull to identify the component in the list of scene components.
  53101. */
  53102. readonly name: string;
  53103. /**
  53104. * The scene the component belongs to.
  53105. */
  53106. scene: Scene;
  53107. private _engine;
  53108. /**
  53109. * Creates a new instance of the component for the given scene
  53110. * @param scene Defines the scene to register the component in
  53111. */
  53112. constructor(scene: Scene);
  53113. /**
  53114. * Registers the component in a given scene
  53115. */
  53116. register(): void;
  53117. /**
  53118. * Rebuilds the elements related to this component in case of
  53119. * context lost for instance.
  53120. */
  53121. rebuild(): void;
  53122. /**
  53123. * Disposes the component and the associated ressources.
  53124. */
  53125. dispose(): void;
  53126. private _draw;
  53127. private _drawCameraPredicate;
  53128. private _drawCameraBackground;
  53129. private _drawCameraForeground;
  53130. private _drawRenderTargetPredicate;
  53131. private _drawRenderTargetBackground;
  53132. private _drawRenderTargetForeground;
  53133. /**
  53134. * Adds all the elements from the container to the scene
  53135. * @param container the container holding the elements
  53136. */
  53137. addFromContainer(container: AbstractScene): void;
  53138. /**
  53139. * Removes all the elements in the container from the scene
  53140. * @param container contains the elements to remove
  53141. * @param dispose if the removed element should be disposed (default: false)
  53142. */
  53143. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  53144. }
  53145. }
  53146. declare module "babylonjs/Shaders/layer.fragment" {
  53147. /** @hidden */
  53148. export var layerPixelShader: {
  53149. name: string;
  53150. shader: string;
  53151. };
  53152. }
  53153. declare module "babylonjs/Shaders/layer.vertex" {
  53154. /** @hidden */
  53155. export var layerVertexShader: {
  53156. name: string;
  53157. shader: string;
  53158. };
  53159. }
  53160. declare module "babylonjs/Layers/layer" {
  53161. import { Observable } from "babylonjs/Misc/observable";
  53162. import { Nullable } from "babylonjs/types";
  53163. import { Scene } from "babylonjs/scene";
  53164. import { Vector2 } from "babylonjs/Maths/math.vector";
  53165. import { Color4 } from "babylonjs/Maths/math.color";
  53166. import { Texture } from "babylonjs/Materials/Textures/texture";
  53167. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  53168. import "babylonjs/Shaders/layer.fragment";
  53169. import "babylonjs/Shaders/layer.vertex";
  53170. /**
  53171. * This represents a full screen 2d layer.
  53172. * This can be useful to display a picture in the background of your scene for instance.
  53173. * @see https://www.babylonjs-playground.com/#08A2BS#1
  53174. */
  53175. export class Layer {
  53176. /**
  53177. * Define the name of the layer.
  53178. */
  53179. name: string;
  53180. /**
  53181. * Define the texture the layer should display.
  53182. */
  53183. texture: Nullable<Texture>;
  53184. /**
  53185. * Is the layer in background or foreground.
  53186. */
  53187. isBackground: boolean;
  53188. /**
  53189. * Define the color of the layer (instead of texture).
  53190. */
  53191. color: Color4;
  53192. /**
  53193. * Define the scale of the layer in order to zoom in out of the texture.
  53194. */
  53195. scale: Vector2;
  53196. /**
  53197. * Define an offset for the layer in order to shift the texture.
  53198. */
  53199. offset: Vector2;
  53200. /**
  53201. * Define the alpha blending mode used in the layer in case the texture or color has an alpha.
  53202. */
  53203. alphaBlendingMode: number;
  53204. /**
  53205. * Define if the layer should alpha test or alpha blend with the rest of the scene.
  53206. * Alpha test will not mix with the background color in case of transparency.
  53207. * It will either use the texture color or the background depending on the alpha value of the current pixel.
  53208. */
  53209. alphaTest: boolean;
  53210. /**
  53211. * Define a mask to restrict the layer to only some of the scene cameras.
  53212. */
  53213. layerMask: number;
  53214. /**
  53215. * Define the list of render target the layer is visible into.
  53216. */
  53217. renderTargetTextures: RenderTargetTexture[];
  53218. /**
  53219. * Define if the layer is only used in renderTarget or if it also
  53220. * renders in the main frame buffer of the canvas.
  53221. */
  53222. renderOnlyInRenderTargetTextures: boolean;
  53223. private _scene;
  53224. private _vertexBuffers;
  53225. private _indexBuffer;
  53226. private _effect;
  53227. private _alphaTestEffect;
  53228. /**
  53229. * An event triggered when the layer is disposed.
  53230. */
  53231. onDisposeObservable: Observable<Layer>;
  53232. private _onDisposeObserver;
  53233. /**
  53234. * Back compatibility with callback before the onDisposeObservable existed.
  53235. * The set callback will be triggered when the layer has been disposed.
  53236. */
  53237. onDispose: () => void;
  53238. /**
  53239. * An event triggered before rendering the scene
  53240. */
  53241. onBeforeRenderObservable: Observable<Layer>;
  53242. private _onBeforeRenderObserver;
  53243. /**
  53244. * Back compatibility with callback before the onBeforeRenderObservable existed.
  53245. * The set callback will be triggered just before rendering the layer.
  53246. */
  53247. onBeforeRender: () => void;
  53248. /**
  53249. * An event triggered after rendering the scene
  53250. */
  53251. onAfterRenderObservable: Observable<Layer>;
  53252. private _onAfterRenderObserver;
  53253. /**
  53254. * Back compatibility with callback before the onAfterRenderObservable existed.
  53255. * The set callback will be triggered just after rendering the layer.
  53256. */
  53257. onAfterRender: () => void;
  53258. /**
  53259. * Instantiates a new layer.
  53260. * This represents a full screen 2d layer.
  53261. * This can be useful to display a picture in the background of your scene for instance.
  53262. * @see https://www.babylonjs-playground.com/#08A2BS#1
  53263. * @param name Define the name of the layer in the scene
  53264. * @param imgUrl Define the url of the texture to display in the layer
  53265. * @param scene Define the scene the layer belongs to
  53266. * @param isBackground Defines whether the layer is displayed in front or behind the scene
  53267. * @param color Defines a color for the layer
  53268. */
  53269. constructor(
  53270. /**
  53271. * Define the name of the layer.
  53272. */
  53273. name: string, imgUrl: Nullable<string>, scene: Nullable<Scene>, isBackground?: boolean, color?: Color4);
  53274. private _createIndexBuffer;
  53275. /** @hidden */
  53276. _rebuild(): void;
  53277. /**
  53278. * Renders the layer in the scene.
  53279. */
  53280. render(): void;
  53281. /**
  53282. * Disposes and releases the associated ressources.
  53283. */
  53284. dispose(): void;
  53285. }
  53286. }
  53287. declare module "babylonjs/Layers/index" {
  53288. export * from "babylonjs/Layers/effectLayer";
  53289. export * from "babylonjs/Layers/effectLayerSceneComponent";
  53290. export * from "babylonjs/Layers/glowLayer";
  53291. export * from "babylonjs/Layers/highlightLayer";
  53292. export * from "babylonjs/Layers/layer";
  53293. export * from "babylonjs/Layers/layerSceneComponent";
  53294. }
  53295. declare module "babylonjs/Shaders/lensFlare.fragment" {
  53296. /** @hidden */
  53297. export var lensFlarePixelShader: {
  53298. name: string;
  53299. shader: string;
  53300. };
  53301. }
  53302. declare module "babylonjs/Shaders/lensFlare.vertex" {
  53303. /** @hidden */
  53304. export var lensFlareVertexShader: {
  53305. name: string;
  53306. shader: string;
  53307. };
  53308. }
  53309. declare module "babylonjs/LensFlares/lensFlareSystem" {
  53310. import { Scene } from "babylonjs/scene";
  53311. import { Vector3 } from "babylonjs/Maths/math.vector";
  53312. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  53313. import { LensFlare } from "babylonjs/LensFlares/lensFlare";
  53314. import "babylonjs/Shaders/lensFlare.fragment";
  53315. import "babylonjs/Shaders/lensFlare.vertex";
  53316. import { Viewport } from "babylonjs/Maths/math.viewport";
  53317. /**
  53318. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  53319. * It is usually composed of several `lensFlare`.
  53320. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  53321. */
  53322. export class LensFlareSystem {
  53323. /**
  53324. * Define the name of the lens flare system
  53325. */
  53326. name: string;
  53327. /**
  53328. * List of lens flares used in this system.
  53329. */
  53330. lensFlares: LensFlare[];
  53331. /**
  53332. * Define a limit from the border the lens flare can be visible.
  53333. */
  53334. borderLimit: number;
  53335. /**
  53336. * Define a viewport border we do not want to see the lens flare in.
  53337. */
  53338. viewportBorder: number;
  53339. /**
  53340. * Define a predicate which could limit the list of meshes able to occlude the effect.
  53341. */
  53342. meshesSelectionPredicate: (mesh: AbstractMesh) => boolean;
  53343. /**
  53344. * Restricts the rendering of the effect to only the camera rendering this layer mask.
  53345. */
  53346. layerMask: number;
  53347. /**
  53348. * Define the id of the lens flare system in the scene.
  53349. * (equal to name by default)
  53350. */
  53351. id: string;
  53352. private _scene;
  53353. private _emitter;
  53354. private _vertexBuffers;
  53355. private _indexBuffer;
  53356. private _effect;
  53357. private _positionX;
  53358. private _positionY;
  53359. private _isEnabled;
  53360. /** @hidden */
  53361. static _SceneComponentInitialization: (scene: Scene) => void;
  53362. /**
  53363. * Instantiates a lens flare system.
  53364. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  53365. * It is usually composed of several `lensFlare`.
  53366. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  53367. * @param name Define the name of the lens flare system in the scene
  53368. * @param emitter Define the source (the emitter) of the lens flares (it can be a camera, a light or a mesh).
  53369. * @param scene Define the scene the lens flare system belongs to
  53370. */
  53371. constructor(
  53372. /**
  53373. * Define the name of the lens flare system
  53374. */
  53375. name: string, emitter: any, scene: Scene);
  53376. /**
  53377. * Define if the lens flare system is enabled.
  53378. */
  53379. isEnabled: boolean;
  53380. /**
  53381. * Get the scene the effects belongs to.
  53382. * @returns the scene holding the lens flare system
  53383. */
  53384. getScene(): Scene;
  53385. /**
  53386. * Get the emitter of the lens flare system.
  53387. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  53388. * @returns the emitter of the lens flare system
  53389. */
  53390. getEmitter(): any;
  53391. /**
  53392. * Set the emitter of the lens flare system.
  53393. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  53394. * @param newEmitter Define the new emitter of the system
  53395. */
  53396. setEmitter(newEmitter: any): void;
  53397. /**
  53398. * Get the lens flare system emitter position.
  53399. * The emitter defines the source of the lens flares (it can be a camera, a light or a mesh).
  53400. * @returns the position
  53401. */
  53402. getEmitterPosition(): Vector3;
  53403. /**
  53404. * @hidden
  53405. */
  53406. computeEffectivePosition(globalViewport: Viewport): boolean;
  53407. /** @hidden */
  53408. _isVisible(): boolean;
  53409. /**
  53410. * @hidden
  53411. */
  53412. render(): boolean;
  53413. /**
  53414. * Dispose and release the lens flare with its associated resources.
  53415. */
  53416. dispose(): void;
  53417. /**
  53418. * Parse a lens flare system from a JSON repressentation
  53419. * @param parsedLensFlareSystem Define the JSON to parse
  53420. * @param scene Define the scene the parsed system should be instantiated in
  53421. * @param rootUrl Define the rootUrl of the load sequence to easily find a load relative dependencies such as textures
  53422. * @returns the parsed system
  53423. */
  53424. static Parse(parsedLensFlareSystem: any, scene: Scene, rootUrl: string): LensFlareSystem;
  53425. /**
  53426. * Serialize the current Lens Flare System into a JSON representation.
  53427. * @returns the serialized JSON
  53428. */
  53429. serialize(): any;
  53430. }
  53431. }
  53432. declare module "babylonjs/LensFlares/lensFlare" {
  53433. import { Nullable } from "babylonjs/types";
  53434. import { Color3 } from "babylonjs/Maths/math.color";
  53435. import { Texture } from "babylonjs/Materials/Textures/texture";
  53436. import { LensFlareSystem } from "babylonjs/LensFlares/lensFlareSystem";
  53437. /**
  53438. * This represents one of the lens effect in a `lensFlareSystem`.
  53439. * It controls one of the indiviual texture used in the effect.
  53440. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  53441. */
  53442. export class LensFlare {
  53443. /**
  53444. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  53445. */
  53446. size: number;
  53447. /**
  53448. * 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.
  53449. */
  53450. position: number;
  53451. /**
  53452. * Define the lens color.
  53453. */
  53454. color: Color3;
  53455. /**
  53456. * Define the lens texture.
  53457. */
  53458. texture: Nullable<Texture>;
  53459. /**
  53460. * Define the alpha mode to render this particular lens.
  53461. */
  53462. alphaMode: number;
  53463. private _system;
  53464. /**
  53465. * Creates a new Lens Flare.
  53466. * This represents one of the lens effect in a `lensFlareSystem`.
  53467. * It controls one of the indiviual texture used in the effect.
  53468. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  53469. * @param size Define the size of the lens flare (a floating value between 0 and 1)
  53470. * @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.
  53471. * @param color Define the lens color
  53472. * @param imgUrl Define the lens texture url
  53473. * @param system Define the `lensFlareSystem` this flare is part of
  53474. * @returns The newly created Lens Flare
  53475. */
  53476. static AddFlare(size: number, position: number, color: Color3, imgUrl: string, system: LensFlareSystem): LensFlare;
  53477. /**
  53478. * Instantiates a new Lens Flare.
  53479. * This represents one of the lens effect in a `lensFlareSystem`.
  53480. * It controls one of the indiviual texture used in the effect.
  53481. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  53482. * @param size Define the size of the lens flare in the system (a floating value between 0 and 1)
  53483. * @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.
  53484. * @param color Define the lens color
  53485. * @param imgUrl Define the lens texture url
  53486. * @param system Define the `lensFlareSystem` this flare is part of
  53487. */
  53488. constructor(
  53489. /**
  53490. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  53491. */
  53492. size: number,
  53493. /**
  53494. * 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.
  53495. */
  53496. position: number, color: Color3, imgUrl: string, system: LensFlareSystem);
  53497. /**
  53498. * Dispose and release the lens flare with its associated resources.
  53499. */
  53500. dispose(): void;
  53501. }
  53502. }
  53503. declare module "babylonjs/LensFlares/lensFlareSystemSceneComponent" {
  53504. import { Nullable } from "babylonjs/types";
  53505. import { Scene } from "babylonjs/scene";
  53506. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  53507. import { AbstractScene } from "babylonjs/abstractScene";
  53508. import { LensFlareSystem } from "babylonjs/LensFlares/lensFlareSystem";
  53509. module "babylonjs/abstractScene" {
  53510. interface AbstractScene {
  53511. /**
  53512. * The list of lens flare system added to the scene
  53513. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  53514. */
  53515. lensFlareSystems: Array<LensFlareSystem>;
  53516. /**
  53517. * Removes the given lens flare system from this scene.
  53518. * @param toRemove The lens flare system to remove
  53519. * @returns The index of the removed lens flare system
  53520. */
  53521. removeLensFlareSystem(toRemove: LensFlareSystem): number;
  53522. /**
  53523. * Adds the given lens flare system to this scene
  53524. * @param newLensFlareSystem The lens flare system to add
  53525. */
  53526. addLensFlareSystem(newLensFlareSystem: LensFlareSystem): void;
  53527. /**
  53528. * Gets a lens flare system using its name
  53529. * @param name defines the name to look for
  53530. * @returns the lens flare system or null if not found
  53531. */
  53532. getLensFlareSystemByName(name: string): Nullable<LensFlareSystem>;
  53533. /**
  53534. * Gets a lens flare system using its id
  53535. * @param id defines the id to look for
  53536. * @returns the lens flare system or null if not found
  53537. */
  53538. getLensFlareSystemByID(id: string): Nullable<LensFlareSystem>;
  53539. }
  53540. }
  53541. /**
  53542. * Defines the lens flare scene component responsible to manage any lens flares
  53543. * in a given scene.
  53544. */
  53545. export class LensFlareSystemSceneComponent implements ISceneSerializableComponent {
  53546. /**
  53547. * The component name helpfull to identify the component in the list of scene components.
  53548. */
  53549. readonly name: string;
  53550. /**
  53551. * The scene the component belongs to.
  53552. */
  53553. scene: Scene;
  53554. /**
  53555. * Creates a new instance of the component for the given scene
  53556. * @param scene Defines the scene to register the component in
  53557. */
  53558. constructor(scene: Scene);
  53559. /**
  53560. * Registers the component in a given scene
  53561. */
  53562. register(): void;
  53563. /**
  53564. * Rebuilds the elements related to this component in case of
  53565. * context lost for instance.
  53566. */
  53567. rebuild(): void;
  53568. /**
  53569. * Adds all the elements from the container to the scene
  53570. * @param container the container holding the elements
  53571. */
  53572. addFromContainer(container: AbstractScene): void;
  53573. /**
  53574. * Removes all the elements in the container from the scene
  53575. * @param container contains the elements to remove
  53576. * @param dispose if the removed element should be disposed (default: false)
  53577. */
  53578. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  53579. /**
  53580. * Serializes the component data to the specified json object
  53581. * @param serializationObject The object to serialize to
  53582. */
  53583. serialize(serializationObject: any): void;
  53584. /**
  53585. * Disposes the component and the associated ressources.
  53586. */
  53587. dispose(): void;
  53588. private _draw;
  53589. }
  53590. }
  53591. declare module "babylonjs/LensFlares/index" {
  53592. export * from "babylonjs/LensFlares/lensFlare";
  53593. export * from "babylonjs/LensFlares/lensFlareSystem";
  53594. export * from "babylonjs/LensFlares/lensFlareSystemSceneComponent";
  53595. }
  53596. declare module "babylonjs/Lights/Shadows/shadowGeneratorSceneComponent" {
  53597. import { Scene } from "babylonjs/scene";
  53598. import { ISceneSerializableComponent } from "babylonjs/sceneComponent";
  53599. import { AbstractScene } from "babylonjs/abstractScene";
  53600. /**
  53601. * Defines the shadow generator component responsible to manage any shadow generators
  53602. * in a given scene.
  53603. */
  53604. export class ShadowGeneratorSceneComponent implements ISceneSerializableComponent {
  53605. /**
  53606. * The component name helpfull to identify the component in the list of scene components.
  53607. */
  53608. readonly name: string;
  53609. /**
  53610. * The scene the component belongs to.
  53611. */
  53612. scene: Scene;
  53613. /**
  53614. * Creates a new instance of the component for the given scene
  53615. * @param scene Defines the scene to register the component in
  53616. */
  53617. constructor(scene: Scene);
  53618. /**
  53619. * Registers the component in a given scene
  53620. */
  53621. register(): void;
  53622. /**
  53623. * Rebuilds the elements related to this component in case of
  53624. * context lost for instance.
  53625. */
  53626. rebuild(): void;
  53627. /**
  53628. * Serializes the component data to the specified json object
  53629. * @param serializationObject The object to serialize to
  53630. */
  53631. serialize(serializationObject: any): void;
  53632. /**
  53633. * Adds all the elements from the container to the scene
  53634. * @param container the container holding the elements
  53635. */
  53636. addFromContainer(container: AbstractScene): void;
  53637. /**
  53638. * Removes all the elements in the container from the scene
  53639. * @param container contains the elements to remove
  53640. * @param dispose if the removed element should be disposed (default: false)
  53641. */
  53642. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  53643. /**
  53644. * Rebuilds the elements related to this component in case of
  53645. * context lost for instance.
  53646. */
  53647. dispose(): void;
  53648. private _gatherRenderTargets;
  53649. }
  53650. }
  53651. declare module "babylonjs/Lights/Shadows/index" {
  53652. export * from "babylonjs/Lights/Shadows/shadowGenerator";
  53653. export * from "babylonjs/Lights/Shadows/shadowGeneratorSceneComponent";
  53654. }
  53655. declare module "babylonjs/Lights/pointLight" {
  53656. import { Scene } from "babylonjs/scene";
  53657. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  53658. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  53659. import { ShadowLight } from "babylonjs/Lights/shadowLight";
  53660. import { Effect } from "babylonjs/Materials/effect";
  53661. /**
  53662. * A point light is a light defined by an unique point in world space.
  53663. * The light is emitted in every direction from this point.
  53664. * A good example of a point light is a standard light bulb.
  53665. * Documentation: https://doc.babylonjs.com/babylon101/lights
  53666. */
  53667. export class PointLight extends ShadowLight {
  53668. private _shadowAngle;
  53669. /**
  53670. * Getter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  53671. * This specifies what angle the shadow will use to be created.
  53672. *
  53673. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  53674. */
  53675. /**
  53676. * Setter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  53677. * This specifies what angle the shadow will use to be created.
  53678. *
  53679. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  53680. */
  53681. shadowAngle: number;
  53682. /**
  53683. * Gets the direction if it has been set.
  53684. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  53685. */
  53686. /**
  53687. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  53688. */
  53689. direction: Vector3;
  53690. /**
  53691. * Creates a PointLight object from the passed name and position (Vector3) and adds it in the scene.
  53692. * A PointLight emits the light in every direction.
  53693. * It can cast shadows.
  53694. * If the scene camera is already defined and you want to set your PointLight at the camera position, just set it :
  53695. * ```javascript
  53696. * var pointLight = new PointLight("pl", camera.position, scene);
  53697. * ```
  53698. * Documentation : https://doc.babylonjs.com/babylon101/lights
  53699. * @param name The light friendly name
  53700. * @param position The position of the point light in the scene
  53701. * @param scene The scene the lights belongs to
  53702. */
  53703. constructor(name: string, position: Vector3, scene: Scene);
  53704. /**
  53705. * Returns the string "PointLight"
  53706. * @returns the class name
  53707. */
  53708. getClassName(): string;
  53709. /**
  53710. * Returns the integer 0.
  53711. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  53712. */
  53713. getTypeID(): number;
  53714. /**
  53715. * Specifies wether or not the shadowmap should be a cube texture.
  53716. * @returns true if the shadowmap needs to be a cube texture.
  53717. */
  53718. needCube(): boolean;
  53719. /**
  53720. * Returns a new Vector3 aligned with the PointLight cube system according to the passed cube face index (integer).
  53721. * @param faceIndex The index of the face we are computed the direction to generate shadow
  53722. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  53723. */
  53724. getShadowDirection(faceIndex?: number): Vector3;
  53725. /**
  53726. * Sets the passed matrix "matrix" as a left-handed perspective projection matrix with the following settings :
  53727. * - fov = PI / 2
  53728. * - aspect ratio : 1.0
  53729. * - z-near and far equal to the active camera minZ and maxZ.
  53730. * Returns the PointLight.
  53731. */
  53732. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  53733. protected _buildUniformLayout(): void;
  53734. /**
  53735. * Sets the passed Effect "effect" with the PointLight transformed position (or position, if none) and passed name (string).
  53736. * @param effect The effect to update
  53737. * @param lightIndex The index of the light in the effect to update
  53738. * @returns The point light
  53739. */
  53740. transferToEffect(effect: Effect, lightIndex: string): PointLight;
  53741. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  53742. /**
  53743. * Prepares the list of defines specific to the light type.
  53744. * @param defines the list of defines
  53745. * @param lightIndex defines the index of the light for the effect
  53746. */
  53747. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  53748. }
  53749. }
  53750. declare module "babylonjs/Lights/index" {
  53751. export * from "babylonjs/Lights/light";
  53752. export * from "babylonjs/Lights/shadowLight";
  53753. export * from "babylonjs/Lights/Shadows/index";
  53754. export * from "babylonjs/Lights/directionalLight";
  53755. export * from "babylonjs/Lights/hemisphericLight";
  53756. export * from "babylonjs/Lights/pointLight";
  53757. export * from "babylonjs/Lights/spotLight";
  53758. }
  53759. declare module "babylonjs/Misc/HighDynamicRange/hdr" {
  53760. import { CubeMapInfo } from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  53761. /**
  53762. * Header information of HDR texture files.
  53763. */
  53764. export interface HDRInfo {
  53765. /**
  53766. * The height of the texture in pixels.
  53767. */
  53768. height: number;
  53769. /**
  53770. * The width of the texture in pixels.
  53771. */
  53772. width: number;
  53773. /**
  53774. * The index of the beginning of the data in the binary file.
  53775. */
  53776. dataPosition: number;
  53777. }
  53778. /**
  53779. * This groups tools to convert HDR texture to native colors array.
  53780. */
  53781. export class HDRTools {
  53782. private static Ldexp;
  53783. private static Rgbe2float;
  53784. private static readStringLine;
  53785. /**
  53786. * Reads header information from an RGBE texture stored in a native array.
  53787. * More information on this format are available here:
  53788. * https://en.wikipedia.org/wiki/RGBE_image_format
  53789. *
  53790. * @param uint8array The binary file stored in native array.
  53791. * @return The header information.
  53792. */
  53793. static RGBE_ReadHeader(uint8array: Uint8Array): HDRInfo;
  53794. /**
  53795. * Returns the cubemap information (each faces texture data) extracted from an RGBE texture.
  53796. * This RGBE texture needs to store the information as a panorama.
  53797. *
  53798. * More information on this format are available here:
  53799. * https://en.wikipedia.org/wiki/RGBE_image_format
  53800. *
  53801. * @param buffer The binary file stored in an array buffer.
  53802. * @param size The expected size of the extracted cubemap.
  53803. * @return The Cube Map information.
  53804. */
  53805. static GetCubeMapTextureData(buffer: ArrayBuffer, size: number): CubeMapInfo;
  53806. /**
  53807. * Returns the pixels data extracted from an RGBE texture.
  53808. * This pixels will be stored left to right up to down in the R G B order in one array.
  53809. *
  53810. * More information on this format are available here:
  53811. * https://en.wikipedia.org/wiki/RGBE_image_format
  53812. *
  53813. * @param uint8array The binary file stored in an array buffer.
  53814. * @param hdrInfo The header information of the file.
  53815. * @return The pixels data in RGB right to left up to down order.
  53816. */
  53817. static RGBE_ReadPixels(uint8array: Uint8Array, hdrInfo: HDRInfo): Float32Array;
  53818. private static RGBE_ReadPixels_RLE;
  53819. }
  53820. }
  53821. declare module "babylonjs/Materials/Textures/hdrCubeTexture" {
  53822. import { Nullable } from "babylonjs/types";
  53823. import { Scene } from "babylonjs/scene";
  53824. import { Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  53825. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  53826. import "babylonjs/Engines/Extensions/engine.rawTexture";
  53827. import "babylonjs/Materials/Textures/baseTexture.polynomial";
  53828. /**
  53829. * This represents a texture coming from an HDR input.
  53830. *
  53831. * The only supported format is currently panorama picture stored in RGBE format.
  53832. * Example of such files can be found on HDRLib: http://hdrlib.com/
  53833. */
  53834. export class HDRCubeTexture extends BaseTexture {
  53835. private static _facesMapping;
  53836. private _generateHarmonics;
  53837. private _noMipmap;
  53838. private _textureMatrix;
  53839. private _size;
  53840. private _onLoad;
  53841. private _onError;
  53842. /**
  53843. * The texture URL.
  53844. */
  53845. url: string;
  53846. /**
  53847. * The texture coordinates mode. As this texture is stored in a cube format, please modify carefully.
  53848. */
  53849. coordinatesMode: number;
  53850. protected _isBlocking: boolean;
  53851. /**
  53852. * Sets wether or not the texture is blocking during loading.
  53853. */
  53854. /**
  53855. * Gets wether or not the texture is blocking during loading.
  53856. */
  53857. isBlocking: boolean;
  53858. protected _rotationY: number;
  53859. /**
  53860. * Sets texture matrix rotation angle around Y axis in radians.
  53861. */
  53862. /**
  53863. * Gets texture matrix rotation angle around Y axis radians.
  53864. */
  53865. rotationY: number;
  53866. /**
  53867. * Gets or sets the center of the bounding box associated with the cube texture
  53868. * It must define where the camera used to render the texture was set
  53869. */
  53870. boundingBoxPosition: Vector3;
  53871. private _boundingBoxSize;
  53872. /**
  53873. * Gets or sets the size of the bounding box associated with the cube texture
  53874. * When defined, the cubemap will switch to local mode
  53875. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  53876. * @example https://www.babylonjs-playground.com/#RNASML
  53877. */
  53878. boundingBoxSize: Vector3;
  53879. /**
  53880. * Instantiates an HDRTexture from the following parameters.
  53881. *
  53882. * @param url The location of the HDR raw data (Panorama stored in RGBE format)
  53883. * @param scene The scene the texture will be used in
  53884. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  53885. * @param noMipmap Forces to not generate the mipmap if true
  53886. * @param generateHarmonics Specifies whether you want to extract the polynomial harmonics during the generation process
  53887. * @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)
  53888. * @param reserved Reserved flag for internal use.
  53889. */
  53890. 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>);
  53891. /**
  53892. * Get the current class name of the texture useful for serialization or dynamic coding.
  53893. * @returns "HDRCubeTexture"
  53894. */
  53895. getClassName(): string;
  53896. /**
  53897. * Occurs when the file is raw .hdr file.
  53898. */
  53899. private loadTexture;
  53900. clone(): HDRCubeTexture;
  53901. delayLoad(): void;
  53902. /**
  53903. * Get the texture reflection matrix used to rotate/transform the reflection.
  53904. * @returns the reflection matrix
  53905. */
  53906. getReflectionTextureMatrix(): Matrix;
  53907. /**
  53908. * Set the texture reflection matrix used to rotate/transform the reflection.
  53909. * @param value Define the reflection matrix to set
  53910. */
  53911. setReflectionTextureMatrix(value: Matrix): void;
  53912. /**
  53913. * Parses a JSON representation of an HDR Texture in order to create the texture
  53914. * @param parsedTexture Define the JSON representation
  53915. * @param scene Define the scene the texture should be created in
  53916. * @param rootUrl Define the root url in case we need to load relative dependencies
  53917. * @returns the newly created texture after parsing
  53918. */
  53919. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<HDRCubeTexture>;
  53920. serialize(): any;
  53921. }
  53922. }
  53923. declare module "babylonjs/Physics/physicsEngine" {
  53924. import { Nullable } from "babylonjs/types";
  53925. import { Vector3 } from "babylonjs/Maths/math.vector";
  53926. import { IPhysicsEngine, IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  53927. import { PhysicsImpostor, IPhysicsEnabledObject } from "babylonjs/Physics/physicsImpostor";
  53928. import { PhysicsJoint } from "babylonjs/Physics/physicsJoint";
  53929. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  53930. /**
  53931. * Class used to control physics engine
  53932. * @see http://doc.babylonjs.com/how_to/using_the_physics_engine
  53933. */
  53934. export class PhysicsEngine implements IPhysicsEngine {
  53935. private _physicsPlugin;
  53936. /**
  53937. * Global value used to control the smallest number supported by the simulation
  53938. */
  53939. static Epsilon: number;
  53940. private _impostors;
  53941. private _joints;
  53942. /**
  53943. * Gets the gravity vector used by the simulation
  53944. */
  53945. gravity: Vector3;
  53946. /**
  53947. * Factory used to create the default physics plugin.
  53948. * @returns The default physics plugin
  53949. */
  53950. static DefaultPluginFactory(): IPhysicsEnginePlugin;
  53951. /**
  53952. * Creates a new Physics Engine
  53953. * @param gravity defines the gravity vector used by the simulation
  53954. * @param _physicsPlugin defines the plugin to use (CannonJS by default)
  53955. */
  53956. constructor(gravity: Nullable<Vector3>, _physicsPlugin?: IPhysicsEnginePlugin);
  53957. /**
  53958. * Sets the gravity vector used by the simulation
  53959. * @param gravity defines the gravity vector to use
  53960. */
  53961. setGravity(gravity: Vector3): void;
  53962. /**
  53963. * Set the time step of the physics engine.
  53964. * Default is 1/60.
  53965. * To slow it down, enter 1/600 for example.
  53966. * To speed it up, 1/30
  53967. * @param newTimeStep defines the new timestep to apply to this world.
  53968. */
  53969. setTimeStep(newTimeStep?: number): void;
  53970. /**
  53971. * Get the time step of the physics engine.
  53972. * @returns the current time step
  53973. */
  53974. getTimeStep(): number;
  53975. /**
  53976. * Release all resources
  53977. */
  53978. dispose(): void;
  53979. /**
  53980. * Gets the name of the current physics plugin
  53981. * @returns the name of the plugin
  53982. */
  53983. getPhysicsPluginName(): string;
  53984. /**
  53985. * Adding a new impostor for the impostor tracking.
  53986. * This will be done by the impostor itself.
  53987. * @param impostor the impostor to add
  53988. */
  53989. addImpostor(impostor: PhysicsImpostor): void;
  53990. /**
  53991. * Remove an impostor from the engine.
  53992. * This impostor and its mesh will not longer be updated by the physics engine.
  53993. * @param impostor the impostor to remove
  53994. */
  53995. removeImpostor(impostor: PhysicsImpostor): void;
  53996. /**
  53997. * Add a joint to the physics engine
  53998. * @param mainImpostor defines the main impostor to which the joint is added.
  53999. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  54000. * @param joint defines the joint that will connect both impostors.
  54001. */
  54002. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  54003. /**
  54004. * Removes a joint from the simulation
  54005. * @param mainImpostor defines the impostor used with the joint
  54006. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  54007. * @param joint defines the joint to remove
  54008. */
  54009. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  54010. /**
  54011. * Called by the scene. No need to call it.
  54012. * @param delta defines the timespam between frames
  54013. */
  54014. _step(delta: number): void;
  54015. /**
  54016. * Gets the current plugin used to run the simulation
  54017. * @returns current plugin
  54018. */
  54019. getPhysicsPlugin(): IPhysicsEnginePlugin;
  54020. /**
  54021. * Gets the list of physic impostors
  54022. * @returns an array of PhysicsImpostor
  54023. */
  54024. getImpostors(): Array<PhysicsImpostor>;
  54025. /**
  54026. * Gets the impostor for a physics enabled object
  54027. * @param object defines the object impersonated by the impostor
  54028. * @returns the PhysicsImpostor or null if not found
  54029. */
  54030. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  54031. /**
  54032. * Gets the impostor for a physics body object
  54033. * @param body defines physics body used by the impostor
  54034. * @returns the PhysicsImpostor or null if not found
  54035. */
  54036. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  54037. /**
  54038. * Does a raycast in the physics world
  54039. * @param from when should the ray start?
  54040. * @param to when should the ray end?
  54041. * @returns PhysicsRaycastResult
  54042. */
  54043. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  54044. }
  54045. }
  54046. declare module "babylonjs/Physics/Plugins/cannonJSPlugin" {
  54047. import { Nullable } from "babylonjs/types";
  54048. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  54049. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  54050. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  54051. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  54052. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  54053. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  54054. /** @hidden */
  54055. export class CannonJSPlugin implements IPhysicsEnginePlugin {
  54056. private _useDeltaForWorldStep;
  54057. world: any;
  54058. name: string;
  54059. private _physicsMaterials;
  54060. private _fixedTimeStep;
  54061. private _cannonRaycastResult;
  54062. private _raycastResult;
  54063. private _physicsBodysToRemoveAfterStep;
  54064. BJSCANNON: any;
  54065. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, cannonInjection?: any);
  54066. setGravity(gravity: Vector3): void;
  54067. setTimeStep(timeStep: number): void;
  54068. getTimeStep(): number;
  54069. executeStep(delta: number): void;
  54070. private _removeMarkedPhysicsBodiesFromWorld;
  54071. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  54072. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  54073. generatePhysicsBody(impostor: PhysicsImpostor): void;
  54074. private _processChildMeshes;
  54075. removePhysicsBody(impostor: PhysicsImpostor): void;
  54076. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  54077. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  54078. private _addMaterial;
  54079. private _checkWithEpsilon;
  54080. private _createShape;
  54081. private _createHeightmap;
  54082. private _minus90X;
  54083. private _plus90X;
  54084. private _tmpPosition;
  54085. private _tmpDeltaPosition;
  54086. private _tmpUnityRotation;
  54087. private _updatePhysicsBodyTransformation;
  54088. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  54089. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  54090. isSupported(): boolean;
  54091. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  54092. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  54093. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  54094. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  54095. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  54096. getBodyMass(impostor: PhysicsImpostor): number;
  54097. getBodyFriction(impostor: PhysicsImpostor): number;
  54098. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  54099. getBodyRestitution(impostor: PhysicsImpostor): number;
  54100. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  54101. sleepBody(impostor: PhysicsImpostor): void;
  54102. wakeUpBody(impostor: PhysicsImpostor): void;
  54103. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number): void;
  54104. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  54105. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  54106. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  54107. getRadius(impostor: PhysicsImpostor): number;
  54108. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  54109. dispose(): void;
  54110. private _extendNamespace;
  54111. /**
  54112. * Does a raycast in the physics world
  54113. * @param from when should the ray start?
  54114. * @param to when should the ray end?
  54115. * @returns PhysicsRaycastResult
  54116. */
  54117. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  54118. }
  54119. }
  54120. declare module "babylonjs/Physics/Plugins/oimoJSPlugin" {
  54121. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  54122. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  54123. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  54124. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  54125. import { Vector3, Quaternion } from "babylonjs/Maths/math.vector";
  54126. import { Nullable } from "babylonjs/types";
  54127. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  54128. /** @hidden */
  54129. export class OimoJSPlugin implements IPhysicsEnginePlugin {
  54130. world: any;
  54131. name: string;
  54132. BJSOIMO: any;
  54133. private _raycastResult;
  54134. constructor(iterations?: number, oimoInjection?: any);
  54135. setGravity(gravity: Vector3): void;
  54136. setTimeStep(timeStep: number): void;
  54137. getTimeStep(): number;
  54138. private _tmpImpostorsArray;
  54139. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  54140. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  54141. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  54142. generatePhysicsBody(impostor: PhysicsImpostor): void;
  54143. private _tmpPositionVector;
  54144. removePhysicsBody(impostor: PhysicsImpostor): void;
  54145. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  54146. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  54147. isSupported(): boolean;
  54148. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  54149. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  54150. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  54151. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  54152. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  54153. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  54154. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  54155. getBodyMass(impostor: PhysicsImpostor): number;
  54156. getBodyFriction(impostor: PhysicsImpostor): number;
  54157. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  54158. getBodyRestitution(impostor: PhysicsImpostor): number;
  54159. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  54160. sleepBody(impostor: PhysicsImpostor): void;
  54161. wakeUpBody(impostor: PhysicsImpostor): void;
  54162. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  54163. setMotor(joint: IMotorEnabledJoint, speed: number, force?: number, motorIndex?: number): void;
  54164. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  54165. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  54166. getRadius(impostor: PhysicsImpostor): number;
  54167. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  54168. dispose(): void;
  54169. /**
  54170. * Does a raycast in the physics world
  54171. * @param from when should the ray start?
  54172. * @param to when should the ray end?
  54173. * @returns PhysicsRaycastResult
  54174. */
  54175. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  54176. }
  54177. }
  54178. declare module "babylonjs/Meshes/Builders/ribbonBuilder" {
  54179. import { Nullable } from "babylonjs/types";
  54180. import { Scene } from "babylonjs/scene";
  54181. import { Vector3, Vector2, Vector4 } from "babylonjs/Maths/math.vector";
  54182. import { Color4 } from "babylonjs/Maths/math.color";
  54183. import { Mesh } from "babylonjs/Meshes/mesh";
  54184. /**
  54185. * Class containing static functions to help procedurally build meshes
  54186. */
  54187. export class RibbonBuilder {
  54188. /**
  54189. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  54190. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  54191. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  54192. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  54193. * * 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
  54194. * * 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
  54195. * * 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
  54196. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  54197. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  54198. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  54199. * * 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
  54200. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  54201. * * 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
  54202. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  54203. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  54204. * @param name defines the name of the mesh
  54205. * @param options defines the options used to create the mesh
  54206. * @param scene defines the hosting scene
  54207. * @returns the ribbon mesh
  54208. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  54209. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  54210. */
  54211. static CreateRibbon(name: string, options: {
  54212. pathArray: Vector3[][];
  54213. closeArray?: boolean;
  54214. closePath?: boolean;
  54215. offset?: number;
  54216. updatable?: boolean;
  54217. sideOrientation?: number;
  54218. frontUVs?: Vector4;
  54219. backUVs?: Vector4;
  54220. instance?: Mesh;
  54221. invertUV?: boolean;
  54222. uvs?: Vector2[];
  54223. colors?: Color4[];
  54224. }, scene?: Nullable<Scene>): Mesh;
  54225. }
  54226. }
  54227. declare module "babylonjs/Meshes/Builders/shapeBuilder" {
  54228. import { Nullable } from "babylonjs/types";
  54229. import { Scene } from "babylonjs/scene";
  54230. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  54231. import { Mesh } from "babylonjs/Meshes/mesh";
  54232. /**
  54233. * Class containing static functions to help procedurally build meshes
  54234. */
  54235. export class ShapeBuilder {
  54236. /**
  54237. * 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.
  54238. * * 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.
  54239. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  54240. * * 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.
  54241. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  54242. * * 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
  54243. * * 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
  54244. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  54245. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  54246. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  54247. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  54248. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  54249. * @param name defines the name of the mesh
  54250. * @param options defines the options used to create the mesh
  54251. * @param scene defines the hosting scene
  54252. * @returns the extruded shape mesh
  54253. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  54254. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  54255. */
  54256. static ExtrudeShape(name: string, options: {
  54257. shape: Vector3[];
  54258. path: Vector3[];
  54259. scale?: number;
  54260. rotation?: number;
  54261. cap?: number;
  54262. updatable?: boolean;
  54263. sideOrientation?: number;
  54264. frontUVs?: Vector4;
  54265. backUVs?: Vector4;
  54266. instance?: Mesh;
  54267. invertUV?: boolean;
  54268. }, scene?: Nullable<Scene>): Mesh;
  54269. /**
  54270. * Creates an custom extruded shape mesh.
  54271. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  54272. * * 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.
  54273. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  54274. * * 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
  54275. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  54276. * * 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
  54277. * * It must returns a float value that will be the scale value applied to the shape on each path point
  54278. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  54279. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  54280. * * 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
  54281. * * 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
  54282. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  54283. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  54284. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  54285. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  54286. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  54287. * @param name defines the name of the mesh
  54288. * @param options defines the options used to create the mesh
  54289. * @param scene defines the hosting scene
  54290. * @returns the custom extruded shape mesh
  54291. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  54292. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  54293. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  54294. */
  54295. static ExtrudeShapeCustom(name: string, options: {
  54296. shape: Vector3[];
  54297. path: Vector3[];
  54298. scaleFunction?: any;
  54299. rotationFunction?: any;
  54300. ribbonCloseArray?: boolean;
  54301. ribbonClosePath?: boolean;
  54302. cap?: number;
  54303. updatable?: boolean;
  54304. sideOrientation?: number;
  54305. frontUVs?: Vector4;
  54306. backUVs?: Vector4;
  54307. instance?: Mesh;
  54308. invertUV?: boolean;
  54309. }, scene?: Nullable<Scene>): Mesh;
  54310. private static _ExtrudeShapeGeneric;
  54311. }
  54312. }
  54313. declare module "babylonjs/Physics/Plugins/ammoJSPlugin" {
  54314. import { Quaternion, Vector3 } from "babylonjs/Maths/math.vector";
  54315. import { IPhysicsEnginePlugin, PhysicsImpostorJoint } from "babylonjs/Physics/IPhysicsEngine";
  54316. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  54317. import { PhysicsJoint, IMotorEnabledJoint } from "babylonjs/Physics/physicsJoint";
  54318. import { Nullable } from "babylonjs/types";
  54319. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  54320. import { PhysicsRaycastResult } from "babylonjs/Physics/physicsRaycastResult";
  54321. /**
  54322. * AmmoJS Physics plugin
  54323. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  54324. * @see https://github.com/kripken/ammo.js/
  54325. */
  54326. export class AmmoJSPlugin implements IPhysicsEnginePlugin {
  54327. private _useDeltaForWorldStep;
  54328. /**
  54329. * Reference to the Ammo library
  54330. */
  54331. bjsAMMO: any;
  54332. /**
  54333. * Created ammoJS world which physics bodies are added to
  54334. */
  54335. world: any;
  54336. /**
  54337. * Name of the plugin
  54338. */
  54339. name: string;
  54340. private _timeStep;
  54341. private _fixedTimeStep;
  54342. private _maxSteps;
  54343. private _tmpQuaternion;
  54344. private _tmpAmmoTransform;
  54345. private _tmpAmmoQuaternion;
  54346. private _tmpAmmoConcreteContactResultCallback;
  54347. private _collisionConfiguration;
  54348. private _dispatcher;
  54349. private _overlappingPairCache;
  54350. private _solver;
  54351. private _softBodySolver;
  54352. private _tmpAmmoVectorA;
  54353. private _tmpAmmoVectorB;
  54354. private _tmpAmmoVectorC;
  54355. private _tmpAmmoVectorD;
  54356. private _tmpContactCallbackResult;
  54357. private _tmpAmmoVectorRCA;
  54358. private _tmpAmmoVectorRCB;
  54359. private _raycastResult;
  54360. private static readonly DISABLE_COLLISION_FLAG;
  54361. private static readonly KINEMATIC_FLAG;
  54362. private static readonly DISABLE_DEACTIVATION_FLAG;
  54363. /**
  54364. * Initializes the ammoJS plugin
  54365. * @param _useDeltaForWorldStep if the time between frames should be used when calculating physics steps (Default: true)
  54366. * @param ammoInjection can be used to inject your own ammo reference
  54367. * @param overlappingPairCache can be used to specify your own overlapping pair cache
  54368. */
  54369. constructor(_useDeltaForWorldStep?: boolean, ammoInjection?: any, overlappingPairCache?: any);
  54370. /**
  54371. * Sets the gravity of the physics world (m/(s^2))
  54372. * @param gravity Gravity to set
  54373. */
  54374. setGravity(gravity: Vector3): void;
  54375. /**
  54376. * Amount of time to step forward on each frame (only used if useDeltaForWorldStep is false in the constructor)
  54377. * @param timeStep timestep to use in seconds
  54378. */
  54379. setTimeStep(timeStep: number): void;
  54380. /**
  54381. * 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)
  54382. * @param fixedTimeStep fixedTimeStep to use in seconds
  54383. */
  54384. setFixedTimeStep(fixedTimeStep: number): void;
  54385. /**
  54386. * Sets the maximum number of steps by the physics engine per frame (Default: 5)
  54387. * @param maxSteps the maximum number of steps by the physics engine per frame
  54388. */
  54389. setMaxSteps(maxSteps: number): void;
  54390. /**
  54391. * Gets the current timestep (only used if useDeltaForWorldStep is false in the constructor)
  54392. * @returns the current timestep in seconds
  54393. */
  54394. getTimeStep(): number;
  54395. private _isImpostorInContact;
  54396. private _isImpostorPairInContact;
  54397. private _stepSimulation;
  54398. /**
  54399. * Moves the physics simulation forward delta seconds and updates the given physics imposters
  54400. * Prior to the step the imposters physics location is set to the position of the babylon meshes
  54401. * After the step the babylon meshes are set to the position of the physics imposters
  54402. * @param delta amount of time to step forward
  54403. * @param impostors array of imposters to update before/after the step
  54404. */
  54405. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  54406. /**
  54407. * Update babylon mesh to match physics world object
  54408. * @param impostor imposter to match
  54409. */
  54410. private _afterSoftStep;
  54411. /**
  54412. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  54413. * @param impostor imposter to match
  54414. */
  54415. private _ropeStep;
  54416. /**
  54417. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  54418. * @param impostor imposter to match
  54419. */
  54420. private _softbodyOrClothStep;
  54421. private _tmpVector;
  54422. private _tmpMatrix;
  54423. /**
  54424. * Applies an impulse on the imposter
  54425. * @param impostor imposter to apply impulse to
  54426. * @param force amount of force to be applied to the imposter
  54427. * @param contactPoint the location to apply the impulse on the imposter
  54428. */
  54429. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  54430. /**
  54431. * Applies a force on the imposter
  54432. * @param impostor imposter to apply force
  54433. * @param force amount of force to be applied to the imposter
  54434. * @param contactPoint the location to apply the force on the imposter
  54435. */
  54436. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  54437. /**
  54438. * Creates a physics body using the plugin
  54439. * @param impostor the imposter to create the physics body on
  54440. */
  54441. generatePhysicsBody(impostor: PhysicsImpostor): void;
  54442. /**
  54443. * Removes the physics body from the imposter and disposes of the body's memory
  54444. * @param impostor imposter to remove the physics body from
  54445. */
  54446. removePhysicsBody(impostor: PhysicsImpostor): void;
  54447. /**
  54448. * Generates a joint
  54449. * @param impostorJoint the imposter joint to create the joint with
  54450. */
  54451. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  54452. /**
  54453. * Removes a joint
  54454. * @param impostorJoint the imposter joint to remove the joint from
  54455. */
  54456. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  54457. private _addMeshVerts;
  54458. /**
  54459. * Initialise the soft body vertices to match its object's (mesh) vertices
  54460. * Softbody vertices (nodes) are in world space and to match this
  54461. * The object's position and rotation is set to zero and so its vertices are also then set in world space
  54462. * @param impostor to create the softbody for
  54463. */
  54464. private _softVertexData;
  54465. /**
  54466. * Create an impostor's soft body
  54467. * @param impostor to create the softbody for
  54468. */
  54469. private _createSoftbody;
  54470. /**
  54471. * Create cloth for an impostor
  54472. * @param impostor to create the softbody for
  54473. */
  54474. private _createCloth;
  54475. /**
  54476. * Create rope for an impostor
  54477. * @param impostor to create the softbody for
  54478. */
  54479. private _createRope;
  54480. private _addHullVerts;
  54481. private _createShape;
  54482. /**
  54483. * Sets the physics body position/rotation from the babylon mesh's position/rotation
  54484. * @param impostor imposter containing the physics body and babylon object
  54485. */
  54486. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  54487. /**
  54488. * Sets the babylon object's position/rotation from the physics body's position/rotation
  54489. * @param impostor imposter containing the physics body and babylon object
  54490. * @param newPosition new position
  54491. * @param newRotation new rotation
  54492. */
  54493. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  54494. /**
  54495. * If this plugin is supported
  54496. * @returns true if its supported
  54497. */
  54498. isSupported(): boolean;
  54499. /**
  54500. * Sets the linear velocity of the physics body
  54501. * @param impostor imposter to set the velocity on
  54502. * @param velocity velocity to set
  54503. */
  54504. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  54505. /**
  54506. * Sets the angular velocity of the physics body
  54507. * @param impostor imposter to set the velocity on
  54508. * @param velocity velocity to set
  54509. */
  54510. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  54511. /**
  54512. * gets the linear velocity
  54513. * @param impostor imposter to get linear velocity from
  54514. * @returns linear velocity
  54515. */
  54516. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  54517. /**
  54518. * gets the angular velocity
  54519. * @param impostor imposter to get angular velocity from
  54520. * @returns angular velocity
  54521. */
  54522. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  54523. /**
  54524. * Sets the mass of physics body
  54525. * @param impostor imposter to set the mass on
  54526. * @param mass mass to set
  54527. */
  54528. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  54529. /**
  54530. * Gets the mass of the physics body
  54531. * @param impostor imposter to get the mass from
  54532. * @returns mass
  54533. */
  54534. getBodyMass(impostor: PhysicsImpostor): number;
  54535. /**
  54536. * Gets friction of the impostor
  54537. * @param impostor impostor to get friction from
  54538. * @returns friction value
  54539. */
  54540. getBodyFriction(impostor: PhysicsImpostor): number;
  54541. /**
  54542. * Sets friction of the impostor
  54543. * @param impostor impostor to set friction on
  54544. * @param friction friction value
  54545. */
  54546. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  54547. /**
  54548. * Gets restitution of the impostor
  54549. * @param impostor impostor to get restitution from
  54550. * @returns restitution value
  54551. */
  54552. getBodyRestitution(impostor: PhysicsImpostor): number;
  54553. /**
  54554. * Sets resitution of the impostor
  54555. * @param impostor impostor to set resitution on
  54556. * @param restitution resitution value
  54557. */
  54558. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  54559. /**
  54560. * Gets pressure inside the impostor
  54561. * @param impostor impostor to get pressure from
  54562. * @returns pressure value
  54563. */
  54564. getBodyPressure(impostor: PhysicsImpostor): number;
  54565. /**
  54566. * Sets pressure inside a soft body impostor
  54567. * Cloth and rope must remain 0 pressure
  54568. * @param impostor impostor to set pressure on
  54569. * @param pressure pressure value
  54570. */
  54571. setBodyPressure(impostor: PhysicsImpostor, pressure: number): void;
  54572. /**
  54573. * Gets stiffness of the impostor
  54574. * @param impostor impostor to get stiffness from
  54575. * @returns pressure value
  54576. */
  54577. getBodyStiffness(impostor: PhysicsImpostor): number;
  54578. /**
  54579. * Sets stiffness of the impostor
  54580. * @param impostor impostor to set stiffness on
  54581. * @param stiffness stiffness value from 0 to 1
  54582. */
  54583. setBodyStiffness(impostor: PhysicsImpostor, stiffness: number): void;
  54584. /**
  54585. * Gets velocityIterations of the impostor
  54586. * @param impostor impostor to get velocity iterations from
  54587. * @returns velocityIterations value
  54588. */
  54589. getBodyVelocityIterations(impostor: PhysicsImpostor): number;
  54590. /**
  54591. * Sets velocityIterations of the impostor
  54592. * @param impostor impostor to set velocity iterations on
  54593. * @param velocityIterations velocityIterations value
  54594. */
  54595. setBodyVelocityIterations(impostor: PhysicsImpostor, velocityIterations: number): void;
  54596. /**
  54597. * Gets positionIterations of the impostor
  54598. * @param impostor impostor to get position iterations from
  54599. * @returns positionIterations value
  54600. */
  54601. getBodyPositionIterations(impostor: PhysicsImpostor): number;
  54602. /**
  54603. * Sets positionIterations of the impostor
  54604. * @param impostor impostor to set position on
  54605. * @param positionIterations positionIterations value
  54606. */
  54607. setBodyPositionIterations(impostor: PhysicsImpostor, positionIterations: number): void;
  54608. /**
  54609. * Append an anchor to a cloth object
  54610. * @param impostor is the cloth impostor to add anchor to
  54611. * @param otherImpostor is the rigid impostor to anchor to
  54612. * @param width ratio across width from 0 to 1
  54613. * @param height ratio up height from 0 to 1
  54614. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  54615. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  54616. */
  54617. appendAnchor(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  54618. /**
  54619. * Append an hook to a rope object
  54620. * @param impostor is the rope impostor to add hook to
  54621. * @param otherImpostor is the rigid impostor to hook to
  54622. * @param length ratio along the rope from 0 to 1
  54623. * @param influence the elasticity between soft impostor and anchor from 0, very stretchy to 1, little strech
  54624. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  54625. */
  54626. appendHook(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  54627. /**
  54628. * Sleeps the physics body and stops it from being active
  54629. * @param impostor impostor to sleep
  54630. */
  54631. sleepBody(impostor: PhysicsImpostor): void;
  54632. /**
  54633. * Activates the physics body
  54634. * @param impostor impostor to activate
  54635. */
  54636. wakeUpBody(impostor: PhysicsImpostor): void;
  54637. /**
  54638. * Updates the distance parameters of the joint
  54639. * @param joint joint to update
  54640. * @param maxDistance maximum distance of the joint
  54641. * @param minDistance minimum distance of the joint
  54642. */
  54643. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  54644. /**
  54645. * Sets a motor on the joint
  54646. * @param joint joint to set motor on
  54647. * @param speed speed of the motor
  54648. * @param maxForce maximum force of the motor
  54649. * @param motorIndex index of the motor
  54650. */
  54651. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  54652. /**
  54653. * Sets the motors limit
  54654. * @param joint joint to set limit on
  54655. * @param upperLimit upper limit
  54656. * @param lowerLimit lower limit
  54657. */
  54658. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  54659. /**
  54660. * Syncs the position and rotation of a mesh with the impostor
  54661. * @param mesh mesh to sync
  54662. * @param impostor impostor to update the mesh with
  54663. */
  54664. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  54665. /**
  54666. * Gets the radius of the impostor
  54667. * @param impostor impostor to get radius from
  54668. * @returns the radius
  54669. */
  54670. getRadius(impostor: PhysicsImpostor): number;
  54671. /**
  54672. * Gets the box size of the impostor
  54673. * @param impostor impostor to get box size from
  54674. * @param result the resulting box size
  54675. */
  54676. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  54677. /**
  54678. * Disposes of the impostor
  54679. */
  54680. dispose(): void;
  54681. /**
  54682. * Does a raycast in the physics world
  54683. * @param from when should the ray start?
  54684. * @param to when should the ray end?
  54685. * @returns PhysicsRaycastResult
  54686. */
  54687. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  54688. }
  54689. }
  54690. declare module "babylonjs/Probes/reflectionProbe" {
  54691. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  54692. import { Vector3 } from "babylonjs/Maths/math.vector";
  54693. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  54694. import { Nullable } from "babylonjs/types";
  54695. import { Scene } from "babylonjs/scene";
  54696. module "babylonjs/abstractScene" {
  54697. interface AbstractScene {
  54698. /**
  54699. * The list of reflection probes added to the scene
  54700. * @see http://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  54701. */
  54702. reflectionProbes: Array<ReflectionProbe>;
  54703. /**
  54704. * Removes the given reflection probe from this scene.
  54705. * @param toRemove The reflection probe to remove
  54706. * @returns The index of the removed reflection probe
  54707. */
  54708. removeReflectionProbe(toRemove: ReflectionProbe): number;
  54709. /**
  54710. * Adds the given reflection probe to this scene.
  54711. * @param newReflectionProbe The reflection probe to add
  54712. */
  54713. addReflectionProbe(newReflectionProbe: ReflectionProbe): void;
  54714. }
  54715. }
  54716. /**
  54717. * Class used to generate realtime reflection / refraction cube textures
  54718. * @see http://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  54719. */
  54720. export class ReflectionProbe {
  54721. /** defines the name of the probe */
  54722. name: string;
  54723. private _scene;
  54724. private _renderTargetTexture;
  54725. private _projectionMatrix;
  54726. private _viewMatrix;
  54727. private _target;
  54728. private _add;
  54729. private _attachedMesh;
  54730. private _invertYAxis;
  54731. /** Gets or sets probe position (center of the cube map) */
  54732. position: Vector3;
  54733. /**
  54734. * Creates a new reflection probe
  54735. * @param name defines the name of the probe
  54736. * @param size defines the texture resolution (for each face)
  54737. * @param scene defines the hosting scene
  54738. * @param generateMipMaps defines if mip maps should be generated automatically (true by default)
  54739. * @param useFloat defines if HDR data (flaot data) should be used to store colors (false by default)
  54740. */
  54741. constructor(
  54742. /** defines the name of the probe */
  54743. name: string, size: number, scene: Scene, generateMipMaps?: boolean, useFloat?: boolean);
  54744. /** Gets or sets the number of samples to use for multi-sampling (0 by default). Required WebGL2 */
  54745. samples: number;
  54746. /** Gets or sets the refresh rate to use (on every frame by default) */
  54747. refreshRate: number;
  54748. /**
  54749. * Gets the hosting scene
  54750. * @returns a Scene
  54751. */
  54752. getScene(): Scene;
  54753. /** Gets the internal CubeTexture used to render to */
  54754. readonly cubeTexture: RenderTargetTexture;
  54755. /** Gets the list of meshes to render */
  54756. readonly renderList: Nullable<AbstractMesh[]>;
  54757. /**
  54758. * Attach the probe to a specific mesh (Rendering will be done from attached mesh's position)
  54759. * @param mesh defines the mesh to attach to
  54760. */
  54761. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  54762. /**
  54763. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups
  54764. * @param renderingGroupId The rendering group id corresponding to its index
  54765. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  54766. */
  54767. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  54768. /**
  54769. * Clean all associated resources
  54770. */
  54771. dispose(): void;
  54772. /**
  54773. * Converts the reflection probe information to a readable string for debug purpose.
  54774. * @param fullDetails Supports for multiple levels of logging within scene loading
  54775. * @returns the human readable reflection probe info
  54776. */
  54777. toString(fullDetails?: boolean): string;
  54778. /**
  54779. * Get the class name of the relfection probe.
  54780. * @returns "ReflectionProbe"
  54781. */
  54782. getClassName(): string;
  54783. /**
  54784. * Serialize the reflection probe to a JSON representation we can easily use in the resepective Parse function.
  54785. * @returns The JSON representation of the texture
  54786. */
  54787. serialize(): any;
  54788. /**
  54789. * Parse the JSON representation of a reflection probe in order to recreate the reflection probe in the given scene.
  54790. * @param parsedReflectionProbe Define the JSON representation of the reflection probe
  54791. * @param scene Define the scene the parsed reflection probe should be instantiated in
  54792. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  54793. * @returns The parsed reflection probe if successful
  54794. */
  54795. static Parse(parsedReflectionProbe: any, scene: Scene, rootUrl: string): Nullable<ReflectionProbe>;
  54796. }
  54797. }
  54798. declare module "babylonjs/Loading/Plugins/babylonFileLoader" {
  54799. /** @hidden */
  54800. export var _BabylonLoaderRegistered: boolean;
  54801. /**
  54802. * Helps setting up some configuration for the babylon file loader.
  54803. */
  54804. export class BabylonFileLoaderConfiguration {
  54805. /**
  54806. * The loader does not allow injecting custom physix engine into the plugins.
  54807. * Unfortunately in ES6, we need to manually inject them into the plugin.
  54808. * So you could set this variable to your engine import to make it work.
  54809. */
  54810. static LoaderInjectedPhysicsEngine: any;
  54811. }
  54812. }
  54813. declare module "babylonjs/Loading/Plugins/index" {
  54814. export * from "babylonjs/Loading/Plugins/babylonFileLoader";
  54815. }
  54816. declare module "babylonjs/Loading/index" {
  54817. export * from "babylonjs/Loading/loadingScreen";
  54818. export * from "babylonjs/Loading/Plugins/index";
  54819. export * from "babylonjs/Loading/sceneLoader";
  54820. export * from "babylonjs/Loading/sceneLoaderFlags";
  54821. }
  54822. declare module "babylonjs/Materials/Background/index" {
  54823. export * from "babylonjs/Materials/Background/backgroundMaterial";
  54824. }
  54825. declare module "babylonjs/Materials/PBR/pbrBaseSimpleMaterial" {
  54826. import { Scene } from "babylonjs/scene";
  54827. import { Color3 } from "babylonjs/Maths/math.color";
  54828. import { PBRBaseMaterial } from "babylonjs/Materials/PBR/pbrBaseMaterial";
  54829. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  54830. /**
  54831. * The Physically based simple base material of BJS.
  54832. *
  54833. * This enables better naming and convention enforcements on top of the pbrMaterial.
  54834. * It is used as the base class for both the specGloss and metalRough conventions.
  54835. */
  54836. export abstract class PBRBaseSimpleMaterial extends PBRBaseMaterial {
  54837. /**
  54838. * Number of Simultaneous lights allowed on the material.
  54839. */
  54840. maxSimultaneousLights: number;
  54841. /**
  54842. * If sets to true, disables all the lights affecting the material.
  54843. */
  54844. disableLighting: boolean;
  54845. /**
  54846. * Environment Texture used in the material (this is use for both reflection and environment lighting).
  54847. */
  54848. environmentTexture: BaseTexture;
  54849. /**
  54850. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  54851. */
  54852. invertNormalMapX: boolean;
  54853. /**
  54854. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  54855. */
  54856. invertNormalMapY: boolean;
  54857. /**
  54858. * Normal map used in the model.
  54859. */
  54860. normalTexture: BaseTexture;
  54861. /**
  54862. * Emissivie color used to self-illuminate the model.
  54863. */
  54864. emissiveColor: Color3;
  54865. /**
  54866. * Emissivie texture used to self-illuminate the model.
  54867. */
  54868. emissiveTexture: BaseTexture;
  54869. /**
  54870. * Occlusion Channel Strenght.
  54871. */
  54872. occlusionStrength: number;
  54873. /**
  54874. * Occlusion Texture of the material (adding extra occlusion effects).
  54875. */
  54876. occlusionTexture: BaseTexture;
  54877. /**
  54878. * Defines the alpha limits in alpha test mode.
  54879. */
  54880. alphaCutOff: number;
  54881. /**
  54882. * Gets the current double sided mode.
  54883. */
  54884. /**
  54885. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  54886. */
  54887. doubleSided: boolean;
  54888. /**
  54889. * Stores the pre-calculated light information of a mesh in a texture.
  54890. */
  54891. lightmapTexture: BaseTexture;
  54892. /**
  54893. * If true, the light map contains occlusion information instead of lighting info.
  54894. */
  54895. useLightmapAsShadowmap: boolean;
  54896. /**
  54897. * Instantiates a new PBRMaterial instance.
  54898. *
  54899. * @param name The material name
  54900. * @param scene The scene the material will be use in.
  54901. */
  54902. constructor(name: string, scene: Scene);
  54903. getClassName(): string;
  54904. }
  54905. }
  54906. declare module "babylonjs/Materials/PBR/pbrMetallicRoughnessMaterial" {
  54907. import { Scene } from "babylonjs/scene";
  54908. import { Color3 } from "babylonjs/Maths/math.color";
  54909. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  54910. import { PBRBaseSimpleMaterial } from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  54911. /**
  54912. * The PBR material of BJS following the metal roughness convention.
  54913. *
  54914. * This fits to the PBR convention in the GLTF definition:
  54915. * https://github.com/KhronosGroup/glTF/tree/2.0/specification/2.0
  54916. */
  54917. export class PBRMetallicRoughnessMaterial extends PBRBaseSimpleMaterial {
  54918. /**
  54919. * The base color has two different interpretations depending on the value of metalness.
  54920. * When the material is a metal, the base color is the specific measured reflectance value
  54921. * at normal incidence (F0). For a non-metal the base color represents the reflected diffuse color
  54922. * of the material.
  54923. */
  54924. baseColor: Color3;
  54925. /**
  54926. * Base texture of the metallic workflow. It contains both the baseColor information in RGB as
  54927. * well as opacity information in the alpha channel.
  54928. */
  54929. baseTexture: BaseTexture;
  54930. /**
  54931. * Specifies the metallic scalar value of the material.
  54932. * Can also be used to scale the metalness values of the metallic texture.
  54933. */
  54934. metallic: number;
  54935. /**
  54936. * Specifies the roughness scalar value of the material.
  54937. * Can also be used to scale the roughness values of the metallic texture.
  54938. */
  54939. roughness: number;
  54940. /**
  54941. * Texture containing both the metallic value in the B channel and the
  54942. * roughness value in the G channel to keep better precision.
  54943. */
  54944. metallicRoughnessTexture: BaseTexture;
  54945. /**
  54946. * Instantiates a new PBRMetalRoughnessMaterial instance.
  54947. *
  54948. * @param name The material name
  54949. * @param scene The scene the material will be use in.
  54950. */
  54951. constructor(name: string, scene: Scene);
  54952. /**
  54953. * Return the currrent class name of the material.
  54954. */
  54955. getClassName(): string;
  54956. /**
  54957. * Makes a duplicate of the current material.
  54958. * @param name - name to use for the new material.
  54959. */
  54960. clone(name: string): PBRMetallicRoughnessMaterial;
  54961. /**
  54962. * Serialize the material to a parsable JSON object.
  54963. */
  54964. serialize(): any;
  54965. /**
  54966. * Parses a JSON object correponding to the serialize function.
  54967. */
  54968. static Parse(source: any, scene: Scene, rootUrl: string): PBRMetallicRoughnessMaterial;
  54969. }
  54970. }
  54971. declare module "babylonjs/Materials/PBR/pbrSpecularGlossinessMaterial" {
  54972. import { Scene } from "babylonjs/scene";
  54973. import { Color3 } from "babylonjs/Maths/math.color";
  54974. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  54975. import { PBRBaseSimpleMaterial } from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  54976. /**
  54977. * The PBR material of BJS following the specular glossiness convention.
  54978. *
  54979. * This fits to the PBR convention in the GLTF definition:
  54980. * https://github.com/KhronosGroup/glTF/tree/2.0/extensions/Khronos/KHR_materials_pbrSpecularGlossiness
  54981. */
  54982. export class PBRSpecularGlossinessMaterial extends PBRBaseSimpleMaterial {
  54983. /**
  54984. * Specifies the diffuse color of the material.
  54985. */
  54986. diffuseColor: Color3;
  54987. /**
  54988. * Specifies the diffuse texture of the material. This can also contains the opcity value in its alpha
  54989. * channel.
  54990. */
  54991. diffuseTexture: BaseTexture;
  54992. /**
  54993. * Specifies the specular color of the material. This indicates how reflective is the material (none to mirror).
  54994. */
  54995. specularColor: Color3;
  54996. /**
  54997. * Specifies the glossiness of the material. This indicates "how sharp is the reflection".
  54998. */
  54999. glossiness: number;
  55000. /**
  55001. * Specifies both the specular color RGB and the glossiness A of the material per pixels.
  55002. */
  55003. specularGlossinessTexture: BaseTexture;
  55004. /**
  55005. * Instantiates a new PBRSpecularGlossinessMaterial instance.
  55006. *
  55007. * @param name The material name
  55008. * @param scene The scene the material will be use in.
  55009. */
  55010. constructor(name: string, scene: Scene);
  55011. /**
  55012. * Return the currrent class name of the material.
  55013. */
  55014. getClassName(): string;
  55015. /**
  55016. * Makes a duplicate of the current material.
  55017. * @param name - name to use for the new material.
  55018. */
  55019. clone(name: string): PBRSpecularGlossinessMaterial;
  55020. /**
  55021. * Serialize the material to a parsable JSON object.
  55022. */
  55023. serialize(): any;
  55024. /**
  55025. * Parses a JSON object correponding to the serialize function.
  55026. */
  55027. static Parse(source: any, scene: Scene, rootUrl: string): PBRSpecularGlossinessMaterial;
  55028. }
  55029. }
  55030. declare module "babylonjs/Materials/PBR/index" {
  55031. export * from "babylonjs/Materials/PBR/pbrBaseMaterial";
  55032. export * from "babylonjs/Materials/PBR/pbrBaseSimpleMaterial";
  55033. export * from "babylonjs/Materials/PBR/pbrMaterial";
  55034. export * from "babylonjs/Materials/PBR/pbrMetallicRoughnessMaterial";
  55035. export * from "babylonjs/Materials/PBR/pbrSpecularGlossinessMaterial";
  55036. }
  55037. declare module "babylonjs/Materials/Textures/colorGradingTexture" {
  55038. import { Nullable } from "babylonjs/types";
  55039. import { Scene } from "babylonjs/scene";
  55040. import { Matrix } from "babylonjs/Maths/math.vector";
  55041. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  55042. /**
  55043. * This represents a color grading texture. This acts as a lookup table LUT, useful during post process
  55044. * It can help converting any input color in a desired output one. This can then be used to create effects
  55045. * from sepia, black and white to sixties or futuristic rendering...
  55046. *
  55047. * The only supported format is currently 3dl.
  55048. * More information on LUT: https://en.wikipedia.org/wiki/3D_lookup_table
  55049. */
  55050. export class ColorGradingTexture extends BaseTexture {
  55051. /**
  55052. * The current texture matrix. (will always be identity in color grading texture)
  55053. */
  55054. private _textureMatrix;
  55055. /**
  55056. * The texture URL.
  55057. */
  55058. url: string;
  55059. /**
  55060. * Empty line regex stored for GC.
  55061. */
  55062. private static _noneEmptyLineRegex;
  55063. private _engine;
  55064. /**
  55065. * Instantiates a ColorGradingTexture from the following parameters.
  55066. *
  55067. * @param url The location of the color gradind data (currently only supporting 3dl)
  55068. * @param scene The scene the texture will be used in
  55069. */
  55070. constructor(url: string, scene: Scene);
  55071. /**
  55072. * Returns the texture matrix used in most of the material.
  55073. * This is not used in color grading but keep for troubleshooting purpose (easily swap diffuse by colorgrading to look in).
  55074. */
  55075. getTextureMatrix(): Matrix;
  55076. /**
  55077. * Occurs when the file being loaded is a .3dl LUT file.
  55078. */
  55079. private load3dlTexture;
  55080. /**
  55081. * Starts the loading process of the texture.
  55082. */
  55083. private loadTexture;
  55084. /**
  55085. * Clones the color gradind texture.
  55086. */
  55087. clone(): ColorGradingTexture;
  55088. /**
  55089. * Called during delayed load for textures.
  55090. */
  55091. delayLoad(): void;
  55092. /**
  55093. * Parses a color grading texture serialized by Babylon.
  55094. * @param parsedTexture The texture information being parsedTexture
  55095. * @param scene The scene to load the texture in
  55096. * @param rootUrl The root url of the data assets to load
  55097. * @return A color gradind texture
  55098. */
  55099. static Parse(parsedTexture: any, scene: Scene): Nullable<ColorGradingTexture>;
  55100. /**
  55101. * Serializes the LUT texture to json format.
  55102. */
  55103. serialize(): any;
  55104. }
  55105. }
  55106. declare module "babylonjs/Materials/Textures/equiRectangularCubeTexture" {
  55107. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  55108. import { Scene } from "babylonjs/scene";
  55109. import { Nullable } from "babylonjs/types";
  55110. import "babylonjs/Engines/Extensions/engine.rawTexture";
  55111. /**
  55112. * This represents a texture coming from an equirectangular image supported by the web browser canvas.
  55113. */
  55114. export class EquiRectangularCubeTexture extends BaseTexture {
  55115. /** The six faces of the cube. */
  55116. private static _FacesMapping;
  55117. private _noMipmap;
  55118. private _onLoad;
  55119. private _onError;
  55120. /** The size of the cubemap. */
  55121. private _size;
  55122. /** The buffer of the image. */
  55123. private _buffer;
  55124. /** The width of the input image. */
  55125. private _width;
  55126. /** The height of the input image. */
  55127. private _height;
  55128. /** The URL to the image. */
  55129. url: string;
  55130. /** The texture coordinates mode. As this texture is stored in a cube format, please modify carefully. */
  55131. coordinatesMode: number;
  55132. /**
  55133. * Instantiates an EquiRectangularCubeTexture from the following parameters.
  55134. * @param url The location of the image
  55135. * @param scene The scene the texture will be used in
  55136. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  55137. * @param noMipmap Forces to not generate the mipmap if true
  55138. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  55139. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  55140. * @param onLoad — defines a callback called when texture is loaded
  55141. * @param onError — defines a callback called if there is an error
  55142. */
  55143. constructor(url: string, scene: Scene, size: number, noMipmap?: boolean, gammaSpace?: boolean, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>);
  55144. /**
  55145. * Load the image data, by putting the image on a canvas and extracting its buffer.
  55146. */
  55147. private loadImage;
  55148. /**
  55149. * Convert the image buffer into a cubemap and create a CubeTexture.
  55150. */
  55151. private loadTexture;
  55152. /**
  55153. * Convert the ArrayBuffer into a Float32Array and drop the transparency channel.
  55154. * @param buffer The ArrayBuffer that should be converted.
  55155. * @returns The buffer as Float32Array.
  55156. */
  55157. private getFloat32ArrayFromArrayBuffer;
  55158. /**
  55159. * Get the current class name of the texture useful for serialization or dynamic coding.
  55160. * @returns "EquiRectangularCubeTexture"
  55161. */
  55162. getClassName(): string;
  55163. /**
  55164. * Create a clone of the current EquiRectangularCubeTexture and return it.
  55165. * @returns A clone of the current EquiRectangularCubeTexture.
  55166. */
  55167. clone(): EquiRectangularCubeTexture;
  55168. }
  55169. }
  55170. declare module "babylonjs/Misc/tga" {
  55171. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  55172. /**
  55173. * Based on jsTGALoader - Javascript loader for TGA file
  55174. * By Vincent Thibault
  55175. * @see http://blog.robrowser.com/javascript-tga-loader.html
  55176. */
  55177. export class TGATools {
  55178. private static _TYPE_INDEXED;
  55179. private static _TYPE_RGB;
  55180. private static _TYPE_GREY;
  55181. private static _TYPE_RLE_INDEXED;
  55182. private static _TYPE_RLE_RGB;
  55183. private static _TYPE_RLE_GREY;
  55184. private static _ORIGIN_MASK;
  55185. private static _ORIGIN_SHIFT;
  55186. private static _ORIGIN_BL;
  55187. private static _ORIGIN_BR;
  55188. private static _ORIGIN_UL;
  55189. private static _ORIGIN_UR;
  55190. /**
  55191. * Gets the header of a TGA file
  55192. * @param data defines the TGA data
  55193. * @returns the header
  55194. */
  55195. static GetTGAHeader(data: Uint8Array): any;
  55196. /**
  55197. * Uploads TGA content to a Babylon Texture
  55198. * @hidden
  55199. */
  55200. static UploadContent(texture: InternalTexture, data: Uint8Array): void;
  55201. /** @hidden */
  55202. 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;
  55203. /** @hidden */
  55204. 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;
  55205. /** @hidden */
  55206. 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;
  55207. /** @hidden */
  55208. 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;
  55209. /** @hidden */
  55210. 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;
  55211. /** @hidden */
  55212. 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;
  55213. }
  55214. }
  55215. declare module "babylonjs/Materials/Textures/Loaders/tgaTextureLoader" {
  55216. import { Nullable } from "babylonjs/types";
  55217. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  55218. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  55219. /**
  55220. * Implementation of the TGA Texture Loader.
  55221. * @hidden
  55222. */
  55223. export class _TGATextureLoader implements IInternalTextureLoader {
  55224. /**
  55225. * Defines wether the loader supports cascade loading the different faces.
  55226. */
  55227. readonly supportCascades: boolean;
  55228. /**
  55229. * This returns if the loader support the current file information.
  55230. * @param extension defines the file extension of the file being loaded
  55231. * @param textureFormatInUse defines the current compressed format in use iun the engine
  55232. * @param fallback defines the fallback internal texture if any
  55233. * @param isBase64 defines whether the texture is encoded as a base64
  55234. * @param isBuffer defines whether the texture data are stored as a buffer
  55235. * @returns true if the loader can load the specified file
  55236. */
  55237. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  55238. /**
  55239. * Transform the url before loading if required.
  55240. * @param rootUrl the url of the texture
  55241. * @param textureFormatInUse defines the current compressed format in use iun the engine
  55242. * @returns the transformed texture
  55243. */
  55244. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  55245. /**
  55246. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  55247. * @param rootUrl the url of the texture
  55248. * @param textureFormatInUse defines the current compressed format in use iun the engine
  55249. * @returns the fallback texture
  55250. */
  55251. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  55252. /**
  55253. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  55254. * @param data contains the texture data
  55255. * @param texture defines the BabylonJS internal texture
  55256. * @param createPolynomials will be true if polynomials have been requested
  55257. * @param onLoad defines the callback to trigger once the texture is ready
  55258. * @param onError defines the callback to trigger in case of error
  55259. */
  55260. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  55261. /**
  55262. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  55263. * @param data contains the texture data
  55264. * @param texture defines the BabylonJS internal texture
  55265. * @param callback defines the method to call once ready to upload
  55266. */
  55267. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  55268. }
  55269. }
  55270. declare module "babylonjs/Misc/basis" {
  55271. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  55272. /**
  55273. * Info about the .basis files
  55274. */
  55275. class BasisFileInfo {
  55276. /**
  55277. * If the file has alpha
  55278. */
  55279. hasAlpha: boolean;
  55280. /**
  55281. * Info about each image of the basis file
  55282. */
  55283. images: Array<{
  55284. levels: Array<{
  55285. width: number;
  55286. height: number;
  55287. transcodedPixels: ArrayBufferView;
  55288. }>;
  55289. }>;
  55290. }
  55291. /**
  55292. * Result of transcoding a basis file
  55293. */
  55294. class TranscodeResult {
  55295. /**
  55296. * Info about the .basis file
  55297. */
  55298. fileInfo: BasisFileInfo;
  55299. /**
  55300. * Format to use when loading the file
  55301. */
  55302. format: number;
  55303. }
  55304. /**
  55305. * Configuration options for the Basis transcoder
  55306. */
  55307. export class BasisTranscodeConfiguration {
  55308. /**
  55309. * Supported compression formats used to determine the supported output format of the transcoder
  55310. */
  55311. supportedCompressionFormats?: {
  55312. /**
  55313. * etc1 compression format
  55314. */
  55315. etc1?: boolean;
  55316. /**
  55317. * s3tc compression format
  55318. */
  55319. s3tc?: boolean;
  55320. /**
  55321. * pvrtc compression format
  55322. */
  55323. pvrtc?: boolean;
  55324. /**
  55325. * etc2 compression format
  55326. */
  55327. etc2?: boolean;
  55328. };
  55329. /**
  55330. * If mipmap levels should be loaded for transcoded images (Default: true)
  55331. */
  55332. loadMipmapLevels?: boolean;
  55333. /**
  55334. * Index of a single image to load (Default: all images)
  55335. */
  55336. loadSingleImage?: number;
  55337. }
  55338. /**
  55339. * Used to load .Basis files
  55340. * See https://github.com/BinomialLLC/basis_universal/tree/master/webgl
  55341. */
  55342. export class BasisTools {
  55343. private static _IgnoreSupportedFormats;
  55344. /**
  55345. * URL to use when loading the basis transcoder
  55346. */
  55347. static JSModuleURL: string;
  55348. /**
  55349. * URL to use when loading the wasm module for the transcoder
  55350. */
  55351. static WasmModuleURL: string;
  55352. /**
  55353. * Get the internal format to be passed to texImage2D corresponding to the .basis format value
  55354. * @param basisFormat format chosen from GetSupportedTranscodeFormat
  55355. * @returns internal format corresponding to the Basis format
  55356. */
  55357. static GetInternalFormatFromBasisFormat(basisFormat: number): number;
  55358. private static _WorkerPromise;
  55359. private static _Worker;
  55360. private static _actionId;
  55361. private static _CreateWorkerAsync;
  55362. /**
  55363. * Transcodes a loaded image file to compressed pixel data
  55364. * @param imageData image data to transcode
  55365. * @param config configuration options for the transcoding
  55366. * @returns a promise resulting in the transcoded image
  55367. */
  55368. static TranscodeAsync(imageData: ArrayBuffer, config: BasisTranscodeConfiguration): Promise<TranscodeResult>;
  55369. /**
  55370. * Loads a texture from the transcode result
  55371. * @param texture texture load to
  55372. * @param transcodeResult the result of transcoding the basis file to load from
  55373. */
  55374. static LoadTextureFromTranscodeResult(texture: InternalTexture, transcodeResult: TranscodeResult): void;
  55375. }
  55376. }
  55377. declare module "babylonjs/Materials/Textures/Loaders/basisTextureLoader" {
  55378. import { Nullable } from "babylonjs/types";
  55379. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  55380. import { IInternalTextureLoader } from "babylonjs/Materials/Textures/internalTextureLoader";
  55381. /**
  55382. * Loader for .basis file format
  55383. */
  55384. export class _BasisTextureLoader implements IInternalTextureLoader {
  55385. /**
  55386. * Defines whether the loader supports cascade loading the different faces.
  55387. */
  55388. readonly supportCascades: boolean;
  55389. /**
  55390. * This returns if the loader support the current file information.
  55391. * @param extension defines the file extension of the file being loaded
  55392. * @param textureFormatInUse defines the current compressed format in use iun the engine
  55393. * @param fallback defines the fallback internal texture if any
  55394. * @param isBase64 defines whether the texture is encoded as a base64
  55395. * @param isBuffer defines whether the texture data are stored as a buffer
  55396. * @returns true if the loader can load the specified file
  55397. */
  55398. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  55399. /**
  55400. * Transform the url before loading if required.
  55401. * @param rootUrl the url of the texture
  55402. * @param textureFormatInUse defines the current compressed format in use iun the engine
  55403. * @returns the transformed texture
  55404. */
  55405. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  55406. /**
  55407. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  55408. * @param rootUrl the url of the texture
  55409. * @param textureFormatInUse defines the current compressed format in use iun the engine
  55410. * @returns the fallback texture
  55411. */
  55412. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  55413. /**
  55414. * Uploads the cube texture data to the WebGl Texture. It has already been bound.
  55415. * @param data contains the texture data
  55416. * @param texture defines the BabylonJS internal texture
  55417. * @param createPolynomials will be true if polynomials have been requested
  55418. * @param onLoad defines the callback to trigger once the texture is ready
  55419. * @param onError defines the callback to trigger in case of error
  55420. */
  55421. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  55422. /**
  55423. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  55424. * @param data contains the texture data
  55425. * @param texture defines the BabylonJS internal texture
  55426. * @param callback defines the method to call once ready to upload
  55427. */
  55428. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  55429. }
  55430. }
  55431. declare module "babylonjs/Materials/Textures/Loaders/index" {
  55432. export * from "babylonjs/Materials/Textures/Loaders/ddsTextureLoader";
  55433. export * from "babylonjs/Materials/Textures/Loaders/envTextureLoader";
  55434. export * from "babylonjs/Materials/Textures/Loaders/ktxTextureLoader";
  55435. export * from "babylonjs/Materials/Textures/Loaders/tgaTextureLoader";
  55436. export * from "babylonjs/Materials/Textures/Loaders/basisTextureLoader";
  55437. }
  55438. declare module "babylonjs/Materials/Textures/Procedurals/customProceduralTexture" {
  55439. import { Scene } from "babylonjs/scene";
  55440. import { Texture } from "babylonjs/Materials/Textures/texture";
  55441. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  55442. /**
  55443. * 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.
  55444. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  55445. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  55446. */
  55447. export class CustomProceduralTexture extends ProceduralTexture {
  55448. private _animate;
  55449. private _time;
  55450. private _config;
  55451. private _texturePath;
  55452. /**
  55453. * Instantiates a new Custom Procedural Texture.
  55454. * 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.
  55455. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  55456. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  55457. * @param name Define the name of the texture
  55458. * @param texturePath Define the folder path containing all the cutom texture related files (config, shaders...)
  55459. * @param size Define the size of the texture to create
  55460. * @param scene Define the scene the texture belongs to
  55461. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  55462. * @param generateMipMaps Define if the texture should creates mip maps or not
  55463. */
  55464. constructor(name: string, texturePath: string, size: number, scene: Scene, fallbackTexture?: Texture, generateMipMaps?: boolean);
  55465. private _loadJson;
  55466. /**
  55467. * Is the texture ready to be used ? (rendered at least once)
  55468. * @returns true if ready, otherwise, false.
  55469. */
  55470. isReady(): boolean;
  55471. /**
  55472. * Render the texture to its associated render target.
  55473. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  55474. */
  55475. render(useCameraPostProcess?: boolean): void;
  55476. /**
  55477. * Update the list of dependant textures samplers in the shader.
  55478. */
  55479. updateTextures(): void;
  55480. /**
  55481. * Update the uniform values of the procedural texture in the shader.
  55482. */
  55483. updateShaderUniforms(): void;
  55484. /**
  55485. * Define if the texture animates or not.
  55486. */
  55487. animate: boolean;
  55488. }
  55489. }
  55490. declare module "babylonjs/Shaders/noise.fragment" {
  55491. /** @hidden */
  55492. export var noisePixelShader: {
  55493. name: string;
  55494. shader: string;
  55495. };
  55496. }
  55497. declare module "babylonjs/Materials/Textures/Procedurals/noiseProceduralTexture" {
  55498. import { Nullable } from "babylonjs/types";
  55499. import { Scene } from "babylonjs/scene";
  55500. import { Texture } from "babylonjs/Materials/Textures/texture";
  55501. import { ProceduralTexture } from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  55502. import "babylonjs/Shaders/noise.fragment";
  55503. /**
  55504. * Class used to generate noise procedural textures
  55505. */
  55506. export class NoiseProceduralTexture extends ProceduralTexture {
  55507. private _time;
  55508. /** Gets or sets a value between 0 and 1 indicating the overall brightness of the texture (default is 0.2) */
  55509. brightness: number;
  55510. /** Defines the number of octaves to process */
  55511. octaves: number;
  55512. /** Defines the level of persistence (0.8 by default) */
  55513. persistence: number;
  55514. /** Gets or sets animation speed factor (default is 1) */
  55515. animationSpeedFactor: number;
  55516. /**
  55517. * Creates a new NoiseProceduralTexture
  55518. * @param name defines the name fo the texture
  55519. * @param size defines the size of the texture (default is 256)
  55520. * @param scene defines the hosting scene
  55521. * @param fallbackTexture defines the texture to use if the NoiseProceduralTexture can't be created
  55522. * @param generateMipMaps defines if mipmaps must be generated (true by default)
  55523. */
  55524. constructor(name: string, size?: number, scene?: Nullable<Scene>, fallbackTexture?: Texture, generateMipMaps?: boolean);
  55525. private _updateShaderUniforms;
  55526. protected _getDefines(): string;
  55527. /** Generate the current state of the procedural texture */
  55528. render(useCameraPostProcess?: boolean): void;
  55529. /**
  55530. * Serializes this noise procedural texture
  55531. * @returns a serialized noise procedural texture object
  55532. */
  55533. serialize(): any;
  55534. /**
  55535. * Creates a NoiseProceduralTexture from parsed noise procedural texture data
  55536. * @param parsedTexture defines parsed texture data
  55537. * @param scene defines the current scene
  55538. * @param rootUrl defines the root URL containing noise procedural texture information
  55539. * @returns a parsed NoiseProceduralTexture
  55540. */
  55541. static Parse(parsedTexture: any, scene: Scene): NoiseProceduralTexture;
  55542. }
  55543. }
  55544. declare module "babylonjs/Materials/Textures/Procedurals/index" {
  55545. export * from "babylonjs/Materials/Textures/Procedurals/customProceduralTexture";
  55546. export * from "babylonjs/Materials/Textures/Procedurals/noiseProceduralTexture";
  55547. export * from "babylonjs/Materials/Textures/Procedurals/proceduralTexture";
  55548. export * from "babylonjs/Materials/Textures/Procedurals/proceduralTextureSceneComponent";
  55549. }
  55550. declare module "babylonjs/Materials/Textures/rawCubeTexture" {
  55551. import { Nullable } from "babylonjs/types";
  55552. import { Scene } from "babylonjs/scene";
  55553. import { SphericalPolynomial } from "babylonjs/Maths/sphericalPolynomial";
  55554. import { InternalTexture } from "babylonjs/Materials/Textures/internalTexture";
  55555. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  55556. import "babylonjs/Engines/Extensions/engine.rawTexture";
  55557. /**
  55558. * Raw cube texture where the raw buffers are passed in
  55559. */
  55560. export class RawCubeTexture extends CubeTexture {
  55561. /**
  55562. * Creates a cube texture where the raw buffers are passed in.
  55563. * @param scene defines the scene the texture is attached to
  55564. * @param data defines the array of data to use to create each face
  55565. * @param size defines the size of the textures
  55566. * @param format defines the format of the data
  55567. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  55568. * @param generateMipMaps defines if the engine should generate the mip levels
  55569. * @param invertY defines if data must be stored with Y axis inverted
  55570. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  55571. * @param compression defines the compression used (null by default)
  55572. */
  55573. constructor(scene: Scene, data: Nullable<ArrayBufferView[]>, size: number, format?: number, type?: number, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, compression?: Nullable<string>);
  55574. /**
  55575. * Updates the raw cube texture.
  55576. * @param data defines the data to store
  55577. * @param format defines the data format
  55578. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  55579. * @param invertY defines if data must be stored with Y axis inverted
  55580. * @param compression defines the compression used (null by default)
  55581. * @param level defines which level of the texture to update
  55582. */
  55583. update(data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression?: Nullable<string>): void;
  55584. /**
  55585. * Updates a raw cube texture with RGBD encoded data.
  55586. * @param data defines the array of data [mipmap][face] to use to create each face
  55587. * @param sphericalPolynomial defines the spherical polynomial for irradiance
  55588. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  55589. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  55590. * @returns a promsie that resolves when the operation is complete
  55591. */
  55592. updateRGBDAsync(data: ArrayBufferView[][], sphericalPolynomial?: Nullable<SphericalPolynomial>, lodScale?: number, lodOffset?: number): Promise<void>;
  55593. /**
  55594. * Clones the raw cube texture.
  55595. * @return a new cube texture
  55596. */
  55597. clone(): CubeTexture;
  55598. /** @hidden */
  55599. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  55600. }
  55601. }
  55602. declare module "babylonjs/Materials/Textures/rawTexture3D" {
  55603. import { Scene } from "babylonjs/scene";
  55604. import { Texture } from "babylonjs/Materials/Textures/texture";
  55605. import "babylonjs/Engines/Extensions/engine.rawTexture";
  55606. /**
  55607. * Class used to store 3D textures containing user data
  55608. */
  55609. export class RawTexture3D extends Texture {
  55610. /** Gets or sets the texture format to use */
  55611. format: number;
  55612. private _engine;
  55613. /**
  55614. * Create a new RawTexture3D
  55615. * @param data defines the data of the texture
  55616. * @param width defines the width of the texture
  55617. * @param height defines the height of the texture
  55618. * @param depth defines the depth of the texture
  55619. * @param format defines the texture format to use
  55620. * @param scene defines the hosting scene
  55621. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  55622. * @param invertY defines if texture must be stored with Y axis inverted
  55623. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  55624. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  55625. */
  55626. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  55627. /** Gets or sets the texture format to use */
  55628. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  55629. /**
  55630. * Update the texture with new data
  55631. * @param data defines the data to store in the texture
  55632. */
  55633. update(data: ArrayBufferView): void;
  55634. }
  55635. }
  55636. declare module "babylonjs/Materials/Textures/rawTexture2DArray" {
  55637. import { Scene } from "babylonjs/scene";
  55638. import { Texture } from "babylonjs/Materials/Textures/texture";
  55639. import "babylonjs/Engines/Extensions/engine.rawTexture";
  55640. /**
  55641. * Class used to store 2D array textures containing user data
  55642. */
  55643. export class RawTexture2DArray extends Texture {
  55644. /** Gets or sets the texture format to use */
  55645. format: number;
  55646. private _engine;
  55647. /**
  55648. * Create a new RawTexture2DArray
  55649. * @param data defines the data of the texture
  55650. * @param width defines the width of the texture
  55651. * @param height defines the height of the texture
  55652. * @param depth defines the number of layers of the texture
  55653. * @param format defines the texture format to use
  55654. * @param scene defines the hosting scene
  55655. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  55656. * @param invertY defines if texture must be stored with Y axis inverted
  55657. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  55658. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  55659. */
  55660. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  55661. /** Gets or sets the texture format to use */
  55662. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  55663. /**
  55664. * Update the texture with new data
  55665. * @param data defines the data to store in the texture
  55666. */
  55667. update(data: ArrayBufferView): void;
  55668. }
  55669. }
  55670. declare module "babylonjs/Materials/Textures/refractionTexture" {
  55671. import { Scene } from "babylonjs/scene";
  55672. import { Plane } from "babylonjs/Maths/math.plane";
  55673. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  55674. /**
  55675. * Creates a refraction texture used by refraction channel of the standard material.
  55676. * It is like a mirror but to see through a material.
  55677. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  55678. */
  55679. export class RefractionTexture extends RenderTargetTexture {
  55680. /**
  55681. * Define the reflection plane we want to use. The refractionPlane is usually set to the constructed refractor.
  55682. * 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.
  55683. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  55684. */
  55685. refractionPlane: Plane;
  55686. /**
  55687. * Define how deep under the surface we should see.
  55688. */
  55689. depth: number;
  55690. /**
  55691. * Creates a refraction texture used by refraction channel of the standard material.
  55692. * It is like a mirror but to see through a material.
  55693. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  55694. * @param name Define the texture name
  55695. * @param size Define the size of the underlying texture
  55696. * @param scene Define the scene the refraction belongs to
  55697. * @param generateMipMaps Define if we need to generate mips level for the refraction
  55698. */
  55699. constructor(name: string, size: number, scene: Scene, generateMipMaps?: boolean);
  55700. /**
  55701. * Clone the refraction texture.
  55702. * @returns the cloned texture
  55703. */
  55704. clone(): RefractionTexture;
  55705. /**
  55706. * Serialize the texture to a JSON representation you could use in Parse later on
  55707. * @returns the serialized JSON representation
  55708. */
  55709. serialize(): any;
  55710. }
  55711. }
  55712. declare module "babylonjs/Materials/Textures/htmlElementTexture" {
  55713. import { Nullable } from "babylonjs/types";
  55714. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  55715. import { Matrix } from "babylonjs/Maths/math.vector";
  55716. import "babylonjs/Engines/Extensions/engine.dynamicTexture";
  55717. import "babylonjs/Engines/Extensions/engine.videoTexture";
  55718. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  55719. import { Scene } from "babylonjs/scene";
  55720. /**
  55721. * Defines the options related to the creation of an HtmlElementTexture
  55722. */
  55723. export interface IHtmlElementTextureOptions {
  55724. /**
  55725. * Defines wether mip maps should be created or not.
  55726. */
  55727. generateMipMaps?: boolean;
  55728. /**
  55729. * Defines the sampling mode of the texture.
  55730. */
  55731. samplingMode?: number;
  55732. /**
  55733. * Defines the engine instance to use the texture with. It is not mandatory if you define a scene.
  55734. */
  55735. engine: Nullable<ThinEngine>;
  55736. /**
  55737. * Defines the scene the texture belongs to. It is not mandatory if you define an engine.
  55738. */
  55739. scene: Nullable<Scene>;
  55740. }
  55741. /**
  55742. * This represents the smallest workload to use an already existing element (Canvas or Video) as a texture.
  55743. * To be as efficient as possible depending on your constraints nothing aside the first upload
  55744. * is automatically managed.
  55745. * It is a cheap VideoTexture or DynamicTexture if you prefer to keep full control of the elements
  55746. * in your application.
  55747. *
  55748. * As the update is not automatic, you need to call them manually.
  55749. */
  55750. export class HtmlElementTexture extends BaseTexture {
  55751. /**
  55752. * The texture URL.
  55753. */
  55754. element: HTMLVideoElement | HTMLCanvasElement;
  55755. private static readonly DefaultOptions;
  55756. private _textureMatrix;
  55757. private _engine;
  55758. private _isVideo;
  55759. private _generateMipMaps;
  55760. private _samplingMode;
  55761. /**
  55762. * Instantiates a HtmlElementTexture from the following parameters.
  55763. *
  55764. * @param name Defines the name of the texture
  55765. * @param element Defines the video or canvas the texture is filled with
  55766. * @param options Defines the other none mandatory texture creation options
  55767. */
  55768. constructor(name: string, element: HTMLVideoElement | HTMLCanvasElement, options: IHtmlElementTextureOptions);
  55769. private _createInternalTexture;
  55770. /**
  55771. * Returns the texture matrix used in most of the material.
  55772. */
  55773. getTextureMatrix(): Matrix;
  55774. /**
  55775. * Updates the content of the texture.
  55776. * @param invertY Defines wether the texture should be inverted on Y (false by default on video and true on canvas)
  55777. */
  55778. update(invertY?: Nullable<boolean>): void;
  55779. }
  55780. }
  55781. declare module "babylonjs/Materials/Textures/index" {
  55782. export * from "babylonjs/Materials/Textures/baseTexture";
  55783. export * from "babylonjs/Materials/Textures/baseTexture.polynomial";
  55784. export * from "babylonjs/Materials/Textures/colorGradingTexture";
  55785. export * from "babylonjs/Materials/Textures/cubeTexture";
  55786. export * from "babylonjs/Materials/Textures/dynamicTexture";
  55787. export * from "babylonjs/Materials/Textures/equiRectangularCubeTexture";
  55788. export * from "babylonjs/Materials/Textures/hdrCubeTexture";
  55789. export * from "babylonjs/Materials/Textures/internalTexture";
  55790. export * from "babylonjs/Materials/Textures/internalTextureLoader";
  55791. export * from "babylonjs/Materials/Textures/Loaders/index";
  55792. export * from "babylonjs/Materials/Textures/mirrorTexture";
  55793. export * from "babylonjs/Materials/Textures/multiRenderTarget";
  55794. export * from "babylonjs/Materials/Textures/Procedurals/index";
  55795. export * from "babylonjs/Materials/Textures/rawCubeTexture";
  55796. export * from "babylonjs/Materials/Textures/rawTexture";
  55797. export * from "babylonjs/Materials/Textures/rawTexture3D";
  55798. export * from "babylonjs/Materials/Textures/rawTexture2DArray";
  55799. export * from "babylonjs/Materials/Textures/refractionTexture";
  55800. export * from "babylonjs/Materials/Textures/renderTargetTexture";
  55801. export * from "babylonjs/Materials/Textures/texture";
  55802. export * from "babylonjs/Materials/Textures/videoTexture";
  55803. export * from "babylonjs/Materials/Textures/htmlElementTexture";
  55804. }
  55805. declare module "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets" {
  55806. /**
  55807. * Enum used to define the target of a block
  55808. */
  55809. export enum NodeMaterialBlockTargets {
  55810. /** Vertex shader */
  55811. Vertex = 1,
  55812. /** Fragment shader */
  55813. Fragment = 2,
  55814. /** Neutral */
  55815. Neutral = 4,
  55816. /** Vertex and Fragment */
  55817. VertexAndFragment = 3
  55818. }
  55819. }
  55820. declare module "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes" {
  55821. /**
  55822. * Defines the kind of connection point for node based material
  55823. */
  55824. export enum NodeMaterialBlockConnectionPointTypes {
  55825. /** Float */
  55826. Float = 1,
  55827. /** Int */
  55828. Int = 2,
  55829. /** Vector2 */
  55830. Vector2 = 4,
  55831. /** Vector3 */
  55832. Vector3 = 8,
  55833. /** Vector4 */
  55834. Vector4 = 16,
  55835. /** Color3 */
  55836. Color3 = 32,
  55837. /** Color4 */
  55838. Color4 = 64,
  55839. /** Matrix */
  55840. Matrix = 128,
  55841. /** Detect type based on connection */
  55842. AutoDetect = 1024,
  55843. /** Output type that will be defined by input type */
  55844. BasedOnInput = 2048
  55845. }
  55846. }
  55847. declare module "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointMode" {
  55848. /**
  55849. * Enum defining the mode of a NodeMaterialBlockConnectionPoint
  55850. */
  55851. export enum NodeMaterialBlockConnectionPointMode {
  55852. /** Value is an uniform */
  55853. Uniform = 0,
  55854. /** Value is a mesh attribute */
  55855. Attribute = 1,
  55856. /** Value is a varying between vertex and fragment shaders */
  55857. Varying = 2,
  55858. /** Mode is undefined */
  55859. Undefined = 3
  55860. }
  55861. }
  55862. declare module "babylonjs/Materials/Node/Enums/nodeMaterialSystemValues" {
  55863. /**
  55864. * Enum used to define system values e.g. values automatically provided by the system
  55865. */
  55866. export enum NodeMaterialSystemValues {
  55867. /** World */
  55868. World = 1,
  55869. /** View */
  55870. View = 2,
  55871. /** Projection */
  55872. Projection = 3,
  55873. /** ViewProjection */
  55874. ViewProjection = 4,
  55875. /** WorldView */
  55876. WorldView = 5,
  55877. /** WorldViewProjection */
  55878. WorldViewProjection = 6,
  55879. /** CameraPosition */
  55880. CameraPosition = 7,
  55881. /** Fog Color */
  55882. FogColor = 8,
  55883. /** Delta time */
  55884. DeltaTime = 9
  55885. }
  55886. }
  55887. declare module "babylonjs/Materials/Node/Enums/index" {
  55888. export * from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  55889. export * from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  55890. export * from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointMode";
  55891. export * from "babylonjs/Materials/Node/Enums/nodeMaterialSystemValues";
  55892. }
  55893. declare module "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer" {
  55894. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  55895. /**
  55896. * Root class for all node material optimizers
  55897. */
  55898. export class NodeMaterialOptimizer {
  55899. /**
  55900. * Function used to optimize a NodeMaterial graph
  55901. * @param vertexOutputNodes defines the list of output nodes for the vertex shader
  55902. * @param fragmentOutputNodes defines the list of output nodes for the fragment shader
  55903. */
  55904. optimize(vertexOutputNodes: NodeMaterialBlock[], fragmentOutputNodes: NodeMaterialBlock[]): void;
  55905. }
  55906. }
  55907. declare module "babylonjs/Materials/Node/Blocks/transformBlock" {
  55908. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  55909. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  55910. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  55911. import { Scene } from "babylonjs/scene";
  55912. /**
  55913. * Block used to transform a vector (2, 3 or 4) with a matrix. It will generate a Vector4
  55914. */
  55915. export class TransformBlock extends NodeMaterialBlock {
  55916. /**
  55917. * Defines the value to use to complement W value to transform it to a Vector4
  55918. */
  55919. complementW: number;
  55920. /**
  55921. * Defines the value to use to complement z value to transform it to a Vector4
  55922. */
  55923. complementZ: number;
  55924. /**
  55925. * Creates a new TransformBlock
  55926. * @param name defines the block name
  55927. */
  55928. constructor(name: string);
  55929. /**
  55930. * Gets the current class name
  55931. * @returns the class name
  55932. */
  55933. getClassName(): string;
  55934. /**
  55935. * Gets the vector input
  55936. */
  55937. readonly vector: NodeMaterialConnectionPoint;
  55938. /**
  55939. * Gets the output component
  55940. */
  55941. readonly output: NodeMaterialConnectionPoint;
  55942. /**
  55943. * Gets the matrix transform input
  55944. */
  55945. readonly transform: NodeMaterialConnectionPoint;
  55946. protected _buildBlock(state: NodeMaterialBuildState): this;
  55947. serialize(): any;
  55948. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  55949. protected _dumpPropertiesCode(): string;
  55950. }
  55951. }
  55952. declare module "babylonjs/Materials/Node/Blocks/Vertex/vertexOutputBlock" {
  55953. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  55954. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  55955. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  55956. /**
  55957. * Block used to output the vertex position
  55958. */
  55959. export class VertexOutputBlock extends NodeMaterialBlock {
  55960. /**
  55961. * Creates a new VertexOutputBlock
  55962. * @param name defines the block name
  55963. */
  55964. constructor(name: string);
  55965. /**
  55966. * Gets the current class name
  55967. * @returns the class name
  55968. */
  55969. getClassName(): string;
  55970. /**
  55971. * Gets the vector input component
  55972. */
  55973. readonly vector: NodeMaterialConnectionPoint;
  55974. protected _buildBlock(state: NodeMaterialBuildState): this;
  55975. }
  55976. }
  55977. declare module "babylonjs/Materials/Node/Blocks/Fragment/fragmentOutputBlock" {
  55978. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  55979. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  55980. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  55981. /**
  55982. * Block used to output the final color
  55983. */
  55984. export class FragmentOutputBlock extends NodeMaterialBlock {
  55985. /**
  55986. * Create a new FragmentOutputBlock
  55987. * @param name defines the block name
  55988. */
  55989. constructor(name: string);
  55990. /**
  55991. * Gets the current class name
  55992. * @returns the class name
  55993. */
  55994. getClassName(): string;
  55995. /**
  55996. * Gets the rgba input component
  55997. */
  55998. readonly rgba: NodeMaterialConnectionPoint;
  55999. /**
  56000. * Gets the rgb input component
  56001. */
  56002. readonly rgb: NodeMaterialConnectionPoint;
  56003. /**
  56004. * Gets the a input component
  56005. */
  56006. readonly a: NodeMaterialConnectionPoint;
  56007. protected _buildBlock(state: NodeMaterialBuildState): this;
  56008. }
  56009. }
  56010. declare module "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBlock" {
  56011. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  56012. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  56013. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  56014. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  56015. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56016. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  56017. import { Effect } from "babylonjs/Materials/effect";
  56018. import { Mesh } from "babylonjs/Meshes/mesh";
  56019. import { Nullable } from "babylonjs/types";
  56020. import { Scene } from "babylonjs/scene";
  56021. import "babylonjs/Shaders/ShadersInclude/reflectionFunction";
  56022. /**
  56023. * Block used to read a reflection texture from a sampler
  56024. */
  56025. export class ReflectionTextureBlock extends NodeMaterialBlock {
  56026. private _define3DName;
  56027. private _defineCubicName;
  56028. private _defineExplicitName;
  56029. private _defineProjectionName;
  56030. private _defineLocalCubicName;
  56031. private _defineSphericalName;
  56032. private _definePlanarName;
  56033. private _defineEquirectangularName;
  56034. private _defineMirroredEquirectangularFixedName;
  56035. private _defineEquirectangularFixedName;
  56036. private _defineSkyboxName;
  56037. private _cubeSamplerName;
  56038. private _2DSamplerName;
  56039. private _positionUVWName;
  56040. private _directionWName;
  56041. private _reflectionCoordsName;
  56042. private _reflection2DCoordsName;
  56043. private _reflectionColorName;
  56044. private _reflectionMatrixName;
  56045. /**
  56046. * Gets or sets the texture associated with the node
  56047. */
  56048. texture: Nullable<BaseTexture>;
  56049. /**
  56050. * Create a new TextureBlock
  56051. * @param name defines the block name
  56052. */
  56053. constructor(name: string);
  56054. /**
  56055. * Gets the current class name
  56056. * @returns the class name
  56057. */
  56058. getClassName(): string;
  56059. /**
  56060. * Gets the world position input component
  56061. */
  56062. readonly position: NodeMaterialConnectionPoint;
  56063. /**
  56064. * Gets the world position input component
  56065. */
  56066. readonly worldPosition: NodeMaterialConnectionPoint;
  56067. /**
  56068. * Gets the world normal input component
  56069. */
  56070. readonly worldNormal: NodeMaterialConnectionPoint;
  56071. /**
  56072. * Gets the world input component
  56073. */
  56074. readonly world: NodeMaterialConnectionPoint;
  56075. /**
  56076. * Gets the camera (or eye) position component
  56077. */
  56078. readonly cameraPosition: NodeMaterialConnectionPoint;
  56079. /**
  56080. * Gets the view input component
  56081. */
  56082. readonly view: NodeMaterialConnectionPoint;
  56083. /**
  56084. * Gets the rgb output component
  56085. */
  56086. readonly rgb: NodeMaterialConnectionPoint;
  56087. /**
  56088. * Gets the r output component
  56089. */
  56090. readonly r: NodeMaterialConnectionPoint;
  56091. /**
  56092. * Gets the g output component
  56093. */
  56094. readonly g: NodeMaterialConnectionPoint;
  56095. /**
  56096. * Gets the b output component
  56097. */
  56098. readonly b: NodeMaterialConnectionPoint;
  56099. autoConfigure(material: NodeMaterial): void;
  56100. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  56101. isReady(): boolean;
  56102. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  56103. private _injectVertexCode;
  56104. private _writeOutput;
  56105. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  56106. protected _dumpPropertiesCode(): string;
  56107. serialize(): any;
  56108. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  56109. }
  56110. }
  56111. declare module "babylonjs/Materials/Node/nodeMaterial" {
  56112. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  56113. import { PushMaterial } from "babylonjs/Materials/pushMaterial";
  56114. import { Scene } from "babylonjs/scene";
  56115. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56116. import { Matrix } from "babylonjs/Maths/math.vector";
  56117. import { Mesh } from "babylonjs/Meshes/mesh";
  56118. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  56119. import { Observable } from "babylonjs/Misc/observable";
  56120. import { SubMesh } from "babylonjs/Meshes/subMesh";
  56121. import { MaterialDefines } from "babylonjs/Materials/materialDefines";
  56122. import { NodeMaterialOptimizer } from "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer";
  56123. import { ImageProcessingConfiguration, IImageProcessingConfigurationDefines } from "babylonjs/Materials/imageProcessingConfiguration";
  56124. import { Nullable } from "babylonjs/types";
  56125. import { InputBlock } from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  56126. import { TextureBlock } from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  56127. import { ReflectionTextureBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBlock";
  56128. /**
  56129. * Interface used to configure the node material editor
  56130. */
  56131. export interface INodeMaterialEditorOptions {
  56132. /** Define the URl to load node editor script */
  56133. editorURL?: string;
  56134. }
  56135. /** @hidden */
  56136. export class NodeMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  56137. /** BONES */
  56138. NUM_BONE_INFLUENCERS: number;
  56139. BonesPerMesh: number;
  56140. BONETEXTURE: boolean;
  56141. /** MORPH TARGETS */
  56142. MORPHTARGETS: boolean;
  56143. MORPHTARGETS_NORMAL: boolean;
  56144. MORPHTARGETS_TANGENT: boolean;
  56145. MORPHTARGETS_UV: boolean;
  56146. NUM_MORPH_INFLUENCERS: number;
  56147. /** IMAGE PROCESSING */
  56148. IMAGEPROCESSING: boolean;
  56149. VIGNETTE: boolean;
  56150. VIGNETTEBLENDMODEMULTIPLY: boolean;
  56151. VIGNETTEBLENDMODEOPAQUE: boolean;
  56152. TONEMAPPING: boolean;
  56153. TONEMAPPING_ACES: boolean;
  56154. CONTRAST: boolean;
  56155. EXPOSURE: boolean;
  56156. COLORCURVES: boolean;
  56157. COLORGRADING: boolean;
  56158. COLORGRADING3D: boolean;
  56159. SAMPLER3DGREENDEPTH: boolean;
  56160. SAMPLER3DBGRMAP: boolean;
  56161. IMAGEPROCESSINGPOSTPROCESS: boolean;
  56162. /** MISC. */
  56163. BUMPDIRECTUV: number;
  56164. constructor();
  56165. setValue(name: string, value: boolean): void;
  56166. }
  56167. /**
  56168. * Class used to configure NodeMaterial
  56169. */
  56170. export interface INodeMaterialOptions {
  56171. /**
  56172. * Defines if blocks should emit comments
  56173. */
  56174. emitComments: boolean;
  56175. }
  56176. /**
  56177. * Class used to create a node based material built by assembling shader blocks
  56178. */
  56179. export class NodeMaterial extends PushMaterial {
  56180. private static _BuildIdGenerator;
  56181. private _options;
  56182. private _vertexCompilationState;
  56183. private _fragmentCompilationState;
  56184. private _sharedData;
  56185. private _buildId;
  56186. private _buildWasSuccessful;
  56187. private _cachedWorldViewMatrix;
  56188. private _cachedWorldViewProjectionMatrix;
  56189. private _optimizers;
  56190. private _animationFrame;
  56191. /** Define the URl to load node editor script */
  56192. static EditorURL: string;
  56193. private BJSNODEMATERIALEDITOR;
  56194. /** Get the inspector from bundle or global */
  56195. private _getGlobalNodeMaterialEditor;
  56196. /**
  56197. * Gets or sets data used by visual editor
  56198. * @see https://nme.babylonjs.com
  56199. */
  56200. editorData: any;
  56201. /**
  56202. * 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)
  56203. */
  56204. ignoreAlpha: boolean;
  56205. /**
  56206. * Defines the maximum number of lights that can be used in the material
  56207. */
  56208. maxSimultaneousLights: number;
  56209. /**
  56210. * Observable raised when the material is built
  56211. */
  56212. onBuildObservable: Observable<NodeMaterial>;
  56213. /**
  56214. * Gets or sets the root nodes of the material vertex shader
  56215. */
  56216. _vertexOutputNodes: NodeMaterialBlock[];
  56217. /**
  56218. * Gets or sets the root nodes of the material fragment (pixel) shader
  56219. */
  56220. _fragmentOutputNodes: NodeMaterialBlock[];
  56221. /** Gets or sets options to control the node material overall behavior */
  56222. options: INodeMaterialOptions;
  56223. /**
  56224. * Default configuration related to image processing available in the standard Material.
  56225. */
  56226. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  56227. /**
  56228. * Gets the image processing configuration used either in this material.
  56229. */
  56230. /**
  56231. * Sets the Default image processing configuration used either in the this material.
  56232. *
  56233. * If sets to null, the scene one is in use.
  56234. */
  56235. imageProcessingConfiguration: ImageProcessingConfiguration;
  56236. /**
  56237. * Gets an array of blocks that needs to be serialized even if they are not yet connected
  56238. */
  56239. attachedBlocks: NodeMaterialBlock[];
  56240. /**
  56241. * Create a new node based material
  56242. * @param name defines the material name
  56243. * @param scene defines the hosting scene
  56244. * @param options defines creation option
  56245. */
  56246. constructor(name: string, scene?: Scene, options?: Partial<INodeMaterialOptions>);
  56247. /**
  56248. * Gets the current class name of the material e.g. "NodeMaterial"
  56249. * @returns the class name
  56250. */
  56251. getClassName(): string;
  56252. /**
  56253. * Keep track of the image processing observer to allow dispose and replace.
  56254. */
  56255. private _imageProcessingObserver;
  56256. /**
  56257. * Attaches a new image processing configuration to the Standard Material.
  56258. * @param configuration
  56259. */
  56260. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  56261. /**
  56262. * Get a block by its name
  56263. * @param name defines the name of the block to retrieve
  56264. * @returns the required block or null if not found
  56265. */
  56266. getBlockByName(name: string): Nullable<NodeMaterialBlock>;
  56267. /**
  56268. * Get a block by its name
  56269. * @param predicate defines the predicate used to find the good candidate
  56270. * @returns the required block or null if not found
  56271. */
  56272. getBlockByPredicate(predicate: (block: NodeMaterialBlock) => boolean): Nullable<NodeMaterialBlock>;
  56273. /**
  56274. * Get an input block by its name
  56275. * @param predicate defines the predicate used to find the good candidate
  56276. * @returns the required input block or null if not found
  56277. */
  56278. getInputBlockByPredicate(predicate: (block: InputBlock) => boolean): Nullable<InputBlock>;
  56279. /**
  56280. * Gets the list of input blocks attached to this material
  56281. * @returns an array of InputBlocks
  56282. */
  56283. getInputBlocks(): InputBlock[];
  56284. /**
  56285. * Adds a new optimizer to the list of optimizers
  56286. * @param optimizer defines the optimizers to add
  56287. * @returns the current material
  56288. */
  56289. registerOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  56290. /**
  56291. * Remove an optimizer from the list of optimizers
  56292. * @param optimizer defines the optimizers to remove
  56293. * @returns the current material
  56294. */
  56295. unregisterOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  56296. /**
  56297. * Add a new block to the list of output nodes
  56298. * @param node defines the node to add
  56299. * @returns the current material
  56300. */
  56301. addOutputNode(node: NodeMaterialBlock): this;
  56302. /**
  56303. * Remove a block from the list of root nodes
  56304. * @param node defines the node to remove
  56305. * @returns the current material
  56306. */
  56307. removeOutputNode(node: NodeMaterialBlock): this;
  56308. private _addVertexOutputNode;
  56309. private _removeVertexOutputNode;
  56310. private _addFragmentOutputNode;
  56311. private _removeFragmentOutputNode;
  56312. /**
  56313. * Specifies if the material will require alpha blending
  56314. * @returns a boolean specifying if alpha blending is needed
  56315. */
  56316. needAlphaBlending(): boolean;
  56317. /**
  56318. * Specifies if this material should be rendered in alpha test mode
  56319. * @returns a boolean specifying if an alpha test is needed.
  56320. */
  56321. needAlphaTesting(): boolean;
  56322. private _initializeBlock;
  56323. private _resetDualBlocks;
  56324. /**
  56325. * Build the material and generates the inner effect
  56326. * @param verbose defines if the build should log activity
  56327. */
  56328. build(verbose?: boolean): void;
  56329. /**
  56330. * Runs an otpimization phase to try to improve the shader code
  56331. */
  56332. optimize(): void;
  56333. private _prepareDefinesForAttributes;
  56334. /**
  56335. * Get if the submesh is ready to be used and all its information available.
  56336. * Child classes can use it to update shaders
  56337. * @param mesh defines the mesh to check
  56338. * @param subMesh defines which submesh to check
  56339. * @param useInstances specifies that instances should be used
  56340. * @returns a boolean indicating that the submesh is ready or not
  56341. */
  56342. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  56343. /**
  56344. * Get a string representing the shaders built by the current node graph
  56345. */
  56346. readonly compiledShaders: string;
  56347. /**
  56348. * Binds the world matrix to the material
  56349. * @param world defines the world transformation matrix
  56350. */
  56351. bindOnlyWorldMatrix(world: Matrix): void;
  56352. /**
  56353. * Binds the submesh to this material by preparing the effect and shader to draw
  56354. * @param world defines the world transformation matrix
  56355. * @param mesh defines the mesh containing the submesh
  56356. * @param subMesh defines the submesh to bind the material to
  56357. */
  56358. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  56359. /**
  56360. * Gets the active textures from the material
  56361. * @returns an array of textures
  56362. */
  56363. getActiveTextures(): BaseTexture[];
  56364. /**
  56365. * Gets the list of texture blocks
  56366. * @returns an array of texture blocks
  56367. */
  56368. getTextureBlocks(): (TextureBlock | ReflectionTextureBlock)[];
  56369. /**
  56370. * Specifies if the material uses a texture
  56371. * @param texture defines the texture to check against the material
  56372. * @returns a boolean specifying if the material uses the texture
  56373. */
  56374. hasTexture(texture: BaseTexture): boolean;
  56375. /**
  56376. * Disposes the material
  56377. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  56378. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  56379. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  56380. */
  56381. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  56382. /** Creates the node editor window. */
  56383. private _createNodeEditor;
  56384. /**
  56385. * Launch the node material editor
  56386. * @param config Define the configuration of the editor
  56387. * @return a promise fulfilled when the node editor is visible
  56388. */
  56389. edit(config?: INodeMaterialEditorOptions): Promise<void>;
  56390. /**
  56391. * Clear the current material
  56392. */
  56393. clear(): void;
  56394. /**
  56395. * Clear the current material and set it to a default state
  56396. */
  56397. setToDefault(): void;
  56398. /**
  56399. * Loads the current Node Material from a url pointing to a file save by the Node Material Editor
  56400. * @param url defines the url to load from
  56401. * @returns a promise that will fullfil when the material is fully loaded
  56402. */
  56403. loadAsync(url: string): Promise<void>;
  56404. private _gatherBlocks;
  56405. /**
  56406. * Generate a string containing the code declaration required to create an equivalent of this material
  56407. * @returns a string
  56408. */
  56409. generateCode(): string;
  56410. /**
  56411. * Serializes this material in a JSON representation
  56412. * @returns the serialized material object
  56413. */
  56414. serialize(): any;
  56415. private _restoreConnections;
  56416. /**
  56417. * Clear the current graph and load a new one from a serialization object
  56418. * @param source defines the JSON representation of the material
  56419. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  56420. */
  56421. loadFromSerialization(source: any, rootUrl?: string): void;
  56422. /**
  56423. * Creates a node material from parsed material data
  56424. * @param source defines the JSON representation of the material
  56425. * @param scene defines the hosting scene
  56426. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  56427. * @returns a new node material
  56428. */
  56429. static Parse(source: any, scene: Scene, rootUrl?: string): NodeMaterial;
  56430. /**
  56431. * Creates a new node material set to default basic configuration
  56432. * @param name defines the name of the material
  56433. * @param scene defines the hosting scene
  56434. * @returns a new NodeMaterial
  56435. */
  56436. static CreateDefault(name: string, scene?: Scene): NodeMaterial;
  56437. }
  56438. }
  56439. declare module "babylonjs/Materials/Node/Blocks/Dual/textureBlock" {
  56440. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  56441. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  56442. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  56443. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  56444. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56445. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  56446. import { Effect } from "babylonjs/Materials/effect";
  56447. import { Mesh } from "babylonjs/Meshes/mesh";
  56448. import { Nullable } from "babylonjs/types";
  56449. import { Texture } from "babylonjs/Materials/Textures/texture";
  56450. import { Scene } from "babylonjs/scene";
  56451. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  56452. /**
  56453. * Block used to read a texture from a sampler
  56454. */
  56455. export class TextureBlock extends NodeMaterialBlock {
  56456. private _defineName;
  56457. private _linearDefineName;
  56458. private _tempTextureRead;
  56459. private _samplerName;
  56460. private _transformedUVName;
  56461. private _textureTransformName;
  56462. private _textureInfoName;
  56463. private _mainUVName;
  56464. private _mainUVDefineName;
  56465. /**
  56466. * Gets or sets the texture associated with the node
  56467. */
  56468. texture: Nullable<Texture>;
  56469. /**
  56470. * Create a new TextureBlock
  56471. * @param name defines the block name
  56472. */
  56473. constructor(name: string);
  56474. /**
  56475. * Gets the current class name
  56476. * @returns the class name
  56477. */
  56478. getClassName(): string;
  56479. /**
  56480. * Gets the uv input component
  56481. */
  56482. readonly uv: NodeMaterialConnectionPoint;
  56483. /**
  56484. * Gets the rgba output component
  56485. */
  56486. readonly rgba: NodeMaterialConnectionPoint;
  56487. /**
  56488. * Gets the rgb output component
  56489. */
  56490. readonly rgb: NodeMaterialConnectionPoint;
  56491. /**
  56492. * Gets the r output component
  56493. */
  56494. readonly r: NodeMaterialConnectionPoint;
  56495. /**
  56496. * Gets the g output component
  56497. */
  56498. readonly g: NodeMaterialConnectionPoint;
  56499. /**
  56500. * Gets the b output component
  56501. */
  56502. readonly b: NodeMaterialConnectionPoint;
  56503. /**
  56504. * Gets the a output component
  56505. */
  56506. readonly a: NodeMaterialConnectionPoint;
  56507. readonly target: NodeMaterialBlockTargets;
  56508. autoConfigure(material: NodeMaterial): void;
  56509. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  56510. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  56511. isReady(): boolean;
  56512. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  56513. private readonly _isMixed;
  56514. private _injectVertexCode;
  56515. private _writeTextureRead;
  56516. private _writeOutput;
  56517. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  56518. protected _dumpPropertiesCode(): string;
  56519. serialize(): any;
  56520. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  56521. }
  56522. }
  56523. declare module "babylonjs/Materials/Node/nodeMaterialBuildStateSharedData" {
  56524. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  56525. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  56526. import { InputBlock } from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  56527. import { TextureBlock } from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  56528. import { ReflectionTextureBlock } from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBlock";
  56529. import { Scene } from "babylonjs/scene";
  56530. /**
  56531. * Class used to store shared data between 2 NodeMaterialBuildState
  56532. */
  56533. export class NodeMaterialBuildStateSharedData {
  56534. /**
  56535. * Gets the list of emitted varyings
  56536. */
  56537. temps: string[];
  56538. /**
  56539. * Gets the list of emitted varyings
  56540. */
  56541. varyings: string[];
  56542. /**
  56543. * Gets the varying declaration string
  56544. */
  56545. varyingDeclaration: string;
  56546. /**
  56547. * Input blocks
  56548. */
  56549. inputBlocks: InputBlock[];
  56550. /**
  56551. * Input blocks
  56552. */
  56553. textureBlocks: (ReflectionTextureBlock | TextureBlock)[];
  56554. /**
  56555. * Bindable blocks (Blocks that need to set data to the effect)
  56556. */
  56557. bindableBlocks: NodeMaterialBlock[];
  56558. /**
  56559. * List of blocks that can provide a compilation fallback
  56560. */
  56561. blocksWithFallbacks: NodeMaterialBlock[];
  56562. /**
  56563. * List of blocks that can provide a define update
  56564. */
  56565. blocksWithDefines: NodeMaterialBlock[];
  56566. /**
  56567. * List of blocks that can provide a repeatable content
  56568. */
  56569. repeatableContentBlocks: NodeMaterialBlock[];
  56570. /**
  56571. * List of blocks that can provide a dynamic list of uniforms
  56572. */
  56573. dynamicUniformBlocks: NodeMaterialBlock[];
  56574. /**
  56575. * List of blocks that can block the isReady function for the material
  56576. */
  56577. blockingBlocks: NodeMaterialBlock[];
  56578. /**
  56579. * Gets the list of animated inputs
  56580. */
  56581. animatedInputs: InputBlock[];
  56582. /**
  56583. * Build Id used to avoid multiple recompilations
  56584. */
  56585. buildId: number;
  56586. /** List of emitted variables */
  56587. variableNames: {
  56588. [key: string]: number;
  56589. };
  56590. /** List of emitted defines */
  56591. defineNames: {
  56592. [key: string]: number;
  56593. };
  56594. /** Should emit comments? */
  56595. emitComments: boolean;
  56596. /** Emit build activity */
  56597. verbose: boolean;
  56598. /** Gets or sets the hosting scene */
  56599. scene: Scene;
  56600. /**
  56601. * Gets the compilation hints emitted at compilation time
  56602. */
  56603. hints: {
  56604. needWorldViewMatrix: boolean;
  56605. needWorldViewProjectionMatrix: boolean;
  56606. needAlphaBlending: boolean;
  56607. needAlphaTesting: boolean;
  56608. };
  56609. /**
  56610. * List of compilation checks
  56611. */
  56612. checks: {
  56613. emitVertex: boolean;
  56614. emitFragment: boolean;
  56615. notConnectedNonOptionalInputs: NodeMaterialConnectionPoint[];
  56616. };
  56617. /** Creates a new shared data */
  56618. constructor();
  56619. /**
  56620. * Emits console errors and exceptions if there is a failing check
  56621. */
  56622. emitErrors(): void;
  56623. }
  56624. }
  56625. declare module "babylonjs/Materials/Node/nodeMaterialBuildState" {
  56626. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  56627. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  56628. import { NodeMaterialBuildStateSharedData } from "babylonjs/Materials/Node/nodeMaterialBuildStateSharedData";
  56629. /**
  56630. * Class used to store node based material build state
  56631. */
  56632. export class NodeMaterialBuildState {
  56633. /** Gets or sets a boolean indicating if the current state can emit uniform buffers */
  56634. supportUniformBuffers: boolean;
  56635. /**
  56636. * Gets the list of emitted attributes
  56637. */
  56638. attributes: string[];
  56639. /**
  56640. * Gets the list of emitted uniforms
  56641. */
  56642. uniforms: string[];
  56643. /**
  56644. * Gets the list of emitted constants
  56645. */
  56646. constants: string[];
  56647. /**
  56648. * Gets the list of emitted samplers
  56649. */
  56650. samplers: string[];
  56651. /**
  56652. * Gets the list of emitted functions
  56653. */
  56654. functions: {
  56655. [key: string]: string;
  56656. };
  56657. /**
  56658. * Gets the list of emitted extensions
  56659. */
  56660. extensions: {
  56661. [key: string]: string;
  56662. };
  56663. /**
  56664. * Gets the target of the compilation state
  56665. */
  56666. target: NodeMaterialBlockTargets;
  56667. /**
  56668. * Gets the list of emitted counters
  56669. */
  56670. counters: {
  56671. [key: string]: number;
  56672. };
  56673. /**
  56674. * Shared data between multiple NodeMaterialBuildState instances
  56675. */
  56676. sharedData: NodeMaterialBuildStateSharedData;
  56677. /** @hidden */
  56678. _vertexState: NodeMaterialBuildState;
  56679. /** @hidden */
  56680. _attributeDeclaration: string;
  56681. /** @hidden */
  56682. _uniformDeclaration: string;
  56683. /** @hidden */
  56684. _constantDeclaration: string;
  56685. /** @hidden */
  56686. _samplerDeclaration: string;
  56687. /** @hidden */
  56688. _varyingTransfer: string;
  56689. private _repeatableContentAnchorIndex;
  56690. /** @hidden */
  56691. _builtCompilationString: string;
  56692. /**
  56693. * Gets the emitted compilation strings
  56694. */
  56695. compilationString: string;
  56696. /**
  56697. * Finalize the compilation strings
  56698. * @param state defines the current compilation state
  56699. */
  56700. finalize(state: NodeMaterialBuildState): void;
  56701. /** @hidden */
  56702. readonly _repeatableContentAnchor: string;
  56703. /** @hidden */
  56704. _getFreeVariableName(prefix: string): string;
  56705. /** @hidden */
  56706. _getFreeDefineName(prefix: string): string;
  56707. /** @hidden */
  56708. _excludeVariableName(name: string): void;
  56709. /** @hidden */
  56710. _emit2DSampler(name: string): void;
  56711. /** @hidden */
  56712. _getGLType(type: NodeMaterialBlockConnectionPointTypes): string;
  56713. /** @hidden */
  56714. _emitExtension(name: string, extension: string): void;
  56715. /** @hidden */
  56716. _emitFunction(name: string, code: string, comments: string): void;
  56717. /** @hidden */
  56718. _emitCodeFromInclude(includeName: string, comments: string, options?: {
  56719. replaceStrings?: {
  56720. search: RegExp;
  56721. replace: string;
  56722. }[];
  56723. repeatKey?: string;
  56724. }): string;
  56725. /** @hidden */
  56726. _emitFunctionFromInclude(includeName: string, comments: string, options?: {
  56727. repeatKey?: string;
  56728. removeAttributes?: boolean;
  56729. removeUniforms?: boolean;
  56730. removeVaryings?: boolean;
  56731. removeIfDef?: boolean;
  56732. replaceStrings?: {
  56733. search: RegExp;
  56734. replace: string;
  56735. }[];
  56736. }, storeKey?: string): void;
  56737. /** @hidden */
  56738. _registerTempVariable(name: string): boolean;
  56739. /** @hidden */
  56740. _emitVaryingFromString(name: string, type: string, define?: string, notDefine?: boolean): boolean;
  56741. /** @hidden */
  56742. _emitUniformFromString(name: string, type: string, define?: string, notDefine?: boolean): void;
  56743. /** @hidden */
  56744. _emitFloat(value: number): string;
  56745. }
  56746. }
  56747. declare module "babylonjs/Materials/Node/nodeMaterialBlock" {
  56748. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  56749. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  56750. import { Nullable } from "babylonjs/types";
  56751. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  56752. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  56753. import { Effect } from "babylonjs/Materials/effect";
  56754. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  56755. import { Mesh } from "babylonjs/Meshes/mesh";
  56756. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  56757. import { Scene } from "babylonjs/scene";
  56758. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  56759. /**
  56760. * Defines a block that can be used inside a node based material
  56761. */
  56762. export class NodeMaterialBlock {
  56763. private _buildId;
  56764. private _buildTarget;
  56765. private _target;
  56766. private _isFinalMerger;
  56767. private _isInput;
  56768. protected _isUnique: boolean;
  56769. /** @hidden */
  56770. _codeVariableName: string;
  56771. /** @hidden */
  56772. _inputs: NodeMaterialConnectionPoint[];
  56773. /** @hidden */
  56774. _outputs: NodeMaterialConnectionPoint[];
  56775. /** @hidden */
  56776. _preparationId: number;
  56777. /**
  56778. * Gets or sets the name of the block
  56779. */
  56780. name: string;
  56781. /**
  56782. * Gets or sets the unique id of the node
  56783. */
  56784. uniqueId: number;
  56785. /**
  56786. * Gets a boolean indicating that this block can only be used once per NodeMaterial
  56787. */
  56788. readonly isUnique: boolean;
  56789. /**
  56790. * Gets a boolean indicating that this block is an end block (e.g. it is generating a system value)
  56791. */
  56792. readonly isFinalMerger: boolean;
  56793. /**
  56794. * Gets a boolean indicating that this block is an input (e.g. it sends data to the shader)
  56795. */
  56796. readonly isInput: boolean;
  56797. /**
  56798. * Gets or sets the build Id
  56799. */
  56800. buildId: number;
  56801. /**
  56802. * Gets or sets the target of the block
  56803. */
  56804. target: NodeMaterialBlockTargets;
  56805. /**
  56806. * Gets the list of input points
  56807. */
  56808. readonly inputs: NodeMaterialConnectionPoint[];
  56809. /** Gets the list of output points */
  56810. readonly outputs: NodeMaterialConnectionPoint[];
  56811. /**
  56812. * Find an input by its name
  56813. * @param name defines the name of the input to look for
  56814. * @returns the input or null if not found
  56815. */
  56816. getInputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  56817. /**
  56818. * Find an output by its name
  56819. * @param name defines the name of the outputto look for
  56820. * @returns the output or null if not found
  56821. */
  56822. getOutputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  56823. /**
  56824. * Creates a new NodeMaterialBlock
  56825. * @param name defines the block name
  56826. * @param target defines the target of that block (Vertex by default)
  56827. * @param isFinalMerger defines a boolean indicating that this block is an end block (e.g. it is generating a system value). Default is false
  56828. * @param isInput defines a boolean indicating that this block is an input (e.g. it sends data to the shader). Default is false
  56829. */
  56830. constructor(name: string, target?: NodeMaterialBlockTargets, isFinalMerger?: boolean, isInput?: boolean);
  56831. /**
  56832. * Initialize the block and prepare the context for build
  56833. * @param state defines the state that will be used for the build
  56834. */
  56835. initialize(state: NodeMaterialBuildState): void;
  56836. /**
  56837. * Bind data to effect. Will only be called for blocks with isBindable === true
  56838. * @param effect defines the effect to bind data to
  56839. * @param nodeMaterial defines the hosting NodeMaterial
  56840. * @param mesh defines the mesh that will be rendered
  56841. */
  56842. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  56843. protected _declareOutput(output: NodeMaterialConnectionPoint, state: NodeMaterialBuildState): string;
  56844. protected _writeVariable(currentPoint: NodeMaterialConnectionPoint): string;
  56845. protected _writeFloat(value: number): string;
  56846. /**
  56847. * Gets the current class name e.g. "NodeMaterialBlock"
  56848. * @returns the class name
  56849. */
  56850. getClassName(): string;
  56851. /**
  56852. * Register a new input. Must be called inside a block constructor
  56853. * @param name defines the connection point name
  56854. * @param type defines the connection point type
  56855. * @param isOptional defines a boolean indicating that this input can be omitted
  56856. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  56857. * @returns the current block
  56858. */
  56859. registerInput(name: string, type: NodeMaterialBlockConnectionPointTypes, isOptional?: boolean, target?: NodeMaterialBlockTargets): this;
  56860. /**
  56861. * Register a new output. Must be called inside a block constructor
  56862. * @param name defines the connection point name
  56863. * @param type defines the connection point type
  56864. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  56865. * @returns the current block
  56866. */
  56867. registerOutput(name: string, type: NodeMaterialBlockConnectionPointTypes, target?: NodeMaterialBlockTargets): this;
  56868. /**
  56869. * Will return the first available input e.g. the first one which is not an uniform or an attribute
  56870. * @param forOutput defines an optional connection point to check compatibility with
  56871. * @returns the first available input or null
  56872. */
  56873. getFirstAvailableInput(forOutput?: Nullable<NodeMaterialConnectionPoint>): Nullable<NodeMaterialConnectionPoint>;
  56874. /**
  56875. * Will return the first available output e.g. the first one which is not yet connected and not a varying
  56876. * @param forBlock defines an optional block to check compatibility with
  56877. * @returns the first available input or null
  56878. */
  56879. getFirstAvailableOutput(forBlock?: Nullable<NodeMaterialBlock>): Nullable<NodeMaterialConnectionPoint>;
  56880. /**
  56881. * Gets the sibling of the given output
  56882. * @param current defines the current output
  56883. * @returns the next output in the list or null
  56884. */
  56885. getSiblingOutput(current: NodeMaterialConnectionPoint): Nullable<NodeMaterialConnectionPoint>;
  56886. /**
  56887. * Connect current block with another block
  56888. * @param other defines the block to connect with
  56889. * @param options define the various options to help pick the right connections
  56890. * @returns the current block
  56891. */
  56892. connectTo(other: NodeMaterialBlock, options?: {
  56893. input?: string;
  56894. output?: string;
  56895. outputSwizzle?: string;
  56896. }): this | undefined;
  56897. protected _buildBlock(state: NodeMaterialBuildState): void;
  56898. /**
  56899. * Add uniforms, samplers and uniform buffers at compilation time
  56900. * @param state defines the state to update
  56901. * @param nodeMaterial defines the node material requesting the update
  56902. * @param defines defines the material defines to update
  56903. * @param uniformBuffers defines the list of uniform buffer names
  56904. */
  56905. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  56906. /**
  56907. * Add potential fallbacks if shader compilation fails
  56908. * @param mesh defines the mesh to be rendered
  56909. * @param fallbacks defines the current prioritized list of fallbacks
  56910. */
  56911. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  56912. /**
  56913. * Initialize defines for shader compilation
  56914. * @param mesh defines the mesh to be rendered
  56915. * @param nodeMaterial defines the node material requesting the update
  56916. * @param defines defines the material defines to update
  56917. * @param useInstances specifies that instances should be used
  56918. */
  56919. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  56920. /**
  56921. * Update defines for shader compilation
  56922. * @param mesh defines the mesh to be rendered
  56923. * @param nodeMaterial defines the node material requesting the update
  56924. * @param defines defines the material defines to update
  56925. * @param useInstances specifies that instances should be used
  56926. */
  56927. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  56928. /**
  56929. * Lets the block try to connect some inputs automatically
  56930. * @param material defines the hosting NodeMaterial
  56931. */
  56932. autoConfigure(material: NodeMaterial): void;
  56933. /**
  56934. * Function called when a block is declared as repeatable content generator
  56935. * @param vertexShaderState defines the current compilation state for the vertex shader
  56936. * @param fragmentShaderState defines the current compilation state for the fragment shader
  56937. * @param mesh defines the mesh to be rendered
  56938. * @param defines defines the material defines to update
  56939. */
  56940. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  56941. /**
  56942. * Checks if the block is ready
  56943. * @param mesh defines the mesh to be rendered
  56944. * @param nodeMaterial defines the node material requesting the update
  56945. * @param defines defines the material defines to update
  56946. * @param useInstances specifies that instances should be used
  56947. * @returns true if the block is ready
  56948. */
  56949. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): boolean;
  56950. protected _linkConnectionTypes(inputIndex0: number, inputIndex1: number): void;
  56951. private _processBuild;
  56952. /**
  56953. * Compile the current node and generate the shader code
  56954. * @param state defines the current compilation state (uniforms, samplers, current string)
  56955. * @param activeBlocks defines the list of active blocks (i.e. blocks to compile)
  56956. * @returns true if already built
  56957. */
  56958. build(state: NodeMaterialBuildState, activeBlocks: NodeMaterialBlock[]): boolean;
  56959. protected _inputRename(name: string): string;
  56960. protected _outputRename(name: string): string;
  56961. protected _dumpPropertiesCode(): string;
  56962. /** @hidden */
  56963. _dumpCode(uniqueNames: string[], alreadyDumped: NodeMaterialBlock[]): string;
  56964. /** @hidden */
  56965. _dumpCodeForOutputConnections(alreadyDumped: NodeMaterialBlock[]): string;
  56966. /**
  56967. * Clone the current block to a new identical block
  56968. * @param scene defines the hosting scene
  56969. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  56970. * @returns a copy of the current block
  56971. */
  56972. clone(scene: Scene, rootUrl?: string): Nullable<NodeMaterialBlock>;
  56973. /**
  56974. * Serializes this block in a JSON representation
  56975. * @returns the serialized block object
  56976. */
  56977. serialize(): any;
  56978. /** @hidden */
  56979. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  56980. /**
  56981. * Release resources
  56982. */
  56983. dispose(): void;
  56984. }
  56985. }
  56986. declare module "babylonjs/Materials/Node/Blocks/Input/animatedInputBlockTypes" {
  56987. /**
  56988. * Enum defining the type of animations supported by InputBlock
  56989. */
  56990. export enum AnimatedInputBlockTypes {
  56991. /** No animation */
  56992. None = 0,
  56993. /** Time based animation. Will only work for floats */
  56994. Time = 1
  56995. }
  56996. }
  56997. declare module "babylonjs/Materials/Node/Blocks/Input/inputBlock" {
  56998. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  56999. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  57000. import { NodeMaterialSystemValues } from "babylonjs/Materials/Node/Enums/nodeMaterialSystemValues";
  57001. import { Nullable } from "babylonjs/types";
  57002. import { Effect } from "babylonjs/Materials/effect";
  57003. import { Matrix } from "babylonjs/Maths/math.vector";
  57004. import { Scene } from "babylonjs/scene";
  57005. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57006. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57007. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  57008. import { AnimatedInputBlockTypes } from "babylonjs/Materials/Node/Blocks/Input/animatedInputBlockTypes";
  57009. /**
  57010. * Block used to expose an input value
  57011. */
  57012. export class InputBlock extends NodeMaterialBlock {
  57013. private _mode;
  57014. private _associatedVariableName;
  57015. private _storedValue;
  57016. private _valueCallback;
  57017. private _type;
  57018. private _animationType;
  57019. /** Gets or set a value used to limit the range of float values */
  57020. min: number;
  57021. /** Gets or set a value used to limit the range of float values */
  57022. max: number;
  57023. /** Gets or sets a value used by the Node Material editor to determine how to configure the current value if it is a matrix */
  57024. matrixMode: number;
  57025. /** @hidden */
  57026. _systemValue: Nullable<NodeMaterialSystemValues>;
  57027. /** Gets or sets a boolean indicating that this input can be edited in the Inspector (false by default) */
  57028. visibleInInspector: boolean;
  57029. /** Gets or sets a boolean indicating that the value of this input will not change after a build */
  57030. isConstant: boolean;
  57031. /**
  57032. * Gets or sets the connection point type (default is float)
  57033. */
  57034. readonly type: NodeMaterialBlockConnectionPointTypes;
  57035. /**
  57036. * Creates a new InputBlock
  57037. * @param name defines the block name
  57038. * @param target defines the target of that block (Vertex by default)
  57039. * @param type defines the type of the input (can be set to NodeMaterialBlockConnectionPointTypes.AutoDetect)
  57040. */
  57041. constructor(name: string, target?: NodeMaterialBlockTargets, type?: NodeMaterialBlockConnectionPointTypes);
  57042. /**
  57043. * Gets the output component
  57044. */
  57045. readonly output: NodeMaterialConnectionPoint;
  57046. /**
  57047. * Set the source of this connection point to a vertex attribute
  57048. * @param attributeName defines the attribute name (position, uv, normal, etc...). If not specified it will take the connection point name
  57049. * @returns the current connection point
  57050. */
  57051. setAsAttribute(attributeName?: string): InputBlock;
  57052. /**
  57053. * Set the source of this connection point to a system value
  57054. * @param value define the system value to use (world, view, etc...) or null to switch to manual value
  57055. * @returns the current connection point
  57056. */
  57057. setAsSystemValue(value: Nullable<NodeMaterialSystemValues>): InputBlock;
  57058. /**
  57059. * Gets or sets the value of that point.
  57060. * Please note that this value will be ignored if valueCallback is defined
  57061. */
  57062. value: any;
  57063. /**
  57064. * Gets or sets a callback used to get the value of that point.
  57065. * Please note that setting this value will force the connection point to ignore the value property
  57066. */
  57067. valueCallback: () => any;
  57068. /**
  57069. * Gets or sets the associated variable name in the shader
  57070. */
  57071. associatedVariableName: string;
  57072. /** Gets or sets the type of animation applied to the input */
  57073. animationType: AnimatedInputBlockTypes;
  57074. /**
  57075. * Gets a boolean indicating that this connection point not defined yet
  57076. */
  57077. readonly isUndefined: boolean;
  57078. /**
  57079. * Gets or sets a boolean indicating that this connection point is coming from an uniform.
  57080. * In this case the connection point name must be the name of the uniform to use.
  57081. * Can only be set on inputs
  57082. */
  57083. isUniform: boolean;
  57084. /**
  57085. * Gets or sets a boolean indicating that this connection point is coming from an attribute.
  57086. * In this case the connection point name must be the name of the attribute to use
  57087. * Can only be set on inputs
  57088. */
  57089. isAttribute: boolean;
  57090. /**
  57091. * Gets or sets a boolean indicating that this connection point is generating a varying variable.
  57092. * Can only be set on exit points
  57093. */
  57094. isVarying: boolean;
  57095. /**
  57096. * Gets a boolean indicating that the current connection point is a system value
  57097. */
  57098. readonly isSystemValue: boolean;
  57099. /**
  57100. * Gets or sets the current well known value or null if not defined as a system value
  57101. */
  57102. systemValue: Nullable<NodeMaterialSystemValues>;
  57103. /**
  57104. * Gets the current class name
  57105. * @returns the class name
  57106. */
  57107. getClassName(): string;
  57108. /**
  57109. * Animate the input if animationType !== None
  57110. * @param scene defines the rendering scene
  57111. */
  57112. animate(scene: Scene): void;
  57113. private _emitDefine;
  57114. initialize(state: NodeMaterialBuildState): void;
  57115. /**
  57116. * Set the input block to its default value (based on its type)
  57117. */
  57118. setDefaultValue(): void;
  57119. private _emitConstant;
  57120. private _emit;
  57121. /** @hidden */
  57122. _transmitWorld(effect: Effect, world: Matrix, worldView: Matrix, worldViewProjection: Matrix): void;
  57123. /** @hidden */
  57124. _transmit(effect: Effect, scene: Scene): void;
  57125. protected _buildBlock(state: NodeMaterialBuildState): void;
  57126. protected _dumpPropertiesCode(): string;
  57127. serialize(): any;
  57128. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  57129. }
  57130. }
  57131. declare module "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint" {
  57132. import { NodeMaterialBlockConnectionPointTypes } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockConnectionPointTypes";
  57133. import { NodeMaterialBlockTargets } from "babylonjs/Materials/Node/Enums/nodeMaterialBlockTargets";
  57134. import { Nullable } from "babylonjs/types";
  57135. import { InputBlock } from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  57136. import { Observable } from "babylonjs/Misc/observable";
  57137. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57138. /**
  57139. * Enum used to define the compatibility state between two connection points
  57140. */
  57141. export enum NodeMaterialConnectionPointCompatibilityStates {
  57142. /** Points are compatibles */
  57143. Compatible = 0,
  57144. /** Points are incompatible because of their types */
  57145. TypeIncompatible = 1,
  57146. /** Points are incompatible because of their targets (vertex vs fragment) */
  57147. TargetIncompatible = 2
  57148. }
  57149. /**
  57150. * Defines a connection point for a block
  57151. */
  57152. export class NodeMaterialConnectionPoint {
  57153. /** @hidden */
  57154. _ownerBlock: NodeMaterialBlock;
  57155. /** @hidden */
  57156. _connectedPoint: Nullable<NodeMaterialConnectionPoint>;
  57157. private _endpoints;
  57158. private _associatedVariableName;
  57159. /** @hidden */
  57160. _typeConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  57161. /** @hidden */
  57162. _linkedConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  57163. private _type;
  57164. /** @hidden */
  57165. _enforceAssociatedVariableName: boolean;
  57166. /**
  57167. * Gets or sets the additional types supported by this connection point
  57168. */
  57169. acceptedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  57170. /**
  57171. * Gets or sets the additional types excluded by this connection point
  57172. */
  57173. excludedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  57174. /**
  57175. * Observable triggered when this point is connected
  57176. */
  57177. onConnectionObservable: Observable<NodeMaterialConnectionPoint>;
  57178. /**
  57179. * Gets or sets the associated variable name in the shader
  57180. */
  57181. associatedVariableName: string;
  57182. /**
  57183. * Gets or sets the connection point type (default is float)
  57184. */
  57185. type: NodeMaterialBlockConnectionPointTypes;
  57186. /**
  57187. * Gets or sets the connection point name
  57188. */
  57189. name: string;
  57190. /**
  57191. * Gets or sets a boolean indicating that this connection point can be omitted
  57192. */
  57193. isOptional: boolean;
  57194. /**
  57195. * Gets or sets a string indicating that this uniform must be defined under a #ifdef
  57196. */
  57197. define: string;
  57198. /** @hidden */
  57199. _prioritizeVertex: boolean;
  57200. private _target;
  57201. /** Gets or sets the target of that connection point */
  57202. target: NodeMaterialBlockTargets;
  57203. /**
  57204. * Gets a boolean indicating that the current point is connected
  57205. */
  57206. readonly isConnected: boolean;
  57207. /**
  57208. * Gets a boolean indicating that the current point is connected to an input block
  57209. */
  57210. readonly isConnectedToInputBlock: boolean;
  57211. /**
  57212. * Gets a the connected input block (if any)
  57213. */
  57214. readonly connectInputBlock: Nullable<InputBlock>;
  57215. /** Get the other side of the connection (if any) */
  57216. readonly connectedPoint: Nullable<NodeMaterialConnectionPoint>;
  57217. /** Get the block that owns this connection point */
  57218. readonly ownerBlock: NodeMaterialBlock;
  57219. /** Get the block connected on the other side of this connection (if any) */
  57220. readonly sourceBlock: Nullable<NodeMaterialBlock>;
  57221. /** Get the block connected on the endpoints of this connection (if any) */
  57222. readonly connectedBlocks: Array<NodeMaterialBlock>;
  57223. /** Gets the list of connected endpoints */
  57224. readonly endpoints: NodeMaterialConnectionPoint[];
  57225. /** Gets a boolean indicating if that output point is connected to at least one input */
  57226. readonly hasEndpoints: boolean;
  57227. /** Gets a boolean indicating that this connection will be used in the vertex shader */
  57228. readonly isConnectedInVertexShader: boolean;
  57229. /** Gets a boolean indicating that this connection will be used in the fragment shader */
  57230. readonly isConnectedInFragmentShader: boolean;
  57231. /**
  57232. * Creates a new connection point
  57233. * @param name defines the connection point name
  57234. * @param ownerBlock defines the block hosting this connection point
  57235. */
  57236. constructor(name: string, ownerBlock: NodeMaterialBlock);
  57237. /**
  57238. * Gets the current class name e.g. "NodeMaterialConnectionPoint"
  57239. * @returns the class name
  57240. */
  57241. getClassName(): string;
  57242. /**
  57243. * Gets a boolean indicating if the current point can be connected to another point
  57244. * @param connectionPoint defines the other connection point
  57245. * @returns a boolean
  57246. */
  57247. canConnectTo(connectionPoint: NodeMaterialConnectionPoint): boolean;
  57248. /**
  57249. * Gets a number indicating if the current point can be connected to another point
  57250. * @param connectionPoint defines the other connection point
  57251. * @returns a number defining the compatibility state
  57252. */
  57253. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  57254. /**
  57255. * Connect this point to another connection point
  57256. * @param connectionPoint defines the other connection point
  57257. * @param ignoreConstraints defines if the system will ignore connection type constraints (default is false)
  57258. * @returns the current connection point
  57259. */
  57260. connectTo(connectionPoint: NodeMaterialConnectionPoint, ignoreConstraints?: boolean): NodeMaterialConnectionPoint;
  57261. /**
  57262. * Disconnect this point from one of his endpoint
  57263. * @param endpoint defines the other connection point
  57264. * @returns the current connection point
  57265. */
  57266. disconnectFrom(endpoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPoint;
  57267. /**
  57268. * Serializes this point in a JSON representation
  57269. * @returns the serialized point object
  57270. */
  57271. serialize(): any;
  57272. /**
  57273. * Release resources
  57274. */
  57275. dispose(): void;
  57276. }
  57277. }
  57278. declare module "babylonjs/Materials/Node/Blocks/Vertex/bonesBlock" {
  57279. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57280. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57281. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  57282. import { Mesh } from "babylonjs/Meshes/mesh";
  57283. import { Effect } from "babylonjs/Materials/effect";
  57284. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57285. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  57286. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  57287. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  57288. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  57289. /**
  57290. * Block used to add support for vertex skinning (bones)
  57291. */
  57292. export class BonesBlock extends NodeMaterialBlock {
  57293. /**
  57294. * Creates a new BonesBlock
  57295. * @param name defines the block name
  57296. */
  57297. constructor(name: string);
  57298. /**
  57299. * Initialize the block and prepare the context for build
  57300. * @param state defines the state that will be used for the build
  57301. */
  57302. initialize(state: NodeMaterialBuildState): void;
  57303. /**
  57304. * Gets the current class name
  57305. * @returns the class name
  57306. */
  57307. getClassName(): string;
  57308. /**
  57309. * Gets the matrix indices input component
  57310. */
  57311. readonly matricesIndices: NodeMaterialConnectionPoint;
  57312. /**
  57313. * Gets the matrix weights input component
  57314. */
  57315. readonly matricesWeights: NodeMaterialConnectionPoint;
  57316. /**
  57317. * Gets the extra matrix indices input component
  57318. */
  57319. readonly matricesIndicesExtra: NodeMaterialConnectionPoint;
  57320. /**
  57321. * Gets the extra matrix weights input component
  57322. */
  57323. readonly matricesWeightsExtra: NodeMaterialConnectionPoint;
  57324. /**
  57325. * Gets the world input component
  57326. */
  57327. readonly world: NodeMaterialConnectionPoint;
  57328. /**
  57329. * Gets the output component
  57330. */
  57331. readonly output: NodeMaterialConnectionPoint;
  57332. autoConfigure(material: NodeMaterial): void;
  57333. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  57334. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  57335. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  57336. protected _buildBlock(state: NodeMaterialBuildState): this;
  57337. }
  57338. }
  57339. declare module "babylonjs/Materials/Node/Blocks/Vertex/instancesBlock" {
  57340. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57341. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57342. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57343. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  57344. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  57345. /**
  57346. * Block used to add support for instances
  57347. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  57348. */
  57349. export class InstancesBlock extends NodeMaterialBlock {
  57350. /**
  57351. * Creates a new InstancesBlock
  57352. * @param name defines the block name
  57353. */
  57354. constructor(name: string);
  57355. /**
  57356. * Gets the current class name
  57357. * @returns the class name
  57358. */
  57359. getClassName(): string;
  57360. /**
  57361. * Gets the first world row input component
  57362. */
  57363. readonly world0: NodeMaterialConnectionPoint;
  57364. /**
  57365. * Gets the second world row input component
  57366. */
  57367. readonly world1: NodeMaterialConnectionPoint;
  57368. /**
  57369. * Gets the third world row input component
  57370. */
  57371. readonly world2: NodeMaterialConnectionPoint;
  57372. /**
  57373. * Gets the forth world row input component
  57374. */
  57375. readonly world3: NodeMaterialConnectionPoint;
  57376. /**
  57377. * Gets the world input component
  57378. */
  57379. readonly world: NodeMaterialConnectionPoint;
  57380. /**
  57381. * Gets the output component
  57382. */
  57383. readonly output: NodeMaterialConnectionPoint;
  57384. autoConfigure(material: NodeMaterial): void;
  57385. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  57386. protected _buildBlock(state: NodeMaterialBuildState): this;
  57387. }
  57388. }
  57389. declare module "babylonjs/Materials/Node/Blocks/Vertex/morphTargetsBlock" {
  57390. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57391. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57392. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57393. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  57394. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  57395. import { Effect } from "babylonjs/Materials/effect";
  57396. import { Mesh } from "babylonjs/Meshes/mesh";
  57397. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  57398. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  57399. /**
  57400. * Block used to add morph targets support to vertex shader
  57401. */
  57402. export class MorphTargetsBlock extends NodeMaterialBlock {
  57403. private _repeatableContentAnchor;
  57404. private _repeatebleContentGenerated;
  57405. /**
  57406. * Create a new MorphTargetsBlock
  57407. * @param name defines the block name
  57408. */
  57409. constructor(name: string);
  57410. /**
  57411. * Gets the current class name
  57412. * @returns the class name
  57413. */
  57414. getClassName(): string;
  57415. /**
  57416. * Gets the position input component
  57417. */
  57418. readonly position: NodeMaterialConnectionPoint;
  57419. /**
  57420. * Gets the normal input component
  57421. */
  57422. readonly normal: NodeMaterialConnectionPoint;
  57423. /**
  57424. * Gets the tangent input component
  57425. */
  57426. readonly tangent: NodeMaterialConnectionPoint;
  57427. /**
  57428. * Gets the tangent input component
  57429. */
  57430. readonly uv: NodeMaterialConnectionPoint;
  57431. /**
  57432. * Gets the position output component
  57433. */
  57434. readonly positionOutput: NodeMaterialConnectionPoint;
  57435. /**
  57436. * Gets the normal output component
  57437. */
  57438. readonly normalOutput: NodeMaterialConnectionPoint;
  57439. /**
  57440. * Gets the tangent output component
  57441. */
  57442. readonly tangentOutput: NodeMaterialConnectionPoint;
  57443. /**
  57444. * Gets the tangent output component
  57445. */
  57446. readonly uvOutput: NodeMaterialConnectionPoint;
  57447. initialize(state: NodeMaterialBuildState): void;
  57448. autoConfigure(material: NodeMaterial): void;
  57449. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  57450. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  57451. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  57452. protected _buildBlock(state: NodeMaterialBuildState): this;
  57453. }
  57454. }
  57455. declare module "babylonjs/Materials/Node/Blocks/Vertex/lightInformationBlock" {
  57456. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57457. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57458. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57459. import { Nullable } from "babylonjs/types";
  57460. import { Scene } from "babylonjs/scene";
  57461. import { Effect } from "babylonjs/Materials/effect";
  57462. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  57463. import { Mesh } from "babylonjs/Meshes/mesh";
  57464. import { Light } from "babylonjs/Lights/light";
  57465. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  57466. /**
  57467. * Block used to get data information from a light
  57468. */
  57469. export class LightInformationBlock extends NodeMaterialBlock {
  57470. private _lightDataUniformName;
  57471. private _lightColorUniformName;
  57472. private _lightTypeDefineName;
  57473. /**
  57474. * Gets or sets the light associated with this block
  57475. */
  57476. light: Nullable<Light>;
  57477. /**
  57478. * Creates a new LightInformationBlock
  57479. * @param name defines the block name
  57480. */
  57481. constructor(name: string);
  57482. /**
  57483. * Gets the current class name
  57484. * @returns the class name
  57485. */
  57486. getClassName(): string;
  57487. /**
  57488. * Gets the world position input component
  57489. */
  57490. readonly worldPosition: NodeMaterialConnectionPoint;
  57491. /**
  57492. * Gets the direction output component
  57493. */
  57494. readonly direction: NodeMaterialConnectionPoint;
  57495. /**
  57496. * Gets the direction output component
  57497. */
  57498. readonly color: NodeMaterialConnectionPoint;
  57499. /**
  57500. * Gets the direction output component
  57501. */
  57502. readonly intensity: NodeMaterialConnectionPoint;
  57503. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  57504. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  57505. protected _buildBlock(state: NodeMaterialBuildState): this;
  57506. serialize(): any;
  57507. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  57508. }
  57509. }
  57510. declare module "babylonjs/Materials/Node/Blocks/Vertex/index" {
  57511. export * from "babylonjs/Materials/Node/Blocks/Vertex/vertexOutputBlock";
  57512. export * from "babylonjs/Materials/Node/Blocks/Vertex/bonesBlock";
  57513. export * from "babylonjs/Materials/Node/Blocks/Vertex/instancesBlock";
  57514. export * from "babylonjs/Materials/Node/Blocks/Vertex/morphTargetsBlock";
  57515. export * from "babylonjs/Materials/Node/Blocks/Vertex/lightInformationBlock";
  57516. }
  57517. declare module "babylonjs/Materials/Node/Blocks/Fragment/imageProcessingBlock" {
  57518. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57519. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57520. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57521. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  57522. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  57523. import { Effect } from "babylonjs/Materials/effect";
  57524. import { Mesh } from "babylonjs/Meshes/mesh";
  57525. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  57526. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  57527. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  57528. /**
  57529. * Block used to add image processing support to fragment shader
  57530. */
  57531. export class ImageProcessingBlock extends NodeMaterialBlock {
  57532. /**
  57533. * Create a new ImageProcessingBlock
  57534. * @param name defines the block name
  57535. */
  57536. constructor(name: string);
  57537. /**
  57538. * Gets the current class name
  57539. * @returns the class name
  57540. */
  57541. getClassName(): string;
  57542. /**
  57543. * Gets the color input component
  57544. */
  57545. readonly color: NodeMaterialConnectionPoint;
  57546. /**
  57547. * Gets the output component
  57548. */
  57549. readonly output: NodeMaterialConnectionPoint;
  57550. /**
  57551. * Initialize the block and prepare the context for build
  57552. * @param state defines the state that will be used for the build
  57553. */
  57554. initialize(state: NodeMaterialBuildState): void;
  57555. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): boolean;
  57556. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  57557. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  57558. protected _buildBlock(state: NodeMaterialBuildState): this;
  57559. }
  57560. }
  57561. declare module "babylonjs/Materials/Node/Blocks/Fragment/perturbNormalBlock" {
  57562. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57563. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57564. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57565. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  57566. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  57567. import { Effect } from "babylonjs/Materials/effect";
  57568. import { Mesh } from "babylonjs/Meshes/mesh";
  57569. import { Scene } from "babylonjs/scene";
  57570. import "babylonjs/Shaders/ShadersInclude/bumpFragmentFunctions";
  57571. import "babylonjs/Shaders/ShadersInclude/bumpFragment";
  57572. /**
  57573. * Block used to pertub normals based on a normal map
  57574. */
  57575. export class PerturbNormalBlock extends NodeMaterialBlock {
  57576. private _tangentSpaceParameterName;
  57577. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  57578. invertX: boolean;
  57579. /** Gets or sets a boolean indicating that normal should be inverted on Y axis */
  57580. invertY: boolean;
  57581. /**
  57582. * Create a new PerturbNormalBlock
  57583. * @param name defines the block name
  57584. */
  57585. constructor(name: string);
  57586. /**
  57587. * Gets the current class name
  57588. * @returns the class name
  57589. */
  57590. getClassName(): string;
  57591. /**
  57592. * Gets the world position input component
  57593. */
  57594. readonly worldPosition: NodeMaterialConnectionPoint;
  57595. /**
  57596. * Gets the world normal input component
  57597. */
  57598. readonly worldNormal: NodeMaterialConnectionPoint;
  57599. /**
  57600. * Gets the uv input component
  57601. */
  57602. readonly uv: NodeMaterialConnectionPoint;
  57603. /**
  57604. * Gets the normal map color input component
  57605. */
  57606. readonly normalMapColor: NodeMaterialConnectionPoint;
  57607. /**
  57608. * Gets the strength input component
  57609. */
  57610. readonly strength: NodeMaterialConnectionPoint;
  57611. /**
  57612. * Gets the output component
  57613. */
  57614. readonly output: NodeMaterialConnectionPoint;
  57615. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  57616. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  57617. autoConfigure(material: NodeMaterial): void;
  57618. protected _buildBlock(state: NodeMaterialBuildState): this;
  57619. protected _dumpPropertiesCode(): string;
  57620. serialize(): any;
  57621. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  57622. }
  57623. }
  57624. declare module "babylonjs/Materials/Node/Blocks/Fragment/discardBlock" {
  57625. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57626. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57627. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57628. /**
  57629. * Block used to discard a pixel if a value is smaller than a cutoff
  57630. */
  57631. export class DiscardBlock extends NodeMaterialBlock {
  57632. /**
  57633. * Create a new DiscardBlock
  57634. * @param name defines the block name
  57635. */
  57636. constructor(name: string);
  57637. /**
  57638. * Gets the current class name
  57639. * @returns the class name
  57640. */
  57641. getClassName(): string;
  57642. /**
  57643. * Gets the color input component
  57644. */
  57645. readonly value: NodeMaterialConnectionPoint;
  57646. /**
  57647. * Gets the cutoff input component
  57648. */
  57649. readonly cutoff: NodeMaterialConnectionPoint;
  57650. protected _buildBlock(state: NodeMaterialBuildState): this;
  57651. }
  57652. }
  57653. declare module "babylonjs/Materials/Node/Blocks/Fragment/frontFacingBlock" {
  57654. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57655. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57656. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57657. /**
  57658. * Block used to test if the fragment shader is front facing
  57659. */
  57660. export class FrontFacingBlock extends NodeMaterialBlock {
  57661. /**
  57662. * Creates a new FrontFacingBlock
  57663. * @param name defines the block name
  57664. */
  57665. constructor(name: string);
  57666. /**
  57667. * Gets the current class name
  57668. * @returns the class name
  57669. */
  57670. getClassName(): string;
  57671. /**
  57672. * Gets the output component
  57673. */
  57674. readonly output: NodeMaterialConnectionPoint;
  57675. protected _buildBlock(state: NodeMaterialBuildState): this;
  57676. }
  57677. }
  57678. declare module "babylonjs/Materials/Node/Blocks/Fragment/index" {
  57679. export * from "babylonjs/Materials/Node/Blocks/Fragment/fragmentOutputBlock";
  57680. export * from "babylonjs/Materials/Node/Blocks/Fragment/imageProcessingBlock";
  57681. export * from "babylonjs/Materials/Node/Blocks/Fragment/perturbNormalBlock";
  57682. export * from "babylonjs/Materials/Node/Blocks/Fragment/discardBlock";
  57683. export * from "babylonjs/Materials/Node/Blocks/Fragment/frontFacingBlock";
  57684. }
  57685. declare module "babylonjs/Materials/Node/Blocks/Dual/fogBlock" {
  57686. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57687. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57688. import { Mesh } from "babylonjs/Meshes/mesh";
  57689. import { Effect } from "babylonjs/Materials/effect";
  57690. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57691. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  57692. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  57693. import "babylonjs/Shaders/ShadersInclude/fogFragmentDeclaration";
  57694. /**
  57695. * Block used to add support for scene fog
  57696. */
  57697. export class FogBlock extends NodeMaterialBlock {
  57698. private _fogDistanceName;
  57699. private _fogParameters;
  57700. /**
  57701. * Create a new FogBlock
  57702. * @param name defines the block name
  57703. */
  57704. constructor(name: string);
  57705. /**
  57706. * Gets the current class name
  57707. * @returns the class name
  57708. */
  57709. getClassName(): string;
  57710. /**
  57711. * Gets the world position input component
  57712. */
  57713. readonly worldPosition: NodeMaterialConnectionPoint;
  57714. /**
  57715. * Gets the view input component
  57716. */
  57717. readonly view: NodeMaterialConnectionPoint;
  57718. /**
  57719. * Gets the color input component
  57720. */
  57721. readonly input: NodeMaterialConnectionPoint;
  57722. /**
  57723. * Gets the fog color input component
  57724. */
  57725. readonly fogColor: NodeMaterialConnectionPoint;
  57726. /**
  57727. * Gets the output component
  57728. */
  57729. readonly output: NodeMaterialConnectionPoint;
  57730. autoConfigure(material: NodeMaterial): void;
  57731. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  57732. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  57733. protected _buildBlock(state: NodeMaterialBuildState): this;
  57734. }
  57735. }
  57736. declare module "babylonjs/Materials/Node/Blocks/Dual/lightBlock" {
  57737. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57738. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57739. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57740. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  57741. import { NodeMaterial, NodeMaterialDefines } from "babylonjs/Materials/Node/nodeMaterial";
  57742. import { Effect } from "babylonjs/Materials/effect";
  57743. import { Mesh } from "babylonjs/Meshes/mesh";
  57744. import { Light } from "babylonjs/Lights/light";
  57745. import { Nullable } from "babylonjs/types";
  57746. import { Scene } from "babylonjs/scene";
  57747. import "babylonjs/Shaders/ShadersInclude/lightFragmentDeclaration";
  57748. import "babylonjs/Shaders/ShadersInclude/lightUboDeclaration";
  57749. import "babylonjs/Shaders/ShadersInclude/lightFragment";
  57750. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  57751. import "babylonjs/Shaders/ShadersInclude/lightsFragmentFunctions";
  57752. import "babylonjs/Shaders/ShadersInclude/shadowsFragmentFunctions";
  57753. import "babylonjs/Shaders/ShadersInclude/shadowsVertex";
  57754. /**
  57755. * Block used to add light in the fragment shader
  57756. */
  57757. export class LightBlock extends NodeMaterialBlock {
  57758. private _lightId;
  57759. /**
  57760. * Gets or sets the light associated with this block
  57761. */
  57762. light: Nullable<Light>;
  57763. /**
  57764. * Create a new LightBlock
  57765. * @param name defines the block name
  57766. */
  57767. constructor(name: string);
  57768. /**
  57769. * Gets the current class name
  57770. * @returns the class name
  57771. */
  57772. getClassName(): string;
  57773. /**
  57774. * Gets the world position input component
  57775. */
  57776. readonly worldPosition: NodeMaterialConnectionPoint;
  57777. /**
  57778. * Gets the world normal input component
  57779. */
  57780. readonly worldNormal: NodeMaterialConnectionPoint;
  57781. /**
  57782. * Gets the camera (or eye) position component
  57783. */
  57784. readonly cameraPosition: NodeMaterialConnectionPoint;
  57785. /**
  57786. * Gets the glossiness component
  57787. */
  57788. readonly glossiness: NodeMaterialConnectionPoint;
  57789. /**
  57790. * Gets the glossinness power component
  57791. */
  57792. readonly glossPower: NodeMaterialConnectionPoint;
  57793. /**
  57794. * Gets the diffuse color component
  57795. */
  57796. readonly diffuseColor: NodeMaterialConnectionPoint;
  57797. /**
  57798. * Gets the specular color component
  57799. */
  57800. readonly specularColor: NodeMaterialConnectionPoint;
  57801. /**
  57802. * Gets the diffuse output component
  57803. */
  57804. readonly diffuseOutput: NodeMaterialConnectionPoint;
  57805. /**
  57806. * Gets the specular output component
  57807. */
  57808. readonly specularOutput: NodeMaterialConnectionPoint;
  57809. autoConfigure(material: NodeMaterial): void;
  57810. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  57811. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  57812. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  57813. private _injectVertexCode;
  57814. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  57815. serialize(): any;
  57816. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  57817. }
  57818. }
  57819. declare module "babylonjs/Materials/Node/Blocks/Dual/index" {
  57820. export * from "babylonjs/Materials/Node/Blocks/Dual/fogBlock";
  57821. export * from "babylonjs/Materials/Node/Blocks/Dual/lightBlock";
  57822. export * from "babylonjs/Materials/Node/Blocks/Dual/textureBlock";
  57823. export * from "babylonjs/Materials/Node/Blocks/Dual/reflectionTextureBlock";
  57824. }
  57825. declare module "babylonjs/Materials/Node/Blocks/Input/index" {
  57826. export * from "babylonjs/Materials/Node/Blocks/Input/inputBlock";
  57827. export * from "babylonjs/Materials/Node/Blocks/Input/animatedInputBlockTypes";
  57828. }
  57829. declare module "babylonjs/Materials/Node/Blocks/multiplyBlock" {
  57830. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57831. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57832. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57833. /**
  57834. * Block used to multiply 2 values
  57835. */
  57836. export class MultiplyBlock extends NodeMaterialBlock {
  57837. /**
  57838. * Creates a new MultiplyBlock
  57839. * @param name defines the block name
  57840. */
  57841. constructor(name: string);
  57842. /**
  57843. * Gets the current class name
  57844. * @returns the class name
  57845. */
  57846. getClassName(): string;
  57847. /**
  57848. * Gets the left operand input component
  57849. */
  57850. readonly left: NodeMaterialConnectionPoint;
  57851. /**
  57852. * Gets the right operand input component
  57853. */
  57854. readonly right: NodeMaterialConnectionPoint;
  57855. /**
  57856. * Gets the output component
  57857. */
  57858. readonly output: NodeMaterialConnectionPoint;
  57859. protected _buildBlock(state: NodeMaterialBuildState): this;
  57860. }
  57861. }
  57862. declare module "babylonjs/Materials/Node/Blocks/addBlock" {
  57863. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57864. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57865. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57866. /**
  57867. * Block used to add 2 vectors
  57868. */
  57869. export class AddBlock extends NodeMaterialBlock {
  57870. /**
  57871. * Creates a new AddBlock
  57872. * @param name defines the block name
  57873. */
  57874. constructor(name: string);
  57875. /**
  57876. * Gets the current class name
  57877. * @returns the class name
  57878. */
  57879. getClassName(): string;
  57880. /**
  57881. * Gets the left operand input component
  57882. */
  57883. readonly left: NodeMaterialConnectionPoint;
  57884. /**
  57885. * Gets the right operand input component
  57886. */
  57887. readonly right: NodeMaterialConnectionPoint;
  57888. /**
  57889. * Gets the output component
  57890. */
  57891. readonly output: NodeMaterialConnectionPoint;
  57892. protected _buildBlock(state: NodeMaterialBuildState): this;
  57893. }
  57894. }
  57895. declare module "babylonjs/Materials/Node/Blocks/scaleBlock" {
  57896. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57897. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57898. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57899. /**
  57900. * Block used to scale a vector by a float
  57901. */
  57902. export class ScaleBlock extends NodeMaterialBlock {
  57903. /**
  57904. * Creates a new ScaleBlock
  57905. * @param name defines the block name
  57906. */
  57907. constructor(name: string);
  57908. /**
  57909. * Gets the current class name
  57910. * @returns the class name
  57911. */
  57912. getClassName(): string;
  57913. /**
  57914. * Gets the input component
  57915. */
  57916. readonly input: NodeMaterialConnectionPoint;
  57917. /**
  57918. * Gets the factor input component
  57919. */
  57920. readonly factor: NodeMaterialConnectionPoint;
  57921. /**
  57922. * Gets the output component
  57923. */
  57924. readonly output: NodeMaterialConnectionPoint;
  57925. protected _buildBlock(state: NodeMaterialBuildState): this;
  57926. }
  57927. }
  57928. declare module "babylonjs/Materials/Node/Blocks/clampBlock" {
  57929. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57930. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57931. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57932. import { Scene } from "babylonjs/scene";
  57933. /**
  57934. * Block used to clamp a float
  57935. */
  57936. export class ClampBlock extends NodeMaterialBlock {
  57937. /** Gets or sets the minimum range */
  57938. minimum: number;
  57939. /** Gets or sets the maximum range */
  57940. maximum: number;
  57941. /**
  57942. * Creates a new ClampBlock
  57943. * @param name defines the block name
  57944. */
  57945. constructor(name: string);
  57946. /**
  57947. * Gets the current class name
  57948. * @returns the class name
  57949. */
  57950. getClassName(): string;
  57951. /**
  57952. * Gets the value input component
  57953. */
  57954. readonly value: NodeMaterialConnectionPoint;
  57955. /**
  57956. * Gets the output component
  57957. */
  57958. readonly output: NodeMaterialConnectionPoint;
  57959. protected _buildBlock(state: NodeMaterialBuildState): this;
  57960. protected _dumpPropertiesCode(): string;
  57961. serialize(): any;
  57962. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  57963. }
  57964. }
  57965. declare module "babylonjs/Materials/Node/Blocks/crossBlock" {
  57966. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  57967. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  57968. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  57969. /**
  57970. * Block used to apply a cross product between 2 vectors
  57971. */
  57972. export class CrossBlock extends NodeMaterialBlock {
  57973. /**
  57974. * Creates a new CrossBlock
  57975. * @param name defines the block name
  57976. */
  57977. constructor(name: string);
  57978. /**
  57979. * Gets the current class name
  57980. * @returns the class name
  57981. */
  57982. getClassName(): string;
  57983. /**
  57984. * Gets the left operand input component
  57985. */
  57986. readonly left: NodeMaterialConnectionPoint;
  57987. /**
  57988. * Gets the right operand input component
  57989. */
  57990. readonly right: NodeMaterialConnectionPoint;
  57991. /**
  57992. * Gets the output component
  57993. */
  57994. readonly output: NodeMaterialConnectionPoint;
  57995. protected _buildBlock(state: NodeMaterialBuildState): this;
  57996. }
  57997. }
  57998. declare module "babylonjs/Materials/Node/Blocks/dotBlock" {
  57999. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58000. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58001. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58002. /**
  58003. * Block used to apply a dot product between 2 vectors
  58004. */
  58005. export class DotBlock extends NodeMaterialBlock {
  58006. /**
  58007. * Creates a new DotBlock
  58008. * @param name defines the block name
  58009. */
  58010. constructor(name: string);
  58011. /**
  58012. * Gets the current class name
  58013. * @returns the class name
  58014. */
  58015. getClassName(): string;
  58016. /**
  58017. * Gets the left operand input component
  58018. */
  58019. readonly left: NodeMaterialConnectionPoint;
  58020. /**
  58021. * Gets the right operand input component
  58022. */
  58023. readonly right: NodeMaterialConnectionPoint;
  58024. /**
  58025. * Gets the output component
  58026. */
  58027. readonly output: NodeMaterialConnectionPoint;
  58028. protected _buildBlock(state: NodeMaterialBuildState): this;
  58029. }
  58030. }
  58031. declare module "babylonjs/Materials/Node/Blocks/remapBlock" {
  58032. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58033. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58034. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58035. import { Vector2 } from "babylonjs/Maths/math.vector";
  58036. import { Scene } from "babylonjs/scene";
  58037. /**
  58038. * Block used to remap a float from a range to a new one
  58039. */
  58040. export class RemapBlock extends NodeMaterialBlock {
  58041. /**
  58042. * Gets or sets the source range
  58043. */
  58044. sourceRange: Vector2;
  58045. /**
  58046. * Gets or sets the target range
  58047. */
  58048. targetRange: Vector2;
  58049. /**
  58050. * Creates a new RemapBlock
  58051. * @param name defines the block name
  58052. */
  58053. constructor(name: string);
  58054. /**
  58055. * Gets the current class name
  58056. * @returns the class name
  58057. */
  58058. getClassName(): string;
  58059. /**
  58060. * Gets the input component
  58061. */
  58062. readonly input: NodeMaterialConnectionPoint;
  58063. /**
  58064. * Gets the source min input component
  58065. */
  58066. readonly sourceMin: NodeMaterialConnectionPoint;
  58067. /**
  58068. * Gets the source max input component
  58069. */
  58070. readonly sourceMax: NodeMaterialConnectionPoint;
  58071. /**
  58072. * Gets the target min input component
  58073. */
  58074. readonly targetMin: NodeMaterialConnectionPoint;
  58075. /**
  58076. * Gets the target max input component
  58077. */
  58078. readonly targetMax: NodeMaterialConnectionPoint;
  58079. /**
  58080. * Gets the output component
  58081. */
  58082. readonly output: NodeMaterialConnectionPoint;
  58083. protected _buildBlock(state: NodeMaterialBuildState): this;
  58084. protected _dumpPropertiesCode(): string;
  58085. serialize(): any;
  58086. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  58087. }
  58088. }
  58089. declare module "babylonjs/Materials/Node/Blocks/normalizeBlock" {
  58090. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58091. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58092. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58093. /**
  58094. * Block used to normalize a vector
  58095. */
  58096. export class NormalizeBlock extends NodeMaterialBlock {
  58097. /**
  58098. * Creates a new NormalizeBlock
  58099. * @param name defines the block name
  58100. */
  58101. constructor(name: string);
  58102. /**
  58103. * Gets the current class name
  58104. * @returns the class name
  58105. */
  58106. getClassName(): string;
  58107. /**
  58108. * Gets the input component
  58109. */
  58110. readonly input: NodeMaterialConnectionPoint;
  58111. /**
  58112. * Gets the output component
  58113. */
  58114. readonly output: NodeMaterialConnectionPoint;
  58115. protected _buildBlock(state: NodeMaterialBuildState): this;
  58116. }
  58117. }
  58118. declare module "babylonjs/Materials/Node/Blocks/trigonometryBlock" {
  58119. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58120. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58121. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58122. import { Scene } from "babylonjs/scene";
  58123. /**
  58124. * Operations supported by the Trigonometry block
  58125. */
  58126. export enum TrigonometryBlockOperations {
  58127. /** Cos */
  58128. Cos = 0,
  58129. /** Sin */
  58130. Sin = 1,
  58131. /** Abs */
  58132. Abs = 2,
  58133. /** Exp */
  58134. Exp = 3,
  58135. /** Exp2 */
  58136. Exp2 = 4,
  58137. /** Round */
  58138. Round = 5,
  58139. /** Floor */
  58140. Floor = 6,
  58141. /** Ceiling */
  58142. Ceiling = 7,
  58143. /** Square root */
  58144. Sqrt = 8,
  58145. /** Log */
  58146. Log = 9,
  58147. /** Tangent */
  58148. Tan = 10,
  58149. /** Arc tangent */
  58150. ArcTan = 11,
  58151. /** Arc cosinus */
  58152. ArcCos = 12,
  58153. /** Arc sinus */
  58154. ArcSin = 13,
  58155. /** Fraction */
  58156. Fract = 14,
  58157. /** Sign */
  58158. Sign = 15,
  58159. /** To radians (from degrees) */
  58160. Radians = 16,
  58161. /** To degrees (from radians) */
  58162. Degrees = 17
  58163. }
  58164. /**
  58165. * Block used to apply trigonometry operation to floats
  58166. */
  58167. export class TrigonometryBlock extends NodeMaterialBlock {
  58168. /**
  58169. * Gets or sets the operation applied by the block
  58170. */
  58171. operation: TrigonometryBlockOperations;
  58172. /**
  58173. * Creates a new TrigonometryBlock
  58174. * @param name defines the block name
  58175. */
  58176. constructor(name: string);
  58177. /**
  58178. * Gets the current class name
  58179. * @returns the class name
  58180. */
  58181. getClassName(): string;
  58182. /**
  58183. * Gets the input component
  58184. */
  58185. readonly input: NodeMaterialConnectionPoint;
  58186. /**
  58187. * Gets the output component
  58188. */
  58189. readonly output: NodeMaterialConnectionPoint;
  58190. protected _buildBlock(state: NodeMaterialBuildState): this;
  58191. serialize(): any;
  58192. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  58193. protected _dumpPropertiesCode(): string;
  58194. }
  58195. }
  58196. declare module "babylonjs/Materials/Node/Blocks/colorMergerBlock" {
  58197. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58198. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58199. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58200. /**
  58201. * Block used to create a Color3/4 out of individual inputs (one for each component)
  58202. */
  58203. export class ColorMergerBlock extends NodeMaterialBlock {
  58204. /**
  58205. * Create a new ColorMergerBlock
  58206. * @param name defines the block name
  58207. */
  58208. constructor(name: string);
  58209. /**
  58210. * Gets the current class name
  58211. * @returns the class name
  58212. */
  58213. getClassName(): string;
  58214. /**
  58215. * Gets the r component (input)
  58216. */
  58217. readonly r: NodeMaterialConnectionPoint;
  58218. /**
  58219. * Gets the g component (input)
  58220. */
  58221. readonly g: NodeMaterialConnectionPoint;
  58222. /**
  58223. * Gets the b component (input)
  58224. */
  58225. readonly b: NodeMaterialConnectionPoint;
  58226. /**
  58227. * Gets the a component (input)
  58228. */
  58229. readonly a: NodeMaterialConnectionPoint;
  58230. /**
  58231. * Gets the rgba component (output)
  58232. */
  58233. readonly rgba: NodeMaterialConnectionPoint;
  58234. /**
  58235. * Gets the rgb component (output)
  58236. */
  58237. readonly rgb: NodeMaterialConnectionPoint;
  58238. protected _buildBlock(state: NodeMaterialBuildState): this;
  58239. }
  58240. }
  58241. declare module "babylonjs/Materials/Node/Blocks/vectorMergerBlock" {
  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 create a Vector2/3/4 out of individual inputs (one for each component)
  58247. */
  58248. export class VectorMergerBlock extends NodeMaterialBlock {
  58249. /**
  58250. * Create a new VectorMergerBlock
  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 x component (input)
  58261. */
  58262. readonly x: NodeMaterialConnectionPoint;
  58263. /**
  58264. * Gets the y component (input)
  58265. */
  58266. readonly y: NodeMaterialConnectionPoint;
  58267. /**
  58268. * Gets the z component (input)
  58269. */
  58270. readonly z: NodeMaterialConnectionPoint;
  58271. /**
  58272. * Gets the w component (input)
  58273. */
  58274. readonly w: NodeMaterialConnectionPoint;
  58275. /**
  58276. * Gets the xyzw component (output)
  58277. */
  58278. readonly xyzw: NodeMaterialConnectionPoint;
  58279. /**
  58280. * Gets the xyz component (output)
  58281. */
  58282. readonly xyz: NodeMaterialConnectionPoint;
  58283. /**
  58284. * Gets the xy component (output)
  58285. */
  58286. readonly xy: NodeMaterialConnectionPoint;
  58287. protected _buildBlock(state: NodeMaterialBuildState): this;
  58288. }
  58289. }
  58290. declare module "babylonjs/Materials/Node/Blocks/colorSplitterBlock" {
  58291. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58292. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58293. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58294. /**
  58295. * Block used to expand a Color3/4 into 4 outputs (one for each component)
  58296. */
  58297. export class ColorSplitterBlock extends NodeMaterialBlock {
  58298. /**
  58299. * Create a new ColorSplitterBlock
  58300. * @param name defines the block name
  58301. */
  58302. constructor(name: string);
  58303. /**
  58304. * Gets the current class name
  58305. * @returns the class name
  58306. */
  58307. getClassName(): string;
  58308. /**
  58309. * Gets the rgba component (input)
  58310. */
  58311. readonly rgba: NodeMaterialConnectionPoint;
  58312. /**
  58313. * Gets the rgb component (input)
  58314. */
  58315. readonly rgbIn: NodeMaterialConnectionPoint;
  58316. /**
  58317. * Gets the rgb component (output)
  58318. */
  58319. readonly rgbOut: NodeMaterialConnectionPoint;
  58320. /**
  58321. * Gets the r component (output)
  58322. */
  58323. readonly r: NodeMaterialConnectionPoint;
  58324. /**
  58325. * Gets the g component (output)
  58326. */
  58327. readonly g: NodeMaterialConnectionPoint;
  58328. /**
  58329. * Gets the b component (output)
  58330. */
  58331. readonly b: NodeMaterialConnectionPoint;
  58332. /**
  58333. * Gets the a component (output)
  58334. */
  58335. readonly a: NodeMaterialConnectionPoint;
  58336. protected _inputRename(name: string): string;
  58337. protected _outputRename(name: string): string;
  58338. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  58339. }
  58340. }
  58341. declare module "babylonjs/Materials/Node/Blocks/vectorSplitterBlock" {
  58342. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58343. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58344. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58345. /**
  58346. * Block used to expand a Vector3/4 into 4 outputs (one for each component)
  58347. */
  58348. export class VectorSplitterBlock extends NodeMaterialBlock {
  58349. /**
  58350. * Create a new VectorSplitterBlock
  58351. * @param name defines the block name
  58352. */
  58353. constructor(name: string);
  58354. /**
  58355. * Gets the current class name
  58356. * @returns the class name
  58357. */
  58358. getClassName(): string;
  58359. /**
  58360. * Gets the xyzw component (input)
  58361. */
  58362. readonly xyzw: NodeMaterialConnectionPoint;
  58363. /**
  58364. * Gets the xyz component (input)
  58365. */
  58366. readonly xyzIn: NodeMaterialConnectionPoint;
  58367. /**
  58368. * Gets the xy component (input)
  58369. */
  58370. readonly xyIn: NodeMaterialConnectionPoint;
  58371. /**
  58372. * Gets the xyz component (output)
  58373. */
  58374. readonly xyzOut: NodeMaterialConnectionPoint;
  58375. /**
  58376. * Gets the xy component (output)
  58377. */
  58378. readonly xyOut: NodeMaterialConnectionPoint;
  58379. /**
  58380. * Gets the x component (output)
  58381. */
  58382. readonly x: NodeMaterialConnectionPoint;
  58383. /**
  58384. * Gets the y component (output)
  58385. */
  58386. readonly y: NodeMaterialConnectionPoint;
  58387. /**
  58388. * Gets the z component (output)
  58389. */
  58390. readonly z: NodeMaterialConnectionPoint;
  58391. /**
  58392. * Gets the w component (output)
  58393. */
  58394. readonly w: NodeMaterialConnectionPoint;
  58395. protected _inputRename(name: string): string;
  58396. protected _outputRename(name: string): string;
  58397. protected _buildBlock(state: NodeMaterialBuildState): this;
  58398. }
  58399. }
  58400. declare module "babylonjs/Materials/Node/Blocks/lerpBlock" {
  58401. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58402. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58403. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58404. /**
  58405. * Block used to lerp between 2 values
  58406. */
  58407. export class LerpBlock extends NodeMaterialBlock {
  58408. /**
  58409. * Creates a new LerpBlock
  58410. * @param name defines the block name
  58411. */
  58412. constructor(name: string);
  58413. /**
  58414. * Gets the current class name
  58415. * @returns the class name
  58416. */
  58417. getClassName(): string;
  58418. /**
  58419. * Gets the left operand input component
  58420. */
  58421. readonly left: NodeMaterialConnectionPoint;
  58422. /**
  58423. * Gets the right operand input component
  58424. */
  58425. readonly right: NodeMaterialConnectionPoint;
  58426. /**
  58427. * Gets the gradient operand input component
  58428. */
  58429. readonly gradient: NodeMaterialConnectionPoint;
  58430. /**
  58431. * Gets the output component
  58432. */
  58433. readonly output: NodeMaterialConnectionPoint;
  58434. protected _buildBlock(state: NodeMaterialBuildState): this;
  58435. }
  58436. }
  58437. declare module "babylonjs/Materials/Node/Blocks/divideBlock" {
  58438. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58439. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58440. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58441. /**
  58442. * Block used to divide 2 vectors
  58443. */
  58444. export class DivideBlock extends NodeMaterialBlock {
  58445. /**
  58446. * Creates a new DivideBlock
  58447. * @param name defines the block name
  58448. */
  58449. constructor(name: string);
  58450. /**
  58451. * Gets the current class name
  58452. * @returns the class name
  58453. */
  58454. getClassName(): string;
  58455. /**
  58456. * Gets the left operand input component
  58457. */
  58458. readonly left: NodeMaterialConnectionPoint;
  58459. /**
  58460. * Gets the right operand input component
  58461. */
  58462. readonly right: NodeMaterialConnectionPoint;
  58463. /**
  58464. * Gets the output component
  58465. */
  58466. readonly output: NodeMaterialConnectionPoint;
  58467. protected _buildBlock(state: NodeMaterialBuildState): this;
  58468. }
  58469. }
  58470. declare module "babylonjs/Materials/Node/Blocks/subtractBlock" {
  58471. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58472. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58473. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58474. /**
  58475. * Block used to subtract 2 vectors
  58476. */
  58477. export class SubtractBlock extends NodeMaterialBlock {
  58478. /**
  58479. * Creates a new SubtractBlock
  58480. * @param name defines the block name
  58481. */
  58482. constructor(name: string);
  58483. /**
  58484. * Gets the current class name
  58485. * @returns the class name
  58486. */
  58487. getClassName(): string;
  58488. /**
  58489. * Gets the left operand input component
  58490. */
  58491. readonly left: NodeMaterialConnectionPoint;
  58492. /**
  58493. * Gets the right operand input component
  58494. */
  58495. readonly right: NodeMaterialConnectionPoint;
  58496. /**
  58497. * Gets the output component
  58498. */
  58499. readonly output: NodeMaterialConnectionPoint;
  58500. protected _buildBlock(state: NodeMaterialBuildState): this;
  58501. }
  58502. }
  58503. declare module "babylonjs/Materials/Node/Blocks/stepBlock" {
  58504. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58505. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58506. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58507. /**
  58508. * Block used to step a value
  58509. */
  58510. export class StepBlock extends NodeMaterialBlock {
  58511. /**
  58512. * Creates a new StepBlock
  58513. * @param name defines the block name
  58514. */
  58515. constructor(name: string);
  58516. /**
  58517. * Gets the current class name
  58518. * @returns the class name
  58519. */
  58520. getClassName(): string;
  58521. /**
  58522. * Gets the value operand input component
  58523. */
  58524. readonly value: NodeMaterialConnectionPoint;
  58525. /**
  58526. * Gets the edge operand input component
  58527. */
  58528. readonly edge: NodeMaterialConnectionPoint;
  58529. /**
  58530. * Gets the output component
  58531. */
  58532. readonly output: NodeMaterialConnectionPoint;
  58533. protected _buildBlock(state: NodeMaterialBuildState): this;
  58534. }
  58535. }
  58536. declare module "babylonjs/Materials/Node/Blocks/oneMinusBlock" {
  58537. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58538. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58539. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58540. /**
  58541. * Block used to get the opposite (1 - x) of a value
  58542. */
  58543. export class OneMinusBlock extends NodeMaterialBlock {
  58544. /**
  58545. * Creates a new OneMinusBlock
  58546. * @param name defines the block name
  58547. */
  58548. constructor(name: string);
  58549. /**
  58550. * Gets the current class name
  58551. * @returns the class name
  58552. */
  58553. getClassName(): string;
  58554. /**
  58555. * Gets the input component
  58556. */
  58557. readonly input: NodeMaterialConnectionPoint;
  58558. /**
  58559. * Gets the output component
  58560. */
  58561. readonly output: NodeMaterialConnectionPoint;
  58562. protected _buildBlock(state: NodeMaterialBuildState): this;
  58563. }
  58564. }
  58565. declare module "babylonjs/Materials/Node/Blocks/viewDirectionBlock" {
  58566. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58567. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58568. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58569. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  58570. /**
  58571. * Block used to get the view direction
  58572. */
  58573. export class ViewDirectionBlock extends NodeMaterialBlock {
  58574. /**
  58575. * Creates a new ViewDirectionBlock
  58576. * @param name defines the block name
  58577. */
  58578. constructor(name: string);
  58579. /**
  58580. * Gets the current class name
  58581. * @returns the class name
  58582. */
  58583. getClassName(): string;
  58584. /**
  58585. * Gets the world position component
  58586. */
  58587. readonly worldPosition: NodeMaterialConnectionPoint;
  58588. /**
  58589. * Gets the camera position component
  58590. */
  58591. readonly cameraPosition: NodeMaterialConnectionPoint;
  58592. /**
  58593. * Gets the output component
  58594. */
  58595. readonly output: NodeMaterialConnectionPoint;
  58596. autoConfigure(material: NodeMaterial): void;
  58597. protected _buildBlock(state: NodeMaterialBuildState): this;
  58598. }
  58599. }
  58600. declare module "babylonjs/Materials/Node/Blocks/fresnelBlock" {
  58601. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58602. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58603. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58604. import { NodeMaterial } from "babylonjs/Materials/Node/nodeMaterial";
  58605. import "babylonjs/Shaders/ShadersInclude/fresnelFunction";
  58606. /**
  58607. * Block used to compute fresnel value
  58608. */
  58609. export class FresnelBlock extends NodeMaterialBlock {
  58610. /**
  58611. * Create a new FresnelBlock
  58612. * @param name defines the block name
  58613. */
  58614. constructor(name: string);
  58615. /**
  58616. * Gets the current class name
  58617. * @returns the class name
  58618. */
  58619. getClassName(): string;
  58620. /**
  58621. * Gets the world normal input component
  58622. */
  58623. readonly worldNormal: NodeMaterialConnectionPoint;
  58624. /**
  58625. * Gets the view direction input component
  58626. */
  58627. readonly viewDirection: NodeMaterialConnectionPoint;
  58628. /**
  58629. * Gets the bias input component
  58630. */
  58631. readonly bias: NodeMaterialConnectionPoint;
  58632. /**
  58633. * Gets the camera (or eye) position component
  58634. */
  58635. readonly power: NodeMaterialConnectionPoint;
  58636. /**
  58637. * Gets the fresnel output component
  58638. */
  58639. readonly fresnel: NodeMaterialConnectionPoint;
  58640. autoConfigure(material: NodeMaterial): void;
  58641. protected _buildBlock(state: NodeMaterialBuildState): this;
  58642. }
  58643. }
  58644. declare module "babylonjs/Materials/Node/Blocks/maxBlock" {
  58645. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58646. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58647. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58648. /**
  58649. * Block used to get the max of 2 values
  58650. */
  58651. export class MaxBlock extends NodeMaterialBlock {
  58652. /**
  58653. * Creates a new MaxBlock
  58654. * @param name defines the block name
  58655. */
  58656. constructor(name: string);
  58657. /**
  58658. * Gets the current class name
  58659. * @returns the class name
  58660. */
  58661. getClassName(): string;
  58662. /**
  58663. * Gets the left operand input component
  58664. */
  58665. readonly left: NodeMaterialConnectionPoint;
  58666. /**
  58667. * Gets the right operand input component
  58668. */
  58669. readonly right: NodeMaterialConnectionPoint;
  58670. /**
  58671. * Gets the output component
  58672. */
  58673. readonly output: NodeMaterialConnectionPoint;
  58674. protected _buildBlock(state: NodeMaterialBuildState): this;
  58675. }
  58676. }
  58677. declare module "babylonjs/Materials/Node/Blocks/minBlock" {
  58678. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58679. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58680. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58681. /**
  58682. * Block used to get the min of 2 values
  58683. */
  58684. export class MinBlock extends NodeMaterialBlock {
  58685. /**
  58686. * Creates a new MinBlock
  58687. * @param name defines the block name
  58688. */
  58689. constructor(name: string);
  58690. /**
  58691. * Gets the current class name
  58692. * @returns the class name
  58693. */
  58694. getClassName(): string;
  58695. /**
  58696. * Gets the left operand input component
  58697. */
  58698. readonly left: NodeMaterialConnectionPoint;
  58699. /**
  58700. * Gets the right operand input component
  58701. */
  58702. readonly right: NodeMaterialConnectionPoint;
  58703. /**
  58704. * Gets the output component
  58705. */
  58706. readonly output: NodeMaterialConnectionPoint;
  58707. protected _buildBlock(state: NodeMaterialBuildState): this;
  58708. }
  58709. }
  58710. declare module "babylonjs/Materials/Node/Blocks/distanceBlock" {
  58711. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58712. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58713. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58714. /**
  58715. * Block used to get the distance between 2 values
  58716. */
  58717. export class DistanceBlock extends NodeMaterialBlock {
  58718. /**
  58719. * Creates a new DistanceBlock
  58720. * @param name defines the block name
  58721. */
  58722. constructor(name: string);
  58723. /**
  58724. * Gets the current class name
  58725. * @returns the class name
  58726. */
  58727. getClassName(): string;
  58728. /**
  58729. * Gets the left operand input component
  58730. */
  58731. readonly left: NodeMaterialConnectionPoint;
  58732. /**
  58733. * Gets the right operand input component
  58734. */
  58735. readonly right: NodeMaterialConnectionPoint;
  58736. /**
  58737. * Gets the output component
  58738. */
  58739. readonly output: NodeMaterialConnectionPoint;
  58740. protected _buildBlock(state: NodeMaterialBuildState): this;
  58741. }
  58742. }
  58743. declare module "babylonjs/Materials/Node/Blocks/lengthBlock" {
  58744. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58745. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58746. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58747. /**
  58748. * Block used to get the length of a vector
  58749. */
  58750. export class LengthBlock extends NodeMaterialBlock {
  58751. /**
  58752. * Creates a new LengthBlock
  58753. * @param name defines the block name
  58754. */
  58755. constructor(name: string);
  58756. /**
  58757. * Gets the current class name
  58758. * @returns the class name
  58759. */
  58760. getClassName(): string;
  58761. /**
  58762. * Gets the value input component
  58763. */
  58764. readonly value: NodeMaterialConnectionPoint;
  58765. /**
  58766. * Gets the output component
  58767. */
  58768. readonly output: NodeMaterialConnectionPoint;
  58769. protected _buildBlock(state: NodeMaterialBuildState): this;
  58770. }
  58771. }
  58772. declare module "babylonjs/Materials/Node/Blocks/negateBlock" {
  58773. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58774. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58775. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58776. /**
  58777. * Block used to get negative version of a value (i.e. x * -1)
  58778. */
  58779. export class NegateBlock extends NodeMaterialBlock {
  58780. /**
  58781. * Creates a new NegateBlock
  58782. * @param name defines the block name
  58783. */
  58784. constructor(name: string);
  58785. /**
  58786. * Gets the current class name
  58787. * @returns the class name
  58788. */
  58789. getClassName(): string;
  58790. /**
  58791. * Gets the value input component
  58792. */
  58793. readonly value: NodeMaterialConnectionPoint;
  58794. /**
  58795. * Gets the output component
  58796. */
  58797. readonly output: NodeMaterialConnectionPoint;
  58798. protected _buildBlock(state: NodeMaterialBuildState): this;
  58799. }
  58800. }
  58801. declare module "babylonjs/Materials/Node/Blocks/powBlock" {
  58802. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58803. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58804. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58805. /**
  58806. * Block used to get the value of the first parameter raised to the power of the second
  58807. */
  58808. export class PowBlock extends NodeMaterialBlock {
  58809. /**
  58810. * Creates a new PowBlock
  58811. * @param name defines the block name
  58812. */
  58813. constructor(name: string);
  58814. /**
  58815. * Gets the current class name
  58816. * @returns the class name
  58817. */
  58818. getClassName(): string;
  58819. /**
  58820. * Gets the value operand input component
  58821. */
  58822. readonly value: NodeMaterialConnectionPoint;
  58823. /**
  58824. * Gets the power operand input component
  58825. */
  58826. readonly power: NodeMaterialConnectionPoint;
  58827. /**
  58828. * Gets the output component
  58829. */
  58830. readonly output: NodeMaterialConnectionPoint;
  58831. protected _buildBlock(state: NodeMaterialBuildState): this;
  58832. }
  58833. }
  58834. declare module "babylonjs/Materials/Node/Blocks/randomNumberBlock" {
  58835. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58836. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58837. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58838. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  58839. /**
  58840. * Block used to get a random number
  58841. */
  58842. export class RandomNumberBlock extends NodeMaterialBlock {
  58843. /**
  58844. * Creates a new RandomNumberBlock
  58845. * @param name defines the block name
  58846. */
  58847. constructor(name: string);
  58848. /**
  58849. * Gets the current class name
  58850. * @returns the class name
  58851. */
  58852. getClassName(): string;
  58853. /**
  58854. * Gets the seed input component
  58855. */
  58856. readonly seed: NodeMaterialConnectionPoint;
  58857. /**
  58858. * Gets the output component
  58859. */
  58860. readonly output: NodeMaterialConnectionPoint;
  58861. protected _buildBlock(state: NodeMaterialBuildState): this;
  58862. }
  58863. }
  58864. declare module "babylonjs/Materials/Node/Blocks/arcTan2Block" {
  58865. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58866. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58867. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58868. /**
  58869. * Block used to compute arc tangent of 2 values
  58870. */
  58871. export class ArcTan2Block extends NodeMaterialBlock {
  58872. /**
  58873. * Creates a new ArcTan2Block
  58874. * @param name defines the block name
  58875. */
  58876. constructor(name: string);
  58877. /**
  58878. * Gets the current class name
  58879. * @returns the class name
  58880. */
  58881. getClassName(): string;
  58882. /**
  58883. * Gets the x operand input component
  58884. */
  58885. readonly x: NodeMaterialConnectionPoint;
  58886. /**
  58887. * Gets the y operand input component
  58888. */
  58889. readonly y: NodeMaterialConnectionPoint;
  58890. /**
  58891. * Gets the output component
  58892. */
  58893. readonly output: NodeMaterialConnectionPoint;
  58894. protected _buildBlock(state: NodeMaterialBuildState): this;
  58895. }
  58896. }
  58897. declare module "babylonjs/Materials/Node/Blocks/smoothStepBlock" {
  58898. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58899. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58900. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58901. /**
  58902. * Block used to smooth step a value
  58903. */
  58904. export class SmoothStepBlock extends NodeMaterialBlock {
  58905. /**
  58906. * Creates a new SmoothStepBlock
  58907. * @param name defines the block name
  58908. */
  58909. constructor(name: string);
  58910. /**
  58911. * Gets the current class name
  58912. * @returns the class name
  58913. */
  58914. getClassName(): string;
  58915. /**
  58916. * Gets the value operand input component
  58917. */
  58918. readonly value: NodeMaterialConnectionPoint;
  58919. /**
  58920. * Gets the first edge operand input component
  58921. */
  58922. readonly edge0: NodeMaterialConnectionPoint;
  58923. /**
  58924. * Gets the second edge operand input component
  58925. */
  58926. readonly edge1: NodeMaterialConnectionPoint;
  58927. /**
  58928. * Gets the output component
  58929. */
  58930. readonly output: NodeMaterialConnectionPoint;
  58931. protected _buildBlock(state: NodeMaterialBuildState): this;
  58932. }
  58933. }
  58934. declare module "babylonjs/Materials/Node/Blocks/reciprocalBlock" {
  58935. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58936. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58937. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58938. /**
  58939. * Block used to get the reciprocal (1 / x) of a value
  58940. */
  58941. export class ReciprocalBlock extends NodeMaterialBlock {
  58942. /**
  58943. * Creates a new ReciprocalBlock
  58944. * @param name defines the block name
  58945. */
  58946. constructor(name: string);
  58947. /**
  58948. * Gets the current class name
  58949. * @returns the class name
  58950. */
  58951. getClassName(): string;
  58952. /**
  58953. * Gets the input component
  58954. */
  58955. readonly input: NodeMaterialConnectionPoint;
  58956. /**
  58957. * Gets the output component
  58958. */
  58959. readonly output: NodeMaterialConnectionPoint;
  58960. protected _buildBlock(state: NodeMaterialBuildState): this;
  58961. }
  58962. }
  58963. declare module "babylonjs/Materials/Node/Blocks/replaceColorBlock" {
  58964. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  58965. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  58966. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  58967. /**
  58968. * Block used to replace a color by another one
  58969. */
  58970. export class ReplaceColorBlock extends NodeMaterialBlock {
  58971. /**
  58972. * Creates a new ReplaceColorBlock
  58973. * @param name defines the block name
  58974. */
  58975. constructor(name: string);
  58976. /**
  58977. * Gets the current class name
  58978. * @returns the class name
  58979. */
  58980. getClassName(): string;
  58981. /**
  58982. * Gets the value input component
  58983. */
  58984. readonly value: NodeMaterialConnectionPoint;
  58985. /**
  58986. * Gets the reference input component
  58987. */
  58988. readonly reference: NodeMaterialConnectionPoint;
  58989. /**
  58990. * Gets the distance input component
  58991. */
  58992. readonly distance: NodeMaterialConnectionPoint;
  58993. /**
  58994. * Gets the replacement input component
  58995. */
  58996. readonly replacement: NodeMaterialConnectionPoint;
  58997. /**
  58998. * Gets the output component
  58999. */
  59000. readonly output: NodeMaterialConnectionPoint;
  59001. protected _buildBlock(state: NodeMaterialBuildState): this;
  59002. }
  59003. }
  59004. declare module "babylonjs/Materials/Node/Blocks/posterizeBlock" {
  59005. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  59006. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  59007. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  59008. /**
  59009. * Block used to posterize a value
  59010. * @see https://en.wikipedia.org/wiki/Posterization
  59011. */
  59012. export class PosterizeBlock extends NodeMaterialBlock {
  59013. /**
  59014. * Creates a new PosterizeBlock
  59015. * @param name defines the block name
  59016. */
  59017. constructor(name: string);
  59018. /**
  59019. * Gets the current class name
  59020. * @returns the class name
  59021. */
  59022. getClassName(): string;
  59023. /**
  59024. * Gets the value input component
  59025. */
  59026. readonly value: NodeMaterialConnectionPoint;
  59027. /**
  59028. * Gets the steps input component
  59029. */
  59030. readonly steps: NodeMaterialConnectionPoint;
  59031. /**
  59032. * Gets the output component
  59033. */
  59034. readonly output: NodeMaterialConnectionPoint;
  59035. protected _buildBlock(state: NodeMaterialBuildState): this;
  59036. }
  59037. }
  59038. declare module "babylonjs/Materials/Node/Blocks/waveBlock" {
  59039. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  59040. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  59041. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  59042. import { Scene } from "babylonjs/scene";
  59043. /**
  59044. * Operations supported by the Wave block
  59045. */
  59046. export enum WaveBlockKind {
  59047. /** SawTooth */
  59048. SawTooth = 0,
  59049. /** Square */
  59050. Square = 1,
  59051. /** Triangle */
  59052. Triangle = 2
  59053. }
  59054. /**
  59055. * Block used to apply wave operation to floats
  59056. */
  59057. export class WaveBlock extends NodeMaterialBlock {
  59058. /**
  59059. * Gets or sets the kibnd of wave to be applied by the block
  59060. */
  59061. kind: WaveBlockKind;
  59062. /**
  59063. * Creates a new WaveBlock
  59064. * @param name defines the block name
  59065. */
  59066. constructor(name: string);
  59067. /**
  59068. * Gets the current class name
  59069. * @returns the class name
  59070. */
  59071. getClassName(): string;
  59072. /**
  59073. * Gets the input component
  59074. */
  59075. readonly input: NodeMaterialConnectionPoint;
  59076. /**
  59077. * Gets the output component
  59078. */
  59079. readonly output: NodeMaterialConnectionPoint;
  59080. protected _buildBlock(state: NodeMaterialBuildState): this;
  59081. serialize(): any;
  59082. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  59083. }
  59084. }
  59085. declare module "babylonjs/Materials/Node/Blocks/gradientBlock" {
  59086. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  59087. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  59088. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  59089. import { Color3 } from "babylonjs/Maths/math.color";
  59090. import { Scene } from "babylonjs/scene";
  59091. /**
  59092. * Class used to store a color step for the GradientBlock
  59093. */
  59094. export class GradientBlockColorStep {
  59095. /**
  59096. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  59097. */
  59098. step: number;
  59099. /**
  59100. * Gets or sets the color associated with this step
  59101. */
  59102. color: Color3;
  59103. /**
  59104. * Creates a new GradientBlockColorStep
  59105. * @param step defines a value indicating which step this color is associated with (between 0 and 1)
  59106. * @param color defines the color associated with this step
  59107. */
  59108. constructor(
  59109. /**
  59110. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  59111. */
  59112. step: number,
  59113. /**
  59114. * Gets or sets the color associated with this step
  59115. */
  59116. color: Color3);
  59117. }
  59118. /**
  59119. * Block used to return a color from a gradient based on an input value between 0 and 1
  59120. */
  59121. export class GradientBlock extends NodeMaterialBlock {
  59122. /**
  59123. * Gets or sets the list of color steps
  59124. */
  59125. colorSteps: GradientBlockColorStep[];
  59126. /**
  59127. * Creates a new GradientBlock
  59128. * @param name defines the block name
  59129. */
  59130. constructor(name: string);
  59131. /**
  59132. * Gets the current class name
  59133. * @returns the class name
  59134. */
  59135. getClassName(): string;
  59136. /**
  59137. * Gets the gradient input component
  59138. */
  59139. readonly gradient: NodeMaterialConnectionPoint;
  59140. /**
  59141. * Gets the output component
  59142. */
  59143. readonly output: NodeMaterialConnectionPoint;
  59144. private _writeColorConstant;
  59145. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  59146. serialize(): any;
  59147. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  59148. protected _dumpPropertiesCode(): string;
  59149. }
  59150. }
  59151. declare module "babylonjs/Materials/Node/Blocks/nLerpBlock" {
  59152. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  59153. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  59154. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  59155. /**
  59156. * Block used to normalize lerp between 2 values
  59157. */
  59158. export class NLerpBlock extends NodeMaterialBlock {
  59159. /**
  59160. * Creates a new NLerpBlock
  59161. * @param name defines the block name
  59162. */
  59163. constructor(name: string);
  59164. /**
  59165. * Gets the current class name
  59166. * @returns the class name
  59167. */
  59168. getClassName(): string;
  59169. /**
  59170. * Gets the left operand input component
  59171. */
  59172. readonly left: NodeMaterialConnectionPoint;
  59173. /**
  59174. * Gets the right operand input component
  59175. */
  59176. readonly right: NodeMaterialConnectionPoint;
  59177. /**
  59178. * Gets the gradient operand input component
  59179. */
  59180. readonly gradient: NodeMaterialConnectionPoint;
  59181. /**
  59182. * Gets the output component
  59183. */
  59184. readonly output: NodeMaterialConnectionPoint;
  59185. protected _buildBlock(state: NodeMaterialBuildState): this;
  59186. }
  59187. }
  59188. declare module "babylonjs/Materials/Node/Blocks/worleyNoise3DBlock" {
  59189. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  59190. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  59191. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  59192. import { Scene } from "babylonjs/scene";
  59193. /**
  59194. * block used to Generate a Worley Noise 3D Noise Pattern
  59195. */
  59196. export class WorleyNoise3DBlock extends NodeMaterialBlock {
  59197. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  59198. manhattanDistance: boolean;
  59199. /**
  59200. * Creates a new WorleyNoise3DBlock
  59201. * @param name defines the block name
  59202. */
  59203. constructor(name: string);
  59204. /**
  59205. * Gets the current class name
  59206. * @returns the class name
  59207. */
  59208. getClassName(): string;
  59209. /**
  59210. * Gets the position input component
  59211. */
  59212. readonly position: NodeMaterialConnectionPoint;
  59213. /**
  59214. * Gets the jitter input component
  59215. */
  59216. readonly jitter: NodeMaterialConnectionPoint;
  59217. /**
  59218. * Gets the output component
  59219. */
  59220. readonly output: NodeMaterialConnectionPoint;
  59221. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  59222. /**
  59223. * Exposes the properties to the UI?
  59224. */
  59225. protected _dumpPropertiesCode(): string;
  59226. /**
  59227. * Exposes the properties to the Seralize?
  59228. */
  59229. serialize(): any;
  59230. /**
  59231. * Exposes the properties to the deseralize?
  59232. */
  59233. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  59234. }
  59235. }
  59236. declare module "babylonjs/Materials/Node/Blocks/simplexPerlin3DBlock" {
  59237. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  59238. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  59239. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  59240. /**
  59241. * block used to Generate a Simplex Perlin 3d Noise Pattern
  59242. */
  59243. export class SimplexPerlin3DBlock extends NodeMaterialBlock {
  59244. /**
  59245. * Creates a new SimplexPerlin3DBlock
  59246. * @param name defines the block name
  59247. */
  59248. constructor(name: string);
  59249. /**
  59250. * Gets the current class name
  59251. * @returns the class name
  59252. */
  59253. getClassName(): string;
  59254. /**
  59255. * Gets the position operand input component
  59256. */
  59257. readonly position: NodeMaterialConnectionPoint;
  59258. /**
  59259. * Gets the output component
  59260. */
  59261. readonly output: NodeMaterialConnectionPoint;
  59262. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  59263. }
  59264. }
  59265. declare module "babylonjs/Materials/Node/Blocks/normalBlendBlock" {
  59266. import { NodeMaterialBlock } from "babylonjs/Materials/Node/nodeMaterialBlock";
  59267. import { NodeMaterialBuildState } from "babylonjs/Materials/Node/nodeMaterialBuildState";
  59268. import { NodeMaterialConnectionPoint } from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  59269. /**
  59270. * Block used to blend normals
  59271. */
  59272. export class NormalBlendBlock extends NodeMaterialBlock {
  59273. /**
  59274. * Creates a new NormalBlendBlock
  59275. * @param name defines the block name
  59276. */
  59277. constructor(name: string);
  59278. /**
  59279. * Gets the current class name
  59280. * @returns the class name
  59281. */
  59282. getClassName(): string;
  59283. /**
  59284. * Gets the first input component
  59285. */
  59286. readonly input0: NodeMaterialConnectionPoint;
  59287. /**
  59288. * Gets the second input component
  59289. */
  59290. readonly input1: NodeMaterialConnectionPoint;
  59291. /**
  59292. * Gets the output component
  59293. */
  59294. readonly output: NodeMaterialConnectionPoint;
  59295. protected _buildBlock(state: NodeMaterialBuildState): this;
  59296. }
  59297. }
  59298. declare module "babylonjs/Materials/Node/Blocks/index" {
  59299. export * from "babylonjs/Materials/Node/Blocks/Vertex/index";
  59300. export * from "babylonjs/Materials/Node/Blocks/Fragment/index";
  59301. export * from "babylonjs/Materials/Node/Blocks/Dual/index";
  59302. export * from "babylonjs/Materials/Node/Blocks/Input/index";
  59303. export * from "babylonjs/Materials/Node/Blocks/multiplyBlock";
  59304. export * from "babylonjs/Materials/Node/Blocks/addBlock";
  59305. export * from "babylonjs/Materials/Node/Blocks/scaleBlock";
  59306. export * from "babylonjs/Materials/Node/Blocks/clampBlock";
  59307. export * from "babylonjs/Materials/Node/Blocks/crossBlock";
  59308. export * from "babylonjs/Materials/Node/Blocks/dotBlock";
  59309. export * from "babylonjs/Materials/Node/Blocks/transformBlock";
  59310. export * from "babylonjs/Materials/Node/Blocks/remapBlock";
  59311. export * from "babylonjs/Materials/Node/Blocks/normalizeBlock";
  59312. export * from "babylonjs/Materials/Node/Blocks/trigonometryBlock";
  59313. export * from "babylonjs/Materials/Node/Blocks/colorMergerBlock";
  59314. export * from "babylonjs/Materials/Node/Blocks/vectorMergerBlock";
  59315. export * from "babylonjs/Materials/Node/Blocks/colorSplitterBlock";
  59316. export * from "babylonjs/Materials/Node/Blocks/vectorSplitterBlock";
  59317. export * from "babylonjs/Materials/Node/Blocks/lerpBlock";
  59318. export * from "babylonjs/Materials/Node/Blocks/divideBlock";
  59319. export * from "babylonjs/Materials/Node/Blocks/subtractBlock";
  59320. export * from "babylonjs/Materials/Node/Blocks/stepBlock";
  59321. export * from "babylonjs/Materials/Node/Blocks/oneMinusBlock";
  59322. export * from "babylonjs/Materials/Node/Blocks/viewDirectionBlock";
  59323. export * from "babylonjs/Materials/Node/Blocks/fresnelBlock";
  59324. export * from "babylonjs/Materials/Node/Blocks/maxBlock";
  59325. export * from "babylonjs/Materials/Node/Blocks/minBlock";
  59326. export * from "babylonjs/Materials/Node/Blocks/distanceBlock";
  59327. export * from "babylonjs/Materials/Node/Blocks/lengthBlock";
  59328. export * from "babylonjs/Materials/Node/Blocks/negateBlock";
  59329. export * from "babylonjs/Materials/Node/Blocks/powBlock";
  59330. export * from "babylonjs/Materials/Node/Blocks/randomNumberBlock";
  59331. export * from "babylonjs/Materials/Node/Blocks/arcTan2Block";
  59332. export * from "babylonjs/Materials/Node/Blocks/smoothStepBlock";
  59333. export * from "babylonjs/Materials/Node/Blocks/reciprocalBlock";
  59334. export * from "babylonjs/Materials/Node/Blocks/replaceColorBlock";
  59335. export * from "babylonjs/Materials/Node/Blocks/posterizeBlock";
  59336. export * from "babylonjs/Materials/Node/Blocks/waveBlock";
  59337. export * from "babylonjs/Materials/Node/Blocks/gradientBlock";
  59338. export * from "babylonjs/Materials/Node/Blocks/nLerpBlock";
  59339. export * from "babylonjs/Materials/Node/Blocks/worleyNoise3DBlock";
  59340. export * from "babylonjs/Materials/Node/Blocks/simplexPerlin3DBlock";
  59341. export * from "babylonjs/Materials/Node/Blocks/normalBlendBlock";
  59342. }
  59343. declare module "babylonjs/Materials/Node/Optimizers/index" {
  59344. export * from "babylonjs/Materials/Node/Optimizers/nodeMaterialOptimizer";
  59345. }
  59346. declare module "babylonjs/Materials/Node/index" {
  59347. export * from "babylonjs/Materials/Node/Enums/index";
  59348. export * from "babylonjs/Materials/Node/nodeMaterialBlockConnectionPoint";
  59349. export * from "babylonjs/Materials/Node/nodeMaterialBlock";
  59350. export * from "babylonjs/Materials/Node/nodeMaterial";
  59351. export * from "babylonjs/Materials/Node/Blocks/index";
  59352. export * from "babylonjs/Materials/Node/Optimizers/index";
  59353. }
  59354. declare module "babylonjs/Materials/effectRenderer" {
  59355. import { Nullable } from "babylonjs/types";
  59356. import { Texture } from "babylonjs/Materials/Textures/texture";
  59357. import { ThinEngine } from "babylonjs/Engines/thinEngine";
  59358. import { Viewport } from "babylonjs/Maths/math.viewport";
  59359. import { Observable } from "babylonjs/Misc/observable";
  59360. import { Effect } from "babylonjs/Materials/effect";
  59361. import "babylonjs/Engines/Extensions/engine.renderTarget";
  59362. import "babylonjs/Shaders/postprocess.vertex";
  59363. /**
  59364. * Effect Render Options
  59365. */
  59366. export interface IEffectRendererOptions {
  59367. /**
  59368. * Defines the vertices positions.
  59369. */
  59370. positions?: number[];
  59371. /**
  59372. * Defines the indices.
  59373. */
  59374. indices?: number[];
  59375. }
  59376. /**
  59377. * Helper class to render one or more effects
  59378. */
  59379. export class EffectRenderer {
  59380. private engine;
  59381. private static _DefaultOptions;
  59382. private _vertexBuffers;
  59383. private _indexBuffer;
  59384. private _ringBufferIndex;
  59385. private _ringScreenBuffer;
  59386. private _fullscreenViewport;
  59387. private _getNextFrameBuffer;
  59388. /**
  59389. * Creates an effect renderer
  59390. * @param engine the engine to use for rendering
  59391. * @param options defines the options of the effect renderer
  59392. */
  59393. constructor(engine: ThinEngine, options?: IEffectRendererOptions);
  59394. /**
  59395. * Sets the current viewport in normalized coordinates 0-1
  59396. * @param viewport Defines the viewport to set (defaults to 0 0 1 1)
  59397. */
  59398. setViewport(viewport?: Viewport): void;
  59399. /**
  59400. * Binds the embedded attributes buffer to the effect.
  59401. * @param effect Defines the effect to bind the attributes for
  59402. */
  59403. bindBuffers(effect: Effect): void;
  59404. /**
  59405. * Sets the current effect wrapper to use during draw.
  59406. * The effect needs to be ready before calling this api.
  59407. * This also sets the default full screen position attribute.
  59408. * @param effectWrapper Defines the effect to draw with
  59409. */
  59410. applyEffectWrapper(effectWrapper: EffectWrapper): void;
  59411. /**
  59412. * Draws a full screen quad.
  59413. */
  59414. draw(): void;
  59415. /**
  59416. * renders one or more effects to a specified texture
  59417. * @param effectWrappers list of effects to renderer
  59418. * @param outputTexture texture to draw to, if null it will render to the screen
  59419. */
  59420. render(effectWrappers: Array<EffectWrapper> | EffectWrapper, outputTexture?: Nullable<Texture>): void;
  59421. /**
  59422. * Disposes of the effect renderer
  59423. */
  59424. dispose(): void;
  59425. }
  59426. /**
  59427. * Options to create an EffectWrapper
  59428. */
  59429. interface EffectWrapperCreationOptions {
  59430. /**
  59431. * Engine to use to create the effect
  59432. */
  59433. engine: ThinEngine;
  59434. /**
  59435. * Fragment shader for the effect
  59436. */
  59437. fragmentShader: string;
  59438. /**
  59439. * Vertex shader for the effect
  59440. */
  59441. vertexShader?: string;
  59442. /**
  59443. * Attributes to use in the shader
  59444. */
  59445. attributeNames?: Array<string>;
  59446. /**
  59447. * Uniforms to use in the shader
  59448. */
  59449. uniformNames?: Array<string>;
  59450. /**
  59451. * Texture sampler names to use in the shader
  59452. */
  59453. samplerNames?: Array<string>;
  59454. /**
  59455. * The friendly name of the effect displayed in Spector.
  59456. */
  59457. name?: string;
  59458. }
  59459. /**
  59460. * Wraps an effect to be used for rendering
  59461. */
  59462. export class EffectWrapper {
  59463. /**
  59464. * Event that is fired right before the effect is drawn (should be used to update uniforms)
  59465. */
  59466. onApplyObservable: Observable<{}>;
  59467. /**
  59468. * The underlying effect
  59469. */
  59470. effect: Effect;
  59471. /**
  59472. * Creates an effect to be renderer
  59473. * @param creationOptions options to create the effect
  59474. */
  59475. constructor(creationOptions: EffectWrapperCreationOptions);
  59476. /**
  59477. * Disposes of the effect wrapper
  59478. */
  59479. dispose(): void;
  59480. }
  59481. }
  59482. declare module "babylonjs/Materials/index" {
  59483. export * from "babylonjs/Materials/Background/index";
  59484. export * from "babylonjs/Materials/colorCurves";
  59485. export * from "babylonjs/Materials/iEffectFallbacks";
  59486. export * from "babylonjs/Materials/effectFallbacks";
  59487. export * from "babylonjs/Materials/effect";
  59488. export * from "babylonjs/Materials/fresnelParameters";
  59489. export * from "babylonjs/Materials/imageProcessingConfiguration";
  59490. export * from "babylonjs/Materials/material";
  59491. export * from "babylonjs/Materials/materialDefines";
  59492. export * from "babylonjs/Materials/materialHelper";
  59493. export * from "babylonjs/Materials/multiMaterial";
  59494. export * from "babylonjs/Materials/PBR/index";
  59495. export * from "babylonjs/Materials/pushMaterial";
  59496. export * from "babylonjs/Materials/shaderMaterial";
  59497. export * from "babylonjs/Materials/standardMaterial";
  59498. export * from "babylonjs/Materials/Textures/index";
  59499. export * from "babylonjs/Materials/uniformBuffer";
  59500. export * from "babylonjs/Materials/materialFlags";
  59501. export * from "babylonjs/Materials/Node/index";
  59502. export * from "babylonjs/Materials/effectRenderer";
  59503. }
  59504. declare module "babylonjs/Maths/index" {
  59505. export * from "babylonjs/Maths/math.scalar";
  59506. export * from "babylonjs/Maths/math";
  59507. export * from "babylonjs/Maths/sphericalPolynomial";
  59508. }
  59509. declare module "babylonjs/Misc/workerPool" {
  59510. import { IDisposable } from "babylonjs/scene";
  59511. /**
  59512. * Helper class to push actions to a pool of workers.
  59513. */
  59514. export class WorkerPool implements IDisposable {
  59515. private _workerInfos;
  59516. private _pendingActions;
  59517. /**
  59518. * Constructor
  59519. * @param workers Array of workers to use for actions
  59520. */
  59521. constructor(workers: Array<Worker>);
  59522. /**
  59523. * Terminates all workers and clears any pending actions.
  59524. */
  59525. dispose(): void;
  59526. /**
  59527. * Pushes an action to the worker pool. If all the workers are active, the action will be
  59528. * pended until a worker has completed its action.
  59529. * @param action The action to perform. Call onComplete when the action is complete.
  59530. */
  59531. push(action: (worker: Worker, onComplete: () => void) => void): void;
  59532. private _execute;
  59533. }
  59534. }
  59535. declare module "babylonjs/Meshes/Compression/dracoCompression" {
  59536. import { IDisposable } from "babylonjs/scene";
  59537. import { VertexData } from "babylonjs/Meshes/mesh.vertexData";
  59538. /**
  59539. * Configuration for Draco compression
  59540. */
  59541. export interface IDracoCompressionConfiguration {
  59542. /**
  59543. * Configuration for the decoder.
  59544. */
  59545. decoder: {
  59546. /**
  59547. * The url to the WebAssembly module.
  59548. */
  59549. wasmUrl?: string;
  59550. /**
  59551. * The url to the WebAssembly binary.
  59552. */
  59553. wasmBinaryUrl?: string;
  59554. /**
  59555. * The url to the fallback JavaScript module.
  59556. */
  59557. fallbackUrl?: string;
  59558. };
  59559. }
  59560. /**
  59561. * Draco compression (https://google.github.io/draco/)
  59562. *
  59563. * This class wraps the Draco module.
  59564. *
  59565. * **Encoder**
  59566. *
  59567. * The encoder is not currently implemented.
  59568. *
  59569. * **Decoder**
  59570. *
  59571. * 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.
  59572. *
  59573. * To update the configuration, use the following code:
  59574. * ```javascript
  59575. * DracoCompression.Configuration = {
  59576. * decoder: {
  59577. * wasmUrl: "<url to the WebAssembly library>",
  59578. * wasmBinaryUrl: "<url to the WebAssembly binary>",
  59579. * fallbackUrl: "<url to the fallback JavaScript library>",
  59580. * }
  59581. * };
  59582. * ```
  59583. *
  59584. * 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.
  59585. * Decoding will automatically fallback to the JavaScript version if WebAssembly version is not configured or if WebAssembly is not supported by the browser.
  59586. * Use `DracoCompression.DecoderAvailable` to determine if the decoder configuration is available for the current context.
  59587. *
  59588. * To decode Draco compressed data, get the default DracoCompression object and call decodeMeshAsync:
  59589. * ```javascript
  59590. * var vertexData = await DracoCompression.Default.decodeMeshAsync(data);
  59591. * ```
  59592. *
  59593. * @see https://www.babylonjs-playground.com/#N3EK4B#0
  59594. */
  59595. export class DracoCompression implements IDisposable {
  59596. private _workerPoolPromise?;
  59597. private _decoderModulePromise?;
  59598. /**
  59599. * The configuration. Defaults to the following urls:
  59600. * - wasmUrl: "https://preview.babylonjs.com/draco_wasm_wrapper_gltf.js"
  59601. * - wasmBinaryUrl: "https://preview.babylonjs.com/draco_decoder_gltf.wasm"
  59602. * - fallbackUrl: "https://preview.babylonjs.com/draco_decoder_gltf.js"
  59603. */
  59604. static Configuration: IDracoCompressionConfiguration;
  59605. /**
  59606. * Returns true if the decoder configuration is available.
  59607. */
  59608. static readonly DecoderAvailable: boolean;
  59609. /**
  59610. * Default number of workers to create when creating the draco compression object.
  59611. */
  59612. static DefaultNumWorkers: number;
  59613. private static GetDefaultNumWorkers;
  59614. private static _Default;
  59615. /**
  59616. * Default instance for the draco compression object.
  59617. */
  59618. static readonly Default: DracoCompression;
  59619. /**
  59620. * Constructor
  59621. * @param numWorkers The number of workers for async operations. Specify `0` to disable web workers and run synchronously in the current context.
  59622. */
  59623. constructor(numWorkers?: number);
  59624. /**
  59625. * Stop all async operations and release resources.
  59626. */
  59627. dispose(): void;
  59628. /**
  59629. * Returns a promise that resolves when ready. Call this manually to ensure draco compression is ready before use.
  59630. * @returns a promise that resolves when ready
  59631. */
  59632. whenReadyAsync(): Promise<void>;
  59633. /**
  59634. * Decode Draco compressed mesh data to vertex data.
  59635. * @param data The ArrayBuffer or ArrayBufferView for the Draco compression data
  59636. * @param attributes A map of attributes from vertex buffer kinds to Draco unique ids
  59637. * @returns A promise that resolves with the decoded vertex data
  59638. */
  59639. decodeMeshAsync(data: ArrayBuffer | ArrayBufferView, attributes?: {
  59640. [kind: string]: number;
  59641. }): Promise<VertexData>;
  59642. }
  59643. }
  59644. declare module "babylonjs/Meshes/Compression/index" {
  59645. export * from "babylonjs/Meshes/Compression/dracoCompression";
  59646. }
  59647. declare module "babylonjs/Meshes/csg" {
  59648. import { Nullable } from "babylonjs/types";
  59649. import { Scene } from "babylonjs/scene";
  59650. import { Quaternion, Matrix, Vector3 } from "babylonjs/Maths/math.vector";
  59651. import { Mesh } from "babylonjs/Meshes/mesh";
  59652. import { Material } from "babylonjs/Materials/material";
  59653. /**
  59654. * Class for building Constructive Solid Geometry
  59655. */
  59656. export class CSG {
  59657. private polygons;
  59658. /**
  59659. * The world matrix
  59660. */
  59661. matrix: Matrix;
  59662. /**
  59663. * Stores the position
  59664. */
  59665. position: Vector3;
  59666. /**
  59667. * Stores the rotation
  59668. */
  59669. rotation: Vector3;
  59670. /**
  59671. * Stores the rotation quaternion
  59672. */
  59673. rotationQuaternion: Nullable<Quaternion>;
  59674. /**
  59675. * Stores the scaling vector
  59676. */
  59677. scaling: Vector3;
  59678. /**
  59679. * Convert the Mesh to CSG
  59680. * @param mesh The Mesh to convert to CSG
  59681. * @returns A new CSG from the Mesh
  59682. */
  59683. static FromMesh(mesh: Mesh): CSG;
  59684. /**
  59685. * Construct a CSG solid from a list of `CSG.Polygon` instances.
  59686. * @param polygons Polygons used to construct a CSG solid
  59687. */
  59688. private static FromPolygons;
  59689. /**
  59690. * Clones, or makes a deep copy, of the CSG
  59691. * @returns A new CSG
  59692. */
  59693. clone(): CSG;
  59694. /**
  59695. * Unions this CSG with another CSG
  59696. * @param csg The CSG to union against this CSG
  59697. * @returns The unioned CSG
  59698. */
  59699. union(csg: CSG): CSG;
  59700. /**
  59701. * Unions this CSG with another CSG in place
  59702. * @param csg The CSG to union against this CSG
  59703. */
  59704. unionInPlace(csg: CSG): void;
  59705. /**
  59706. * Subtracts this CSG with another CSG
  59707. * @param csg The CSG to subtract against this CSG
  59708. * @returns A new CSG
  59709. */
  59710. subtract(csg: CSG): CSG;
  59711. /**
  59712. * Subtracts this CSG with another CSG in place
  59713. * @param csg The CSG to subtact against this CSG
  59714. */
  59715. subtractInPlace(csg: CSG): void;
  59716. /**
  59717. * Intersect this CSG with another CSG
  59718. * @param csg The CSG to intersect against this CSG
  59719. * @returns A new CSG
  59720. */
  59721. intersect(csg: CSG): CSG;
  59722. /**
  59723. * Intersects this CSG with another CSG in place
  59724. * @param csg The CSG to intersect against this CSG
  59725. */
  59726. intersectInPlace(csg: CSG): void;
  59727. /**
  59728. * Return a new CSG solid with solid and empty space switched. This solid is
  59729. * not modified.
  59730. * @returns A new CSG solid with solid and empty space switched
  59731. */
  59732. inverse(): CSG;
  59733. /**
  59734. * Inverses the CSG in place
  59735. */
  59736. inverseInPlace(): void;
  59737. /**
  59738. * This is used to keep meshes transformations so they can be restored
  59739. * when we build back a Babylon Mesh
  59740. * NB : All CSG operations are performed in world coordinates
  59741. * @param csg The CSG to copy the transform attributes from
  59742. * @returns This CSG
  59743. */
  59744. copyTransformAttributes(csg: CSG): CSG;
  59745. /**
  59746. * Build Raw mesh from CSG
  59747. * Coordinates here are in world space
  59748. * @param name The name of the mesh geometry
  59749. * @param scene The Scene
  59750. * @param keepSubMeshes Specifies if the submeshes should be kept
  59751. * @returns A new Mesh
  59752. */
  59753. buildMeshGeometry(name: string, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  59754. /**
  59755. * Build Mesh from CSG taking material and transforms into account
  59756. * @param name The name of the Mesh
  59757. * @param material The material of the Mesh
  59758. * @param scene The Scene
  59759. * @param keepSubMeshes Specifies if submeshes should be kept
  59760. * @returns The new Mesh
  59761. */
  59762. toMesh(name: string, material?: Nullable<Material>, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  59763. }
  59764. }
  59765. declare module "babylonjs/Meshes/trailMesh" {
  59766. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  59767. import { Mesh } from "babylonjs/Meshes/mesh";
  59768. import { Scene } from "babylonjs/scene";
  59769. /**
  59770. * Class used to create a trail following a mesh
  59771. */
  59772. export class TrailMesh extends Mesh {
  59773. private _generator;
  59774. private _autoStart;
  59775. private _running;
  59776. private _diameter;
  59777. private _length;
  59778. private _sectionPolygonPointsCount;
  59779. private _sectionVectors;
  59780. private _sectionNormalVectors;
  59781. private _beforeRenderObserver;
  59782. /**
  59783. * @constructor
  59784. * @param name The value used by scene.getMeshByName() to do a lookup.
  59785. * @param generator The mesh to generate a trail.
  59786. * @param scene The scene to add this mesh to.
  59787. * @param diameter Diameter of trailing mesh. Default is 1.
  59788. * @param length Length of trailing mesh. Default is 60.
  59789. * @param autoStart Automatically start trailing mesh. Default true.
  59790. */
  59791. constructor(name: string, generator: AbstractMesh, scene: Scene, diameter?: number, length?: number, autoStart?: boolean);
  59792. /**
  59793. * "TrailMesh"
  59794. * @returns "TrailMesh"
  59795. */
  59796. getClassName(): string;
  59797. private _createMesh;
  59798. /**
  59799. * Start trailing mesh.
  59800. */
  59801. start(): void;
  59802. /**
  59803. * Stop trailing mesh.
  59804. */
  59805. stop(): void;
  59806. /**
  59807. * Update trailing mesh geometry.
  59808. */
  59809. update(): void;
  59810. /**
  59811. * Returns a new TrailMesh object.
  59812. * @param name is a string, the name given to the new mesh
  59813. * @param newGenerator use new generator object for cloned trail mesh
  59814. * @returns a new mesh
  59815. */
  59816. clone(name: string | undefined, newGenerator: AbstractMesh): TrailMesh;
  59817. /**
  59818. * Serializes this trail mesh
  59819. * @param serializationObject object to write serialization to
  59820. */
  59821. serialize(serializationObject: any): void;
  59822. /**
  59823. * Parses a serialized trail mesh
  59824. * @param parsedMesh the serialized mesh
  59825. * @param scene the scene to create the trail mesh in
  59826. * @returns the created trail mesh
  59827. */
  59828. static Parse(parsedMesh: any, scene: Scene): TrailMesh;
  59829. }
  59830. }
  59831. declare module "babylonjs/Meshes/Builders/tiledBoxBuilder" {
  59832. import { Nullable } from "babylonjs/types";
  59833. import { Scene } from "babylonjs/scene";
  59834. import { Vector4 } from "babylonjs/Maths/math.vector";
  59835. import { Color4 } from "babylonjs/Maths/math.color";
  59836. import { Mesh } from "babylonjs/Meshes/mesh";
  59837. /**
  59838. * Class containing static functions to help procedurally build meshes
  59839. */
  59840. export class TiledBoxBuilder {
  59841. /**
  59842. * Creates a box mesh
  59843. * 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)
  59844. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  59845. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  59846. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  59847. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  59848. * @param name defines the name of the mesh
  59849. * @param options defines the options used to create the mesh
  59850. * @param scene defines the hosting scene
  59851. * @returns the box mesh
  59852. */
  59853. static CreateTiledBox(name: string, options: {
  59854. pattern?: number;
  59855. width?: number;
  59856. height?: number;
  59857. depth?: number;
  59858. tileSize?: number;
  59859. tileWidth?: number;
  59860. tileHeight?: number;
  59861. alignHorizontal?: number;
  59862. alignVertical?: number;
  59863. faceUV?: Vector4[];
  59864. faceColors?: Color4[];
  59865. sideOrientation?: number;
  59866. updatable?: boolean;
  59867. }, scene?: Nullable<Scene>): Mesh;
  59868. }
  59869. }
  59870. declare module "babylonjs/Meshes/Builders/torusKnotBuilder" {
  59871. import { Vector4 } from "babylonjs/Maths/math.vector";
  59872. import { Mesh } from "babylonjs/Meshes/mesh";
  59873. /**
  59874. * Class containing static functions to help procedurally build meshes
  59875. */
  59876. export class TorusKnotBuilder {
  59877. /**
  59878. * Creates a torus knot mesh
  59879. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  59880. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  59881. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  59882. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  59883. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  59884. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  59885. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  59886. * @param name defines the name of the mesh
  59887. * @param options defines the options used to create the mesh
  59888. * @param scene defines the hosting scene
  59889. * @returns the torus knot mesh
  59890. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  59891. */
  59892. static CreateTorusKnot(name: string, options: {
  59893. radius?: number;
  59894. tube?: number;
  59895. radialSegments?: number;
  59896. tubularSegments?: number;
  59897. p?: number;
  59898. q?: number;
  59899. updatable?: boolean;
  59900. sideOrientation?: number;
  59901. frontUVs?: Vector4;
  59902. backUVs?: Vector4;
  59903. }, scene: any): Mesh;
  59904. }
  59905. }
  59906. declare module "babylonjs/Meshes/polygonMesh" {
  59907. import { Scene } from "babylonjs/scene";
  59908. import { Vector2 } from "babylonjs/Maths/math.vector";
  59909. import { Mesh } from "babylonjs/Meshes/mesh";
  59910. import { VertexData } from "babylonjs/Meshes/mesh.vertexData";
  59911. import { Path2 } from "babylonjs/Maths/math.path";
  59912. /**
  59913. * Polygon
  59914. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  59915. */
  59916. export class Polygon {
  59917. /**
  59918. * Creates a rectangle
  59919. * @param xmin bottom X coord
  59920. * @param ymin bottom Y coord
  59921. * @param xmax top X coord
  59922. * @param ymax top Y coord
  59923. * @returns points that make the resulting rectation
  59924. */
  59925. static Rectangle(xmin: number, ymin: number, xmax: number, ymax: number): Vector2[];
  59926. /**
  59927. * Creates a circle
  59928. * @param radius radius of circle
  59929. * @param cx scale in x
  59930. * @param cy scale in y
  59931. * @param numberOfSides number of sides that make up the circle
  59932. * @returns points that make the resulting circle
  59933. */
  59934. static Circle(radius: number, cx?: number, cy?: number, numberOfSides?: number): Vector2[];
  59935. /**
  59936. * Creates a polygon from input string
  59937. * @param input Input polygon data
  59938. * @returns the parsed points
  59939. */
  59940. static Parse(input: string): Vector2[];
  59941. /**
  59942. * Starts building a polygon from x and y coordinates
  59943. * @param x x coordinate
  59944. * @param y y coordinate
  59945. * @returns the started path2
  59946. */
  59947. static StartingAt(x: number, y: number): Path2;
  59948. }
  59949. /**
  59950. * Builds a polygon
  59951. * @see https://doc.babylonjs.com/how_to/polygonmeshbuilder
  59952. */
  59953. export class PolygonMeshBuilder {
  59954. private _points;
  59955. private _outlinepoints;
  59956. private _holes;
  59957. private _name;
  59958. private _scene;
  59959. private _epoints;
  59960. private _eholes;
  59961. private _addToepoint;
  59962. /**
  59963. * Babylon reference to the earcut plugin.
  59964. */
  59965. bjsEarcut: any;
  59966. /**
  59967. * Creates a PolygonMeshBuilder
  59968. * @param name name of the builder
  59969. * @param contours Path of the polygon
  59970. * @param scene scene to add to when creating the mesh
  59971. * @param earcutInjection can be used to inject your own earcut reference
  59972. */
  59973. constructor(name: string, contours: Path2 | Vector2[] | any, scene?: Scene, earcutInjection?: any);
  59974. /**
  59975. * Adds a whole within the polygon
  59976. * @param hole Array of points defining the hole
  59977. * @returns this
  59978. */
  59979. addHole(hole: Vector2[]): PolygonMeshBuilder;
  59980. /**
  59981. * Creates the polygon
  59982. * @param updatable If the mesh should be updatable
  59983. * @param depth The depth of the mesh created
  59984. * @returns the created mesh
  59985. */
  59986. build(updatable?: boolean, depth?: number): Mesh;
  59987. /**
  59988. * Creates the polygon
  59989. * @param depth The depth of the mesh created
  59990. * @returns the created VertexData
  59991. */
  59992. buildVertexData(depth?: number): VertexData;
  59993. /**
  59994. * Adds a side to the polygon
  59995. * @param positions points that make the polygon
  59996. * @param normals normals of the polygon
  59997. * @param uvs uvs of the polygon
  59998. * @param indices indices of the polygon
  59999. * @param bounds bounds of the polygon
  60000. * @param points points of the polygon
  60001. * @param depth depth of the polygon
  60002. * @param flip flip of the polygon
  60003. */
  60004. private addSide;
  60005. }
  60006. }
  60007. declare module "babylonjs/Meshes/Builders/polygonBuilder" {
  60008. import { Scene } from "babylonjs/scene";
  60009. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  60010. import { Color4 } from "babylonjs/Maths/math.color";
  60011. import { Mesh } from "babylonjs/Meshes/mesh";
  60012. import { Nullable } from "babylonjs/types";
  60013. /**
  60014. * Class containing static functions to help procedurally build meshes
  60015. */
  60016. export class PolygonBuilder {
  60017. /**
  60018. * Creates a polygon mesh
  60019. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  60020. * * 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
  60021. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  60022. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60023. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  60024. * * Remember you can only change the shape positions, not their number when updating a polygon
  60025. * @param name defines the name of the mesh
  60026. * @param options defines the options used to create the mesh
  60027. * @param scene defines the hosting scene
  60028. * @param earcutInjection can be used to inject your own earcut reference
  60029. * @returns the polygon mesh
  60030. */
  60031. static CreatePolygon(name: string, options: {
  60032. shape: Vector3[];
  60033. holes?: Vector3[][];
  60034. depth?: number;
  60035. faceUV?: Vector4[];
  60036. faceColors?: Color4[];
  60037. updatable?: boolean;
  60038. sideOrientation?: number;
  60039. frontUVs?: Vector4;
  60040. backUVs?: Vector4;
  60041. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  60042. /**
  60043. * Creates an extruded polygon mesh, with depth in the Y direction.
  60044. * * 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)
  60045. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  60046. * @param name defines the name of the mesh
  60047. * @param options defines the options used to create the mesh
  60048. * @param scene defines the hosting scene
  60049. * @param earcutInjection can be used to inject your own earcut reference
  60050. * @returns the polygon mesh
  60051. */
  60052. static ExtrudePolygon(name: string, options: {
  60053. shape: Vector3[];
  60054. holes?: Vector3[][];
  60055. depth?: number;
  60056. faceUV?: Vector4[];
  60057. faceColors?: Color4[];
  60058. updatable?: boolean;
  60059. sideOrientation?: number;
  60060. frontUVs?: Vector4;
  60061. backUVs?: Vector4;
  60062. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  60063. }
  60064. }
  60065. declare module "babylonjs/Meshes/Builders/latheBuilder" {
  60066. import { Scene } from "babylonjs/scene";
  60067. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  60068. import { Mesh } from "babylonjs/Meshes/mesh";
  60069. import { Nullable } from "babylonjs/types";
  60070. /**
  60071. * Class containing static functions to help procedurally build meshes
  60072. */
  60073. export class LatheBuilder {
  60074. /**
  60075. * Creates lathe mesh.
  60076. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  60077. * * 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
  60078. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  60079. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  60080. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  60081. * * 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
  60082. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  60083. * * 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
  60084. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  60085. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60086. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  60087. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60088. * @param name defines the name of the mesh
  60089. * @param options defines the options used to create the mesh
  60090. * @param scene defines the hosting scene
  60091. * @returns the lathe mesh
  60092. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  60093. */
  60094. static CreateLathe(name: string, options: {
  60095. shape: Vector3[];
  60096. radius?: number;
  60097. tessellation?: number;
  60098. clip?: number;
  60099. arc?: number;
  60100. closed?: boolean;
  60101. updatable?: boolean;
  60102. sideOrientation?: number;
  60103. frontUVs?: Vector4;
  60104. backUVs?: Vector4;
  60105. cap?: number;
  60106. invertUV?: boolean;
  60107. }, scene?: Nullable<Scene>): Mesh;
  60108. }
  60109. }
  60110. declare module "babylonjs/Meshes/Builders/tiledPlaneBuilder" {
  60111. import { Nullable } from "babylonjs/types";
  60112. import { Scene } from "babylonjs/scene";
  60113. import { Vector4 } from "babylonjs/Maths/math.vector";
  60114. import { Mesh } from "babylonjs/Meshes/mesh";
  60115. /**
  60116. * Class containing static functions to help procedurally build meshes
  60117. */
  60118. export class TiledPlaneBuilder {
  60119. /**
  60120. * Creates a tiled plane mesh
  60121. * * The parameter `pattern` will, depending on value, do nothing or
  60122. * * * flip (reflect about central vertical) alternate tiles across and up
  60123. * * * flip every tile on alternate rows
  60124. * * * rotate (180 degs) alternate tiles across and up
  60125. * * * rotate every tile on alternate rows
  60126. * * * flip and rotate alternate tiles across and up
  60127. * * * flip and rotate every tile on alternate rows
  60128. * * The parameter `tileSize` sets the size (float) of each tile side (default 1)
  60129. * * You can set some different tile dimensions by using the parameters `tileWidth` and `tileHeight` (both by default have the same value of `tileSize`)
  60130. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60131. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  60132. * * 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)
  60133. * * 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)
  60134. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  60135. * @param name defines the name of the mesh
  60136. * @param options defines the options used to create the mesh
  60137. * @param scene defines the hosting scene
  60138. * @returns the box mesh
  60139. */
  60140. static CreateTiledPlane(name: string, options: {
  60141. pattern?: number;
  60142. tileSize?: number;
  60143. tileWidth?: number;
  60144. tileHeight?: number;
  60145. size?: number;
  60146. width?: number;
  60147. height?: number;
  60148. alignHorizontal?: number;
  60149. alignVertical?: number;
  60150. sideOrientation?: number;
  60151. frontUVs?: Vector4;
  60152. backUVs?: Vector4;
  60153. updatable?: boolean;
  60154. }, scene?: Nullable<Scene>): Mesh;
  60155. }
  60156. }
  60157. declare module "babylonjs/Meshes/Builders/tubeBuilder" {
  60158. import { Nullable } from "babylonjs/types";
  60159. import { Scene } from "babylonjs/scene";
  60160. import { Vector3, Vector4 } from "babylonjs/Maths/math.vector";
  60161. import { Mesh } from "babylonjs/Meshes/mesh";
  60162. /**
  60163. * Class containing static functions to help procedurally build meshes
  60164. */
  60165. export class TubeBuilder {
  60166. /**
  60167. * Creates a tube mesh.
  60168. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  60169. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  60170. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  60171. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  60172. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  60173. * * 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)
  60174. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  60175. * * 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
  60176. * * 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
  60177. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  60178. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60179. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  60180. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60181. * @param name defines the name of the mesh
  60182. * @param options defines the options used to create the mesh
  60183. * @param scene defines the hosting scene
  60184. * @returns the tube mesh
  60185. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  60186. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  60187. */
  60188. static CreateTube(name: string, options: {
  60189. path: Vector3[];
  60190. radius?: number;
  60191. tessellation?: number;
  60192. radiusFunction?: {
  60193. (i: number, distance: number): number;
  60194. };
  60195. cap?: number;
  60196. arc?: number;
  60197. updatable?: boolean;
  60198. sideOrientation?: number;
  60199. frontUVs?: Vector4;
  60200. backUVs?: Vector4;
  60201. instance?: Mesh;
  60202. invertUV?: boolean;
  60203. }, scene?: Nullable<Scene>): Mesh;
  60204. }
  60205. }
  60206. declare module "babylonjs/Meshes/Builders/icoSphereBuilder" {
  60207. import { Scene } from "babylonjs/scene";
  60208. import { Vector4 } from "babylonjs/Maths/math.vector";
  60209. import { Mesh } from "babylonjs/Meshes/mesh";
  60210. import { Nullable } from "babylonjs/types";
  60211. /**
  60212. * Class containing static functions to help procedurally build meshes
  60213. */
  60214. export class IcoSphereBuilder {
  60215. /**
  60216. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  60217. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  60218. * * 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`)
  60219. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  60220. * * 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
  60221. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  60222. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60223. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60224. * @param name defines the name of the mesh
  60225. * @param options defines the options used to create the mesh
  60226. * @param scene defines the hosting scene
  60227. * @returns the icosahedron mesh
  60228. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  60229. */
  60230. static CreateIcoSphere(name: string, options: {
  60231. radius?: number;
  60232. radiusX?: number;
  60233. radiusY?: number;
  60234. radiusZ?: number;
  60235. flat?: boolean;
  60236. subdivisions?: number;
  60237. sideOrientation?: number;
  60238. frontUVs?: Vector4;
  60239. backUVs?: Vector4;
  60240. updatable?: boolean;
  60241. }, scene?: Nullable<Scene>): Mesh;
  60242. }
  60243. }
  60244. declare module "babylonjs/Meshes/Builders/decalBuilder" {
  60245. import { Vector3 } from "babylonjs/Maths/math.vector";
  60246. import { Mesh } from "babylonjs/Meshes/mesh";
  60247. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  60248. /**
  60249. * Class containing static functions to help procedurally build meshes
  60250. */
  60251. export class DecalBuilder {
  60252. /**
  60253. * Creates a decal mesh.
  60254. * 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
  60255. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  60256. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  60257. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  60258. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  60259. * @param name defines the name of the mesh
  60260. * @param sourceMesh defines the mesh where the decal must be applied
  60261. * @param options defines the options used to create the mesh
  60262. * @param scene defines the hosting scene
  60263. * @returns the decal mesh
  60264. * @see https://doc.babylonjs.com/how_to/decals
  60265. */
  60266. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  60267. position?: Vector3;
  60268. normal?: Vector3;
  60269. size?: Vector3;
  60270. angle?: number;
  60271. }): Mesh;
  60272. }
  60273. }
  60274. declare module "babylonjs/Meshes/meshBuilder" {
  60275. import { Vector4, Vector3, Vector2 } from "babylonjs/Maths/math.vector";
  60276. import { Nullable } from "babylonjs/types";
  60277. import { Scene } from "babylonjs/scene";
  60278. import { Mesh } from "babylonjs/Meshes/mesh";
  60279. import { LinesMesh } from "babylonjs/Meshes/linesMesh";
  60280. import { GroundMesh } from "babylonjs/Meshes/groundMesh";
  60281. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  60282. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  60283. import { Plane } from "babylonjs/Maths/math.plane";
  60284. /**
  60285. * Class containing static functions to help procedurally build meshes
  60286. */
  60287. export class MeshBuilder {
  60288. /**
  60289. * Creates a box mesh
  60290. * * The parameter `size` sets the size (float) of each box side (default 1)
  60291. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  60292. * * 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)
  60293. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  60294. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  60295. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60296. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60297. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  60298. * @param name defines the name of the mesh
  60299. * @param options defines the options used to create the mesh
  60300. * @param scene defines the hosting scene
  60301. * @returns the box mesh
  60302. */
  60303. static CreateBox(name: string, options: {
  60304. size?: number;
  60305. width?: number;
  60306. height?: number;
  60307. depth?: number;
  60308. faceUV?: Vector4[];
  60309. faceColors?: Color4[];
  60310. sideOrientation?: number;
  60311. frontUVs?: Vector4;
  60312. backUVs?: Vector4;
  60313. updatable?: boolean;
  60314. }, scene?: Nullable<Scene>): Mesh;
  60315. /**
  60316. * Creates a tiled box mesh
  60317. * * faceTiles sets the pattern, tile size and number of tiles for a face
  60318. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60319. * @param name defines the name of the mesh
  60320. * @param options defines the options used to create the mesh
  60321. * @param scene defines the hosting scene
  60322. * @returns the tiled box mesh
  60323. */
  60324. static CreateTiledBox(name: string, options: {
  60325. pattern?: number;
  60326. size?: number;
  60327. width?: number;
  60328. height?: number;
  60329. depth: number;
  60330. tileSize?: number;
  60331. tileWidth?: number;
  60332. tileHeight?: number;
  60333. faceUV?: Vector4[];
  60334. faceColors?: Color4[];
  60335. alignHorizontal?: number;
  60336. alignVertical?: number;
  60337. sideOrientation?: number;
  60338. updatable?: boolean;
  60339. }, scene?: Nullable<Scene>): Mesh;
  60340. /**
  60341. * Creates a sphere mesh
  60342. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  60343. * * 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`)
  60344. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  60345. * * 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
  60346. * * 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)
  60347. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  60348. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60349. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60350. * @param name defines the name of the mesh
  60351. * @param options defines the options used to create the mesh
  60352. * @param scene defines the hosting scene
  60353. * @returns the sphere mesh
  60354. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  60355. */
  60356. static CreateSphere(name: string, options: {
  60357. segments?: number;
  60358. diameter?: number;
  60359. diameterX?: number;
  60360. diameterY?: number;
  60361. diameterZ?: number;
  60362. arc?: number;
  60363. slice?: number;
  60364. sideOrientation?: number;
  60365. frontUVs?: Vector4;
  60366. backUVs?: Vector4;
  60367. updatable?: boolean;
  60368. }, scene?: Nullable<Scene>): Mesh;
  60369. /**
  60370. * Creates a plane polygonal mesh. By default, this is a disc
  60371. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  60372. * * 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
  60373. * * 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
  60374. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  60375. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60376. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60377. * @param name defines the name of the mesh
  60378. * @param options defines the options used to create the mesh
  60379. * @param scene defines the hosting scene
  60380. * @returns the plane polygonal mesh
  60381. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  60382. */
  60383. static CreateDisc(name: string, options: {
  60384. radius?: number;
  60385. tessellation?: number;
  60386. arc?: number;
  60387. updatable?: boolean;
  60388. sideOrientation?: number;
  60389. frontUVs?: Vector4;
  60390. backUVs?: Vector4;
  60391. }, scene?: Nullable<Scene>): Mesh;
  60392. /**
  60393. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  60394. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  60395. * * 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`)
  60396. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  60397. * * 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
  60398. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  60399. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60400. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60401. * @param name defines the name of the mesh
  60402. * @param options defines the options used to create the mesh
  60403. * @param scene defines the hosting scene
  60404. * @returns the icosahedron mesh
  60405. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  60406. */
  60407. static CreateIcoSphere(name: string, options: {
  60408. radius?: number;
  60409. radiusX?: number;
  60410. radiusY?: number;
  60411. radiusZ?: number;
  60412. flat?: boolean;
  60413. subdivisions?: number;
  60414. sideOrientation?: number;
  60415. frontUVs?: Vector4;
  60416. backUVs?: Vector4;
  60417. updatable?: boolean;
  60418. }, scene?: Nullable<Scene>): Mesh;
  60419. /**
  60420. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  60421. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  60422. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  60423. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  60424. * * 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
  60425. * * 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
  60426. * * 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
  60427. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  60428. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60429. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  60430. * * 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
  60431. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  60432. * * 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
  60433. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  60434. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60435. * @param name defines the name of the mesh
  60436. * @param options defines the options used to create the mesh
  60437. * @param scene defines the hosting scene
  60438. * @returns the ribbon mesh
  60439. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  60440. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  60441. */
  60442. static CreateRibbon(name: string, options: {
  60443. pathArray: Vector3[][];
  60444. closeArray?: boolean;
  60445. closePath?: boolean;
  60446. offset?: number;
  60447. updatable?: boolean;
  60448. sideOrientation?: number;
  60449. frontUVs?: Vector4;
  60450. backUVs?: Vector4;
  60451. instance?: Mesh;
  60452. invertUV?: boolean;
  60453. uvs?: Vector2[];
  60454. colors?: Color4[];
  60455. }, scene?: Nullable<Scene>): Mesh;
  60456. /**
  60457. * Creates a cylinder or a cone mesh
  60458. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  60459. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  60460. * * 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.
  60461. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  60462. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  60463. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  60464. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  60465. * * 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).
  60466. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  60467. * * 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).
  60468. * * 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
  60469. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  60470. * * 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
  60471. * * 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.
  60472. * * If `enclose` is false, a ring surface is one element.
  60473. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  60474. * * 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
  60475. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  60476. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60477. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  60478. * @param name defines the name of the mesh
  60479. * @param options defines the options used to create the mesh
  60480. * @param scene defines the hosting scene
  60481. * @returns the cylinder mesh
  60482. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  60483. */
  60484. static CreateCylinder(name: string, options: {
  60485. height?: number;
  60486. diameterTop?: number;
  60487. diameterBottom?: number;
  60488. diameter?: number;
  60489. tessellation?: number;
  60490. subdivisions?: number;
  60491. arc?: number;
  60492. faceColors?: Color4[];
  60493. faceUV?: Vector4[];
  60494. updatable?: boolean;
  60495. hasRings?: boolean;
  60496. enclose?: boolean;
  60497. cap?: number;
  60498. sideOrientation?: number;
  60499. frontUVs?: Vector4;
  60500. backUVs?: Vector4;
  60501. }, scene?: Nullable<Scene>): Mesh;
  60502. /**
  60503. * Creates a torus mesh
  60504. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  60505. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  60506. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  60507. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  60508. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60509. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  60510. * @param name defines the name of the mesh
  60511. * @param options defines the options used to create the mesh
  60512. * @param scene defines the hosting scene
  60513. * @returns the torus mesh
  60514. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  60515. */
  60516. static CreateTorus(name: string, options: {
  60517. diameter?: number;
  60518. thickness?: number;
  60519. tessellation?: number;
  60520. updatable?: boolean;
  60521. sideOrientation?: number;
  60522. frontUVs?: Vector4;
  60523. backUVs?: Vector4;
  60524. }, scene?: Nullable<Scene>): Mesh;
  60525. /**
  60526. * Creates a torus knot mesh
  60527. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  60528. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  60529. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  60530. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  60531. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  60532. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60533. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  60534. * @param name defines the name of the mesh
  60535. * @param options defines the options used to create the mesh
  60536. * @param scene defines the hosting scene
  60537. * @returns the torus knot mesh
  60538. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  60539. */
  60540. static CreateTorusKnot(name: string, options: {
  60541. radius?: number;
  60542. tube?: number;
  60543. radialSegments?: number;
  60544. tubularSegments?: number;
  60545. p?: number;
  60546. q?: number;
  60547. updatable?: boolean;
  60548. sideOrientation?: number;
  60549. frontUVs?: Vector4;
  60550. backUVs?: Vector4;
  60551. }, scene?: Nullable<Scene>): Mesh;
  60552. /**
  60553. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  60554. * * 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
  60555. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  60556. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  60557. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  60558. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  60559. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  60560. * * 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
  60561. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  60562. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60563. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  60564. * @param name defines the name of the new line system
  60565. * @param options defines the options used to create the line system
  60566. * @param scene defines the hosting scene
  60567. * @returns a new line system mesh
  60568. */
  60569. static CreateLineSystem(name: string, options: {
  60570. lines: Vector3[][];
  60571. updatable?: boolean;
  60572. instance?: Nullable<LinesMesh>;
  60573. colors?: Nullable<Color4[][]>;
  60574. useVertexAlpha?: boolean;
  60575. }, scene: Nullable<Scene>): LinesMesh;
  60576. /**
  60577. * Creates a line mesh
  60578. * 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
  60579. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  60580. * * The parameter `points` is an array successive Vector3
  60581. * * 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
  60582. * * The optional parameter `colors` is an array of successive Color4, one per line point
  60583. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  60584. * * When updating an instance, remember that only point positions can change, not the number of points
  60585. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60586. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  60587. * @param name defines the name of the new line system
  60588. * @param options defines the options used to create the line system
  60589. * @param scene defines the hosting scene
  60590. * @returns a new line mesh
  60591. */
  60592. static CreateLines(name: string, options: {
  60593. points: Vector3[];
  60594. updatable?: boolean;
  60595. instance?: Nullable<LinesMesh>;
  60596. colors?: Color4[];
  60597. useVertexAlpha?: boolean;
  60598. }, scene?: Nullable<Scene>): LinesMesh;
  60599. /**
  60600. * Creates a dashed line mesh
  60601. * * 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
  60602. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  60603. * * The parameter `points` is an array successive Vector3
  60604. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  60605. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  60606. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  60607. * * 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
  60608. * * When updating an instance, remember that only point positions can change, not the number of points
  60609. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60610. * @param name defines the name of the mesh
  60611. * @param options defines the options used to create the mesh
  60612. * @param scene defines the hosting scene
  60613. * @returns the dashed line mesh
  60614. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  60615. */
  60616. static CreateDashedLines(name: string, options: {
  60617. points: Vector3[];
  60618. dashSize?: number;
  60619. gapSize?: number;
  60620. dashNb?: number;
  60621. updatable?: boolean;
  60622. instance?: LinesMesh;
  60623. }, scene?: Nullable<Scene>): LinesMesh;
  60624. /**
  60625. * 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.
  60626. * * 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.
  60627. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  60628. * * 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.
  60629. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  60630. * * 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
  60631. * * 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
  60632. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  60633. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  60634. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60635. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  60636. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  60637. * @param name defines the name of the mesh
  60638. * @param options defines the options used to create the mesh
  60639. * @param scene defines the hosting scene
  60640. * @returns the extruded shape mesh
  60641. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  60642. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  60643. */
  60644. static ExtrudeShape(name: string, options: {
  60645. shape: Vector3[];
  60646. path: Vector3[];
  60647. scale?: number;
  60648. rotation?: number;
  60649. cap?: number;
  60650. updatable?: boolean;
  60651. sideOrientation?: number;
  60652. frontUVs?: Vector4;
  60653. backUVs?: Vector4;
  60654. instance?: Mesh;
  60655. invertUV?: boolean;
  60656. }, scene?: Nullable<Scene>): Mesh;
  60657. /**
  60658. * Creates an custom extruded shape mesh.
  60659. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  60660. * * 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.
  60661. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  60662. * * 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
  60663. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  60664. * * 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
  60665. * * It must returns a float value that will be the scale value applied to the shape on each path point
  60666. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  60667. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  60668. * * 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
  60669. * * 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
  60670. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  60671. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  60672. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60673. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  60674. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60675. * @param name defines the name of the mesh
  60676. * @param options defines the options used to create the mesh
  60677. * @param scene defines the hosting scene
  60678. * @returns the custom extruded shape mesh
  60679. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  60680. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  60681. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  60682. */
  60683. static ExtrudeShapeCustom(name: string, options: {
  60684. shape: Vector3[];
  60685. path: Vector3[];
  60686. scaleFunction?: any;
  60687. rotationFunction?: any;
  60688. ribbonCloseArray?: boolean;
  60689. ribbonClosePath?: boolean;
  60690. cap?: number;
  60691. updatable?: boolean;
  60692. sideOrientation?: number;
  60693. frontUVs?: Vector4;
  60694. backUVs?: Vector4;
  60695. instance?: Mesh;
  60696. invertUV?: boolean;
  60697. }, scene?: Nullable<Scene>): Mesh;
  60698. /**
  60699. * Creates lathe mesh.
  60700. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  60701. * * 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
  60702. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  60703. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  60704. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  60705. * * 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
  60706. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  60707. * * 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
  60708. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  60709. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60710. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  60711. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60712. * @param name defines the name of the mesh
  60713. * @param options defines the options used to create the mesh
  60714. * @param scene defines the hosting scene
  60715. * @returns the lathe mesh
  60716. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  60717. */
  60718. static CreateLathe(name: string, options: {
  60719. shape: Vector3[];
  60720. radius?: number;
  60721. tessellation?: number;
  60722. clip?: number;
  60723. arc?: number;
  60724. closed?: boolean;
  60725. updatable?: boolean;
  60726. sideOrientation?: number;
  60727. frontUVs?: Vector4;
  60728. backUVs?: Vector4;
  60729. cap?: number;
  60730. invertUV?: boolean;
  60731. }, scene?: Nullable<Scene>): Mesh;
  60732. /**
  60733. * Creates a tiled plane mesh
  60734. * * You can set a limited pattern arrangement with the tiles
  60735. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  60736. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60737. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60738. * @param name defines the name of the mesh
  60739. * @param options defines the options used to create the mesh
  60740. * @param scene defines the hosting scene
  60741. * @returns the plane mesh
  60742. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  60743. */
  60744. static CreateTiledPlane(name: string, options: {
  60745. pattern?: number;
  60746. tileSize?: number;
  60747. tileWidth?: number;
  60748. tileHeight?: number;
  60749. size?: number;
  60750. width?: number;
  60751. height?: number;
  60752. alignHorizontal?: number;
  60753. alignVertical?: number;
  60754. sideOrientation?: number;
  60755. frontUVs?: Vector4;
  60756. backUVs?: Vector4;
  60757. updatable?: boolean;
  60758. }, scene?: Nullable<Scene>): Mesh;
  60759. /**
  60760. * Creates a plane mesh
  60761. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  60762. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  60763. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  60764. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  60765. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60766. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60767. * @param name defines the name of the mesh
  60768. * @param options defines the options used to create the mesh
  60769. * @param scene defines the hosting scene
  60770. * @returns the plane mesh
  60771. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  60772. */
  60773. static CreatePlane(name: string, options: {
  60774. size?: number;
  60775. width?: number;
  60776. height?: number;
  60777. sideOrientation?: number;
  60778. frontUVs?: Vector4;
  60779. backUVs?: Vector4;
  60780. updatable?: boolean;
  60781. sourcePlane?: Plane;
  60782. }, scene?: Nullable<Scene>): Mesh;
  60783. /**
  60784. * Creates a ground mesh
  60785. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  60786. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  60787. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60788. * @param name defines the name of the mesh
  60789. * @param options defines the options used to create the mesh
  60790. * @param scene defines the hosting scene
  60791. * @returns the ground mesh
  60792. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  60793. */
  60794. static CreateGround(name: string, options: {
  60795. width?: number;
  60796. height?: number;
  60797. subdivisions?: number;
  60798. subdivisionsX?: number;
  60799. subdivisionsY?: number;
  60800. updatable?: boolean;
  60801. }, scene?: Nullable<Scene>): Mesh;
  60802. /**
  60803. * Creates a tiled ground mesh
  60804. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  60805. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  60806. * * 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
  60807. * * 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
  60808. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  60809. * @param name defines the name of the mesh
  60810. * @param options defines the options used to create the mesh
  60811. * @param scene defines the hosting scene
  60812. * @returns the tiled ground mesh
  60813. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  60814. */
  60815. static CreateTiledGround(name: string, options: {
  60816. xmin: number;
  60817. zmin: number;
  60818. xmax: number;
  60819. zmax: number;
  60820. subdivisions?: {
  60821. w: number;
  60822. h: number;
  60823. };
  60824. precision?: {
  60825. w: number;
  60826. h: number;
  60827. };
  60828. updatable?: boolean;
  60829. }, scene?: Nullable<Scene>): Mesh;
  60830. /**
  60831. * Creates a ground mesh from a height map
  60832. * * The parameter `url` sets the URL of the height map image resource.
  60833. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  60834. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  60835. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  60836. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  60837. * * 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.
  60838. * * 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).
  60839. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  60840. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  60841. * @param name defines the name of the mesh
  60842. * @param url defines the url to the height map
  60843. * @param options defines the options used to create the mesh
  60844. * @param scene defines the hosting scene
  60845. * @returns the ground mesh
  60846. * @see https://doc.babylonjs.com/babylon101/height_map
  60847. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  60848. */
  60849. static CreateGroundFromHeightMap(name: string, url: string, options: {
  60850. width?: number;
  60851. height?: number;
  60852. subdivisions?: number;
  60853. minHeight?: number;
  60854. maxHeight?: number;
  60855. colorFilter?: Color3;
  60856. alphaFilter?: number;
  60857. updatable?: boolean;
  60858. onReady?: (mesh: GroundMesh) => void;
  60859. }, scene?: Nullable<Scene>): GroundMesh;
  60860. /**
  60861. * Creates a polygon mesh
  60862. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  60863. * * 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
  60864. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  60865. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60866. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  60867. * * Remember you can only change the shape positions, not their number when updating a polygon
  60868. * @param name defines the name of the mesh
  60869. * @param options defines the options used to create the mesh
  60870. * @param scene defines the hosting scene
  60871. * @param earcutInjection can be used to inject your own earcut reference
  60872. * @returns the polygon mesh
  60873. */
  60874. static CreatePolygon(name: string, options: {
  60875. shape: Vector3[];
  60876. holes?: Vector3[][];
  60877. depth?: number;
  60878. faceUV?: Vector4[];
  60879. faceColors?: Color4[];
  60880. updatable?: boolean;
  60881. sideOrientation?: number;
  60882. frontUVs?: Vector4;
  60883. backUVs?: Vector4;
  60884. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  60885. /**
  60886. * Creates an extruded polygon mesh, with depth in the Y direction.
  60887. * * 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)
  60888. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  60889. * @param name defines the name of the mesh
  60890. * @param options defines the options used to create the mesh
  60891. * @param scene defines the hosting scene
  60892. * @param earcutInjection can be used to inject your own earcut reference
  60893. * @returns the polygon mesh
  60894. */
  60895. static ExtrudePolygon(name: string, options: {
  60896. shape: Vector3[];
  60897. holes?: Vector3[][];
  60898. depth?: number;
  60899. faceUV?: Vector4[];
  60900. faceColors?: Color4[];
  60901. updatable?: boolean;
  60902. sideOrientation?: number;
  60903. frontUVs?: Vector4;
  60904. backUVs?: Vector4;
  60905. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  60906. /**
  60907. * Creates a tube mesh.
  60908. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  60909. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  60910. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  60911. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  60912. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  60913. * * 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)
  60914. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  60915. * * 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
  60916. * * 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
  60917. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  60918. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60919. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  60920. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60921. * @param name defines the name of the mesh
  60922. * @param options defines the options used to create the mesh
  60923. * @param scene defines the hosting scene
  60924. * @returns the tube mesh
  60925. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  60926. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  60927. */
  60928. static CreateTube(name: string, options: {
  60929. path: Vector3[];
  60930. radius?: number;
  60931. tessellation?: number;
  60932. radiusFunction?: {
  60933. (i: number, distance: number): number;
  60934. };
  60935. cap?: number;
  60936. arc?: number;
  60937. updatable?: boolean;
  60938. sideOrientation?: number;
  60939. frontUVs?: Vector4;
  60940. backUVs?: Vector4;
  60941. instance?: Mesh;
  60942. invertUV?: boolean;
  60943. }, scene?: Nullable<Scene>): Mesh;
  60944. /**
  60945. * Creates a polyhedron mesh
  60946. * * 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
  60947. * * The parameter `size` (positive float, default 1) sets the polygon size
  60948. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  60949. * * 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`
  60950. * * 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
  60951. * * 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)`)
  60952. * * 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
  60953. * * 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
  60954. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  60955. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  60956. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  60957. * @param name defines the name of the mesh
  60958. * @param options defines the options used to create the mesh
  60959. * @param scene defines the hosting scene
  60960. * @returns the polyhedron mesh
  60961. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  60962. */
  60963. static CreatePolyhedron(name: string, options: {
  60964. type?: number;
  60965. size?: number;
  60966. sizeX?: number;
  60967. sizeY?: number;
  60968. sizeZ?: number;
  60969. custom?: any;
  60970. faceUV?: Vector4[];
  60971. faceColors?: Color4[];
  60972. flat?: boolean;
  60973. updatable?: boolean;
  60974. sideOrientation?: number;
  60975. frontUVs?: Vector4;
  60976. backUVs?: Vector4;
  60977. }, scene?: Nullable<Scene>): Mesh;
  60978. /**
  60979. * Creates a decal mesh.
  60980. * 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
  60981. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  60982. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  60983. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  60984. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  60985. * @param name defines the name of the mesh
  60986. * @param sourceMesh defines the mesh where the decal must be applied
  60987. * @param options defines the options used to create the mesh
  60988. * @param scene defines the hosting scene
  60989. * @returns the decal mesh
  60990. * @see https://doc.babylonjs.com/how_to/decals
  60991. */
  60992. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  60993. position?: Vector3;
  60994. normal?: Vector3;
  60995. size?: Vector3;
  60996. angle?: number;
  60997. }): Mesh;
  60998. }
  60999. }
  61000. declare module "babylonjs/Meshes/meshSimplification" {
  61001. import { Mesh } from "babylonjs/Meshes/mesh";
  61002. /**
  61003. * A simplifier interface for future simplification implementations
  61004. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  61005. */
  61006. export interface ISimplifier {
  61007. /**
  61008. * Simplification of a given mesh according to the given settings.
  61009. * Since this requires computation, it is assumed that the function runs async.
  61010. * @param settings The settings of the simplification, including quality and distance
  61011. * @param successCallback A callback that will be called after the mesh was simplified.
  61012. * @param errorCallback in case of an error, this callback will be called. optional.
  61013. */
  61014. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMeshes: Mesh) => void, errorCallback?: () => void): void;
  61015. }
  61016. /**
  61017. * Expected simplification settings.
  61018. * Quality should be between 0 and 1 (1 being 100%, 0 being 0%)
  61019. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  61020. */
  61021. export interface ISimplificationSettings {
  61022. /**
  61023. * Gets or sets the expected quality
  61024. */
  61025. quality: number;
  61026. /**
  61027. * Gets or sets the distance when this optimized version should be used
  61028. */
  61029. distance: number;
  61030. /**
  61031. * Gets an already optimized mesh
  61032. */
  61033. optimizeMesh?: boolean;
  61034. }
  61035. /**
  61036. * Class used to specify simplification options
  61037. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  61038. */
  61039. export class SimplificationSettings implements ISimplificationSettings {
  61040. /** expected quality */
  61041. quality: number;
  61042. /** distance when this optimized version should be used */
  61043. distance: number;
  61044. /** already optimized mesh */
  61045. optimizeMesh?: boolean | undefined;
  61046. /**
  61047. * Creates a SimplificationSettings
  61048. * @param quality expected quality
  61049. * @param distance distance when this optimized version should be used
  61050. * @param optimizeMesh already optimized mesh
  61051. */
  61052. constructor(
  61053. /** expected quality */
  61054. quality: number,
  61055. /** distance when this optimized version should be used */
  61056. distance: number,
  61057. /** already optimized mesh */
  61058. optimizeMesh?: boolean | undefined);
  61059. }
  61060. /**
  61061. * Interface used to define a simplification task
  61062. */
  61063. export interface ISimplificationTask {
  61064. /**
  61065. * Array of settings
  61066. */
  61067. settings: Array<ISimplificationSettings>;
  61068. /**
  61069. * Simplification type
  61070. */
  61071. simplificationType: SimplificationType;
  61072. /**
  61073. * Mesh to simplify
  61074. */
  61075. mesh: Mesh;
  61076. /**
  61077. * Callback called on success
  61078. */
  61079. successCallback?: () => void;
  61080. /**
  61081. * Defines if parallel processing can be used
  61082. */
  61083. parallelProcessing: boolean;
  61084. }
  61085. /**
  61086. * Queue used to order the simplification tasks
  61087. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  61088. */
  61089. export class SimplificationQueue {
  61090. private _simplificationArray;
  61091. /**
  61092. * Gets a boolean indicating that the process is still running
  61093. */
  61094. running: boolean;
  61095. /**
  61096. * Creates a new queue
  61097. */
  61098. constructor();
  61099. /**
  61100. * Adds a new simplification task
  61101. * @param task defines a task to add
  61102. */
  61103. addTask(task: ISimplificationTask): void;
  61104. /**
  61105. * Execute next task
  61106. */
  61107. executeNext(): void;
  61108. /**
  61109. * Execute a simplification task
  61110. * @param task defines the task to run
  61111. */
  61112. runSimplification(task: ISimplificationTask): void;
  61113. private getSimplifier;
  61114. }
  61115. /**
  61116. * The implemented types of simplification
  61117. * At the moment only Quadratic Error Decimation is implemented
  61118. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  61119. */
  61120. export enum SimplificationType {
  61121. /** Quadratic error decimation */
  61122. QUADRATIC = 0
  61123. }
  61124. }
  61125. declare module "babylonjs/Meshes/meshSimplificationSceneComponent" {
  61126. import { Scene } from "babylonjs/scene";
  61127. import { SimplificationQueue, ISimplificationSettings, SimplificationType } from "babylonjs/Meshes/meshSimplification";
  61128. import { ISceneComponent } from "babylonjs/sceneComponent";
  61129. module "babylonjs/scene" {
  61130. interface Scene {
  61131. /** @hidden (Backing field) */
  61132. _simplificationQueue: SimplificationQueue;
  61133. /**
  61134. * Gets or sets the simplification queue attached to the scene
  61135. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  61136. */
  61137. simplificationQueue: SimplificationQueue;
  61138. }
  61139. }
  61140. module "babylonjs/Meshes/mesh" {
  61141. interface Mesh {
  61142. /**
  61143. * Simplify the mesh according to the given array of settings.
  61144. * Function will return immediately and will simplify async
  61145. * @param settings a collection of simplification settings
  61146. * @param parallelProcessing should all levels calculate parallel or one after the other
  61147. * @param simplificationType the type of simplification to run
  61148. * @param successCallback optional success callback to be called after the simplification finished processing all settings
  61149. * @returns the current mesh
  61150. */
  61151. simplify(settings: Array<ISimplificationSettings>, parallelProcessing?: boolean, simplificationType?: SimplificationType, successCallback?: (mesh?: Mesh, submeshIndex?: number) => void): Mesh;
  61152. }
  61153. }
  61154. /**
  61155. * Defines the simplification queue scene component responsible to help scheduling the various simplification task
  61156. * created in a scene
  61157. */
  61158. export class SimplicationQueueSceneComponent implements ISceneComponent {
  61159. /**
  61160. * The component name helpfull to identify the component in the list of scene components.
  61161. */
  61162. readonly name: string;
  61163. /**
  61164. * The scene the component belongs to.
  61165. */
  61166. scene: Scene;
  61167. /**
  61168. * Creates a new instance of the component for the given scene
  61169. * @param scene Defines the scene to register the component in
  61170. */
  61171. constructor(scene: Scene);
  61172. /**
  61173. * Registers the component in a given scene
  61174. */
  61175. register(): void;
  61176. /**
  61177. * Rebuilds the elements related to this component in case of
  61178. * context lost for instance.
  61179. */
  61180. rebuild(): void;
  61181. /**
  61182. * Disposes the component and the associated ressources
  61183. */
  61184. dispose(): void;
  61185. private _beforeCameraUpdate;
  61186. }
  61187. }
  61188. declare module "babylonjs/Meshes/Builders/index" {
  61189. export * from "babylonjs/Meshes/Builders/boxBuilder";
  61190. export * from "babylonjs/Meshes/Builders/tiledBoxBuilder";
  61191. export * from "babylonjs/Meshes/Builders/discBuilder";
  61192. export * from "babylonjs/Meshes/Builders/ribbonBuilder";
  61193. export * from "babylonjs/Meshes/Builders/sphereBuilder";
  61194. export * from "babylonjs/Meshes/Builders/hemisphereBuilder";
  61195. export * from "babylonjs/Meshes/Builders/cylinderBuilder";
  61196. export * from "babylonjs/Meshes/Builders/torusBuilder";
  61197. export * from "babylonjs/Meshes/Builders/torusKnotBuilder";
  61198. export * from "babylonjs/Meshes/Builders/linesBuilder";
  61199. export * from "babylonjs/Meshes/Builders/polygonBuilder";
  61200. export * from "babylonjs/Meshes/Builders/shapeBuilder";
  61201. export * from "babylonjs/Meshes/Builders/latheBuilder";
  61202. export * from "babylonjs/Meshes/Builders/planeBuilder";
  61203. export * from "babylonjs/Meshes/Builders/tiledPlaneBuilder";
  61204. export * from "babylonjs/Meshes/Builders/groundBuilder";
  61205. export * from "babylonjs/Meshes/Builders/tubeBuilder";
  61206. export * from "babylonjs/Meshes/Builders/polyhedronBuilder";
  61207. export * from "babylonjs/Meshes/Builders/icoSphereBuilder";
  61208. export * from "babylonjs/Meshes/Builders/decalBuilder";
  61209. }
  61210. declare module "babylonjs/Meshes/index" {
  61211. export * from "babylonjs/Meshes/abstractMesh";
  61212. export * from "babylonjs/Meshes/buffer";
  61213. export * from "babylonjs/Meshes/Compression/index";
  61214. export * from "babylonjs/Meshes/csg";
  61215. export * from "babylonjs/Meshes/geometry";
  61216. export * from "babylonjs/Meshes/groundMesh";
  61217. export * from "babylonjs/Meshes/trailMesh";
  61218. export * from "babylonjs/Meshes/instancedMesh";
  61219. export * from "babylonjs/Meshes/linesMesh";
  61220. export * from "babylonjs/Meshes/mesh";
  61221. export * from "babylonjs/Meshes/mesh.vertexData";
  61222. export * from "babylonjs/Meshes/meshBuilder";
  61223. export * from "babylonjs/Meshes/meshSimplification";
  61224. export * from "babylonjs/Meshes/meshSimplificationSceneComponent";
  61225. export * from "babylonjs/Meshes/polygonMesh";
  61226. export * from "babylonjs/Meshes/subMesh";
  61227. export * from "babylonjs/Meshes/meshLODLevel";
  61228. export * from "babylonjs/Meshes/transformNode";
  61229. export * from "babylonjs/Meshes/Builders/index";
  61230. export * from "babylonjs/Meshes/dataBuffer";
  61231. export * from "babylonjs/Meshes/WebGL/webGLDataBuffer";
  61232. }
  61233. declare module "babylonjs/Morph/index" {
  61234. export * from "babylonjs/Morph/morphTarget";
  61235. export * from "babylonjs/Morph/morphTargetManager";
  61236. }
  61237. declare module "babylonjs/Navigation/INavigationEngine" {
  61238. import { TransformNode } from "babylonjs/Meshes/transformNode";
  61239. import { Vector3 } from "babylonjs/Maths/math";
  61240. import { Mesh } from "babylonjs/Meshes/mesh";
  61241. import { Scene } from "babylonjs/scene";
  61242. /**
  61243. * Navigation plugin interface to add navigation constrained by a navigation mesh
  61244. */
  61245. export interface INavigationEnginePlugin {
  61246. /**
  61247. * plugin name
  61248. */
  61249. name: string;
  61250. /**
  61251. * Creates a navigation mesh
  61252. * @param meshes array of all the geometry used to compute the navigatio mesh
  61253. * @param parameters bunch of parameters used to filter geometry
  61254. */
  61255. createMavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  61256. /**
  61257. * Create a navigation mesh debug mesh
  61258. * @param scene is where the mesh will be added
  61259. * @returns debug display mesh
  61260. */
  61261. createDebugNavMesh(scene: Scene): Mesh;
  61262. /**
  61263. * Get a navigation mesh constrained position, closest to the parameter position
  61264. * @param position world position
  61265. * @returns the closest point to position constrained by the navigation mesh
  61266. */
  61267. getClosestPoint(position: Vector3): Vector3;
  61268. /**
  61269. * Get a navigation mesh constrained position, within a particular radius
  61270. * @param position world position
  61271. * @param maxRadius the maximum distance to the constrained world position
  61272. * @returns the closest point to position constrained by the navigation mesh
  61273. */
  61274. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  61275. /**
  61276. * Compute the final position from a segment made of destination-position
  61277. * @param position world position
  61278. * @param destination world position
  61279. * @returns the resulting point along the navmesh
  61280. */
  61281. moveAlong(position: Vector3, destination: Vector3): Vector3;
  61282. /**
  61283. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  61284. * @param start world position
  61285. * @param end world position
  61286. * @returns array containing world position composing the path
  61287. */
  61288. computePath(start: Vector3, end: Vector3): Vector3[];
  61289. /**
  61290. * If this plugin is supported
  61291. * @returns true if plugin is supported
  61292. */
  61293. isSupported(): boolean;
  61294. /**
  61295. * Create a new Crowd so you can add agents
  61296. * @param maxAgents the maximum agent count in the crowd
  61297. * @param maxAgentRadius the maximum radius an agent can have
  61298. * @param scene to attach the crowd to
  61299. * @returns the crowd you can add agents to
  61300. */
  61301. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  61302. /**
  61303. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  61304. * The queries will try to find a solution within those bounds
  61305. * default is (1,1,1)
  61306. * @param extent x,y,z value that define the extent around the queries point of reference
  61307. */
  61308. setDefaultQueryExtent(extent: Vector3): void;
  61309. /**
  61310. * Get the Bounding box extent specified by setDefaultQueryExtent
  61311. * @returns the box extent values
  61312. */
  61313. getDefaultQueryExtent(): Vector3;
  61314. /**
  61315. * Release all resources
  61316. */
  61317. dispose(): void;
  61318. }
  61319. /**
  61320. * Crowd Interface. A Crowd is a collection of moving agents constrained by a navigation mesh
  61321. */
  61322. export interface ICrowd {
  61323. /**
  61324. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  61325. * You can attach anything to that node. The node position is updated in the scene update tick.
  61326. * @param pos world position that will be constrained by the navigation mesh
  61327. * @param parameters agent parameters
  61328. * @param transform hooked to the agent that will be update by the scene
  61329. * @returns agent index
  61330. */
  61331. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  61332. /**
  61333. * Returns the agent position in world space
  61334. * @param index agent index returned by addAgent
  61335. * @returns world space position
  61336. */
  61337. getAgentPosition(index: number): Vector3;
  61338. /**
  61339. * Gets the agent velocity in world space
  61340. * @param index agent index returned by addAgent
  61341. * @returns world space velocity
  61342. */
  61343. getAgentVelocity(index: number): Vector3;
  61344. /**
  61345. * remove a particular agent previously created
  61346. * @param index agent index returned by addAgent
  61347. */
  61348. removeAgent(index: number): void;
  61349. /**
  61350. * get the list of all agents attached to this crowd
  61351. * @returns list of agent indices
  61352. */
  61353. getAgents(): number[];
  61354. /**
  61355. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  61356. * @param deltaTime in seconds
  61357. */
  61358. update(deltaTime: number): void;
  61359. /**
  61360. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  61361. * @param index agent index returned by addAgent
  61362. * @param destination targeted world position
  61363. */
  61364. agentGoto(index: number, destination: Vector3): void;
  61365. /**
  61366. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  61367. * The queries will try to find a solution within those bounds
  61368. * default is (1,1,1)
  61369. * @param extent x,y,z value that define the extent around the queries point of reference
  61370. */
  61371. setDefaultQueryExtent(extent: Vector3): void;
  61372. /**
  61373. * Get the Bounding box extent specified by setDefaultQueryExtent
  61374. * @returns the box extent values
  61375. */
  61376. getDefaultQueryExtent(): Vector3;
  61377. /**
  61378. * Release all resources
  61379. */
  61380. dispose(): void;
  61381. }
  61382. /**
  61383. * Configures an agent
  61384. */
  61385. export interface IAgentParameters {
  61386. /**
  61387. * Agent radius. [Limit: >= 0]
  61388. */
  61389. radius: number;
  61390. /**
  61391. * Agent height. [Limit: > 0]
  61392. */
  61393. height: number;
  61394. /**
  61395. * Maximum allowed acceleration. [Limit: >= 0]
  61396. */
  61397. maxAcceleration: number;
  61398. /**
  61399. * Maximum allowed speed. [Limit: >= 0]
  61400. */
  61401. maxSpeed: number;
  61402. /**
  61403. * Defines how close a collision element must be before it is considered for steering behaviors. [Limits: > 0]
  61404. */
  61405. collisionQueryRange: number;
  61406. /**
  61407. * The path visibility optimization range. [Limit: > 0]
  61408. */
  61409. pathOptimizationRange: number;
  61410. /**
  61411. * How aggresive the agent manager should be at avoiding collisions with this agent. [Limit: >= 0]
  61412. */
  61413. separationWeight: number;
  61414. }
  61415. /**
  61416. * Configures the navigation mesh creation
  61417. */
  61418. export interface INavMeshParameters {
  61419. /**
  61420. * The xz-plane cell size to use for fields. [Limit: > 0] [Units: wu]
  61421. */
  61422. cs: number;
  61423. /**
  61424. * The y-axis cell size to use for fields. [Limit: > 0] [Units: wu]
  61425. */
  61426. ch: number;
  61427. /**
  61428. * The maximum slope that is considered walkable. [Limits: 0 <= value < 90] [Units: Degrees]
  61429. */
  61430. walkableSlopeAngle: number;
  61431. /**
  61432. * Minimum floor to 'ceiling' height that will still allow the floor area to
  61433. * be considered walkable. [Limit: >= 3] [Units: vx]
  61434. */
  61435. walkableHeight: number;
  61436. /**
  61437. * Maximum ledge height that is considered to still be traversable. [Limit: >=0] [Units: vx]
  61438. */
  61439. walkableClimb: number;
  61440. /**
  61441. * The distance to erode/shrink the walkable area of the heightfield away from
  61442. * obstructions. [Limit: >=0] [Units: vx]
  61443. */
  61444. walkableRadius: number;
  61445. /**
  61446. * The maximum allowed length for contour edges along the border of the mesh. [Limit: >=0] [Units: vx]
  61447. */
  61448. maxEdgeLen: number;
  61449. /**
  61450. * The maximum distance a simplfied contour's border edges should deviate
  61451. * the original raw contour. [Limit: >=0] [Units: vx]
  61452. */
  61453. maxSimplificationError: number;
  61454. /**
  61455. * The minimum number of cells allowed to form isolated island areas. [Limit: >=0] [Units: vx]
  61456. */
  61457. minRegionArea: number;
  61458. /**
  61459. * Any regions with a span count smaller than this value will, if possible,
  61460. * be merged with larger regions. [Limit: >=0] [Units: vx]
  61461. */
  61462. mergeRegionArea: number;
  61463. /**
  61464. * The maximum number of vertices allowed for polygons generated during the
  61465. * contour to polygon conversion process. [Limit: >= 3]
  61466. */
  61467. maxVertsPerPoly: number;
  61468. /**
  61469. * Sets the sampling distance to use when generating the detail mesh.
  61470. * (For height detail only.) [Limits: 0 or >= 0.9] [Units: wu]
  61471. */
  61472. detailSampleDist: number;
  61473. /**
  61474. * The maximum distance the detail mesh surface should deviate from heightfield
  61475. * data. (For height detail only.) [Limit: >=0] [Units: wu]
  61476. */
  61477. detailSampleMaxError: number;
  61478. }
  61479. }
  61480. declare module "babylonjs/Navigation/Plugins/recastJSPlugin" {
  61481. import { INavigationEnginePlugin, ICrowd, IAgentParameters, INavMeshParameters } from "babylonjs/Navigation/INavigationEngine";
  61482. import { Mesh } from "babylonjs/Meshes/mesh";
  61483. import { Scene } from "babylonjs/scene";
  61484. import { Vector3 } from "babylonjs/Maths/math";
  61485. import { TransformNode } from "babylonjs/Meshes/transformNode";
  61486. /**
  61487. * RecastJS navigation plugin
  61488. */
  61489. export class RecastJSPlugin implements INavigationEnginePlugin {
  61490. /**
  61491. * Reference to the Recast library
  61492. */
  61493. bjsRECAST: any;
  61494. /**
  61495. * plugin name
  61496. */
  61497. name: string;
  61498. /**
  61499. * the first navmesh created. We might extend this to support multiple navmeshes
  61500. */
  61501. navMesh: any;
  61502. /**
  61503. * Initializes the recastJS plugin
  61504. * @param recastInjection can be used to inject your own recast reference
  61505. */
  61506. constructor(recastInjection?: any);
  61507. /**
  61508. * Creates a navigation mesh
  61509. * @param meshes array of all the geometry used to compute the navigatio mesh
  61510. * @param parameters bunch of parameters used to filter geometry
  61511. */
  61512. createMavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  61513. /**
  61514. * Create a navigation mesh debug mesh
  61515. * @param scene is where the mesh will be added
  61516. * @returns debug display mesh
  61517. */
  61518. createDebugNavMesh(scene: Scene): Mesh;
  61519. /**
  61520. * Get a navigation mesh constrained position, closest to the parameter position
  61521. * @param position world position
  61522. * @returns the closest point to position constrained by the navigation mesh
  61523. */
  61524. getClosestPoint(position: Vector3): Vector3;
  61525. /**
  61526. * Get a navigation mesh constrained position, within a particular radius
  61527. * @param position world position
  61528. * @param maxRadius the maximum distance to the constrained world position
  61529. * @returns the closest point to position constrained by the navigation mesh
  61530. */
  61531. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  61532. /**
  61533. * Compute the final position from a segment made of destination-position
  61534. * @param position world position
  61535. * @param destination world position
  61536. * @returns the resulting point along the navmesh
  61537. */
  61538. moveAlong(position: Vector3, destination: Vector3): Vector3;
  61539. /**
  61540. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  61541. * @param start world position
  61542. * @param end world position
  61543. * @returns array containing world position composing the path
  61544. */
  61545. computePath(start: Vector3, end: Vector3): Vector3[];
  61546. /**
  61547. * Create a new Crowd so you can add agents
  61548. * @param maxAgents the maximum agent count in the crowd
  61549. * @param maxAgentRadius the maximum radius an agent can have
  61550. * @param scene to attach the crowd to
  61551. * @returns the crowd you can add agents to
  61552. */
  61553. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  61554. /**
  61555. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  61556. * The queries will try to find a solution within those bounds
  61557. * default is (1,1,1)
  61558. * @param extent x,y,z value that define the extent around the queries point of reference
  61559. */
  61560. setDefaultQueryExtent(extent: Vector3): void;
  61561. /**
  61562. * Get the Bounding box extent specified by setDefaultQueryExtent
  61563. * @returns the box extent values
  61564. */
  61565. getDefaultQueryExtent(): Vector3;
  61566. /**
  61567. * Disposes
  61568. */
  61569. dispose(): void;
  61570. /**
  61571. * If this plugin is supported
  61572. * @returns true if plugin is supported
  61573. */
  61574. isSupported(): boolean;
  61575. }
  61576. /**
  61577. * Recast detour crowd implementation
  61578. */
  61579. export class RecastJSCrowd implements ICrowd {
  61580. /**
  61581. * Recast/detour plugin
  61582. */
  61583. bjsRECASTPlugin: RecastJSPlugin;
  61584. /**
  61585. * Link to the detour crowd
  61586. */
  61587. recastCrowd: any;
  61588. /**
  61589. * One transform per agent
  61590. */
  61591. transforms: TransformNode[];
  61592. /**
  61593. * All agents created
  61594. */
  61595. agents: number[];
  61596. /**
  61597. * Link to the scene is kept to unregister the crowd from the scene
  61598. */
  61599. private _scene;
  61600. /**
  61601. * Observer for crowd updates
  61602. */
  61603. private _onBeforeAnimationsObserver;
  61604. /**
  61605. * Constructor
  61606. * @param plugin recastJS plugin
  61607. * @param maxAgents the maximum agent count in the crowd
  61608. * @param maxAgentRadius the maximum radius an agent can have
  61609. * @param scene to attach the crowd to
  61610. * @returns the crowd you can add agents to
  61611. */
  61612. constructor(plugin: RecastJSPlugin, maxAgents: number, maxAgentRadius: number, scene: Scene);
  61613. /**
  61614. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  61615. * You can attach anything to that node. The node position is updated in the scene update tick.
  61616. * @param pos world position that will be constrained by the navigation mesh
  61617. * @param parameters agent parameters
  61618. * @param transform hooked to the agent that will be update by the scene
  61619. * @returns agent index
  61620. */
  61621. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  61622. /**
  61623. * Returns the agent position in world space
  61624. * @param index agent index returned by addAgent
  61625. * @returns world space position
  61626. */
  61627. getAgentPosition(index: number): Vector3;
  61628. /**
  61629. * Returns the agent velocity in world space
  61630. * @param index agent index returned by addAgent
  61631. * @returns world space velocity
  61632. */
  61633. getAgentVelocity(index: number): Vector3;
  61634. /**
  61635. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  61636. * @param index agent index returned by addAgent
  61637. * @param destination targeted world position
  61638. */
  61639. agentGoto(index: number, destination: Vector3): void;
  61640. /**
  61641. * remove a particular agent previously created
  61642. * @param index agent index returned by addAgent
  61643. */
  61644. removeAgent(index: number): void;
  61645. /**
  61646. * get the list of all agents attached to this crowd
  61647. * @returns list of agent indices
  61648. */
  61649. getAgents(): number[];
  61650. /**
  61651. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  61652. * @param deltaTime in seconds
  61653. */
  61654. update(deltaTime: number): void;
  61655. /**
  61656. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  61657. * The queries will try to find a solution within those bounds
  61658. * default is (1,1,1)
  61659. * @param extent x,y,z value that define the extent around the queries point of reference
  61660. */
  61661. setDefaultQueryExtent(extent: Vector3): void;
  61662. /**
  61663. * Get the Bounding box extent specified by setDefaultQueryExtent
  61664. * @returns the box extent values
  61665. */
  61666. getDefaultQueryExtent(): Vector3;
  61667. /**
  61668. * Release all resources
  61669. */
  61670. dispose(): void;
  61671. }
  61672. }
  61673. declare module "babylonjs/Navigation/Plugins/index" {
  61674. export * from "babylonjs/Navigation/Plugins/recastJSPlugin";
  61675. }
  61676. declare module "babylonjs/Navigation/index" {
  61677. export * from "babylonjs/Navigation/INavigationEngine";
  61678. export * from "babylonjs/Navigation/Plugins/index";
  61679. }
  61680. declare module "babylonjs/Offline/database" {
  61681. import { IOfflineProvider } from "babylonjs/Offline/IOfflineProvider";
  61682. /**
  61683. * Class used to enable access to IndexedDB
  61684. * @see http://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  61685. */
  61686. export class Database implements IOfflineProvider {
  61687. private _callbackManifestChecked;
  61688. private _currentSceneUrl;
  61689. private _db;
  61690. private _enableSceneOffline;
  61691. private _enableTexturesOffline;
  61692. private _manifestVersionFound;
  61693. private _mustUpdateRessources;
  61694. private _hasReachedQuota;
  61695. private _isSupported;
  61696. private _idbFactory;
  61697. /** Gets a boolean indicating if the user agent supports blob storage (this value will be updated after creating the first Database object) */
  61698. private static IsUASupportingBlobStorage;
  61699. /**
  61700. * Gets a boolean indicating if Database storate is enabled (off by default)
  61701. */
  61702. static IDBStorageEnabled: boolean;
  61703. /**
  61704. * Gets a boolean indicating if scene must be saved in the database
  61705. */
  61706. readonly enableSceneOffline: boolean;
  61707. /**
  61708. * Gets a boolean indicating if textures must be saved in the database
  61709. */
  61710. readonly enableTexturesOffline: boolean;
  61711. /**
  61712. * Creates a new Database
  61713. * @param urlToScene defines the url to load the scene
  61714. * @param callbackManifestChecked defines the callback to use when manifest is checked
  61715. * @param disableManifestCheck defines a boolean indicating that we want to skip the manifest validation (it will be considered validated and up to date)
  61716. */
  61717. constructor(urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck?: boolean);
  61718. private static _ParseURL;
  61719. private static _ReturnFullUrlLocation;
  61720. private _checkManifestFile;
  61721. /**
  61722. * Open the database and make it available
  61723. * @param successCallback defines the callback to call on success
  61724. * @param errorCallback defines the callback to call on error
  61725. */
  61726. open(successCallback: () => void, errorCallback: () => void): void;
  61727. /**
  61728. * Loads an image from the database
  61729. * @param url defines the url to load from
  61730. * @param image defines the target DOM image
  61731. */
  61732. loadImage(url: string, image: HTMLImageElement): void;
  61733. private _loadImageFromDBAsync;
  61734. private _saveImageIntoDBAsync;
  61735. private _checkVersionFromDB;
  61736. private _loadVersionFromDBAsync;
  61737. private _saveVersionIntoDBAsync;
  61738. /**
  61739. * Loads a file from database
  61740. * @param url defines the URL to load from
  61741. * @param sceneLoaded defines a callback to call on success
  61742. * @param progressCallBack defines a callback to call when progress changed
  61743. * @param errorCallback defines a callback to call on error
  61744. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  61745. */
  61746. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  61747. private _loadFileAsync;
  61748. private _saveFileAsync;
  61749. /**
  61750. * Validates if xhr data is correct
  61751. * @param xhr defines the request to validate
  61752. * @param dataType defines the expected data type
  61753. * @returns true if data is correct
  61754. */
  61755. private static _ValidateXHRData;
  61756. }
  61757. }
  61758. declare module "babylonjs/Offline/index" {
  61759. export * from "babylonjs/Offline/database";
  61760. export * from "babylonjs/Offline/IOfflineProvider";
  61761. }
  61762. declare module "babylonjs/Shaders/gpuUpdateParticles.fragment" {
  61763. /** @hidden */
  61764. export var gpuUpdateParticlesPixelShader: {
  61765. name: string;
  61766. shader: string;
  61767. };
  61768. }
  61769. declare module "babylonjs/Shaders/gpuUpdateParticles.vertex" {
  61770. /** @hidden */
  61771. export var gpuUpdateParticlesVertexShader: {
  61772. name: string;
  61773. shader: string;
  61774. };
  61775. }
  61776. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration2" {
  61777. /** @hidden */
  61778. export var clipPlaneFragmentDeclaration2: {
  61779. name: string;
  61780. shader: string;
  61781. };
  61782. }
  61783. declare module "babylonjs/Shaders/gpuRenderParticles.fragment" {
  61784. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragmentDeclaration2";
  61785. import "babylonjs/Shaders/ShadersInclude/imageProcessingDeclaration";
  61786. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  61787. import "babylonjs/Shaders/ShadersInclude/imageProcessingFunctions";
  61788. import "babylonjs/Shaders/ShadersInclude/clipPlaneFragment";
  61789. /** @hidden */
  61790. export var gpuRenderParticlesPixelShader: {
  61791. name: string;
  61792. shader: string;
  61793. };
  61794. }
  61795. declare module "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration2" {
  61796. /** @hidden */
  61797. export var clipPlaneVertexDeclaration2: {
  61798. name: string;
  61799. shader: string;
  61800. };
  61801. }
  61802. declare module "babylonjs/Shaders/gpuRenderParticles.vertex" {
  61803. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertexDeclaration2";
  61804. import "babylonjs/Shaders/ShadersInclude/clipPlaneVertex";
  61805. /** @hidden */
  61806. export var gpuRenderParticlesVertexShader: {
  61807. name: string;
  61808. shader: string;
  61809. };
  61810. }
  61811. declare module "babylonjs/Particles/gpuParticleSystem" {
  61812. import { Nullable } from "babylonjs/types";
  61813. import { Color3Gradient, IValueGradient } from "babylonjs/Misc/gradients";
  61814. import { Observable } from "babylonjs/Misc/observable";
  61815. import { Color4, Color3 } from "babylonjs/Maths/math.color";
  61816. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  61817. import { BaseParticleSystem } from "babylonjs/Particles/baseParticleSystem";
  61818. import { Scene, IDisposable } from "babylonjs/scene";
  61819. import { RawTexture } from "babylonjs/Materials/Textures/rawTexture";
  61820. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  61821. import "babylonjs/Shaders/gpuUpdateParticles.fragment";
  61822. import "babylonjs/Shaders/gpuUpdateParticles.vertex";
  61823. import "babylonjs/Shaders/gpuRenderParticles.fragment";
  61824. import "babylonjs/Shaders/gpuRenderParticles.vertex";
  61825. /**
  61826. * This represents a GPU particle system in Babylon
  61827. * This is the fastest particle system in Babylon as it uses the GPU to update the individual particle data
  61828. * @see https://www.babylonjs-playground.com/#PU4WYI#4
  61829. */
  61830. export class GPUParticleSystem extends BaseParticleSystem implements IDisposable, IParticleSystem, IAnimatable {
  61831. /**
  61832. * The layer mask we are rendering the particles through.
  61833. */
  61834. layerMask: number;
  61835. private _capacity;
  61836. private _activeCount;
  61837. private _currentActiveCount;
  61838. private _accumulatedCount;
  61839. private _renderEffect;
  61840. private _updateEffect;
  61841. private _buffer0;
  61842. private _buffer1;
  61843. private _spriteBuffer;
  61844. private _updateVAO;
  61845. private _renderVAO;
  61846. private _targetIndex;
  61847. private _sourceBuffer;
  61848. private _targetBuffer;
  61849. private _engine;
  61850. private _currentRenderId;
  61851. private _started;
  61852. private _stopped;
  61853. private _timeDelta;
  61854. private _randomTexture;
  61855. private _randomTexture2;
  61856. private _attributesStrideSize;
  61857. private _updateEffectOptions;
  61858. private _randomTextureSize;
  61859. private _actualFrame;
  61860. private readonly _rawTextureWidth;
  61861. /**
  61862. * Gets a boolean indicating if the GPU particles can be rendered on current browser
  61863. */
  61864. static readonly IsSupported: boolean;
  61865. /**
  61866. * An event triggered when the system is disposed.
  61867. */
  61868. onDisposeObservable: Observable<GPUParticleSystem>;
  61869. /**
  61870. * Gets the maximum number of particles active at the same time.
  61871. * @returns The max number of active particles.
  61872. */
  61873. getCapacity(): number;
  61874. /**
  61875. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  61876. * to override the particles.
  61877. */
  61878. forceDepthWrite: boolean;
  61879. /**
  61880. * Gets or set the number of active particles
  61881. */
  61882. activeParticleCount: number;
  61883. private _preWarmDone;
  61884. /**
  61885. * Is this system ready to be used/rendered
  61886. * @return true if the system is ready
  61887. */
  61888. isReady(): boolean;
  61889. /**
  61890. * Gets if the system has been started. (Note: this will still be true after stop is called)
  61891. * @returns True if it has been started, otherwise false.
  61892. */
  61893. isStarted(): boolean;
  61894. /**
  61895. * Starts the particle system and begins to emit
  61896. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  61897. */
  61898. start(delay?: number): void;
  61899. /**
  61900. * Stops the particle system.
  61901. */
  61902. stop(): void;
  61903. /**
  61904. * Remove all active particles
  61905. */
  61906. reset(): void;
  61907. /**
  61908. * Returns the string "GPUParticleSystem"
  61909. * @returns a string containing the class name
  61910. */
  61911. getClassName(): string;
  61912. private _colorGradientsTexture;
  61913. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: RawTexture): BaseParticleSystem;
  61914. /**
  61915. * Adds a new color gradient
  61916. * @param gradient defines the gradient to use (between 0 and 1)
  61917. * @param color1 defines the color to affect to the specified gradient
  61918. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  61919. * @returns the current particle system
  61920. */
  61921. addColorGradient(gradient: number, color1: Color4, color2?: Color4): GPUParticleSystem;
  61922. /**
  61923. * Remove a specific color gradient
  61924. * @param gradient defines the gradient to remove
  61925. * @returns the current particle system
  61926. */
  61927. removeColorGradient(gradient: number): GPUParticleSystem;
  61928. private _angularSpeedGradientsTexture;
  61929. private _sizeGradientsTexture;
  61930. private _velocityGradientsTexture;
  61931. private _limitVelocityGradientsTexture;
  61932. private _dragGradientsTexture;
  61933. private _addFactorGradient;
  61934. /**
  61935. * Adds a new size gradient
  61936. * @param gradient defines the gradient to use (between 0 and 1)
  61937. * @param factor defines the size factor to affect to the specified gradient
  61938. * @returns the current particle system
  61939. */
  61940. addSizeGradient(gradient: number, factor: number): GPUParticleSystem;
  61941. /**
  61942. * Remove a specific size gradient
  61943. * @param gradient defines the gradient to remove
  61944. * @returns the current particle system
  61945. */
  61946. removeSizeGradient(gradient: number): GPUParticleSystem;
  61947. /**
  61948. * Adds a new angular speed gradient
  61949. * @param gradient defines the gradient to use (between 0 and 1)
  61950. * @param factor defines the angular speed to affect to the specified gradient
  61951. * @returns the current particle system
  61952. */
  61953. addAngularSpeedGradient(gradient: number, factor: number): GPUParticleSystem;
  61954. /**
  61955. * Remove a specific angular speed gradient
  61956. * @param gradient defines the gradient to remove
  61957. * @returns the current particle system
  61958. */
  61959. removeAngularSpeedGradient(gradient: number): GPUParticleSystem;
  61960. /**
  61961. * Adds a new velocity gradient
  61962. * @param gradient defines the gradient to use (between 0 and 1)
  61963. * @param factor defines the velocity to affect to the specified gradient
  61964. * @returns the current particle system
  61965. */
  61966. addVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  61967. /**
  61968. * Remove a specific velocity gradient
  61969. * @param gradient defines the gradient to remove
  61970. * @returns the current particle system
  61971. */
  61972. removeVelocityGradient(gradient: number): GPUParticleSystem;
  61973. /**
  61974. * Adds a new limit velocity gradient
  61975. * @param gradient defines the gradient to use (between 0 and 1)
  61976. * @param factor defines the limit velocity value to affect to the specified gradient
  61977. * @returns the current particle system
  61978. */
  61979. addLimitVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  61980. /**
  61981. * Remove a specific limit velocity gradient
  61982. * @param gradient defines the gradient to remove
  61983. * @returns the current particle system
  61984. */
  61985. removeLimitVelocityGradient(gradient: number): GPUParticleSystem;
  61986. /**
  61987. * Adds a new drag gradient
  61988. * @param gradient defines the gradient to use (between 0 and 1)
  61989. * @param factor defines the drag value to affect to the specified gradient
  61990. * @returns the current particle system
  61991. */
  61992. addDragGradient(gradient: number, factor: number): GPUParticleSystem;
  61993. /**
  61994. * Remove a specific drag gradient
  61995. * @param gradient defines the gradient to remove
  61996. * @returns the current particle system
  61997. */
  61998. removeDragGradient(gradient: number): GPUParticleSystem;
  61999. /**
  62000. * Not supported by GPUParticleSystem
  62001. * @param gradient defines the gradient to use (between 0 and 1)
  62002. * @param factor defines the emit rate value to affect to the specified gradient
  62003. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  62004. * @returns the current particle system
  62005. */
  62006. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  62007. /**
  62008. * Not supported by GPUParticleSystem
  62009. * @param gradient defines the gradient to remove
  62010. * @returns the current particle system
  62011. */
  62012. removeEmitRateGradient(gradient: number): IParticleSystem;
  62013. /**
  62014. * Not supported by GPUParticleSystem
  62015. * @param gradient defines the gradient to use (between 0 and 1)
  62016. * @param factor defines the start size value to affect to the specified gradient
  62017. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  62018. * @returns the current particle system
  62019. */
  62020. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  62021. /**
  62022. * Not supported by GPUParticleSystem
  62023. * @param gradient defines the gradient to remove
  62024. * @returns the current particle system
  62025. */
  62026. removeStartSizeGradient(gradient: number): IParticleSystem;
  62027. /**
  62028. * Not supported by GPUParticleSystem
  62029. * @param gradient defines the gradient to use (between 0 and 1)
  62030. * @param min defines the color remap minimal range
  62031. * @param max defines the color remap maximal range
  62032. * @returns the current particle system
  62033. */
  62034. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  62035. /**
  62036. * Not supported by GPUParticleSystem
  62037. * @param gradient defines the gradient to remove
  62038. * @returns the current particle system
  62039. */
  62040. removeColorRemapGradient(): IParticleSystem;
  62041. /**
  62042. * Not supported by GPUParticleSystem
  62043. * @param gradient defines the gradient to use (between 0 and 1)
  62044. * @param min defines the alpha remap minimal range
  62045. * @param max defines the alpha remap maximal range
  62046. * @returns the current particle system
  62047. */
  62048. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  62049. /**
  62050. * Not supported by GPUParticleSystem
  62051. * @param gradient defines the gradient to remove
  62052. * @returns the current particle system
  62053. */
  62054. removeAlphaRemapGradient(): IParticleSystem;
  62055. /**
  62056. * Not supported by GPUParticleSystem
  62057. * @param gradient defines the gradient to use (between 0 and 1)
  62058. * @param color defines the color to affect to the specified gradient
  62059. * @returns the current particle system
  62060. */
  62061. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  62062. /**
  62063. * Not supported by GPUParticleSystem
  62064. * @param gradient defines the gradient to remove
  62065. * @returns the current particle system
  62066. */
  62067. removeRampGradient(): IParticleSystem;
  62068. /**
  62069. * Not supported by GPUParticleSystem
  62070. * @returns the list of ramp gradients
  62071. */
  62072. getRampGradients(): Nullable<Array<Color3Gradient>>;
  62073. /**
  62074. * Not supported by GPUParticleSystem
  62075. * Gets or sets a boolean indicating that ramp gradients must be used
  62076. * @see http://doc.babylonjs.com/babylon101/particles#ramp-gradients
  62077. */
  62078. useRampGradients: boolean;
  62079. /**
  62080. * Not supported by GPUParticleSystem
  62081. * @param gradient defines the gradient to use (between 0 and 1)
  62082. * @param factor defines the life time factor to affect to the specified gradient
  62083. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  62084. * @returns the current particle system
  62085. */
  62086. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  62087. /**
  62088. * Not supported by GPUParticleSystem
  62089. * @param gradient defines the gradient to remove
  62090. * @returns the current particle system
  62091. */
  62092. removeLifeTimeGradient(gradient: number): IParticleSystem;
  62093. /**
  62094. * Instantiates a GPU particle system.
  62095. * 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.
  62096. * @param name The name of the particle system
  62097. * @param options The options used to create the system
  62098. * @param scene The scene the particle system belongs to
  62099. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  62100. */
  62101. constructor(name: string, options: Partial<{
  62102. capacity: number;
  62103. randomTextureSize: number;
  62104. }>, scene: Scene, isAnimationSheetEnabled?: boolean);
  62105. protected _reset(): void;
  62106. private _createUpdateVAO;
  62107. private _createRenderVAO;
  62108. private _initialize;
  62109. /** @hidden */
  62110. _recreateUpdateEffect(): void;
  62111. /** @hidden */
  62112. _recreateRenderEffect(): void;
  62113. /**
  62114. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  62115. * @param preWarm defines if we are in the pre-warmimg phase
  62116. */
  62117. animate(preWarm?: boolean): void;
  62118. private _createFactorGradientTexture;
  62119. private _createSizeGradientTexture;
  62120. private _createAngularSpeedGradientTexture;
  62121. private _createVelocityGradientTexture;
  62122. private _createLimitVelocityGradientTexture;
  62123. private _createDragGradientTexture;
  62124. private _createColorGradientTexture;
  62125. /**
  62126. * Renders the particle system in its current state
  62127. * @param preWarm defines if the system should only update the particles but not render them
  62128. * @returns the current number of particles
  62129. */
  62130. render(preWarm?: boolean): number;
  62131. /**
  62132. * Rebuilds the particle system
  62133. */
  62134. rebuild(): void;
  62135. private _releaseBuffers;
  62136. private _releaseVAOs;
  62137. /**
  62138. * Disposes the particle system and free the associated resources
  62139. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  62140. */
  62141. dispose(disposeTexture?: boolean): void;
  62142. /**
  62143. * Clones the particle system.
  62144. * @param name The name of the cloned object
  62145. * @param newEmitter The new emitter to use
  62146. * @returns the cloned particle system
  62147. */
  62148. clone(name: string, newEmitter: any): GPUParticleSystem;
  62149. /**
  62150. * Serializes the particle system to a JSON object.
  62151. * @returns the JSON object
  62152. */
  62153. serialize(): any;
  62154. /**
  62155. * Parses a JSON object to create a GPU particle system.
  62156. * @param parsedParticleSystem The JSON object to parse
  62157. * @param scene The scene to create the particle system in
  62158. * @param rootUrl The root url to use to load external dependencies like texture
  62159. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  62160. * @returns the parsed GPU particle system
  62161. */
  62162. static Parse(parsedParticleSystem: any, scene: Scene, rootUrl: string, doNotStart?: boolean): GPUParticleSystem;
  62163. }
  62164. }
  62165. declare module "babylonjs/Particles/particleSystemSet" {
  62166. import { Nullable } from "babylonjs/types";
  62167. import { Color3 } from "babylonjs/Maths/math.color";
  62168. import { TransformNode } from "babylonjs/Meshes/transformNode";
  62169. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  62170. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  62171. import { Scene, IDisposable } from "babylonjs/scene";
  62172. /**
  62173. * Represents a set of particle systems working together to create a specific effect
  62174. */
  62175. export class ParticleSystemSet implements IDisposable {
  62176. /**
  62177. * Gets or sets base Assets URL
  62178. */
  62179. static BaseAssetsUrl: string;
  62180. private _emitterCreationOptions;
  62181. private _emitterNode;
  62182. /**
  62183. * Gets the particle system list
  62184. */
  62185. systems: IParticleSystem[];
  62186. /**
  62187. * Gets the emitter node used with this set
  62188. */
  62189. readonly emitterNode: Nullable<TransformNode>;
  62190. /**
  62191. * Creates a new emitter mesh as a sphere
  62192. * @param options defines the options used to create the sphere
  62193. * @param renderingGroupId defines the renderingGroupId to use for the sphere
  62194. * @param scene defines the hosting scene
  62195. */
  62196. setEmitterAsSphere(options: {
  62197. diameter: number;
  62198. segments: number;
  62199. color: Color3;
  62200. }, renderingGroupId: number, scene: Scene): void;
  62201. /**
  62202. * Starts all particle systems of the set
  62203. * @param emitter defines an optional mesh to use as emitter for the particle systems
  62204. */
  62205. start(emitter?: AbstractMesh): void;
  62206. /**
  62207. * Release all associated resources
  62208. */
  62209. dispose(): void;
  62210. /**
  62211. * Serialize the set into a JSON compatible object
  62212. * @returns a JSON compatible representation of the set
  62213. */
  62214. serialize(): any;
  62215. /**
  62216. * Parse a new ParticleSystemSet from a serialized source
  62217. * @param data defines a JSON compatible representation of the set
  62218. * @param scene defines the hosting scene
  62219. * @param gpu defines if we want GPU particles or CPU particles
  62220. * @returns a new ParticleSystemSet
  62221. */
  62222. static Parse(data: any, scene: Scene, gpu?: boolean): ParticleSystemSet;
  62223. }
  62224. }
  62225. declare module "babylonjs/Particles/particleHelper" {
  62226. import { Nullable } from "babylonjs/types";
  62227. import { Scene } from "babylonjs/scene";
  62228. import { Vector3 } from "babylonjs/Maths/math.vector";
  62229. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  62230. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  62231. import { ParticleSystemSet } from "babylonjs/Particles/particleSystemSet";
  62232. /**
  62233. * This class is made for on one-liner static method to help creating particle system set.
  62234. */
  62235. export class ParticleHelper {
  62236. /**
  62237. * Gets or sets base Assets URL
  62238. */
  62239. static BaseAssetsUrl: string;
  62240. /**
  62241. * Create a default particle system that you can tweak
  62242. * @param emitter defines the emitter to use
  62243. * @param capacity defines the system capacity (default is 500 particles)
  62244. * @param scene defines the hosting scene
  62245. * @param useGPU defines if a GPUParticleSystem must be created (default is false)
  62246. * @returns the new Particle system
  62247. */
  62248. static CreateDefault(emitter: Nullable<AbstractMesh | Vector3>, capacity?: number, scene?: Scene, useGPU?: boolean): IParticleSystem;
  62249. /**
  62250. * This is the main static method (one-liner) of this helper to create different particle systems
  62251. * @param type This string represents the type to the particle system to create
  62252. * @param scene The scene where the particle system should live
  62253. * @param gpu If the system will use gpu
  62254. * @returns the ParticleSystemSet created
  62255. */
  62256. static CreateAsync(type: string, scene: Nullable<Scene>, gpu?: boolean): Promise<ParticleSystemSet>;
  62257. /**
  62258. * Static function used to export a particle system to a ParticleSystemSet variable.
  62259. * Please note that the emitter shape is not exported
  62260. * @param systems defines the particle systems to export
  62261. * @returns the created particle system set
  62262. */
  62263. static ExportSet(systems: IParticleSystem[]): ParticleSystemSet;
  62264. }
  62265. }
  62266. declare module "babylonjs/Particles/particleSystemComponent" {
  62267. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  62268. import { Effect } from "babylonjs/Materials/effect";
  62269. import "babylonjs/Shaders/particles.vertex";
  62270. import { EffectFallbacks } from "babylonjs/Materials/effectFallbacks";
  62271. module "babylonjs/Engines/engine" {
  62272. interface Engine {
  62273. /**
  62274. * Create an effect to use with particle systems.
  62275. * Please note that some parameters like animation sheets or not being billboard are not supported in this configuration
  62276. * @param fragmentName defines the base name of the effect (The name of file without .fragment.fx)
  62277. * @param uniformsNames defines a list of attribute names
  62278. * @param samplers defines an array of string used to represent textures
  62279. * @param defines defines the string containing the defines to use to compile the shaders
  62280. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  62281. * @param onCompiled defines a function to call when the effect creation is successful
  62282. * @param onError defines a function to call when the effect creation has failed
  62283. * @returns the new Effect
  62284. */
  62285. createEffectForParticles(fragmentName: string, uniformsNames: string[], samplers: string[], defines: string, fallbacks?: EffectFallbacks, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): Effect;
  62286. }
  62287. }
  62288. module "babylonjs/Meshes/mesh" {
  62289. interface Mesh {
  62290. /**
  62291. * Returns an array populated with IParticleSystem objects whose the mesh is the emitter
  62292. * @returns an array of IParticleSystem
  62293. */
  62294. getEmittedParticleSystems(): IParticleSystem[];
  62295. /**
  62296. * Returns an array populated with IParticleSystem objects whose the mesh or its children are the emitter
  62297. * @returns an array of IParticleSystem
  62298. */
  62299. getHierarchyEmittedParticleSystems(): IParticleSystem[];
  62300. }
  62301. }
  62302. /**
  62303. * @hidden
  62304. */
  62305. export var _IDoNeedToBeInTheBuild: number;
  62306. }
  62307. declare module "babylonjs/Particles/pointsCloudSystem" {
  62308. import { Color4 } from "babylonjs/Maths/math";
  62309. import { Mesh } from "babylonjs/Meshes/mesh";
  62310. import { Scene, IDisposable } from "babylonjs/scene";
  62311. import { CloudPoint } from "babylonjs/Particles/cloudPoint";
  62312. /** Defines the 4 color options */
  62313. export enum PointColor {
  62314. /** color value */
  62315. Color = 2,
  62316. /** uv value */
  62317. UV = 1,
  62318. /** random value */
  62319. Random = 0,
  62320. /** stated value */
  62321. Stated = 3
  62322. }
  62323. /**
  62324. * The PointCloudSystem (PCS) is a single updatable mesh. The points corresponding to the vertices of this big mesh.
  62325. * 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.
  62326. * The PointCloudSytem is also a particle system, with each point being a particle. It provides some methods to manage the particles.
  62327. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  62328. *
  62329. * Full documentation here : TO BE ENTERED
  62330. */
  62331. export class PointsCloudSystem implements IDisposable {
  62332. /**
  62333. * The PCS array of cloud point objects. Just access each particle as with any classic array.
  62334. * Example : var p = SPS.particles[i];
  62335. */
  62336. particles: CloudPoint[];
  62337. /**
  62338. * The PCS total number of particles. Read only. Use PCS.counter instead if you need to set your own value.
  62339. */
  62340. nbParticles: number;
  62341. /**
  62342. * This a counter for your own usage. It's not set by any SPS functions.
  62343. */
  62344. counter: number;
  62345. /**
  62346. * The PCS name. This name is also given to the underlying mesh.
  62347. */
  62348. name: string;
  62349. /**
  62350. * The PCS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  62351. */
  62352. mesh: Mesh;
  62353. /**
  62354. * This empty object is intended to store some PCS specific or temporary values in order to lower the Garbage Collector activity.
  62355. * Please read :
  62356. */
  62357. vars: any;
  62358. /**
  62359. * @hidden
  62360. */
  62361. _size: number;
  62362. private _scene;
  62363. private _promises;
  62364. private _positions;
  62365. private _indices;
  62366. private _normals;
  62367. private _colors;
  62368. private _uvs;
  62369. private _indices32;
  62370. private _positions32;
  62371. private _colors32;
  62372. private _uvs32;
  62373. private _updatable;
  62374. private _isVisibilityBoxLocked;
  62375. private _alwaysVisible;
  62376. private _groups;
  62377. private _groupCounter;
  62378. private _computeParticleColor;
  62379. private _computeParticleTexture;
  62380. private _computeParticleRotation;
  62381. private _computeBoundingBox;
  62382. private _isReady;
  62383. /**
  62384. * Creates a PCS (Points Cloud System) object
  62385. * @param name (String) is the PCS name, this will be the underlying mesh name
  62386. * @param pointSize (number) is the size for each point
  62387. * @param scene (Scene) is the scene in which the PCS is added
  62388. * @param options defines the options of the PCS e.g.
  62389. * * updatable (optional boolean, default true) : if the PCS must be updatable or immutable
  62390. */
  62391. constructor(name: string, pointSize: number, scene: Scene, options?: {
  62392. updatable?: boolean;
  62393. });
  62394. /**
  62395. * Builds the PCS underlying mesh. Returns a standard Mesh.
  62396. * If no points were added to the PCS, the returned mesh is just a single point.
  62397. * @returns a promise for the created mesh
  62398. */
  62399. buildMeshAsync(): Promise<Mesh>;
  62400. /**
  62401. * @hidden
  62402. */
  62403. private _buildMesh;
  62404. private _addParticle;
  62405. private _randomUnitVector;
  62406. private _getColorIndicesForCoord;
  62407. private _setPointsColorOrUV;
  62408. private _colorFromTexture;
  62409. private _calculateDensity;
  62410. /**
  62411. * Adds points to the PCS in random positions within a unit sphere
  62412. * @param nb (positive integer) the number of particles to be created from this model
  62413. * @param pointFunction is an optional javascript function to be called for each particle on PCS creation
  62414. * @returns the number of groups in the system
  62415. */
  62416. addPoints(nb: number, pointFunction?: any): number;
  62417. /**
  62418. * Adds points to the PCS from the surface of the model shape
  62419. * @param mesh is any Mesh object that will be used as a surface model for the points
  62420. * @param nb (positive integer) the number of particles to be created from this model
  62421. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  62422. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  62423. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  62424. * @returns the number of groups in the system
  62425. */
  62426. addSurfacePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  62427. /**
  62428. * Adds points to the PCS inside the model shape
  62429. * @param mesh is any Mesh object that will be used as a surface model for the points
  62430. * @param nb (positive integer) the number of particles to be created from this model
  62431. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  62432. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  62433. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  62434. * @returns the number of groups in the system
  62435. */
  62436. addVolumePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  62437. /**
  62438. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  62439. * This method calls `updateParticle()` for each particle of the SPS.
  62440. * For an animated SPS, it is usually called within the render loop.
  62441. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  62442. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  62443. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  62444. * @returns the PCS.
  62445. */
  62446. setParticles(start?: number, end?: number, update?: boolean): PointsCloudSystem;
  62447. /**
  62448. * Disposes the PCS.
  62449. */
  62450. dispose(): void;
  62451. /**
  62452. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  62453. * doc :
  62454. * @returns the PCS.
  62455. */
  62456. refreshVisibleSize(): PointsCloudSystem;
  62457. /**
  62458. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  62459. * @param size the size (float) of the visibility box
  62460. * note : this doesn't lock the PCS mesh bounding box.
  62461. * doc :
  62462. */
  62463. setVisibilityBox(size: number): void;
  62464. /**
  62465. * Gets whether the PCS is always visible or not
  62466. * doc :
  62467. */
  62468. /**
  62469. * Sets the PCS as always visible or not
  62470. * doc :
  62471. */
  62472. isAlwaysVisible: boolean;
  62473. /**
  62474. * Tells to `setParticles()` to compute the particle rotations or not
  62475. * Default value : false. The PCS is faster when it's set to false
  62476. * Note : particle rotations are only applied to parent particles
  62477. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate
  62478. */
  62479. computeParticleRotation: boolean;
  62480. /**
  62481. * Tells to `setParticles()` to compute the particle colors or not.
  62482. * Default value : true. The PCS is faster when it's set to false.
  62483. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  62484. */
  62485. /**
  62486. * Gets if `setParticles()` computes the particle colors or not.
  62487. * Default value : false. The PCS is faster when it's set to false.
  62488. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  62489. */
  62490. computeParticleColor: boolean;
  62491. /**
  62492. * Gets if `setParticles()` computes the particle textures or not.
  62493. * Default value : false. The PCS is faster when it's set to false.
  62494. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  62495. */
  62496. computeParticleTexture: boolean;
  62497. /**
  62498. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  62499. */
  62500. /**
  62501. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  62502. */
  62503. computeBoundingBox: boolean;
  62504. /**
  62505. * This function does nothing. It may be overwritten to set all the particle first values.
  62506. * The PCS doesn't call this function, you may have to call it by your own.
  62507. * doc :
  62508. */
  62509. initParticles(): void;
  62510. /**
  62511. * This function does nothing. It may be overwritten to recycle a particle
  62512. * The PCS doesn't call this function, you can to call it
  62513. * doc :
  62514. * @param particle The particle to recycle
  62515. * @returns the recycled particle
  62516. */
  62517. recycleParticle(particle: CloudPoint): CloudPoint;
  62518. /**
  62519. * Updates a particle : this function should be overwritten by the user.
  62520. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  62521. * doc :
  62522. * @example : just set a particle position or velocity and recycle conditions
  62523. * @param particle The particle to update
  62524. * @returns the updated particle
  62525. */
  62526. updateParticle(particle: CloudPoint): CloudPoint;
  62527. /**
  62528. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  62529. * This does nothing and may be overwritten by the user.
  62530. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  62531. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  62532. * @param update the boolean update value actually passed to setParticles()
  62533. */
  62534. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  62535. /**
  62536. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  62537. * This will be passed three parameters.
  62538. * This does nothing and may be overwritten by the user.
  62539. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  62540. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  62541. * @param update the boolean update value actually passed to setParticles()
  62542. */
  62543. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  62544. }
  62545. }
  62546. declare module "babylonjs/Particles/cloudPoint" {
  62547. import { Nullable } from "babylonjs/types";
  62548. import { Color4, Vector2, Vector3, Matrix, Quaternion } from "babylonjs/Maths/math";
  62549. import { Mesh } from "babylonjs/Meshes/mesh";
  62550. import { BoundingInfo } from "babylonjs/Culling/boundingInfo";
  62551. import { PointsCloudSystem } from "babylonjs/Particles/pointsCloudSystem";
  62552. /**
  62553. * Represents one particle of a points cloud system.
  62554. */
  62555. export class CloudPoint {
  62556. /**
  62557. * particle global index
  62558. */
  62559. idx: number;
  62560. /**
  62561. * The color of the particle
  62562. */
  62563. color: Nullable<Color4>;
  62564. /**
  62565. * The world space position of the particle.
  62566. */
  62567. position: Vector3;
  62568. /**
  62569. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  62570. */
  62571. rotation: Vector3;
  62572. /**
  62573. * The world space rotation quaternion of the particle.
  62574. */
  62575. rotationQuaternion: Nullable<Quaternion>;
  62576. /**
  62577. * The uv of the particle.
  62578. */
  62579. uv: Nullable<Vector2>;
  62580. /**
  62581. * The current speed of the particle.
  62582. */
  62583. velocity: Vector3;
  62584. /**
  62585. * The pivot point in the particle local space.
  62586. */
  62587. pivot: Vector3;
  62588. /**
  62589. * Must the particle be translated from its pivot point in its local space ?
  62590. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  62591. * Default : false
  62592. */
  62593. translateFromPivot: boolean;
  62594. /**
  62595. * Index of this particle in the global "positions" array (Internal use)
  62596. * @hidden
  62597. */
  62598. _pos: number;
  62599. /**
  62600. * @hidden Index of this particle in the global "indices" array (Internal use)
  62601. */
  62602. _ind: number;
  62603. /**
  62604. * Group this particle belongs to
  62605. */
  62606. _group: PointsGroup;
  62607. /**
  62608. * Group id of this particle
  62609. */
  62610. groupId: number;
  62611. /**
  62612. * Index of the particle in its group id (Internal use)
  62613. */
  62614. idxInGroup: number;
  62615. /**
  62616. * @hidden Particle BoundingInfo object (Internal use)
  62617. */
  62618. _boundingInfo: BoundingInfo;
  62619. /**
  62620. * @hidden Reference to the PCS that the particle belongs to (Internal use)
  62621. */
  62622. _pcs: PointsCloudSystem;
  62623. /**
  62624. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  62625. */
  62626. _stillInvisible: boolean;
  62627. /**
  62628. * @hidden Last computed particle rotation matrix
  62629. */
  62630. _rotationMatrix: number[];
  62631. /**
  62632. * Parent particle Id, if any.
  62633. * Default null.
  62634. */
  62635. parentId: Nullable<number>;
  62636. /**
  62637. * @hidden Internal global position in the PCS.
  62638. */
  62639. _globalPosition: Vector3;
  62640. /**
  62641. * Creates a Point Cloud object.
  62642. * Don't create particles manually, use instead the PCS internal tools like _addParticle()
  62643. * @param particleIndex (integer) is the particle index in the PCS pool. It's also the particle identifier.
  62644. * @param group (PointsGroup) is the group the particle belongs to
  62645. * @param groupId (integer) is the group identifier in the PCS.
  62646. * @param idxInGroup (integer) is the index of the particle in the current point group (ex: the 10th point of addPoints(30))
  62647. * @param pcs defines the PCS it is associated to
  62648. */
  62649. constructor(particleIndex: number, group: PointsGroup, groupId: number, idxInGroup: number, pcs: PointsCloudSystem);
  62650. /**
  62651. * get point size
  62652. */
  62653. /**
  62654. * Set point size
  62655. */
  62656. size: Vector3;
  62657. /**
  62658. * Legacy support, changed quaternion to rotationQuaternion
  62659. */
  62660. /**
  62661. * Legacy support, changed quaternion to rotationQuaternion
  62662. */
  62663. quaternion: Nullable<Quaternion>;
  62664. /**
  62665. * Returns a boolean. True if the particle intersects a mesh, else false
  62666. * The intersection is computed on the particle position and Axis Aligned Bounding Box (AABB) or Sphere
  62667. * @param target is the object (point or mesh) what the intersection is computed against
  62668. * @param isSphere is boolean flag when false (default) bounding box of mesh is used, when true the bouding sphere is used
  62669. * @returns true if it intersects
  62670. */
  62671. intersectsMesh(target: Mesh, isSphere: boolean): boolean;
  62672. /**
  62673. * get the rotation matrix of the particle
  62674. * @hidden
  62675. */
  62676. getRotationMatrix(m: Matrix): void;
  62677. }
  62678. /**
  62679. * Represents a group of points in a points cloud system
  62680. * * PCS internal tool, don't use it manually.
  62681. */
  62682. export class PointsGroup {
  62683. /**
  62684. * The group id
  62685. * @hidden
  62686. */
  62687. groupID: number;
  62688. /**
  62689. * image data for group (internal use)
  62690. * @hidden
  62691. */
  62692. _groupImageData: Nullable<ArrayBufferView>;
  62693. /**
  62694. * Image Width (internal use)
  62695. * @hidden
  62696. */
  62697. _groupImgWidth: number;
  62698. /**
  62699. * Image Height (internal use)
  62700. * @hidden
  62701. */
  62702. _groupImgHeight: number;
  62703. /**
  62704. * Custom position function (internal use)
  62705. * @hidden
  62706. */
  62707. _positionFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>;
  62708. /**
  62709. * density per facet for surface points
  62710. * @hidden
  62711. */
  62712. _groupDensity: number[];
  62713. /**
  62714. * Only when points are colored by texture carries pointer to texture list array
  62715. * @hidden
  62716. */
  62717. _textureNb: number;
  62718. /**
  62719. * Creates a points group object. This is an internal reference to produce particles for the PCS.
  62720. * PCS internal tool, don't use it manually.
  62721. * @hidden
  62722. */
  62723. constructor(id: number, posFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>);
  62724. }
  62725. }
  62726. declare module "babylonjs/Particles/index" {
  62727. export * from "babylonjs/Particles/baseParticleSystem";
  62728. export * from "babylonjs/Particles/EmitterTypes/index";
  62729. export * from "babylonjs/Particles/gpuParticleSystem";
  62730. export * from "babylonjs/Particles/IParticleSystem";
  62731. export * from "babylonjs/Particles/particle";
  62732. export * from "babylonjs/Particles/particleHelper";
  62733. export * from "babylonjs/Particles/particleSystem";
  62734. export * from "babylonjs/Particles/particleSystemComponent";
  62735. export * from "babylonjs/Particles/particleSystemSet";
  62736. export * from "babylonjs/Particles/solidParticle";
  62737. export * from "babylonjs/Particles/solidParticleSystem";
  62738. export * from "babylonjs/Particles/cloudPoint";
  62739. export * from "babylonjs/Particles/pointsCloudSystem";
  62740. export * from "babylonjs/Particles/subEmitter";
  62741. }
  62742. declare module "babylonjs/Physics/physicsEngineComponent" {
  62743. import { Nullable } from "babylonjs/types";
  62744. import { Observable, Observer } from "babylonjs/Misc/observable";
  62745. import { Vector3 } from "babylonjs/Maths/math.vector";
  62746. import { Mesh } from "babylonjs/Meshes/mesh";
  62747. import { ISceneComponent } from "babylonjs/sceneComponent";
  62748. import { Scene } from "babylonjs/scene";
  62749. import { Node } from "babylonjs/node";
  62750. import { IPhysicsEngine, IPhysicsEnginePlugin } from "babylonjs/Physics/IPhysicsEngine";
  62751. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  62752. module "babylonjs/scene" {
  62753. interface Scene {
  62754. /** @hidden (Backing field) */
  62755. _physicsEngine: Nullable<IPhysicsEngine>;
  62756. /**
  62757. * Gets the current physics engine
  62758. * @returns a IPhysicsEngine or null if none attached
  62759. */
  62760. getPhysicsEngine(): Nullable<IPhysicsEngine>;
  62761. /**
  62762. * Enables physics to the current scene
  62763. * @param gravity defines the scene's gravity for the physics engine
  62764. * @param plugin defines the physics engine to be used. defaults to OimoJS.
  62765. * @return a boolean indicating if the physics engine was initialized
  62766. */
  62767. enablePhysics(gravity: Nullable<Vector3>, plugin?: IPhysicsEnginePlugin): boolean;
  62768. /**
  62769. * Disables and disposes the physics engine associated with the scene
  62770. */
  62771. disablePhysicsEngine(): void;
  62772. /**
  62773. * Gets a boolean indicating if there is an active physics engine
  62774. * @returns a boolean indicating if there is an active physics engine
  62775. */
  62776. isPhysicsEnabled(): boolean;
  62777. /**
  62778. * Deletes a physics compound impostor
  62779. * @param compound defines the compound to delete
  62780. */
  62781. deleteCompoundImpostor(compound: any): void;
  62782. /**
  62783. * An event triggered when physic simulation is about to be run
  62784. */
  62785. onBeforePhysicsObservable: Observable<Scene>;
  62786. /**
  62787. * An event triggered when physic simulation has been done
  62788. */
  62789. onAfterPhysicsObservable: Observable<Scene>;
  62790. }
  62791. }
  62792. module "babylonjs/Meshes/abstractMesh" {
  62793. interface AbstractMesh {
  62794. /** @hidden */
  62795. _physicsImpostor: Nullable<PhysicsImpostor>;
  62796. /**
  62797. * Gets or sets impostor used for physic simulation
  62798. * @see http://doc.babylonjs.com/features/physics_engine
  62799. */
  62800. physicsImpostor: Nullable<PhysicsImpostor>;
  62801. /**
  62802. * Gets the current physics impostor
  62803. * @see http://doc.babylonjs.com/features/physics_engine
  62804. * @returns a physics impostor or null
  62805. */
  62806. getPhysicsImpostor(): Nullable<PhysicsImpostor>;
  62807. /** Apply a physic impulse to the mesh
  62808. * @param force defines the force to apply
  62809. * @param contactPoint defines where to apply the force
  62810. * @returns the current mesh
  62811. * @see http://doc.babylonjs.com/how_to/using_the_physics_engine
  62812. */
  62813. applyImpulse(force: Vector3, contactPoint: Vector3): AbstractMesh;
  62814. /**
  62815. * Creates a physic joint between two meshes
  62816. * @param otherMesh defines the other mesh to use
  62817. * @param pivot1 defines the pivot to use on this mesh
  62818. * @param pivot2 defines the pivot to use on the other mesh
  62819. * @param options defines additional options (can be plugin dependent)
  62820. * @returns the current mesh
  62821. * @see https://www.babylonjs-playground.com/#0BS5U0#0
  62822. */
  62823. setPhysicsLinkWith(otherMesh: Mesh, pivot1: Vector3, pivot2: Vector3, options?: any): AbstractMesh;
  62824. /** @hidden */
  62825. _disposePhysicsObserver: Nullable<Observer<Node>>;
  62826. }
  62827. }
  62828. /**
  62829. * Defines the physics engine scene component responsible to manage a physics engine
  62830. */
  62831. export class PhysicsEngineSceneComponent implements ISceneComponent {
  62832. /**
  62833. * The component name helpful to identify the component in the list of scene components.
  62834. */
  62835. readonly name: string;
  62836. /**
  62837. * The scene the component belongs to.
  62838. */
  62839. scene: Scene;
  62840. /**
  62841. * Creates a new instance of the component for the given scene
  62842. * @param scene Defines the scene to register the component in
  62843. */
  62844. constructor(scene: Scene);
  62845. /**
  62846. * Registers the component in a given scene
  62847. */
  62848. register(): void;
  62849. /**
  62850. * Rebuilds the elements related to this component in case of
  62851. * context lost for instance.
  62852. */
  62853. rebuild(): void;
  62854. /**
  62855. * Disposes the component and the associated ressources
  62856. */
  62857. dispose(): void;
  62858. }
  62859. }
  62860. declare module "babylonjs/Physics/physicsHelper" {
  62861. import { Nullable } from "babylonjs/types";
  62862. import { Vector3 } from "babylonjs/Maths/math.vector";
  62863. import { Mesh } from "babylonjs/Meshes/mesh";
  62864. import { Scene } from "babylonjs/scene";
  62865. import { PhysicsImpostor } from "babylonjs/Physics/physicsImpostor";
  62866. /**
  62867. * A helper for physics simulations
  62868. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  62869. */
  62870. export class PhysicsHelper {
  62871. private _scene;
  62872. private _physicsEngine;
  62873. /**
  62874. * Initializes the Physics helper
  62875. * @param scene Babylon.js scene
  62876. */
  62877. constructor(scene: Scene);
  62878. /**
  62879. * Applies a radial explosion impulse
  62880. * @param origin the origin of the explosion
  62881. * @param radiusOrEventOptions the radius or the options of radial explosion
  62882. * @param strength the explosion strength
  62883. * @param falloff possible options: Constant & Linear. Defaults to Constant
  62884. * @returns A physics radial explosion event, or null
  62885. */
  62886. applyRadialExplosionImpulse(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  62887. /**
  62888. * Applies a radial explosion force
  62889. * @param origin the origin of the explosion
  62890. * @param radiusOrEventOptions the radius or the options of radial explosion
  62891. * @param strength the explosion strength
  62892. * @param falloff possible options: Constant & Linear. Defaults to Constant
  62893. * @returns A physics radial explosion event, or null
  62894. */
  62895. applyRadialExplosionForce(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  62896. /**
  62897. * Creates a gravitational field
  62898. * @param origin the origin of the explosion
  62899. * @param radiusOrEventOptions the radius or the options of radial explosion
  62900. * @param strength the explosion strength
  62901. * @param falloff possible options: Constant & Linear. Defaults to Constant
  62902. * @returns A physics gravitational field event, or null
  62903. */
  62904. gravitationalField(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsGravitationalFieldEvent>;
  62905. /**
  62906. * Creates a physics updraft event
  62907. * @param origin the origin of the updraft
  62908. * @param radiusOrEventOptions the radius or the options of the updraft
  62909. * @param strength the strength of the updraft
  62910. * @param height the height of the updraft
  62911. * @param updraftMode possible options: Center & Perpendicular. Defaults to Center
  62912. * @returns A physics updraft event, or null
  62913. */
  62914. updraft(origin: Vector3, radiusOrEventOptions: number | PhysicsUpdraftEventOptions, strength?: number, height?: number, updraftMode?: PhysicsUpdraftMode): Nullable<PhysicsUpdraftEvent>;
  62915. /**
  62916. * Creates a physics vortex event
  62917. * @param origin the of the vortex
  62918. * @param radiusOrEventOptions the radius or the options of the vortex
  62919. * @param strength the strength of the vortex
  62920. * @param height the height of the vortex
  62921. * @returns a Physics vortex event, or null
  62922. * A physics vortex event or null
  62923. */
  62924. vortex(origin: Vector3, radiusOrEventOptions: number | PhysicsVortexEventOptions, strength?: number, height?: number): Nullable<PhysicsVortexEvent>;
  62925. }
  62926. /**
  62927. * Represents a physics radial explosion event
  62928. */
  62929. class PhysicsRadialExplosionEvent {
  62930. private _scene;
  62931. private _options;
  62932. private _sphere;
  62933. private _dataFetched;
  62934. /**
  62935. * Initializes a radial explosioin event
  62936. * @param _scene BabylonJS scene
  62937. * @param _options The options for the vortex event
  62938. */
  62939. constructor(_scene: Scene, _options: PhysicsRadialExplosionEventOptions);
  62940. /**
  62941. * Returns the data related to the radial explosion event (sphere).
  62942. * @returns The radial explosion event data
  62943. */
  62944. getData(): PhysicsRadialExplosionEventData;
  62945. /**
  62946. * Returns the force and contact point of the impostor or false, if the impostor is not affected by the force/impulse.
  62947. * @param impostor A physics imposter
  62948. * @param origin the origin of the explosion
  62949. * @returns {Nullable<PhysicsHitData>} A physics force and contact point, or null
  62950. */
  62951. getImpostorHitData(impostor: PhysicsImpostor, origin: Vector3): Nullable<PhysicsHitData>;
  62952. /**
  62953. * Triggers affecterd impostors callbacks
  62954. * @param affectedImpostorsWithData defines the list of affected impostors (including associated data)
  62955. */
  62956. triggerAffectedImpostorsCallback(affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>): void;
  62957. /**
  62958. * Disposes the sphere.
  62959. * @param force Specifies if the sphere should be disposed by force
  62960. */
  62961. dispose(force?: boolean): void;
  62962. /*** Helpers ***/
  62963. private _prepareSphere;
  62964. private _intersectsWithSphere;
  62965. }
  62966. /**
  62967. * Represents a gravitational field event
  62968. */
  62969. class PhysicsGravitationalFieldEvent {
  62970. private _physicsHelper;
  62971. private _scene;
  62972. private _origin;
  62973. private _options;
  62974. private _tickCallback;
  62975. private _sphere;
  62976. private _dataFetched;
  62977. /**
  62978. * Initializes the physics gravitational field event
  62979. * @param _physicsHelper A physics helper
  62980. * @param _scene BabylonJS scene
  62981. * @param _origin The origin position of the gravitational field event
  62982. * @param _options The options for the vortex event
  62983. */
  62984. constructor(_physicsHelper: PhysicsHelper, _scene: Scene, _origin: Vector3, _options: PhysicsRadialExplosionEventOptions);
  62985. /**
  62986. * Returns the data related to the gravitational field event (sphere).
  62987. * @returns A gravitational field event
  62988. */
  62989. getData(): PhysicsGravitationalFieldEventData;
  62990. /**
  62991. * Enables the gravitational field.
  62992. */
  62993. enable(): void;
  62994. /**
  62995. * Disables the gravitational field.
  62996. */
  62997. disable(): void;
  62998. /**
  62999. * Disposes the sphere.
  63000. * @param force The force to dispose from the gravitational field event
  63001. */
  63002. dispose(force?: boolean): void;
  63003. private _tick;
  63004. }
  63005. /**
  63006. * Represents a physics updraft event
  63007. */
  63008. class PhysicsUpdraftEvent {
  63009. private _scene;
  63010. private _origin;
  63011. private _options;
  63012. private _physicsEngine;
  63013. private _originTop;
  63014. private _originDirection;
  63015. private _tickCallback;
  63016. private _cylinder;
  63017. private _cylinderPosition;
  63018. private _dataFetched;
  63019. /**
  63020. * Initializes the physics updraft event
  63021. * @param _scene BabylonJS scene
  63022. * @param _origin The origin position of the updraft
  63023. * @param _options The options for the updraft event
  63024. */
  63025. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsUpdraftEventOptions);
  63026. /**
  63027. * Returns the data related to the updraft event (cylinder).
  63028. * @returns A physics updraft event
  63029. */
  63030. getData(): PhysicsUpdraftEventData;
  63031. /**
  63032. * Enables the updraft.
  63033. */
  63034. enable(): void;
  63035. /**
  63036. * Disables the updraft.
  63037. */
  63038. disable(): void;
  63039. /**
  63040. * Disposes the cylinder.
  63041. * @param force Specifies if the updraft should be disposed by force
  63042. */
  63043. dispose(force?: boolean): void;
  63044. private getImpostorHitData;
  63045. private _tick;
  63046. /*** Helpers ***/
  63047. private _prepareCylinder;
  63048. private _intersectsWithCylinder;
  63049. }
  63050. /**
  63051. * Represents a physics vortex event
  63052. */
  63053. class PhysicsVortexEvent {
  63054. private _scene;
  63055. private _origin;
  63056. private _options;
  63057. private _physicsEngine;
  63058. private _originTop;
  63059. private _tickCallback;
  63060. private _cylinder;
  63061. private _cylinderPosition;
  63062. private _dataFetched;
  63063. /**
  63064. * Initializes the physics vortex event
  63065. * @param _scene The BabylonJS scene
  63066. * @param _origin The origin position of the vortex
  63067. * @param _options The options for the vortex event
  63068. */
  63069. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsVortexEventOptions);
  63070. /**
  63071. * Returns the data related to the vortex event (cylinder).
  63072. * @returns The physics vortex event data
  63073. */
  63074. getData(): PhysicsVortexEventData;
  63075. /**
  63076. * Enables the vortex.
  63077. */
  63078. enable(): void;
  63079. /**
  63080. * Disables the cortex.
  63081. */
  63082. disable(): void;
  63083. /**
  63084. * Disposes the sphere.
  63085. * @param force
  63086. */
  63087. dispose(force?: boolean): void;
  63088. private getImpostorHitData;
  63089. private _tick;
  63090. /*** Helpers ***/
  63091. private _prepareCylinder;
  63092. private _intersectsWithCylinder;
  63093. }
  63094. /**
  63095. * Options fot the radial explosion event
  63096. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  63097. */
  63098. export class PhysicsRadialExplosionEventOptions {
  63099. /**
  63100. * The radius of the sphere for the radial explosion.
  63101. */
  63102. radius: number;
  63103. /**
  63104. * The strenth of the explosion.
  63105. */
  63106. strength: number;
  63107. /**
  63108. * The strenght of the force in correspondence to the distance of the affected object
  63109. */
  63110. falloff: PhysicsRadialImpulseFalloff;
  63111. /**
  63112. * Sphere options for the radial explosion.
  63113. */
  63114. sphere: {
  63115. segments: number;
  63116. diameter: number;
  63117. };
  63118. /**
  63119. * Sphere options for the radial explosion.
  63120. */
  63121. affectedImpostorsCallback: (affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>) => void;
  63122. }
  63123. /**
  63124. * Options fot the updraft event
  63125. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  63126. */
  63127. export class PhysicsUpdraftEventOptions {
  63128. /**
  63129. * The radius of the cylinder for the vortex
  63130. */
  63131. radius: number;
  63132. /**
  63133. * The strenth of the updraft.
  63134. */
  63135. strength: number;
  63136. /**
  63137. * The height of the cylinder for the updraft.
  63138. */
  63139. height: number;
  63140. /**
  63141. * The mode for the the updraft.
  63142. */
  63143. updraftMode: PhysicsUpdraftMode;
  63144. }
  63145. /**
  63146. * Options fot the vortex event
  63147. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  63148. */
  63149. export class PhysicsVortexEventOptions {
  63150. /**
  63151. * The radius of the cylinder for the vortex
  63152. */
  63153. radius: number;
  63154. /**
  63155. * The strenth of the vortex.
  63156. */
  63157. strength: number;
  63158. /**
  63159. * The height of the cylinder for the vortex.
  63160. */
  63161. height: number;
  63162. /**
  63163. * At which distance, relative to the radius the centripetal forces should kick in? Range: 0-1
  63164. */
  63165. centripetalForceThreshold: number;
  63166. /**
  63167. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when below the treshold.
  63168. */
  63169. centripetalForceMultiplier: number;
  63170. /**
  63171. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when above the treshold.
  63172. */
  63173. centrifugalForceMultiplier: number;
  63174. /**
  63175. * This multiplier determines with how much force the objects will be pushed upwards, when in the vortex.
  63176. */
  63177. updraftForceMultiplier: number;
  63178. }
  63179. /**
  63180. * The strenght of the force in correspondence to the distance of the affected object
  63181. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  63182. */
  63183. export enum PhysicsRadialImpulseFalloff {
  63184. /** Defines that impulse is constant in strength across it's whole radius */
  63185. Constant = 0,
  63186. /** Defines that impulse gets weaker if it's further from the origin */
  63187. Linear = 1
  63188. }
  63189. /**
  63190. * The strength of the force in correspondence to the distance of the affected object
  63191. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  63192. */
  63193. export enum PhysicsUpdraftMode {
  63194. /** Defines that the upstream forces will pull towards the top center of the cylinder */
  63195. Center = 0,
  63196. /** Defines that once a impostor is inside the cylinder, it will shoot out perpendicular from the ground of the cylinder */
  63197. Perpendicular = 1
  63198. }
  63199. /**
  63200. * Interface for a physics hit data
  63201. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  63202. */
  63203. export interface PhysicsHitData {
  63204. /**
  63205. * The force applied at the contact point
  63206. */
  63207. force: Vector3;
  63208. /**
  63209. * The contact point
  63210. */
  63211. contactPoint: Vector3;
  63212. /**
  63213. * The distance from the origin to the contact point
  63214. */
  63215. distanceFromOrigin: number;
  63216. }
  63217. /**
  63218. * Interface for radial explosion event data
  63219. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  63220. */
  63221. export interface PhysicsRadialExplosionEventData {
  63222. /**
  63223. * A sphere used for the radial explosion event
  63224. */
  63225. sphere: Mesh;
  63226. }
  63227. /**
  63228. * Interface for gravitational field event data
  63229. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  63230. */
  63231. export interface PhysicsGravitationalFieldEventData {
  63232. /**
  63233. * A sphere mesh used for the gravitational field event
  63234. */
  63235. sphere: Mesh;
  63236. }
  63237. /**
  63238. * Interface for updraft event data
  63239. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  63240. */
  63241. export interface PhysicsUpdraftEventData {
  63242. /**
  63243. * A cylinder used for the updraft event
  63244. */
  63245. cylinder: Mesh;
  63246. }
  63247. /**
  63248. * Interface for vortex event data
  63249. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  63250. */
  63251. export interface PhysicsVortexEventData {
  63252. /**
  63253. * A cylinder used for the vortex event
  63254. */
  63255. cylinder: Mesh;
  63256. }
  63257. /**
  63258. * Interface for an affected physics impostor
  63259. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  63260. */
  63261. export interface PhysicsAffectedImpostorWithData {
  63262. /**
  63263. * The impostor affected by the effect
  63264. */
  63265. impostor: PhysicsImpostor;
  63266. /**
  63267. * The data about the hit/horce from the explosion
  63268. */
  63269. hitData: PhysicsHitData;
  63270. }
  63271. }
  63272. declare module "babylonjs/Physics/Plugins/index" {
  63273. export * from "babylonjs/Physics/Plugins/cannonJSPlugin";
  63274. export * from "babylonjs/Physics/Plugins/ammoJSPlugin";
  63275. export * from "babylonjs/Physics/Plugins/oimoJSPlugin";
  63276. }
  63277. declare module "babylonjs/Physics/index" {
  63278. export * from "babylonjs/Physics/IPhysicsEngine";
  63279. export * from "babylonjs/Physics/physicsEngine";
  63280. export * from "babylonjs/Physics/physicsEngineComponent";
  63281. export * from "babylonjs/Physics/physicsHelper";
  63282. export * from "babylonjs/Physics/physicsImpostor";
  63283. export * from "babylonjs/Physics/physicsJoint";
  63284. export * from "babylonjs/Physics/Plugins/index";
  63285. }
  63286. declare module "babylonjs/Shaders/blackAndWhite.fragment" {
  63287. /** @hidden */
  63288. export var blackAndWhitePixelShader: {
  63289. name: string;
  63290. shader: string;
  63291. };
  63292. }
  63293. declare module "babylonjs/PostProcesses/blackAndWhitePostProcess" {
  63294. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  63295. import { Camera } from "babylonjs/Cameras/camera";
  63296. import { Engine } from "babylonjs/Engines/engine";
  63297. import "babylonjs/Shaders/blackAndWhite.fragment";
  63298. /**
  63299. * Post process used to render in black and white
  63300. */
  63301. export class BlackAndWhitePostProcess extends PostProcess {
  63302. /**
  63303. * Linear about to convert he result to black and white (default: 1)
  63304. */
  63305. degree: number;
  63306. /**
  63307. * Creates a black and white post process
  63308. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#black-and-white
  63309. * @param name The name of the effect.
  63310. * @param options The required width/height ratio to downsize to before computing the render pass.
  63311. * @param camera The camera to apply the render pass to.
  63312. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  63313. * @param engine The engine which the post process will be applied. (default: current engine)
  63314. * @param reusable If the post process can be reused on the same frame. (default: false)
  63315. */
  63316. constructor(name: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  63317. }
  63318. }
  63319. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect" {
  63320. import { Nullable } from "babylonjs/types";
  63321. import { Camera } from "babylonjs/Cameras/camera";
  63322. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  63323. import { Engine } from "babylonjs/Engines/engine";
  63324. /**
  63325. * This represents a set of one or more post processes in Babylon.
  63326. * A post process can be used to apply a shader to a texture after it is rendered.
  63327. * @example https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  63328. */
  63329. export class PostProcessRenderEffect {
  63330. private _postProcesses;
  63331. private _getPostProcesses;
  63332. private _singleInstance;
  63333. private _cameras;
  63334. private _indicesForCamera;
  63335. /**
  63336. * Name of the effect
  63337. * @hidden
  63338. */
  63339. _name: string;
  63340. /**
  63341. * Instantiates a post process render effect.
  63342. * A post process can be used to apply a shader to a texture after it is rendered.
  63343. * @param engine The engine the effect is tied to
  63344. * @param name The name of the effect
  63345. * @param getPostProcesses A function that returns a set of post processes which the effect will run in order to be run.
  63346. * @param singleInstance False if this post process can be run on multiple cameras. (default: true)
  63347. */
  63348. constructor(engine: Engine, name: string, getPostProcesses: () => Nullable<PostProcess | Array<PostProcess>>, singleInstance?: boolean);
  63349. /**
  63350. * Checks if all the post processes in the effect are supported.
  63351. */
  63352. readonly isSupported: boolean;
  63353. /**
  63354. * Updates the current state of the effect
  63355. * @hidden
  63356. */
  63357. _update(): void;
  63358. /**
  63359. * Attaches the effect on cameras
  63360. * @param cameras The camera to attach to.
  63361. * @hidden
  63362. */
  63363. _attachCameras(cameras: Camera): void;
  63364. /**
  63365. * Attaches the effect on cameras
  63366. * @param cameras The camera to attach to.
  63367. * @hidden
  63368. */
  63369. _attachCameras(cameras: Camera[]): void;
  63370. /**
  63371. * Detaches the effect on cameras
  63372. * @param cameras The camera to detatch from.
  63373. * @hidden
  63374. */
  63375. _detachCameras(cameras: Camera): void;
  63376. /**
  63377. * Detatches the effect on cameras
  63378. * @param cameras The camera to detatch from.
  63379. * @hidden
  63380. */
  63381. _detachCameras(cameras: Camera[]): void;
  63382. /**
  63383. * Enables the effect on given cameras
  63384. * @param cameras The camera to enable.
  63385. * @hidden
  63386. */
  63387. _enable(cameras: Camera): void;
  63388. /**
  63389. * Enables the effect on given cameras
  63390. * @param cameras The camera to enable.
  63391. * @hidden
  63392. */
  63393. _enable(cameras: Nullable<Camera[]>): void;
  63394. /**
  63395. * Disables the effect on the given cameras
  63396. * @param cameras The camera to disable.
  63397. * @hidden
  63398. */
  63399. _disable(cameras: Camera): void;
  63400. /**
  63401. * Disables the effect on the given cameras
  63402. * @param cameras The camera to disable.
  63403. * @hidden
  63404. */
  63405. _disable(cameras: Nullable<Camera[]>): void;
  63406. /**
  63407. * Gets a list of the post processes contained in the effect.
  63408. * @param camera The camera to get the post processes on.
  63409. * @returns The list of the post processes in the effect.
  63410. */
  63411. getPostProcesses(camera?: Camera): Nullable<Array<PostProcess>>;
  63412. }
  63413. }
  63414. declare module "babylonjs/Shaders/extractHighlights.fragment" {
  63415. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  63416. /** @hidden */
  63417. export var extractHighlightsPixelShader: {
  63418. name: string;
  63419. shader: string;
  63420. };
  63421. }
  63422. declare module "babylonjs/PostProcesses/extractHighlightsPostProcess" {
  63423. import { Nullable } from "babylonjs/types";
  63424. import { Camera } from "babylonjs/Cameras/camera";
  63425. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  63426. import { Engine } from "babylonjs/Engines/engine";
  63427. import "babylonjs/Shaders/extractHighlights.fragment";
  63428. /**
  63429. * 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.
  63430. */
  63431. export class ExtractHighlightsPostProcess extends PostProcess {
  63432. /**
  63433. * The luminance threshold, pixels below this value will be set to black.
  63434. */
  63435. threshold: number;
  63436. /** @hidden */
  63437. _exposure: number;
  63438. /**
  63439. * Post process which has the input texture to be used when performing highlight extraction
  63440. * @hidden
  63441. */
  63442. _inputPostProcess: Nullable<PostProcess>;
  63443. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  63444. }
  63445. }
  63446. declare module "babylonjs/Shaders/bloomMerge.fragment" {
  63447. /** @hidden */
  63448. export var bloomMergePixelShader: {
  63449. name: string;
  63450. shader: string;
  63451. };
  63452. }
  63453. declare module "babylonjs/PostProcesses/bloomMergePostProcess" {
  63454. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  63455. import { Nullable } from "babylonjs/types";
  63456. import { Engine } from "babylonjs/Engines/engine";
  63457. import { Camera } from "babylonjs/Cameras/camera";
  63458. import "babylonjs/Shaders/bloomMerge.fragment";
  63459. /**
  63460. * The BloomMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  63461. */
  63462. export class BloomMergePostProcess extends PostProcess {
  63463. /** Weight of the bloom to be added to the original input. */
  63464. weight: number;
  63465. /**
  63466. * Creates a new instance of @see BloomMergePostProcess
  63467. * @param name The name of the effect.
  63468. * @param originalFromInput Post process which's input will be used for the merge.
  63469. * @param blurred Blurred highlights post process which's output will be used.
  63470. * @param weight Weight of the bloom to be added to the original input.
  63471. * @param options The required width/height ratio to downsize to before computing the render pass.
  63472. * @param camera The camera to apply the render pass to.
  63473. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  63474. * @param engine The engine which the post process will be applied. (default: current engine)
  63475. * @param reusable If the post process can be reused on the same frame. (default: false)
  63476. * @param textureType Type of textures used when performing the post process. (default: 0)
  63477. * @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)
  63478. */
  63479. constructor(name: string, originalFromInput: PostProcess, blurred: PostProcess,
  63480. /** Weight of the bloom to be added to the original input. */
  63481. weight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  63482. }
  63483. }
  63484. declare module "babylonjs/PostProcesses/bloomEffect" {
  63485. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  63486. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  63487. import { ExtractHighlightsPostProcess } from "babylonjs/PostProcesses/extractHighlightsPostProcess";
  63488. import { Camera } from "babylonjs/Cameras/camera";
  63489. import { Scene } from "babylonjs/scene";
  63490. /**
  63491. * The bloom effect spreads bright areas of an image to simulate artifacts seen in cameras
  63492. */
  63493. export class BloomEffect extends PostProcessRenderEffect {
  63494. private bloomScale;
  63495. /**
  63496. * @hidden Internal
  63497. */
  63498. _effects: Array<PostProcess>;
  63499. /**
  63500. * @hidden Internal
  63501. */
  63502. _downscale: ExtractHighlightsPostProcess;
  63503. private _blurX;
  63504. private _blurY;
  63505. private _merge;
  63506. /**
  63507. * The luminance threshold to find bright areas of the image to bloom.
  63508. */
  63509. threshold: number;
  63510. /**
  63511. * The strength of the bloom.
  63512. */
  63513. weight: number;
  63514. /**
  63515. * Specifies the size of the bloom blur kernel, relative to the final output size
  63516. */
  63517. kernel: number;
  63518. /**
  63519. * Creates a new instance of @see BloomEffect
  63520. * @param scene The scene the effect belongs to.
  63521. * @param bloomScale The ratio of the blur texture to the input texture that should be used to compute the bloom.
  63522. * @param bloomKernel The size of the kernel to be used when applying the blur.
  63523. * @param bloomWeight The the strength of bloom.
  63524. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  63525. * @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)
  63526. */
  63527. constructor(scene: Scene, bloomScale: number, bloomWeight: number, bloomKernel: number, pipelineTextureType?: number, blockCompilation?: boolean);
  63528. /**
  63529. * Disposes each of the internal effects for a given camera.
  63530. * @param camera The camera to dispose the effect on.
  63531. */
  63532. disposeEffects(camera: Camera): void;
  63533. /**
  63534. * @hidden Internal
  63535. */
  63536. _updateEffects(): void;
  63537. /**
  63538. * Internal
  63539. * @returns if all the contained post processes are ready.
  63540. * @hidden
  63541. */
  63542. _isReady(): boolean;
  63543. }
  63544. }
  63545. declare module "babylonjs/Shaders/chromaticAberration.fragment" {
  63546. /** @hidden */
  63547. export var chromaticAberrationPixelShader: {
  63548. name: string;
  63549. shader: string;
  63550. };
  63551. }
  63552. declare module "babylonjs/PostProcesses/chromaticAberrationPostProcess" {
  63553. import { Vector2 } from "babylonjs/Maths/math.vector";
  63554. import { Nullable } from "babylonjs/types";
  63555. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  63556. import { Camera } from "babylonjs/Cameras/camera";
  63557. import { Engine } from "babylonjs/Engines/engine";
  63558. import "babylonjs/Shaders/chromaticAberration.fragment";
  63559. /**
  63560. * The ChromaticAberrationPostProcess separates the rgb channels in an image to produce chromatic distortion around the edges of the screen
  63561. */
  63562. export class ChromaticAberrationPostProcess extends PostProcess {
  63563. /**
  63564. * The amount of seperation of rgb channels (default: 30)
  63565. */
  63566. aberrationAmount: number;
  63567. /**
  63568. * The amount the effect will increase for pixels closer to the edge of the screen. (default: 0)
  63569. */
  63570. radialIntensity: number;
  63571. /**
  63572. * 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))
  63573. */
  63574. direction: Vector2;
  63575. /**
  63576. * 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))
  63577. */
  63578. centerPosition: Vector2;
  63579. /**
  63580. * Creates a new instance ChromaticAberrationPostProcess
  63581. * @param name The name of the effect.
  63582. * @param screenWidth The width of the screen to apply the effect on.
  63583. * @param screenHeight The height of the screen to apply the effect on.
  63584. * @param options The required width/height ratio to downsize to before computing the render pass.
  63585. * @param camera The camera to apply the render pass to.
  63586. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  63587. * @param engine The engine which the post process will be applied. (default: current engine)
  63588. * @param reusable If the post process can be reused on the same frame. (default: false)
  63589. * @param textureType Type of textures used when performing the post process. (default: 0)
  63590. * @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)
  63591. */
  63592. constructor(name: string, screenWidth: number, screenHeight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  63593. }
  63594. }
  63595. declare module "babylonjs/Shaders/circleOfConfusion.fragment" {
  63596. /** @hidden */
  63597. export var circleOfConfusionPixelShader: {
  63598. name: string;
  63599. shader: string;
  63600. };
  63601. }
  63602. declare module "babylonjs/PostProcesses/circleOfConfusionPostProcess" {
  63603. import { Nullable } from "babylonjs/types";
  63604. import { Engine } from "babylonjs/Engines/engine";
  63605. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  63606. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  63607. import { Camera } from "babylonjs/Cameras/camera";
  63608. import "babylonjs/Shaders/circleOfConfusion.fragment";
  63609. /**
  63610. * The CircleOfConfusionPostProcess computes the circle of confusion value for each pixel given required lens parameters. See https://en.wikipedia.org/wiki/Circle_of_confusion
  63611. */
  63612. export class CircleOfConfusionPostProcess extends PostProcess {
  63613. /**
  63614. * 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.
  63615. */
  63616. lensSize: number;
  63617. /**
  63618. * F-Stop of the effect's camera. The diamater of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  63619. */
  63620. fStop: number;
  63621. /**
  63622. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  63623. */
  63624. focusDistance: number;
  63625. /**
  63626. * Focal length of the effect's camera in scene units/1000 (eg. millimeter). (default: 50)
  63627. */
  63628. focalLength: number;
  63629. private _depthTexture;
  63630. /**
  63631. * Creates a new instance CircleOfConfusionPostProcess
  63632. * @param name The name of the effect.
  63633. * @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.
  63634. * @param options The required width/height ratio to downsize to before computing the render pass.
  63635. * @param camera The camera to apply the render pass to.
  63636. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  63637. * @param engine The engine which the post process will be applied. (default: current engine)
  63638. * @param reusable If the post process can be reused on the same frame. (default: false)
  63639. * @param textureType Type of textures used when performing the post process. (default: 0)
  63640. * @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)
  63641. */
  63642. constructor(name: string, depthTexture: Nullable<RenderTargetTexture>, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  63643. /**
  63644. * 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.
  63645. */
  63646. depthTexture: RenderTargetTexture;
  63647. }
  63648. }
  63649. declare module "babylonjs/Shaders/colorCorrection.fragment" {
  63650. /** @hidden */
  63651. export var colorCorrectionPixelShader: {
  63652. name: string;
  63653. shader: string;
  63654. };
  63655. }
  63656. declare module "babylonjs/PostProcesses/colorCorrectionPostProcess" {
  63657. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  63658. import { Engine } from "babylonjs/Engines/engine";
  63659. import { Camera } from "babylonjs/Cameras/camera";
  63660. import "babylonjs/Shaders/colorCorrection.fragment";
  63661. /**
  63662. *
  63663. * This post-process allows the modification of rendered colors by using
  63664. * a 'look-up table' (LUT). This effect is also called Color Grading.
  63665. *
  63666. * The object needs to be provided an url to a texture containing the color
  63667. * look-up table: the texture must be 256 pixels wide and 16 pixels high.
  63668. * Use an image editing software to tweak the LUT to match your needs.
  63669. *
  63670. * For an example of a color LUT, see here:
  63671. * @see http://udn.epicgames.com/Three/rsrc/Three/ColorGrading/RGBTable16x1.png
  63672. * For explanations on color grading, see here:
  63673. * @see http://udn.epicgames.com/Three/ColorGrading.html
  63674. *
  63675. */
  63676. export class ColorCorrectionPostProcess extends PostProcess {
  63677. private _colorTableTexture;
  63678. constructor(name: string, colorTableUrl: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  63679. }
  63680. }
  63681. declare module "babylonjs/Shaders/convolution.fragment" {
  63682. /** @hidden */
  63683. export var convolutionPixelShader: {
  63684. name: string;
  63685. shader: string;
  63686. };
  63687. }
  63688. declare module "babylonjs/PostProcesses/convolutionPostProcess" {
  63689. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  63690. import { Nullable } from "babylonjs/types";
  63691. import { Camera } from "babylonjs/Cameras/camera";
  63692. import { Engine } from "babylonjs/Engines/engine";
  63693. import "babylonjs/Shaders/convolution.fragment";
  63694. /**
  63695. * The ConvolutionPostProcess applies a 3x3 kernel to every pixel of the
  63696. * input texture to perform effects such as edge detection or sharpening
  63697. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  63698. */
  63699. export class ConvolutionPostProcess extends PostProcess {
  63700. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  63701. kernel: number[];
  63702. /**
  63703. * Creates a new instance ConvolutionPostProcess
  63704. * @param name The name of the effect.
  63705. * @param kernel Array of 9 values corresponding to the 3x3 kernel to be applied
  63706. * @param options The required width/height ratio to downsize to before computing the render pass.
  63707. * @param camera The camera to apply the render pass to.
  63708. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  63709. * @param engine The engine which the post process will be applied. (default: current engine)
  63710. * @param reusable If the post process can be reused on the same frame. (default: false)
  63711. * @param textureType Type of textures used when performing the post process. (default: 0)
  63712. */
  63713. constructor(name: string,
  63714. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  63715. kernel: number[], options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  63716. /**
  63717. * Edge detection 0 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  63718. */
  63719. static EdgeDetect0Kernel: number[];
  63720. /**
  63721. * Edge detection 1 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  63722. */
  63723. static EdgeDetect1Kernel: number[];
  63724. /**
  63725. * Edge detection 2 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  63726. */
  63727. static EdgeDetect2Kernel: number[];
  63728. /**
  63729. * Kernel to sharpen an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  63730. */
  63731. static SharpenKernel: number[];
  63732. /**
  63733. * Kernel to emboss an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  63734. */
  63735. static EmbossKernel: number[];
  63736. /**
  63737. * Kernel to blur an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  63738. */
  63739. static GaussianKernel: number[];
  63740. }
  63741. }
  63742. declare module "babylonjs/PostProcesses/depthOfFieldBlurPostProcess" {
  63743. import { Nullable } from "babylonjs/types";
  63744. import { Vector2 } from "babylonjs/Maths/math.vector";
  63745. import { Camera } from "babylonjs/Cameras/camera";
  63746. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  63747. import { BlurPostProcess } from "babylonjs/PostProcesses/blurPostProcess";
  63748. import { Engine } from "babylonjs/Engines/engine";
  63749. import { Scene } from "babylonjs/scene";
  63750. /**
  63751. * The DepthOfFieldBlurPostProcess applied a blur in a give direction.
  63752. * This blur differs from the standard BlurPostProcess as it attempts to avoid blurring pixels
  63753. * based on samples that have a large difference in distance than the center pixel.
  63754. * See section 2.6.2 http://fileadmin.cs.lth.se/cs/education/edan35/lectures/12dof.pdf
  63755. */
  63756. export class DepthOfFieldBlurPostProcess extends BlurPostProcess {
  63757. direction: Vector2;
  63758. /**
  63759. * Creates a new instance CircleOfConfusionPostProcess
  63760. * @param name The name of the effect.
  63761. * @param scene The scene the effect belongs to.
  63762. * @param direction The direction the blur should be applied.
  63763. * @param kernel The size of the kernel used to blur.
  63764. * @param options The required width/height ratio to downsize to before computing the render pass.
  63765. * @param camera The camera to apply the render pass to.
  63766. * @param circleOfConfusion The circle of confusion + depth map to be used to avoid blurring accross edges
  63767. * @param imageToBlur The image to apply the blur to (default: Current rendered frame)
  63768. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  63769. * @param engine The engine which the post process will be applied. (default: current engine)
  63770. * @param reusable If the post process can be reused on the same frame. (default: false)
  63771. * @param textureType Type of textures used when performing the post process. (default: 0)
  63772. * @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)
  63773. */
  63774. 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);
  63775. }
  63776. }
  63777. declare module "babylonjs/Shaders/depthOfFieldMerge.fragment" {
  63778. /** @hidden */
  63779. export var depthOfFieldMergePixelShader: {
  63780. name: string;
  63781. shader: string;
  63782. };
  63783. }
  63784. declare module "babylonjs/PostProcesses/depthOfFieldMergePostProcess" {
  63785. import { Nullable } from "babylonjs/types";
  63786. import { Camera } from "babylonjs/Cameras/camera";
  63787. import { Effect } from "babylonjs/Materials/effect";
  63788. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  63789. import { Engine } from "babylonjs/Engines/engine";
  63790. import "babylonjs/Shaders/depthOfFieldMerge.fragment";
  63791. /**
  63792. * Options to be set when merging outputs from the default pipeline.
  63793. */
  63794. export class DepthOfFieldMergePostProcessOptions {
  63795. /**
  63796. * The original image to merge on top of
  63797. */
  63798. originalFromInput: PostProcess;
  63799. /**
  63800. * Parameters to perform the merge of the depth of field effect
  63801. */
  63802. depthOfField?: {
  63803. circleOfConfusion: PostProcess;
  63804. blurSteps: Array<PostProcess>;
  63805. };
  63806. /**
  63807. * Parameters to perform the merge of bloom effect
  63808. */
  63809. bloom?: {
  63810. blurred: PostProcess;
  63811. weight: number;
  63812. };
  63813. }
  63814. /**
  63815. * The DepthOfFieldMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  63816. */
  63817. export class DepthOfFieldMergePostProcess extends PostProcess {
  63818. private blurSteps;
  63819. /**
  63820. * Creates a new instance of DepthOfFieldMergePostProcess
  63821. * @param name The name of the effect.
  63822. * @param originalFromInput Post process which's input will be used for the merge.
  63823. * @param circleOfConfusion Circle of confusion post process which's output will be used to blur each pixel.
  63824. * @param blurSteps Blur post processes from low to high which will be mixed with the original image.
  63825. * @param options The required width/height ratio to downsize to before computing the render pass.
  63826. * @param camera The camera to apply the render pass to.
  63827. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  63828. * @param engine The engine which the post process will be applied. (default: current engine)
  63829. * @param reusable If the post process can be reused on the same frame. (default: false)
  63830. * @param textureType Type of textures used when performing the post process. (default: 0)
  63831. * @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)
  63832. */
  63833. 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);
  63834. /**
  63835. * Updates the effect with the current post process compile time values and recompiles the shader.
  63836. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  63837. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  63838. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  63839. * @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
  63840. * @param onCompiled Called when the shader has been compiled.
  63841. * @param onError Called if there is an error when compiling a shader.
  63842. */
  63843. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  63844. }
  63845. }
  63846. declare module "babylonjs/PostProcesses/depthOfFieldEffect" {
  63847. import { Nullable } from "babylonjs/types";
  63848. import { Camera } from "babylonjs/Cameras/camera";
  63849. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  63850. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  63851. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  63852. import { DepthOfFieldBlurPostProcess } from "babylonjs/PostProcesses/depthOfFieldBlurPostProcess";
  63853. import { Scene } from "babylonjs/scene";
  63854. /**
  63855. * Specifies the level of max blur that should be applied when using the depth of field effect
  63856. */
  63857. export enum DepthOfFieldEffectBlurLevel {
  63858. /**
  63859. * Subtle blur
  63860. */
  63861. Low = 0,
  63862. /**
  63863. * Medium blur
  63864. */
  63865. Medium = 1,
  63866. /**
  63867. * Large blur
  63868. */
  63869. High = 2
  63870. }
  63871. /**
  63872. * The depth of field effect applies a blur to objects that are closer or further from where the camera is focusing.
  63873. */
  63874. export class DepthOfFieldEffect extends PostProcessRenderEffect {
  63875. private _circleOfConfusion;
  63876. /**
  63877. * @hidden Internal, blurs from high to low
  63878. */
  63879. _depthOfFieldBlurX: Array<DepthOfFieldBlurPostProcess>;
  63880. private _depthOfFieldBlurY;
  63881. private _dofMerge;
  63882. /**
  63883. * @hidden Internal post processes in depth of field effect
  63884. */
  63885. _effects: Array<PostProcess>;
  63886. /**
  63887. * The focal the length of the camera used in the effect in scene units/1000 (eg. millimeter)
  63888. */
  63889. focalLength: number;
  63890. /**
  63891. * F-Stop of the effect's camera. The diameter of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  63892. */
  63893. fStop: number;
  63894. /**
  63895. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  63896. */
  63897. focusDistance: number;
  63898. /**
  63899. * 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.
  63900. */
  63901. lensSize: number;
  63902. /**
  63903. * Creates a new instance DepthOfFieldEffect
  63904. * @param scene The scene the effect belongs to.
  63905. * @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.
  63906. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  63907. * @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)
  63908. */
  63909. constructor(scene: Scene, depthTexture: Nullable<RenderTargetTexture>, blurLevel?: DepthOfFieldEffectBlurLevel, pipelineTextureType?: number, blockCompilation?: boolean);
  63910. /**
  63911. * Get the current class name of the current effet
  63912. * @returns "DepthOfFieldEffect"
  63913. */
  63914. getClassName(): string;
  63915. /**
  63916. * 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.
  63917. */
  63918. depthTexture: RenderTargetTexture;
  63919. /**
  63920. * Disposes each of the internal effects for a given camera.
  63921. * @param camera The camera to dispose the effect on.
  63922. */
  63923. disposeEffects(camera: Camera): void;
  63924. /**
  63925. * @hidden Internal
  63926. */
  63927. _updateEffects(): void;
  63928. /**
  63929. * Internal
  63930. * @returns if all the contained post processes are ready.
  63931. * @hidden
  63932. */
  63933. _isReady(): boolean;
  63934. }
  63935. }
  63936. declare module "babylonjs/Shaders/displayPass.fragment" {
  63937. /** @hidden */
  63938. export var displayPassPixelShader: {
  63939. name: string;
  63940. shader: string;
  63941. };
  63942. }
  63943. declare module "babylonjs/PostProcesses/displayPassPostProcess" {
  63944. import { Nullable } from "babylonjs/types";
  63945. import { Camera } from "babylonjs/Cameras/camera";
  63946. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  63947. import { Engine } from "babylonjs/Engines/engine";
  63948. import "babylonjs/Shaders/displayPass.fragment";
  63949. /**
  63950. * DisplayPassPostProcess which produces an output the same as it's input
  63951. */
  63952. export class DisplayPassPostProcess extends PostProcess {
  63953. /**
  63954. * Creates the DisplayPassPostProcess
  63955. * @param name The name of the effect.
  63956. * @param options The required width/height ratio to downsize to before computing the render pass.
  63957. * @param camera The camera to apply the render pass to.
  63958. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  63959. * @param engine The engine which the post process will be applied. (default: current engine)
  63960. * @param reusable If the post process can be reused on the same frame. (default: false)
  63961. */
  63962. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  63963. }
  63964. }
  63965. declare module "babylonjs/Shaders/filter.fragment" {
  63966. /** @hidden */
  63967. export var filterPixelShader: {
  63968. name: string;
  63969. shader: string;
  63970. };
  63971. }
  63972. declare module "babylonjs/PostProcesses/filterPostProcess" {
  63973. import { Nullable } from "babylonjs/types";
  63974. import { Matrix } from "babylonjs/Maths/math.vector";
  63975. import { Camera } from "babylonjs/Cameras/camera";
  63976. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  63977. import { Engine } from "babylonjs/Engines/engine";
  63978. import "babylonjs/Shaders/filter.fragment";
  63979. /**
  63980. * Applies a kernel filter to the image
  63981. */
  63982. export class FilterPostProcess extends PostProcess {
  63983. /** The matrix to be applied to the image */
  63984. kernelMatrix: Matrix;
  63985. /**
  63986. *
  63987. * @param name The name of the effect.
  63988. * @param kernelMatrix The matrix to be applied to the image
  63989. * @param options The required width/height ratio to downsize to before computing the render pass.
  63990. * @param camera The camera to apply the render pass to.
  63991. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  63992. * @param engine The engine which the post process will be applied. (default: current engine)
  63993. * @param reusable If the post process can be reused on the same frame. (default: false)
  63994. */
  63995. constructor(name: string,
  63996. /** The matrix to be applied to the image */
  63997. kernelMatrix: Matrix, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  63998. }
  63999. }
  64000. declare module "babylonjs/Shaders/fxaa.fragment" {
  64001. /** @hidden */
  64002. export var fxaaPixelShader: {
  64003. name: string;
  64004. shader: string;
  64005. };
  64006. }
  64007. declare module "babylonjs/Shaders/fxaa.vertex" {
  64008. /** @hidden */
  64009. export var fxaaVertexShader: {
  64010. name: string;
  64011. shader: string;
  64012. };
  64013. }
  64014. declare module "babylonjs/PostProcesses/fxaaPostProcess" {
  64015. import { Nullable } from "babylonjs/types";
  64016. import { Camera } from "babylonjs/Cameras/camera";
  64017. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  64018. import { Engine } from "babylonjs/Engines/engine";
  64019. import "babylonjs/Shaders/fxaa.fragment";
  64020. import "babylonjs/Shaders/fxaa.vertex";
  64021. /**
  64022. * Fxaa post process
  64023. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#fxaa
  64024. */
  64025. export class FxaaPostProcess extends PostProcess {
  64026. /** @hidden */
  64027. texelWidth: number;
  64028. /** @hidden */
  64029. texelHeight: number;
  64030. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  64031. private _getDefines;
  64032. }
  64033. }
  64034. declare module "babylonjs/Shaders/grain.fragment" {
  64035. import "babylonjs/Shaders/ShadersInclude/helperFunctions";
  64036. /** @hidden */
  64037. export var grainPixelShader: {
  64038. name: string;
  64039. shader: string;
  64040. };
  64041. }
  64042. declare module "babylonjs/PostProcesses/grainPostProcess" {
  64043. import { Nullable } from "babylonjs/types";
  64044. import { Camera } from "babylonjs/Cameras/camera";
  64045. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  64046. import { Engine } from "babylonjs/Engines/engine";
  64047. import "babylonjs/Shaders/grain.fragment";
  64048. /**
  64049. * The GrainPostProcess adds noise to the image at mid luminance levels
  64050. */
  64051. export class GrainPostProcess extends PostProcess {
  64052. /**
  64053. * The intensity of the grain added (default: 30)
  64054. */
  64055. intensity: number;
  64056. /**
  64057. * If the grain should be randomized on every frame
  64058. */
  64059. animated: boolean;
  64060. /**
  64061. * Creates a new instance of @see GrainPostProcess
  64062. * @param name The name of the effect.
  64063. * @param options The required width/height ratio to downsize to before computing the render pass.
  64064. * @param camera The camera to apply the render pass to.
  64065. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  64066. * @param engine The engine which the post process will be applied. (default: current engine)
  64067. * @param reusable If the post process can be reused on the same frame. (default: false)
  64068. * @param textureType Type of textures used when performing the post process. (default: 0)
  64069. * @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)
  64070. */
  64071. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  64072. }
  64073. }
  64074. declare module "babylonjs/Shaders/highlights.fragment" {
  64075. /** @hidden */
  64076. export var highlightsPixelShader: {
  64077. name: string;
  64078. shader: string;
  64079. };
  64080. }
  64081. declare module "babylonjs/PostProcesses/highlightsPostProcess" {
  64082. import { Nullable } from "babylonjs/types";
  64083. import { Camera } from "babylonjs/Cameras/camera";
  64084. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  64085. import { Engine } from "babylonjs/Engines/engine";
  64086. import "babylonjs/Shaders/highlights.fragment";
  64087. /**
  64088. * Extracts highlights from the image
  64089. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  64090. */
  64091. export class HighlightsPostProcess extends PostProcess {
  64092. /**
  64093. * Extracts highlights from the image
  64094. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  64095. * @param name The name of the effect.
  64096. * @param options The required width/height ratio to downsize to before computing the render pass.
  64097. * @param camera The camera to apply the render pass to.
  64098. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  64099. * @param engine The engine which the post process will be applied. (default: current engine)
  64100. * @param reusable If the post process can be reused on the same frame. (default: false)
  64101. * @param textureType Type of texture for the post process (default: Engine.TEXTURETYPE_UNSIGNED_INT)
  64102. */
  64103. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  64104. }
  64105. }
  64106. declare module "babylonjs/Shaders/ShadersInclude/mrtFragmentDeclaration" {
  64107. /** @hidden */
  64108. export var mrtFragmentDeclaration: {
  64109. name: string;
  64110. shader: string;
  64111. };
  64112. }
  64113. declare module "babylonjs/Shaders/geometry.fragment" {
  64114. import "babylonjs/Shaders/ShadersInclude/mrtFragmentDeclaration";
  64115. /** @hidden */
  64116. export var geometryPixelShader: {
  64117. name: string;
  64118. shader: string;
  64119. };
  64120. }
  64121. declare module "babylonjs/Shaders/geometry.vertex" {
  64122. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  64123. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  64124. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  64125. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  64126. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  64127. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  64128. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  64129. /** @hidden */
  64130. export var geometryVertexShader: {
  64131. name: string;
  64132. shader: string;
  64133. };
  64134. }
  64135. declare module "babylonjs/Rendering/geometryBufferRenderer" {
  64136. import { Matrix } from "babylonjs/Maths/math.vector";
  64137. import { SubMesh } from "babylonjs/Meshes/subMesh";
  64138. import { Mesh } from "babylonjs/Meshes/mesh";
  64139. import { MultiRenderTarget } from "babylonjs/Materials/Textures/multiRenderTarget";
  64140. import { Effect } from "babylonjs/Materials/effect";
  64141. import { Scene } from "babylonjs/scene";
  64142. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  64143. import "babylonjs/Shaders/geometry.fragment";
  64144. import "babylonjs/Shaders/geometry.vertex";
  64145. /** @hidden */
  64146. interface ISavedTransformationMatrix {
  64147. world: Matrix;
  64148. viewProjection: Matrix;
  64149. }
  64150. /**
  64151. * This renderer is helpfull to fill one of the render target with a geometry buffer.
  64152. */
  64153. export class GeometryBufferRenderer {
  64154. /**
  64155. * Constant used to retrieve the position texture index in the G-Buffer textures array
  64156. * using getIndex(GeometryBufferRenderer.POSITION_TEXTURE_INDEX)
  64157. */
  64158. static readonly POSITION_TEXTURE_TYPE: number;
  64159. /**
  64160. * Constant used to retrieve the velocity texture index in the G-Buffer textures array
  64161. * using getIndex(GeometryBufferRenderer.VELOCITY_TEXTURE_INDEX)
  64162. */
  64163. static readonly VELOCITY_TEXTURE_TYPE: number;
  64164. /**
  64165. * Dictionary used to store the previous transformation matrices of each rendered mesh
  64166. * in order to compute objects velocities when enableVelocity is set to "true"
  64167. * @hidden
  64168. */
  64169. _previousTransformationMatrices: {
  64170. [index: number]: ISavedTransformationMatrix;
  64171. };
  64172. /**
  64173. * Dictionary used to store the previous bones transformation matrices of each rendered mesh
  64174. * in order to compute objects velocities when enableVelocity is set to "true"
  64175. * @hidden
  64176. */
  64177. _previousBonesTransformationMatrices: {
  64178. [index: number]: Float32Array;
  64179. };
  64180. /**
  64181. * Array used to store the ignored skinned meshes while computing velocity map (typically used by the motion blur post-process).
  64182. * Avoids computing bones velocities and computes only mesh's velocity itself (position, rotation, scaling).
  64183. */
  64184. excludedSkinnedMeshesFromVelocity: AbstractMesh[];
  64185. private _scene;
  64186. private _multiRenderTarget;
  64187. private _ratio;
  64188. private _enablePosition;
  64189. private _enableVelocity;
  64190. private _positionIndex;
  64191. private _velocityIndex;
  64192. protected _effect: Effect;
  64193. protected _cachedDefines: string;
  64194. /**
  64195. * Set the render list (meshes to be rendered) used in the G buffer.
  64196. */
  64197. renderList: Mesh[];
  64198. /**
  64199. * Gets wether or not G buffer are supported by the running hardware.
  64200. * This requires draw buffer supports
  64201. */
  64202. readonly isSupported: boolean;
  64203. /**
  64204. * Returns the index of the given texture type in the G-Buffer textures array
  64205. * @param textureType The texture type constant. For example GeometryBufferRenderer.POSITION_TEXTURE_INDEX
  64206. * @returns the index of the given texture type in the G-Buffer textures array
  64207. */
  64208. getTextureIndex(textureType: number): number;
  64209. /**
  64210. * Gets a boolean indicating if objects positions are enabled for the G buffer.
  64211. */
  64212. /**
  64213. * Sets whether or not objects positions are enabled for the G buffer.
  64214. */
  64215. enablePosition: boolean;
  64216. /**
  64217. * Gets a boolean indicating if objects velocities are enabled for the G buffer.
  64218. */
  64219. /**
  64220. * Sets wether or not objects velocities are enabled for the G buffer.
  64221. */
  64222. enableVelocity: boolean;
  64223. /**
  64224. * Gets the scene associated with the buffer.
  64225. */
  64226. readonly scene: Scene;
  64227. /**
  64228. * Gets the ratio used by the buffer during its creation.
  64229. * How big is the buffer related to the main canvas.
  64230. */
  64231. readonly ratio: number;
  64232. /** @hidden */
  64233. static _SceneComponentInitialization: (scene: Scene) => void;
  64234. /**
  64235. * Creates a new G Buffer for the scene
  64236. * @param scene The scene the buffer belongs to
  64237. * @param ratio How big is the buffer related to the main canvas.
  64238. */
  64239. constructor(scene: Scene, ratio?: number);
  64240. /**
  64241. * Checks wether everything is ready to render a submesh to the G buffer.
  64242. * @param subMesh the submesh to check readiness for
  64243. * @param useInstances is the mesh drawn using instance or not
  64244. * @returns true if ready otherwise false
  64245. */
  64246. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  64247. /**
  64248. * Gets the current underlying G Buffer.
  64249. * @returns the buffer
  64250. */
  64251. getGBuffer(): MultiRenderTarget;
  64252. /**
  64253. * Gets the number of samples used to render the buffer (anti aliasing).
  64254. */
  64255. /**
  64256. * Sets the number of samples used to render the buffer (anti aliasing).
  64257. */
  64258. samples: number;
  64259. /**
  64260. * Disposes the renderer and frees up associated resources.
  64261. */
  64262. dispose(): void;
  64263. protected _createRenderTargets(): void;
  64264. private _copyBonesTransformationMatrices;
  64265. }
  64266. }
  64267. declare module "babylonjs/Rendering/geometryBufferRendererSceneComponent" {
  64268. import { Nullable } from "babylonjs/types";
  64269. import { Scene } from "babylonjs/scene";
  64270. import { ISceneComponent } from "babylonjs/sceneComponent";
  64271. import { GeometryBufferRenderer } from "babylonjs/Rendering/geometryBufferRenderer";
  64272. module "babylonjs/scene" {
  64273. interface Scene {
  64274. /** @hidden (Backing field) */
  64275. _geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  64276. /**
  64277. * Gets or Sets the current geometry buffer associated to the scene.
  64278. */
  64279. geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  64280. /**
  64281. * Enables a GeometryBufferRender and associates it with the scene
  64282. * @param ratio defines the scaling ratio to apply to the renderer (1 by default which means same resolution)
  64283. * @returns the GeometryBufferRenderer
  64284. */
  64285. enableGeometryBufferRenderer(ratio?: number): Nullable<GeometryBufferRenderer>;
  64286. /**
  64287. * Disables the GeometryBufferRender associated with the scene
  64288. */
  64289. disableGeometryBufferRenderer(): void;
  64290. }
  64291. }
  64292. /**
  64293. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  64294. * in several rendering techniques.
  64295. */
  64296. export class GeometryBufferRendererSceneComponent implements ISceneComponent {
  64297. /**
  64298. * The component name helpful to identify the component in the list of scene components.
  64299. */
  64300. readonly name: string;
  64301. /**
  64302. * The scene the component belongs to.
  64303. */
  64304. scene: Scene;
  64305. /**
  64306. * Creates a new instance of the component for the given scene
  64307. * @param scene Defines the scene to register the component in
  64308. */
  64309. constructor(scene: Scene);
  64310. /**
  64311. * Registers the component in a given scene
  64312. */
  64313. register(): void;
  64314. /**
  64315. * Rebuilds the elements related to this component in case of
  64316. * context lost for instance.
  64317. */
  64318. rebuild(): void;
  64319. /**
  64320. * Disposes the component and the associated ressources
  64321. */
  64322. dispose(): void;
  64323. private _gatherRenderTargets;
  64324. }
  64325. }
  64326. declare module "babylonjs/Shaders/motionBlur.fragment" {
  64327. /** @hidden */
  64328. export var motionBlurPixelShader: {
  64329. name: string;
  64330. shader: string;
  64331. };
  64332. }
  64333. declare module "babylonjs/PostProcesses/motionBlurPostProcess" {
  64334. import { Nullable } from "babylonjs/types";
  64335. import { Camera } from "babylonjs/Cameras/camera";
  64336. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  64337. import { Scene } from "babylonjs/scene";
  64338. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  64339. import "babylonjs/Animations/animatable";
  64340. import "babylonjs/Rendering/geometryBufferRendererSceneComponent";
  64341. import "babylonjs/Shaders/motionBlur.fragment";
  64342. import { Engine } from "babylonjs/Engines/engine";
  64343. /**
  64344. * The Motion Blur Post Process which blurs an image based on the objects velocity in scene.
  64345. * Velocity can be affected by each object's rotation, position and scale depending on the transformation speed.
  64346. * As an example, all you have to do is to create the post-process:
  64347. * var mb = new BABYLON.MotionBlurPostProcess(
  64348. * 'mb', // The name of the effect.
  64349. * scene, // The scene containing the objects to blur according to their velocity.
  64350. * 1.0, // The required width/height ratio to downsize to before computing the render pass.
  64351. * camera // The camera to apply the render pass to.
  64352. * );
  64353. * Then, all objects moving, rotating and/or scaling will be blurred depending on the transformation speed.
  64354. */
  64355. export class MotionBlurPostProcess extends PostProcess {
  64356. /**
  64357. * Defines how much the image is blurred by the movement. Default value is equal to 1
  64358. */
  64359. motionStrength: number;
  64360. /**
  64361. * Gets the number of iterations are used for motion blur quality. Default value is equal to 32
  64362. */
  64363. /**
  64364. * Sets the number of iterations to be used for motion blur quality
  64365. */
  64366. motionBlurSamples: number;
  64367. private _motionBlurSamples;
  64368. private _geometryBufferRenderer;
  64369. /**
  64370. * Creates a new instance MotionBlurPostProcess
  64371. * @param name The name of the effect.
  64372. * @param scene The scene containing the objects to blur according to their velocity.
  64373. * @param options The required width/height ratio to downsize to before computing the render pass.
  64374. * @param camera The camera to apply the render pass to.
  64375. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  64376. * @param engine The engine which the post process will be applied. (default: current engine)
  64377. * @param reusable If the post process can be reused on the same frame. (default: false)
  64378. * @param textureType Type of textures used when performing the post process. (default: 0)
  64379. * @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)
  64380. */
  64381. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  64382. /**
  64383. * Excludes the given skinned mesh from computing bones velocities.
  64384. * 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.
  64385. * @param skinnedMesh The mesh containing the skeleton to ignore when computing the velocity map.
  64386. */
  64387. excludeSkinnedMesh(skinnedMesh: AbstractMesh): void;
  64388. /**
  64389. * Removes the given skinned mesh from the excluded meshes to integrate bones velocities while rendering the velocity map.
  64390. * @param skinnedMesh The mesh containing the skeleton that has been ignored previously.
  64391. * @see excludeSkinnedMesh to exclude a skinned mesh from bones velocity computation.
  64392. */
  64393. removeExcludedSkinnedMesh(skinnedMesh: AbstractMesh): void;
  64394. /**
  64395. * Disposes the post process.
  64396. * @param camera The camera to dispose the post process on.
  64397. */
  64398. dispose(camera?: Camera): void;
  64399. }
  64400. }
  64401. declare module "babylonjs/Shaders/refraction.fragment" {
  64402. /** @hidden */
  64403. export var refractionPixelShader: {
  64404. name: string;
  64405. shader: string;
  64406. };
  64407. }
  64408. declare module "babylonjs/PostProcesses/refractionPostProcess" {
  64409. import { Color3 } from "babylonjs/Maths/math.color";
  64410. import { Camera } from "babylonjs/Cameras/camera";
  64411. import { Texture } from "babylonjs/Materials/Textures/texture";
  64412. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  64413. import { Engine } from "babylonjs/Engines/engine";
  64414. import "babylonjs/Shaders/refraction.fragment";
  64415. /**
  64416. * Post process which applies a refractin texture
  64417. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  64418. */
  64419. export class RefractionPostProcess extends PostProcess {
  64420. /** the base color of the refraction (used to taint the rendering) */
  64421. color: Color3;
  64422. /** simulated refraction depth */
  64423. depth: number;
  64424. /** the coefficient of the base color (0 to remove base color tainting) */
  64425. colorLevel: number;
  64426. private _refTexture;
  64427. private _ownRefractionTexture;
  64428. /**
  64429. * Gets or sets the refraction texture
  64430. * Please note that you are responsible for disposing the texture if you set it manually
  64431. */
  64432. refractionTexture: Texture;
  64433. /**
  64434. * Initializes the RefractionPostProcess
  64435. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  64436. * @param name The name of the effect.
  64437. * @param refractionTextureUrl Url of the refraction texture to use
  64438. * @param color the base color of the refraction (used to taint the rendering)
  64439. * @param depth simulated refraction depth
  64440. * @param colorLevel the coefficient of the base color (0 to remove base color tainting)
  64441. * @param camera The camera to apply the render pass to.
  64442. * @param options The required width/height ratio to downsize to before computing the render pass.
  64443. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  64444. * @param engine The engine which the post process will be applied. (default: current engine)
  64445. * @param reusable If the post process can be reused on the same frame. (default: false)
  64446. */
  64447. constructor(name: string, refractionTextureUrl: string,
  64448. /** the base color of the refraction (used to taint the rendering) */
  64449. color: Color3,
  64450. /** simulated refraction depth */
  64451. depth: number,
  64452. /** the coefficient of the base color (0 to remove base color tainting) */
  64453. colorLevel: number, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  64454. /**
  64455. * Disposes of the post process
  64456. * @param camera Camera to dispose post process on
  64457. */
  64458. dispose(camera: Camera): void;
  64459. }
  64460. }
  64461. declare module "babylonjs/Shaders/sharpen.fragment" {
  64462. /** @hidden */
  64463. export var sharpenPixelShader: {
  64464. name: string;
  64465. shader: string;
  64466. };
  64467. }
  64468. declare module "babylonjs/PostProcesses/sharpenPostProcess" {
  64469. import { Nullable } from "babylonjs/types";
  64470. import { Camera } from "babylonjs/Cameras/camera";
  64471. import { PostProcess, PostProcessOptions } from "babylonjs/PostProcesses/postProcess";
  64472. import "babylonjs/Shaders/sharpen.fragment";
  64473. import { Engine } from "babylonjs/Engines/engine";
  64474. /**
  64475. * The SharpenPostProcess applies a sharpen kernel to every pixel
  64476. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  64477. */
  64478. export class SharpenPostProcess extends PostProcess {
  64479. /**
  64480. * How much of the original color should be applied. Setting this to 0 will display edge detection. (default: 1)
  64481. */
  64482. colorAmount: number;
  64483. /**
  64484. * How much sharpness should be applied (default: 0.3)
  64485. */
  64486. edgeAmount: number;
  64487. /**
  64488. * Creates a new instance ConvolutionPostProcess
  64489. * @param name The name of the effect.
  64490. * @param options The required width/height ratio to downsize to before computing the render pass.
  64491. * @param camera The camera to apply the render pass to.
  64492. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  64493. * @param engine The engine which the post process will be applied. (default: current engine)
  64494. * @param reusable If the post process can be reused on the same frame. (default: false)
  64495. * @param textureType Type of textures used when performing the post process. (default: 0)
  64496. * @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)
  64497. */
  64498. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  64499. }
  64500. }
  64501. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline" {
  64502. import { Nullable } from "babylonjs/types";
  64503. import { Camera } from "babylonjs/Cameras/camera";
  64504. import { Engine } from "babylonjs/Engines/engine";
  64505. import { PostProcessRenderEffect } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  64506. import { IInspectable } from "babylonjs/Misc/iInspectable";
  64507. /**
  64508. * PostProcessRenderPipeline
  64509. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  64510. */
  64511. export class PostProcessRenderPipeline {
  64512. private engine;
  64513. private _renderEffects;
  64514. private _renderEffectsForIsolatedPass;
  64515. /**
  64516. * List of inspectable custom properties (used by the Inspector)
  64517. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  64518. */
  64519. inspectableCustomProperties: IInspectable[];
  64520. /**
  64521. * @hidden
  64522. */
  64523. protected _cameras: Camera[];
  64524. /** @hidden */
  64525. _name: string;
  64526. /**
  64527. * Gets pipeline name
  64528. */
  64529. readonly name: string;
  64530. /** Gets the list of attached cameras */
  64531. readonly cameras: Camera[];
  64532. /**
  64533. * Initializes a PostProcessRenderPipeline
  64534. * @param engine engine to add the pipeline to
  64535. * @param name name of the pipeline
  64536. */
  64537. constructor(engine: Engine, name: string);
  64538. /**
  64539. * Gets the class name
  64540. * @returns "PostProcessRenderPipeline"
  64541. */
  64542. getClassName(): string;
  64543. /**
  64544. * If all the render effects in the pipeline are supported
  64545. */
  64546. readonly isSupported: boolean;
  64547. /**
  64548. * Adds an effect to the pipeline
  64549. * @param renderEffect the effect to add
  64550. */
  64551. addEffect(renderEffect: PostProcessRenderEffect): void;
  64552. /** @hidden */
  64553. _rebuild(): void;
  64554. /** @hidden */
  64555. _enableEffect(renderEffectName: string, cameras: Camera): void;
  64556. /** @hidden */
  64557. _enableEffect(renderEffectName: string, cameras: Camera[]): void;
  64558. /** @hidden */
  64559. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  64560. /** @hidden */
  64561. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  64562. /** @hidden */
  64563. _attachCameras(cameras: Camera, unique: boolean): void;
  64564. /** @hidden */
  64565. _attachCameras(cameras: Camera[], unique: boolean): void;
  64566. /** @hidden */
  64567. _detachCameras(cameras: Camera): void;
  64568. /** @hidden */
  64569. _detachCameras(cameras: Nullable<Camera[]>): void;
  64570. /** @hidden */
  64571. _update(): void;
  64572. /** @hidden */
  64573. _reset(): void;
  64574. protected _enableMSAAOnFirstPostProcess(sampleCount: number): boolean;
  64575. /**
  64576. * Disposes of the pipeline
  64577. */
  64578. dispose(): void;
  64579. }
  64580. }
  64581. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager" {
  64582. import { Camera } from "babylonjs/Cameras/camera";
  64583. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  64584. /**
  64585. * PostProcessRenderPipelineManager class
  64586. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  64587. */
  64588. export class PostProcessRenderPipelineManager {
  64589. private _renderPipelines;
  64590. /**
  64591. * Initializes a PostProcessRenderPipelineManager
  64592. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  64593. */
  64594. constructor();
  64595. /**
  64596. * Gets the list of supported render pipelines
  64597. */
  64598. readonly supportedPipelines: PostProcessRenderPipeline[];
  64599. /**
  64600. * Adds a pipeline to the manager
  64601. * @param renderPipeline The pipeline to add
  64602. */
  64603. addPipeline(renderPipeline: PostProcessRenderPipeline): void;
  64604. /**
  64605. * Attaches a camera to the pipeline
  64606. * @param renderPipelineName The name of the pipeline to attach to
  64607. * @param cameras the camera to attach
  64608. * @param unique if the camera can be attached multiple times to the pipeline
  64609. */
  64610. attachCamerasToRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera, unique?: boolean): void;
  64611. /**
  64612. * Detaches a camera from the pipeline
  64613. * @param renderPipelineName The name of the pipeline to detach from
  64614. * @param cameras the camera to detach
  64615. */
  64616. detachCamerasFromRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera): void;
  64617. /**
  64618. * Enables an effect by name on a pipeline
  64619. * @param renderPipelineName the name of the pipeline to enable the effect in
  64620. * @param renderEffectName the name of the effect to enable
  64621. * @param cameras the cameras that the effect should be enabled on
  64622. */
  64623. enableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  64624. /**
  64625. * Disables an effect by name on a pipeline
  64626. * @param renderPipelineName the name of the pipeline to disable the effect in
  64627. * @param renderEffectName the name of the effect to disable
  64628. * @param cameras the cameras that the effect should be disabled on
  64629. */
  64630. disableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  64631. /**
  64632. * Updates the state of all contained render pipelines and disposes of any non supported pipelines
  64633. */
  64634. update(): void;
  64635. /** @hidden */
  64636. _rebuild(): void;
  64637. /**
  64638. * Disposes of the manager and pipelines
  64639. */
  64640. dispose(): void;
  64641. }
  64642. }
  64643. declare module "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent" {
  64644. import { ISceneComponent } from "babylonjs/sceneComponent";
  64645. import { PostProcessRenderPipelineManager } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager";
  64646. import { Scene } from "babylonjs/scene";
  64647. module "babylonjs/scene" {
  64648. interface Scene {
  64649. /** @hidden (Backing field) */
  64650. _postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  64651. /**
  64652. * Gets the postprocess render pipeline manager
  64653. * @see http://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  64654. * @see http://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  64655. */
  64656. readonly postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  64657. }
  64658. }
  64659. /**
  64660. * Defines the Render Pipeline scene component responsible to rendering pipelines
  64661. */
  64662. export class PostProcessRenderPipelineManagerSceneComponent implements ISceneComponent {
  64663. /**
  64664. * The component name helpfull to identify the component in the list of scene components.
  64665. */
  64666. readonly name: string;
  64667. /**
  64668. * The scene the component belongs to.
  64669. */
  64670. scene: Scene;
  64671. /**
  64672. * Creates a new instance of the component for the given scene
  64673. * @param scene Defines the scene to register the component in
  64674. */
  64675. constructor(scene: Scene);
  64676. /**
  64677. * Registers the component in a given scene
  64678. */
  64679. register(): void;
  64680. /**
  64681. * Rebuilds the elements related to this component in case of
  64682. * context lost for instance.
  64683. */
  64684. rebuild(): void;
  64685. /**
  64686. * Disposes the component and the associated ressources
  64687. */
  64688. dispose(): void;
  64689. private _gatherRenderTargets;
  64690. }
  64691. }
  64692. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/defaultRenderingPipeline" {
  64693. import { Nullable } from "babylonjs/types";
  64694. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  64695. import { Camera } from "babylonjs/Cameras/camera";
  64696. import { IDisposable } from "babylonjs/scene";
  64697. import { GlowLayer } from "babylonjs/Layers/glowLayer";
  64698. import { Scene } from "babylonjs/scene";
  64699. import { SharpenPostProcess } from "babylonjs/PostProcesses/sharpenPostProcess";
  64700. import { ImageProcessingPostProcess } from "babylonjs/PostProcesses/imageProcessingPostProcess";
  64701. import { ChromaticAberrationPostProcess } from "babylonjs/PostProcesses/chromaticAberrationPostProcess";
  64702. import { GrainPostProcess } from "babylonjs/PostProcesses/grainPostProcess";
  64703. import { FxaaPostProcess } from "babylonjs/PostProcesses/fxaaPostProcess";
  64704. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  64705. import { DepthOfFieldEffect, DepthOfFieldEffectBlurLevel } from "babylonjs/PostProcesses/depthOfFieldEffect";
  64706. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  64707. import { Animation } from "babylonjs/Animations/animation";
  64708. /**
  64709. * The default rendering pipeline can be added to a scene to apply common post processing effects such as anti-aliasing or depth of field.
  64710. * See https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  64711. */
  64712. export class DefaultRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  64713. private _scene;
  64714. private _camerasToBeAttached;
  64715. /**
  64716. * ID of the sharpen post process,
  64717. */
  64718. private readonly SharpenPostProcessId;
  64719. /**
  64720. * @ignore
  64721. * ID of the image processing post process;
  64722. */
  64723. readonly ImageProcessingPostProcessId: string;
  64724. /**
  64725. * @ignore
  64726. * ID of the Fast Approximate Anti-Aliasing post process;
  64727. */
  64728. readonly FxaaPostProcessId: string;
  64729. /**
  64730. * ID of the chromatic aberration post process,
  64731. */
  64732. private readonly ChromaticAberrationPostProcessId;
  64733. /**
  64734. * ID of the grain post process
  64735. */
  64736. private readonly GrainPostProcessId;
  64737. /**
  64738. * Sharpen post process which will apply a sharpen convolution to enhance edges
  64739. */
  64740. sharpen: SharpenPostProcess;
  64741. private _sharpenEffect;
  64742. private bloom;
  64743. /**
  64744. * Depth of field effect, applies a blur based on how far away objects are from the focus distance.
  64745. */
  64746. depthOfField: DepthOfFieldEffect;
  64747. /**
  64748. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  64749. */
  64750. fxaa: FxaaPostProcess;
  64751. /**
  64752. * Image post processing pass used to perform operations such as tone mapping or color grading.
  64753. */
  64754. imageProcessing: ImageProcessingPostProcess;
  64755. /**
  64756. * Chromatic aberration post process which will shift rgb colors in the image
  64757. */
  64758. chromaticAberration: ChromaticAberrationPostProcess;
  64759. private _chromaticAberrationEffect;
  64760. /**
  64761. * Grain post process which add noise to the image
  64762. */
  64763. grain: GrainPostProcess;
  64764. private _grainEffect;
  64765. /**
  64766. * Glow post process which adds a glow to emissive areas of the image
  64767. */
  64768. private _glowLayer;
  64769. /**
  64770. * Animations which can be used to tweak settings over a period of time
  64771. */
  64772. animations: Animation[];
  64773. private _imageProcessingConfigurationObserver;
  64774. private _sharpenEnabled;
  64775. private _bloomEnabled;
  64776. private _depthOfFieldEnabled;
  64777. private _depthOfFieldBlurLevel;
  64778. private _fxaaEnabled;
  64779. private _imageProcessingEnabled;
  64780. private _defaultPipelineTextureType;
  64781. private _bloomScale;
  64782. private _chromaticAberrationEnabled;
  64783. private _grainEnabled;
  64784. private _buildAllowed;
  64785. /**
  64786. * Gets active scene
  64787. */
  64788. readonly scene: Scene;
  64789. /**
  64790. * Enable or disable the sharpen process from the pipeline
  64791. */
  64792. sharpenEnabled: boolean;
  64793. private _resizeObserver;
  64794. private _hardwareScaleLevel;
  64795. private _bloomKernel;
  64796. /**
  64797. * Specifies the size of the bloom blur kernel, relative to the final output size
  64798. */
  64799. bloomKernel: number;
  64800. /**
  64801. * Specifies the weight of the bloom in the final rendering
  64802. */
  64803. private _bloomWeight;
  64804. /**
  64805. * Specifies the luma threshold for the area that will be blurred by the bloom
  64806. */
  64807. private _bloomThreshold;
  64808. private _hdr;
  64809. /**
  64810. * The strength of the bloom.
  64811. */
  64812. bloomWeight: number;
  64813. /**
  64814. * The strength of the bloom.
  64815. */
  64816. bloomThreshold: number;
  64817. /**
  64818. * The scale of the bloom, lower value will provide better performance.
  64819. */
  64820. bloomScale: number;
  64821. /**
  64822. * Enable or disable the bloom from the pipeline
  64823. */
  64824. bloomEnabled: boolean;
  64825. private _rebuildBloom;
  64826. /**
  64827. * If the depth of field is enabled.
  64828. */
  64829. depthOfFieldEnabled: boolean;
  64830. /**
  64831. * Blur level of the depth of field effect. (Higher blur will effect performance)
  64832. */
  64833. depthOfFieldBlurLevel: DepthOfFieldEffectBlurLevel;
  64834. /**
  64835. * If the anti aliasing is enabled.
  64836. */
  64837. fxaaEnabled: boolean;
  64838. private _samples;
  64839. /**
  64840. * MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  64841. */
  64842. samples: number;
  64843. /**
  64844. * If image processing is enabled.
  64845. */
  64846. imageProcessingEnabled: boolean;
  64847. /**
  64848. * If glow layer is enabled. (Adds a glow effect to emmissive materials)
  64849. */
  64850. glowLayerEnabled: boolean;
  64851. /**
  64852. * Gets the glow layer (or null if not defined)
  64853. */
  64854. readonly glowLayer: Nullable<GlowLayer>;
  64855. /**
  64856. * Enable or disable the chromaticAberration process from the pipeline
  64857. */
  64858. chromaticAberrationEnabled: boolean;
  64859. /**
  64860. * Enable or disable the grain process from the pipeline
  64861. */
  64862. grainEnabled: boolean;
  64863. /**
  64864. * @constructor
  64865. * @param name - The rendering pipeline name (default: "")
  64866. * @param hdr - If high dynamic range textures should be used (default: true)
  64867. * @param scene - The scene linked to this pipeline (default: the last created scene)
  64868. * @param cameras - The array of cameras that the rendering pipeline will be attached to (default: scene.cameras)
  64869. * @param automaticBuild - if false, you will have to manually call prepare() to update the pipeline (default: true)
  64870. */
  64871. constructor(name?: string, hdr?: boolean, scene?: Scene, cameras?: Camera[], automaticBuild?: boolean);
  64872. /**
  64873. * Get the class name
  64874. * @returns "DefaultRenderingPipeline"
  64875. */
  64876. getClassName(): string;
  64877. /**
  64878. * Force the compilation of the entire pipeline.
  64879. */
  64880. prepare(): void;
  64881. private _hasCleared;
  64882. private _prevPostProcess;
  64883. private _prevPrevPostProcess;
  64884. private _setAutoClearAndTextureSharing;
  64885. private _depthOfFieldSceneObserver;
  64886. private _buildPipeline;
  64887. private _disposePostProcesses;
  64888. /**
  64889. * Adds a camera to the pipeline
  64890. * @param camera the camera to be added
  64891. */
  64892. addCamera(camera: Camera): void;
  64893. /**
  64894. * Removes a camera from the pipeline
  64895. * @param camera the camera to remove
  64896. */
  64897. removeCamera(camera: Camera): void;
  64898. /**
  64899. * Dispose of the pipeline and stop all post processes
  64900. */
  64901. dispose(): void;
  64902. /**
  64903. * Serialize the rendering pipeline (Used when exporting)
  64904. * @returns the serialized object
  64905. */
  64906. serialize(): any;
  64907. /**
  64908. * Parse the serialized pipeline
  64909. * @param source Source pipeline.
  64910. * @param scene The scene to load the pipeline to.
  64911. * @param rootUrl The URL of the serialized pipeline.
  64912. * @returns An instantiated pipeline from the serialized object.
  64913. */
  64914. static Parse(source: any, scene: Scene, rootUrl: string): DefaultRenderingPipeline;
  64915. }
  64916. }
  64917. declare module "babylonjs/Shaders/lensHighlights.fragment" {
  64918. /** @hidden */
  64919. export var lensHighlightsPixelShader: {
  64920. name: string;
  64921. shader: string;
  64922. };
  64923. }
  64924. declare module "babylonjs/Shaders/depthOfField.fragment" {
  64925. /** @hidden */
  64926. export var depthOfFieldPixelShader: {
  64927. name: string;
  64928. shader: string;
  64929. };
  64930. }
  64931. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline" {
  64932. import { Camera } from "babylonjs/Cameras/camera";
  64933. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  64934. import { Scene } from "babylonjs/scene";
  64935. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  64936. import "babylonjs/Shaders/chromaticAberration.fragment";
  64937. import "babylonjs/Shaders/lensHighlights.fragment";
  64938. import "babylonjs/Shaders/depthOfField.fragment";
  64939. /**
  64940. * BABYLON.JS Chromatic Aberration GLSL Shader
  64941. * Author: Olivier Guyot
  64942. * Separates very slightly R, G and B colors on the edges of the screen
  64943. * Inspired by Francois Tarlier & Martins Upitis
  64944. */
  64945. export class LensRenderingPipeline extends PostProcessRenderPipeline {
  64946. /**
  64947. * @ignore
  64948. * The chromatic aberration PostProcess id in the pipeline
  64949. */
  64950. LensChromaticAberrationEffect: string;
  64951. /**
  64952. * @ignore
  64953. * The highlights enhancing PostProcess id in the pipeline
  64954. */
  64955. HighlightsEnhancingEffect: string;
  64956. /**
  64957. * @ignore
  64958. * The depth-of-field PostProcess id in the pipeline
  64959. */
  64960. LensDepthOfFieldEffect: string;
  64961. private _scene;
  64962. private _depthTexture;
  64963. private _grainTexture;
  64964. private _chromaticAberrationPostProcess;
  64965. private _highlightsPostProcess;
  64966. private _depthOfFieldPostProcess;
  64967. private _edgeBlur;
  64968. private _grainAmount;
  64969. private _chromaticAberration;
  64970. private _distortion;
  64971. private _highlightsGain;
  64972. private _highlightsThreshold;
  64973. private _dofDistance;
  64974. private _dofAperture;
  64975. private _dofDarken;
  64976. private _dofPentagon;
  64977. private _blurNoise;
  64978. /**
  64979. * @constructor
  64980. *
  64981. * Effect parameters are as follow:
  64982. * {
  64983. * chromatic_aberration: number; // from 0 to x (1 for realism)
  64984. * edge_blur: number; // from 0 to x (1 for realism)
  64985. * distortion: number; // from 0 to x (1 for realism)
  64986. * grain_amount: number; // from 0 to 1
  64987. * grain_texture: BABYLON.Texture; // texture to use for grain effect; if unset, use random B&W noise
  64988. * dof_focus_distance: number; // depth-of-field: focus distance; unset to disable (disabled by default)
  64989. * dof_aperture: number; // depth-of-field: focus blur bias (default: 1)
  64990. * dof_darken: number; // depth-of-field: darken that which is out of focus (from 0 to 1, disabled by default)
  64991. * dof_pentagon: boolean; // depth-of-field: makes a pentagon-like "bokeh" effect
  64992. * dof_gain: number; // depth-of-field: highlights gain; unset to disable (disabled by default)
  64993. * dof_threshold: number; // depth-of-field: highlights threshold (default: 1)
  64994. * blur_noise: boolean; // add a little bit of noise to the blur (default: true)
  64995. * }
  64996. * Note: if an effect parameter is unset, effect is disabled
  64997. *
  64998. * @param name The rendering pipeline name
  64999. * @param parameters - An object containing all parameters (see above)
  65000. * @param scene The scene linked to this pipeline
  65001. * @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)
  65002. * @param cameras The array of cameras that the rendering pipeline will be attached to
  65003. */
  65004. constructor(name: string, parameters: any, scene: Scene, ratio?: number, cameras?: Camera[]);
  65005. /**
  65006. * Get the class name
  65007. * @returns "LensRenderingPipeline"
  65008. */
  65009. getClassName(): string;
  65010. /**
  65011. * Gets associated scene
  65012. */
  65013. readonly scene: Scene;
  65014. /**
  65015. * Gets or sets the edge blur
  65016. */
  65017. edgeBlur: number;
  65018. /**
  65019. * Gets or sets the grain amount
  65020. */
  65021. grainAmount: number;
  65022. /**
  65023. * Gets or sets the chromatic aberration amount
  65024. */
  65025. chromaticAberration: number;
  65026. /**
  65027. * Gets or sets the depth of field aperture
  65028. */
  65029. dofAperture: number;
  65030. /**
  65031. * Gets or sets the edge distortion
  65032. */
  65033. edgeDistortion: number;
  65034. /**
  65035. * Gets or sets the depth of field distortion
  65036. */
  65037. dofDistortion: number;
  65038. /**
  65039. * Gets or sets the darken out of focus amount
  65040. */
  65041. darkenOutOfFocus: number;
  65042. /**
  65043. * Gets or sets a boolean indicating if blur noise is enabled
  65044. */
  65045. blurNoise: boolean;
  65046. /**
  65047. * Gets or sets a boolean indicating if pentagon bokeh is enabled
  65048. */
  65049. pentagonBokeh: boolean;
  65050. /**
  65051. * Gets or sets the highlight grain amount
  65052. */
  65053. highlightsGain: number;
  65054. /**
  65055. * Gets or sets the highlight threshold
  65056. */
  65057. highlightsThreshold: number;
  65058. /**
  65059. * Sets the amount of blur at the edges
  65060. * @param amount blur amount
  65061. */
  65062. setEdgeBlur(amount: number): void;
  65063. /**
  65064. * Sets edge blur to 0
  65065. */
  65066. disableEdgeBlur(): void;
  65067. /**
  65068. * Sets the amout of grain
  65069. * @param amount Amount of grain
  65070. */
  65071. setGrainAmount(amount: number): void;
  65072. /**
  65073. * Set grain amount to 0
  65074. */
  65075. disableGrain(): void;
  65076. /**
  65077. * Sets the chromatic aberration amount
  65078. * @param amount amount of chromatic aberration
  65079. */
  65080. setChromaticAberration(amount: number): void;
  65081. /**
  65082. * Sets chromatic aberration amount to 0
  65083. */
  65084. disableChromaticAberration(): void;
  65085. /**
  65086. * Sets the EdgeDistortion amount
  65087. * @param amount amount of EdgeDistortion
  65088. */
  65089. setEdgeDistortion(amount: number): void;
  65090. /**
  65091. * Sets edge distortion to 0
  65092. */
  65093. disableEdgeDistortion(): void;
  65094. /**
  65095. * Sets the FocusDistance amount
  65096. * @param amount amount of FocusDistance
  65097. */
  65098. setFocusDistance(amount: number): void;
  65099. /**
  65100. * Disables depth of field
  65101. */
  65102. disableDepthOfField(): void;
  65103. /**
  65104. * Sets the Aperture amount
  65105. * @param amount amount of Aperture
  65106. */
  65107. setAperture(amount: number): void;
  65108. /**
  65109. * Sets the DarkenOutOfFocus amount
  65110. * @param amount amount of DarkenOutOfFocus
  65111. */
  65112. setDarkenOutOfFocus(amount: number): void;
  65113. private _pentagonBokehIsEnabled;
  65114. /**
  65115. * Creates a pentagon bokeh effect
  65116. */
  65117. enablePentagonBokeh(): void;
  65118. /**
  65119. * Disables the pentagon bokeh effect
  65120. */
  65121. disablePentagonBokeh(): void;
  65122. /**
  65123. * Enables noise blur
  65124. */
  65125. enableNoiseBlur(): void;
  65126. /**
  65127. * Disables noise blur
  65128. */
  65129. disableNoiseBlur(): void;
  65130. /**
  65131. * Sets the HighlightsGain amount
  65132. * @param amount amount of HighlightsGain
  65133. */
  65134. setHighlightsGain(amount: number): void;
  65135. /**
  65136. * Sets the HighlightsThreshold amount
  65137. * @param amount amount of HighlightsThreshold
  65138. */
  65139. setHighlightsThreshold(amount: number): void;
  65140. /**
  65141. * Disables highlights
  65142. */
  65143. disableHighlights(): void;
  65144. /**
  65145. * Removes the internal pipeline assets and detaches the pipeline from the scene cameras
  65146. * @param disableDepthRender If the scens depth rendering should be disabled (default: false)
  65147. */
  65148. dispose(disableDepthRender?: boolean): void;
  65149. private _createChromaticAberrationPostProcess;
  65150. private _createHighlightsPostProcess;
  65151. private _createDepthOfFieldPostProcess;
  65152. private _createGrainTexture;
  65153. }
  65154. }
  65155. declare module "babylonjs/Shaders/ssao2.fragment" {
  65156. /** @hidden */
  65157. export var ssao2PixelShader: {
  65158. name: string;
  65159. shader: string;
  65160. };
  65161. }
  65162. declare module "babylonjs/Shaders/ssaoCombine.fragment" {
  65163. /** @hidden */
  65164. export var ssaoCombinePixelShader: {
  65165. name: string;
  65166. shader: string;
  65167. };
  65168. }
  65169. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssao2RenderingPipeline" {
  65170. import { Camera } from "babylonjs/Cameras/camera";
  65171. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  65172. import { Scene } from "babylonjs/scene";
  65173. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  65174. import "babylonjs/Shaders/ssao2.fragment";
  65175. import "babylonjs/Shaders/ssaoCombine.fragment";
  65176. /**
  65177. * Render pipeline to produce ssao effect
  65178. */
  65179. export class SSAO2RenderingPipeline extends PostProcessRenderPipeline {
  65180. /**
  65181. * @ignore
  65182. * The PassPostProcess id in the pipeline that contains the original scene color
  65183. */
  65184. SSAOOriginalSceneColorEffect: string;
  65185. /**
  65186. * @ignore
  65187. * The SSAO PostProcess id in the pipeline
  65188. */
  65189. SSAORenderEffect: string;
  65190. /**
  65191. * @ignore
  65192. * The horizontal blur PostProcess id in the pipeline
  65193. */
  65194. SSAOBlurHRenderEffect: string;
  65195. /**
  65196. * @ignore
  65197. * The vertical blur PostProcess id in the pipeline
  65198. */
  65199. SSAOBlurVRenderEffect: string;
  65200. /**
  65201. * @ignore
  65202. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  65203. */
  65204. SSAOCombineRenderEffect: string;
  65205. /**
  65206. * The output strength of the SSAO post-process. Default value is 1.0.
  65207. */
  65208. totalStrength: number;
  65209. /**
  65210. * Maximum depth value to still render AO. A smooth falloff makes the dimming more natural, so there will be no abrupt shading change.
  65211. */
  65212. maxZ: number;
  65213. /**
  65214. * In order to save performances, SSAO radius is clamped on close geometry. This ratio changes by how much
  65215. */
  65216. minZAspect: number;
  65217. private _samples;
  65218. /**
  65219. * Number of samples used for the SSAO calculations. Default value is 8
  65220. */
  65221. samples: number;
  65222. private _textureSamples;
  65223. /**
  65224. * Number of samples to use for antialiasing
  65225. */
  65226. textureSamples: number;
  65227. /**
  65228. * Ratio object used for SSAO ratio and blur ratio
  65229. */
  65230. private _ratio;
  65231. /**
  65232. * Dynamically generated sphere sampler.
  65233. */
  65234. private _sampleSphere;
  65235. /**
  65236. * Blur filter offsets
  65237. */
  65238. private _samplerOffsets;
  65239. private _expensiveBlur;
  65240. /**
  65241. * If bilateral blur should be used
  65242. */
  65243. expensiveBlur: boolean;
  65244. /**
  65245. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 2.0
  65246. */
  65247. radius: number;
  65248. /**
  65249. * The base color of the SSAO post-process
  65250. * The final result is "base + ssao" between [0, 1]
  65251. */
  65252. base: number;
  65253. /**
  65254. * Support test.
  65255. */
  65256. static readonly IsSupported: boolean;
  65257. private _scene;
  65258. private _depthTexture;
  65259. private _normalTexture;
  65260. private _randomTexture;
  65261. private _originalColorPostProcess;
  65262. private _ssaoPostProcess;
  65263. private _blurHPostProcess;
  65264. private _blurVPostProcess;
  65265. private _ssaoCombinePostProcess;
  65266. /**
  65267. * Gets active scene
  65268. */
  65269. readonly scene: Scene;
  65270. /**
  65271. * @constructor
  65272. * @param name The rendering pipeline name
  65273. * @param scene The scene linked to this pipeline
  65274. * @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 }
  65275. * @param cameras The array of cameras that the rendering pipeline will be attached to
  65276. */
  65277. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[]);
  65278. /**
  65279. * Get the class name
  65280. * @returns "SSAO2RenderingPipeline"
  65281. */
  65282. getClassName(): string;
  65283. /**
  65284. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  65285. */
  65286. dispose(disableGeometryBufferRenderer?: boolean): void;
  65287. private _createBlurPostProcess;
  65288. /** @hidden */
  65289. _rebuild(): void;
  65290. private _bits;
  65291. private _radicalInverse_VdC;
  65292. private _hammersley;
  65293. private _hemisphereSample_uniform;
  65294. private _generateHemisphere;
  65295. private _createSSAOPostProcess;
  65296. private _createSSAOCombinePostProcess;
  65297. private _createRandomTexture;
  65298. /**
  65299. * Serialize the rendering pipeline (Used when exporting)
  65300. * @returns the serialized object
  65301. */
  65302. serialize(): any;
  65303. /**
  65304. * Parse the serialized pipeline
  65305. * @param source Source pipeline.
  65306. * @param scene The scene to load the pipeline to.
  65307. * @param rootUrl The URL of the serialized pipeline.
  65308. * @returns An instantiated pipeline from the serialized object.
  65309. */
  65310. static Parse(source: any, scene: Scene, rootUrl: string): SSAO2RenderingPipeline;
  65311. }
  65312. }
  65313. declare module "babylonjs/Shaders/ssao.fragment" {
  65314. /** @hidden */
  65315. export var ssaoPixelShader: {
  65316. name: string;
  65317. shader: string;
  65318. };
  65319. }
  65320. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssaoRenderingPipeline" {
  65321. import { Camera } from "babylonjs/Cameras/camera";
  65322. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  65323. import { Scene } from "babylonjs/scene";
  65324. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  65325. import "babylonjs/Shaders/ssao.fragment";
  65326. import "babylonjs/Shaders/ssaoCombine.fragment";
  65327. /**
  65328. * Render pipeline to produce ssao effect
  65329. */
  65330. export class SSAORenderingPipeline extends PostProcessRenderPipeline {
  65331. /**
  65332. * @ignore
  65333. * The PassPostProcess id in the pipeline that contains the original scene color
  65334. */
  65335. SSAOOriginalSceneColorEffect: string;
  65336. /**
  65337. * @ignore
  65338. * The SSAO PostProcess id in the pipeline
  65339. */
  65340. SSAORenderEffect: string;
  65341. /**
  65342. * @ignore
  65343. * The horizontal blur PostProcess id in the pipeline
  65344. */
  65345. SSAOBlurHRenderEffect: string;
  65346. /**
  65347. * @ignore
  65348. * The vertical blur PostProcess id in the pipeline
  65349. */
  65350. SSAOBlurVRenderEffect: string;
  65351. /**
  65352. * @ignore
  65353. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  65354. */
  65355. SSAOCombineRenderEffect: string;
  65356. /**
  65357. * The output strength of the SSAO post-process. Default value is 1.0.
  65358. */
  65359. totalStrength: number;
  65360. /**
  65361. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 0.0006
  65362. */
  65363. radius: number;
  65364. /**
  65365. * Related to fallOff, used to interpolate SSAO samples (first interpolate function input) based on the occlusion difference of each pixel
  65366. * Must not be equal to fallOff and superior to fallOff.
  65367. * Default value is 0.0075
  65368. */
  65369. area: number;
  65370. /**
  65371. * Related to area, used to interpolate SSAO samples (second interpolate function input) based on the occlusion difference of each pixel
  65372. * Must not be equal to area and inferior to area.
  65373. * Default value is 0.000001
  65374. */
  65375. fallOff: number;
  65376. /**
  65377. * The base color of the SSAO post-process
  65378. * The final result is "base + ssao" between [0, 1]
  65379. */
  65380. base: number;
  65381. private _scene;
  65382. private _depthTexture;
  65383. private _randomTexture;
  65384. private _originalColorPostProcess;
  65385. private _ssaoPostProcess;
  65386. private _blurHPostProcess;
  65387. private _blurVPostProcess;
  65388. private _ssaoCombinePostProcess;
  65389. private _firstUpdate;
  65390. /**
  65391. * Gets active scene
  65392. */
  65393. readonly scene: Scene;
  65394. /**
  65395. * @constructor
  65396. * @param name - The rendering pipeline name
  65397. * @param scene - The scene linked to this pipeline
  65398. * @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 }
  65399. * @param cameras - The array of cameras that the rendering pipeline will be attached to
  65400. */
  65401. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[]);
  65402. /**
  65403. * Get the class name
  65404. * @returns "SSAORenderingPipeline"
  65405. */
  65406. getClassName(): string;
  65407. /**
  65408. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  65409. */
  65410. dispose(disableDepthRender?: boolean): void;
  65411. private _createBlurPostProcess;
  65412. /** @hidden */
  65413. _rebuild(): void;
  65414. private _createSSAOPostProcess;
  65415. private _createSSAOCombinePostProcess;
  65416. private _createRandomTexture;
  65417. }
  65418. }
  65419. declare module "babylonjs/Shaders/standard.fragment" {
  65420. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  65421. /** @hidden */
  65422. export var standardPixelShader: {
  65423. name: string;
  65424. shader: string;
  65425. };
  65426. }
  65427. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/standardRenderingPipeline" {
  65428. import { Nullable } from "babylonjs/types";
  65429. import { IAnimatable } from "babylonjs/Animations/animatable.interface";
  65430. import { Camera } from "babylonjs/Cameras/camera";
  65431. import { Texture } from "babylonjs/Materials/Textures/texture";
  65432. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  65433. import { PostProcessRenderPipeline } from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  65434. import { BlurPostProcess } from "babylonjs/PostProcesses/blurPostProcess";
  65435. import { FxaaPostProcess } from "babylonjs/PostProcesses/fxaaPostProcess";
  65436. import { IDisposable } from "babylonjs/scene";
  65437. import { SpotLight } from "babylonjs/Lights/spotLight";
  65438. import { DirectionalLight } from "babylonjs/Lights/directionalLight";
  65439. import { Scene } from "babylonjs/scene";
  65440. import { Animation } from "babylonjs/Animations/animation";
  65441. import "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  65442. import "babylonjs/Shaders/standard.fragment";
  65443. /**
  65444. * Standard rendering pipeline
  65445. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  65446. * @see https://doc.babylonjs.com/how_to/using_standard_rendering_pipeline
  65447. */
  65448. export class StandardRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  65449. /**
  65450. * Public members
  65451. */
  65452. /**
  65453. * Post-process which contains the original scene color before the pipeline applies all the effects
  65454. */
  65455. originalPostProcess: Nullable<PostProcess>;
  65456. /**
  65457. * Post-process used to down scale an image x4
  65458. */
  65459. downSampleX4PostProcess: Nullable<PostProcess>;
  65460. /**
  65461. * Post-process used to calculate the illuminated surfaces controlled by a threshold
  65462. */
  65463. brightPassPostProcess: Nullable<PostProcess>;
  65464. /**
  65465. * Post-process array storing all the horizontal blur post-processes used by the pipeline
  65466. */
  65467. blurHPostProcesses: PostProcess[];
  65468. /**
  65469. * Post-process array storing all the vertical blur post-processes used by the pipeline
  65470. */
  65471. blurVPostProcesses: PostProcess[];
  65472. /**
  65473. * Post-process used to add colors of 2 textures (typically brightness + real scene color)
  65474. */
  65475. textureAdderPostProcess: Nullable<PostProcess>;
  65476. /**
  65477. * Post-process used to create volumetric lighting effect
  65478. */
  65479. volumetricLightPostProcess: Nullable<PostProcess>;
  65480. /**
  65481. * Post-process used to smooth the previous volumetric light post-process on the X axis
  65482. */
  65483. volumetricLightSmoothXPostProcess: Nullable<BlurPostProcess>;
  65484. /**
  65485. * Post-process used to smooth the previous volumetric light post-process on the Y axis
  65486. */
  65487. volumetricLightSmoothYPostProcess: Nullable<BlurPostProcess>;
  65488. /**
  65489. * Post-process used to merge the volumetric light effect and the real scene color
  65490. */
  65491. volumetricLightMergePostProces: Nullable<PostProcess>;
  65492. /**
  65493. * Post-process used to store the final volumetric light post-process (attach/detach for debug purpose)
  65494. */
  65495. volumetricLightFinalPostProcess: Nullable<PostProcess>;
  65496. /**
  65497. * Base post-process used to calculate the average luminance of the final image for HDR
  65498. */
  65499. luminancePostProcess: Nullable<PostProcess>;
  65500. /**
  65501. * Post-processes used to create down sample post-processes in order to get
  65502. * the average luminance of the final image for HDR
  65503. * Array of length "StandardRenderingPipeline.LuminanceSteps"
  65504. */
  65505. luminanceDownSamplePostProcesses: PostProcess[];
  65506. /**
  65507. * Post-process used to create a HDR effect (light adaptation)
  65508. */
  65509. hdrPostProcess: Nullable<PostProcess>;
  65510. /**
  65511. * Post-process used to store the final texture adder post-process (attach/detach for debug purpose)
  65512. */
  65513. textureAdderFinalPostProcess: Nullable<PostProcess>;
  65514. /**
  65515. * Post-process used to store the final lens flare post-process (attach/detach for debug purpose)
  65516. */
  65517. lensFlareFinalPostProcess: Nullable<PostProcess>;
  65518. /**
  65519. * Post-process used to merge the final HDR post-process and the real scene color
  65520. */
  65521. hdrFinalPostProcess: Nullable<PostProcess>;
  65522. /**
  65523. * Post-process used to create a lens flare effect
  65524. */
  65525. lensFlarePostProcess: Nullable<PostProcess>;
  65526. /**
  65527. * Post-process that merges the result of the lens flare post-process and the real scene color
  65528. */
  65529. lensFlareComposePostProcess: Nullable<PostProcess>;
  65530. /**
  65531. * Post-process used to create a motion blur effect
  65532. */
  65533. motionBlurPostProcess: Nullable<PostProcess>;
  65534. /**
  65535. * Post-process used to create a depth of field effect
  65536. */
  65537. depthOfFieldPostProcess: Nullable<PostProcess>;
  65538. /**
  65539. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  65540. */
  65541. fxaaPostProcess: Nullable<FxaaPostProcess>;
  65542. /**
  65543. * Represents the brightness threshold in order to configure the illuminated surfaces
  65544. */
  65545. brightThreshold: number;
  65546. /**
  65547. * Configures the blur intensity used for surexposed surfaces are highlighted surfaces (light halo)
  65548. */
  65549. blurWidth: number;
  65550. /**
  65551. * Sets if the blur for highlighted surfaces must be only horizontal
  65552. */
  65553. horizontalBlur: boolean;
  65554. /**
  65555. * Gets the overall exposure used by the pipeline
  65556. */
  65557. /**
  65558. * Sets the overall exposure used by the pipeline
  65559. */
  65560. exposure: number;
  65561. /**
  65562. * Texture used typically to simulate "dirty" on camera lens
  65563. */
  65564. lensTexture: Nullable<Texture>;
  65565. /**
  65566. * Represents the offset coefficient based on Rayleigh principle. Typically in interval [-0.2, 0.2]
  65567. */
  65568. volumetricLightCoefficient: number;
  65569. /**
  65570. * The overall power of volumetric lights, typically in interval [0, 10] maximum
  65571. */
  65572. volumetricLightPower: number;
  65573. /**
  65574. * Used the set the blur intensity to smooth the volumetric lights
  65575. */
  65576. volumetricLightBlurScale: number;
  65577. /**
  65578. * Light (spot or directional) used to generate the volumetric lights rays
  65579. * The source light must have a shadow generate so the pipeline can get its
  65580. * depth map
  65581. */
  65582. sourceLight: Nullable<SpotLight | DirectionalLight>;
  65583. /**
  65584. * For eye adaptation, represents the minimum luminance the eye can see
  65585. */
  65586. hdrMinimumLuminance: number;
  65587. /**
  65588. * For eye adaptation, represents the decrease luminance speed
  65589. */
  65590. hdrDecreaseRate: number;
  65591. /**
  65592. * For eye adaptation, represents the increase luminance speed
  65593. */
  65594. hdrIncreaseRate: number;
  65595. /**
  65596. * Gets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  65597. */
  65598. /**
  65599. * Sets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  65600. */
  65601. hdrAutoExposure: boolean;
  65602. /**
  65603. * Lens color texture used by the lens flare effect. Mandatory if lens flare effect enabled
  65604. */
  65605. lensColorTexture: Nullable<Texture>;
  65606. /**
  65607. * The overall strengh for the lens flare effect
  65608. */
  65609. lensFlareStrength: number;
  65610. /**
  65611. * Dispersion coefficient for lens flare ghosts
  65612. */
  65613. lensFlareGhostDispersal: number;
  65614. /**
  65615. * Main lens flare halo width
  65616. */
  65617. lensFlareHaloWidth: number;
  65618. /**
  65619. * Based on the lens distortion effect, defines how much the lens flare result
  65620. * is distorted
  65621. */
  65622. lensFlareDistortionStrength: number;
  65623. /**
  65624. * Configures the blur intensity used for for lens flare (halo)
  65625. */
  65626. lensFlareBlurWidth: number;
  65627. /**
  65628. * Lens star texture must be used to simulate rays on the flares and is available
  65629. * in the documentation
  65630. */
  65631. lensStarTexture: Nullable<Texture>;
  65632. /**
  65633. * As the "lensTexture" (can be the same texture or different), it is used to apply the lens
  65634. * flare effect by taking account of the dirt texture
  65635. */
  65636. lensFlareDirtTexture: Nullable<Texture>;
  65637. /**
  65638. * Represents the focal length for the depth of field effect
  65639. */
  65640. depthOfFieldDistance: number;
  65641. /**
  65642. * Represents the blur intensity for the blurred part of the depth of field effect
  65643. */
  65644. depthOfFieldBlurWidth: number;
  65645. /**
  65646. * Gets how much the image is blurred by the movement while using the motion blur post-process
  65647. */
  65648. /**
  65649. * Sets how much the image is blurred by the movement while using the motion blur post-process
  65650. */
  65651. motionStrength: number;
  65652. /**
  65653. * Gets wether or not the motion blur post-process is object based or screen based.
  65654. */
  65655. /**
  65656. * Sets wether or not the motion blur post-process should be object based or screen based
  65657. */
  65658. objectBasedMotionBlur: boolean;
  65659. /**
  65660. * List of animations for the pipeline (IAnimatable implementation)
  65661. */
  65662. animations: Animation[];
  65663. /**
  65664. * Private members
  65665. */
  65666. private _scene;
  65667. private _currentDepthOfFieldSource;
  65668. private _basePostProcess;
  65669. private _fixedExposure;
  65670. private _currentExposure;
  65671. private _hdrAutoExposure;
  65672. private _hdrCurrentLuminance;
  65673. private _motionStrength;
  65674. private _isObjectBasedMotionBlur;
  65675. private _floatTextureType;
  65676. private _camerasToBeAttached;
  65677. private _ratio;
  65678. private _bloomEnabled;
  65679. private _depthOfFieldEnabled;
  65680. private _vlsEnabled;
  65681. private _lensFlareEnabled;
  65682. private _hdrEnabled;
  65683. private _motionBlurEnabled;
  65684. private _fxaaEnabled;
  65685. private _motionBlurSamples;
  65686. private _volumetricLightStepsCount;
  65687. private _samples;
  65688. /**
  65689. * @ignore
  65690. * Specifies if the bloom pipeline is enabled
  65691. */
  65692. BloomEnabled: boolean;
  65693. /**
  65694. * @ignore
  65695. * Specifies if the depth of field pipeline is enabed
  65696. */
  65697. DepthOfFieldEnabled: boolean;
  65698. /**
  65699. * @ignore
  65700. * Specifies if the lens flare pipeline is enabed
  65701. */
  65702. LensFlareEnabled: boolean;
  65703. /**
  65704. * @ignore
  65705. * Specifies if the HDR pipeline is enabled
  65706. */
  65707. HDREnabled: boolean;
  65708. /**
  65709. * @ignore
  65710. * Specifies if the volumetric lights scattering effect is enabled
  65711. */
  65712. VLSEnabled: boolean;
  65713. /**
  65714. * @ignore
  65715. * Specifies if the motion blur effect is enabled
  65716. */
  65717. MotionBlurEnabled: boolean;
  65718. /**
  65719. * Specifies if anti-aliasing is enabled
  65720. */
  65721. fxaaEnabled: boolean;
  65722. /**
  65723. * Specifies the number of steps used to calculate the volumetric lights
  65724. * Typically in interval [50, 200]
  65725. */
  65726. volumetricLightStepsCount: number;
  65727. /**
  65728. * Specifies the number of samples used for the motion blur effect
  65729. * Typically in interval [16, 64]
  65730. */
  65731. motionBlurSamples: number;
  65732. /**
  65733. * Specifies MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  65734. */
  65735. samples: number;
  65736. /**
  65737. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  65738. * @constructor
  65739. * @param name The rendering pipeline name
  65740. * @param scene The scene linked to this pipeline
  65741. * @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)
  65742. * @param originalPostProcess the custom original color post-process. Must be "reusable". Can be null.
  65743. * @param cameras The array of cameras that the rendering pipeline will be attached to
  65744. */
  65745. constructor(name: string, scene: Scene, ratio: number, originalPostProcess?: Nullable<PostProcess>, cameras?: Camera[]);
  65746. private _buildPipeline;
  65747. private _createDownSampleX4PostProcess;
  65748. private _createBrightPassPostProcess;
  65749. private _createBlurPostProcesses;
  65750. private _createTextureAdderPostProcess;
  65751. private _createVolumetricLightPostProcess;
  65752. private _createLuminancePostProcesses;
  65753. private _createHdrPostProcess;
  65754. private _createLensFlarePostProcess;
  65755. private _createDepthOfFieldPostProcess;
  65756. private _createMotionBlurPostProcess;
  65757. private _getDepthTexture;
  65758. private _disposePostProcesses;
  65759. /**
  65760. * Dispose of the pipeline and stop all post processes
  65761. */
  65762. dispose(): void;
  65763. /**
  65764. * Serialize the rendering pipeline (Used when exporting)
  65765. * @returns the serialized object
  65766. */
  65767. serialize(): any;
  65768. /**
  65769. * Parse the serialized pipeline
  65770. * @param source Source pipeline.
  65771. * @param scene The scene to load the pipeline to.
  65772. * @param rootUrl The URL of the serialized pipeline.
  65773. * @returns An instantiated pipeline from the serialized object.
  65774. */
  65775. static Parse(source: any, scene: Scene, rootUrl: string): StandardRenderingPipeline;
  65776. /**
  65777. * Luminance steps
  65778. */
  65779. static LuminanceSteps: number;
  65780. }
  65781. }
  65782. declare module "babylonjs/PostProcesses/RenderPipeline/Pipelines/index" {
  65783. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/defaultRenderingPipeline";
  65784. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/lensRenderingPipeline";
  65785. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssao2RenderingPipeline";
  65786. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/ssaoRenderingPipeline";
  65787. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/standardRenderingPipeline";
  65788. }
  65789. declare module "babylonjs/PostProcesses/RenderPipeline/index" {
  65790. export * from "babylonjs/PostProcesses/RenderPipeline/Pipelines/index";
  65791. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderEffect";
  65792. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipeline";
  65793. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManager";
  65794. export * from "babylonjs/PostProcesses/RenderPipeline/postProcessRenderPipelineManagerSceneComponent";
  65795. }
  65796. declare module "babylonjs/Shaders/tonemap.fragment" {
  65797. /** @hidden */
  65798. export var tonemapPixelShader: {
  65799. name: string;
  65800. shader: string;
  65801. };
  65802. }
  65803. declare module "babylonjs/PostProcesses/tonemapPostProcess" {
  65804. import { Camera } from "babylonjs/Cameras/camera";
  65805. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  65806. import "babylonjs/Shaders/tonemap.fragment";
  65807. import { Engine } from "babylonjs/Engines/engine";
  65808. /** Defines operator used for tonemapping */
  65809. export enum TonemappingOperator {
  65810. /** Hable */
  65811. Hable = 0,
  65812. /** Reinhard */
  65813. Reinhard = 1,
  65814. /** HejiDawson */
  65815. HejiDawson = 2,
  65816. /** Photographic */
  65817. Photographic = 3
  65818. }
  65819. /**
  65820. * Defines a post process to apply tone mapping
  65821. */
  65822. export class TonemapPostProcess extends PostProcess {
  65823. private _operator;
  65824. /** Defines the required exposure adjustement */
  65825. exposureAdjustment: number;
  65826. /**
  65827. * Creates a new TonemapPostProcess
  65828. * @param name defines the name of the postprocess
  65829. * @param _operator defines the operator to use
  65830. * @param exposureAdjustment defines the required exposure adjustement
  65831. * @param camera defines the camera to use (can be null)
  65832. * @param samplingMode defines the required sampling mode (BABYLON.Texture.BILINEAR_SAMPLINGMODE by default)
  65833. * @param engine defines the hosting engine (can be ignore if camera is set)
  65834. * @param textureFormat defines the texture format to use (BABYLON.Engine.TEXTURETYPE_UNSIGNED_INT by default)
  65835. */
  65836. constructor(name: string, _operator: TonemappingOperator,
  65837. /** Defines the required exposure adjustement */
  65838. exposureAdjustment: number, camera: Camera, samplingMode?: number, engine?: Engine, textureFormat?: number);
  65839. }
  65840. }
  65841. declare module "babylonjs/Shaders/depth.vertex" {
  65842. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  65843. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  65844. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  65845. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  65846. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  65847. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  65848. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  65849. /** @hidden */
  65850. export var depthVertexShader: {
  65851. name: string;
  65852. shader: string;
  65853. };
  65854. }
  65855. declare module "babylonjs/Shaders/volumetricLightScattering.fragment" {
  65856. /** @hidden */
  65857. export var volumetricLightScatteringPixelShader: {
  65858. name: string;
  65859. shader: string;
  65860. };
  65861. }
  65862. declare module "babylonjs/Shaders/volumetricLightScatteringPass.vertex" {
  65863. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  65864. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  65865. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  65866. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  65867. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  65868. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  65869. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  65870. /** @hidden */
  65871. export var volumetricLightScatteringPassVertexShader: {
  65872. name: string;
  65873. shader: string;
  65874. };
  65875. }
  65876. declare module "babylonjs/Shaders/volumetricLightScatteringPass.fragment" {
  65877. /** @hidden */
  65878. export var volumetricLightScatteringPassPixelShader: {
  65879. name: string;
  65880. shader: string;
  65881. };
  65882. }
  65883. declare module "babylonjs/PostProcesses/volumetricLightScatteringPostProcess" {
  65884. import { Vector3 } from "babylonjs/Maths/math.vector";
  65885. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  65886. import { Mesh } from "babylonjs/Meshes/mesh";
  65887. import { Camera } from "babylonjs/Cameras/camera";
  65888. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  65889. import { PostProcess } from "babylonjs/PostProcesses/postProcess";
  65890. import { Scene } from "babylonjs/scene";
  65891. import "babylonjs/Meshes/Builders/planeBuilder";
  65892. import "babylonjs/Shaders/depth.vertex";
  65893. import "babylonjs/Shaders/volumetricLightScattering.fragment";
  65894. import "babylonjs/Shaders/volumetricLightScatteringPass.vertex";
  65895. import "babylonjs/Shaders/volumetricLightScatteringPass.fragment";
  65896. import { Engine } from "babylonjs/Engines/engine";
  65897. /**
  65898. * Inspired by http://http.developer.nvidia.com/GPUGems3/gpugems3_ch13.html
  65899. */
  65900. export class VolumetricLightScatteringPostProcess extends PostProcess {
  65901. private _volumetricLightScatteringPass;
  65902. private _volumetricLightScatteringRTT;
  65903. private _viewPort;
  65904. private _screenCoordinates;
  65905. private _cachedDefines;
  65906. /**
  65907. * If not undefined, the mesh position is computed from the attached node position
  65908. */
  65909. attachedNode: {
  65910. position: Vector3;
  65911. };
  65912. /**
  65913. * Custom position of the mesh. Used if "useCustomMeshPosition" is set to "true"
  65914. */
  65915. customMeshPosition: Vector3;
  65916. /**
  65917. * Set if the post-process should use a custom position for the light source (true) or the internal mesh position (false)
  65918. */
  65919. useCustomMeshPosition: boolean;
  65920. /**
  65921. * If the post-process should inverse the light scattering direction
  65922. */
  65923. invert: boolean;
  65924. /**
  65925. * The internal mesh used by the post-process
  65926. */
  65927. mesh: Mesh;
  65928. /**
  65929. * @hidden
  65930. * VolumetricLightScatteringPostProcess.useDiffuseColor is no longer used, use the mesh material directly instead
  65931. */
  65932. useDiffuseColor: boolean;
  65933. /**
  65934. * Array containing the excluded meshes not rendered in the internal pass
  65935. */
  65936. excludedMeshes: AbstractMesh[];
  65937. /**
  65938. * Controls the overall intensity of the post-process
  65939. */
  65940. exposure: number;
  65941. /**
  65942. * Dissipates each sample's contribution in range [0, 1]
  65943. */
  65944. decay: number;
  65945. /**
  65946. * Controls the overall intensity of each sample
  65947. */
  65948. weight: number;
  65949. /**
  65950. * Controls the density of each sample
  65951. */
  65952. density: number;
  65953. /**
  65954. * @constructor
  65955. * @param name The post-process name
  65956. * @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)
  65957. * @param camera The camera that the post-process will be attached to
  65958. * @param mesh The mesh used to create the light scattering
  65959. * @param samples The post-process quality, default 100
  65960. * @param samplingModeThe post-process filtering mode
  65961. * @param engine The babylon engine
  65962. * @param reusable If the post-process is reusable
  65963. * @param scene The constructor needs a scene reference to initialize internal components. If "camera" is null a "scene" must be provided
  65964. */
  65965. constructor(name: string, ratio: any, camera: Camera, mesh?: Mesh, samples?: number, samplingMode?: number, engine?: Engine, reusable?: boolean, scene?: Scene);
  65966. /**
  65967. * Returns the string "VolumetricLightScatteringPostProcess"
  65968. * @returns "VolumetricLightScatteringPostProcess"
  65969. */
  65970. getClassName(): string;
  65971. private _isReady;
  65972. /**
  65973. * Sets the new light position for light scattering effect
  65974. * @param position The new custom light position
  65975. */
  65976. setCustomMeshPosition(position: Vector3): void;
  65977. /**
  65978. * Returns the light position for light scattering effect
  65979. * @return Vector3 The custom light position
  65980. */
  65981. getCustomMeshPosition(): Vector3;
  65982. /**
  65983. * Disposes the internal assets and detaches the post-process from the camera
  65984. */
  65985. dispose(camera: Camera): void;
  65986. /**
  65987. * Returns the render target texture used by the post-process
  65988. * @return the render target texture used by the post-process
  65989. */
  65990. getPass(): RenderTargetTexture;
  65991. private _meshExcluded;
  65992. private _createPass;
  65993. private _updateMeshScreenCoordinates;
  65994. /**
  65995. * Creates a default mesh for the Volumeric Light Scattering post-process
  65996. * @param name The mesh name
  65997. * @param scene The scene where to create the mesh
  65998. * @return the default mesh
  65999. */
  66000. static CreateDefaultMesh(name: string, scene: Scene): Mesh;
  66001. }
  66002. }
  66003. declare module "babylonjs/PostProcesses/index" {
  66004. export * from "babylonjs/PostProcesses/anaglyphPostProcess";
  66005. export * from "babylonjs/PostProcesses/blackAndWhitePostProcess";
  66006. export * from "babylonjs/PostProcesses/bloomEffect";
  66007. export * from "babylonjs/PostProcesses/bloomMergePostProcess";
  66008. export * from "babylonjs/PostProcesses/blurPostProcess";
  66009. export * from "babylonjs/PostProcesses/chromaticAberrationPostProcess";
  66010. export * from "babylonjs/PostProcesses/circleOfConfusionPostProcess";
  66011. export * from "babylonjs/PostProcesses/colorCorrectionPostProcess";
  66012. export * from "babylonjs/PostProcesses/convolutionPostProcess";
  66013. export * from "babylonjs/PostProcesses/depthOfFieldBlurPostProcess";
  66014. export * from "babylonjs/PostProcesses/depthOfFieldEffect";
  66015. export * from "babylonjs/PostProcesses/depthOfFieldMergePostProcess";
  66016. export * from "babylonjs/PostProcesses/displayPassPostProcess";
  66017. export * from "babylonjs/PostProcesses/extractHighlightsPostProcess";
  66018. export * from "babylonjs/PostProcesses/filterPostProcess";
  66019. export * from "babylonjs/PostProcesses/fxaaPostProcess";
  66020. export * from "babylonjs/PostProcesses/grainPostProcess";
  66021. export * from "babylonjs/PostProcesses/highlightsPostProcess";
  66022. export * from "babylonjs/PostProcesses/imageProcessingPostProcess";
  66023. export * from "babylonjs/PostProcesses/motionBlurPostProcess";
  66024. export * from "babylonjs/PostProcesses/passPostProcess";
  66025. export * from "babylonjs/PostProcesses/postProcess";
  66026. export * from "babylonjs/PostProcesses/postProcessManager";
  66027. export * from "babylonjs/PostProcesses/refractionPostProcess";
  66028. export * from "babylonjs/PostProcesses/RenderPipeline/index";
  66029. export * from "babylonjs/PostProcesses/sharpenPostProcess";
  66030. export * from "babylonjs/PostProcesses/stereoscopicInterlacePostProcess";
  66031. export * from "babylonjs/PostProcesses/tonemapPostProcess";
  66032. export * from "babylonjs/PostProcesses/volumetricLightScatteringPostProcess";
  66033. export * from "babylonjs/PostProcesses/vrDistortionCorrectionPostProcess";
  66034. export * from "babylonjs/PostProcesses/vrMultiviewToSingleviewPostProcess";
  66035. }
  66036. declare module "babylonjs/Probes/index" {
  66037. export * from "babylonjs/Probes/reflectionProbe";
  66038. }
  66039. declare module "babylonjs/Rendering/boundingBoxRenderer" {
  66040. import { Scene } from "babylonjs/scene";
  66041. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  66042. import { SmartArray } from "babylonjs/Misc/smartArray";
  66043. import { ISceneComponent } from "babylonjs/sceneComponent";
  66044. import { BoundingBox } from "babylonjs/Culling/boundingBox";
  66045. import "babylonjs/Meshes/Builders/boxBuilder";
  66046. import "babylonjs/Shaders/color.fragment";
  66047. import "babylonjs/Shaders/color.vertex";
  66048. import { Color3 } from "babylonjs/Maths/math.color";
  66049. module "babylonjs/scene" {
  66050. interface Scene {
  66051. /** @hidden (Backing field) */
  66052. _boundingBoxRenderer: BoundingBoxRenderer;
  66053. /** @hidden (Backing field) */
  66054. _forceShowBoundingBoxes: boolean;
  66055. /**
  66056. * Gets or sets a boolean indicating if all bounding boxes must be rendered
  66057. */
  66058. forceShowBoundingBoxes: boolean;
  66059. /**
  66060. * Gets the bounding box renderer associated with the scene
  66061. * @returns a BoundingBoxRenderer
  66062. */
  66063. getBoundingBoxRenderer(): BoundingBoxRenderer;
  66064. }
  66065. }
  66066. module "babylonjs/Meshes/abstractMesh" {
  66067. interface AbstractMesh {
  66068. /** @hidden (Backing field) */
  66069. _showBoundingBox: boolean;
  66070. /**
  66071. * Gets or sets a boolean indicating if the bounding box must be rendered as well (false by default)
  66072. */
  66073. showBoundingBox: boolean;
  66074. }
  66075. }
  66076. /**
  66077. * Component responsible of rendering the bounding box of the meshes in a scene.
  66078. * This is usually used through the mesh.showBoundingBox or the scene.forceShowBoundingBoxes properties
  66079. */
  66080. export class BoundingBoxRenderer implements ISceneComponent {
  66081. /**
  66082. * The component name helpfull to identify the component in the list of scene components.
  66083. */
  66084. readonly name: string;
  66085. /**
  66086. * The scene the component belongs to.
  66087. */
  66088. scene: Scene;
  66089. /**
  66090. * Color of the bounding box lines placed in front of an object
  66091. */
  66092. frontColor: Color3;
  66093. /**
  66094. * Color of the bounding box lines placed behind an object
  66095. */
  66096. backColor: Color3;
  66097. /**
  66098. * Defines if the renderer should show the back lines or not
  66099. */
  66100. showBackLines: boolean;
  66101. /**
  66102. * @hidden
  66103. */
  66104. renderList: SmartArray<BoundingBox>;
  66105. private _colorShader;
  66106. private _vertexBuffers;
  66107. private _indexBuffer;
  66108. private _fillIndexBuffer;
  66109. private _fillIndexData;
  66110. /**
  66111. * Instantiates a new bounding box renderer in a scene.
  66112. * @param scene the scene the renderer renders in
  66113. */
  66114. constructor(scene: Scene);
  66115. /**
  66116. * Registers the component in a given scene
  66117. */
  66118. register(): void;
  66119. private _evaluateSubMesh;
  66120. private _activeMesh;
  66121. private _prepareRessources;
  66122. private _createIndexBuffer;
  66123. /**
  66124. * Rebuilds the elements related to this component in case of
  66125. * context lost for instance.
  66126. */
  66127. rebuild(): void;
  66128. /**
  66129. * @hidden
  66130. */
  66131. reset(): void;
  66132. /**
  66133. * Render the bounding boxes of a specific rendering group
  66134. * @param renderingGroupId defines the rendering group to render
  66135. */
  66136. render(renderingGroupId: number): void;
  66137. /**
  66138. * In case of occlusion queries, we can render the occlusion bounding box through this method
  66139. * @param mesh Define the mesh to render the occlusion bounding box for
  66140. */
  66141. renderOcclusionBoundingBox(mesh: AbstractMesh): void;
  66142. /**
  66143. * Dispose and release the resources attached to this renderer.
  66144. */
  66145. dispose(): void;
  66146. }
  66147. }
  66148. declare module "babylonjs/Shaders/depth.fragment" {
  66149. import "babylonjs/Shaders/ShadersInclude/packingFunctions";
  66150. /** @hidden */
  66151. export var depthPixelShader: {
  66152. name: string;
  66153. shader: string;
  66154. };
  66155. }
  66156. declare module "babylonjs/Rendering/depthRenderer" {
  66157. import { Nullable } from "babylonjs/types";
  66158. import { SubMesh } from "babylonjs/Meshes/subMesh";
  66159. import { Scene } from "babylonjs/scene";
  66160. import { RenderTargetTexture } from "babylonjs/Materials/Textures/renderTargetTexture";
  66161. import { Camera } from "babylonjs/Cameras/camera";
  66162. import "babylonjs/Shaders/depth.fragment";
  66163. import "babylonjs/Shaders/depth.vertex";
  66164. /**
  66165. * This represents a depth renderer in Babylon.
  66166. * A depth renderer will render to it's depth map every frame which can be displayed or used in post processing
  66167. */
  66168. export class DepthRenderer {
  66169. private _scene;
  66170. private _depthMap;
  66171. private _effect;
  66172. private readonly _storeNonLinearDepth;
  66173. private readonly _clearColor;
  66174. /** Get if the depth renderer is using packed depth or not */
  66175. readonly isPacked: boolean;
  66176. private _cachedDefines;
  66177. private _camera;
  66178. /**
  66179. * Specifiess that the depth renderer will only be used within
  66180. * the camera it is created for.
  66181. * This can help forcing its rendering during the camera processing.
  66182. */
  66183. useOnlyInActiveCamera: boolean;
  66184. /** @hidden */
  66185. static _SceneComponentInitialization: (scene: Scene) => void;
  66186. /**
  66187. * Instantiates a depth renderer
  66188. * @param scene The scene the renderer belongs to
  66189. * @param type The texture type of the depth map (default: Engine.TEXTURETYPE_FLOAT)
  66190. * @param camera The camera to be used to render the depth map (default: scene's active camera)
  66191. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  66192. */
  66193. constructor(scene: Scene, type?: number, camera?: Nullable<Camera>, storeNonLinearDepth?: boolean);
  66194. /**
  66195. * Creates the depth rendering effect and checks if the effect is ready.
  66196. * @param subMesh The submesh to be used to render the depth map of
  66197. * @param useInstances If multiple world instances should be used
  66198. * @returns if the depth renderer is ready to render the depth map
  66199. */
  66200. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  66201. /**
  66202. * Gets the texture which the depth map will be written to.
  66203. * @returns The depth map texture
  66204. */
  66205. getDepthMap(): RenderTargetTexture;
  66206. /**
  66207. * Disposes of the depth renderer.
  66208. */
  66209. dispose(): void;
  66210. }
  66211. }
  66212. declare module "babylonjs/Rendering/depthRendererSceneComponent" {
  66213. import { Nullable } from "babylonjs/types";
  66214. import { Scene } from "babylonjs/scene";
  66215. import { DepthRenderer } from "babylonjs/Rendering/depthRenderer";
  66216. import { Camera } from "babylonjs/Cameras/camera";
  66217. import { ISceneComponent } from "babylonjs/sceneComponent";
  66218. module "babylonjs/scene" {
  66219. interface Scene {
  66220. /** @hidden (Backing field) */
  66221. _depthRenderer: {
  66222. [id: string]: DepthRenderer;
  66223. };
  66224. /**
  66225. * Creates a depth renderer a given camera which contains a depth map which can be used for post processing.
  66226. * @param camera The camera to create the depth renderer on (default: scene's active camera)
  66227. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  66228. * @returns the created depth renderer
  66229. */
  66230. enableDepthRenderer(camera?: Nullable<Camera>, storeNonLinearDepth?: boolean): DepthRenderer;
  66231. /**
  66232. * Disables a depth renderer for a given camera
  66233. * @param camera The camera to disable the depth renderer on (default: scene's active camera)
  66234. */
  66235. disableDepthRenderer(camera?: Nullable<Camera>): void;
  66236. }
  66237. }
  66238. /**
  66239. * Defines the Depth Renderer scene component responsible to manage a depth buffer useful
  66240. * in several rendering techniques.
  66241. */
  66242. export class DepthRendererSceneComponent implements ISceneComponent {
  66243. /**
  66244. * The component name helpfull to identify the component in the list of scene components.
  66245. */
  66246. readonly name: string;
  66247. /**
  66248. * The scene the component belongs to.
  66249. */
  66250. scene: Scene;
  66251. /**
  66252. * Creates a new instance of the component for the given scene
  66253. * @param scene Defines the scene to register the component in
  66254. */
  66255. constructor(scene: Scene);
  66256. /**
  66257. * Registers the component in a given scene
  66258. */
  66259. register(): void;
  66260. /**
  66261. * Rebuilds the elements related to this component in case of
  66262. * context lost for instance.
  66263. */
  66264. rebuild(): void;
  66265. /**
  66266. * Disposes the component and the associated ressources
  66267. */
  66268. dispose(): void;
  66269. private _gatherRenderTargets;
  66270. private _gatherActiveCameraRenderTargets;
  66271. }
  66272. }
  66273. declare module "babylonjs/Shaders/outline.fragment" {
  66274. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  66275. import "babylonjs/Shaders/ShadersInclude/logDepthFragment";
  66276. /** @hidden */
  66277. export var outlinePixelShader: {
  66278. name: string;
  66279. shader: string;
  66280. };
  66281. }
  66282. declare module "babylonjs/Shaders/outline.vertex" {
  66283. import "babylonjs/Shaders/ShadersInclude/bonesDeclaration";
  66284. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexGlobalDeclaration";
  66285. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertexDeclaration";
  66286. import "babylonjs/Shaders/ShadersInclude/instancesDeclaration";
  66287. import "babylonjs/Shaders/ShadersInclude/logDepthDeclaration";
  66288. import "babylonjs/Shaders/ShadersInclude/morphTargetsVertex";
  66289. import "babylonjs/Shaders/ShadersInclude/instancesVertex";
  66290. import "babylonjs/Shaders/ShadersInclude/bonesVertex";
  66291. import "babylonjs/Shaders/ShadersInclude/logDepthVertex";
  66292. /** @hidden */
  66293. export var outlineVertexShader: {
  66294. name: string;
  66295. shader: string;
  66296. };
  66297. }
  66298. declare module "babylonjs/Rendering/outlineRenderer" {
  66299. import { SubMesh } from "babylonjs/Meshes/subMesh";
  66300. import { _InstancesBatch } from "babylonjs/Meshes/mesh";
  66301. import { Scene } from "babylonjs/scene";
  66302. import { ISceneComponent } from "babylonjs/sceneComponent";
  66303. import "babylonjs/Shaders/outline.fragment";
  66304. import "babylonjs/Shaders/outline.vertex";
  66305. module "babylonjs/scene" {
  66306. interface Scene {
  66307. /** @hidden */
  66308. _outlineRenderer: OutlineRenderer;
  66309. /**
  66310. * Gets the outline renderer associated with the scene
  66311. * @returns a OutlineRenderer
  66312. */
  66313. getOutlineRenderer(): OutlineRenderer;
  66314. }
  66315. }
  66316. module "babylonjs/Meshes/abstractMesh" {
  66317. interface AbstractMesh {
  66318. /** @hidden (Backing field) */
  66319. _renderOutline: boolean;
  66320. /**
  66321. * Gets or sets a boolean indicating if the outline must be rendered as well
  66322. * @see https://www.babylonjs-playground.com/#10WJ5S#3
  66323. */
  66324. renderOutline: boolean;
  66325. /** @hidden (Backing field) */
  66326. _renderOverlay: boolean;
  66327. /**
  66328. * Gets or sets a boolean indicating if the overlay must be rendered as well
  66329. * @see https://www.babylonjs-playground.com/#10WJ5S#2
  66330. */
  66331. renderOverlay: boolean;
  66332. }
  66333. }
  66334. /**
  66335. * This class is responsible to draw bothe outline/overlay of meshes.
  66336. * It should not be used directly but through the available method on mesh.
  66337. */
  66338. export class OutlineRenderer implements ISceneComponent {
  66339. /**
  66340. * Stencil value used to avoid outline being seen within the mesh when the mesh is transparent
  66341. */
  66342. private static _StencilReference;
  66343. /**
  66344. * The name of the component. Each component must have a unique name.
  66345. */
  66346. name: string;
  66347. /**
  66348. * The scene the component belongs to.
  66349. */
  66350. scene: Scene;
  66351. /**
  66352. * Defines a zOffset to prevent zFighting between the overlay and the mesh.
  66353. */
  66354. zOffset: number;
  66355. private _engine;
  66356. private _effect;
  66357. private _cachedDefines;
  66358. private _savedDepthWrite;
  66359. /**
  66360. * Instantiates a new outline renderer. (There could be only one per scene).
  66361. * @param scene Defines the scene it belongs to
  66362. */
  66363. constructor(scene: Scene);
  66364. /**
  66365. * Register the component to one instance of a scene.
  66366. */
  66367. register(): void;
  66368. /**
  66369. * Rebuilds the elements related to this component in case of
  66370. * context lost for instance.
  66371. */
  66372. rebuild(): void;
  66373. /**
  66374. * Disposes the component and the associated ressources.
  66375. */
  66376. dispose(): void;
  66377. /**
  66378. * Renders the outline in the canvas.
  66379. * @param subMesh Defines the sumesh to render
  66380. * @param batch Defines the batch of meshes in case of instances
  66381. * @param useOverlay Defines if the rendering is for the overlay or the outline
  66382. */
  66383. render(subMesh: SubMesh, batch: _InstancesBatch, useOverlay?: boolean): void;
  66384. /**
  66385. * Returns whether or not the outline renderer is ready for a given submesh.
  66386. * All the dependencies e.g. submeshes, texture, effect... mus be ready
  66387. * @param subMesh Defines the submesh to check readyness for
  66388. * @param useInstances Defines wheter wee are trying to render instances or not
  66389. * @returns true if ready otherwise false
  66390. */
  66391. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  66392. private _beforeRenderingMesh;
  66393. private _afterRenderingMesh;
  66394. }
  66395. }
  66396. declare module "babylonjs/Rendering/index" {
  66397. export * from "babylonjs/Rendering/boundingBoxRenderer";
  66398. export * from "babylonjs/Rendering/depthRenderer";
  66399. export * from "babylonjs/Rendering/depthRendererSceneComponent";
  66400. export * from "babylonjs/Rendering/edgesRenderer";
  66401. export * from "babylonjs/Rendering/geometryBufferRenderer";
  66402. export * from "babylonjs/Rendering/geometryBufferRendererSceneComponent";
  66403. export * from "babylonjs/Rendering/outlineRenderer";
  66404. export * from "babylonjs/Rendering/renderingGroup";
  66405. export * from "babylonjs/Rendering/renderingManager";
  66406. export * from "babylonjs/Rendering/utilityLayerRenderer";
  66407. }
  66408. declare module "babylonjs/Sprites/spritePackedManager" {
  66409. import { SpriteManager } from "babylonjs/Sprites/spriteManager";
  66410. import { Scene } from "babylonjs/scene";
  66411. /**
  66412. * Class used to manage multiple sprites of different sizes on the same spritesheet
  66413. * @see http://doc.babylonjs.com/babylon101/sprites
  66414. */
  66415. export class SpritePackedManager extends SpriteManager {
  66416. /** defines the packed manager's name */
  66417. name: string;
  66418. /**
  66419. * Creates a new sprite manager from a packed sprite sheet
  66420. * @param name defines the manager's name
  66421. * @param imgUrl defines the sprite sheet url
  66422. * @param capacity defines the maximum allowed number of sprites
  66423. * @param scene defines the hosting scene
  66424. * @param spriteJSON null otherwise a JSON object defining sprite sheet data
  66425. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  66426. * @param samplingMode defines the smapling mode to use with spritesheet
  66427. * @param fromPacked set to true; do not alter
  66428. */
  66429. constructor(
  66430. /** defines the packed manager's name */
  66431. name: string, imgUrl: string, capacity: number, scene: Scene, spriteJSON?: string | null, epsilon?: number, samplingMode?: number);
  66432. }
  66433. }
  66434. declare module "babylonjs/Sprites/index" {
  66435. export * from "babylonjs/Sprites/sprite";
  66436. export * from "babylonjs/Sprites/spriteManager";
  66437. export * from "babylonjs/Sprites/spritePackedManager";
  66438. export * from "babylonjs/Sprites/spriteSceneComponent";
  66439. }
  66440. declare module "babylonjs/States/index" {
  66441. export * from "babylonjs/States/alphaCullingState";
  66442. export * from "babylonjs/States/depthCullingState";
  66443. export * from "babylonjs/States/stencilState";
  66444. }
  66445. declare module "babylonjs/Misc/assetsManager" {
  66446. import { Scene } from "babylonjs/scene";
  66447. import { AbstractMesh } from "babylonjs/Meshes/abstractMesh";
  66448. import { IParticleSystem } from "babylonjs/Particles/IParticleSystem";
  66449. import { Skeleton } from "babylonjs/Bones/skeleton";
  66450. import { Observable } from "babylonjs/Misc/observable";
  66451. import { BaseTexture } from "babylonjs/Materials/Textures/baseTexture";
  66452. import { Texture } from "babylonjs/Materials/Textures/texture";
  66453. import { CubeTexture } from "babylonjs/Materials/Textures/cubeTexture";
  66454. import { HDRCubeTexture } from "babylonjs/Materials/Textures/hdrCubeTexture";
  66455. import { EquiRectangularCubeTexture } from "babylonjs/Materials/Textures/equiRectangularCubeTexture";
  66456. import { AnimationGroup } from "babylonjs/Animations/animationGroup";
  66457. /**
  66458. * Defines the list of states available for a task inside a AssetsManager
  66459. */
  66460. export enum AssetTaskState {
  66461. /**
  66462. * Initialization
  66463. */
  66464. INIT = 0,
  66465. /**
  66466. * Running
  66467. */
  66468. RUNNING = 1,
  66469. /**
  66470. * Done
  66471. */
  66472. DONE = 2,
  66473. /**
  66474. * Error
  66475. */
  66476. ERROR = 3
  66477. }
  66478. /**
  66479. * Define an abstract asset task used with a AssetsManager class to load assets into a scene
  66480. */
  66481. export abstract class AbstractAssetTask {
  66482. /**
  66483. * Task name
  66484. */ name: string;
  66485. /**
  66486. * Callback called when the task is successful
  66487. */
  66488. onSuccess: (task: any) => void;
  66489. /**
  66490. * Callback called when the task is not successful
  66491. */
  66492. onError: (task: any, message?: string, exception?: any) => void;
  66493. /**
  66494. * Creates a new AssetsManager
  66495. * @param name defines the name of the task
  66496. */
  66497. constructor(
  66498. /**
  66499. * Task name
  66500. */ name: string);
  66501. private _isCompleted;
  66502. private _taskState;
  66503. private _errorObject;
  66504. /**
  66505. * Get if the task is completed
  66506. */
  66507. readonly isCompleted: boolean;
  66508. /**
  66509. * Gets the current state of the task
  66510. */
  66511. readonly taskState: AssetTaskState;
  66512. /**
  66513. * Gets the current error object (if task is in error)
  66514. */
  66515. readonly errorObject: {
  66516. message?: string;
  66517. exception?: any;
  66518. };
  66519. /**
  66520. * Internal only
  66521. * @hidden
  66522. */
  66523. _setErrorObject(message?: string, exception?: any): void;
  66524. /**
  66525. * Execute the current task
  66526. * @param scene defines the scene where you want your assets to be loaded
  66527. * @param onSuccess is a callback called when the task is successfully executed
  66528. * @param onError is a callback called if an error occurs
  66529. */
  66530. run(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  66531. /**
  66532. * Execute the current task
  66533. * @param scene defines the scene where you want your assets to be loaded
  66534. * @param onSuccess is a callback called when the task is successfully executed
  66535. * @param onError is a callback called if an error occurs
  66536. */
  66537. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  66538. /**
  66539. * Reset will set the task state back to INIT, so the next load call of the assets manager will execute this task again.
  66540. * This can be used with failed tasks that have the reason for failure fixed.
  66541. */
  66542. reset(): void;
  66543. private onErrorCallback;
  66544. private onDoneCallback;
  66545. }
  66546. /**
  66547. * Define the interface used by progress events raised during assets loading
  66548. */
  66549. export interface IAssetsProgressEvent {
  66550. /**
  66551. * Defines the number of remaining tasks to process
  66552. */
  66553. remainingCount: number;
  66554. /**
  66555. * Defines the total number of tasks
  66556. */
  66557. totalCount: number;
  66558. /**
  66559. * Defines the task that was just processed
  66560. */
  66561. task: AbstractAssetTask;
  66562. }
  66563. /**
  66564. * Class used to share progress information about assets loading
  66565. */
  66566. export class AssetsProgressEvent implements IAssetsProgressEvent {
  66567. /**
  66568. * Defines the number of remaining tasks to process
  66569. */
  66570. remainingCount: number;
  66571. /**
  66572. * Defines the total number of tasks
  66573. */
  66574. totalCount: number;
  66575. /**
  66576. * Defines the task that was just processed
  66577. */
  66578. task: AbstractAssetTask;
  66579. /**
  66580. * Creates a AssetsProgressEvent
  66581. * @param remainingCount defines the number of remaining tasks to process
  66582. * @param totalCount defines the total number of tasks
  66583. * @param task defines the task that was just processed
  66584. */
  66585. constructor(remainingCount: number, totalCount: number, task: AbstractAssetTask);
  66586. }
  66587. /**
  66588. * Define a task used by AssetsManager to load meshes
  66589. */
  66590. export class MeshAssetTask extends AbstractAssetTask {
  66591. /**
  66592. * Defines the name of the task
  66593. */
  66594. name: string;
  66595. /**
  66596. * Defines the list of mesh's names you want to load
  66597. */
  66598. meshesNames: any;
  66599. /**
  66600. * Defines the root url to use as a base to load your meshes and associated resources
  66601. */
  66602. rootUrl: string;
  66603. /**
  66604. * Defines the filename of the scene to load from
  66605. */
  66606. sceneFilename: string;
  66607. /**
  66608. * Gets the list of loaded meshes
  66609. */
  66610. loadedMeshes: Array<AbstractMesh>;
  66611. /**
  66612. * Gets the list of loaded particle systems
  66613. */
  66614. loadedParticleSystems: Array<IParticleSystem>;
  66615. /**
  66616. * Gets the list of loaded skeletons
  66617. */
  66618. loadedSkeletons: Array<Skeleton>;
  66619. /**
  66620. * Gets the list of loaded animation groups
  66621. */
  66622. loadedAnimationGroups: Array<AnimationGroup>;
  66623. /**
  66624. * Callback called when the task is successful
  66625. */
  66626. onSuccess: (task: MeshAssetTask) => void;
  66627. /**
  66628. * Callback called when the task is successful
  66629. */
  66630. onError: (task: MeshAssetTask, message?: string, exception?: any) => void;
  66631. /**
  66632. * Creates a new MeshAssetTask
  66633. * @param name defines the name of the task
  66634. * @param meshesNames defines the list of mesh's names you want to load
  66635. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  66636. * @param sceneFilename defines the filename of the scene to load from
  66637. */
  66638. constructor(
  66639. /**
  66640. * Defines the name of the task
  66641. */
  66642. name: string,
  66643. /**
  66644. * Defines the list of mesh's names you want to load
  66645. */
  66646. meshesNames: any,
  66647. /**
  66648. * Defines the root url to use as a base to load your meshes and associated resources
  66649. */
  66650. rootUrl: string,
  66651. /**
  66652. * Defines the filename of the scene to load from
  66653. */
  66654. sceneFilename: string);
  66655. /**
  66656. * Execute the current task
  66657. * @param scene defines the scene where you want your assets to be loaded
  66658. * @param onSuccess is a callback called when the task is successfully executed
  66659. * @param onError is a callback called if an error occurs
  66660. */
  66661. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  66662. }
  66663. /**
  66664. * Define a task used by AssetsManager to load text content
  66665. */
  66666. export class TextFileAssetTask extends AbstractAssetTask {
  66667. /**
  66668. * Defines the name of the task
  66669. */
  66670. name: string;
  66671. /**
  66672. * Defines the location of the file to load
  66673. */
  66674. url: string;
  66675. /**
  66676. * Gets the loaded text string
  66677. */
  66678. text: string;
  66679. /**
  66680. * Callback called when the task is successful
  66681. */
  66682. onSuccess: (task: TextFileAssetTask) => void;
  66683. /**
  66684. * Callback called when the task is successful
  66685. */
  66686. onError: (task: TextFileAssetTask, message?: string, exception?: any) => void;
  66687. /**
  66688. * Creates a new TextFileAssetTask object
  66689. * @param name defines the name of the task
  66690. * @param url defines the location of the file to load
  66691. */
  66692. constructor(
  66693. /**
  66694. * Defines the name of the task
  66695. */
  66696. name: string,
  66697. /**
  66698. * Defines the location of the file to load
  66699. */
  66700. url: string);
  66701. /**
  66702. * Execute the current task
  66703. * @param scene defines the scene where you want your assets to be loaded
  66704. * @param onSuccess is a callback called when the task is successfully executed
  66705. * @param onError is a callback called if an error occurs
  66706. */
  66707. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  66708. }
  66709. /**
  66710. * Define a task used by AssetsManager to load binary data
  66711. */
  66712. export class BinaryFileAssetTask extends AbstractAssetTask {
  66713. /**
  66714. * Defines the name of the task
  66715. */
  66716. name: string;
  66717. /**
  66718. * Defines the location of the file to load
  66719. */
  66720. url: string;
  66721. /**
  66722. * Gets the lodaded data (as an array buffer)
  66723. */
  66724. data: ArrayBuffer;
  66725. /**
  66726. * Callback called when the task is successful
  66727. */
  66728. onSuccess: (task: BinaryFileAssetTask) => void;
  66729. /**
  66730. * Callback called when the task is successful
  66731. */
  66732. onError: (task: BinaryFileAssetTask, message?: string, exception?: any) => void;
  66733. /**
  66734. * Creates a new BinaryFileAssetTask object
  66735. * @param name defines the name of the new task
  66736. * @param url defines the location of the file to load
  66737. */
  66738. constructor(
  66739. /**
  66740. * Defines the name of the task
  66741. */
  66742. name: string,
  66743. /**
  66744. * Defines the location of the file to load
  66745. */
  66746. url: string);
  66747. /**
  66748. * Execute the current task
  66749. * @param scene defines the scene where you want your assets to be loaded
  66750. * @param onSuccess is a callback called when the task is successfully executed
  66751. * @param onError is a callback called if an error occurs
  66752. */
  66753. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  66754. }
  66755. /**
  66756. * Define a task used by AssetsManager to load images
  66757. */
  66758. export class ImageAssetTask extends AbstractAssetTask {
  66759. /**
  66760. * Defines the name of the task
  66761. */
  66762. name: string;
  66763. /**
  66764. * Defines the location of the image to load
  66765. */
  66766. url: string;
  66767. /**
  66768. * Gets the loaded images
  66769. */
  66770. image: HTMLImageElement;
  66771. /**
  66772. * Callback called when the task is successful
  66773. */
  66774. onSuccess: (task: ImageAssetTask) => void;
  66775. /**
  66776. * Callback called when the task is successful
  66777. */
  66778. onError: (task: ImageAssetTask, message?: string, exception?: any) => void;
  66779. /**
  66780. * Creates a new ImageAssetTask
  66781. * @param name defines the name of the task
  66782. * @param url defines the location of the image to load
  66783. */
  66784. constructor(
  66785. /**
  66786. * Defines the name of the task
  66787. */
  66788. name: string,
  66789. /**
  66790. * Defines the location of the image to load
  66791. */
  66792. url: string);
  66793. /**
  66794. * Execute the current task
  66795. * @param scene defines the scene where you want your assets to be loaded
  66796. * @param onSuccess is a callback called when the task is successfully executed
  66797. * @param onError is a callback called if an error occurs
  66798. */
  66799. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  66800. }
  66801. /**
  66802. * Defines the interface used by texture loading tasks
  66803. */
  66804. export interface ITextureAssetTask<TEX extends BaseTexture> {
  66805. /**
  66806. * Gets the loaded texture
  66807. */
  66808. texture: TEX;
  66809. }
  66810. /**
  66811. * Define a task used by AssetsManager to load 2D textures
  66812. */
  66813. export class TextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<Texture> {
  66814. /**
  66815. * Defines the name of the task
  66816. */
  66817. name: string;
  66818. /**
  66819. * Defines the location of the file to load
  66820. */
  66821. url: string;
  66822. /**
  66823. * Defines if mipmap should not be generated (default is false)
  66824. */
  66825. noMipmap?: boolean | undefined;
  66826. /**
  66827. * Defines if texture must be inverted on Y axis (default is false)
  66828. */
  66829. invertY?: boolean | undefined;
  66830. /**
  66831. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  66832. */
  66833. samplingMode: number;
  66834. /**
  66835. * Gets the loaded texture
  66836. */
  66837. texture: Texture;
  66838. /**
  66839. * Callback called when the task is successful
  66840. */
  66841. onSuccess: (task: TextureAssetTask) => void;
  66842. /**
  66843. * Callback called when the task is successful
  66844. */
  66845. onError: (task: TextureAssetTask, message?: string, exception?: any) => void;
  66846. /**
  66847. * Creates a new TextureAssetTask object
  66848. * @param name defines the name of the task
  66849. * @param url defines the location of the file to load
  66850. * @param noMipmap defines if mipmap should not be generated (default is false)
  66851. * @param invertY defines if texture must be inverted on Y axis (default is false)
  66852. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  66853. */
  66854. constructor(
  66855. /**
  66856. * Defines the name of the task
  66857. */
  66858. name: string,
  66859. /**
  66860. * Defines the location of the file to load
  66861. */
  66862. url: string,
  66863. /**
  66864. * Defines if mipmap should not be generated (default is false)
  66865. */
  66866. noMipmap?: boolean | undefined,
  66867. /**
  66868. * Defines if texture must be inverted on Y axis (default is false)
  66869. */
  66870. invertY?: boolean | undefined,
  66871. /**
  66872. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  66873. */
  66874. samplingMode?: number);
  66875. /**
  66876. * Execute the current task
  66877. * @param scene defines the scene where you want your assets to be loaded
  66878. * @param onSuccess is a callback called when the task is successfully executed
  66879. * @param onError is a callback called if an error occurs
  66880. */
  66881. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  66882. }
  66883. /**
  66884. * Define a task used by AssetsManager to load cube textures
  66885. */
  66886. export class CubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<CubeTexture> {
  66887. /**
  66888. * Defines the name of the task
  66889. */
  66890. name: string;
  66891. /**
  66892. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  66893. */
  66894. url: string;
  66895. /**
  66896. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  66897. */
  66898. extensions?: string[] | undefined;
  66899. /**
  66900. * Defines if mipmaps should not be generated (default is false)
  66901. */
  66902. noMipmap?: boolean | undefined;
  66903. /**
  66904. * Defines the explicit list of files (undefined by default)
  66905. */
  66906. files?: string[] | undefined;
  66907. /**
  66908. * Gets the loaded texture
  66909. */
  66910. texture: CubeTexture;
  66911. /**
  66912. * Callback called when the task is successful
  66913. */
  66914. onSuccess: (task: CubeTextureAssetTask) => void;
  66915. /**
  66916. * Callback called when the task is successful
  66917. */
  66918. onError: (task: CubeTextureAssetTask, message?: string, exception?: any) => void;
  66919. /**
  66920. * Creates a new CubeTextureAssetTask
  66921. * @param name defines the name of the task
  66922. * @param url defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  66923. * @param extensions defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  66924. * @param noMipmap defines if mipmaps should not be generated (default is false)
  66925. * @param files defines the explicit list of files (undefined by default)
  66926. */
  66927. constructor(
  66928. /**
  66929. * Defines the name of the task
  66930. */
  66931. name: string,
  66932. /**
  66933. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  66934. */
  66935. url: string,
  66936. /**
  66937. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  66938. */
  66939. extensions?: string[] | undefined,
  66940. /**
  66941. * Defines if mipmaps should not be generated (default is false)
  66942. */
  66943. noMipmap?: boolean | undefined,
  66944. /**
  66945. * Defines the explicit list of files (undefined by default)
  66946. */
  66947. files?: string[] | undefined);
  66948. /**
  66949. * Execute the current task
  66950. * @param scene defines the scene where you want your assets to be loaded
  66951. * @param onSuccess is a callback called when the task is successfully executed
  66952. * @param onError is a callback called if an error occurs
  66953. */
  66954. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  66955. }
  66956. /**
  66957. * Define a task used by AssetsManager to load HDR cube textures
  66958. */
  66959. export class HDRCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<HDRCubeTexture> {
  66960. /**
  66961. * Defines the name of the task
  66962. */
  66963. name: string;
  66964. /**
  66965. * Defines the location of the file to load
  66966. */
  66967. url: string;
  66968. /**
  66969. * Defines the desired size (the more it increases the longer the generation will be)
  66970. */
  66971. size: number;
  66972. /**
  66973. * Defines if mipmaps should not be generated (default is false)
  66974. */
  66975. noMipmap: boolean;
  66976. /**
  66977. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  66978. */
  66979. generateHarmonics: boolean;
  66980. /**
  66981. * 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)
  66982. */
  66983. gammaSpace: boolean;
  66984. /**
  66985. * Internal Use Only
  66986. */
  66987. reserved: boolean;
  66988. /**
  66989. * Gets the loaded texture
  66990. */
  66991. texture: HDRCubeTexture;
  66992. /**
  66993. * Callback called when the task is successful
  66994. */
  66995. onSuccess: (task: HDRCubeTextureAssetTask) => void;
  66996. /**
  66997. * Callback called when the task is successful
  66998. */
  66999. onError: (task: HDRCubeTextureAssetTask, message?: string, exception?: any) => void;
  67000. /**
  67001. * Creates a new HDRCubeTextureAssetTask object
  67002. * @param name defines the name of the task
  67003. * @param url defines the location of the file to load
  67004. * @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.
  67005. * @param noMipmap defines if mipmaps should not be generated (default is false)
  67006. * @param generateHarmonics specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  67007. * @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)
  67008. * @param reserved Internal use only
  67009. */
  67010. constructor(
  67011. /**
  67012. * Defines the name of the task
  67013. */
  67014. name: string,
  67015. /**
  67016. * Defines the location of the file to load
  67017. */
  67018. url: string,
  67019. /**
  67020. * Defines the desired size (the more it increases the longer the generation will be)
  67021. */
  67022. size: number,
  67023. /**
  67024. * Defines if mipmaps should not be generated (default is false)
  67025. */
  67026. noMipmap?: boolean,
  67027. /**
  67028. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  67029. */
  67030. generateHarmonics?: boolean,
  67031. /**
  67032. * 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)
  67033. */
  67034. gammaSpace?: boolean,
  67035. /**
  67036. * Internal Use Only
  67037. */
  67038. reserved?: boolean);
  67039. /**
  67040. * Execute the current task
  67041. * @param scene defines the scene where you want your assets to be loaded
  67042. * @param onSuccess is a callback called when the task is successfully executed
  67043. * @param onError is a callback called if an error occurs
  67044. */
  67045. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  67046. }
  67047. /**
  67048. * Define a task used by AssetsManager to load Equirectangular cube textures
  67049. */
  67050. export class EquiRectangularCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<EquiRectangularCubeTexture> {
  67051. /**
  67052. * Defines the name of the task
  67053. */
  67054. name: string;
  67055. /**
  67056. * Defines the location of the file to load
  67057. */
  67058. url: string;
  67059. /**
  67060. * Defines the desired size (the more it increases the longer the generation will be)
  67061. */
  67062. size: number;
  67063. /**
  67064. * Defines if mipmaps should not be generated (default is false)
  67065. */
  67066. noMipmap: boolean;
  67067. /**
  67068. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  67069. * but the standard material would require them in Gamma space) (default is true)
  67070. */
  67071. gammaSpace: boolean;
  67072. /**
  67073. * Gets the loaded texture
  67074. */
  67075. texture: EquiRectangularCubeTexture;
  67076. /**
  67077. * Callback called when the task is successful
  67078. */
  67079. onSuccess: (task: EquiRectangularCubeTextureAssetTask) => void;
  67080. /**
  67081. * Callback called when the task is successful
  67082. */
  67083. onError: (task: EquiRectangularCubeTextureAssetTask, message?: string, exception?: any) => void;
  67084. /**
  67085. * Creates a new EquiRectangularCubeTextureAssetTask object
  67086. * @param name defines the name of the task
  67087. * @param url defines the location of the file to load
  67088. * @param size defines the desired size (the more it increases the longer the generation will be)
  67089. * If the size is omitted this implies you are using a preprocessed cubemap.
  67090. * @param noMipmap defines if mipmaps should not be generated (default is false)
  67091. * @param gammaSpace specifies if the texture will be used in gamma or linear space
  67092. * (the PBR material requires those texture in linear space, but the standard material would require them in Gamma space)
  67093. * (default is true)
  67094. */
  67095. constructor(
  67096. /**
  67097. * Defines the name of the task
  67098. */
  67099. name: string,
  67100. /**
  67101. * Defines the location of the file to load
  67102. */
  67103. url: string,
  67104. /**
  67105. * Defines the desired size (the more it increases the longer the generation will be)
  67106. */
  67107. size: number,
  67108. /**
  67109. * Defines if mipmaps should not be generated (default is false)
  67110. */
  67111. noMipmap?: boolean,
  67112. /**
  67113. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  67114. * but the standard material would require them in Gamma space) (default is true)
  67115. */
  67116. gammaSpace?: boolean);
  67117. /**
  67118. * Execute the current task
  67119. * @param scene defines the scene where you want your assets to be loaded
  67120. * @param onSuccess is a callback called when the task is successfully executed
  67121. * @param onError is a callback called if an error occurs
  67122. */
  67123. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  67124. }
  67125. /**
  67126. * This class can be used to easily import assets into a scene
  67127. * @see http://doc.babylonjs.com/how_to/how_to_use_assetsmanager
  67128. */
  67129. export class AssetsManager {
  67130. private _scene;
  67131. private _isLoading;
  67132. protected _tasks: AbstractAssetTask[];
  67133. protected _waitingTasksCount: number;
  67134. protected _totalTasksCount: number;
  67135. /**
  67136. * Callback called when all tasks are processed
  67137. */
  67138. onFinish: (tasks: AbstractAssetTask[]) => void;
  67139. /**
  67140. * Callback called when a task is successful
  67141. */
  67142. onTaskSuccess: (task: AbstractAssetTask) => void;
  67143. /**
  67144. * Callback called when a task had an error
  67145. */
  67146. onTaskError: (task: AbstractAssetTask) => void;
  67147. /**
  67148. * Callback called when a task is done (whatever the result is)
  67149. */
  67150. onProgress: (remainingCount: number, totalCount: number, task: AbstractAssetTask) => void;
  67151. /**
  67152. * Observable called when all tasks are processed
  67153. */
  67154. onTaskSuccessObservable: Observable<AbstractAssetTask>;
  67155. /**
  67156. * Observable called when a task had an error
  67157. */
  67158. onTaskErrorObservable: Observable<AbstractAssetTask>;
  67159. /**
  67160. * Observable called when all tasks were executed
  67161. */
  67162. onTasksDoneObservable: Observable<AbstractAssetTask[]>;
  67163. /**
  67164. * Observable called when a task is done (whatever the result is)
  67165. */
  67166. onProgressObservable: Observable<IAssetsProgressEvent>;
  67167. /**
  67168. * Gets or sets a boolean defining if the AssetsManager should use the default loading screen
  67169. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  67170. */
  67171. useDefaultLoadingScreen: boolean;
  67172. /**
  67173. * Gets or sets a boolean defining if the AssetsManager should automatically hide the loading screen
  67174. * when all assets have been downloaded.
  67175. * If set to false, you need to manually call in hideLoadingUI() once your scene is ready.
  67176. */
  67177. autoHideLoadingUI: boolean;
  67178. /**
  67179. * Creates a new AssetsManager
  67180. * @param scene defines the scene to work on
  67181. */
  67182. constructor(scene: Scene);
  67183. /**
  67184. * Add a MeshAssetTask to the list of active tasks
  67185. * @param taskName defines the name of the new task
  67186. * @param meshesNames defines the name of meshes to load
  67187. * @param rootUrl defines the root url to use to locate files
  67188. * @param sceneFilename defines the filename of the scene file
  67189. * @returns a new MeshAssetTask object
  67190. */
  67191. addMeshTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): MeshAssetTask;
  67192. /**
  67193. * Add a TextFileAssetTask to the list of active tasks
  67194. * @param taskName defines the name of the new task
  67195. * @param url defines the url of the file to load
  67196. * @returns a new TextFileAssetTask object
  67197. */
  67198. addTextFileTask(taskName: string, url: string): TextFileAssetTask;
  67199. /**
  67200. * Add a BinaryFileAssetTask to the list of active tasks
  67201. * @param taskName defines the name of the new task
  67202. * @param url defines the url of the file to load
  67203. * @returns a new BinaryFileAssetTask object
  67204. */
  67205. addBinaryFileTask(taskName: string, url: string): BinaryFileAssetTask;
  67206. /**
  67207. * Add a ImageAssetTask to the list of active tasks
  67208. * @param taskName defines the name of the new task
  67209. * @param url defines the url of the file to load
  67210. * @returns a new ImageAssetTask object
  67211. */
  67212. addImageTask(taskName: string, url: string): ImageAssetTask;
  67213. /**
  67214. * Add a TextureAssetTask to the list of active tasks
  67215. * @param taskName defines the name of the new task
  67216. * @param url defines the url of the file to load
  67217. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  67218. * @param invertY defines if you want to invert Y axis of the loaded texture (false by default)
  67219. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  67220. * @returns a new TextureAssetTask object
  67221. */
  67222. addTextureTask(taskName: string, url: string, noMipmap?: boolean, invertY?: boolean, samplingMode?: number): TextureAssetTask;
  67223. /**
  67224. * Add a CubeTextureAssetTask to the list of active tasks
  67225. * @param taskName defines the name of the new task
  67226. * @param url defines the url of the file to load
  67227. * @param extensions defines the extension to use to load the cube map (can be null)
  67228. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  67229. * @param files defines the list of files to load (can be null)
  67230. * @returns a new CubeTextureAssetTask object
  67231. */
  67232. addCubeTextureTask(taskName: string, url: string, extensions?: string[], noMipmap?: boolean, files?: string[]): CubeTextureAssetTask;
  67233. /**
  67234. *
  67235. * Add a HDRCubeTextureAssetTask to the list of active tasks
  67236. * @param taskName defines the name of the new task
  67237. * @param url defines the url of the file to load
  67238. * @param size defines the size you want for the cubemap (can be null)
  67239. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  67240. * @param generateHarmonics defines if you want to automatically generate (true by default)
  67241. * @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)
  67242. * @param reserved Internal use only
  67243. * @returns a new HDRCubeTextureAssetTask object
  67244. */
  67245. addHDRCubeTextureTask(taskName: string, url: string, size: number, noMipmap?: boolean, generateHarmonics?: boolean, gammaSpace?: boolean, reserved?: boolean): HDRCubeTextureAssetTask;
  67246. /**
  67247. *
  67248. * Add a EquiRectangularCubeTextureAssetTask to the list of active tasks
  67249. * @param taskName defines the name of the new task
  67250. * @param url defines the url of the file to load
  67251. * @param size defines the size you want for the cubemap (can be null)
  67252. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  67253. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  67254. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  67255. * @returns a new EquiRectangularCubeTextureAssetTask object
  67256. */
  67257. addEquiRectangularCubeTextureAssetTask(taskName: string, url: string, size: number, noMipmap?: boolean, gammaSpace?: boolean): EquiRectangularCubeTextureAssetTask;
  67258. /**
  67259. * Remove a task from the assets manager.
  67260. * @param task the task to remove
  67261. */
  67262. removeTask(task: AbstractAssetTask): void;
  67263. private _decreaseWaitingTasksCount;
  67264. private _runTask;
  67265. /**
  67266. * Reset the AssetsManager and remove all tasks
  67267. * @return the current instance of the AssetsManager
  67268. */
  67269. reset(): AssetsManager;
  67270. /**
  67271. * Start the loading process
  67272. * @return the current instance of the AssetsManager
  67273. */
  67274. load(): AssetsManager;
  67275. /**
  67276. * Start the loading process as an async operation
  67277. * @return a promise returning the list of failed tasks
  67278. */
  67279. loadAsync(): Promise<void>;
  67280. }
  67281. }
  67282. declare module "babylonjs/Misc/deferred" {
  67283. /**
  67284. * Wrapper class for promise with external resolve and reject.
  67285. */
  67286. export class Deferred<T> {
  67287. /**
  67288. * The promise associated with this deferred object.
  67289. */
  67290. readonly promise: Promise<T>;
  67291. private _resolve;
  67292. private _reject;
  67293. /**
  67294. * The resolve method of the promise associated with this deferred object.
  67295. */
  67296. readonly resolve: (value?: T | PromiseLike<T> | undefined) => void;
  67297. /**
  67298. * The reject method of the promise associated with this deferred object.
  67299. */
  67300. readonly reject: (reason?: any) => void;
  67301. /**
  67302. * Constructor for this deferred object.
  67303. */
  67304. constructor();
  67305. }
  67306. }
  67307. declare module "babylonjs/Misc/meshExploder" {
  67308. import { Mesh } from "babylonjs/Meshes/mesh";
  67309. /**
  67310. * Class used to explode meshes (ie. to have a center and move them away from that center to better see the overall organization)
  67311. */
  67312. export class MeshExploder {
  67313. private _centerMesh;
  67314. private _meshes;
  67315. private _meshesOrigins;
  67316. private _toCenterVectors;
  67317. private _scaledDirection;
  67318. private _newPosition;
  67319. private _centerPosition;
  67320. /**
  67321. * Explodes meshes from a center mesh.
  67322. * @param meshes The meshes to explode.
  67323. * @param centerMesh The mesh to be center of explosion.
  67324. */
  67325. constructor(meshes: Array<Mesh>, centerMesh?: Mesh);
  67326. private _setCenterMesh;
  67327. /**
  67328. * Get class name
  67329. * @returns "MeshExploder"
  67330. */
  67331. getClassName(): string;
  67332. /**
  67333. * "Exploded meshes"
  67334. * @returns Array of meshes with the centerMesh at index 0.
  67335. */
  67336. getMeshes(): Array<Mesh>;
  67337. /**
  67338. * Explodes meshes giving a specific direction
  67339. * @param direction Number to multiply distance of each mesh's origin from center. Use a negative number to implode, or zero to reset.
  67340. */
  67341. explode(direction?: number): void;
  67342. }
  67343. }
  67344. declare module "babylonjs/Misc/filesInput" {
  67345. import { Engine } from "babylonjs/Engines/engine";
  67346. import { Scene } from "babylonjs/scene";
  67347. import { SceneLoaderProgressEvent } from "babylonjs/Loading/sceneLoader";
  67348. /**
  67349. * Class used to help managing file picking and drag'n'drop
  67350. */
  67351. export class FilesInput {
  67352. /**
  67353. * List of files ready to be loaded
  67354. */
  67355. static readonly FilesToLoad: {
  67356. [key: string]: File;
  67357. };
  67358. /**
  67359. * Callback called when a file is processed
  67360. */
  67361. onProcessFileCallback: (file: File, name: string, extension: string) => true;
  67362. private _engine;
  67363. private _currentScene;
  67364. private _sceneLoadedCallback;
  67365. private _progressCallback;
  67366. private _additionalRenderLoopLogicCallback;
  67367. private _textureLoadingCallback;
  67368. private _startingProcessingFilesCallback;
  67369. private _onReloadCallback;
  67370. private _errorCallback;
  67371. private _elementToMonitor;
  67372. private _sceneFileToLoad;
  67373. private _filesToLoad;
  67374. /**
  67375. * Creates a new FilesInput
  67376. * @param engine defines the rendering engine
  67377. * @param scene defines the hosting scene
  67378. * @param sceneLoadedCallback callback called when scene is loaded
  67379. * @param progressCallback callback called to track progress
  67380. * @param additionalRenderLoopLogicCallback callback called to add user logic to the rendering loop
  67381. * @param textureLoadingCallback callback called when a texture is loading
  67382. * @param startingProcessingFilesCallback callback called when the system is about to process all files
  67383. * @param onReloadCallback callback called when a reload is requested
  67384. * @param errorCallback callback call if an error occurs
  67385. */
  67386. 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);
  67387. private _dragEnterHandler;
  67388. private _dragOverHandler;
  67389. private _dropHandler;
  67390. /**
  67391. * Calls this function to listen to drag'n'drop events on a specific DOM element
  67392. * @param elementToMonitor defines the DOM element to track
  67393. */
  67394. monitorElementForDragNDrop(elementToMonitor: HTMLElement): void;
  67395. /**
  67396. * Release all associated resources
  67397. */
  67398. dispose(): void;
  67399. private renderFunction;
  67400. private drag;
  67401. private drop;
  67402. private _traverseFolder;
  67403. private _processFiles;
  67404. /**
  67405. * Load files from a drop event
  67406. * @param event defines the drop event to use as source
  67407. */
  67408. loadFiles(event: any): void;
  67409. private _processReload;
  67410. /**
  67411. * Reload the current scene from the loaded files
  67412. */
  67413. reload(): void;
  67414. }
  67415. }
  67416. declare module "babylonjs/Misc/HighDynamicRange/index" {
  67417. export * from "babylonjs/Misc/HighDynamicRange/cubemapToSphericalPolynomial";
  67418. export * from "babylonjs/Misc/HighDynamicRange/hdr";
  67419. export * from "babylonjs/Misc/HighDynamicRange/panoramaToCubemap";
  67420. }
  67421. declare module "babylonjs/Misc/sceneOptimizer" {
  67422. import { Scene, IDisposable } from "babylonjs/scene";
  67423. import { Observable } from "babylonjs/Misc/observable";
  67424. /**
  67425. * Defines the root class used to create scene optimization to use with SceneOptimizer
  67426. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  67427. */
  67428. export class SceneOptimization {
  67429. /**
  67430. * Defines the priority of this optimization (0 by default which means first in the list)
  67431. */
  67432. priority: number;
  67433. /**
  67434. * Gets a string describing the action executed by the current optimization
  67435. * @returns description string
  67436. */
  67437. getDescription(): string;
  67438. /**
  67439. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  67440. * @param scene defines the current scene where to apply this optimization
  67441. * @param optimizer defines the current optimizer
  67442. * @returns true if everything that can be done was applied
  67443. */
  67444. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  67445. /**
  67446. * Creates the SceneOptimization object
  67447. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  67448. * @param desc defines the description associated with the optimization
  67449. */
  67450. constructor(
  67451. /**
  67452. * Defines the priority of this optimization (0 by default which means first in the list)
  67453. */
  67454. priority?: number);
  67455. }
  67456. /**
  67457. * Defines an optimization used to reduce the size of render target textures
  67458. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  67459. */
  67460. export class TextureOptimization extends SceneOptimization {
  67461. /**
  67462. * Defines the priority of this optimization (0 by default which means first in the list)
  67463. */
  67464. priority: number;
  67465. /**
  67466. * 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
  67467. */
  67468. maximumSize: number;
  67469. /**
  67470. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  67471. */
  67472. step: number;
  67473. /**
  67474. * Gets a string describing the action executed by the current optimization
  67475. * @returns description string
  67476. */
  67477. getDescription(): string;
  67478. /**
  67479. * Creates the TextureOptimization object
  67480. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  67481. * @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
  67482. * @param step defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  67483. */
  67484. constructor(
  67485. /**
  67486. * Defines the priority of this optimization (0 by default which means first in the list)
  67487. */
  67488. priority?: number,
  67489. /**
  67490. * 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
  67491. */
  67492. maximumSize?: number,
  67493. /**
  67494. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  67495. */
  67496. step?: number);
  67497. /**
  67498. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  67499. * @param scene defines the current scene where to apply this optimization
  67500. * @param optimizer defines the current optimizer
  67501. * @returns true if everything that can be done was applied
  67502. */
  67503. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  67504. }
  67505. /**
  67506. * Defines an optimization used to increase or decrease the rendering resolution
  67507. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  67508. */
  67509. export class HardwareScalingOptimization extends SceneOptimization {
  67510. /**
  67511. * Defines the priority of this optimization (0 by default which means first in the list)
  67512. */
  67513. priority: number;
  67514. /**
  67515. * Defines the maximum scale to use (2 by default)
  67516. */
  67517. maximumScale: number;
  67518. /**
  67519. * Defines the step to use between two passes (0.5 by default)
  67520. */
  67521. step: number;
  67522. private _currentScale;
  67523. private _directionOffset;
  67524. /**
  67525. * Gets a string describing the action executed by the current optimization
  67526. * @return description string
  67527. */
  67528. getDescription(): string;
  67529. /**
  67530. * Creates the HardwareScalingOptimization object
  67531. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  67532. * @param maximumScale defines the maximum scale to use (2 by default)
  67533. * @param step defines the step to use between two passes (0.5 by default)
  67534. */
  67535. constructor(
  67536. /**
  67537. * Defines the priority of this optimization (0 by default which means first in the list)
  67538. */
  67539. priority?: number,
  67540. /**
  67541. * Defines the maximum scale to use (2 by default)
  67542. */
  67543. maximumScale?: number,
  67544. /**
  67545. * Defines the step to use between two passes (0.5 by default)
  67546. */
  67547. step?: number);
  67548. /**
  67549. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  67550. * @param scene defines the current scene where to apply this optimization
  67551. * @param optimizer defines the current optimizer
  67552. * @returns true if everything that can be done was applied
  67553. */
  67554. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  67555. }
  67556. /**
  67557. * Defines an optimization used to remove shadows
  67558. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  67559. */
  67560. export class ShadowsOptimization extends SceneOptimization {
  67561. /**
  67562. * Gets a string describing the action executed by the current optimization
  67563. * @return description string
  67564. */
  67565. getDescription(): string;
  67566. /**
  67567. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  67568. * @param scene defines the current scene where to apply this optimization
  67569. * @param optimizer defines the current optimizer
  67570. * @returns true if everything that can be done was applied
  67571. */
  67572. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  67573. }
  67574. /**
  67575. * Defines an optimization used to turn post-processes off
  67576. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  67577. */
  67578. export class PostProcessesOptimization extends SceneOptimization {
  67579. /**
  67580. * Gets a string describing the action executed by the current optimization
  67581. * @return description string
  67582. */
  67583. getDescription(): string;
  67584. /**
  67585. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  67586. * @param scene defines the current scene where to apply this optimization
  67587. * @param optimizer defines the current optimizer
  67588. * @returns true if everything that can be done was applied
  67589. */
  67590. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  67591. }
  67592. /**
  67593. * Defines an optimization used to turn lens flares off
  67594. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  67595. */
  67596. export class LensFlaresOptimization extends SceneOptimization {
  67597. /**
  67598. * Gets a string describing the action executed by the current optimization
  67599. * @return description string
  67600. */
  67601. getDescription(): string;
  67602. /**
  67603. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  67604. * @param scene defines the current scene where to apply this optimization
  67605. * @param optimizer defines the current optimizer
  67606. * @returns true if everything that can be done was applied
  67607. */
  67608. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  67609. }
  67610. /**
  67611. * Defines an optimization based on user defined callback.
  67612. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  67613. */
  67614. export class CustomOptimization extends SceneOptimization {
  67615. /**
  67616. * Callback called to apply the custom optimization.
  67617. */
  67618. onApply: (scene: Scene, optimizer: SceneOptimizer) => boolean;
  67619. /**
  67620. * Callback called to get custom description
  67621. */
  67622. onGetDescription: () => string;
  67623. /**
  67624. * Gets a string describing the action executed by the current optimization
  67625. * @returns description string
  67626. */
  67627. getDescription(): string;
  67628. /**
  67629. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  67630. * @param scene defines the current scene where to apply this optimization
  67631. * @param optimizer defines the current optimizer
  67632. * @returns true if everything that can be done was applied
  67633. */
  67634. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  67635. }
  67636. /**
  67637. * Defines an optimization used to turn particles off
  67638. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  67639. */
  67640. export class ParticlesOptimization extends SceneOptimization {
  67641. /**
  67642. * Gets a string describing the action executed by the current optimization
  67643. * @return description string
  67644. */
  67645. getDescription(): string;
  67646. /**
  67647. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  67648. * @param scene defines the current scene where to apply this optimization
  67649. * @param optimizer defines the current optimizer
  67650. * @returns true if everything that can be done was applied
  67651. */
  67652. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  67653. }
  67654. /**
  67655. * Defines an optimization used to turn render targets off
  67656. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  67657. */
  67658. export class RenderTargetsOptimization extends SceneOptimization {
  67659. /**
  67660. * Gets a string describing the action executed by the current optimization
  67661. * @return description string
  67662. */
  67663. getDescription(): string;
  67664. /**
  67665. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  67666. * @param scene defines the current scene where to apply this optimization
  67667. * @param optimizer defines the current optimizer
  67668. * @returns true if everything that can be done was applied
  67669. */
  67670. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  67671. }
  67672. /**
  67673. * Defines an optimization used to merge meshes with compatible materials
  67674. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  67675. */
  67676. export class MergeMeshesOptimization extends SceneOptimization {
  67677. private static _UpdateSelectionTree;
  67678. /**
  67679. * Gets or sets a boolean which defines if optimization octree has to be updated
  67680. */
  67681. /**
  67682. * Gets or sets a boolean which defines if optimization octree has to be updated
  67683. */
  67684. static UpdateSelectionTree: boolean;
  67685. /**
  67686. * Gets a string describing the action executed by the current optimization
  67687. * @return description string
  67688. */
  67689. getDescription(): string;
  67690. private _canBeMerged;
  67691. /**
  67692. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  67693. * @param scene defines the current scene where to apply this optimization
  67694. * @param optimizer defines the current optimizer
  67695. * @param updateSelectionTree defines that the selection octree has to be updated (false by default)
  67696. * @returns true if everything that can be done was applied
  67697. */
  67698. apply(scene: Scene, optimizer: SceneOptimizer, updateSelectionTree?: boolean): boolean;
  67699. }
  67700. /**
  67701. * Defines a list of options used by SceneOptimizer
  67702. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  67703. */
  67704. export class SceneOptimizerOptions {
  67705. /**
  67706. * Defines the target frame rate to reach (60 by default)
  67707. */
  67708. targetFrameRate: number;
  67709. /**
  67710. * Defines the interval between two checkes (2000ms by default)
  67711. */
  67712. trackerDuration: number;
  67713. /**
  67714. * Gets the list of optimizations to apply
  67715. */
  67716. optimizations: SceneOptimization[];
  67717. /**
  67718. * Creates a new list of options used by SceneOptimizer
  67719. * @param targetFrameRate defines the target frame rate to reach (60 by default)
  67720. * @param trackerDuration defines the interval between two checkes (2000ms by default)
  67721. */
  67722. constructor(
  67723. /**
  67724. * Defines the target frame rate to reach (60 by default)
  67725. */
  67726. targetFrameRate?: number,
  67727. /**
  67728. * Defines the interval between two checkes (2000ms by default)
  67729. */
  67730. trackerDuration?: number);
  67731. /**
  67732. * Add a new optimization
  67733. * @param optimization defines the SceneOptimization to add to the list of active optimizations
  67734. * @returns the current SceneOptimizerOptions
  67735. */
  67736. addOptimization(optimization: SceneOptimization): SceneOptimizerOptions;
  67737. /**
  67738. * Add a new custom optimization
  67739. * @param onApply defines the callback called to apply the custom optimization (true if everything that can be done was applied)
  67740. * @param onGetDescription defines the callback called to get the description attached with the optimization.
  67741. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  67742. * @returns the current SceneOptimizerOptions
  67743. */
  67744. addCustomOptimization(onApply: (scene: Scene) => boolean, onGetDescription: () => string, priority?: number): SceneOptimizerOptions;
  67745. /**
  67746. * Creates a list of pre-defined optimizations aimed to reduce the visual impact on the scene
  67747. * @param targetFrameRate defines the target frame rate (60 by default)
  67748. * @returns a SceneOptimizerOptions object
  67749. */
  67750. static LowDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  67751. /**
  67752. * Creates a list of pre-defined optimizations aimed to have a moderate impact on the scene visual
  67753. * @param targetFrameRate defines the target frame rate (60 by default)
  67754. * @returns a SceneOptimizerOptions object
  67755. */
  67756. static ModerateDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  67757. /**
  67758. * Creates a list of pre-defined optimizations aimed to have a big impact on the scene visual
  67759. * @param targetFrameRate defines the target frame rate (60 by default)
  67760. * @returns a SceneOptimizerOptions object
  67761. */
  67762. static HighDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  67763. }
  67764. /**
  67765. * Class used to run optimizations in order to reach a target frame rate
  67766. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  67767. */
  67768. export class SceneOptimizer implements IDisposable {
  67769. private _isRunning;
  67770. private _options;
  67771. private _scene;
  67772. private _currentPriorityLevel;
  67773. private _targetFrameRate;
  67774. private _trackerDuration;
  67775. private _currentFrameRate;
  67776. private _sceneDisposeObserver;
  67777. private _improvementMode;
  67778. /**
  67779. * Defines an observable called when the optimizer reaches the target frame rate
  67780. */
  67781. onSuccessObservable: Observable<SceneOptimizer>;
  67782. /**
  67783. * Defines an observable called when the optimizer enables an optimization
  67784. */
  67785. onNewOptimizationAppliedObservable: Observable<SceneOptimization>;
  67786. /**
  67787. * Defines an observable called when the optimizer is not able to reach the target frame rate
  67788. */
  67789. onFailureObservable: Observable<SceneOptimizer>;
  67790. /**
  67791. * Gets a boolean indicating if the optimizer is in improvement mode
  67792. */
  67793. readonly isInImprovementMode: boolean;
  67794. /**
  67795. * Gets the current priority level (0 at start)
  67796. */
  67797. readonly currentPriorityLevel: number;
  67798. /**
  67799. * Gets the current frame rate checked by the SceneOptimizer
  67800. */
  67801. readonly currentFrameRate: number;
  67802. /**
  67803. * Gets or sets the current target frame rate (60 by default)
  67804. */
  67805. /**
  67806. * Gets or sets the current target frame rate (60 by default)
  67807. */
  67808. targetFrameRate: number;
  67809. /**
  67810. * Gets or sets the current interval between two checks (every 2000ms by default)
  67811. */
  67812. /**
  67813. * Gets or sets the current interval between two checks (every 2000ms by default)
  67814. */
  67815. trackerDuration: number;
  67816. /**
  67817. * Gets the list of active optimizations
  67818. */
  67819. readonly optimizations: SceneOptimization[];
  67820. /**
  67821. * Creates a new SceneOptimizer
  67822. * @param scene defines the scene to work on
  67823. * @param options defines the options to use with the SceneOptimizer
  67824. * @param autoGeneratePriorities defines if priorities must be generated and not read from SceneOptimization property (true by default)
  67825. * @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)
  67826. */
  67827. constructor(scene: Scene, options?: SceneOptimizerOptions, autoGeneratePriorities?: boolean, improvementMode?: boolean);
  67828. /**
  67829. * Stops the current optimizer
  67830. */
  67831. stop(): void;
  67832. /**
  67833. * Reset the optimizer to initial step (current priority level = 0)
  67834. */
  67835. reset(): void;
  67836. /**
  67837. * Start the optimizer. By default it will try to reach a specific framerate
  67838. * but if the optimizer is set with improvementMode === true then it will run all optimiatiation while frame rate is above the target frame rate
  67839. */
  67840. start(): void;
  67841. private _checkCurrentState;
  67842. /**
  67843. * Release all resources
  67844. */
  67845. dispose(): void;
  67846. /**
  67847. * Helper function to create a SceneOptimizer with one single line of code
  67848. * @param scene defines the scene to work on
  67849. * @param options defines the options to use with the SceneOptimizer
  67850. * @param onSuccess defines a callback to call on success
  67851. * @param onFailure defines a callback to call on failure
  67852. * @returns the new SceneOptimizer object
  67853. */
  67854. static OptimizeAsync(scene: Scene, options?: SceneOptimizerOptions, onSuccess?: () => void, onFailure?: () => void): SceneOptimizer;
  67855. }
  67856. }
  67857. declare module "babylonjs/Misc/sceneSerializer" {
  67858. import { Scene } from "babylonjs/scene";
  67859. /**
  67860. * Class used to serialize a scene into a string
  67861. */
  67862. export class SceneSerializer {
  67863. /**
  67864. * Clear cache used by a previous serialization
  67865. */
  67866. static ClearCache(): void;
  67867. /**
  67868. * Serialize a scene into a JSON compatible object
  67869. * @param scene defines the scene to serialize
  67870. * @returns a JSON compatible object
  67871. */
  67872. static Serialize(scene: Scene): any;
  67873. /**
  67874. * Serialize a mesh into a JSON compatible object
  67875. * @param toSerialize defines the mesh to serialize
  67876. * @param withParents defines if parents must be serialized as well
  67877. * @param withChildren defines if children must be serialized as well
  67878. * @returns a JSON compatible object
  67879. */
  67880. static SerializeMesh(toSerialize: any, withParents?: boolean, withChildren?: boolean): any;
  67881. }
  67882. }
  67883. declare module "babylonjs/Misc/textureTools" {
  67884. import { Texture } from "babylonjs/Materials/Textures/texture";
  67885. /**
  67886. * Class used to host texture specific utilities
  67887. */
  67888. export class TextureTools {
  67889. /**
  67890. * Uses the GPU to create a copy texture rescaled at a given size
  67891. * @param texture Texture to copy from
  67892. * @param width defines the desired width
  67893. * @param height defines the desired height
  67894. * @param useBilinearMode defines if bilinear mode has to be used
  67895. * @return the generated texture
  67896. */
  67897. static CreateResizedCopy(texture: Texture, width: number, height: number, useBilinearMode?: boolean): Texture;
  67898. }
  67899. }
  67900. declare module "babylonjs/Misc/videoRecorder" {
  67901. import { Nullable } from "babylonjs/types";
  67902. import { Engine } from "babylonjs/Engines/engine";
  67903. /**
  67904. * This represents the different options available for the video capture.
  67905. */
  67906. export interface VideoRecorderOptions {
  67907. /** Defines the mime type of the video. */
  67908. mimeType: string;
  67909. /** Defines the FPS the video should be recorded at. */
  67910. fps: number;
  67911. /** Defines the chunk size for the recording data. */
  67912. recordChunckSize: number;
  67913. /** The audio tracks to attach to the recording. */
  67914. audioTracks?: MediaStreamTrack[];
  67915. }
  67916. /**
  67917. * This can help with recording videos from BabylonJS.
  67918. * This is based on the available WebRTC functionalities of the browser.
  67919. *
  67920. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_video
  67921. */
  67922. export class VideoRecorder {
  67923. private static readonly _defaultOptions;
  67924. /**
  67925. * Returns whether or not the VideoRecorder is available in your browser.
  67926. * @param engine Defines the Babylon Engine.
  67927. * @returns true if supported otherwise false.
  67928. */
  67929. static IsSupported(engine: Engine): boolean;
  67930. private readonly _options;
  67931. private _canvas;
  67932. private _mediaRecorder;
  67933. private _recordedChunks;
  67934. private _fileName;
  67935. private _resolve;
  67936. private _reject;
  67937. /**
  67938. * True when a recording is already in progress.
  67939. */
  67940. readonly isRecording: boolean;
  67941. /**
  67942. * Create a new VideoCapture object which can help converting what you see in Babylon to a video file.
  67943. * @param engine Defines the BabylonJS Engine you wish to record.
  67944. * @param options Defines options that can be used to customize the capture.
  67945. */
  67946. constructor(engine: Engine, options?: Nullable<VideoRecorderOptions>);
  67947. /**
  67948. * Stops the current recording before the default capture timeout passed in the startRecording function.
  67949. */
  67950. stopRecording(): void;
  67951. /**
  67952. * Starts recording the canvas for a max duration specified in parameters.
  67953. * @param fileName Defines the name of the file to be downloaded when the recording stop.
  67954. * If null no automatic download will start and you can rely on the promise to get the data back.
  67955. * @param maxDuration Defines the maximum recording time in seconds.
  67956. * It defaults to 7 seconds. A value of zero will not stop automatically, you would need to call stopRecording manually.
  67957. * @return A promise callback at the end of the recording with the video data in Blob.
  67958. */
  67959. startRecording(fileName?: Nullable<string>, maxDuration?: number): Promise<Blob>;
  67960. /**
  67961. * Releases internal resources used during the recording.
  67962. */
  67963. dispose(): void;
  67964. private _handleDataAvailable;
  67965. private _handleError;
  67966. private _handleStop;
  67967. }
  67968. }
  67969. declare module "babylonjs/Misc/screenshotTools" {
  67970. import { Camera } from "babylonjs/Cameras/camera";
  67971. import { IScreenshotSize } from "babylonjs/Misc/interfaces/screenshotSize";
  67972. import { Engine } from "babylonjs/Engines/engine";
  67973. /**
  67974. * Class containing a set of static utilities functions for screenshots
  67975. */
  67976. export class ScreenshotTools {
  67977. /**
  67978. * Captures a screenshot of the current rendering
  67979. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  67980. * @param engine defines the rendering engine
  67981. * @param camera defines the source camera
  67982. * @param size This parameter can be set to a single number or to an object with the
  67983. * following (optional) properties: precision, width, height. If a single number is passed,
  67984. * it will be used for both width and height. If an object is passed, the screenshot size
  67985. * will be derived from the parameters. The precision property is a multiplier allowing
  67986. * rendering at a higher or lower resolution
  67987. * @param successCallback defines the callback receives a single parameter which contains the
  67988. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  67989. * src parameter of an <img> to display it
  67990. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  67991. * Check your browser for supported MIME types
  67992. */
  67993. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  67994. /**
  67995. * Captures a screenshot of the current rendering
  67996. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  67997. * @param engine defines the rendering engine
  67998. * @param camera defines the source camera
  67999. * @param size This parameter can be set to a single number or to an object with the
  68000. * following (optional) properties: precision, width, height. If a single number is passed,
  68001. * it will be used for both width and height. If an object is passed, the screenshot size
  68002. * will be derived from the parameters. The precision property is a multiplier allowing
  68003. * rendering at a higher or lower resolution
  68004. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  68005. * Check your browser for supported MIME types
  68006. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  68007. * to the src parameter of an <img> to display it
  68008. */
  68009. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: any, mimeType?: string): Promise<string>;
  68010. /**
  68011. * Generates an image screenshot from the specified camera.
  68012. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  68013. * @param engine The engine to use for rendering
  68014. * @param camera The camera to use for rendering
  68015. * @param size This parameter can be set to a single number or to an object with the
  68016. * following (optional) properties: precision, width, height. If a single number is passed,
  68017. * it will be used for both width and height. If an object is passed, the screenshot size
  68018. * will be derived from the parameters. The precision property is a multiplier allowing
  68019. * rendering at a higher or lower resolution
  68020. * @param successCallback The callback receives a single parameter which contains the
  68021. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  68022. * src parameter of an <img> to display it
  68023. * @param mimeType The MIME type of the screenshot image (default: image/png).
  68024. * Check your browser for supported MIME types
  68025. * @param samples Texture samples (default: 1)
  68026. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  68027. * @param fileName A name for for the downloaded file.
  68028. */
  68029. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): void;
  68030. /**
  68031. * Generates an image screenshot from the specified camera.
  68032. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  68033. * @param engine The engine to use for rendering
  68034. * @param camera The camera to use for rendering
  68035. * @param size This parameter can be set to a single number or to an object with the
  68036. * following (optional) properties: precision, width, height. If a single number is passed,
  68037. * it will be used for both width and height. If an object is passed, the screenshot size
  68038. * will be derived from the parameters. The precision property is a multiplier allowing
  68039. * rendering at a higher or lower resolution
  68040. * @param mimeType The MIME type of the screenshot image (default: image/png).
  68041. * Check your browser for supported MIME types
  68042. * @param samples Texture samples (default: 1)
  68043. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  68044. * @param fileName A name for for the downloaded file.
  68045. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  68046. * to the src parameter of an <img> to display it
  68047. */
  68048. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: any, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): Promise<string>;
  68049. /**
  68050. * Gets height and width for screenshot size
  68051. * @private
  68052. */
  68053. private static _getScreenshotSize;
  68054. }
  68055. }
  68056. declare module "babylonjs/Misc/dataReader" {
  68057. /**
  68058. * Interface for a data buffer
  68059. */
  68060. export interface IDataBuffer {
  68061. /**
  68062. * Reads bytes from the data buffer.
  68063. * @param byteOffset The byte offset to read
  68064. * @param byteLength The byte length to read
  68065. * @returns A promise that resolves when the bytes are read
  68066. */
  68067. readAsync(byteOffset: number, byteLength: number): Promise<ArrayBufferView>;
  68068. /**
  68069. * The byte length of the buffer.
  68070. */
  68071. readonly byteLength: number;
  68072. }
  68073. /**
  68074. * Utility class for reading from a data buffer
  68075. */
  68076. export class DataReader {
  68077. /**
  68078. * The data buffer associated with this data reader.
  68079. */
  68080. readonly buffer: IDataBuffer;
  68081. /**
  68082. * The current byte offset from the beginning of the data buffer.
  68083. */
  68084. byteOffset: number;
  68085. private _dataView;
  68086. private _dataByteOffset;
  68087. /**
  68088. * Constructor
  68089. * @param buffer The buffer to read
  68090. */
  68091. constructor(buffer: IDataBuffer);
  68092. /**
  68093. * Loads the given byte length.
  68094. * @param byteLength The byte length to load
  68095. * @returns A promise that resolves when the load is complete
  68096. */
  68097. loadAsync(byteLength: number): Promise<void>;
  68098. /**
  68099. * Read a unsigned 32-bit integer from the currently loaded data range.
  68100. * @returns The 32-bit integer read
  68101. */
  68102. readUint32(): number;
  68103. /**
  68104. * Read a byte array from the currently loaded data range.
  68105. * @param byteLength The byte length to read
  68106. * @returns The byte array read
  68107. */
  68108. readUint8Array(byteLength: number): Uint8Array;
  68109. /**
  68110. * Read a string from the currently loaded data range.
  68111. * @param byteLength The byte length to read
  68112. * @returns The string read
  68113. */
  68114. readString(byteLength: number): string;
  68115. /**
  68116. * Skips the given byte length the currently loaded data range.
  68117. * @param byteLength The byte length to skip
  68118. */
  68119. skipBytes(byteLength: number): void;
  68120. }
  68121. }
  68122. declare module "babylonjs/Misc/index" {
  68123. export * from "babylonjs/Misc/andOrNotEvaluator";
  68124. export * from "babylonjs/Misc/assetsManager";
  68125. export * from "babylonjs/Misc/dds";
  68126. export * from "babylonjs/Misc/decorators";
  68127. export * from "babylonjs/Misc/deferred";
  68128. export * from "babylonjs/Misc/environmentTextureTools";
  68129. export * from "babylonjs/Misc/meshExploder";
  68130. export * from "babylonjs/Misc/filesInput";
  68131. export * from "babylonjs/Misc/HighDynamicRange/index";
  68132. export * from "babylonjs/Misc/khronosTextureContainer";
  68133. export * from "babylonjs/Misc/observable";
  68134. export * from "babylonjs/Misc/performanceMonitor";
  68135. export * from "babylonjs/Misc/promise";
  68136. export * from "babylonjs/Misc/sceneOptimizer";
  68137. export * from "babylonjs/Misc/sceneSerializer";
  68138. export * from "babylonjs/Misc/smartArray";
  68139. export * from "babylonjs/Misc/stringDictionary";
  68140. export * from "babylonjs/Misc/tags";
  68141. export * from "babylonjs/Misc/textureTools";
  68142. export * from "babylonjs/Misc/tga";
  68143. export * from "babylonjs/Misc/tools";
  68144. export * from "babylonjs/Misc/videoRecorder";
  68145. export * from "babylonjs/Misc/virtualJoystick";
  68146. export * from "babylonjs/Misc/workerPool";
  68147. export * from "babylonjs/Misc/logger";
  68148. export * from "babylonjs/Misc/typeStore";
  68149. export * from "babylonjs/Misc/filesInputStore";
  68150. export * from "babylonjs/Misc/deepCopier";
  68151. export * from "babylonjs/Misc/pivotTools";
  68152. export * from "babylonjs/Misc/precisionDate";
  68153. export * from "babylonjs/Misc/screenshotTools";
  68154. export * from "babylonjs/Misc/typeStore";
  68155. export * from "babylonjs/Misc/webRequest";
  68156. export * from "babylonjs/Misc/iInspectable";
  68157. export * from "babylonjs/Misc/brdfTextureTools";
  68158. export * from "babylonjs/Misc/rgbdTextureTools";
  68159. export * from "babylonjs/Misc/gradients";
  68160. export * from "babylonjs/Misc/perfCounter";
  68161. export * from "babylonjs/Misc/fileRequest";
  68162. export * from "babylonjs/Misc/customAnimationFrameRequester";
  68163. export * from "babylonjs/Misc/retryStrategy";
  68164. export * from "babylonjs/Misc/interfaces/screenshotSize";
  68165. export * from "babylonjs/Misc/canvasGenerator";
  68166. export * from "babylonjs/Misc/fileTools";
  68167. export * from "babylonjs/Misc/stringTools";
  68168. export * from "babylonjs/Misc/dataReader";
  68169. }
  68170. declare module "babylonjs/index" {
  68171. export * from "babylonjs/abstractScene";
  68172. export * from "babylonjs/Actions/index";
  68173. export * from "babylonjs/Animations/index";
  68174. export * from "babylonjs/assetContainer";
  68175. export * from "babylonjs/Audio/index";
  68176. export * from "babylonjs/Behaviors/index";
  68177. export * from "babylonjs/Bones/index";
  68178. export * from "babylonjs/Cameras/index";
  68179. export * from "babylonjs/Collisions/index";
  68180. export * from "babylonjs/Culling/index";
  68181. export * from "babylonjs/Debug/index";
  68182. export * from "babylonjs/Engines/index";
  68183. export * from "babylonjs/Events/index";
  68184. export * from "babylonjs/Gamepads/index";
  68185. export * from "babylonjs/Gizmos/index";
  68186. export * from "babylonjs/Helpers/index";
  68187. export * from "babylonjs/Instrumentation/index";
  68188. export * from "babylonjs/Layers/index";
  68189. export * from "babylonjs/LensFlares/index";
  68190. export * from "babylonjs/Lights/index";
  68191. export * from "babylonjs/Loading/index";
  68192. export * from "babylonjs/Materials/index";
  68193. export * from "babylonjs/Maths/index";
  68194. export * from "babylonjs/Meshes/index";
  68195. export * from "babylonjs/Morph/index";
  68196. export * from "babylonjs/Navigation/index";
  68197. export * from "babylonjs/node";
  68198. export * from "babylonjs/Offline/index";
  68199. export * from "babylonjs/Particles/index";
  68200. export * from "babylonjs/Physics/index";
  68201. export * from "babylonjs/PostProcesses/index";
  68202. export * from "babylonjs/Probes/index";
  68203. export * from "babylonjs/Rendering/index";
  68204. export * from "babylonjs/scene";
  68205. export * from "babylonjs/sceneComponent";
  68206. export * from "babylonjs/Sprites/index";
  68207. export * from "babylonjs/States/index";
  68208. export * from "babylonjs/Misc/index";
  68209. export * from "babylonjs/types";
  68210. }
  68211. declare module "babylonjs/Animations/pathCursor" {
  68212. import { Vector3 } from "babylonjs/Maths/math.vector";
  68213. import { Path2 } from "babylonjs/Maths/math.path";
  68214. /**
  68215. * A cursor which tracks a point on a path
  68216. */
  68217. export class PathCursor {
  68218. private path;
  68219. /**
  68220. * Stores path cursor callbacks for when an onchange event is triggered
  68221. */
  68222. private _onchange;
  68223. /**
  68224. * The value of the path cursor
  68225. */
  68226. value: number;
  68227. /**
  68228. * The animation array of the path cursor
  68229. */
  68230. animations: Animation[];
  68231. /**
  68232. * Initializes the path cursor
  68233. * @param path The path to track
  68234. */
  68235. constructor(path: Path2);
  68236. /**
  68237. * Gets the cursor point on the path
  68238. * @returns A point on the path cursor at the cursor location
  68239. */
  68240. getPoint(): Vector3;
  68241. /**
  68242. * Moves the cursor ahead by the step amount
  68243. * @param step The amount to move the cursor forward
  68244. * @returns This path cursor
  68245. */
  68246. moveAhead(step?: number): PathCursor;
  68247. /**
  68248. * Moves the cursor behind by the step amount
  68249. * @param step The amount to move the cursor back
  68250. * @returns This path cursor
  68251. */
  68252. moveBack(step?: number): PathCursor;
  68253. /**
  68254. * Moves the cursor by the step amount
  68255. * If the step amount is greater than one, an exception is thrown
  68256. * @param step The amount to move the cursor
  68257. * @returns This path cursor
  68258. */
  68259. move(step: number): PathCursor;
  68260. /**
  68261. * Ensures that the value is limited between zero and one
  68262. * @returns This path cursor
  68263. */
  68264. private ensureLimits;
  68265. /**
  68266. * Runs onchange callbacks on change (used by the animation engine)
  68267. * @returns This path cursor
  68268. */
  68269. private raiseOnChange;
  68270. /**
  68271. * Executes a function on change
  68272. * @param f A path cursor onchange callback
  68273. * @returns This path cursor
  68274. */
  68275. onchange(f: (cursor: PathCursor) => void): PathCursor;
  68276. }
  68277. }
  68278. declare module "babylonjs/Engines/Processors/Expressions/Operators/index" {
  68279. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineAndOperator";
  68280. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineArithmeticOperator";
  68281. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineIsDefinedOperator";
  68282. export * from "babylonjs/Engines/Processors/Expressions/Operators/shaderDefineOrOperator";
  68283. }
  68284. declare module "babylonjs/Engines/Processors/Expressions/index" {
  68285. export * from "babylonjs/Engines/Processors/Expressions/shaderDefineExpression";
  68286. export * from "babylonjs/Engines/Processors/Expressions/Operators/index";
  68287. }
  68288. declare module "babylonjs/Engines/Processors/index" {
  68289. export * from "babylonjs/Engines/Processors/iShaderProcessor";
  68290. export * from "babylonjs/Engines/Processors/Expressions/index";
  68291. export * from "babylonjs/Engines/Processors/shaderCodeConditionNode";
  68292. export * from "babylonjs/Engines/Processors/shaderCodeCursor";
  68293. export * from "babylonjs/Engines/Processors/shaderCodeNode";
  68294. export * from "babylonjs/Engines/Processors/shaderCodeTestNode";
  68295. export * from "babylonjs/Engines/Processors/shaderProcessingOptions";
  68296. export * from "babylonjs/Engines/Processors/shaderProcessor";
  68297. }
  68298. declare module "babylonjs/Legacy/legacy" {
  68299. import * as Babylon from "babylonjs/index";
  68300. export * from "babylonjs/index";
  68301. }
  68302. declare module "babylonjs/Shaders/blur.fragment" {
  68303. /** @hidden */
  68304. export var blurPixelShader: {
  68305. name: string;
  68306. shader: string;
  68307. };
  68308. }
  68309. declare module "babylonjs/Shaders/ShadersInclude/pointCloudVertexDeclaration" {
  68310. /** @hidden */
  68311. export var pointCloudVertexDeclaration: {
  68312. name: string;
  68313. shader: string;
  68314. };
  68315. }
  68316. declare module "babylonjs" {
  68317. export * from "babylonjs/Legacy/legacy";
  68318. }
  68319. declare module BABYLON {
  68320. /** Alias type for value that can be null */
  68321. export type Nullable<T> = T | null;
  68322. /**
  68323. * Alias type for number that are floats
  68324. * @ignorenaming
  68325. */
  68326. export type float = number;
  68327. /**
  68328. * Alias type for number that are doubles.
  68329. * @ignorenaming
  68330. */
  68331. export type double = number;
  68332. /**
  68333. * Alias type for number that are integer
  68334. * @ignorenaming
  68335. */
  68336. export type int = number;
  68337. /** Alias type for number array or Float32Array */
  68338. export type FloatArray = number[] | Float32Array;
  68339. /** Alias type for number array or Float32Array or Int32Array or Uint32Array or Uint16Array */
  68340. export type IndicesArray = number[] | Int32Array | Uint32Array | Uint16Array;
  68341. /**
  68342. * Alias for types that can be used by a Buffer or VertexBuffer.
  68343. */
  68344. export type DataArray = number[] | ArrayBuffer | ArrayBufferView;
  68345. /**
  68346. * Alias type for primitive types
  68347. * @ignorenaming
  68348. */
  68349. type Primitive = undefined | null | boolean | string | number | Function;
  68350. /**
  68351. * Type modifier to make all the properties of an object Readonly
  68352. */
  68353. export type Immutable<T> = T extends Primitive ? T : T extends Array<infer U> ? ReadonlyArray<U> : DeepImmutable<T>;
  68354. /**
  68355. * Type modifier to make all the properties of an object Readonly recursively
  68356. */
  68357. export type DeepImmutable<T> = T extends Primitive ? T : T extends Array<infer U> ? DeepImmutableArray<U> : DeepImmutableObject<T>;
  68358. /**
  68359. * Type modifier to make object properties readonly.
  68360. */
  68361. export type DeepImmutableObject<T> = {
  68362. readonly [K in keyof T]: DeepImmutable<T[K]>;
  68363. };
  68364. /** @hidden */
  68365. interface DeepImmutableArray<T> extends ReadonlyArray<DeepImmutable<T>> {
  68366. }
  68367. }
  68368. declare module BABYLON {
  68369. /**
  68370. * A class serves as a medium between the observable and its observers
  68371. */
  68372. export class EventState {
  68373. /**
  68374. * Create a new EventState
  68375. * @param mask defines the mask associated with this state
  68376. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  68377. * @param target defines the original target of the state
  68378. * @param currentTarget defines the current target of the state
  68379. */
  68380. constructor(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any);
  68381. /**
  68382. * Initialize the current event state
  68383. * @param mask defines the mask associated with this state
  68384. * @param skipNextObservers defines a flag which will instruct the observable to skip following observers when set to true
  68385. * @param target defines the original target of the state
  68386. * @param currentTarget defines the current target of the state
  68387. * @returns the current event state
  68388. */
  68389. initalize(mask: number, skipNextObservers?: boolean, target?: any, currentTarget?: any): EventState;
  68390. /**
  68391. * An Observer can set this property to true to prevent subsequent observers of being notified
  68392. */
  68393. skipNextObservers: boolean;
  68394. /**
  68395. * Get the mask value that were used to trigger the event corresponding to this EventState object
  68396. */
  68397. mask: number;
  68398. /**
  68399. * The object that originally notified the event
  68400. */
  68401. target?: any;
  68402. /**
  68403. * The current object in the bubbling phase
  68404. */
  68405. currentTarget?: any;
  68406. /**
  68407. * This will be populated with the return value of the last function that was executed.
  68408. * If it is the first function in the callback chain it will be the event data.
  68409. */
  68410. lastReturnValue?: any;
  68411. }
  68412. /**
  68413. * Represent an Observer registered to a given Observable object.
  68414. */
  68415. export class Observer<T> {
  68416. /**
  68417. * Defines the callback to call when the observer is notified
  68418. */
  68419. callback: (eventData: T, eventState: EventState) => void;
  68420. /**
  68421. * Defines the mask of the observer (used to filter notifications)
  68422. */
  68423. mask: number;
  68424. /**
  68425. * Defines the current scope used to restore the JS context
  68426. */
  68427. scope: any;
  68428. /** @hidden */
  68429. _willBeUnregistered: boolean;
  68430. /**
  68431. * Gets or sets a property defining that the observer as to be unregistered after the next notification
  68432. */
  68433. unregisterOnNextCall: boolean;
  68434. /**
  68435. * Creates a new observer
  68436. * @param callback defines the callback to call when the observer is notified
  68437. * @param mask defines the mask of the observer (used to filter notifications)
  68438. * @param scope defines the current scope used to restore the JS context
  68439. */
  68440. constructor(
  68441. /**
  68442. * Defines the callback to call when the observer is notified
  68443. */
  68444. callback: (eventData: T, eventState: EventState) => void,
  68445. /**
  68446. * Defines the mask of the observer (used to filter notifications)
  68447. */
  68448. mask: number,
  68449. /**
  68450. * Defines the current scope used to restore the JS context
  68451. */
  68452. scope?: any);
  68453. }
  68454. /**
  68455. * Represent a list of observers registered to multiple Observables object.
  68456. */
  68457. export class MultiObserver<T> {
  68458. private _observers;
  68459. private _observables;
  68460. /**
  68461. * Release associated resources
  68462. */
  68463. dispose(): void;
  68464. /**
  68465. * Raise a callback when one of the observable will notify
  68466. * @param observables defines a list of observables to watch
  68467. * @param callback defines the callback to call on notification
  68468. * @param mask defines the mask used to filter notifications
  68469. * @param scope defines the current scope used to restore the JS context
  68470. * @returns the new MultiObserver
  68471. */
  68472. static Watch<T>(observables: Observable<T>[], callback: (eventData: T, eventState: EventState) => void, mask?: number, scope?: any): MultiObserver<T>;
  68473. }
  68474. /**
  68475. * The Observable class is a simple implementation of the Observable pattern.
  68476. *
  68477. * 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.
  68478. * This enable a more fine grained execution without having to rely on multiple different Observable objects.
  68479. * 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).
  68480. * 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.
  68481. */
  68482. export class Observable<T> {
  68483. private _observers;
  68484. private _eventState;
  68485. private _onObserverAdded;
  68486. /**
  68487. * Gets the list of observers
  68488. */
  68489. readonly observers: Array<Observer<T>>;
  68490. /**
  68491. * Creates a new observable
  68492. * @param onObserverAdded defines a callback to call when a new observer is added
  68493. */
  68494. constructor(onObserverAdded?: (observer: Observer<T>) => void);
  68495. /**
  68496. * Create a new Observer with the specified callback
  68497. * @param callback the callback that will be executed for that Observer
  68498. * @param mask the mask used to filter observers
  68499. * @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.
  68500. * @param scope optional scope for the callback to be called from
  68501. * @param unregisterOnFirstCall defines if the observer as to be unregistered after the next notification
  68502. * @returns the new observer created for the callback
  68503. */
  68504. add(callback: (eventData: T, eventState: EventState) => void, mask?: number, insertFirst?: boolean, scope?: any, unregisterOnFirstCall?: boolean): Nullable<Observer<T>>;
  68505. /**
  68506. * Create a new Observer with the specified callback and unregisters after the next notification
  68507. * @param callback the callback that will be executed for that Observer
  68508. * @returns the new observer created for the callback
  68509. */
  68510. addOnce(callback: (eventData: T, eventState: EventState) => void): Nullable<Observer<T>>;
  68511. /**
  68512. * Remove an Observer from the Observable object
  68513. * @param observer the instance of the Observer to remove
  68514. * @returns false if it doesn't belong to this Observable
  68515. */
  68516. remove(observer: Nullable<Observer<T>>): boolean;
  68517. /**
  68518. * Remove a callback from the Observable object
  68519. * @param callback the callback to remove
  68520. * @param scope optional scope. If used only the callbacks with this scope will be removed
  68521. * @returns false if it doesn't belong to this Observable
  68522. */
  68523. removeCallback(callback: (eventData: T, eventState: EventState) => void, scope?: any): boolean;
  68524. private _deferUnregister;
  68525. private _remove;
  68526. /**
  68527. * Moves the observable to the top of the observer list making it get called first when notified
  68528. * @param observer the observer to move
  68529. */
  68530. makeObserverTopPriority(observer: Observer<T>): void;
  68531. /**
  68532. * Moves the observable to the bottom of the observer list making it get called last when notified
  68533. * @param observer the observer to move
  68534. */
  68535. makeObserverBottomPriority(observer: Observer<T>): void;
  68536. /**
  68537. * Notify all Observers by calling their respective callback with the given data
  68538. * Will return true if all observers were executed, false if an observer set skipNextObservers to true, then prevent the subsequent ones to execute
  68539. * @param eventData defines the data to send to all observers
  68540. * @param mask defines the mask of the current notification (observers with incompatible mask (ie mask & observer.mask === 0) will not be notified)
  68541. * @param target defines the original target of the state
  68542. * @param currentTarget defines the current target of the state
  68543. * @returns false if the complete observer chain was not processed (because one observer set the skipNextObservers to true)
  68544. */
  68545. notifyObservers(eventData: T, mask?: number, target?: any, currentTarget?: any): boolean;
  68546. /**
  68547. * Calling this will execute each callback, expecting it to be a promise or return a value.
  68548. * If at any point in the chain one function fails, the promise will fail and the execution will not continue.
  68549. * This is useful when a chain of events (sometimes async events) is needed to initialize a certain object
  68550. * and it is crucial that all callbacks will be executed.
  68551. * The order of the callbacks is kept, callbacks are not executed parallel.
  68552. *
  68553. * @param eventData The data to be sent to each callback
  68554. * @param mask is used to filter observers defaults to -1
  68555. * @param target defines the callback target (see EventState)
  68556. * @param currentTarget defines he current object in the bubbling phase
  68557. * @returns {Promise<T>} will return a Promise than resolves when all callbacks executed successfully.
  68558. */
  68559. notifyObserversWithPromise(eventData: T, mask?: number, target?: any, currentTarget?: any): Promise<T>;
  68560. /**
  68561. * Notify a specific observer
  68562. * @param observer defines the observer to notify
  68563. * @param eventData defines the data to be sent to each callback
  68564. * @param mask is used to filter observers defaults to -1
  68565. */
  68566. notifyObserver(observer: Observer<T>, eventData: T, mask?: number): void;
  68567. /**
  68568. * Gets a boolean indicating if the observable has at least one observer
  68569. * @returns true is the Observable has at least one Observer registered
  68570. */
  68571. hasObservers(): boolean;
  68572. /**
  68573. * Clear the list of observers
  68574. */
  68575. clear(): void;
  68576. /**
  68577. * Clone the current observable
  68578. * @returns a new observable
  68579. */
  68580. clone(): Observable<T>;
  68581. /**
  68582. * Does this observable handles observer registered with a given mask
  68583. * @param mask defines the mask to be tested
  68584. * @return whether or not one observer registered with the given mask is handeled
  68585. **/
  68586. hasSpecificMask(mask?: number): boolean;
  68587. }
  68588. }
  68589. declare module BABYLON {
  68590. /**
  68591. * Sets of helpers dealing with the DOM and some of the recurrent functions needed in
  68592. * Babylon.js
  68593. */
  68594. export class DomManagement {
  68595. /**
  68596. * Checks if the window object exists
  68597. * @returns true if the window object exists
  68598. */
  68599. static IsWindowObjectExist(): boolean;
  68600. /**
  68601. * Checks if the navigator object exists
  68602. * @returns true if the navigator object exists
  68603. */
  68604. static IsNavigatorAvailable(): boolean;
  68605. /**
  68606. * Extracts text content from a DOM element hierarchy
  68607. * @param element defines the root element
  68608. * @returns a string
  68609. */
  68610. static GetDOMTextContent(element: HTMLElement): string;
  68611. }
  68612. }
  68613. declare module BABYLON {
  68614. /**
  68615. * Logger used througouht the application to allow configuration of
  68616. * the log level required for the messages.
  68617. */
  68618. export class Logger {
  68619. /**
  68620. * No log
  68621. */
  68622. static readonly NoneLogLevel: number;
  68623. /**
  68624. * Only message logs
  68625. */
  68626. static readonly MessageLogLevel: number;
  68627. /**
  68628. * Only warning logs
  68629. */
  68630. static readonly WarningLogLevel: number;
  68631. /**
  68632. * Only error logs
  68633. */
  68634. static readonly ErrorLogLevel: number;
  68635. /**
  68636. * All logs
  68637. */
  68638. static readonly AllLogLevel: number;
  68639. private static _LogCache;
  68640. /**
  68641. * Gets a value indicating the number of loading errors
  68642. * @ignorenaming
  68643. */
  68644. static errorsCount: number;
  68645. /**
  68646. * Callback called when a new log is added
  68647. */
  68648. static OnNewCacheEntry: (entry: string) => void;
  68649. private static _AddLogEntry;
  68650. private static _FormatMessage;
  68651. private static _LogDisabled;
  68652. private static _LogEnabled;
  68653. private static _WarnDisabled;
  68654. private static _WarnEnabled;
  68655. private static _ErrorDisabled;
  68656. private static _ErrorEnabled;
  68657. /**
  68658. * Log a message to the console
  68659. */
  68660. static Log: (message: string) => void;
  68661. /**
  68662. * Write a warning message to the console
  68663. */
  68664. static Warn: (message: string) => void;
  68665. /**
  68666. * Write an error message to the console
  68667. */
  68668. static Error: (message: string) => void;
  68669. /**
  68670. * Gets current log cache (list of logs)
  68671. */
  68672. static readonly LogCache: string;
  68673. /**
  68674. * Clears the log cache
  68675. */
  68676. static ClearLogCache(): void;
  68677. /**
  68678. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  68679. */
  68680. static LogLevels: number;
  68681. }
  68682. }
  68683. declare module BABYLON {
  68684. /** @hidden */
  68685. export class _TypeStore {
  68686. /** @hidden */
  68687. static RegisteredTypes: {
  68688. [key: string]: Object;
  68689. };
  68690. /** @hidden */
  68691. static GetClass(fqdn: string): any;
  68692. }
  68693. }
  68694. declare module BABYLON {
  68695. /**
  68696. * Helper to manipulate strings
  68697. */
  68698. export class StringTools {
  68699. /**
  68700. * Checks for a matching suffix at the end of a string (for ES5 and lower)
  68701. * @param str Source string
  68702. * @param suffix Suffix to search for in the source string
  68703. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  68704. */
  68705. static EndsWith(str: string, suffix: string): boolean;
  68706. /**
  68707. * Checks for a matching suffix at the beginning of a string (for ES5 and lower)
  68708. * @param str Source string
  68709. * @param suffix Suffix to search for in the source string
  68710. * @returns Boolean indicating whether the suffix was found (true) or not (false)
  68711. */
  68712. static StartsWith(str: string, suffix: string): boolean;
  68713. /**
  68714. * Decodes a buffer into a string
  68715. * @param buffer The buffer to decode
  68716. * @returns The decoded string
  68717. */
  68718. static Decode(buffer: Uint8Array | Uint16Array): string;
  68719. /**
  68720. * Encode a buffer to a base64 string
  68721. * @param buffer defines the buffer to encode
  68722. * @returns the encoded string
  68723. */
  68724. static EncodeArrayBufferToBase64(buffer: ArrayBuffer | ArrayBufferView): string;
  68725. }
  68726. }
  68727. declare module BABYLON {
  68728. /**
  68729. * Class containing a set of static utilities functions for deep copy.
  68730. */
  68731. export class DeepCopier {
  68732. /**
  68733. * Tries to copy an object by duplicating every property
  68734. * @param source defines the source object
  68735. * @param destination defines the target object
  68736. * @param doNotCopyList defines a list of properties to avoid
  68737. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  68738. */
  68739. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  68740. }
  68741. }
  68742. declare module BABYLON {
  68743. /**
  68744. * Class containing a set of static utilities functions for precision date
  68745. */
  68746. export class PrecisionDate {
  68747. /**
  68748. * Gets either window.performance.now() if supported or Date.now() else
  68749. */
  68750. static readonly Now: number;
  68751. }
  68752. }
  68753. declare module BABYLON {
  68754. /** @hidden */
  68755. export class _DevTools {
  68756. static WarnImport(name: string): string;
  68757. }
  68758. }
  68759. declare module BABYLON {
  68760. /**
  68761. * Interface used to define the mechanism to get data from the network
  68762. */
  68763. export interface IWebRequest {
  68764. /**
  68765. * Returns client's response url
  68766. */
  68767. responseURL: string;
  68768. /**
  68769. * Returns client's status
  68770. */
  68771. status: number;
  68772. /**
  68773. * Returns client's status as a text
  68774. */
  68775. statusText: string;
  68776. }
  68777. }
  68778. declare module BABYLON {
  68779. /**
  68780. * Extended version of XMLHttpRequest with support for customizations (headers, ...)
  68781. */
  68782. export class WebRequest implements IWebRequest {
  68783. private _xhr;
  68784. /**
  68785. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  68786. * i.e. when loading files, where the server/service expects an Authorization header
  68787. */
  68788. static CustomRequestHeaders: {
  68789. [key: string]: string;
  68790. };
  68791. /**
  68792. * Add callback functions in this array to update all the requests before they get sent to the network
  68793. */
  68794. static CustomRequestModifiers: ((request: XMLHttpRequest, url: string) => void)[];
  68795. private _injectCustomRequestHeaders;
  68796. /**
  68797. * Gets or sets a function to be called when loading progress changes
  68798. */
  68799. onprogress: ((this: XMLHttpRequest, ev: ProgressEvent) => any) | null;
  68800. /**
  68801. * Returns client's state
  68802. */
  68803. readonly readyState: number;
  68804. /**
  68805. * Returns client's status
  68806. */
  68807. readonly status: number;
  68808. /**
  68809. * Returns client's status as a text
  68810. */
  68811. readonly statusText: string;
  68812. /**
  68813. * Returns client's response
  68814. */
  68815. readonly response: any;
  68816. /**
  68817. * Returns client's response url
  68818. */
  68819. readonly responseURL: string;
  68820. /**
  68821. * Returns client's response as text
  68822. */
  68823. readonly responseText: string;
  68824. /**
  68825. * Gets or sets the expected response type
  68826. */
  68827. responseType: XMLHttpRequestResponseType;
  68828. /** @hidden */
  68829. addEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | AddEventListenerOptions): void;
  68830. /** @hidden */
  68831. removeEventListener<K extends keyof XMLHttpRequestEventMap>(type: K, listener: (this: XMLHttpRequest, ev: XMLHttpRequestEventMap[K]) => any, options?: boolean | EventListenerOptions): void;
  68832. /**
  68833. * Cancels any network activity
  68834. */
  68835. abort(): void;
  68836. /**
  68837. * Initiates the request. The optional argument provides the request body. The argument is ignored if request method is GET or HEAD
  68838. * @param body defines an optional request body
  68839. */
  68840. send(body?: Document | BodyInit | null): void;
  68841. /**
  68842. * Sets the request method, request URL
  68843. * @param method defines the method to use (GET, POST, etc..)
  68844. * @param url defines the url to connect with
  68845. */
  68846. open(method: string, url: string): void;
  68847. /**
  68848. * Sets the value of a request header.
  68849. * @param name The name of the header whose value is to be set
  68850. * @param value The value to set as the body of the header
  68851. */
  68852. setRequestHeader(name: string, value: string): void;
  68853. /**
  68854. * Get the string containing the text of a particular header's value.
  68855. * @param name The name of the header
  68856. * @returns The string containing the text of the given header name
  68857. */
  68858. getResponseHeader(name: string): Nullable<string>;
  68859. }
  68860. }
  68861. declare module BABYLON {
  68862. /**
  68863. * File request interface
  68864. */
  68865. export interface IFileRequest {
  68866. /**
  68867. * Raised when the request is complete (success or error).
  68868. */
  68869. onCompleteObservable: Observable<IFileRequest>;
  68870. /**
  68871. * Aborts the request for a file.
  68872. */
  68873. abort: () => void;
  68874. }
  68875. }
  68876. declare module BABYLON {
  68877. /**
  68878. * Define options used to create a render target texture
  68879. */
  68880. export class RenderTargetCreationOptions {
  68881. /**
  68882. * Specifies is mipmaps must be generated
  68883. */
  68884. generateMipMaps?: boolean;
  68885. /** Specifies whether or not a depth should be allocated in the texture (true by default) */
  68886. generateDepthBuffer?: boolean;
  68887. /** Specifies whether or not a stencil should be allocated in the texture (false by default)*/
  68888. generateStencilBuffer?: boolean;
  68889. /** Defines texture type (int by default) */
  68890. type?: number;
  68891. /** Defines sampling mode (trilinear by default) */
  68892. samplingMode?: number;
  68893. /** Defines format (RGBA by default) */
  68894. format?: number;
  68895. }
  68896. }
  68897. declare module BABYLON {
  68898. /**
  68899. * @hidden
  68900. **/
  68901. export class _TimeToken {
  68902. _startTimeQuery: Nullable<WebGLQuery>;
  68903. _endTimeQuery: Nullable<WebGLQuery>;
  68904. _timeElapsedQuery: Nullable<WebGLQuery>;
  68905. _timeElapsedQueryEnded: boolean;
  68906. }
  68907. }
  68908. declare module BABYLON {
  68909. /** Defines the cross module used constants to avoid circular dependncies */
  68910. export class Constants {
  68911. /** Defines that alpha blending is disabled */
  68912. static readonly ALPHA_DISABLE: number;
  68913. /** Defines that alpha blending to SRC ALPHA * SRC + DEST */
  68914. static readonly ALPHA_ADD: number;
  68915. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  68916. static readonly ALPHA_COMBINE: number;
  68917. /** Defines that alpha blending to DEST - SRC * DEST */
  68918. static readonly ALPHA_SUBTRACT: number;
  68919. /** Defines that alpha blending to SRC * DEST */
  68920. static readonly ALPHA_MULTIPLY: number;
  68921. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC) * DEST */
  68922. static readonly ALPHA_MAXIMIZED: number;
  68923. /** Defines that alpha blending to SRC + DEST */
  68924. static readonly ALPHA_ONEONE: number;
  68925. /** Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST */
  68926. static readonly ALPHA_PREMULTIPLIED: number;
  68927. /**
  68928. * Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST
  68929. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  68930. */
  68931. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  68932. /** Defines that alpha blending to CST * SRC + (1 - CST) * DEST */
  68933. static readonly ALPHA_INTERPOLATE: number;
  68934. /**
  68935. * Defines that alpha blending to SRC + (1 - SRC) * DEST
  68936. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  68937. */
  68938. static readonly ALPHA_SCREENMODE: number;
  68939. /**
  68940. * Defines that alpha blending to SRC + DST
  68941. * Alpha will be set to SRC ALPHA + DST ALPHA
  68942. */
  68943. static readonly ALPHA_ONEONE_ONEONE: number;
  68944. /**
  68945. * Defines that alpha blending to SRC * DST ALPHA + DST
  68946. * Alpha will be set to 0
  68947. */
  68948. static readonly ALPHA_ALPHATOCOLOR: number;
  68949. /**
  68950. * Defines that alpha blending to SRC * (1 - DST) + DST * (1 - SRC)
  68951. */
  68952. static readonly ALPHA_REVERSEONEMINUS: number;
  68953. /**
  68954. * Defines that alpha blending to SRC + DST * (1 - SRC ALPHA)
  68955. * Alpha will be set to SRC ALPHA + DST ALPHA * (1 - SRC ALPHA)
  68956. */
  68957. static readonly ALPHA_SRC_DSTONEMINUSSRCALPHA: number;
  68958. /**
  68959. * Defines that alpha blending to SRC + DST
  68960. * Alpha will be set to SRC ALPHA
  68961. */
  68962. static readonly ALPHA_ONEONE_ONEZERO: number;
  68963. /** Defines that alpha blending equation a SUM */
  68964. static readonly ALPHA_EQUATION_ADD: number;
  68965. /** Defines that alpha blending equation a SUBSTRACTION */
  68966. static readonly ALPHA_EQUATION_SUBSTRACT: number;
  68967. /** Defines that alpha blending equation a REVERSE SUBSTRACTION */
  68968. static readonly ALPHA_EQUATION_REVERSE_SUBTRACT: number;
  68969. /** Defines that alpha blending equation a MAX operation */
  68970. static readonly ALPHA_EQUATION_MAX: number;
  68971. /** Defines that alpha blending equation a MIN operation */
  68972. static readonly ALPHA_EQUATION_MIN: number;
  68973. /**
  68974. * Defines that alpha blending equation a DARKEN operation:
  68975. * It takes the min of the src and sums the alpha channels.
  68976. */
  68977. static readonly ALPHA_EQUATION_DARKEN: number;
  68978. /** Defines that the ressource is not delayed*/
  68979. static readonly DELAYLOADSTATE_NONE: number;
  68980. /** Defines that the ressource was successfully delay loaded */
  68981. static readonly DELAYLOADSTATE_LOADED: number;
  68982. /** Defines that the ressource is currently delay loading */
  68983. static readonly DELAYLOADSTATE_LOADING: number;
  68984. /** Defines that the ressource is delayed and has not started loading */
  68985. static readonly DELAYLOADSTATE_NOTLOADED: number;
  68986. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  68987. static readonly NEVER: number;
  68988. /** 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 */
  68989. static readonly ALWAYS: number;
  68990. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  68991. static readonly LESS: number;
  68992. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  68993. static readonly EQUAL: number;
  68994. /** 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 */
  68995. static readonly LEQUAL: number;
  68996. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  68997. static readonly GREATER: number;
  68998. /** 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 */
  68999. static readonly GEQUAL: number;
  69000. /** 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 */
  69001. static readonly NOTEQUAL: number;
  69002. /** Passed to stencilOperation to specify that stencil value must be kept */
  69003. static readonly KEEP: number;
  69004. /** Passed to stencilOperation to specify that stencil value must be replaced */
  69005. static readonly REPLACE: number;
  69006. /** Passed to stencilOperation to specify that stencil value must be incremented */
  69007. static readonly INCR: number;
  69008. /** Passed to stencilOperation to specify that stencil value must be decremented */
  69009. static readonly DECR: number;
  69010. /** Passed to stencilOperation to specify that stencil value must be inverted */
  69011. static readonly INVERT: number;
  69012. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  69013. static readonly INCR_WRAP: number;
  69014. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  69015. static readonly DECR_WRAP: number;
  69016. /** Texture is not repeating outside of 0..1 UVs */
  69017. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  69018. /** Texture is repeating outside of 0..1 UVs */
  69019. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  69020. /** Texture is repeating and mirrored */
  69021. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  69022. /** ALPHA */
  69023. static readonly TEXTUREFORMAT_ALPHA: number;
  69024. /** LUMINANCE */
  69025. static readonly TEXTUREFORMAT_LUMINANCE: number;
  69026. /** LUMINANCE_ALPHA */
  69027. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  69028. /** RGB */
  69029. static readonly TEXTUREFORMAT_RGB: number;
  69030. /** RGBA */
  69031. static readonly TEXTUREFORMAT_RGBA: number;
  69032. /** RED */
  69033. static readonly TEXTUREFORMAT_RED: number;
  69034. /** RED (2nd reference) */
  69035. static readonly TEXTUREFORMAT_R: number;
  69036. /** RG */
  69037. static readonly TEXTUREFORMAT_RG: number;
  69038. /** RED_INTEGER */
  69039. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  69040. /** RED_INTEGER (2nd reference) */
  69041. static readonly TEXTUREFORMAT_R_INTEGER: number;
  69042. /** RG_INTEGER */
  69043. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  69044. /** RGB_INTEGER */
  69045. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  69046. /** RGBA_INTEGER */
  69047. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  69048. /** UNSIGNED_BYTE */
  69049. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  69050. /** UNSIGNED_BYTE (2nd reference) */
  69051. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  69052. /** FLOAT */
  69053. static readonly TEXTURETYPE_FLOAT: number;
  69054. /** HALF_FLOAT */
  69055. static readonly TEXTURETYPE_HALF_FLOAT: number;
  69056. /** BYTE */
  69057. static readonly TEXTURETYPE_BYTE: number;
  69058. /** SHORT */
  69059. static readonly TEXTURETYPE_SHORT: number;
  69060. /** UNSIGNED_SHORT */
  69061. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  69062. /** INT */
  69063. static readonly TEXTURETYPE_INT: number;
  69064. /** UNSIGNED_INT */
  69065. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  69066. /** UNSIGNED_SHORT_4_4_4_4 */
  69067. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  69068. /** UNSIGNED_SHORT_5_5_5_1 */
  69069. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  69070. /** UNSIGNED_SHORT_5_6_5 */
  69071. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  69072. /** UNSIGNED_INT_2_10_10_10_REV */
  69073. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  69074. /** UNSIGNED_INT_24_8 */
  69075. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  69076. /** UNSIGNED_INT_10F_11F_11F_REV */
  69077. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  69078. /** UNSIGNED_INT_5_9_9_9_REV */
  69079. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  69080. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  69081. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  69082. /** nearest is mag = nearest and min = nearest and mip = nearest */
  69083. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  69084. /** Bilinear is mag = linear and min = linear and mip = nearest */
  69085. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  69086. /** Trilinear is mag = linear and min = linear and mip = linear */
  69087. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  69088. /** nearest is mag = nearest and min = nearest and mip = linear */
  69089. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  69090. /** Bilinear is mag = linear and min = linear and mip = nearest */
  69091. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  69092. /** Trilinear is mag = linear and min = linear and mip = linear */
  69093. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  69094. /** mag = nearest and min = nearest and mip = nearest */
  69095. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  69096. /** mag = nearest and min = linear and mip = nearest */
  69097. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  69098. /** mag = nearest and min = linear and mip = linear */
  69099. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  69100. /** mag = nearest and min = linear and mip = none */
  69101. static readonly TEXTURE_NEAREST_LINEAR: number;
  69102. /** mag = nearest and min = nearest and mip = none */
  69103. static readonly TEXTURE_NEAREST_NEAREST: number;
  69104. /** mag = linear and min = nearest and mip = nearest */
  69105. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  69106. /** mag = linear and min = nearest and mip = linear */
  69107. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  69108. /** mag = linear and min = linear and mip = none */
  69109. static readonly TEXTURE_LINEAR_LINEAR: number;
  69110. /** mag = linear and min = nearest and mip = none */
  69111. static readonly TEXTURE_LINEAR_NEAREST: number;
  69112. /** Explicit coordinates mode */
  69113. static readonly TEXTURE_EXPLICIT_MODE: number;
  69114. /** Spherical coordinates mode */
  69115. static readonly TEXTURE_SPHERICAL_MODE: number;
  69116. /** Planar coordinates mode */
  69117. static readonly TEXTURE_PLANAR_MODE: number;
  69118. /** Cubic coordinates mode */
  69119. static readonly TEXTURE_CUBIC_MODE: number;
  69120. /** Projection coordinates mode */
  69121. static readonly TEXTURE_PROJECTION_MODE: number;
  69122. /** Skybox coordinates mode */
  69123. static readonly TEXTURE_SKYBOX_MODE: number;
  69124. /** Inverse Cubic coordinates mode */
  69125. static readonly TEXTURE_INVCUBIC_MODE: number;
  69126. /** Equirectangular coordinates mode */
  69127. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  69128. /** Equirectangular Fixed coordinates mode */
  69129. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  69130. /** Equirectangular Fixed Mirrored coordinates mode */
  69131. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  69132. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  69133. static readonly SCALEMODE_FLOOR: number;
  69134. /** Defines that texture rescaling will look for the nearest power of 2 size */
  69135. static readonly SCALEMODE_NEAREST: number;
  69136. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  69137. static readonly SCALEMODE_CEILING: number;
  69138. /**
  69139. * The dirty texture flag value
  69140. */
  69141. static readonly MATERIAL_TextureDirtyFlag: number;
  69142. /**
  69143. * The dirty light flag value
  69144. */
  69145. static readonly MATERIAL_LightDirtyFlag: number;
  69146. /**
  69147. * The dirty fresnel flag value
  69148. */
  69149. static readonly MATERIAL_FresnelDirtyFlag: number;
  69150. /**
  69151. * The dirty attribute flag value
  69152. */
  69153. static readonly MATERIAL_AttributesDirtyFlag: number;
  69154. /**
  69155. * The dirty misc flag value
  69156. */
  69157. static readonly MATERIAL_MiscDirtyFlag: number;
  69158. /**
  69159. * The all dirty flag value
  69160. */
  69161. static readonly MATERIAL_AllDirtyFlag: number;
  69162. /**
  69163. * Returns the triangle fill mode
  69164. */
  69165. static readonly MATERIAL_TriangleFillMode: number;
  69166. /**
  69167. * Returns the wireframe mode
  69168. */
  69169. static readonly MATERIAL_WireFrameFillMode: number;
  69170. /**
  69171. * Returns the point fill mode
  69172. */
  69173. static readonly MATERIAL_PointFillMode: number;
  69174. /**
  69175. * Returns the point list draw mode
  69176. */
  69177. static readonly MATERIAL_PointListDrawMode: number;
  69178. /**
  69179. * Returns the line list draw mode
  69180. */
  69181. static readonly MATERIAL_LineListDrawMode: number;
  69182. /**
  69183. * Returns the line loop draw mode
  69184. */
  69185. static readonly MATERIAL_LineLoopDrawMode: number;
  69186. /**
  69187. * Returns the line strip draw mode
  69188. */
  69189. static readonly MATERIAL_LineStripDrawMode: number;
  69190. /**
  69191. * Returns the triangle strip draw mode
  69192. */
  69193. static readonly MATERIAL_TriangleStripDrawMode: number;
  69194. /**
  69195. * Returns the triangle fan draw mode
  69196. */
  69197. static readonly MATERIAL_TriangleFanDrawMode: number;
  69198. /**
  69199. * Stores the clock-wise side orientation
  69200. */
  69201. static readonly MATERIAL_ClockWiseSideOrientation: number;
  69202. /**
  69203. * Stores the counter clock-wise side orientation
  69204. */
  69205. static readonly MATERIAL_CounterClockWiseSideOrientation: number;
  69206. /**
  69207. * Nothing
  69208. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  69209. */
  69210. static readonly ACTION_NothingTrigger: number;
  69211. /**
  69212. * On pick
  69213. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  69214. */
  69215. static readonly ACTION_OnPickTrigger: number;
  69216. /**
  69217. * On left pick
  69218. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  69219. */
  69220. static readonly ACTION_OnLeftPickTrigger: number;
  69221. /**
  69222. * On right pick
  69223. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  69224. */
  69225. static readonly ACTION_OnRightPickTrigger: number;
  69226. /**
  69227. * On center pick
  69228. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  69229. */
  69230. static readonly ACTION_OnCenterPickTrigger: number;
  69231. /**
  69232. * On pick down
  69233. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  69234. */
  69235. static readonly ACTION_OnPickDownTrigger: number;
  69236. /**
  69237. * On double pick
  69238. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  69239. */
  69240. static readonly ACTION_OnDoublePickTrigger: number;
  69241. /**
  69242. * On pick up
  69243. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  69244. */
  69245. static readonly ACTION_OnPickUpTrigger: number;
  69246. /**
  69247. * On pick out.
  69248. * This trigger will only be raised if you also declared a OnPickDown
  69249. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  69250. */
  69251. static readonly ACTION_OnPickOutTrigger: number;
  69252. /**
  69253. * On long press
  69254. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  69255. */
  69256. static readonly ACTION_OnLongPressTrigger: number;
  69257. /**
  69258. * On pointer over
  69259. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  69260. */
  69261. static readonly ACTION_OnPointerOverTrigger: number;
  69262. /**
  69263. * On pointer out
  69264. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  69265. */
  69266. static readonly ACTION_OnPointerOutTrigger: number;
  69267. /**
  69268. * On every frame
  69269. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  69270. */
  69271. static readonly ACTION_OnEveryFrameTrigger: number;
  69272. /**
  69273. * On intersection enter
  69274. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  69275. */
  69276. static readonly ACTION_OnIntersectionEnterTrigger: number;
  69277. /**
  69278. * On intersection exit
  69279. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  69280. */
  69281. static readonly ACTION_OnIntersectionExitTrigger: number;
  69282. /**
  69283. * On key down
  69284. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  69285. */
  69286. static readonly ACTION_OnKeyDownTrigger: number;
  69287. /**
  69288. * On key up
  69289. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  69290. */
  69291. static readonly ACTION_OnKeyUpTrigger: number;
  69292. /**
  69293. * Billboard mode will only apply to Y axis
  69294. */
  69295. static readonly PARTICLES_BILLBOARDMODE_Y: number;
  69296. /**
  69297. * Billboard mode will apply to all axes
  69298. */
  69299. static readonly PARTICLES_BILLBOARDMODE_ALL: number;
  69300. /**
  69301. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  69302. */
  69303. static readonly PARTICLES_BILLBOARDMODE_STRETCHED: number;
  69304. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  69305. * Test order :
  69306. * Is the bounding sphere outside the frustum ?
  69307. * If not, are the bounding box vertices outside the frustum ?
  69308. * It not, then the cullable object is in the frustum.
  69309. */
  69310. static readonly MESHES_CULLINGSTRATEGY_STANDARD: number;
  69311. /** Culling strategy : Bounding Sphere Only.
  69312. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  69313. * It's also less accurate than the standard because some not visible objects can still be selected.
  69314. * Test : is the bounding sphere outside the frustum ?
  69315. * If not, then the cullable object is in the frustum.
  69316. */
  69317. static readonly MESHES_CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  69318. /** Culling strategy : Optimistic Inclusion.
  69319. * This in an inclusion test first, then the standard exclusion test.
  69320. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  69321. * 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.
  69322. * Anyway, it's as accurate as the standard strategy.
  69323. * Test :
  69324. * Is the cullable object bounding sphere center in the frustum ?
  69325. * If not, apply the default culling strategy.
  69326. */
  69327. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  69328. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  69329. * This in an inclusion test first, then the bounding sphere only exclusion test.
  69330. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  69331. * 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.
  69332. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  69333. * Test :
  69334. * Is the cullable object bounding sphere center in the frustum ?
  69335. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  69336. */
  69337. static readonly MESHES_CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  69338. /**
  69339. * No logging while loading
  69340. */
  69341. static readonly SCENELOADER_NO_LOGGING: number;
  69342. /**
  69343. * Minimal logging while loading
  69344. */
  69345. static readonly SCENELOADER_MINIMAL_LOGGING: number;
  69346. /**
  69347. * Summary logging while loading
  69348. */
  69349. static readonly SCENELOADER_SUMMARY_LOGGING: number;
  69350. /**
  69351. * Detailled logging while loading
  69352. */
  69353. static readonly SCENELOADER_DETAILED_LOGGING: number;
  69354. }
  69355. }
  69356. declare module BABYLON {
  69357. /**
  69358. * This represents the required contract to create a new type of texture loader.
  69359. */
  69360. export interface IInternalTextureLoader {
  69361. /**
  69362. * Defines wether the loader supports cascade loading the different faces.
  69363. */
  69364. supportCascades: boolean;
  69365. /**
  69366. * This returns if the loader support the current file information.
  69367. * @param extension defines the file extension of the file being loaded
  69368. * @param textureFormatInUse defines the current compressed format in use iun the engine
  69369. * @param fallback defines the fallback internal texture if any
  69370. * @param isBase64 defines whether the texture is encoded as a base64
  69371. * @param isBuffer defines whether the texture data are stored as a buffer
  69372. * @returns true if the loader can load the specified file
  69373. */
  69374. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  69375. /**
  69376. * Transform the url before loading if required.
  69377. * @param rootUrl the url of the texture
  69378. * @param textureFormatInUse defines the current compressed format in use iun the engine
  69379. * @returns the transformed texture
  69380. */
  69381. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  69382. /**
  69383. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  69384. * @param rootUrl the url of the texture
  69385. * @param textureFormatInUse defines the current compressed format in use iun the engine
  69386. * @returns the fallback texture
  69387. */
  69388. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  69389. /**
  69390. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  69391. * @param data contains the texture data
  69392. * @param texture defines the BabylonJS internal texture
  69393. * @param createPolynomials will be true if polynomials have been requested
  69394. * @param onLoad defines the callback to trigger once the texture is ready
  69395. * @param onError defines the callback to trigger in case of error
  69396. */
  69397. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  69398. /**
  69399. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  69400. * @param data contains the texture data
  69401. * @param texture defines the BabylonJS internal texture
  69402. * @param callback defines the method to call once ready to upload
  69403. */
  69404. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed?: boolean) => void): void;
  69405. }
  69406. }
  69407. declare module BABYLON {
  69408. /**
  69409. * Class used to store and describe the pipeline context associated with an effect
  69410. */
  69411. export interface IPipelineContext {
  69412. /**
  69413. * Gets a boolean indicating that this pipeline context is supporting asynchronous creating
  69414. */
  69415. isAsync: boolean;
  69416. /**
  69417. * Gets a boolean indicating that the context is ready to be used (like shaders / pipelines are compiled and ready for instance)
  69418. */
  69419. isReady: boolean;
  69420. /** @hidden */
  69421. _handlesSpectorRebuildCallback(onCompiled: (compiledObject: any) => void): void;
  69422. }
  69423. }
  69424. declare module BABYLON {
  69425. /**
  69426. * Class used to store gfx data (like WebGLBuffer)
  69427. */
  69428. export class DataBuffer {
  69429. /**
  69430. * Gets or sets the number of objects referencing this buffer
  69431. */
  69432. references: number;
  69433. /** Gets or sets the size of the underlying buffer */
  69434. capacity: number;
  69435. /**
  69436. * Gets or sets a boolean indicating if the buffer contains 32bits indices
  69437. */
  69438. is32Bits: boolean;
  69439. /**
  69440. * Gets the underlying buffer
  69441. */
  69442. readonly underlyingResource: any;
  69443. }
  69444. }
  69445. declare module BABYLON {
  69446. /** @hidden */
  69447. export interface IShaderProcessor {
  69448. attributeProcessor?: (attribute: string) => string;
  69449. varyingProcessor?: (varying: string, isFragment: boolean) => string;
  69450. uniformProcessor?: (uniform: string, isFragment: boolean) => string;
  69451. uniformBufferProcessor?: (uniformBuffer: string, isFragment: boolean) => string;
  69452. endOfUniformBufferProcessor?: (closingBracketLine: string, isFragment: boolean) => string;
  69453. lineProcessor?: (line: string, isFragment: boolean) => string;
  69454. preProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  69455. postProcessor?: (code: string, defines: string[], isFragment: boolean) => string;
  69456. }
  69457. }
  69458. declare module BABYLON {
  69459. /** @hidden */
  69460. export interface ProcessingOptions {
  69461. defines: string[];
  69462. indexParameters: any;
  69463. isFragment: boolean;
  69464. shouldUseHighPrecisionShader: boolean;
  69465. supportsUniformBuffers: boolean;
  69466. shadersRepository: string;
  69467. includesShadersStore: {
  69468. [key: string]: string;
  69469. };
  69470. processor?: IShaderProcessor;
  69471. version: string;
  69472. platformName: string;
  69473. lookForClosingBracketForUniformBuffer?: boolean;
  69474. }
  69475. }
  69476. declare module BABYLON {
  69477. /** @hidden */
  69478. export class ShaderCodeNode {
  69479. line: string;
  69480. children: ShaderCodeNode[];
  69481. additionalDefineKey?: string;
  69482. additionalDefineValue?: string;
  69483. isValid(preprocessors: {
  69484. [key: string]: string;
  69485. }): boolean;
  69486. process(preprocessors: {
  69487. [key: string]: string;
  69488. }, options: ProcessingOptions): string;
  69489. }
  69490. }
  69491. declare module BABYLON {
  69492. /** @hidden */
  69493. export class ShaderCodeCursor {
  69494. private _lines;
  69495. lineIndex: number;
  69496. readonly currentLine: string;
  69497. readonly canRead: boolean;
  69498. lines: string[];
  69499. }
  69500. }
  69501. declare module BABYLON {
  69502. /** @hidden */
  69503. export class ShaderCodeConditionNode extends ShaderCodeNode {
  69504. process(preprocessors: {
  69505. [key: string]: string;
  69506. }, options: ProcessingOptions): string;
  69507. }
  69508. }
  69509. declare module BABYLON {
  69510. /** @hidden */
  69511. export class ShaderDefineExpression {
  69512. isTrue(preprocessors: {
  69513. [key: string]: string;
  69514. }): boolean;
  69515. }
  69516. }
  69517. declare module BABYLON {
  69518. /** @hidden */
  69519. export class ShaderCodeTestNode extends ShaderCodeNode {
  69520. testExpression: ShaderDefineExpression;
  69521. isValid(preprocessors: {
  69522. [key: string]: string;
  69523. }): boolean;
  69524. }
  69525. }
  69526. declare module BABYLON {
  69527. /** @hidden */
  69528. export class ShaderDefineIsDefinedOperator extends ShaderDefineExpression {
  69529. define: string;
  69530. not: boolean;
  69531. constructor(define: string, not?: boolean);
  69532. isTrue(preprocessors: {
  69533. [key: string]: string;
  69534. }): boolean;
  69535. }
  69536. }
  69537. declare module BABYLON {
  69538. /** @hidden */
  69539. export class ShaderDefineOrOperator extends ShaderDefineExpression {
  69540. leftOperand: ShaderDefineExpression;
  69541. rightOperand: ShaderDefineExpression;
  69542. isTrue(preprocessors: {
  69543. [key: string]: string;
  69544. }): boolean;
  69545. }
  69546. }
  69547. declare module BABYLON {
  69548. /** @hidden */
  69549. export class ShaderDefineAndOperator extends ShaderDefineExpression {
  69550. leftOperand: ShaderDefineExpression;
  69551. rightOperand: ShaderDefineExpression;
  69552. isTrue(preprocessors: {
  69553. [key: string]: string;
  69554. }): boolean;
  69555. }
  69556. }
  69557. declare module BABYLON {
  69558. /** @hidden */
  69559. export class ShaderDefineArithmeticOperator extends ShaderDefineExpression {
  69560. define: string;
  69561. operand: string;
  69562. testValue: string;
  69563. constructor(define: string, operand: string, testValue: string);
  69564. isTrue(preprocessors: {
  69565. [key: string]: string;
  69566. }): boolean;
  69567. }
  69568. }
  69569. declare module BABYLON {
  69570. /**
  69571. * Class used to enable access to offline support
  69572. * @see http://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  69573. */
  69574. export interface IOfflineProvider {
  69575. /**
  69576. * Gets a boolean indicating if scene must be saved in the database
  69577. */
  69578. enableSceneOffline: boolean;
  69579. /**
  69580. * Gets a boolean indicating if textures must be saved in the database
  69581. */
  69582. enableTexturesOffline: boolean;
  69583. /**
  69584. * Open the offline support and make it available
  69585. * @param successCallback defines the callback to call on success
  69586. * @param errorCallback defines the callback to call on error
  69587. */
  69588. open(successCallback: () => void, errorCallback: () => void): void;
  69589. /**
  69590. * Loads an image from the offline support
  69591. * @param url defines the url to load from
  69592. * @param image defines the target DOM image
  69593. */
  69594. loadImage(url: string, image: HTMLImageElement): void;
  69595. /**
  69596. * Loads a file from offline support
  69597. * @param url defines the URL to load from
  69598. * @param sceneLoaded defines a callback to call on success
  69599. * @param progressCallBack defines a callback to call when progress changed
  69600. * @param errorCallback defines a callback to call on error
  69601. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  69602. */
  69603. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  69604. }
  69605. }
  69606. declare module BABYLON {
  69607. /**
  69608. * Class used to help managing file picking and drag'n'drop
  69609. * File Storage
  69610. */
  69611. export class FilesInputStore {
  69612. /**
  69613. * List of files ready to be loaded
  69614. */
  69615. static FilesToLoad: {
  69616. [key: string]: File;
  69617. };
  69618. }
  69619. }
  69620. declare module BABYLON {
  69621. /**
  69622. * Class used to define a retry strategy when error happens while loading assets
  69623. */
  69624. export class RetryStrategy {
  69625. /**
  69626. * Function used to defines an exponential back off strategy
  69627. * @param maxRetries defines the maximum number of retries (3 by default)
  69628. * @param baseInterval defines the interval between retries
  69629. * @returns the strategy function to use
  69630. */
  69631. static ExponentialBackoff(maxRetries?: number, baseInterval?: number): (url: string, request: WebRequest, retryIndex: number) => number;
  69632. }
  69633. }
  69634. declare module BABYLON {
  69635. /**
  69636. * @ignore
  69637. * Application error to support additional information when loading a file
  69638. */
  69639. export abstract class BaseError extends Error {
  69640. protected static _setPrototypeOf: (o: any, proto: object | null) => any;
  69641. }
  69642. }
  69643. declare module BABYLON {
  69644. /** @ignore */
  69645. export class LoadFileError extends BaseError {
  69646. request?: WebRequest;
  69647. file?: File;
  69648. /**
  69649. * Creates a new LoadFileError
  69650. * @param message defines the message of the error
  69651. * @param request defines the optional web request
  69652. * @param file defines the optional file
  69653. */
  69654. constructor(message: string, object?: WebRequest | File);
  69655. }
  69656. /** @ignore */
  69657. export class RequestFileError extends BaseError {
  69658. request: WebRequest;
  69659. /**
  69660. * Creates a new LoadFileError
  69661. * @param message defines the message of the error
  69662. * @param request defines the optional web request
  69663. */
  69664. constructor(message: string, request: WebRequest);
  69665. }
  69666. /** @ignore */
  69667. export class ReadFileError extends BaseError {
  69668. file: File;
  69669. /**
  69670. * Creates a new ReadFileError
  69671. * @param message defines the message of the error
  69672. * @param file defines the optional file
  69673. */
  69674. constructor(message: string, file: File);
  69675. }
  69676. /**
  69677. * @hidden
  69678. */
  69679. export class FileTools {
  69680. /**
  69681. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  69682. */
  69683. static DefaultRetryStrategy: (url: string, request: WebRequest, retryIndex: number) => number;
  69684. /**
  69685. * Gets or sets the base URL to use to load assets
  69686. */
  69687. static BaseUrl: string;
  69688. /**
  69689. * Default behaviour for cors in the application.
  69690. * It can be a string if the expected behavior is identical in the entire app.
  69691. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  69692. */
  69693. static CorsBehavior: string | ((url: string | string[]) => string);
  69694. /**
  69695. * Gets or sets a function used to pre-process url before using them to load assets
  69696. */
  69697. static PreprocessUrl: (url: string) => string;
  69698. /**
  69699. * Removes unwanted characters from an url
  69700. * @param url defines the url to clean
  69701. * @returns the cleaned url
  69702. */
  69703. private static _CleanUrl;
  69704. /**
  69705. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  69706. * @param url define the url we are trying
  69707. * @param element define the dom element where to configure the cors policy
  69708. */
  69709. static SetCorsBehavior(url: string | string[], element: {
  69710. crossOrigin: string | null;
  69711. }): void;
  69712. /**
  69713. * Loads an image as an HTMLImageElement.
  69714. * @param input url string, ArrayBuffer, or Blob to load
  69715. * @param onLoad callback called when the image successfully loads
  69716. * @param onError callback called when the image fails to load
  69717. * @param offlineProvider offline provider for caching
  69718. * @param mimeType optional mime type
  69719. * @returns the HTMLImageElement of the loaded image
  69720. */
  69721. 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>;
  69722. /**
  69723. * Reads a file from a File object
  69724. * @param file defines the file to load
  69725. * @param onSuccess defines the callback to call when data is loaded
  69726. * @param onProgress defines the callback to call during loading process
  69727. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  69728. * @param onError defines the callback to call when an error occurs
  69729. * @returns a file request object
  69730. */
  69731. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  69732. /**
  69733. * Loads a file from a url
  69734. * @param url url to load
  69735. * @param onSuccess callback called when the file successfully loads
  69736. * @param onProgress callback called while file is loading (if the server supports this mode)
  69737. * @param offlineProvider defines the offline provider for caching
  69738. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  69739. * @param onError callback called when the file fails to load
  69740. * @returns a file request object
  69741. */
  69742. 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;
  69743. /**
  69744. * Loads a file
  69745. * @param url url to load
  69746. * @param onSuccess callback called when the file successfully loads
  69747. * @param onProgress callback called while file is loading (if the server supports this mode)
  69748. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  69749. * @param onError callback called when the file fails to load
  69750. * @param onOpened callback called when the web request is opened
  69751. * @returns a file request object
  69752. */
  69753. 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;
  69754. /**
  69755. * Checks if the loaded document was accessed via `file:`-Protocol.
  69756. * @returns boolean
  69757. */
  69758. static IsFileURL(): boolean;
  69759. }
  69760. }
  69761. declare module BABYLON {
  69762. /** @hidden */
  69763. export class ShaderProcessor {
  69764. static Process(sourceCode: string, options: ProcessingOptions, callback: (migratedCode: string) => void): void;
  69765. private static _ProcessPrecision;
  69766. private static _ExtractOperation;
  69767. private static _BuildSubExpression;
  69768. private static _BuildExpression;
  69769. private static _MoveCursorWithinIf;
  69770. private static _MoveCursor;
  69771. private static _EvaluatePreProcessors;
  69772. private static _PreparePreProcessors;
  69773. private static _ProcessShaderConversion;
  69774. private static _ProcessIncludes;
  69775. }
  69776. }
  69777. declare module BABYLON {
  69778. /**
  69779. * @hidden
  69780. */
  69781. export interface IColor4Like {
  69782. r: float;
  69783. g: float;
  69784. b: float;
  69785. a: float;
  69786. }
  69787. /**
  69788. * @hidden
  69789. */
  69790. export interface IColor3Like {
  69791. r: float;
  69792. g: float;
  69793. b: float;
  69794. }
  69795. /**
  69796. * @hidden
  69797. */
  69798. export interface IVector4Like {
  69799. x: float;
  69800. y: float;
  69801. z: float;
  69802. w: float;
  69803. }
  69804. /**
  69805. * @hidden
  69806. */
  69807. export interface IVector3Like {
  69808. x: float;
  69809. y: float;
  69810. z: float;
  69811. }
  69812. /**
  69813. * @hidden
  69814. */
  69815. export interface IVector2Like {
  69816. x: float;
  69817. y: float;
  69818. }
  69819. /**
  69820. * @hidden
  69821. */
  69822. export interface IMatrixLike {
  69823. toArray(): DeepImmutable<Float32Array>;
  69824. updateFlag: int;
  69825. }
  69826. /**
  69827. * @hidden
  69828. */
  69829. export interface IViewportLike {
  69830. x: float;
  69831. y: float;
  69832. width: float;
  69833. height: float;
  69834. }
  69835. /**
  69836. * @hidden
  69837. */
  69838. export interface IPlaneLike {
  69839. normal: IVector3Like;
  69840. d: float;
  69841. normalize(): void;
  69842. }
  69843. }
  69844. declare module BABYLON {
  69845. /**
  69846. * Interface used to define common properties for effect fallbacks
  69847. */
  69848. export interface IEffectFallbacks {
  69849. /**
  69850. * Removes the defines that should be removed when falling back.
  69851. * @param currentDefines defines the current define statements for the shader.
  69852. * @param effect defines the current effect we try to compile
  69853. * @returns The resulting defines with defines of the current rank removed.
  69854. */
  69855. reduce(currentDefines: string, effect: Effect): string;
  69856. /**
  69857. * Removes the fallback from the bound mesh.
  69858. */
  69859. unBindMesh(): void;
  69860. /**
  69861. * Checks to see if more fallbacks are still availible.
  69862. */
  69863. hasMoreFallbacks: boolean;
  69864. }
  69865. }
  69866. declare module BABYLON {
  69867. /**
  69868. * Class used to evalaute queries containing `and` and `or` operators
  69869. */
  69870. export class AndOrNotEvaluator {
  69871. /**
  69872. * Evaluate a query
  69873. * @param query defines the query to evaluate
  69874. * @param evaluateCallback defines the callback used to filter result
  69875. * @returns true if the query matches
  69876. */
  69877. static Eval(query: string, evaluateCallback: (val: any) => boolean): boolean;
  69878. private static _HandleParenthesisContent;
  69879. private static _SimplifyNegation;
  69880. }
  69881. }
  69882. declare module BABYLON {
  69883. /**
  69884. * Class used to store custom tags
  69885. */
  69886. export class Tags {
  69887. /**
  69888. * Adds support for tags on the given object
  69889. * @param obj defines the object to use
  69890. */
  69891. static EnableFor(obj: any): void;
  69892. /**
  69893. * Removes tags support
  69894. * @param obj defines the object to use
  69895. */
  69896. static DisableFor(obj: any): void;
  69897. /**
  69898. * Gets a boolean indicating if the given object has tags
  69899. * @param obj defines the object to use
  69900. * @returns a boolean
  69901. */
  69902. static HasTags(obj: any): boolean;
  69903. /**
  69904. * Gets the tags available on a given object
  69905. * @param obj defines the object to use
  69906. * @param asString defines if the tags must be returned as a string instead of an array of strings
  69907. * @returns the tags
  69908. */
  69909. static GetTags(obj: any, asString?: boolean): any;
  69910. /**
  69911. * Adds tags to an object
  69912. * @param obj defines the object to use
  69913. * @param tagsString defines the tag string. The tags 'true' and 'false' are reserved and cannot be used as tags.
  69914. * A tag cannot start with '||', '&&', and '!'. It cannot contain whitespaces
  69915. */
  69916. static AddTagsTo(obj: any, tagsString: string): void;
  69917. /**
  69918. * @hidden
  69919. */
  69920. static _AddTagTo(obj: any, tag: string): void;
  69921. /**
  69922. * Removes specific tags from a specific object
  69923. * @param obj defines the object to use
  69924. * @param tagsString defines the tags to remove
  69925. */
  69926. static RemoveTagsFrom(obj: any, tagsString: string): void;
  69927. /**
  69928. * @hidden
  69929. */
  69930. static _RemoveTagFrom(obj: any, tag: string): void;
  69931. /**
  69932. * Defines if tags hosted on an object match a given query
  69933. * @param obj defines the object to use
  69934. * @param tagsQuery defines the tag query
  69935. * @returns a boolean
  69936. */
  69937. static MatchesQuery(obj: any, tagsQuery: string): boolean;
  69938. }
  69939. }
  69940. declare module BABYLON {
  69941. /**
  69942. * Scalar computation library
  69943. */
  69944. export class Scalar {
  69945. /**
  69946. * Two pi constants convenient for computation.
  69947. */
  69948. static TwoPi: number;
  69949. /**
  69950. * Boolean : true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  69951. * @param a number
  69952. * @param b number
  69953. * @param epsilon (default = 1.401298E-45)
  69954. * @returns true if the absolute difference between a and b is lower than epsilon (default = 1.401298E-45)
  69955. */
  69956. static WithinEpsilon(a: number, b: number, epsilon?: number): boolean;
  69957. /**
  69958. * Returns a string : the upper case translation of the number i to hexadecimal.
  69959. * @param i number
  69960. * @returns the upper case translation of the number i to hexadecimal.
  69961. */
  69962. static ToHex(i: number): string;
  69963. /**
  69964. * Returns -1 if value is negative and +1 is value is positive.
  69965. * @param value the value
  69966. * @returns the value itself if it's equal to zero.
  69967. */
  69968. static Sign(value: number): number;
  69969. /**
  69970. * Returns the value itself if it's between min and max.
  69971. * Returns min if the value is lower than min.
  69972. * Returns max if the value is greater than max.
  69973. * @param value the value to clmap
  69974. * @param min the min value to clamp to (default: 0)
  69975. * @param max the max value to clamp to (default: 1)
  69976. * @returns the clamped value
  69977. */
  69978. static Clamp(value: number, min?: number, max?: number): number;
  69979. /**
  69980. * the log2 of value.
  69981. * @param value the value to compute log2 of
  69982. * @returns the log2 of value.
  69983. */
  69984. static Log2(value: number): number;
  69985. /**
  69986. * Loops the value, so that it is never larger than length and never smaller than 0.
  69987. *
  69988. * This is similar to the modulo operator but it works with floating point numbers.
  69989. * For example, using 3.0 for t and 2.5 for length, the result would be 0.5.
  69990. * With t = 5 and length = 2.5, the result would be 0.0.
  69991. * Note, however, that the behaviour is not defined for negative numbers as it is for the modulo operator
  69992. * @param value the value
  69993. * @param length the length
  69994. * @returns the looped value
  69995. */
  69996. static Repeat(value: number, length: number): number;
  69997. /**
  69998. * Normalize the value between 0.0 and 1.0 using min and max values
  69999. * @param value value to normalize
  70000. * @param min max to normalize between
  70001. * @param max min to normalize between
  70002. * @returns the normalized value
  70003. */
  70004. static Normalize(value: number, min: number, max: number): number;
  70005. /**
  70006. * Denormalize the value from 0.0 and 1.0 using min and max values
  70007. * @param normalized value to denormalize
  70008. * @param min max to denormalize between
  70009. * @param max min to denormalize between
  70010. * @returns the denormalized value
  70011. */
  70012. static Denormalize(normalized: number, min: number, max: number): number;
  70013. /**
  70014. * Calculates the shortest difference between two given angles given in degrees.
  70015. * @param current current angle in degrees
  70016. * @param target target angle in degrees
  70017. * @returns the delta
  70018. */
  70019. static DeltaAngle(current: number, target: number): number;
  70020. /**
  70021. * PingPongs the value t, so that it is never larger than length and never smaller than 0.
  70022. * @param tx value
  70023. * @param length length
  70024. * @returns The returned value will move back and forth between 0 and length
  70025. */
  70026. static PingPong(tx: number, length: number): number;
  70027. /**
  70028. * Interpolates between min and max with smoothing at the limits.
  70029. *
  70030. * This function interpolates between min and max in a similar way to Lerp. However, the interpolation will gradually speed up
  70031. * from the start and slow down toward the end. This is useful for creating natural-looking animation, fading and other transitions.
  70032. * @param from from
  70033. * @param to to
  70034. * @param tx value
  70035. * @returns the smooth stepped value
  70036. */
  70037. static SmoothStep(from: number, to: number, tx: number): number;
  70038. /**
  70039. * Moves a value current towards target.
  70040. *
  70041. * This is essentially the same as Mathf.Lerp but instead the function will ensure that the speed never exceeds maxDelta.
  70042. * Negative values of maxDelta pushes the value away from target.
  70043. * @param current current value
  70044. * @param target target value
  70045. * @param maxDelta max distance to move
  70046. * @returns resulting value
  70047. */
  70048. static MoveTowards(current: number, target: number, maxDelta: number): number;
  70049. /**
  70050. * Same as MoveTowards but makes sure the values interpolate correctly when they wrap around 360 degrees.
  70051. *
  70052. * Variables current and target are assumed to be in degrees. For optimization reasons, negative values of maxDelta
  70053. * are not supported and may cause oscillation. To push current away from a target angle, add 180 to that angle instead.
  70054. * @param current current value
  70055. * @param target target value
  70056. * @param maxDelta max distance to move
  70057. * @returns resulting angle
  70058. */
  70059. static MoveTowardsAngle(current: number, target: number, maxDelta: number): number;
  70060. /**
  70061. * Creates a new scalar with values linearly interpolated of "amount" between the start scalar and the end scalar.
  70062. * @param start start value
  70063. * @param end target value
  70064. * @param amount amount to lerp between
  70065. * @returns the lerped value
  70066. */
  70067. static Lerp(start: number, end: number, amount: number): number;
  70068. /**
  70069. * Same as Lerp but makes sure the values interpolate correctly when they wrap around 360 degrees.
  70070. * The parameter t is clamped to the range [0, 1]. Variables a and b are assumed to be in degrees.
  70071. * @param start start value
  70072. * @param end target value
  70073. * @param amount amount to lerp between
  70074. * @returns the lerped value
  70075. */
  70076. static LerpAngle(start: number, end: number, amount: number): number;
  70077. /**
  70078. * Calculates the linear parameter t that produces the interpolant value within the range [a, b].
  70079. * @param a start value
  70080. * @param b target value
  70081. * @param value value between a and b
  70082. * @returns the inverseLerp value
  70083. */
  70084. static InverseLerp(a: number, b: number, value: number): number;
  70085. /**
  70086. * Returns a new scalar located for "amount" (float) on the Hermite spline defined by the scalars "value1", "value3", "tangent1", "tangent2".
  70087. * @see http://mathworld.wolfram.com/HermitePolynomial.html
  70088. * @param value1 spline value
  70089. * @param tangent1 spline value
  70090. * @param value2 spline value
  70091. * @param tangent2 spline value
  70092. * @param amount input value
  70093. * @returns hermite result
  70094. */
  70095. static Hermite(value1: number, tangent1: number, value2: number, tangent2: number, amount: number): number;
  70096. /**
  70097. * Returns a random float number between and min and max values
  70098. * @param min min value of random
  70099. * @param max max value of random
  70100. * @returns random value
  70101. */
  70102. static RandomRange(min: number, max: number): number;
  70103. /**
  70104. * This function returns percentage of a number in a given range.
  70105. *
  70106. * RangeToPercent(40,20,60) will return 0.5 (50%)
  70107. * RangeToPercent(34,0,100) will return 0.34 (34%)
  70108. * @param number to convert to percentage
  70109. * @param min min range
  70110. * @param max max range
  70111. * @returns the percentage
  70112. */
  70113. static RangeToPercent(number: number, min: number, max: number): number;
  70114. /**
  70115. * This function returns number that corresponds to the percentage in a given range.
  70116. *
  70117. * PercentToRange(0.34,0,100) will return 34.
  70118. * @param percent to convert to number
  70119. * @param min min range
  70120. * @param max max range
  70121. * @returns the number
  70122. */
  70123. static PercentToRange(percent: number, min: number, max: number): number;
  70124. /**
  70125. * Returns the angle converted to equivalent value between -Math.PI and Math.PI radians.
  70126. * @param angle The angle to normalize in radian.
  70127. * @return The converted angle.
  70128. */
  70129. static NormalizeRadians(angle: number): number;
  70130. }
  70131. }
  70132. declare module BABYLON {
  70133. /**
  70134. * Constant used to convert a value to gamma space
  70135. * @ignorenaming
  70136. */
  70137. export const ToGammaSpace: number;
  70138. /**
  70139. * Constant used to convert a value to linear space
  70140. * @ignorenaming
  70141. */
  70142. export const ToLinearSpace = 2.2;
  70143. /**
  70144. * Constant used to define the minimal number value in Babylon.js
  70145. * @ignorenaming
  70146. */
  70147. let Epsilon: number;
  70148. }
  70149. declare module BABYLON {
  70150. /**
  70151. * Class used to represent a viewport on screen
  70152. */
  70153. export class Viewport {
  70154. /** viewport left coordinate */
  70155. x: number;
  70156. /** viewport top coordinate */
  70157. y: number;
  70158. /**viewport width */
  70159. width: number;
  70160. /** viewport height */
  70161. height: number;
  70162. /**
  70163. * Creates a Viewport object located at (x, y) and sized (width, height)
  70164. * @param x defines viewport left coordinate
  70165. * @param y defines viewport top coordinate
  70166. * @param width defines the viewport width
  70167. * @param height defines the viewport height
  70168. */
  70169. constructor(
  70170. /** viewport left coordinate */
  70171. x: number,
  70172. /** viewport top coordinate */
  70173. y: number,
  70174. /**viewport width */
  70175. width: number,
  70176. /** viewport height */
  70177. height: number);
  70178. /**
  70179. * Creates a new viewport using absolute sizing (from 0-> width, 0-> height instead of 0->1)
  70180. * @param renderWidth defines the rendering width
  70181. * @param renderHeight defines the rendering height
  70182. * @returns a new Viewport
  70183. */
  70184. toGlobal(renderWidth: number, renderHeight: number): Viewport;
  70185. /**
  70186. * Stores absolute viewport value into a target viewport (from 0-> width, 0-> height instead of 0->1)
  70187. * @param renderWidth defines the rendering width
  70188. * @param renderHeight defines the rendering height
  70189. * @param ref defines the target viewport
  70190. * @returns the current viewport
  70191. */
  70192. toGlobalToRef(renderWidth: number, renderHeight: number, ref: Viewport): Viewport;
  70193. /**
  70194. * Returns a new Viewport copied from the current one
  70195. * @returns a new Viewport
  70196. */
  70197. clone(): Viewport;
  70198. }
  70199. }
  70200. declare module BABYLON {
  70201. /**
  70202. * Class containing a set of static utilities functions for arrays.
  70203. */
  70204. export class ArrayTools {
  70205. /**
  70206. * Returns an array of the given size filled with element built from the given constructor and the paramters
  70207. * @param size the number of element to construct and put in the array
  70208. * @param itemBuilder a callback responsible for creating new instance of item. Called once per array entry.
  70209. * @returns a new array filled with new objects
  70210. */
  70211. static BuildArray<T>(size: number, itemBuilder: () => T): Array<T>;
  70212. }
  70213. }
  70214. declare module BABYLON {
  70215. /**
  70216. * Class representing a vector containing 2 coordinates
  70217. */
  70218. export class Vector2 {
  70219. /** defines the first coordinate */
  70220. x: number;
  70221. /** defines the second coordinate */
  70222. y: number;
  70223. /**
  70224. * Creates a new Vector2 from the given x and y coordinates
  70225. * @param x defines the first coordinate
  70226. * @param y defines the second coordinate
  70227. */
  70228. constructor(
  70229. /** defines the first coordinate */
  70230. x?: number,
  70231. /** defines the second coordinate */
  70232. y?: number);
  70233. /**
  70234. * Gets a string with the Vector2 coordinates
  70235. * @returns a string with the Vector2 coordinates
  70236. */
  70237. toString(): string;
  70238. /**
  70239. * Gets class name
  70240. * @returns the string "Vector2"
  70241. */
  70242. getClassName(): string;
  70243. /**
  70244. * Gets current vector hash code
  70245. * @returns the Vector2 hash code as a number
  70246. */
  70247. getHashCode(): number;
  70248. /**
  70249. * Sets the Vector2 coordinates in the given array or Float32Array from the given index.
  70250. * @param array defines the source array
  70251. * @param index defines the offset in source array
  70252. * @returns the current Vector2
  70253. */
  70254. toArray(array: FloatArray, index?: number): Vector2;
  70255. /**
  70256. * Copy the current vector to an array
  70257. * @returns a new array with 2 elements: the Vector2 coordinates.
  70258. */
  70259. asArray(): number[];
  70260. /**
  70261. * Sets the Vector2 coordinates with the given Vector2 coordinates
  70262. * @param source defines the source Vector2
  70263. * @returns the current updated Vector2
  70264. */
  70265. copyFrom(source: DeepImmutable<Vector2>): Vector2;
  70266. /**
  70267. * Sets the Vector2 coordinates with the given floats
  70268. * @param x defines the first coordinate
  70269. * @param y defines the second coordinate
  70270. * @returns the current updated Vector2
  70271. */
  70272. copyFromFloats(x: number, y: number): Vector2;
  70273. /**
  70274. * Sets the Vector2 coordinates with the given floats
  70275. * @param x defines the first coordinate
  70276. * @param y defines the second coordinate
  70277. * @returns the current updated Vector2
  70278. */
  70279. set(x: number, y: number): Vector2;
  70280. /**
  70281. * Add another vector with the current one
  70282. * @param otherVector defines the other vector
  70283. * @returns a new Vector2 set with the addition of the current Vector2 and the given one coordinates
  70284. */
  70285. add(otherVector: DeepImmutable<Vector2>): Vector2;
  70286. /**
  70287. * Sets the "result" coordinates with the addition of the current Vector2 and the given one coordinates
  70288. * @param otherVector defines the other vector
  70289. * @param result defines the target vector
  70290. * @returns the unmodified current Vector2
  70291. */
  70292. addToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  70293. /**
  70294. * Set the Vector2 coordinates by adding the given Vector2 coordinates
  70295. * @param otherVector defines the other vector
  70296. * @returns the current updated Vector2
  70297. */
  70298. addInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  70299. /**
  70300. * Gets a new Vector2 by adding the current Vector2 coordinates to the given Vector3 x, y coordinates
  70301. * @param otherVector defines the other vector
  70302. * @returns a new Vector2
  70303. */
  70304. addVector3(otherVector: Vector3): Vector2;
  70305. /**
  70306. * Gets a new Vector2 set with the subtracted coordinates of the given one from the current Vector2
  70307. * @param otherVector defines the other vector
  70308. * @returns a new Vector2
  70309. */
  70310. subtract(otherVector: Vector2): Vector2;
  70311. /**
  70312. * Sets the "result" coordinates with the subtraction of the given one from the current Vector2 coordinates.
  70313. * @param otherVector defines the other vector
  70314. * @param result defines the target vector
  70315. * @returns the unmodified current Vector2
  70316. */
  70317. subtractToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  70318. /**
  70319. * Sets the current Vector2 coordinates by subtracting from it the given one coordinates
  70320. * @param otherVector defines the other vector
  70321. * @returns the current updated Vector2
  70322. */
  70323. subtractInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  70324. /**
  70325. * Multiplies in place the current Vector2 coordinates by the given ones
  70326. * @param otherVector defines the other vector
  70327. * @returns the current updated Vector2
  70328. */
  70329. multiplyInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  70330. /**
  70331. * Returns a new Vector2 set with the multiplication of the current Vector2 and the given one coordinates
  70332. * @param otherVector defines the other vector
  70333. * @returns a new Vector2
  70334. */
  70335. multiply(otherVector: DeepImmutable<Vector2>): Vector2;
  70336. /**
  70337. * Sets "result" coordinates with the multiplication of the current Vector2 and the given one coordinates
  70338. * @param otherVector defines the other vector
  70339. * @param result defines the target vector
  70340. * @returns the unmodified current Vector2
  70341. */
  70342. multiplyToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  70343. /**
  70344. * Gets a new Vector2 set with the Vector2 coordinates multiplied by the given floats
  70345. * @param x defines the first coordinate
  70346. * @param y defines the second coordinate
  70347. * @returns a new Vector2
  70348. */
  70349. multiplyByFloats(x: number, y: number): Vector2;
  70350. /**
  70351. * Returns a new Vector2 set with the Vector2 coordinates divided by the given one coordinates
  70352. * @param otherVector defines the other vector
  70353. * @returns a new Vector2
  70354. */
  70355. divide(otherVector: Vector2): Vector2;
  70356. /**
  70357. * Sets the "result" coordinates with the Vector2 divided by the given one coordinates
  70358. * @param otherVector defines the other vector
  70359. * @param result defines the target vector
  70360. * @returns the unmodified current Vector2
  70361. */
  70362. divideToRef(otherVector: DeepImmutable<Vector2>, result: Vector2): Vector2;
  70363. /**
  70364. * Divides the current Vector2 coordinates by the given ones
  70365. * @param otherVector defines the other vector
  70366. * @returns the current updated Vector2
  70367. */
  70368. divideInPlace(otherVector: DeepImmutable<Vector2>): Vector2;
  70369. /**
  70370. * Gets a new Vector2 with current Vector2 negated coordinates
  70371. * @returns a new Vector2
  70372. */
  70373. negate(): Vector2;
  70374. /**
  70375. * Multiply the Vector2 coordinates by scale
  70376. * @param scale defines the scaling factor
  70377. * @returns the current updated Vector2
  70378. */
  70379. scaleInPlace(scale: number): Vector2;
  70380. /**
  70381. * Returns a new Vector2 scaled by "scale" from the current Vector2
  70382. * @param scale defines the scaling factor
  70383. * @returns a new Vector2
  70384. */
  70385. scale(scale: number): Vector2;
  70386. /**
  70387. * Scale the current Vector2 values by a factor to a given Vector2
  70388. * @param scale defines the scale factor
  70389. * @param result defines the Vector2 object where to store the result
  70390. * @returns the unmodified current Vector2
  70391. */
  70392. scaleToRef(scale: number, result: Vector2): Vector2;
  70393. /**
  70394. * Scale the current Vector2 values by a factor and add the result to a given Vector2
  70395. * @param scale defines the scale factor
  70396. * @param result defines the Vector2 object where to store the result
  70397. * @returns the unmodified current Vector2
  70398. */
  70399. scaleAndAddToRef(scale: number, result: Vector2): Vector2;
  70400. /**
  70401. * Gets a boolean if two vectors are equals
  70402. * @param otherVector defines the other vector
  70403. * @returns true if the given vector coordinates strictly equal the current Vector2 ones
  70404. */
  70405. equals(otherVector: DeepImmutable<Vector2>): boolean;
  70406. /**
  70407. * Gets a boolean if two vectors are equals (using an epsilon value)
  70408. * @param otherVector defines the other vector
  70409. * @param epsilon defines the minimal distance to consider equality
  70410. * @returns true if the given vector coordinates are close to the current ones by a distance of epsilon.
  70411. */
  70412. equalsWithEpsilon(otherVector: DeepImmutable<Vector2>, epsilon?: number): boolean;
  70413. /**
  70414. * Gets a new Vector2 from current Vector2 floored values
  70415. * @returns a new Vector2
  70416. */
  70417. floor(): Vector2;
  70418. /**
  70419. * Gets a new Vector2 from current Vector2 floored values
  70420. * @returns a new Vector2
  70421. */
  70422. fract(): Vector2;
  70423. /**
  70424. * Gets the length of the vector
  70425. * @returns the vector length (float)
  70426. */
  70427. length(): number;
  70428. /**
  70429. * Gets the vector squared length
  70430. * @returns the vector squared length (float)
  70431. */
  70432. lengthSquared(): number;
  70433. /**
  70434. * Normalize the vector
  70435. * @returns the current updated Vector2
  70436. */
  70437. normalize(): Vector2;
  70438. /**
  70439. * Gets a new Vector2 copied from the Vector2
  70440. * @returns a new Vector2
  70441. */
  70442. clone(): Vector2;
  70443. /**
  70444. * Gets a new Vector2(0, 0)
  70445. * @returns a new Vector2
  70446. */
  70447. static Zero(): Vector2;
  70448. /**
  70449. * Gets a new Vector2(1, 1)
  70450. * @returns a new Vector2
  70451. */
  70452. static One(): Vector2;
  70453. /**
  70454. * Gets a new Vector2 set from the given index element of the given array
  70455. * @param array defines the data source
  70456. * @param offset defines the offset in the data source
  70457. * @returns a new Vector2
  70458. */
  70459. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector2;
  70460. /**
  70461. * Sets "result" from the given index element of the given array
  70462. * @param array defines the data source
  70463. * @param offset defines the offset in the data source
  70464. * @param result defines the target vector
  70465. */
  70466. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector2): void;
  70467. /**
  70468. * Gets a new Vector2 located for "amount" (float) on the CatmullRom spline defined by the given four Vector2
  70469. * @param value1 defines 1st point of control
  70470. * @param value2 defines 2nd point of control
  70471. * @param value3 defines 3rd point of control
  70472. * @param value4 defines 4th point of control
  70473. * @param amount defines the interpolation factor
  70474. * @returns a new Vector2
  70475. */
  70476. static CatmullRom(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, value3: DeepImmutable<Vector2>, value4: DeepImmutable<Vector2>, amount: number): Vector2;
  70477. /**
  70478. * 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".
  70479. * If a coordinate of "value" is lower than "min" coordinates, the returned Vector2 is given this "min" coordinate.
  70480. * If a coordinate of "value" is greater than "max" coordinates, the returned Vector2 is given this "max" coordinate
  70481. * @param value defines the value to clamp
  70482. * @param min defines the lower limit
  70483. * @param max defines the upper limit
  70484. * @returns a new Vector2
  70485. */
  70486. static Clamp(value: DeepImmutable<Vector2>, min: DeepImmutable<Vector2>, max: DeepImmutable<Vector2>): Vector2;
  70487. /**
  70488. * Returns a new Vector2 located for "amount" (float) on the Hermite spline defined by the vectors "value1", "value3", "tangent1", "tangent2"
  70489. * @param value1 defines the 1st control point
  70490. * @param tangent1 defines the outgoing tangent
  70491. * @param value2 defines the 2nd control point
  70492. * @param tangent2 defines the incoming tangent
  70493. * @param amount defines the interpolation factor
  70494. * @returns a new Vector2
  70495. */
  70496. static Hermite(value1: DeepImmutable<Vector2>, tangent1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>, tangent2: DeepImmutable<Vector2>, amount: number): Vector2;
  70497. /**
  70498. * Returns a new Vector2 located for "amount" (float) on the linear interpolation between the vector "start" adn the vector "end".
  70499. * @param start defines the start vector
  70500. * @param end defines the end vector
  70501. * @param amount defines the interpolation factor
  70502. * @returns a new Vector2
  70503. */
  70504. static Lerp(start: DeepImmutable<Vector2>, end: DeepImmutable<Vector2>, amount: number): Vector2;
  70505. /**
  70506. * Gets the dot product of the vector "left" and the vector "right"
  70507. * @param left defines first vector
  70508. * @param right defines second vector
  70509. * @returns the dot product (float)
  70510. */
  70511. static Dot(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): number;
  70512. /**
  70513. * Returns a new Vector2 equal to the normalized given vector
  70514. * @param vector defines the vector to normalize
  70515. * @returns a new Vector2
  70516. */
  70517. static Normalize(vector: DeepImmutable<Vector2>): Vector2;
  70518. /**
  70519. * Gets a new Vector2 set with the minimal coordinate values from the "left" and "right" vectors
  70520. * @param left defines 1st vector
  70521. * @param right defines 2nd vector
  70522. * @returns a new Vector2
  70523. */
  70524. static Minimize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  70525. /**
  70526. * Gets a new Vecto2 set with the maximal coordinate values from the "left" and "right" vectors
  70527. * @param left defines 1st vector
  70528. * @param right defines 2nd vector
  70529. * @returns a new Vector2
  70530. */
  70531. static Maximize(left: DeepImmutable<Vector2>, right: DeepImmutable<Vector2>): Vector2;
  70532. /**
  70533. * Gets a new Vector2 set with the transformed coordinates of the given vector by the given transformation matrix
  70534. * @param vector defines the vector to transform
  70535. * @param transformation defines the matrix to apply
  70536. * @returns a new Vector2
  70537. */
  70538. static Transform(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>): Vector2;
  70539. /**
  70540. * Transforms the given vector coordinates by the given transformation matrix and stores the result in the vector "result" coordinates
  70541. * @param vector defines the vector to transform
  70542. * @param transformation defines the matrix to apply
  70543. * @param result defines the target vector
  70544. */
  70545. static TransformToRef(vector: DeepImmutable<Vector2>, transformation: DeepImmutable<Matrix>, result: Vector2): void;
  70546. /**
  70547. * Determines if a given vector is included in a triangle
  70548. * @param p defines the vector to test
  70549. * @param p0 defines 1st triangle point
  70550. * @param p1 defines 2nd triangle point
  70551. * @param p2 defines 3rd triangle point
  70552. * @returns true if the point "p" is in the triangle defined by the vertors "p0", "p1", "p2"
  70553. */
  70554. static PointInTriangle(p: DeepImmutable<Vector2>, p0: DeepImmutable<Vector2>, p1: DeepImmutable<Vector2>, p2: DeepImmutable<Vector2>): boolean;
  70555. /**
  70556. * Gets the distance between the vectors "value1" and "value2"
  70557. * @param value1 defines first vector
  70558. * @param value2 defines second vector
  70559. * @returns the distance between vectors
  70560. */
  70561. static Distance(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  70562. /**
  70563. * Returns the squared distance between the vectors "value1" and "value2"
  70564. * @param value1 defines first vector
  70565. * @param value2 defines second vector
  70566. * @returns the squared distance between vectors
  70567. */
  70568. static DistanceSquared(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): number;
  70569. /**
  70570. * Gets a new Vector2 located at the center of the vectors "value1" and "value2"
  70571. * @param value1 defines first vector
  70572. * @param value2 defines second vector
  70573. * @returns a new Vector2
  70574. */
  70575. static Center(value1: DeepImmutable<Vector2>, value2: DeepImmutable<Vector2>): Vector2;
  70576. /**
  70577. * Gets the shortest distance (float) between the point "p" and the segment defined by the two points "segA" and "segB".
  70578. * @param p defines the middle point
  70579. * @param segA defines one point of the segment
  70580. * @param segB defines the other point of the segment
  70581. * @returns the shortest distance
  70582. */
  70583. static DistanceOfPointFromSegment(p: DeepImmutable<Vector2>, segA: DeepImmutable<Vector2>, segB: DeepImmutable<Vector2>): number;
  70584. }
  70585. /**
  70586. * Classed used to store (x,y,z) vector representation
  70587. * A Vector3 is the main object used in 3D geometry
  70588. * It can represent etiher the coordinates of a point the space, either a direction
  70589. * Reminder: js uses a left handed forward facing system
  70590. */
  70591. export class Vector3 {
  70592. /**
  70593. * Defines the first coordinates (on X axis)
  70594. */
  70595. x: number;
  70596. /**
  70597. * Defines the second coordinates (on Y axis)
  70598. */
  70599. y: number;
  70600. /**
  70601. * Defines the third coordinates (on Z axis)
  70602. */
  70603. z: number;
  70604. private static _UpReadOnly;
  70605. private static _ZeroReadOnly;
  70606. /**
  70607. * Creates a new Vector3 object from the given x, y, z (floats) coordinates.
  70608. * @param x defines the first coordinates (on X axis)
  70609. * @param y defines the second coordinates (on Y axis)
  70610. * @param z defines the third coordinates (on Z axis)
  70611. */
  70612. constructor(
  70613. /**
  70614. * Defines the first coordinates (on X axis)
  70615. */
  70616. x?: number,
  70617. /**
  70618. * Defines the second coordinates (on Y axis)
  70619. */
  70620. y?: number,
  70621. /**
  70622. * Defines the third coordinates (on Z axis)
  70623. */
  70624. z?: number);
  70625. /**
  70626. * Creates a string representation of the Vector3
  70627. * @returns a string with the Vector3 coordinates.
  70628. */
  70629. toString(): string;
  70630. /**
  70631. * Gets the class name
  70632. * @returns the string "Vector3"
  70633. */
  70634. getClassName(): string;
  70635. /**
  70636. * Creates the Vector3 hash code
  70637. * @returns a number which tends to be unique between Vector3 instances
  70638. */
  70639. getHashCode(): number;
  70640. /**
  70641. * Creates an array containing three elements : the coordinates of the Vector3
  70642. * @returns a new array of numbers
  70643. */
  70644. asArray(): number[];
  70645. /**
  70646. * Populates the given array or Float32Array from the given index with the successive coordinates of the Vector3
  70647. * @param array defines the destination array
  70648. * @param index defines the offset in the destination array
  70649. * @returns the current Vector3
  70650. */
  70651. toArray(array: FloatArray, index?: number): Vector3;
  70652. /**
  70653. * Converts the current Vector3 into a quaternion (considering that the Vector3 contains Euler angles representation of a rotation)
  70654. * @returns a new Quaternion object, computed from the Vector3 coordinates
  70655. */
  70656. toQuaternion(): Quaternion;
  70657. /**
  70658. * Adds the given vector to the current Vector3
  70659. * @param otherVector defines the second operand
  70660. * @returns the current updated Vector3
  70661. */
  70662. addInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  70663. /**
  70664. * Adds the given coordinates to the current Vector3
  70665. * @param x defines the x coordinate of the operand
  70666. * @param y defines the y coordinate of the operand
  70667. * @param z defines the z coordinate of the operand
  70668. * @returns the current updated Vector3
  70669. */
  70670. addInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  70671. /**
  70672. * Gets a new Vector3, result of the addition the current Vector3 and the given vector
  70673. * @param otherVector defines the second operand
  70674. * @returns the resulting Vector3
  70675. */
  70676. add(otherVector: DeepImmutable<Vector3>): Vector3;
  70677. /**
  70678. * Adds the current Vector3 to the given one and stores the result in the vector "result"
  70679. * @param otherVector defines the second operand
  70680. * @param result defines the Vector3 object where to store the result
  70681. * @returns the current Vector3
  70682. */
  70683. addToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  70684. /**
  70685. * Subtract the given vector from the current Vector3
  70686. * @param otherVector defines the second operand
  70687. * @returns the current updated Vector3
  70688. */
  70689. subtractInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  70690. /**
  70691. * Returns a new Vector3, result of the subtraction of the given vector from the current Vector3
  70692. * @param otherVector defines the second operand
  70693. * @returns the resulting Vector3
  70694. */
  70695. subtract(otherVector: DeepImmutable<Vector3>): Vector3;
  70696. /**
  70697. * Subtracts the given vector from the current Vector3 and stores the result in the vector "result".
  70698. * @param otherVector defines the second operand
  70699. * @param result defines the Vector3 object where to store the result
  70700. * @returns the current Vector3
  70701. */
  70702. subtractToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  70703. /**
  70704. * Returns a new Vector3 set with the subtraction of the given floats from the current Vector3 coordinates
  70705. * @param x defines the x coordinate of the operand
  70706. * @param y defines the y coordinate of the operand
  70707. * @param z defines the z coordinate of the operand
  70708. * @returns the resulting Vector3
  70709. */
  70710. subtractFromFloats(x: number, y: number, z: number): Vector3;
  70711. /**
  70712. * Subtracts the given floats from the current Vector3 coordinates and set the given vector "result" with this result
  70713. * @param x defines the x coordinate of the operand
  70714. * @param y defines the y coordinate of the operand
  70715. * @param z defines the z coordinate of the operand
  70716. * @param result defines the Vector3 object where to store the result
  70717. * @returns the current Vector3
  70718. */
  70719. subtractFromFloatsToRef(x: number, y: number, z: number, result: Vector3): Vector3;
  70720. /**
  70721. * Gets a new Vector3 set with the current Vector3 negated coordinates
  70722. * @returns a new Vector3
  70723. */
  70724. negate(): Vector3;
  70725. /**
  70726. * Multiplies the Vector3 coordinates by the float "scale"
  70727. * @param scale defines the multiplier factor
  70728. * @returns the current updated Vector3
  70729. */
  70730. scaleInPlace(scale: number): Vector3;
  70731. /**
  70732. * Returns a new Vector3 set with the current Vector3 coordinates multiplied by the float "scale"
  70733. * @param scale defines the multiplier factor
  70734. * @returns a new Vector3
  70735. */
  70736. scale(scale: number): Vector3;
  70737. /**
  70738. * Multiplies the current Vector3 coordinates by the float "scale" and stores the result in the given vector "result" coordinates
  70739. * @param scale defines the multiplier factor
  70740. * @param result defines the Vector3 object where to store the result
  70741. * @returns the current Vector3
  70742. */
  70743. scaleToRef(scale: number, result: Vector3): Vector3;
  70744. /**
  70745. * Scale the current Vector3 values by a factor and add the result to a given Vector3
  70746. * @param scale defines the scale factor
  70747. * @param result defines the Vector3 object where to store the result
  70748. * @returns the unmodified current Vector3
  70749. */
  70750. scaleAndAddToRef(scale: number, result: Vector3): Vector3;
  70751. /**
  70752. * Returns true if the current Vector3 and the given vector coordinates are strictly equal
  70753. * @param otherVector defines the second operand
  70754. * @returns true if both vectors are equals
  70755. */
  70756. equals(otherVector: DeepImmutable<Vector3>): boolean;
  70757. /**
  70758. * Returns true if the current Vector3 and the given vector coordinates are distant less than epsilon
  70759. * @param otherVector defines the second operand
  70760. * @param epsilon defines the minimal distance to define values as equals
  70761. * @returns true if both vectors are distant less than epsilon
  70762. */
  70763. equalsWithEpsilon(otherVector: DeepImmutable<Vector3>, epsilon?: number): boolean;
  70764. /**
  70765. * Returns true if the current Vector3 coordinates equals the given floats
  70766. * @param x defines the x coordinate of the operand
  70767. * @param y defines the y coordinate of the operand
  70768. * @param z defines the z coordinate of the operand
  70769. * @returns true if both vectors are equals
  70770. */
  70771. equalsToFloats(x: number, y: number, z: number): boolean;
  70772. /**
  70773. * Multiplies the current Vector3 coordinates by the given ones
  70774. * @param otherVector defines the second operand
  70775. * @returns the current updated Vector3
  70776. */
  70777. multiplyInPlace(otherVector: DeepImmutable<Vector3>): Vector3;
  70778. /**
  70779. * Returns a new Vector3, result of the multiplication of the current Vector3 by the given vector
  70780. * @param otherVector defines the second operand
  70781. * @returns the new Vector3
  70782. */
  70783. multiply(otherVector: DeepImmutable<Vector3>): Vector3;
  70784. /**
  70785. * Multiplies the current Vector3 by the given one and stores the result in the given vector "result"
  70786. * @param otherVector defines the second operand
  70787. * @param result defines the Vector3 object where to store the result
  70788. * @returns the current Vector3
  70789. */
  70790. multiplyToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  70791. /**
  70792. * Returns a new Vector3 set with the result of the mulliplication of the current Vector3 coordinates by the given floats
  70793. * @param x defines the x coordinate of the operand
  70794. * @param y defines the y coordinate of the operand
  70795. * @param z defines the z coordinate of the operand
  70796. * @returns the new Vector3
  70797. */
  70798. multiplyByFloats(x: number, y: number, z: number): Vector3;
  70799. /**
  70800. * Returns a new Vector3 set with the result of the division of the current Vector3 coordinates by the given ones
  70801. * @param otherVector defines the second operand
  70802. * @returns the new Vector3
  70803. */
  70804. divide(otherVector: DeepImmutable<Vector3>): Vector3;
  70805. /**
  70806. * Divides the current Vector3 coordinates by the given ones and stores the result in the given vector "result"
  70807. * @param otherVector defines the second operand
  70808. * @param result defines the Vector3 object where to store the result
  70809. * @returns the current Vector3
  70810. */
  70811. divideToRef(otherVector: DeepImmutable<Vector3>, result: Vector3): Vector3;
  70812. /**
  70813. * Divides the current Vector3 coordinates by the given ones.
  70814. * @param otherVector defines the second operand
  70815. * @returns the current updated Vector3
  70816. */
  70817. divideInPlace(otherVector: Vector3): Vector3;
  70818. /**
  70819. * Updates the current Vector3 with the minimal coordinate values between its and the given vector ones
  70820. * @param other defines the second operand
  70821. * @returns the current updated Vector3
  70822. */
  70823. minimizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  70824. /**
  70825. * Updates the current Vector3 with the maximal coordinate values between its and the given vector ones.
  70826. * @param other defines the second operand
  70827. * @returns the current updated Vector3
  70828. */
  70829. maximizeInPlace(other: DeepImmutable<Vector3>): Vector3;
  70830. /**
  70831. * Updates the current Vector3 with the minimal coordinate values between its and the given coordinates
  70832. * @param x defines the x coordinate of the operand
  70833. * @param y defines the y coordinate of the operand
  70834. * @param z defines the z coordinate of the operand
  70835. * @returns the current updated Vector3
  70836. */
  70837. minimizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  70838. /**
  70839. * Updates the current Vector3 with the maximal coordinate values between its and the given coordinates.
  70840. * @param x defines the x coordinate of the operand
  70841. * @param y defines the y coordinate of the operand
  70842. * @param z defines the z coordinate of the operand
  70843. * @returns the current updated Vector3
  70844. */
  70845. maximizeInPlaceFromFloats(x: number, y: number, z: number): Vector3;
  70846. /**
  70847. * Due to float precision, scale of a mesh could be uniform but float values are off by a small fraction
  70848. * Check if is non uniform within a certain amount of decimal places to account for this
  70849. * @param epsilon the amount the values can differ
  70850. * @returns if the the vector is non uniform to a certain number of decimal places
  70851. */
  70852. isNonUniformWithinEpsilon(epsilon: number): boolean;
  70853. /**
  70854. * Gets a boolean indicating that the vector is non uniform meaning x, y or z are not all the same
  70855. */
  70856. readonly isNonUniform: boolean;
  70857. /**
  70858. * Gets a new Vector3 from current Vector3 floored values
  70859. * @returns a new Vector3
  70860. */
  70861. floor(): Vector3;
  70862. /**
  70863. * Gets a new Vector3 from current Vector3 floored values
  70864. * @returns a new Vector3
  70865. */
  70866. fract(): Vector3;
  70867. /**
  70868. * Gets the length of the Vector3
  70869. * @returns the length of the Vector3
  70870. */
  70871. length(): number;
  70872. /**
  70873. * Gets the squared length of the Vector3
  70874. * @returns squared length of the Vector3
  70875. */
  70876. lengthSquared(): number;
  70877. /**
  70878. * Normalize the current Vector3.
  70879. * Please note that this is an in place operation.
  70880. * @returns the current updated Vector3
  70881. */
  70882. normalize(): Vector3;
  70883. /**
  70884. * Reorders the x y z properties of the vector in place
  70885. * @param order new ordering of the properties (eg. for vector 1,2,3 with "ZYX" will produce 3,2,1)
  70886. * @returns the current updated vector
  70887. */
  70888. reorderInPlace(order: string): this;
  70889. /**
  70890. * Rotates the vector around 0,0,0 by a quaternion
  70891. * @param quaternion the rotation quaternion
  70892. * @param result vector to store the result
  70893. * @returns the resulting vector
  70894. */
  70895. rotateByQuaternionToRef(quaternion: Quaternion, result: Vector3): Vector3;
  70896. /**
  70897. * Rotates a vector around a given point
  70898. * @param quaternion the rotation quaternion
  70899. * @param point the point to rotate around
  70900. * @param result vector to store the result
  70901. * @returns the resulting vector
  70902. */
  70903. rotateByQuaternionAroundPointToRef(quaternion: Quaternion, point: Vector3, result: Vector3): Vector3;
  70904. /**
  70905. * Returns a new Vector3 as the cross product of the current vector and the "other" one
  70906. * The cross product is then orthogonal to both current and "other"
  70907. * @param other defines the right operand
  70908. * @returns the cross product
  70909. */
  70910. cross(other: Vector3): Vector3;
  70911. /**
  70912. * Normalize the current Vector3 with the given input length.
  70913. * Please note that this is an in place operation.
  70914. * @param len the length of the vector
  70915. * @returns the current updated Vector3
  70916. */
  70917. normalizeFromLength(len: number): Vector3;
  70918. /**
  70919. * Normalize the current Vector3 to a new vector
  70920. * @returns the new Vector3
  70921. */
  70922. normalizeToNew(): Vector3;
  70923. /**
  70924. * Normalize the current Vector3 to the reference
  70925. * @param reference define the Vector3 to update
  70926. * @returns the updated Vector3
  70927. */
  70928. normalizeToRef(reference: DeepImmutable<Vector3>): Vector3;
  70929. /**
  70930. * Creates a new Vector3 copied from the current Vector3
  70931. * @returns the new Vector3
  70932. */
  70933. clone(): Vector3;
  70934. /**
  70935. * Copies the given vector coordinates to the current Vector3 ones
  70936. * @param source defines the source Vector3
  70937. * @returns the current updated Vector3
  70938. */
  70939. copyFrom(source: DeepImmutable<Vector3>): Vector3;
  70940. /**
  70941. * Copies the given floats to the current Vector3 coordinates
  70942. * @param x defines the x coordinate of the operand
  70943. * @param y defines the y coordinate of the operand
  70944. * @param z defines the z coordinate of the operand
  70945. * @returns the current updated Vector3
  70946. */
  70947. copyFromFloats(x: number, y: number, z: number): Vector3;
  70948. /**
  70949. * Copies the given floats to the current Vector3 coordinates
  70950. * @param x defines the x coordinate of the operand
  70951. * @param y defines the y coordinate of the operand
  70952. * @param z defines the z coordinate of the operand
  70953. * @returns the current updated Vector3
  70954. */
  70955. set(x: number, y: number, z: number): Vector3;
  70956. /**
  70957. * Copies the given float to the current Vector3 coordinates
  70958. * @param v defines the x, y and z coordinates of the operand
  70959. * @returns the current updated Vector3
  70960. */
  70961. setAll(v: number): Vector3;
  70962. /**
  70963. * Get the clip factor between two vectors
  70964. * @param vector0 defines the first operand
  70965. * @param vector1 defines the second operand
  70966. * @param axis defines the axis to use
  70967. * @param size defines the size along the axis
  70968. * @returns the clip factor
  70969. */
  70970. static GetClipFactor(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, axis: DeepImmutable<Vector3>, size: number): number;
  70971. /**
  70972. * Get angle between two vectors
  70973. * @param vector0 angle between vector0 and vector1
  70974. * @param vector1 angle between vector0 and vector1
  70975. * @param normal direction of the normal
  70976. * @return the angle between vector0 and vector1
  70977. */
  70978. static GetAngleBetweenVectors(vector0: DeepImmutable<Vector3>, vector1: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>): number;
  70979. /**
  70980. * Returns a new Vector3 set from the index "offset" of the given array
  70981. * @param array defines the source array
  70982. * @param offset defines the offset in the source array
  70983. * @returns the new Vector3
  70984. */
  70985. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector3;
  70986. /**
  70987. * Returns a new Vector3 set from the index "offset" of the given Float32Array
  70988. * This function is deprecated. Use FromArray instead
  70989. * @param array defines the source array
  70990. * @param offset defines the offset in the source array
  70991. * @returns the new Vector3
  70992. */
  70993. static FromFloatArray(array: DeepImmutable<Float32Array>, offset?: number): Vector3;
  70994. /**
  70995. * Sets the given vector "result" with the element values from the index "offset" of the given array
  70996. * @param array defines the source array
  70997. * @param offset defines the offset in the source array
  70998. * @param result defines the Vector3 where to store the result
  70999. */
  71000. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector3): void;
  71001. /**
  71002. * Sets the given vector "result" with the element values from the index "offset" of the given Float32Array
  71003. * This function is deprecated. Use FromArrayToRef instead.
  71004. * @param array defines the source array
  71005. * @param offset defines the offset in the source array
  71006. * @param result defines the Vector3 where to store the result
  71007. */
  71008. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector3): void;
  71009. /**
  71010. * Sets the given vector "result" with the given floats.
  71011. * @param x defines the x coordinate of the source
  71012. * @param y defines the y coordinate of the source
  71013. * @param z defines the z coordinate of the source
  71014. * @param result defines the Vector3 where to store the result
  71015. */
  71016. static FromFloatsToRef(x: number, y: number, z: number, result: Vector3): void;
  71017. /**
  71018. * Returns a new Vector3 set to (0.0, 0.0, 0.0)
  71019. * @returns a new empty Vector3
  71020. */
  71021. static Zero(): Vector3;
  71022. /**
  71023. * Returns a new Vector3 set to (1.0, 1.0, 1.0)
  71024. * @returns a new unit Vector3
  71025. */
  71026. static One(): Vector3;
  71027. /**
  71028. * Returns a new Vector3 set to (0.0, 1.0, 0.0)
  71029. * @returns a new up Vector3
  71030. */
  71031. static Up(): Vector3;
  71032. /**
  71033. * Gets a up Vector3 that must not be updated
  71034. */
  71035. static readonly UpReadOnly: DeepImmutable<Vector3>;
  71036. /**
  71037. * Gets a zero Vector3 that must not be updated
  71038. */
  71039. static readonly ZeroReadOnly: DeepImmutable<Vector3>;
  71040. /**
  71041. * Returns a new Vector3 set to (0.0, -1.0, 0.0)
  71042. * @returns a new down Vector3
  71043. */
  71044. static Down(): Vector3;
  71045. /**
  71046. * Returns a new Vector3 set to (0.0, 0.0, 1.0)
  71047. * @returns a new forward Vector3
  71048. */
  71049. static Forward(): Vector3;
  71050. /**
  71051. * Returns a new Vector3 set to (0.0, 0.0, -1.0)
  71052. * @returns a new forward Vector3
  71053. */
  71054. static Backward(): Vector3;
  71055. /**
  71056. * Returns a new Vector3 set to (1.0, 0.0, 0.0)
  71057. * @returns a new right Vector3
  71058. */
  71059. static Right(): Vector3;
  71060. /**
  71061. * Returns a new Vector3 set to (-1.0, 0.0, 0.0)
  71062. * @returns a new left Vector3
  71063. */
  71064. static Left(): Vector3;
  71065. /**
  71066. * Returns a new Vector3 set with the result of the transformation by the given matrix of the given vector.
  71067. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  71068. * @param vector defines the Vector3 to transform
  71069. * @param transformation defines the transformation matrix
  71070. * @returns the transformed Vector3
  71071. */
  71072. static TransformCoordinates(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  71073. /**
  71074. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given vector
  71075. * This method computes tranformed coordinates only, not transformed direction vectors (ie. it takes translation in account)
  71076. * @param vector defines the Vector3 to transform
  71077. * @param transformation defines the transformation matrix
  71078. * @param result defines the Vector3 where to store the result
  71079. */
  71080. static TransformCoordinatesToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  71081. /**
  71082. * Sets the given vector "result" coordinates with the result of the transformation by the given matrix of the given floats (x, y, z)
  71083. * This method computes tranformed coordinates only, not transformed direction vectors
  71084. * @param x define the x coordinate of the source vector
  71085. * @param y define the y coordinate of the source vector
  71086. * @param z define the z coordinate of the source vector
  71087. * @param transformation defines the transformation matrix
  71088. * @param result defines the Vector3 where to store the result
  71089. */
  71090. static TransformCoordinatesFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  71091. /**
  71092. * Returns a new Vector3 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 (ie. it does not apply translation)
  71094. * @param vector defines the Vector3 to transform
  71095. * @param transformation defines the transformation matrix
  71096. * @returns the new Vector3
  71097. */
  71098. static TransformNormal(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>): Vector3;
  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 (ie. it does not apply translation)
  71102. * @param vector defines the Vector3 to transform
  71103. * @param transformation defines the transformation matrix
  71104. * @param result defines the Vector3 where to store the result
  71105. */
  71106. static TransformNormalToRef(vector: DeepImmutable<Vector3>, transformation: DeepImmutable<Matrix>, result: Vector3): 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)
  71109. * This methods computes transformed normalized direction vectors only (ie. it does not apply translation)
  71110. * @param x define the x coordinate of the source vector
  71111. * @param y define the y coordinate of the source vector
  71112. * @param z define the z coordinate of the source vector
  71113. * @param transformation defines the transformation matrix
  71114. * @param result defines the Vector3 where to store the result
  71115. */
  71116. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, transformation: DeepImmutable<Matrix>, result: Vector3): void;
  71117. /**
  71118. * Returns a new Vector3 located for "amount" on the CatmullRom interpolation spline defined by the vectors "value1", "value2", "value3", "value4"
  71119. * @param value1 defines the first control point
  71120. * @param value2 defines the second control point
  71121. * @param value3 defines the third control point
  71122. * @param value4 defines the fourth control point
  71123. * @param amount defines the amount on the spline to use
  71124. * @returns the new Vector3
  71125. */
  71126. static CatmullRom(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, value3: DeepImmutable<Vector3>, value4: DeepImmutable<Vector3>, amount: number): Vector3;
  71127. /**
  71128. * 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"
  71129. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  71130. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  71131. * @param value defines the current value
  71132. * @param min defines the lower range value
  71133. * @param max defines the upper range value
  71134. * @returns the new Vector3
  71135. */
  71136. static Clamp(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): Vector3;
  71137. /**
  71138. * 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"
  71139. * If a coordinate value of "value" is lower than one of the "min" coordinate, then this "value" coordinate is set with the "min" one
  71140. * If a coordinate value of "value" is greater than one of the "max" coordinate, then this "value" coordinate is set with the "max" one
  71141. * @param value defines the current value
  71142. * @param min defines the lower range value
  71143. * @param max defines the upper range value
  71144. * @param result defines the Vector3 where to store the result
  71145. */
  71146. static ClampToRef(value: DeepImmutable<Vector3>, min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, result: Vector3): void;
  71147. /**
  71148. * Checks if a given vector is inside a specific range
  71149. * @param v defines the vector to test
  71150. * @param min defines the minimum range
  71151. * @param max defines the maximum range
  71152. */
  71153. static CheckExtends(v: Vector3, min: Vector3, max: Vector3): void;
  71154. /**
  71155. * Returns a new Vector3 located for "amount" (float) on the Hermite interpolation spline defined by the vectors "value1", "tangent1", "value2", "tangent2"
  71156. * @param value1 defines the first control point
  71157. * @param tangent1 defines the first tangent vector
  71158. * @param value2 defines the second control point
  71159. * @param tangent2 defines the second tangent vector
  71160. * @param amount defines the amount on the interpolation spline (between 0 and 1)
  71161. * @returns the new Vector3
  71162. */
  71163. static Hermite(value1: DeepImmutable<Vector3>, tangent1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>, tangent2: DeepImmutable<Vector3>, amount: number): Vector3;
  71164. /**
  71165. * Returns a new Vector3 located for "amount" (float) on the linear interpolation between the vectors "start" and "end"
  71166. * @param start defines the start value
  71167. * @param end defines the end value
  71168. * @param amount max defines amount between both (between 0 and 1)
  71169. * @returns the new Vector3
  71170. */
  71171. static Lerp(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number): Vector3;
  71172. /**
  71173. * Sets the given vector "result" with the result of the linear interpolation from the vector "start" for "amount" to the vector "end"
  71174. * @param start defines the start value
  71175. * @param end defines the end value
  71176. * @param amount max defines amount between both (between 0 and 1)
  71177. * @param result defines the Vector3 where to store the result
  71178. */
  71179. static LerpToRef(start: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, amount: number, result: Vector3): void;
  71180. /**
  71181. * Returns the dot product (float) between the vectors "left" and "right"
  71182. * @param left defines the left operand
  71183. * @param right defines the right operand
  71184. * @returns the dot product
  71185. */
  71186. static Dot(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): number;
  71187. /**
  71188. * Returns a new Vector3 as the cross product of the vectors "left" and "right"
  71189. * The cross product is then orthogonal to both "left" and "right"
  71190. * @param left defines the left operand
  71191. * @param right defines the right operand
  71192. * @returns the cross product
  71193. */
  71194. static Cross(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  71195. /**
  71196. * Sets the given vector "result" with the cross product of "left" and "right"
  71197. * The cross product is then orthogonal to both "left" and "right"
  71198. * @param left defines the left operand
  71199. * @param right defines the right operand
  71200. * @param result defines the Vector3 where to store the result
  71201. */
  71202. static CrossToRef(left: Vector3, right: Vector3, result: Vector3): void;
  71203. /**
  71204. * Returns a new Vector3 as the normalization of the given vector
  71205. * @param vector defines the Vector3 to normalize
  71206. * @returns the new Vector3
  71207. */
  71208. static Normalize(vector: DeepImmutable<Vector3>): Vector3;
  71209. /**
  71210. * Sets the given vector "result" with the normalization of the given first vector
  71211. * @param vector defines the Vector3 to normalize
  71212. * @param result defines the Vector3 where to store the result
  71213. */
  71214. static NormalizeToRef(vector: DeepImmutable<Vector3>, result: Vector3): void;
  71215. /**
  71216. * Project a Vector3 onto screen space
  71217. * @param vector defines the Vector3 to project
  71218. * @param world defines the world matrix to use
  71219. * @param transform defines the transform (view x projection) matrix to use
  71220. * @param viewport defines the screen viewport to use
  71221. * @returns the new Vector3
  71222. */
  71223. static Project(vector: DeepImmutable<Vector3>, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>, viewport: DeepImmutable<Viewport>): Vector3;
  71224. /** @hidden */
  71225. static _UnprojectFromInvertedMatrixToRef(source: DeepImmutable<Vector3>, matrix: DeepImmutable<Matrix>, result: Vector3): void;
  71226. /**
  71227. * Unproject from screen space to object space
  71228. * @param source defines the screen space Vector3 to use
  71229. * @param viewportWidth defines the current width of the viewport
  71230. * @param viewportHeight defines the current height of the viewport
  71231. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  71232. * @param transform defines the transform (view x projection) matrix to use
  71233. * @returns the new Vector3
  71234. */
  71235. static UnprojectFromTransform(source: Vector3, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, transform: DeepImmutable<Matrix>): Vector3;
  71236. /**
  71237. * Unproject from screen space to object space
  71238. * @param source defines the screen space Vector3 to use
  71239. * @param viewportWidth defines the current width of the viewport
  71240. * @param viewportHeight defines the current height of the viewport
  71241. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  71242. * @param view defines the view matrix to use
  71243. * @param projection defines the projection matrix to use
  71244. * @returns the new Vector3
  71245. */
  71246. static Unproject(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Vector3;
  71247. /**
  71248. * Unproject from screen space to object space
  71249. * @param source defines the screen space Vector3 to use
  71250. * @param viewportWidth defines the current width of the viewport
  71251. * @param viewportHeight defines the current height of the viewport
  71252. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  71253. * @param view defines the view matrix to use
  71254. * @param projection defines the projection matrix to use
  71255. * @param result defines the Vector3 where to store the result
  71256. */
  71257. static UnprojectToRef(source: DeepImmutable<Vector3>, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  71258. /**
  71259. * Unproject from screen space to object space
  71260. * @param sourceX defines the screen space x coordinate to use
  71261. * @param sourceY defines the screen space y coordinate to use
  71262. * @param sourceZ defines the screen space z coordinate to use
  71263. * @param viewportWidth defines the current width of the viewport
  71264. * @param viewportHeight defines the current height of the viewport
  71265. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  71266. * @param view defines the view matrix to use
  71267. * @param projection defines the projection matrix to use
  71268. * @param result defines the Vector3 where to store the result
  71269. */
  71270. static UnprojectFloatsToRef(sourceX: float, sourceY: float, sourceZ: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, result: Vector3): void;
  71271. /**
  71272. * Gets the minimal coordinate values between two Vector3
  71273. * @param left defines the first operand
  71274. * @param right defines the second operand
  71275. * @returns the new Vector3
  71276. */
  71277. static Minimize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  71278. /**
  71279. * Gets the maximal coordinate values between two Vector3
  71280. * @param left defines the first operand
  71281. * @param right defines the second operand
  71282. * @returns the new Vector3
  71283. */
  71284. static Maximize(left: DeepImmutable<Vector3>, right: DeepImmutable<Vector3>): Vector3;
  71285. /**
  71286. * Returns the distance between the vectors "value1" and "value2"
  71287. * @param value1 defines the first operand
  71288. * @param value2 defines the second operand
  71289. * @returns the distance
  71290. */
  71291. static Distance(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  71292. /**
  71293. * Returns the squared distance between the vectors "value1" and "value2"
  71294. * @param value1 defines the first operand
  71295. * @param value2 defines the second operand
  71296. * @returns the squared distance
  71297. */
  71298. static DistanceSquared(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): number;
  71299. /**
  71300. * Returns a new Vector3 located at the center between "value1" and "value2"
  71301. * @param value1 defines the first operand
  71302. * @param value2 defines the second operand
  71303. * @returns the new Vector3
  71304. */
  71305. static Center(value1: DeepImmutable<Vector3>, value2: DeepImmutable<Vector3>): Vector3;
  71306. /**
  71307. * Given three orthogonal normalized left-handed oriented Vector3 axis in space (target system),
  71308. * RotationFromAxis() returns the rotation Euler angles (ex : rotation.x, rotation.y, rotation.z) to apply
  71309. * to something in order to rotate it from its local system to the given target system
  71310. * Note: axis1, axis2 and axis3 are normalized during this operation
  71311. * @param axis1 defines the first axis
  71312. * @param axis2 defines the second axis
  71313. * @param axis3 defines the third axis
  71314. * @returns a new Vector3
  71315. */
  71316. static RotationFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Vector3;
  71317. /**
  71318. * The same than RotationFromAxis but updates the given ref Vector3 parameter instead of returning a new Vector3
  71319. * @param axis1 defines the first axis
  71320. * @param axis2 defines the second axis
  71321. * @param axis3 defines the third axis
  71322. * @param ref defines the Vector3 where to store the result
  71323. */
  71324. static RotationFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Vector3): void;
  71325. }
  71326. /**
  71327. * Vector4 class created for EulerAngle class conversion to Quaternion
  71328. */
  71329. export class Vector4 {
  71330. /** x value of the vector */
  71331. x: number;
  71332. /** y value of the vector */
  71333. y: number;
  71334. /** z value of the vector */
  71335. z: number;
  71336. /** w value of the vector */
  71337. w: number;
  71338. /**
  71339. * Creates a Vector4 object from the given floats.
  71340. * @param x x value of the vector
  71341. * @param y y value of the vector
  71342. * @param z z value of the vector
  71343. * @param w w value of the vector
  71344. */
  71345. constructor(
  71346. /** x value of the vector */
  71347. x: number,
  71348. /** y value of the vector */
  71349. y: number,
  71350. /** z value of the vector */
  71351. z: number,
  71352. /** w value of the vector */
  71353. w: number);
  71354. /**
  71355. * Returns the string with the Vector4 coordinates.
  71356. * @returns a string containing all the vector values
  71357. */
  71358. toString(): string;
  71359. /**
  71360. * Returns the string "Vector4".
  71361. * @returns "Vector4"
  71362. */
  71363. getClassName(): string;
  71364. /**
  71365. * Returns the Vector4 hash code.
  71366. * @returns a unique hash code
  71367. */
  71368. getHashCode(): number;
  71369. /**
  71370. * Returns a new array populated with 4 elements : the Vector4 coordinates.
  71371. * @returns the resulting array
  71372. */
  71373. asArray(): number[];
  71374. /**
  71375. * Populates the given array from the given index with the Vector4 coordinates.
  71376. * @param array array to populate
  71377. * @param index index of the array to start at (default: 0)
  71378. * @returns the Vector4.
  71379. */
  71380. toArray(array: FloatArray, index?: number): Vector4;
  71381. /**
  71382. * Adds the given vector to the current Vector4.
  71383. * @param otherVector the vector to add
  71384. * @returns the updated Vector4.
  71385. */
  71386. addInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  71387. /**
  71388. * Returns a new Vector4 as the result of the addition of the current Vector4 and the given one.
  71389. * @param otherVector the vector to add
  71390. * @returns the resulting vector
  71391. */
  71392. add(otherVector: DeepImmutable<Vector4>): Vector4;
  71393. /**
  71394. * Updates the given vector "result" with the result of the addition of the current Vector4 and the given one.
  71395. * @param otherVector the vector to add
  71396. * @param result the vector to store the result
  71397. * @returns the current Vector4.
  71398. */
  71399. addToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  71400. /**
  71401. * Subtract in place the given vector from the current Vector4.
  71402. * @param otherVector the vector to subtract
  71403. * @returns the updated Vector4.
  71404. */
  71405. subtractInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  71406. /**
  71407. * Returns a new Vector4 with the result of the subtraction of the given vector from the current Vector4.
  71408. * @param otherVector the vector to add
  71409. * @returns the new vector with the result
  71410. */
  71411. subtract(otherVector: DeepImmutable<Vector4>): Vector4;
  71412. /**
  71413. * Sets the given vector "result" with the result of the subtraction of the given vector from the current Vector4.
  71414. * @param otherVector the vector to subtract
  71415. * @param result the vector to store the result
  71416. * @returns the current Vector4.
  71417. */
  71418. subtractToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  71419. /**
  71420. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  71421. */
  71422. /**
  71423. * Returns a new Vector4 set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  71424. * @param x value to subtract
  71425. * @param y value to subtract
  71426. * @param z value to subtract
  71427. * @param w value to subtract
  71428. * @returns new vector containing the result
  71429. */
  71430. subtractFromFloats(x: number, y: number, z: number, w: number): Vector4;
  71431. /**
  71432. * Sets the given vector "result" set with the result of the subtraction of the given floats from the current Vector4 coordinates.
  71433. * @param x value to subtract
  71434. * @param y value to subtract
  71435. * @param z value to subtract
  71436. * @param w value to subtract
  71437. * @param result the vector to store the result in
  71438. * @returns the current Vector4.
  71439. */
  71440. subtractFromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): Vector4;
  71441. /**
  71442. * Returns a new Vector4 set with the current Vector4 negated coordinates.
  71443. * @returns a new vector with the negated values
  71444. */
  71445. negate(): Vector4;
  71446. /**
  71447. * Multiplies the current Vector4 coordinates by scale (float).
  71448. * @param scale the number to scale with
  71449. * @returns the updated Vector4.
  71450. */
  71451. scaleInPlace(scale: number): Vector4;
  71452. /**
  71453. * Returns a new Vector4 set with the current Vector4 coordinates multiplied by scale (float).
  71454. * @param scale the number to scale with
  71455. * @returns a new vector with the result
  71456. */
  71457. scale(scale: number): Vector4;
  71458. /**
  71459. * Sets the given vector "result" with the current Vector4 coordinates multiplied by scale (float).
  71460. * @param scale the number to scale with
  71461. * @param result a vector to store the result in
  71462. * @returns the current Vector4.
  71463. */
  71464. scaleToRef(scale: number, result: Vector4): Vector4;
  71465. /**
  71466. * Scale the current Vector4 values by a factor and add the result to a given Vector4
  71467. * @param scale defines the scale factor
  71468. * @param result defines the Vector4 object where to store the result
  71469. * @returns the unmodified current Vector4
  71470. */
  71471. scaleAndAddToRef(scale: number, result: Vector4): Vector4;
  71472. /**
  71473. * Boolean : True if the current Vector4 coordinates are stricly equal to the given ones.
  71474. * @param otherVector the vector to compare against
  71475. * @returns true if they are equal
  71476. */
  71477. equals(otherVector: DeepImmutable<Vector4>): boolean;
  71478. /**
  71479. * Boolean : True if the current Vector4 coordinates are each beneath the distance "epsilon" from the given vector ones.
  71480. * @param otherVector vector to compare against
  71481. * @param epsilon (Default: very small number)
  71482. * @returns true if they are equal
  71483. */
  71484. equalsWithEpsilon(otherVector: DeepImmutable<Vector4>, epsilon?: number): boolean;
  71485. /**
  71486. * Boolean : True if the given floats are strictly equal to the current Vector4 coordinates.
  71487. * @param x x value to compare against
  71488. * @param y y value to compare against
  71489. * @param z z value to compare against
  71490. * @param w w value to compare against
  71491. * @returns true if equal
  71492. */
  71493. equalsToFloats(x: number, y: number, z: number, w: number): boolean;
  71494. /**
  71495. * Multiplies in place the current Vector4 by the given one.
  71496. * @param otherVector vector to multiple with
  71497. * @returns the updated Vector4.
  71498. */
  71499. multiplyInPlace(otherVector: Vector4): Vector4;
  71500. /**
  71501. * Returns a new Vector4 set with the multiplication result of the current Vector4 and the given one.
  71502. * @param otherVector vector to multiple with
  71503. * @returns resulting new vector
  71504. */
  71505. multiply(otherVector: DeepImmutable<Vector4>): Vector4;
  71506. /**
  71507. * Updates the given vector "result" with the multiplication result of the current Vector4 and the given one.
  71508. * @param otherVector vector to multiple with
  71509. * @param result vector to store the result
  71510. * @returns the current Vector4.
  71511. */
  71512. multiplyToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  71513. /**
  71514. * Returns a new Vector4 set with the multiplication result of the given floats and the current Vector4 coordinates.
  71515. * @param x x value multiply with
  71516. * @param y y value multiply with
  71517. * @param z z value multiply with
  71518. * @param w w value multiply with
  71519. * @returns resulting new vector
  71520. */
  71521. multiplyByFloats(x: number, y: number, z: number, w: number): Vector4;
  71522. /**
  71523. * Returns a new Vector4 set with the division result of the current Vector4 by the given one.
  71524. * @param otherVector vector to devide with
  71525. * @returns resulting new vector
  71526. */
  71527. divide(otherVector: DeepImmutable<Vector4>): Vector4;
  71528. /**
  71529. * Updates the given vector "result" with the division result of the current Vector4 by the given one.
  71530. * @param otherVector vector to devide with
  71531. * @param result vector to store the result
  71532. * @returns the current Vector4.
  71533. */
  71534. divideToRef(otherVector: DeepImmutable<Vector4>, result: Vector4): Vector4;
  71535. /**
  71536. * Divides the current Vector3 coordinates by the given ones.
  71537. * @param otherVector vector to devide with
  71538. * @returns the updated Vector3.
  71539. */
  71540. divideInPlace(otherVector: DeepImmutable<Vector4>): Vector4;
  71541. /**
  71542. * Updates the Vector4 coordinates with the minimum values between its own and the given vector ones
  71543. * @param other defines the second operand
  71544. * @returns the current updated Vector4
  71545. */
  71546. minimizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  71547. /**
  71548. * Updates the Vector4 coordinates with the maximum values between its own and the given vector ones
  71549. * @param other defines the second operand
  71550. * @returns the current updated Vector4
  71551. */
  71552. maximizeInPlace(other: DeepImmutable<Vector4>): Vector4;
  71553. /**
  71554. * Gets a new Vector4 from current Vector4 floored values
  71555. * @returns a new Vector4
  71556. */
  71557. floor(): Vector4;
  71558. /**
  71559. * Gets a new Vector4 from current Vector3 floored values
  71560. * @returns a new Vector4
  71561. */
  71562. fract(): Vector4;
  71563. /**
  71564. * Returns the Vector4 length (float).
  71565. * @returns the length
  71566. */
  71567. length(): number;
  71568. /**
  71569. * Returns the Vector4 squared length (float).
  71570. * @returns the length squared
  71571. */
  71572. lengthSquared(): number;
  71573. /**
  71574. * Normalizes in place the Vector4.
  71575. * @returns the updated Vector4.
  71576. */
  71577. normalize(): Vector4;
  71578. /**
  71579. * Returns a new Vector3 from the Vector4 (x, y, z) coordinates.
  71580. * @returns this converted to a new vector3
  71581. */
  71582. toVector3(): Vector3;
  71583. /**
  71584. * Returns a new Vector4 copied from the current one.
  71585. * @returns the new cloned vector
  71586. */
  71587. clone(): Vector4;
  71588. /**
  71589. * Updates the current Vector4 with the given one coordinates.
  71590. * @param source the source vector to copy from
  71591. * @returns the updated Vector4.
  71592. */
  71593. copyFrom(source: DeepImmutable<Vector4>): Vector4;
  71594. /**
  71595. * Updates the current Vector4 coordinates with the given floats.
  71596. * @param x float to copy from
  71597. * @param y float to copy from
  71598. * @param z float to copy from
  71599. * @param w float to copy from
  71600. * @returns the updated Vector4.
  71601. */
  71602. copyFromFloats(x: number, y: number, z: number, w: number): Vector4;
  71603. /**
  71604. * Updates the current Vector4 coordinates with the given floats.
  71605. * @param x float to set from
  71606. * @param y float to set from
  71607. * @param z float to set from
  71608. * @param w float to set from
  71609. * @returns the updated Vector4.
  71610. */
  71611. set(x: number, y: number, z: number, w: number): Vector4;
  71612. /**
  71613. * Copies the given float to the current Vector3 coordinates
  71614. * @param v defines the x, y, z and w coordinates of the operand
  71615. * @returns the current updated Vector3
  71616. */
  71617. setAll(v: number): Vector4;
  71618. /**
  71619. * Returns a new Vector4 set from the starting index of the given array.
  71620. * @param array the array to pull values from
  71621. * @param offset the offset into the array to start at
  71622. * @returns the new vector
  71623. */
  71624. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Vector4;
  71625. /**
  71626. * Updates the given vector "result" from the starting index of the given array.
  71627. * @param array the array to pull values from
  71628. * @param offset the offset into the array to start at
  71629. * @param result the vector to store the result in
  71630. */
  71631. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Vector4): void;
  71632. /**
  71633. * Updates the given vector "result" from the starting index of the given Float32Array.
  71634. * @param array the array to pull values from
  71635. * @param offset the offset into the array to start at
  71636. * @param result the vector to store the result in
  71637. */
  71638. static FromFloatArrayToRef(array: DeepImmutable<Float32Array>, offset: number, result: Vector4): void;
  71639. /**
  71640. * Updates the given vector "result" coordinates from the given floats.
  71641. * @param x float to set from
  71642. * @param y float to set from
  71643. * @param z float to set from
  71644. * @param w float to set from
  71645. * @param result the vector to the floats in
  71646. */
  71647. static FromFloatsToRef(x: number, y: number, z: number, w: number, result: Vector4): void;
  71648. /**
  71649. * Returns a new Vector4 set to (0.0, 0.0, 0.0, 0.0)
  71650. * @returns the new vector
  71651. */
  71652. static Zero(): Vector4;
  71653. /**
  71654. * Returns a new Vector4 set to (1.0, 1.0, 1.0, 1.0)
  71655. * @returns the new vector
  71656. */
  71657. static One(): Vector4;
  71658. /**
  71659. * Returns a new normalized Vector4 from the given one.
  71660. * @param vector the vector to normalize
  71661. * @returns the vector
  71662. */
  71663. static Normalize(vector: DeepImmutable<Vector4>): Vector4;
  71664. /**
  71665. * Updates the given vector "result" from the normalization of the given one.
  71666. * @param vector the vector to normalize
  71667. * @param result the vector to store the result in
  71668. */
  71669. static NormalizeToRef(vector: DeepImmutable<Vector4>, result: Vector4): void;
  71670. /**
  71671. * Returns a vector with the minimum values from the left and right vectors
  71672. * @param left left vector to minimize
  71673. * @param right right vector to minimize
  71674. * @returns a new vector with the minimum of the left and right vector values
  71675. */
  71676. static Minimize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  71677. /**
  71678. * Returns a vector with the maximum values from the left and right vectors
  71679. * @param left left vector to maximize
  71680. * @param right right vector to maximize
  71681. * @returns a new vector with the maximum of the left and right vector values
  71682. */
  71683. static Maximize(left: DeepImmutable<Vector4>, right: DeepImmutable<Vector4>): Vector4;
  71684. /**
  71685. * Returns the distance (float) between the vectors "value1" and "value2".
  71686. * @param value1 value to calulate the distance between
  71687. * @param value2 value to calulate the distance between
  71688. * @return the distance between the two vectors
  71689. */
  71690. static Distance(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  71691. /**
  71692. * Returns the squared distance (float) between the vectors "value1" and "value2".
  71693. * @param value1 value to calulate the distance between
  71694. * @param value2 value to calulate the distance between
  71695. * @return the distance between the two vectors squared
  71696. */
  71697. static DistanceSquared(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): number;
  71698. /**
  71699. * Returns a new Vector4 located at the center between the vectors "value1" and "value2".
  71700. * @param value1 value to calulate the center between
  71701. * @param value2 value to calulate the center between
  71702. * @return the center between the two vectors
  71703. */
  71704. static Center(value1: DeepImmutable<Vector4>, value2: DeepImmutable<Vector4>): Vector4;
  71705. /**
  71706. * Returns a new Vector4 set with the result of the normal transformation by the given matrix of the given vector.
  71707. * This methods computes transformed normalized direction vectors only.
  71708. * @param vector the vector to transform
  71709. * @param transformation the transformation matrix to apply
  71710. * @returns the new vector
  71711. */
  71712. static TransformNormal(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>): Vector4;
  71713. /**
  71714. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given vector.
  71715. * This methods computes transformed normalized direction vectors only.
  71716. * @param vector the vector to transform
  71717. * @param transformation the transformation matrix to apply
  71718. * @param result the vector to store the result in
  71719. */
  71720. static TransformNormalToRef(vector: DeepImmutable<Vector4>, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  71721. /**
  71722. * Sets the given vector "result" with the result of the normal transformation by the given matrix of the given floats (x, y, z, w).
  71723. * This methods computes transformed normalized direction vectors only.
  71724. * @param x value to transform
  71725. * @param y value to transform
  71726. * @param z value to transform
  71727. * @param w value to transform
  71728. * @param transformation the transformation matrix to apply
  71729. * @param result the vector to store the results in
  71730. */
  71731. static TransformNormalFromFloatsToRef(x: number, y: number, z: number, w: number, transformation: DeepImmutable<Matrix>, result: Vector4): void;
  71732. /**
  71733. * Creates a new Vector4 from a Vector3
  71734. * @param source defines the source data
  71735. * @param w defines the 4th component (default is 0)
  71736. * @returns a new Vector4
  71737. */
  71738. static FromVector3(source: Vector3, w?: number): Vector4;
  71739. }
  71740. /**
  71741. * Class used to store quaternion data
  71742. * @see https://en.wikipedia.org/wiki/Quaternion
  71743. * @see http://doc.babylonjs.com/features/position,_rotation,_scaling
  71744. */
  71745. export class Quaternion {
  71746. /** defines the first component (0 by default) */
  71747. x: number;
  71748. /** defines the second component (0 by default) */
  71749. y: number;
  71750. /** defines the third component (0 by default) */
  71751. z: number;
  71752. /** defines the fourth component (1.0 by default) */
  71753. w: number;
  71754. /**
  71755. * Creates a new Quaternion from the given floats
  71756. * @param x defines the first component (0 by default)
  71757. * @param y defines the second component (0 by default)
  71758. * @param z defines the third component (0 by default)
  71759. * @param w defines the fourth component (1.0 by default)
  71760. */
  71761. constructor(
  71762. /** defines the first component (0 by default) */
  71763. x?: number,
  71764. /** defines the second component (0 by default) */
  71765. y?: number,
  71766. /** defines the third component (0 by default) */
  71767. z?: number,
  71768. /** defines the fourth component (1.0 by default) */
  71769. w?: number);
  71770. /**
  71771. * Gets a string representation for the current quaternion
  71772. * @returns a string with the Quaternion coordinates
  71773. */
  71774. toString(): string;
  71775. /**
  71776. * Gets the class name of the quaternion
  71777. * @returns the string "Quaternion"
  71778. */
  71779. getClassName(): string;
  71780. /**
  71781. * Gets a hash code for this quaternion
  71782. * @returns the quaternion hash code
  71783. */
  71784. getHashCode(): number;
  71785. /**
  71786. * Copy the quaternion to an array
  71787. * @returns a new array populated with 4 elements from the quaternion coordinates
  71788. */
  71789. asArray(): number[];
  71790. /**
  71791. * Check if two quaternions are equals
  71792. * @param otherQuaternion defines the second operand
  71793. * @return true if the current quaternion and the given one coordinates are strictly equals
  71794. */
  71795. equals(otherQuaternion: DeepImmutable<Quaternion>): boolean;
  71796. /**
  71797. * Clone the current quaternion
  71798. * @returns a new quaternion copied from the current one
  71799. */
  71800. clone(): Quaternion;
  71801. /**
  71802. * Copy a quaternion to the current one
  71803. * @param other defines the other quaternion
  71804. * @returns the updated current quaternion
  71805. */
  71806. copyFrom(other: DeepImmutable<Quaternion>): Quaternion;
  71807. /**
  71808. * Updates the current quaternion with the given float coordinates
  71809. * @param x defines the x coordinate
  71810. * @param y defines the y coordinate
  71811. * @param z defines the z coordinate
  71812. * @param w defines the w coordinate
  71813. * @returns the updated current quaternion
  71814. */
  71815. copyFromFloats(x: number, y: number, z: number, w: number): Quaternion;
  71816. /**
  71817. * Updates the current quaternion from the given float coordinates
  71818. * @param x defines the x coordinate
  71819. * @param y defines the y coordinate
  71820. * @param z defines the z coordinate
  71821. * @param w defines the w coordinate
  71822. * @returns the updated current quaternion
  71823. */
  71824. set(x: number, y: number, z: number, w: number): Quaternion;
  71825. /**
  71826. * Adds two quaternions
  71827. * @param other defines the second operand
  71828. * @returns a new quaternion as the addition result of the given one and the current quaternion
  71829. */
  71830. add(other: DeepImmutable<Quaternion>): Quaternion;
  71831. /**
  71832. * Add a quaternion to the current one
  71833. * @param other defines the quaternion to add
  71834. * @returns the current quaternion
  71835. */
  71836. addInPlace(other: DeepImmutable<Quaternion>): Quaternion;
  71837. /**
  71838. * Subtract two quaternions
  71839. * @param other defines the second operand
  71840. * @returns a new quaternion as the subtraction result of the given one from the current one
  71841. */
  71842. subtract(other: Quaternion): Quaternion;
  71843. /**
  71844. * Multiplies the current quaternion by a scale factor
  71845. * @param value defines the scale factor
  71846. * @returns a new quaternion set by multiplying the current quaternion coordinates by the float "scale"
  71847. */
  71848. scale(value: number): Quaternion;
  71849. /**
  71850. * Scale the current quaternion values by a factor and stores the result to a given quaternion
  71851. * @param scale defines the scale factor
  71852. * @param result defines the Quaternion object where to store the result
  71853. * @returns the unmodified current quaternion
  71854. */
  71855. scaleToRef(scale: number, result: Quaternion): Quaternion;
  71856. /**
  71857. * Multiplies in place the current quaternion by a scale factor
  71858. * @param value defines the scale factor
  71859. * @returns the current modified quaternion
  71860. */
  71861. scaleInPlace(value: number): Quaternion;
  71862. /**
  71863. * Scale the current quaternion values by a factor and add the result to a given quaternion
  71864. * @param scale defines the scale factor
  71865. * @param result defines the Quaternion object where to store the result
  71866. * @returns the unmodified current quaternion
  71867. */
  71868. scaleAndAddToRef(scale: number, result: Quaternion): Quaternion;
  71869. /**
  71870. * Multiplies two quaternions
  71871. * @param q1 defines the second operand
  71872. * @returns a new quaternion set as the multiplication result of the current one with the given one "q1"
  71873. */
  71874. multiply(q1: DeepImmutable<Quaternion>): Quaternion;
  71875. /**
  71876. * Sets the given "result" as the the multiplication result of the current one with the given one "q1"
  71877. * @param q1 defines the second operand
  71878. * @param result defines the target quaternion
  71879. * @returns the current quaternion
  71880. */
  71881. multiplyToRef(q1: DeepImmutable<Quaternion>, result: Quaternion): Quaternion;
  71882. /**
  71883. * Updates the current quaternion with the multiplication of itself with the given one "q1"
  71884. * @param q1 defines the second operand
  71885. * @returns the currentupdated quaternion
  71886. */
  71887. multiplyInPlace(q1: DeepImmutable<Quaternion>): Quaternion;
  71888. /**
  71889. * Conjugates (1-q) the current quaternion and stores the result in the given quaternion
  71890. * @param ref defines the target quaternion
  71891. * @returns the current quaternion
  71892. */
  71893. conjugateToRef(ref: Quaternion): Quaternion;
  71894. /**
  71895. * Conjugates in place (1-q) the current quaternion
  71896. * @returns the current updated quaternion
  71897. */
  71898. conjugateInPlace(): Quaternion;
  71899. /**
  71900. * Conjugates in place (1-q) the current quaternion
  71901. * @returns a new quaternion
  71902. */
  71903. conjugate(): Quaternion;
  71904. /**
  71905. * Gets length of current quaternion
  71906. * @returns the quaternion length (float)
  71907. */
  71908. length(): number;
  71909. /**
  71910. * Normalize in place the current quaternion
  71911. * @returns the current updated quaternion
  71912. */
  71913. normalize(): Quaternion;
  71914. /**
  71915. * Returns a new Vector3 set with the Euler angles translated from the current quaternion
  71916. * @param order is a reserved parameter and is ignore for now
  71917. * @returns a new Vector3 containing the Euler angles
  71918. */
  71919. toEulerAngles(order?: string): Vector3;
  71920. /**
  71921. * Sets the given vector3 "result" with the Euler angles translated from the current quaternion
  71922. * @param result defines the vector which will be filled with the Euler angles
  71923. * @param order is a reserved parameter and is ignore for now
  71924. * @returns the current unchanged quaternion
  71925. */
  71926. toEulerAnglesToRef(result: Vector3): Quaternion;
  71927. /**
  71928. * Updates the given rotation matrix with the current quaternion values
  71929. * @param result defines the target matrix
  71930. * @returns the current unchanged quaternion
  71931. */
  71932. toRotationMatrix(result: Matrix): Quaternion;
  71933. /**
  71934. * Updates the current quaternion from the given rotation matrix values
  71935. * @param matrix defines the source matrix
  71936. * @returns the current updated quaternion
  71937. */
  71938. fromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  71939. /**
  71940. * Creates a new quaternion from a rotation matrix
  71941. * @param matrix defines the source matrix
  71942. * @returns a new quaternion created from the given rotation matrix values
  71943. */
  71944. static FromRotationMatrix(matrix: DeepImmutable<Matrix>): Quaternion;
  71945. /**
  71946. * Updates the given quaternion with the given rotation matrix values
  71947. * @param matrix defines the source matrix
  71948. * @param result defines the target quaternion
  71949. */
  71950. static FromRotationMatrixToRef(matrix: DeepImmutable<Matrix>, result: Quaternion): void;
  71951. /**
  71952. * Returns the dot product (float) between the quaternions "left" and "right"
  71953. * @param left defines the left operand
  71954. * @param right defines the right operand
  71955. * @returns the dot product
  71956. */
  71957. static Dot(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>): number;
  71958. /**
  71959. * Checks if the two quaternions are close to each other
  71960. * @param quat0 defines the first quaternion to check
  71961. * @param quat1 defines the second quaternion to check
  71962. * @returns true if the two quaternions are close to each other
  71963. */
  71964. static AreClose(quat0: DeepImmutable<Quaternion>, quat1: DeepImmutable<Quaternion>): boolean;
  71965. /**
  71966. * Creates an empty quaternion
  71967. * @returns a new quaternion set to (0.0, 0.0, 0.0)
  71968. */
  71969. static Zero(): Quaternion;
  71970. /**
  71971. * Inverse a given quaternion
  71972. * @param q defines the source quaternion
  71973. * @returns a new quaternion as the inverted current quaternion
  71974. */
  71975. static Inverse(q: DeepImmutable<Quaternion>): Quaternion;
  71976. /**
  71977. * Inverse a given quaternion
  71978. * @param q defines the source quaternion
  71979. * @param result the quaternion the result will be stored in
  71980. * @returns the result quaternion
  71981. */
  71982. static InverseToRef(q: Quaternion, result: Quaternion): Quaternion;
  71983. /**
  71984. * Creates an identity quaternion
  71985. * @returns the identity quaternion
  71986. */
  71987. static Identity(): Quaternion;
  71988. /**
  71989. * Gets a boolean indicating if the given quaternion is identity
  71990. * @param quaternion defines the quaternion to check
  71991. * @returns true if the quaternion is identity
  71992. */
  71993. static IsIdentity(quaternion: DeepImmutable<Quaternion>): boolean;
  71994. /**
  71995. * Creates a quaternion from a rotation around an axis
  71996. * @param axis defines the axis to use
  71997. * @param angle defines the angle to use
  71998. * @returns a new quaternion created from the given axis (Vector3) and angle in radians (float)
  71999. */
  72000. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Quaternion;
  72001. /**
  72002. * Creates a rotation around an axis and stores it into the given quaternion
  72003. * @param axis defines the axis to use
  72004. * @param angle defines the angle to use
  72005. * @param result defines the target quaternion
  72006. * @returns the target quaternion
  72007. */
  72008. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Quaternion): Quaternion;
  72009. /**
  72010. * Creates a new quaternion from data stored into an array
  72011. * @param array defines the data source
  72012. * @param offset defines the offset in the source array where the data starts
  72013. * @returns a new quaternion
  72014. */
  72015. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Quaternion;
  72016. /**
  72017. * Create a quaternion from Euler rotation angles
  72018. * @param x Pitch
  72019. * @param y Yaw
  72020. * @param z Roll
  72021. * @returns the new Quaternion
  72022. */
  72023. static FromEulerAngles(x: number, y: number, z: number): Quaternion;
  72024. /**
  72025. * Updates a quaternion from Euler rotation angles
  72026. * @param x Pitch
  72027. * @param y Yaw
  72028. * @param z Roll
  72029. * @param result the quaternion to store the result
  72030. * @returns the updated quaternion
  72031. */
  72032. static FromEulerAnglesToRef(x: number, y: number, z: number, result: Quaternion): Quaternion;
  72033. /**
  72034. * Create a quaternion from Euler rotation vector
  72035. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  72036. * @returns the new Quaternion
  72037. */
  72038. static FromEulerVector(vec: DeepImmutable<Vector3>): Quaternion;
  72039. /**
  72040. * Updates a quaternion from Euler rotation vector
  72041. * @param vec the Euler vector (x Pitch, y Yaw, z Roll)
  72042. * @param result the quaternion to store the result
  72043. * @returns the updated quaternion
  72044. */
  72045. static FromEulerVectorToRef(vec: DeepImmutable<Vector3>, result: Quaternion): Quaternion;
  72046. /**
  72047. * Creates a new quaternion from the given Euler float angles (y, x, z)
  72048. * @param yaw defines the rotation around Y axis
  72049. * @param pitch defines the rotation around X axis
  72050. * @param roll defines the rotation around Z axis
  72051. * @returns the new quaternion
  72052. */
  72053. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Quaternion;
  72054. /**
  72055. * Creates a new rotation from the given Euler float angles (y, x, z) and stores it in the target quaternion
  72056. * @param yaw defines the rotation around Y axis
  72057. * @param pitch defines the rotation around X axis
  72058. * @param roll defines the rotation around Z axis
  72059. * @param result defines the target quaternion
  72060. */
  72061. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Quaternion): void;
  72062. /**
  72063. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation
  72064. * @param alpha defines the rotation around first axis
  72065. * @param beta defines the rotation around second axis
  72066. * @param gamma defines the rotation around third axis
  72067. * @returns the new quaternion
  72068. */
  72069. static RotationAlphaBetaGamma(alpha: number, beta: number, gamma: number): Quaternion;
  72070. /**
  72071. * Creates a new quaternion from the given Euler float angles expressed in z-x-z orientation and stores it in the target quaternion
  72072. * @param alpha defines the rotation around first axis
  72073. * @param beta defines the rotation around second axis
  72074. * @param gamma defines the rotation around third axis
  72075. * @param result defines the target quaternion
  72076. */
  72077. static RotationAlphaBetaGammaToRef(alpha: number, beta: number, gamma: number, result: Quaternion): void;
  72078. /**
  72079. * 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)
  72080. * @param axis1 defines the first axis
  72081. * @param axis2 defines the second axis
  72082. * @param axis3 defines the third axis
  72083. * @returns the new quaternion
  72084. */
  72085. static RotationQuaternionFromAxis(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>): Quaternion;
  72086. /**
  72087. * 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
  72088. * @param axis1 defines the first axis
  72089. * @param axis2 defines the second axis
  72090. * @param axis3 defines the third axis
  72091. * @param ref defines the target quaternion
  72092. */
  72093. static RotationQuaternionFromAxisToRef(axis1: DeepImmutable<Vector3>, axis2: DeepImmutable<Vector3>, axis3: DeepImmutable<Vector3>, ref: Quaternion): void;
  72094. /**
  72095. * Interpolates between two quaternions
  72096. * @param left defines first quaternion
  72097. * @param right defines second quaternion
  72098. * @param amount defines the gradient to use
  72099. * @returns the new interpolated quaternion
  72100. */
  72101. static Slerp(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number): Quaternion;
  72102. /**
  72103. * Interpolates between two quaternions and stores it into a target quaternion
  72104. * @param left defines first quaternion
  72105. * @param right defines second quaternion
  72106. * @param amount defines the gradient to use
  72107. * @param result defines the target quaternion
  72108. */
  72109. static SlerpToRef(left: DeepImmutable<Quaternion>, right: DeepImmutable<Quaternion>, amount: number, result: Quaternion): void;
  72110. /**
  72111. * Interpolate between two quaternions using Hermite interpolation
  72112. * @param value1 defines first quaternion
  72113. * @param tangent1 defines the incoming tangent
  72114. * @param value2 defines second quaternion
  72115. * @param tangent2 defines the outgoing tangent
  72116. * @param amount defines the target quaternion
  72117. * @returns the new interpolated quaternion
  72118. */
  72119. static Hermite(value1: DeepImmutable<Quaternion>, tangent1: DeepImmutable<Quaternion>, value2: DeepImmutable<Quaternion>, tangent2: DeepImmutable<Quaternion>, amount: number): Quaternion;
  72120. }
  72121. /**
  72122. * Class used to store matrix data (4x4)
  72123. */
  72124. export class Matrix {
  72125. private static _updateFlagSeed;
  72126. private static _identityReadOnly;
  72127. private _isIdentity;
  72128. private _isIdentityDirty;
  72129. private _isIdentity3x2;
  72130. private _isIdentity3x2Dirty;
  72131. /**
  72132. * Gets the update flag of the matrix which is an unique number for the matrix.
  72133. * It will be incremented every time the matrix data change.
  72134. * You can use it to speed the comparison between two versions of the same matrix.
  72135. */
  72136. updateFlag: number;
  72137. private readonly _m;
  72138. /**
  72139. * Gets the internal data of the matrix
  72140. */
  72141. readonly m: DeepImmutable<Float32Array>;
  72142. /** @hidden */
  72143. _markAsUpdated(): void;
  72144. /** @hidden */
  72145. private _updateIdentityStatus;
  72146. /**
  72147. * Creates an empty matrix (filled with zeros)
  72148. */
  72149. constructor();
  72150. /**
  72151. * Check if the current matrix is identity
  72152. * @returns true is the matrix is the identity matrix
  72153. */
  72154. isIdentity(): boolean;
  72155. /**
  72156. * Check if the current matrix is identity as a texture matrix (3x2 store in 4x4)
  72157. * @returns true is the matrix is the identity matrix
  72158. */
  72159. isIdentityAs3x2(): boolean;
  72160. /**
  72161. * Gets the determinant of the matrix
  72162. * @returns the matrix determinant
  72163. */
  72164. determinant(): number;
  72165. /**
  72166. * Returns the matrix as a Float32Array
  72167. * @returns the matrix underlying array
  72168. */
  72169. toArray(): DeepImmutable<Float32Array>;
  72170. /**
  72171. * Returns the matrix as a Float32Array
  72172. * @returns the matrix underlying array.
  72173. */
  72174. asArray(): DeepImmutable<Float32Array>;
  72175. /**
  72176. * Inverts the current matrix in place
  72177. * @returns the current inverted matrix
  72178. */
  72179. invert(): Matrix;
  72180. /**
  72181. * Sets all the matrix elements to zero
  72182. * @returns the current matrix
  72183. */
  72184. reset(): Matrix;
  72185. /**
  72186. * Adds the current matrix with a second one
  72187. * @param other defines the matrix to add
  72188. * @returns a new matrix as the addition of the current matrix and the given one
  72189. */
  72190. add(other: DeepImmutable<Matrix>): Matrix;
  72191. /**
  72192. * Sets the given matrix "result" to the addition of the current matrix and the given one
  72193. * @param other defines the matrix to add
  72194. * @param result defines the target matrix
  72195. * @returns the current matrix
  72196. */
  72197. addToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  72198. /**
  72199. * Adds in place the given matrix to the current matrix
  72200. * @param other defines the second operand
  72201. * @returns the current updated matrix
  72202. */
  72203. addToSelf(other: DeepImmutable<Matrix>): Matrix;
  72204. /**
  72205. * Sets the given matrix to the current inverted Matrix
  72206. * @param other defines the target matrix
  72207. * @returns the unmodified current matrix
  72208. */
  72209. invertToRef(other: Matrix): Matrix;
  72210. /**
  72211. * add a value at the specified position in the current Matrix
  72212. * @param index the index of the value within the matrix. between 0 and 15.
  72213. * @param value the value to be added
  72214. * @returns the current updated matrix
  72215. */
  72216. addAtIndex(index: number, value: number): Matrix;
  72217. /**
  72218. * mutiply the specified position in the current Matrix by a value
  72219. * @param index the index of the value within the matrix. between 0 and 15.
  72220. * @param value the value to be added
  72221. * @returns the current updated matrix
  72222. */
  72223. multiplyAtIndex(index: number, value: number): Matrix;
  72224. /**
  72225. * Inserts the translation vector (using 3 floats) in the current matrix
  72226. * @param x defines the 1st component of the translation
  72227. * @param y defines the 2nd component of the translation
  72228. * @param z defines the 3rd component of the translation
  72229. * @returns the current updated matrix
  72230. */
  72231. setTranslationFromFloats(x: number, y: number, z: number): Matrix;
  72232. /**
  72233. * Adds the translation vector (using 3 floats) in the current matrix
  72234. * @param x defines the 1st component of the translation
  72235. * @param y defines the 2nd component of the translation
  72236. * @param z defines the 3rd component of the translation
  72237. * @returns the current updated matrix
  72238. */
  72239. addTranslationFromFloats(x: number, y: number, z: number): Matrix;
  72240. /**
  72241. * Inserts the translation vector in the current matrix
  72242. * @param vector3 defines the translation to insert
  72243. * @returns the current updated matrix
  72244. */
  72245. setTranslation(vector3: DeepImmutable<Vector3>): Matrix;
  72246. /**
  72247. * Gets the translation value of the current matrix
  72248. * @returns a new Vector3 as the extracted translation from the matrix
  72249. */
  72250. getTranslation(): Vector3;
  72251. /**
  72252. * Fill a Vector3 with the extracted translation from the matrix
  72253. * @param result defines the Vector3 where to store the translation
  72254. * @returns the current matrix
  72255. */
  72256. getTranslationToRef(result: Vector3): Matrix;
  72257. /**
  72258. * Remove rotation and scaling part from the matrix
  72259. * @returns the updated matrix
  72260. */
  72261. removeRotationAndScaling(): Matrix;
  72262. /**
  72263. * Multiply two matrices
  72264. * @param other defines the second operand
  72265. * @returns a new matrix set with the multiplication result of the current Matrix and the given one
  72266. */
  72267. multiply(other: DeepImmutable<Matrix>): Matrix;
  72268. /**
  72269. * Copy the current matrix from the given one
  72270. * @param other defines the source matrix
  72271. * @returns the current updated matrix
  72272. */
  72273. copyFrom(other: DeepImmutable<Matrix>): Matrix;
  72274. /**
  72275. * Populates the given array from the starting index with the current matrix values
  72276. * @param array defines the target array
  72277. * @param offset defines the offset in the target array where to start storing values
  72278. * @returns the current matrix
  72279. */
  72280. copyToArray(array: Float32Array, offset?: number): Matrix;
  72281. /**
  72282. * Sets the given matrix "result" with the multiplication result of the current Matrix and the given one
  72283. * @param other defines the second operand
  72284. * @param result defines the matrix where to store the multiplication
  72285. * @returns the current matrix
  72286. */
  72287. multiplyToRef(other: DeepImmutable<Matrix>, result: Matrix): Matrix;
  72288. /**
  72289. * Sets the Float32Array "result" from the given index "offset" with the multiplication of the current matrix and the given one
  72290. * @param other defines the second operand
  72291. * @param result defines the array where to store the multiplication
  72292. * @param offset defines the offset in the target array where to start storing values
  72293. * @returns the current matrix
  72294. */
  72295. multiplyToArray(other: DeepImmutable<Matrix>, result: Float32Array, offset: number): Matrix;
  72296. /**
  72297. * Check equality between this matrix and a second one
  72298. * @param value defines the second matrix to compare
  72299. * @returns true is the current matrix and the given one values are strictly equal
  72300. */
  72301. equals(value: DeepImmutable<Matrix>): boolean;
  72302. /**
  72303. * Clone the current matrix
  72304. * @returns a new matrix from the current matrix
  72305. */
  72306. clone(): Matrix;
  72307. /**
  72308. * Returns the name of the current matrix class
  72309. * @returns the string "Matrix"
  72310. */
  72311. getClassName(): string;
  72312. /**
  72313. * Gets the hash code of the current matrix
  72314. * @returns the hash code
  72315. */
  72316. getHashCode(): number;
  72317. /**
  72318. * Decomposes the current Matrix into a translation, rotation and scaling components
  72319. * @param scale defines the scale vector3 given as a reference to update
  72320. * @param rotation defines the rotation quaternion given as a reference to update
  72321. * @param translation defines the translation vector3 given as a reference to update
  72322. * @returns true if operation was successful
  72323. */
  72324. decompose(scale?: Vector3, rotation?: Quaternion, translation?: Vector3): boolean;
  72325. /**
  72326. * Gets specific row of the matrix
  72327. * @param index defines the number of the row to get
  72328. * @returns the index-th row of the current matrix as a new Vector4
  72329. */
  72330. getRow(index: number): Nullable<Vector4>;
  72331. /**
  72332. * Sets the index-th row of the current matrix to the vector4 values
  72333. * @param index defines the number of the row to set
  72334. * @param row defines the target vector4
  72335. * @returns the updated current matrix
  72336. */
  72337. setRow(index: number, row: Vector4): Matrix;
  72338. /**
  72339. * Compute the transpose of the matrix
  72340. * @returns the new transposed matrix
  72341. */
  72342. transpose(): Matrix;
  72343. /**
  72344. * Compute the transpose of the matrix and store it in a given matrix
  72345. * @param result defines the target matrix
  72346. * @returns the current matrix
  72347. */
  72348. transposeToRef(result: Matrix): Matrix;
  72349. /**
  72350. * Sets the index-th row of the current matrix with the given 4 x float values
  72351. * @param index defines the row index
  72352. * @param x defines the x component to set
  72353. * @param y defines the y component to set
  72354. * @param z defines the z component to set
  72355. * @param w defines the w component to set
  72356. * @returns the updated current matrix
  72357. */
  72358. setRowFromFloats(index: number, x: number, y: number, z: number, w: number): Matrix;
  72359. /**
  72360. * Compute a new matrix set with the current matrix values multiplied by scale (float)
  72361. * @param scale defines the scale factor
  72362. * @returns a new matrix
  72363. */
  72364. scale(scale: number): Matrix;
  72365. /**
  72366. * Scale the current matrix values by a factor to a given result matrix
  72367. * @param scale defines the scale factor
  72368. * @param result defines the matrix to store the result
  72369. * @returns the current matrix
  72370. */
  72371. scaleToRef(scale: number, result: Matrix): Matrix;
  72372. /**
  72373. * Scale the current matrix values by a factor and add the result to a given matrix
  72374. * @param scale defines the scale factor
  72375. * @param result defines the Matrix to store the result
  72376. * @returns the current matrix
  72377. */
  72378. scaleAndAddToRef(scale: number, result: Matrix): Matrix;
  72379. /**
  72380. * Writes to the given matrix a normal matrix, computed from this one (using values from identity matrix for fourth row and column).
  72381. * @param ref matrix to store the result
  72382. */
  72383. toNormalMatrix(ref: Matrix): void;
  72384. /**
  72385. * Gets only rotation part of the current matrix
  72386. * @returns a new matrix sets to the extracted rotation matrix from the current one
  72387. */
  72388. getRotationMatrix(): Matrix;
  72389. /**
  72390. * Extracts the rotation matrix from the current one and sets it as the given "result"
  72391. * @param result defines the target matrix to store data to
  72392. * @returns the current matrix
  72393. */
  72394. getRotationMatrixToRef(result: Matrix): Matrix;
  72395. /**
  72396. * Toggles model matrix from being right handed to left handed in place and vice versa
  72397. */
  72398. toggleModelMatrixHandInPlace(): void;
  72399. /**
  72400. * Toggles projection matrix from being right handed to left handed in place and vice versa
  72401. */
  72402. toggleProjectionMatrixHandInPlace(): void;
  72403. /**
  72404. * Creates a matrix from an array
  72405. * @param array defines the source array
  72406. * @param offset defines an offset in the source array
  72407. * @returns a new Matrix set from the starting index of the given array
  72408. */
  72409. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Matrix;
  72410. /**
  72411. * Copy the content of an array into a given matrix
  72412. * @param array defines the source array
  72413. * @param offset defines an offset in the source array
  72414. * @param result defines the target matrix
  72415. */
  72416. static FromArrayToRef(array: DeepImmutable<ArrayLike<number>>, offset: number, result: Matrix): void;
  72417. /**
  72418. * Stores an array into a matrix after having multiplied each component by a given factor
  72419. * @param array defines the source array
  72420. * @param offset defines the offset in the source array
  72421. * @param scale defines the scaling factor
  72422. * @param result defines the target matrix
  72423. */
  72424. static FromFloat32ArrayToRefScaled(array: DeepImmutable<Float32Array>, offset: number, scale: number, result: Matrix): void;
  72425. /**
  72426. * Gets an identity matrix that must not be updated
  72427. */
  72428. static readonly IdentityReadOnly: DeepImmutable<Matrix>;
  72429. /**
  72430. * Stores a list of values (16) inside a given matrix
  72431. * @param initialM11 defines 1st value of 1st row
  72432. * @param initialM12 defines 2nd value of 1st row
  72433. * @param initialM13 defines 3rd value of 1st row
  72434. * @param initialM14 defines 4th value of 1st row
  72435. * @param initialM21 defines 1st value of 2nd row
  72436. * @param initialM22 defines 2nd value of 2nd row
  72437. * @param initialM23 defines 3rd value of 2nd row
  72438. * @param initialM24 defines 4th value of 2nd row
  72439. * @param initialM31 defines 1st value of 3rd row
  72440. * @param initialM32 defines 2nd value of 3rd row
  72441. * @param initialM33 defines 3rd value of 3rd row
  72442. * @param initialM34 defines 4th value of 3rd row
  72443. * @param initialM41 defines 1st value of 4th row
  72444. * @param initialM42 defines 2nd value of 4th row
  72445. * @param initialM43 defines 3rd value of 4th row
  72446. * @param initialM44 defines 4th value of 4th row
  72447. * @param result defines the target matrix
  72448. */
  72449. 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;
  72450. /**
  72451. * Creates new matrix from a list of values (16)
  72452. * @param initialM11 defines 1st value of 1st row
  72453. * @param initialM12 defines 2nd value of 1st row
  72454. * @param initialM13 defines 3rd value of 1st row
  72455. * @param initialM14 defines 4th value of 1st row
  72456. * @param initialM21 defines 1st value of 2nd row
  72457. * @param initialM22 defines 2nd value of 2nd row
  72458. * @param initialM23 defines 3rd value of 2nd row
  72459. * @param initialM24 defines 4th value of 2nd row
  72460. * @param initialM31 defines 1st value of 3rd row
  72461. * @param initialM32 defines 2nd value of 3rd row
  72462. * @param initialM33 defines 3rd value of 3rd row
  72463. * @param initialM34 defines 4th value of 3rd row
  72464. * @param initialM41 defines 1st value of 4th row
  72465. * @param initialM42 defines 2nd value of 4th row
  72466. * @param initialM43 defines 3rd value of 4th row
  72467. * @param initialM44 defines 4th value of 4th row
  72468. * @returns the new matrix
  72469. */
  72470. 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;
  72471. /**
  72472. * Creates a new matrix composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  72473. * @param scale defines the scale vector3
  72474. * @param rotation defines the rotation quaternion
  72475. * @param translation defines the translation vector3
  72476. * @returns a new matrix
  72477. */
  72478. static Compose(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>): Matrix;
  72479. /**
  72480. * Sets a matrix to a value composed by merging scale (vector3), rotation (quaternion) and translation (vector3)
  72481. * @param scale defines the scale vector3
  72482. * @param rotation defines the rotation quaternion
  72483. * @param translation defines the translation vector3
  72484. * @param result defines the target matrix
  72485. */
  72486. static ComposeToRef(scale: DeepImmutable<Vector3>, rotation: DeepImmutable<Quaternion>, translation: DeepImmutable<Vector3>, result: Matrix): void;
  72487. /**
  72488. * Creates a new identity matrix
  72489. * @returns a new identity matrix
  72490. */
  72491. static Identity(): Matrix;
  72492. /**
  72493. * Creates a new identity matrix and stores the result in a given matrix
  72494. * @param result defines the target matrix
  72495. */
  72496. static IdentityToRef(result: Matrix): void;
  72497. /**
  72498. * Creates a new zero matrix
  72499. * @returns a new zero matrix
  72500. */
  72501. static Zero(): Matrix;
  72502. /**
  72503. * Creates a new rotation matrix for "angle" radians around the X axis
  72504. * @param angle defines the angle (in radians) to use
  72505. * @return the new matrix
  72506. */
  72507. static RotationX(angle: number): Matrix;
  72508. /**
  72509. * Creates a new matrix as the invert of a given matrix
  72510. * @param source defines the source matrix
  72511. * @returns the new matrix
  72512. */
  72513. static Invert(source: DeepImmutable<Matrix>): Matrix;
  72514. /**
  72515. * Creates a new rotation matrix for "angle" radians around the X axis and stores it in a given matrix
  72516. * @param angle defines the angle (in radians) to use
  72517. * @param result defines the target matrix
  72518. */
  72519. static RotationXToRef(angle: number, result: Matrix): void;
  72520. /**
  72521. * Creates a new rotation matrix for "angle" radians around the Y axis
  72522. * @param angle defines the angle (in radians) to use
  72523. * @return the new matrix
  72524. */
  72525. static RotationY(angle: number): Matrix;
  72526. /**
  72527. * Creates a new rotation matrix for "angle" radians around the Y axis and stores it in a given matrix
  72528. * @param angle defines the angle (in radians) to use
  72529. * @param result defines the target matrix
  72530. */
  72531. static RotationYToRef(angle: number, result: Matrix): void;
  72532. /**
  72533. * Creates a new rotation matrix for "angle" radians around the Z axis
  72534. * @param angle defines the angle (in radians) to use
  72535. * @return the new matrix
  72536. */
  72537. static RotationZ(angle: number): Matrix;
  72538. /**
  72539. * Creates a new rotation matrix for "angle" radians around the Z axis and stores it in a given matrix
  72540. * @param angle defines the angle (in radians) to use
  72541. * @param result defines the target matrix
  72542. */
  72543. static RotationZToRef(angle: number, result: Matrix): void;
  72544. /**
  72545. * Creates a new rotation matrix for "angle" radians around the given axis
  72546. * @param axis defines the axis to use
  72547. * @param angle defines the angle (in radians) to use
  72548. * @return the new matrix
  72549. */
  72550. static RotationAxis(axis: DeepImmutable<Vector3>, angle: number): Matrix;
  72551. /**
  72552. * Creates a new rotation matrix for "angle" radians around the given axis and stores it in a given matrix
  72553. * @param axis defines the axis to use
  72554. * @param angle defines the angle (in radians) to use
  72555. * @param result defines the target matrix
  72556. */
  72557. static RotationAxisToRef(axis: DeepImmutable<Vector3>, angle: number, result: Matrix): void;
  72558. /**
  72559. * Takes normalised vectors and returns a rotation matrix to align "from" with "to".
  72560. * Taken from http://www.iquilezles.org/www/articles/noacos/noacos.htm
  72561. * @param from defines the vector to align
  72562. * @param to defines the vector to align to
  72563. * @param result defines the target matrix
  72564. */
  72565. static RotationAlignToRef(from: DeepImmutable<Vector3>, to: DeepImmutable<Vector3>, result: Matrix): void;
  72566. /**
  72567. * Creates a rotation matrix
  72568. * @param yaw defines the yaw angle in radians (Y axis)
  72569. * @param pitch defines the pitch angle in radians (X axis)
  72570. * @param roll defines the roll angle in radians (X axis)
  72571. * @returns the new rotation matrix
  72572. */
  72573. static RotationYawPitchRoll(yaw: number, pitch: number, roll: number): Matrix;
  72574. /**
  72575. * Creates a rotation matrix and stores it in a given matrix
  72576. * @param yaw defines the yaw angle in radians (Y axis)
  72577. * @param pitch defines the pitch angle in radians (X axis)
  72578. * @param roll defines the roll angle in radians (X axis)
  72579. * @param result defines the target matrix
  72580. */
  72581. static RotationYawPitchRollToRef(yaw: number, pitch: number, roll: number, result: Matrix): void;
  72582. /**
  72583. * Creates a scaling matrix
  72584. * @param x defines the scale factor on X axis
  72585. * @param y defines the scale factor on Y axis
  72586. * @param z defines the scale factor on Z axis
  72587. * @returns the new matrix
  72588. */
  72589. static Scaling(x: number, y: number, z: number): Matrix;
  72590. /**
  72591. * Creates a scaling matrix and stores it in a given matrix
  72592. * @param x defines the scale factor on X axis
  72593. * @param y defines the scale factor on Y axis
  72594. * @param z defines the scale factor on Z axis
  72595. * @param result defines the target matrix
  72596. */
  72597. static ScalingToRef(x: number, y: number, z: number, result: Matrix): void;
  72598. /**
  72599. * Creates a translation matrix
  72600. * @param x defines the translation on X axis
  72601. * @param y defines the translation on Y axis
  72602. * @param z defines the translationon Z axis
  72603. * @returns the new matrix
  72604. */
  72605. static Translation(x: number, y: number, z: number): Matrix;
  72606. /**
  72607. * Creates a translation matrix and stores it in a given matrix
  72608. * @param x defines the translation on X axis
  72609. * @param y defines the translation on Y axis
  72610. * @param z defines the translationon Z axis
  72611. * @param result defines the target matrix
  72612. */
  72613. static TranslationToRef(x: number, y: number, z: number, result: Matrix): void;
  72614. /**
  72615. * Returns a new Matrix whose values are the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  72616. * @param startValue defines the start value
  72617. * @param endValue defines the end value
  72618. * @param gradient defines the gradient factor
  72619. * @returns the new matrix
  72620. */
  72621. static Lerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  72622. /**
  72623. * Set the given matrix "result" as the interpolated values for "gradient" (float) between the ones of the matrices "startValue" and "endValue".
  72624. * @param startValue defines the start value
  72625. * @param endValue defines the end value
  72626. * @param gradient defines the gradient factor
  72627. * @param result defines the Matrix object where to store data
  72628. */
  72629. static LerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  72630. /**
  72631. * Builds a new matrix whose values are computed by:
  72632. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  72633. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  72634. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  72635. * @param startValue defines the first matrix
  72636. * @param endValue defines the second matrix
  72637. * @param gradient defines the gradient between the two matrices
  72638. * @returns the new matrix
  72639. */
  72640. static DecomposeLerp(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number): Matrix;
  72641. /**
  72642. * Update a matrix to values which are computed by:
  72643. * * decomposing the the "startValue" and "endValue" matrices into their respective scale, rotation and translation matrices
  72644. * * interpolating for "gradient" (float) the values between each of these decomposed matrices between the start and the end
  72645. * * recomposing a new matrix from these 3 interpolated scale, rotation and translation matrices
  72646. * @param startValue defines the first matrix
  72647. * @param endValue defines the second matrix
  72648. * @param gradient defines the gradient between the two matrices
  72649. * @param result defines the target matrix
  72650. */
  72651. static DecomposeLerpToRef(startValue: DeepImmutable<Matrix>, endValue: DeepImmutable<Matrix>, gradient: number, result: Matrix): void;
  72652. /**
  72653. * 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"
  72654. * This function works in left handed mode
  72655. * @param eye defines the final position of the entity
  72656. * @param target defines where the entity should look at
  72657. * @param up defines the up vector for the entity
  72658. * @returns the new matrix
  72659. */
  72660. static LookAtLH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  72661. /**
  72662. * 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".
  72663. * This function works in left handed mode
  72664. * @param eye defines the final position of the entity
  72665. * @param target defines where the entity should look at
  72666. * @param up defines the up vector for the entity
  72667. * @param result defines the target matrix
  72668. */
  72669. static LookAtLHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  72670. /**
  72671. * 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"
  72672. * This function works in right handed mode
  72673. * @param eye defines the final position of the entity
  72674. * @param target defines where the entity should look at
  72675. * @param up defines the up vector for the entity
  72676. * @returns the new matrix
  72677. */
  72678. static LookAtRH(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>): Matrix;
  72679. /**
  72680. * 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".
  72681. * This function works in right handed mode
  72682. * @param eye defines the final position of the entity
  72683. * @param target defines where the entity should look at
  72684. * @param up defines the up vector for the entity
  72685. * @param result defines the target matrix
  72686. */
  72687. static LookAtRHToRef(eye: DeepImmutable<Vector3>, target: DeepImmutable<Vector3>, up: DeepImmutable<Vector3>, result: Matrix): void;
  72688. /**
  72689. * Create a left-handed orthographic projection matrix
  72690. * @param width defines the viewport width
  72691. * @param height defines the viewport height
  72692. * @param znear defines the near clip plane
  72693. * @param zfar defines the far clip plane
  72694. * @returns a new matrix as a left-handed orthographic projection matrix
  72695. */
  72696. static OrthoLH(width: number, height: number, znear: number, zfar: number): Matrix;
  72697. /**
  72698. * Store a left-handed orthographic projection to a given matrix
  72699. * @param width defines the viewport width
  72700. * @param height defines the viewport height
  72701. * @param znear defines the near clip plane
  72702. * @param zfar defines the far clip plane
  72703. * @param result defines the target matrix
  72704. */
  72705. static OrthoLHToRef(width: number, height: number, znear: number, zfar: number, result: Matrix): void;
  72706. /**
  72707. * Create a left-handed orthographic projection matrix
  72708. * @param left defines the viewport left coordinate
  72709. * @param right defines the viewport right coordinate
  72710. * @param bottom defines the viewport bottom coordinate
  72711. * @param top defines the viewport top coordinate
  72712. * @param znear defines the near clip plane
  72713. * @param zfar defines the far clip plane
  72714. * @returns a new matrix as a left-handed orthographic projection matrix
  72715. */
  72716. static OrthoOffCenterLH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  72717. /**
  72718. * Stores a left-handed orthographic projection into a given matrix
  72719. * @param left defines the viewport left coordinate
  72720. * @param right defines the viewport right coordinate
  72721. * @param bottom defines the viewport bottom coordinate
  72722. * @param top defines the viewport top coordinate
  72723. * @param znear defines the near clip plane
  72724. * @param zfar defines the far clip plane
  72725. * @param result defines the target matrix
  72726. */
  72727. static OrthoOffCenterLHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  72728. /**
  72729. * Creates a right-handed orthographic projection matrix
  72730. * @param left defines the viewport left coordinate
  72731. * @param right defines the viewport right coordinate
  72732. * @param bottom defines the viewport bottom coordinate
  72733. * @param top defines the viewport top coordinate
  72734. * @param znear defines the near clip plane
  72735. * @param zfar defines the far clip plane
  72736. * @returns a new matrix as a right-handed orthographic projection matrix
  72737. */
  72738. static OrthoOffCenterRH(left: number, right: number, bottom: number, top: number, znear: number, zfar: number): Matrix;
  72739. /**
  72740. * Stores a right-handed orthographic projection into a given matrix
  72741. * @param left defines the viewport left coordinate
  72742. * @param right defines the viewport right coordinate
  72743. * @param bottom defines the viewport bottom coordinate
  72744. * @param top defines the viewport top coordinate
  72745. * @param znear defines the near clip plane
  72746. * @param zfar defines the far clip plane
  72747. * @param result defines the target matrix
  72748. */
  72749. static OrthoOffCenterRHToRef(left: number, right: number, bottom: number, top: number, znear: number, zfar: number, result: Matrix): void;
  72750. /**
  72751. * Creates a left-handed perspective projection matrix
  72752. * @param width defines the viewport width
  72753. * @param height defines the viewport height
  72754. * @param znear defines the near clip plane
  72755. * @param zfar defines the far clip plane
  72756. * @returns a new matrix as a left-handed perspective projection matrix
  72757. */
  72758. static PerspectiveLH(width: number, height: number, znear: number, zfar: number): Matrix;
  72759. /**
  72760. * Creates a left-handed perspective projection matrix
  72761. * @param fov defines the horizontal field of view
  72762. * @param aspect defines the aspect ratio
  72763. * @param znear defines the near clip plane
  72764. * @param zfar defines the far clip plane
  72765. * @returns a new matrix as a left-handed perspective projection matrix
  72766. */
  72767. static PerspectiveFovLH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  72768. /**
  72769. * Stores a left-handed perspective projection into a given matrix
  72770. * @param fov defines the horizontal field of view
  72771. * @param aspect defines the aspect ratio
  72772. * @param znear defines the near clip plane
  72773. * @param zfar defines the far clip plane
  72774. * @param result defines the target matrix
  72775. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  72776. */
  72777. static PerspectiveFovLHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  72778. /**
  72779. * Creates a right-handed perspective projection matrix
  72780. * @param fov defines the horizontal field of view
  72781. * @param aspect defines the aspect ratio
  72782. * @param znear defines the near clip plane
  72783. * @param zfar defines the far clip plane
  72784. * @returns a new matrix as a right-handed perspective projection matrix
  72785. */
  72786. static PerspectiveFovRH(fov: number, aspect: number, znear: number, zfar: number): Matrix;
  72787. /**
  72788. * Stores a right-handed perspective projection into a given matrix
  72789. * @param fov defines the horizontal field of view
  72790. * @param aspect defines the aspect ratio
  72791. * @param znear defines the near clip plane
  72792. * @param zfar defines the far clip plane
  72793. * @param result defines the target matrix
  72794. * @param isVerticalFovFixed defines it the fov is vertically fixed (default) or horizontally
  72795. */
  72796. static PerspectiveFovRHToRef(fov: number, aspect: number, znear: number, zfar: number, result: Matrix, isVerticalFovFixed?: boolean): void;
  72797. /**
  72798. * Stores a perspective projection for WebVR info a given matrix
  72799. * @param fov defines the field of view
  72800. * @param znear defines the near clip plane
  72801. * @param zfar defines the far clip plane
  72802. * @param result defines the target matrix
  72803. * @param rightHanded defines if the matrix must be in right-handed mode (false by default)
  72804. */
  72805. static PerspectiveFovWebVRToRef(fov: {
  72806. upDegrees: number;
  72807. downDegrees: number;
  72808. leftDegrees: number;
  72809. rightDegrees: number;
  72810. }, znear: number, zfar: number, result: Matrix, rightHanded?: boolean): void;
  72811. /**
  72812. * Computes a complete transformation matrix
  72813. * @param viewport defines the viewport to use
  72814. * @param world defines the world matrix
  72815. * @param view defines the view matrix
  72816. * @param projection defines the projection matrix
  72817. * @param zmin defines the near clip plane
  72818. * @param zmax defines the far clip plane
  72819. * @returns the transformation matrix
  72820. */
  72821. static GetFinalMatrix(viewport: DeepImmutable<Viewport>, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>, zmin: number, zmax: number): Matrix;
  72822. /**
  72823. * Extracts a 2x2 matrix from a given matrix and store the result in a Float32Array
  72824. * @param matrix defines the matrix to use
  72825. * @returns a new Float32Array array with 4 elements : the 2x2 matrix extracted from the given matrix
  72826. */
  72827. static GetAsMatrix2x2(matrix: DeepImmutable<Matrix>): Float32Array;
  72828. /**
  72829. * Extracts a 3x3 matrix from a given matrix and store the result in a Float32Array
  72830. * @param matrix defines the matrix to use
  72831. * @returns a new Float32Array array with 9 elements : the 3x3 matrix extracted from the given matrix
  72832. */
  72833. static GetAsMatrix3x3(matrix: DeepImmutable<Matrix>): Float32Array;
  72834. /**
  72835. * Compute the transpose of a given matrix
  72836. * @param matrix defines the matrix to transpose
  72837. * @returns the new matrix
  72838. */
  72839. static Transpose(matrix: DeepImmutable<Matrix>): Matrix;
  72840. /**
  72841. * Compute the transpose of a matrix and store it in a target matrix
  72842. * @param matrix defines the matrix to transpose
  72843. * @param result defines the target matrix
  72844. */
  72845. static TransposeToRef(matrix: DeepImmutable<Matrix>, result: Matrix): void;
  72846. /**
  72847. * Computes a reflection matrix from a plane
  72848. * @param plane defines the reflection plane
  72849. * @returns a new matrix
  72850. */
  72851. static Reflection(plane: DeepImmutable<IPlaneLike>): Matrix;
  72852. /**
  72853. * Computes a reflection matrix from a plane
  72854. * @param plane defines the reflection plane
  72855. * @param result defines the target matrix
  72856. */
  72857. static ReflectionToRef(plane: DeepImmutable<IPlaneLike>, result: Matrix): void;
  72858. /**
  72859. * Sets the given matrix as a rotation matrix composed from the 3 left handed axes
  72860. * @param xaxis defines the value of the 1st axis
  72861. * @param yaxis defines the value of the 2nd axis
  72862. * @param zaxis defines the value of the 3rd axis
  72863. * @param result defines the target matrix
  72864. */
  72865. static FromXYZAxesToRef(xaxis: DeepImmutable<Vector3>, yaxis: DeepImmutable<Vector3>, zaxis: DeepImmutable<Vector3>, result: Matrix): void;
  72866. /**
  72867. * Creates a rotation matrix from a quaternion and stores it in a target matrix
  72868. * @param quat defines the quaternion to use
  72869. * @param result defines the target matrix
  72870. */
  72871. static FromQuaternionToRef(quat: DeepImmutable<Quaternion>, result: Matrix): void;
  72872. }
  72873. /**
  72874. * @hidden
  72875. */
  72876. export class TmpVectors {
  72877. static Vector2: Vector2[];
  72878. static Vector3: Vector3[];
  72879. static Vector4: Vector4[];
  72880. static Quaternion: Quaternion[];
  72881. static Matrix: Matrix[];
  72882. }
  72883. }
  72884. declare module BABYLON {
  72885. /**
  72886. * Defines potential orientation for back face culling
  72887. */
  72888. export enum Orientation {
  72889. /**
  72890. * Clockwise
  72891. */
  72892. CW = 0,
  72893. /** Counter clockwise */
  72894. CCW = 1
  72895. }
  72896. /** Class used to represent a Bezier curve */
  72897. export class BezierCurve {
  72898. /**
  72899. * Returns the cubic Bezier interpolated value (float) at "t" (float) from the given x1, y1, x2, y2 floats
  72900. * @param t defines the time
  72901. * @param x1 defines the left coordinate on X axis
  72902. * @param y1 defines the left coordinate on Y axis
  72903. * @param x2 defines the right coordinate on X axis
  72904. * @param y2 defines the right coordinate on Y axis
  72905. * @returns the interpolated value
  72906. */
  72907. static Interpolate(t: number, x1: number, y1: number, x2: number, y2: number): number;
  72908. }
  72909. /**
  72910. * Defines angle representation
  72911. */
  72912. export class Angle {
  72913. private _radians;
  72914. /**
  72915. * Creates an Angle object of "radians" radians (float).
  72916. * @param radians the angle in radians
  72917. */
  72918. constructor(radians: number);
  72919. /**
  72920. * Get value in degrees
  72921. * @returns the Angle value in degrees (float)
  72922. */
  72923. degrees(): number;
  72924. /**
  72925. * Get value in radians
  72926. * @returns the Angle value in radians (float)
  72927. */
  72928. radians(): number;
  72929. /**
  72930. * Gets a new Angle object valued with the angle value in radians between the two given vectors
  72931. * @param a defines first vector
  72932. * @param b defines second vector
  72933. * @returns a new Angle
  72934. */
  72935. static BetweenTwoPoints(a: DeepImmutable<Vector2>, b: DeepImmutable<Vector2>): Angle;
  72936. /**
  72937. * Gets a new Angle object from the given float in radians
  72938. * @param radians defines the angle value in radians
  72939. * @returns a new Angle
  72940. */
  72941. static FromRadians(radians: number): Angle;
  72942. /**
  72943. * Gets a new Angle object from the given float in degrees
  72944. * @param degrees defines the angle value in degrees
  72945. * @returns a new Angle
  72946. */
  72947. static FromDegrees(degrees: number): Angle;
  72948. }
  72949. /**
  72950. * This represents an arc in a 2d space.
  72951. */
  72952. export class Arc2 {
  72953. /** Defines the start point of the arc */
  72954. startPoint: Vector2;
  72955. /** Defines the mid point of the arc */
  72956. midPoint: Vector2;
  72957. /** Defines the end point of the arc */
  72958. endPoint: Vector2;
  72959. /**
  72960. * Defines the center point of the arc.
  72961. */
  72962. centerPoint: Vector2;
  72963. /**
  72964. * Defines the radius of the arc.
  72965. */
  72966. radius: number;
  72967. /**
  72968. * Defines the angle of the arc (from mid point to end point).
  72969. */
  72970. angle: Angle;
  72971. /**
  72972. * Defines the start angle of the arc (from start point to middle point).
  72973. */
  72974. startAngle: Angle;
  72975. /**
  72976. * Defines the orientation of the arc (clock wise/counter clock wise).
  72977. */
  72978. orientation: Orientation;
  72979. /**
  72980. * Creates an Arc object from the three given points : start, middle and end.
  72981. * @param startPoint Defines the start point of the arc
  72982. * @param midPoint Defines the midlle point of the arc
  72983. * @param endPoint Defines the end point of the arc
  72984. */
  72985. constructor(
  72986. /** Defines the start point of the arc */
  72987. startPoint: Vector2,
  72988. /** Defines the mid point of the arc */
  72989. midPoint: Vector2,
  72990. /** Defines the end point of the arc */
  72991. endPoint: Vector2);
  72992. }
  72993. /**
  72994. * Represents a 2D path made up of multiple 2D points
  72995. */
  72996. export class Path2 {
  72997. private _points;
  72998. private _length;
  72999. /**
  73000. * If the path start and end point are the same
  73001. */
  73002. closed: boolean;
  73003. /**
  73004. * Creates a Path2 object from the starting 2D coordinates x and y.
  73005. * @param x the starting points x value
  73006. * @param y the starting points y value
  73007. */
  73008. constructor(x: number, y: number);
  73009. /**
  73010. * Adds a new segment until the given coordinates (x, y) to the current Path2.
  73011. * @param x the added points x value
  73012. * @param y the added points y value
  73013. * @returns the updated Path2.
  73014. */
  73015. addLineTo(x: number, y: number): Path2;
  73016. /**
  73017. * 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.
  73018. * @param midX middle point x value
  73019. * @param midY middle point y value
  73020. * @param endX end point x value
  73021. * @param endY end point y value
  73022. * @param numberOfSegments (default: 36)
  73023. * @returns the updated Path2.
  73024. */
  73025. addArcTo(midX: number, midY: number, endX: number, endY: number, numberOfSegments?: number): Path2;
  73026. /**
  73027. * Closes the Path2.
  73028. * @returns the Path2.
  73029. */
  73030. close(): Path2;
  73031. /**
  73032. * Gets the sum of the distance between each sequential point in the path
  73033. * @returns the Path2 total length (float).
  73034. */
  73035. length(): number;
  73036. /**
  73037. * Gets the points which construct the path
  73038. * @returns the Path2 internal array of points.
  73039. */
  73040. getPoints(): Vector2[];
  73041. /**
  73042. * Retreives the point at the distance aways from the starting point
  73043. * @param normalizedLengthPosition the length along the path to retreive the point from
  73044. * @returns a new Vector2 located at a percentage of the Path2 total length on this path.
  73045. */
  73046. getPointAtLengthPosition(normalizedLengthPosition: number): Vector2;
  73047. /**
  73048. * Creates a new path starting from an x and y position
  73049. * @param x starting x value
  73050. * @param y starting y value
  73051. * @returns a new Path2 starting at the coordinates (x, y).
  73052. */
  73053. static StartingAt(x: number, y: number): Path2;
  73054. }
  73055. /**
  73056. * Represents a 3D path made up of multiple 3D points
  73057. */
  73058. export class Path3D {
  73059. /**
  73060. * an array of Vector3, the curve axis of the Path3D
  73061. */
  73062. path: Vector3[];
  73063. private _curve;
  73064. private _distances;
  73065. private _tangents;
  73066. private _normals;
  73067. private _binormals;
  73068. private _raw;
  73069. private _alignTangentsWithPath;
  73070. private readonly _pointAtData;
  73071. /**
  73072. * new Path3D(path, normal, raw)
  73073. * Creates a Path3D. A Path3D is a logical math object, so not a mesh.
  73074. * please read the description in the tutorial : https://doc.babylonjs.com/how_to/how_to_use_path3d
  73075. * @param path an array of Vector3, the curve axis of the Path3D
  73076. * @param firstNormal (options) Vector3, the first wanted normal to the curve. Ex (0, 1, 0) for a vertical normal.
  73077. * @param raw (optional, default false) : boolean, if true the returned Path3D isn't normalized. Useful to depict path acceleration or speed.
  73078. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path.
  73079. */
  73080. constructor(
  73081. /**
  73082. * an array of Vector3, the curve axis of the Path3D
  73083. */
  73084. path: Vector3[], firstNormal?: Nullable<Vector3>, raw?: boolean, alignTangentsWithPath?: boolean);
  73085. /**
  73086. * Returns the Path3D array of successive Vector3 designing its curve.
  73087. * @returns the Path3D array of successive Vector3 designing its curve.
  73088. */
  73089. getCurve(): Vector3[];
  73090. /**
  73091. * Returns the Path3D array of successive Vector3 designing its curve.
  73092. * @returns the Path3D array of successive Vector3 designing its curve.
  73093. */
  73094. getPoints(): Vector3[];
  73095. /**
  73096. * @returns the computed length (float) of the path.
  73097. */
  73098. length(): number;
  73099. /**
  73100. * Returns an array populated with tangent vectors on each Path3D curve point.
  73101. * @returns an array populated with tangent vectors on each Path3D curve point.
  73102. */
  73103. getTangents(): Vector3[];
  73104. /**
  73105. * Returns an array populated with normal vectors on each Path3D curve point.
  73106. * @returns an array populated with normal vectors on each Path3D curve point.
  73107. */
  73108. getNormals(): Vector3[];
  73109. /**
  73110. * Returns an array populated with binormal vectors on each Path3D curve point.
  73111. * @returns an array populated with binormal vectors on each Path3D curve point.
  73112. */
  73113. getBinormals(): Vector3[];
  73114. /**
  73115. * Returns an array populated with distances (float) of the i-th point from the first curve point.
  73116. * @returns an array populated with distances (float) of the i-th point from the first curve point.
  73117. */
  73118. getDistances(): number[];
  73119. /**
  73120. * Returns an interpolated point along this path
  73121. * @param position the position of the point along this path, from 0.0 to 1.0
  73122. * @returns a new Vector3 as the point
  73123. */
  73124. getPointAt(position: number): Vector3;
  73125. /**
  73126. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  73127. * @param position the position of the point along this path, from 0.0 to 1.0
  73128. * @param interpolated (optional, default false) : boolean, if true returns an interpolated tangent instead of the tangent of the previous path point.
  73129. * @returns a tangent vector corresponding to the interpolated Path3D curve point, if not interpolated, the tangent is taken from the precomputed tangents array.
  73130. */
  73131. getTangentAt(position: number, interpolated?: boolean): Vector3;
  73132. /**
  73133. * Returns the tangent vector of an interpolated Path3D curve point at the specified position along this path.
  73134. * @param position the position of the point along this path, from 0.0 to 1.0
  73135. * @param interpolated (optional, default false) : boolean, if true returns an interpolated normal instead of the normal of the previous path point.
  73136. * @returns a normal vector corresponding to the interpolated Path3D curve point, if not interpolated, the normal is taken from the precomputed normals array.
  73137. */
  73138. getNormalAt(position: number, interpolated?: boolean): Vector3;
  73139. /**
  73140. * Returns the binormal vector of an interpolated Path3D curve point at the specified position along this path.
  73141. * @param position the position of the point along this path, from 0.0 to 1.0
  73142. * @param interpolated (optional, default false) : boolean, if true returns an interpolated binormal instead of the binormal of the previous path point.
  73143. * @returns a binormal vector corresponding to the interpolated Path3D curve point, if not interpolated, the binormal is taken from the precomputed binormals array.
  73144. */
  73145. getBinormalAt(position: number, interpolated?: boolean): Vector3;
  73146. /**
  73147. * Returns the distance (float) of an interpolated Path3D curve point at the specified position along this path.
  73148. * @param position the position of the point along this path, from 0.0 to 1.0
  73149. * @returns the distance of the interpolated Path3D curve point at the specified position along this path.
  73150. */
  73151. getDistanceAt(position: number): number;
  73152. /**
  73153. * Returns the array index of the previous point of an interpolated point along this path
  73154. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  73155. * @returns the array index
  73156. */
  73157. getPreviousPointIndexAt(position: number): number;
  73158. /**
  73159. * Returns the position of an interpolated point relative to the two path points it lies between, from 0.0 (point A) to 1.0 (point B)
  73160. * @param position the position of the point to interpolate along this path, from 0.0 to 1.0
  73161. * @returns the sub position
  73162. */
  73163. getSubPositionAt(position: number): number;
  73164. /**
  73165. * Returns the position of the closest virtual point on this path to an arbitrary Vector3, from 0.0 to 1.0
  73166. * @param target the vector of which to get the closest position to
  73167. * @returns the position of the closest virtual point on this path to the target vector
  73168. */
  73169. getClosestPositionTo(target: Vector3): number;
  73170. /**
  73171. * Returns a sub path (slice) of this path
  73172. * @param start the position of the fist path point, from 0.0 to 1.0, or a negative value, which will get wrapped around from the end of the path to 0.0 to 1.0 values
  73173. * @param end the position of the last path point, from 0.0 to 1.0, or a negative value, which will get wrapped around from the end of the path to 0.0 to 1.0 values
  73174. * @returns a sub path (slice) of this path
  73175. */
  73176. slice(start?: number, end?: number): Path3D;
  73177. /**
  73178. * Forces the Path3D tangent, normal, binormal and distance recomputation.
  73179. * @param path path which all values are copied into the curves points
  73180. * @param firstNormal which should be projected onto the curve
  73181. * @param alignTangentsWithPath (optional, default false) : boolean, if true the tangents will be aligned with the path
  73182. * @returns the same object updated.
  73183. */
  73184. update(path: Vector3[], firstNormal?: Nullable<Vector3>, alignTangentsWithPath?: boolean): Path3D;
  73185. private _compute;
  73186. private _getFirstNonNullVector;
  73187. private _getLastNonNullVector;
  73188. private _normalVector;
  73189. /**
  73190. * Updates the point at data for an interpolated point along this curve
  73191. * @param position the position of the point along this curve, from 0.0 to 1.0
  73192. * @interpolateTNB wether to compute the interpolated tangent, normal and binormal
  73193. * @returns the (updated) point at data
  73194. */
  73195. private _updatePointAtData;
  73196. /**
  73197. * Updates the point at data from the specified parameters
  73198. * @param position where along the path the interpolated point is, from 0.0 to 1.0
  73199. * @param point the interpolated point
  73200. * @param parentIndex the index of an existing curve point that is on, or else positionally the first behind, the interpolated point
  73201. */
  73202. private _setPointAtData;
  73203. /**
  73204. * Updates the point at interpolation matrix for the tangents, normals and binormals
  73205. */
  73206. private _updateInterpolationMatrix;
  73207. }
  73208. /**
  73209. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  73210. * A Curve3 is designed from a series of successive Vector3.
  73211. * @see https://doc.babylonjs.com/how_to/how_to_use_curve3
  73212. */
  73213. export class Curve3 {
  73214. private _points;
  73215. private _length;
  73216. /**
  73217. * Returns a Curve3 object along a Quadratic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#quadratic-bezier-curve
  73218. * @param v0 (Vector3) the origin point of the Quadratic Bezier
  73219. * @param v1 (Vector3) the control point
  73220. * @param v2 (Vector3) the end point of the Quadratic Bezier
  73221. * @param nbPoints (integer) the wanted number of points in the curve
  73222. * @returns the created Curve3
  73223. */
  73224. static CreateQuadraticBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  73225. /**
  73226. * Returns a Curve3 object along a Cubic Bezier curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#cubic-bezier-curve
  73227. * @param v0 (Vector3) the origin point of the Cubic Bezier
  73228. * @param v1 (Vector3) the first control point
  73229. * @param v2 (Vector3) the second control point
  73230. * @param v3 (Vector3) the end point of the Cubic Bezier
  73231. * @param nbPoints (integer) the wanted number of points in the curve
  73232. * @returns the created Curve3
  73233. */
  73234. static CreateCubicBezier(v0: DeepImmutable<Vector3>, v1: DeepImmutable<Vector3>, v2: DeepImmutable<Vector3>, v3: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  73235. /**
  73236. * Returns a Curve3 object along a Hermite Spline curve : https://doc.babylonjs.com/how_to/how_to_use_curve3#hermite-spline
  73237. * @param p1 (Vector3) the origin point of the Hermite Spline
  73238. * @param t1 (Vector3) the tangent vector at the origin point
  73239. * @param p2 (Vector3) the end point of the Hermite Spline
  73240. * @param t2 (Vector3) the tangent vector at the end point
  73241. * @param nbPoints (integer) the wanted number of points in the curve
  73242. * @returns the created Curve3
  73243. */
  73244. static CreateHermiteSpline(p1: DeepImmutable<Vector3>, t1: DeepImmutable<Vector3>, p2: DeepImmutable<Vector3>, t2: DeepImmutable<Vector3>, nbPoints: number): Curve3;
  73245. /**
  73246. * Returns a Curve3 object along a CatmullRom Spline curve :
  73247. * @param points (array of Vector3) the points the spline must pass through. At least, four points required
  73248. * @param nbPoints (integer) the wanted number of points between each curve control points
  73249. * @param closed (boolean) optional with default false, when true forms a closed loop from the points
  73250. * @returns the created Curve3
  73251. */
  73252. static CreateCatmullRomSpline(points: DeepImmutable<Vector3[]>, nbPoints: number, closed?: boolean): Curve3;
  73253. /**
  73254. * A Curve3 object is a logical object, so not a mesh, to handle curves in the 3D geometric space.
  73255. * A Curve3 is designed from a series of successive Vector3.
  73256. * Tuto : https://doc.babylonjs.com/how_to/how_to_use_curve3#curve3-object
  73257. * @param points points which make up the curve
  73258. */
  73259. constructor(points: Vector3[]);
  73260. /**
  73261. * @returns the Curve3 stored array of successive Vector3
  73262. */
  73263. getPoints(): Vector3[];
  73264. /**
  73265. * @returns the computed length (float) of the curve.
  73266. */
  73267. length(): number;
  73268. /**
  73269. * Returns a new instance of Curve3 object : var curve = curveA.continue(curveB);
  73270. * This new Curve3 is built by translating and sticking the curveB at the end of the curveA.
  73271. * curveA and curveB keep unchanged.
  73272. * @param curve the curve to continue from this curve
  73273. * @returns the newly constructed curve
  73274. */
  73275. continue(curve: DeepImmutable<Curve3>): Curve3;
  73276. private _computeLength;
  73277. }
  73278. }
  73279. declare module BABYLON {
  73280. /**
  73281. * This represents the main contract an easing function should follow.
  73282. * Easing functions are used throughout the animation system.
  73283. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  73284. */
  73285. export interface IEasingFunction {
  73286. /**
  73287. * Given an input gradient between 0 and 1, this returns the corrseponding value
  73288. * of the easing function.
  73289. * The link below provides some of the most common examples of easing functions.
  73290. * @see https://easings.net/
  73291. * @param gradient Defines the value between 0 and 1 we want the easing value for
  73292. * @returns the corresponding value on the curve defined by the easing function
  73293. */
  73294. ease(gradient: number): number;
  73295. }
  73296. /**
  73297. * Base class used for every default easing function.
  73298. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  73299. */
  73300. export class EasingFunction implements IEasingFunction {
  73301. /**
  73302. * Interpolation follows the mathematical formula associated with the easing function.
  73303. */
  73304. static readonly EASINGMODE_EASEIN: number;
  73305. /**
  73306. * Interpolation follows 100% interpolation minus the output of the formula associated with the easing function.
  73307. */
  73308. static readonly EASINGMODE_EASEOUT: number;
  73309. /**
  73310. * Interpolation uses EaseIn for the first half of the animation and EaseOut for the second half.
  73311. */
  73312. static readonly EASINGMODE_EASEINOUT: number;
  73313. private _easingMode;
  73314. /**
  73315. * Sets the easing mode of the current function.
  73316. * @param easingMode Defines the willing mode (EASINGMODE_EASEIN, EASINGMODE_EASEOUT or EASINGMODE_EASEINOUT)
  73317. */
  73318. setEasingMode(easingMode: number): void;
  73319. /**
  73320. * Gets the current easing mode.
  73321. * @returns the easing mode
  73322. */
  73323. getEasingMode(): number;
  73324. /**
  73325. * @hidden
  73326. */
  73327. easeInCore(gradient: number): number;
  73328. /**
  73329. * Given an input gradient between 0 and 1, this returns the corresponding value
  73330. * of the easing function.
  73331. * @param gradient Defines the value between 0 and 1 we want the easing value for
  73332. * @returns the corresponding value on the curve defined by the easing function
  73333. */
  73334. ease(gradient: number): number;
  73335. }
  73336. /**
  73337. * Easing function with a circle shape (see link below).
  73338. * @see https://easings.net/#easeInCirc
  73339. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  73340. */
  73341. export class CircleEase extends EasingFunction implements IEasingFunction {
  73342. /** @hidden */
  73343. easeInCore(gradient: number): number;
  73344. }
  73345. /**
  73346. * Easing function with a ease back shape (see link below).
  73347. * @see https://easings.net/#easeInBack
  73348. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  73349. */
  73350. export class BackEase extends EasingFunction implements IEasingFunction {
  73351. /** Defines the amplitude of the function */
  73352. amplitude: number;
  73353. /**
  73354. * Instantiates a back ease easing
  73355. * @see https://easings.net/#easeInBack
  73356. * @param amplitude Defines the amplitude of the function
  73357. */
  73358. constructor(
  73359. /** Defines the amplitude of the function */
  73360. amplitude?: number);
  73361. /** @hidden */
  73362. easeInCore(gradient: number): number;
  73363. }
  73364. /**
  73365. * Easing function with a bouncing shape (see link below).
  73366. * @see https://easings.net/#easeInBounce
  73367. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  73368. */
  73369. export class BounceEase extends EasingFunction implements IEasingFunction {
  73370. /** Defines the number of bounces */
  73371. bounces: number;
  73372. /** Defines the amplitude of the bounce */
  73373. bounciness: number;
  73374. /**
  73375. * Instantiates a bounce easing
  73376. * @see https://easings.net/#easeInBounce
  73377. * @param bounces Defines the number of bounces
  73378. * @param bounciness Defines the amplitude of the bounce
  73379. */
  73380. constructor(
  73381. /** Defines the number of bounces */
  73382. bounces?: number,
  73383. /** Defines the amplitude of the bounce */
  73384. bounciness?: number);
  73385. /** @hidden */
  73386. easeInCore(gradient: number): number;
  73387. }
  73388. /**
  73389. * Easing function with a power of 3 shape (see link below).
  73390. * @see https://easings.net/#easeInCubic
  73391. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  73392. */
  73393. export class CubicEase extends EasingFunction implements IEasingFunction {
  73394. /** @hidden */
  73395. easeInCore(gradient: number): number;
  73396. }
  73397. /**
  73398. * Easing function with an elastic shape (see link below).
  73399. * @see https://easings.net/#easeInElastic
  73400. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  73401. */
  73402. export class ElasticEase extends EasingFunction implements IEasingFunction {
  73403. /** Defines the number of oscillations*/
  73404. oscillations: number;
  73405. /** Defines the amplitude of the oscillations*/
  73406. springiness: number;
  73407. /**
  73408. * Instantiates an elastic easing function
  73409. * @see https://easings.net/#easeInElastic
  73410. * @param oscillations Defines the number of oscillations
  73411. * @param springiness Defines the amplitude of the oscillations
  73412. */
  73413. constructor(
  73414. /** Defines the number of oscillations*/
  73415. oscillations?: number,
  73416. /** Defines the amplitude of the oscillations*/
  73417. springiness?: number);
  73418. /** @hidden */
  73419. easeInCore(gradient: number): number;
  73420. }
  73421. /**
  73422. * Easing function with an exponential shape (see link below).
  73423. * @see https://easings.net/#easeInExpo
  73424. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  73425. */
  73426. export class ExponentialEase extends EasingFunction implements IEasingFunction {
  73427. /** Defines the exponent of the function */
  73428. exponent: number;
  73429. /**
  73430. * Instantiates an exponential easing function
  73431. * @see https://easings.net/#easeInExpo
  73432. * @param exponent Defines the exponent of the function
  73433. */
  73434. constructor(
  73435. /** Defines the exponent of the function */
  73436. exponent?: number);
  73437. /** @hidden */
  73438. easeInCore(gradient: number): number;
  73439. }
  73440. /**
  73441. * Easing function with a power shape (see link below).
  73442. * @see https://easings.net/#easeInQuad
  73443. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  73444. */
  73445. export class PowerEase extends EasingFunction implements IEasingFunction {
  73446. /** Defines the power of the function */
  73447. power: number;
  73448. /**
  73449. * Instantiates an power base easing function
  73450. * @see https://easings.net/#easeInQuad
  73451. * @param power Defines the power of the function
  73452. */
  73453. constructor(
  73454. /** Defines the power of the function */
  73455. power?: number);
  73456. /** @hidden */
  73457. easeInCore(gradient: number): number;
  73458. }
  73459. /**
  73460. * Easing function with a power of 2 shape (see link below).
  73461. * @see https://easings.net/#easeInQuad
  73462. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  73463. */
  73464. export class QuadraticEase extends EasingFunction implements IEasingFunction {
  73465. /** @hidden */
  73466. easeInCore(gradient: number): number;
  73467. }
  73468. /**
  73469. * Easing function with a power of 4 shape (see link below).
  73470. * @see https://easings.net/#easeInQuart
  73471. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  73472. */
  73473. export class QuarticEase extends EasingFunction implements IEasingFunction {
  73474. /** @hidden */
  73475. easeInCore(gradient: number): number;
  73476. }
  73477. /**
  73478. * Easing function with a power of 5 shape (see link below).
  73479. * @see https://easings.net/#easeInQuint
  73480. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  73481. */
  73482. export class QuinticEase extends EasingFunction implements IEasingFunction {
  73483. /** @hidden */
  73484. easeInCore(gradient: number): number;
  73485. }
  73486. /**
  73487. * Easing function with a sin shape (see link below).
  73488. * @see https://easings.net/#easeInSine
  73489. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  73490. */
  73491. export class SineEase extends EasingFunction implements IEasingFunction {
  73492. /** @hidden */
  73493. easeInCore(gradient: number): number;
  73494. }
  73495. /**
  73496. * Easing function with a bezier shape (see link below).
  73497. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  73498. * @see http://doc.babylonjs.com/babylon101/animations#easing-functions
  73499. */
  73500. export class BezierCurveEase extends EasingFunction implements IEasingFunction {
  73501. /** Defines the x component of the start tangent in the bezier curve */
  73502. x1: number;
  73503. /** Defines the y component of the start tangent in the bezier curve */
  73504. y1: number;
  73505. /** Defines the x component of the end tangent in the bezier curve */
  73506. x2: number;
  73507. /** Defines the y component of the end tangent in the bezier curve */
  73508. y2: number;
  73509. /**
  73510. * Instantiates a bezier function
  73511. * @see http://cubic-bezier.com/#.17,.67,.83,.67
  73512. * @param x1 Defines the x component of the start tangent in the bezier curve
  73513. * @param y1 Defines the y component of the start tangent in the bezier curve
  73514. * @param x2 Defines the x component of the end tangent in the bezier curve
  73515. * @param y2 Defines the y component of the end tangent in the bezier curve
  73516. */
  73517. constructor(
  73518. /** Defines the x component of the start tangent in the bezier curve */
  73519. x1?: number,
  73520. /** Defines the y component of the start tangent in the bezier curve */
  73521. y1?: number,
  73522. /** Defines the x component of the end tangent in the bezier curve */
  73523. x2?: number,
  73524. /** Defines the y component of the end tangent in the bezier curve */
  73525. y2?: number);
  73526. /** @hidden */
  73527. easeInCore(gradient: number): number;
  73528. }
  73529. }
  73530. declare module BABYLON {
  73531. /**
  73532. * Class used to hold a RBG color
  73533. */
  73534. export class Color3 {
  73535. /**
  73536. * Defines the red component (between 0 and 1, default is 0)
  73537. */
  73538. r: number;
  73539. /**
  73540. * Defines the green component (between 0 and 1, default is 0)
  73541. */
  73542. g: number;
  73543. /**
  73544. * Defines the blue component (between 0 and 1, default is 0)
  73545. */
  73546. b: number;
  73547. /**
  73548. * Creates a new Color3 object from red, green, blue values, all between 0 and 1
  73549. * @param r defines the red component (between 0 and 1, default is 0)
  73550. * @param g defines the green component (between 0 and 1, default is 0)
  73551. * @param b defines the blue component (between 0 and 1, default is 0)
  73552. */
  73553. constructor(
  73554. /**
  73555. * Defines the red component (between 0 and 1, default is 0)
  73556. */
  73557. r?: number,
  73558. /**
  73559. * Defines the green component (between 0 and 1, default is 0)
  73560. */
  73561. g?: number,
  73562. /**
  73563. * Defines the blue component (between 0 and 1, default is 0)
  73564. */
  73565. b?: number);
  73566. /**
  73567. * Creates a string with the Color3 current values
  73568. * @returns the string representation of the Color3 object
  73569. */
  73570. toString(): string;
  73571. /**
  73572. * Returns the string "Color3"
  73573. * @returns "Color3"
  73574. */
  73575. getClassName(): string;
  73576. /**
  73577. * Compute the Color3 hash code
  73578. * @returns an unique number that can be used to hash Color3 objects
  73579. */
  73580. getHashCode(): number;
  73581. /**
  73582. * Stores in the given array from the given starting index the red, green, blue values as successive elements
  73583. * @param array defines the array where to store the r,g,b components
  73584. * @param index defines an optional index in the target array to define where to start storing values
  73585. * @returns the current Color3 object
  73586. */
  73587. toArray(array: FloatArray, index?: number): Color3;
  73588. /**
  73589. * Returns a new Color4 object from the current Color3 and the given alpha
  73590. * @param alpha defines the alpha component on the new Color4 object (default is 1)
  73591. * @returns a new Color4 object
  73592. */
  73593. toColor4(alpha?: number): Color4;
  73594. /**
  73595. * Returns a new array populated with 3 numeric elements : red, green and blue values
  73596. * @returns the new array
  73597. */
  73598. asArray(): number[];
  73599. /**
  73600. * Returns the luminance value
  73601. * @returns a float value
  73602. */
  73603. toLuminance(): number;
  73604. /**
  73605. * Multiply each Color3 rgb values by the given Color3 rgb values in a new Color3 object
  73606. * @param otherColor defines the second operand
  73607. * @returns the new Color3 object
  73608. */
  73609. multiply(otherColor: DeepImmutable<Color3>): Color3;
  73610. /**
  73611. * Multiply the rgb values of the Color3 and the given Color3 and stores the result in the object "result"
  73612. * @param otherColor defines the second operand
  73613. * @param result defines the Color3 object where to store the result
  73614. * @returns the current Color3
  73615. */
  73616. multiplyToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  73617. /**
  73618. * Determines equality between Color3 objects
  73619. * @param otherColor defines the second operand
  73620. * @returns true if the rgb values are equal to the given ones
  73621. */
  73622. equals(otherColor: DeepImmutable<Color3>): boolean;
  73623. /**
  73624. * Determines equality between the current Color3 object and a set of r,b,g values
  73625. * @param r defines the red component to check
  73626. * @param g defines the green component to check
  73627. * @param b defines the blue component to check
  73628. * @returns true if the rgb values are equal to the given ones
  73629. */
  73630. equalsFloats(r: number, g: number, b: number): boolean;
  73631. /**
  73632. * Multiplies in place each rgb value by scale
  73633. * @param scale defines the scaling factor
  73634. * @returns the updated Color3
  73635. */
  73636. scale(scale: number): Color3;
  73637. /**
  73638. * Multiplies the rgb values by scale and stores the result into "result"
  73639. * @param scale defines the scaling factor
  73640. * @param result defines the Color3 object where to store the result
  73641. * @returns the unmodified current Color3
  73642. */
  73643. scaleToRef(scale: number, result: Color3): Color3;
  73644. /**
  73645. * Scale the current Color3 values by a factor and add the result to a given Color3
  73646. * @param scale defines the scale factor
  73647. * @param result defines color to store the result into
  73648. * @returns the unmodified current Color3
  73649. */
  73650. scaleAndAddToRef(scale: number, result: Color3): Color3;
  73651. /**
  73652. * Clamps the rgb values by the min and max values and stores the result into "result"
  73653. * @param min defines minimum clamping value (default is 0)
  73654. * @param max defines maximum clamping value (default is 1)
  73655. * @param result defines color to store the result into
  73656. * @returns the original Color3
  73657. */
  73658. clampToRef(min: number | undefined, max: number | undefined, result: Color3): Color3;
  73659. /**
  73660. * Creates a new Color3 set with the added values of the current Color3 and of the given one
  73661. * @param otherColor defines the second operand
  73662. * @returns the new Color3
  73663. */
  73664. add(otherColor: DeepImmutable<Color3>): Color3;
  73665. /**
  73666. * Stores the result of the addition of the current Color3 and given one rgb values into "result"
  73667. * @param otherColor defines the second operand
  73668. * @param result defines Color3 object to store the result into
  73669. * @returns the unmodified current Color3
  73670. */
  73671. addToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  73672. /**
  73673. * Returns a new Color3 set with the subtracted values of the given one from the current Color3
  73674. * @param otherColor defines the second operand
  73675. * @returns the new Color3
  73676. */
  73677. subtract(otherColor: DeepImmutable<Color3>): Color3;
  73678. /**
  73679. * Stores the result of the subtraction of given one from the current Color3 rgb values into "result"
  73680. * @param otherColor defines the second operand
  73681. * @param result defines Color3 object to store the result into
  73682. * @returns the unmodified current Color3
  73683. */
  73684. subtractToRef(otherColor: DeepImmutable<Color3>, result: Color3): Color3;
  73685. /**
  73686. * Copy the current object
  73687. * @returns a new Color3 copied the current one
  73688. */
  73689. clone(): Color3;
  73690. /**
  73691. * Copies the rgb values from the source in the current Color3
  73692. * @param source defines the source Color3 object
  73693. * @returns the updated Color3 object
  73694. */
  73695. copyFrom(source: DeepImmutable<Color3>): Color3;
  73696. /**
  73697. * Updates the Color3 rgb values from the given floats
  73698. * @param r defines the red component to read from
  73699. * @param g defines the green component to read from
  73700. * @param b defines the blue component to read from
  73701. * @returns the current Color3 object
  73702. */
  73703. copyFromFloats(r: number, g: number, b: number): Color3;
  73704. /**
  73705. * Updates the Color3 rgb values from the given floats
  73706. * @param r defines the red component to read from
  73707. * @param g defines the green component to read from
  73708. * @param b defines the blue component to read from
  73709. * @returns the current Color3 object
  73710. */
  73711. set(r: number, g: number, b: number): Color3;
  73712. /**
  73713. * Compute the Color3 hexadecimal code as a string
  73714. * @returns a string containing the hexadecimal representation of the Color3 object
  73715. */
  73716. toHexString(): string;
  73717. /**
  73718. * Computes a new Color3 converted from the current one to linear space
  73719. * @returns a new Color3 object
  73720. */
  73721. toLinearSpace(): Color3;
  73722. /**
  73723. * Converts current color in rgb space to HSV values
  73724. * @returns a new color3 representing the HSV values
  73725. */
  73726. toHSV(): Color3;
  73727. /**
  73728. * Converts current color in rgb space to HSV values
  73729. * @param result defines the Color3 where to store the HSV values
  73730. */
  73731. toHSVToRef(result: Color3): void;
  73732. /**
  73733. * Converts the Color3 values to linear space and stores the result in "convertedColor"
  73734. * @param convertedColor defines the Color3 object where to store the linear space version
  73735. * @returns the unmodified Color3
  73736. */
  73737. toLinearSpaceToRef(convertedColor: Color3): Color3;
  73738. /**
  73739. * Computes a new Color3 converted from the current one to gamma space
  73740. * @returns a new Color3 object
  73741. */
  73742. toGammaSpace(): Color3;
  73743. /**
  73744. * Converts the Color3 values to gamma space and stores the result in "convertedColor"
  73745. * @param convertedColor defines the Color3 object where to store the gamma space version
  73746. * @returns the unmodified Color3
  73747. */
  73748. toGammaSpaceToRef(convertedColor: Color3): Color3;
  73749. private static _BlackReadOnly;
  73750. /**
  73751. * Convert Hue, saturation and value to a Color3 (RGB)
  73752. * @param hue defines the hue
  73753. * @param saturation defines the saturation
  73754. * @param value defines the value
  73755. * @param result defines the Color3 where to store the RGB values
  73756. */
  73757. static HSVtoRGBToRef(hue: number, saturation: number, value: number, result: Color3): void;
  73758. /**
  73759. * Creates a new Color3 from the string containing valid hexadecimal values
  73760. * @param hex defines a string containing valid hexadecimal values
  73761. * @returns a new Color3 object
  73762. */
  73763. static FromHexString(hex: string): Color3;
  73764. /**
  73765. * Creates a new Color3 from the starting index of the given array
  73766. * @param array defines the source array
  73767. * @param offset defines an offset in the source array
  73768. * @returns a new Color3 object
  73769. */
  73770. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color3;
  73771. /**
  73772. * Creates a new Color3 from integer values (< 256)
  73773. * @param r defines the red component to read from (value between 0 and 255)
  73774. * @param g defines the green component to read from (value between 0 and 255)
  73775. * @param b defines the blue component to read from (value between 0 and 255)
  73776. * @returns a new Color3 object
  73777. */
  73778. static FromInts(r: number, g: number, b: number): Color3;
  73779. /**
  73780. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  73781. * @param start defines the start Color3 value
  73782. * @param end defines the end Color3 value
  73783. * @param amount defines the gradient value between start and end
  73784. * @returns a new Color3 object
  73785. */
  73786. static Lerp(start: DeepImmutable<Color3>, end: DeepImmutable<Color3>, amount: number): Color3;
  73787. /**
  73788. * Creates a new Color3 with values linearly interpolated of "amount" between the start Color3 and the end Color3
  73789. * @param left defines the start value
  73790. * @param right defines the end value
  73791. * @param amount defines the gradient factor
  73792. * @param result defines the Color3 object where to store the result
  73793. */
  73794. static LerpToRef(left: DeepImmutable<Color3>, right: DeepImmutable<Color3>, amount: number, result: Color3): void;
  73795. /**
  73796. * Returns a Color3 value containing a red color
  73797. * @returns a new Color3 object
  73798. */
  73799. static Red(): Color3;
  73800. /**
  73801. * Returns a Color3 value containing a green color
  73802. * @returns a new Color3 object
  73803. */
  73804. static Green(): Color3;
  73805. /**
  73806. * Returns a Color3 value containing a blue color
  73807. * @returns a new Color3 object
  73808. */
  73809. static Blue(): Color3;
  73810. /**
  73811. * Returns a Color3 value containing a black color
  73812. * @returns a new Color3 object
  73813. */
  73814. static Black(): Color3;
  73815. /**
  73816. * Gets a Color3 value containing a black color that must not be updated
  73817. */
  73818. static readonly BlackReadOnly: DeepImmutable<Color3>;
  73819. /**
  73820. * Returns a Color3 value containing a white color
  73821. * @returns a new Color3 object
  73822. */
  73823. static White(): Color3;
  73824. /**
  73825. * Returns a Color3 value containing a purple color
  73826. * @returns a new Color3 object
  73827. */
  73828. static Purple(): Color3;
  73829. /**
  73830. * Returns a Color3 value containing a magenta color
  73831. * @returns a new Color3 object
  73832. */
  73833. static Magenta(): Color3;
  73834. /**
  73835. * Returns a Color3 value containing a yellow color
  73836. * @returns a new Color3 object
  73837. */
  73838. static Yellow(): Color3;
  73839. /**
  73840. * Returns a Color3 value containing a gray color
  73841. * @returns a new Color3 object
  73842. */
  73843. static Gray(): Color3;
  73844. /**
  73845. * Returns a Color3 value containing a teal color
  73846. * @returns a new Color3 object
  73847. */
  73848. static Teal(): Color3;
  73849. /**
  73850. * Returns a Color3 value containing a random color
  73851. * @returns a new Color3 object
  73852. */
  73853. static Random(): Color3;
  73854. }
  73855. /**
  73856. * Class used to hold a RBGA color
  73857. */
  73858. export class Color4 {
  73859. /**
  73860. * Defines the red component (between 0 and 1, default is 0)
  73861. */
  73862. r: number;
  73863. /**
  73864. * Defines the green component (between 0 and 1, default is 0)
  73865. */
  73866. g: number;
  73867. /**
  73868. * Defines the blue component (between 0 and 1, default is 0)
  73869. */
  73870. b: number;
  73871. /**
  73872. * Defines the alpha component (between 0 and 1, default is 1)
  73873. */
  73874. a: number;
  73875. /**
  73876. * Creates a new Color4 object from red, green, blue values, all between 0 and 1
  73877. * @param r defines the red component (between 0 and 1, default is 0)
  73878. * @param g defines the green component (between 0 and 1, default is 0)
  73879. * @param b defines the blue component (between 0 and 1, default is 0)
  73880. * @param a defines the alpha component (between 0 and 1, default is 1)
  73881. */
  73882. constructor(
  73883. /**
  73884. * Defines the red component (between 0 and 1, default is 0)
  73885. */
  73886. r?: number,
  73887. /**
  73888. * Defines the green component (between 0 and 1, default is 0)
  73889. */
  73890. g?: number,
  73891. /**
  73892. * Defines the blue component (between 0 and 1, default is 0)
  73893. */
  73894. b?: number,
  73895. /**
  73896. * Defines the alpha component (between 0 and 1, default is 1)
  73897. */
  73898. a?: number);
  73899. /**
  73900. * Adds in place the given Color4 values to the current Color4 object
  73901. * @param right defines the second operand
  73902. * @returns the current updated Color4 object
  73903. */
  73904. addInPlace(right: DeepImmutable<Color4>): Color4;
  73905. /**
  73906. * Creates a new array populated with 4 numeric elements : red, green, blue, alpha values
  73907. * @returns the new array
  73908. */
  73909. asArray(): number[];
  73910. /**
  73911. * Stores from the starting index in the given array the Color4 successive values
  73912. * @param array defines the array where to store the r,g,b components
  73913. * @param index defines an optional index in the target array to define where to start storing values
  73914. * @returns the current Color4 object
  73915. */
  73916. toArray(array: number[], index?: number): Color4;
  73917. /**
  73918. * Determines equality between Color4 objects
  73919. * @param otherColor defines the second operand
  73920. * @returns true if the rgba values are equal to the given ones
  73921. */
  73922. equals(otherColor: DeepImmutable<Color4>): boolean;
  73923. /**
  73924. * Creates a new Color4 set with the added values of the current Color4 and of the given one
  73925. * @param right defines the second operand
  73926. * @returns a new Color4 object
  73927. */
  73928. add(right: DeepImmutable<Color4>): Color4;
  73929. /**
  73930. * Creates a new Color4 set with the subtracted values of the given one from the current Color4
  73931. * @param right defines the second operand
  73932. * @returns a new Color4 object
  73933. */
  73934. subtract(right: DeepImmutable<Color4>): Color4;
  73935. /**
  73936. * Subtracts the given ones from the current Color4 values and stores the results in "result"
  73937. * @param right defines the second operand
  73938. * @param result defines the Color4 object where to store the result
  73939. * @returns the current Color4 object
  73940. */
  73941. subtractToRef(right: DeepImmutable<Color4>, result: Color4): Color4;
  73942. /**
  73943. * Creates a new Color4 with the current Color4 values multiplied by scale
  73944. * @param scale defines the scaling factor to apply
  73945. * @returns a new Color4 object
  73946. */
  73947. scale(scale: number): Color4;
  73948. /**
  73949. * Multiplies the current Color4 values by scale and stores the result in "result"
  73950. * @param scale defines the scaling factor to apply
  73951. * @param result defines the Color4 object where to store the result
  73952. * @returns the current unmodified Color4
  73953. */
  73954. scaleToRef(scale: number, result: Color4): Color4;
  73955. /**
  73956. * Scale the current Color4 values by a factor and add the result to a given Color4
  73957. * @param scale defines the scale factor
  73958. * @param result defines the Color4 object where to store the result
  73959. * @returns the unmodified current Color4
  73960. */
  73961. scaleAndAddToRef(scale: number, result: Color4): Color4;
  73962. /**
  73963. * Clamps the rgb values by the min and max values and stores the result into "result"
  73964. * @param min defines minimum clamping value (default is 0)
  73965. * @param max defines maximum clamping value (default is 1)
  73966. * @param result defines color to store the result into.
  73967. * @returns the cuurent Color4
  73968. */
  73969. clampToRef(min: number | undefined, max: number | undefined, result: Color4): Color4;
  73970. /**
  73971. * Multipy an Color4 value by another and return a new Color4 object
  73972. * @param color defines the Color4 value to multiply by
  73973. * @returns a new Color4 object
  73974. */
  73975. multiply(color: Color4): Color4;
  73976. /**
  73977. * Multipy a Color4 value by another and push the result in a reference value
  73978. * @param color defines the Color4 value to multiply by
  73979. * @param result defines the Color4 to fill the result in
  73980. * @returns the result Color4
  73981. */
  73982. multiplyToRef(color: Color4, result: Color4): Color4;
  73983. /**
  73984. * Creates a string with the Color4 current values
  73985. * @returns the string representation of the Color4 object
  73986. */
  73987. toString(): string;
  73988. /**
  73989. * Returns the string "Color4"
  73990. * @returns "Color4"
  73991. */
  73992. getClassName(): string;
  73993. /**
  73994. * Compute the Color4 hash code
  73995. * @returns an unique number that can be used to hash Color4 objects
  73996. */
  73997. getHashCode(): number;
  73998. /**
  73999. * Creates a new Color4 copied from the current one
  74000. * @returns a new Color4 object
  74001. */
  74002. clone(): Color4;
  74003. /**
  74004. * Copies the given Color4 values into the current one
  74005. * @param source defines the source Color4 object
  74006. * @returns the current updated Color4 object
  74007. */
  74008. copyFrom(source: Color4): Color4;
  74009. /**
  74010. * Copies the given float values into the current one
  74011. * @param r defines the red component to read from
  74012. * @param g defines the green component to read from
  74013. * @param b defines the blue component to read from
  74014. * @param a defines the alpha component to read from
  74015. * @returns the current updated Color4 object
  74016. */
  74017. copyFromFloats(r: number, g: number, b: number, a: number): Color4;
  74018. /**
  74019. * Copies the given float values into the current one
  74020. * @param r defines the red component to read from
  74021. * @param g defines the green component to read from
  74022. * @param b defines the blue component to read from
  74023. * @param a defines the alpha component to read from
  74024. * @returns the current updated Color4 object
  74025. */
  74026. set(r: number, g: number, b: number, a: number): Color4;
  74027. /**
  74028. * Compute the Color4 hexadecimal code as a string
  74029. * @returns a string containing the hexadecimal representation of the Color4 object
  74030. */
  74031. toHexString(): string;
  74032. /**
  74033. * Computes a new Color4 converted from the current one to linear space
  74034. * @returns a new Color4 object
  74035. */
  74036. toLinearSpace(): Color4;
  74037. /**
  74038. * Converts the Color4 values to linear space and stores the result in "convertedColor"
  74039. * @param convertedColor defines the Color4 object where to store the linear space version
  74040. * @returns the unmodified Color4
  74041. */
  74042. toLinearSpaceToRef(convertedColor: Color4): Color4;
  74043. /**
  74044. * Computes a new Color4 converted from the current one to gamma space
  74045. * @returns a new Color4 object
  74046. */
  74047. toGammaSpace(): Color4;
  74048. /**
  74049. * Converts the Color4 values to gamma space and stores the result in "convertedColor"
  74050. * @param convertedColor defines the Color4 object where to store the gamma space version
  74051. * @returns the unmodified Color4
  74052. */
  74053. toGammaSpaceToRef(convertedColor: Color4): Color4;
  74054. /**
  74055. * Creates a new Color4 from the string containing valid hexadecimal values
  74056. * @param hex defines a string containing valid hexadecimal values
  74057. * @returns a new Color4 object
  74058. */
  74059. static FromHexString(hex: string): Color4;
  74060. /**
  74061. * Creates a new Color4 object set with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  74062. * @param left defines the start value
  74063. * @param right defines the end value
  74064. * @param amount defines the gradient factor
  74065. * @returns a new Color4 object
  74066. */
  74067. static Lerp(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number): Color4;
  74068. /**
  74069. * Set the given "result" with the linearly interpolated values of "amount" between the left Color4 object and the right Color4 object
  74070. * @param left defines the start value
  74071. * @param right defines the end value
  74072. * @param amount defines the gradient factor
  74073. * @param result defines the Color4 object where to store data
  74074. */
  74075. static LerpToRef(left: DeepImmutable<Color4>, right: DeepImmutable<Color4>, amount: number, result: Color4): void;
  74076. /**
  74077. * Creates a new Color4 from a Color3 and an alpha value
  74078. * @param color3 defines the source Color3 to read from
  74079. * @param alpha defines the alpha component (1.0 by default)
  74080. * @returns a new Color4 object
  74081. */
  74082. static FromColor3(color3: DeepImmutable<Color3>, alpha?: number): Color4;
  74083. /**
  74084. * Creates a new Color4 from the starting index element of the given array
  74085. * @param array defines the source array to read from
  74086. * @param offset defines the offset in the source array
  74087. * @returns a new Color4 object
  74088. */
  74089. static FromArray(array: DeepImmutable<ArrayLike<number>>, offset?: number): Color4;
  74090. /**
  74091. * Creates a new Color3 from integer values (< 256)
  74092. * @param r defines the red component to read from (value between 0 and 255)
  74093. * @param g defines the green component to read from (value between 0 and 255)
  74094. * @param b defines the blue component to read from (value between 0 and 255)
  74095. * @param a defines the alpha component to read from (value between 0 and 255)
  74096. * @returns a new Color3 object
  74097. */
  74098. static FromInts(r: number, g: number, b: number, a: number): Color4;
  74099. /**
  74100. * Check the content of a given array and convert it to an array containing RGBA data
  74101. * If the original array was already containing count * 4 values then it is returned directly
  74102. * @param colors defines the array to check
  74103. * @param count defines the number of RGBA data to expect
  74104. * @returns an array containing count * 4 values (RGBA)
  74105. */
  74106. static CheckColors4(colors: number[], count: number): number[];
  74107. }
  74108. /**
  74109. * @hidden
  74110. */
  74111. export class TmpColors {
  74112. static Color3: Color3[];
  74113. static Color4: Color4[];
  74114. }
  74115. }
  74116. declare module BABYLON {
  74117. /**
  74118. * Defines an interface which represents an animation key frame
  74119. */
  74120. export interface IAnimationKey {
  74121. /**
  74122. * Frame of the key frame
  74123. */
  74124. frame: number;
  74125. /**
  74126. * Value at the specifies key frame
  74127. */
  74128. value: any;
  74129. /**
  74130. * The input tangent for the cubic hermite spline
  74131. */
  74132. inTangent?: any;
  74133. /**
  74134. * The output tangent for the cubic hermite spline
  74135. */
  74136. outTangent?: any;
  74137. /**
  74138. * The animation interpolation type
  74139. */
  74140. interpolation?: AnimationKeyInterpolation;
  74141. }
  74142. /**
  74143. * Enum for the animation key frame interpolation type
  74144. */
  74145. export enum AnimationKeyInterpolation {
  74146. /**
  74147. * Do not interpolate between keys and use the start key value only. Tangents are ignored
  74148. */
  74149. STEP = 1
  74150. }
  74151. }
  74152. declare module BABYLON {
  74153. /**
  74154. * Represents the range of an animation
  74155. */
  74156. export class AnimationRange {
  74157. /**The name of the animation range**/
  74158. name: string;
  74159. /**The starting frame of the animation */
  74160. from: number;
  74161. /**The ending frame of the animation*/
  74162. to: number;
  74163. /**
  74164. * Initializes the range of an animation
  74165. * @param name The name of the animation range
  74166. * @param from The starting frame of the animation
  74167. * @param to The ending frame of the animation
  74168. */
  74169. constructor(
  74170. /**The name of the animation range**/
  74171. name: string,
  74172. /**The starting frame of the animation */
  74173. from: number,
  74174. /**The ending frame of the animation*/
  74175. to: number);
  74176. /**
  74177. * Makes a copy of the animation range
  74178. * @returns A copy of the animation range
  74179. */
  74180. clone(): AnimationRange;
  74181. }
  74182. }
  74183. declare module BABYLON {
  74184. /**
  74185. * Composed of a frame, and an action function
  74186. */
  74187. export class AnimationEvent {
  74188. /** The frame for which the event is triggered **/
  74189. frame: number;
  74190. /** The event to perform when triggered **/
  74191. action: (currentFrame: number) => void;
  74192. /** Specifies if the event should be triggered only once**/
  74193. onlyOnce?: boolean | undefined;
  74194. /**
  74195. * Specifies if the animation event is done
  74196. */
  74197. isDone: boolean;
  74198. /**
  74199. * Initializes the animation event
  74200. * @param frame The frame for which the event is triggered
  74201. * @param action The event to perform when triggered
  74202. * @param onlyOnce Specifies if the event should be triggered only once
  74203. */
  74204. constructor(
  74205. /** The frame for which the event is triggered **/
  74206. frame: number,
  74207. /** The event to perform when triggered **/
  74208. action: (currentFrame: number) => void,
  74209. /** Specifies if the event should be triggered only once**/
  74210. onlyOnce?: boolean | undefined);
  74211. /** @hidden */
  74212. _clone(): AnimationEvent;
  74213. }
  74214. }
  74215. declare module BABYLON {
  74216. /**
  74217. * Interface used to define a behavior
  74218. */
  74219. export interface Behavior<T> {
  74220. /** gets or sets behavior's name */
  74221. name: string;
  74222. /**
  74223. * Function called when the behavior needs to be initialized (after attaching it to a target)
  74224. */
  74225. init(): void;
  74226. /**
  74227. * Called when the behavior is attached to a target
  74228. * @param target defines the target where the behavior is attached to
  74229. */
  74230. attach(target: T): void;
  74231. /**
  74232. * Called when the behavior is detached from its target
  74233. */
  74234. detach(): void;
  74235. }
  74236. /**
  74237. * Interface implemented by classes supporting behaviors
  74238. */
  74239. export interface IBehaviorAware<T> {
  74240. /**
  74241. * Attach a behavior
  74242. * @param behavior defines the behavior to attach
  74243. * @returns the current host
  74244. */
  74245. addBehavior(behavior: Behavior<T>): T;
  74246. /**
  74247. * Remove a behavior from the current object
  74248. * @param behavior defines the behavior to detach
  74249. * @returns the current host
  74250. */
  74251. removeBehavior(behavior: Behavior<T>): T;
  74252. /**
  74253. * Gets a behavior using its name to search
  74254. * @param name defines the name to search
  74255. * @returns the behavior or null if not found
  74256. */
  74257. getBehaviorByName(name: string): Nullable<Behavior<T>>;
  74258. }
  74259. }
  74260. declare module BABYLON {
  74261. /**
  74262. * Defines an array and its length.
  74263. * It can be helpfull to group result from both Arrays and smart arrays in one structure.
  74264. */
  74265. export interface ISmartArrayLike<T> {
  74266. /**
  74267. * The data of the array.
  74268. */
  74269. data: Array<T>;
  74270. /**
  74271. * The active length of the array.
  74272. */
  74273. length: number;
  74274. }
  74275. /**
  74276. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  74277. */
  74278. export class SmartArray<T> implements ISmartArrayLike<T> {
  74279. /**
  74280. * The full set of data from the array.
  74281. */
  74282. data: Array<T>;
  74283. /**
  74284. * The active length of the array.
  74285. */
  74286. length: number;
  74287. protected _id: number;
  74288. /**
  74289. * Instantiates a Smart Array.
  74290. * @param capacity defines the default capacity of the array.
  74291. */
  74292. constructor(capacity: number);
  74293. /**
  74294. * Pushes a value at the end of the active data.
  74295. * @param value defines the object to push in the array.
  74296. */
  74297. push(value: T): void;
  74298. /**
  74299. * Iterates over the active data and apply the lambda to them.
  74300. * @param func defines the action to apply on each value.
  74301. */
  74302. forEach(func: (content: T) => void): void;
  74303. /**
  74304. * Sorts the full sets of data.
  74305. * @param compareFn defines the comparison function to apply.
  74306. */
  74307. sort(compareFn: (a: T, b: T) => number): void;
  74308. /**
  74309. * Resets the active data to an empty array.
  74310. */
  74311. reset(): void;
  74312. /**
  74313. * Releases all the data from the array as well as the array.
  74314. */
  74315. dispose(): void;
  74316. /**
  74317. * Concats the active data with a given array.
  74318. * @param array defines the data to concatenate with.
  74319. */
  74320. concat(array: any): void;
  74321. /**
  74322. * Returns the position of a value in the active data.
  74323. * @param value defines the value to find the index for
  74324. * @returns the index if found in the active data otherwise -1
  74325. */
  74326. indexOf(value: T): number;
  74327. /**
  74328. * Returns whether an element is part of the active data.
  74329. * @param value defines the value to look for
  74330. * @returns true if found in the active data otherwise false
  74331. */
  74332. contains(value: T): boolean;
  74333. private static _GlobalId;
  74334. }
  74335. /**
  74336. * Defines an GC Friendly array where the backfield array do not shrink to prevent over allocations.
  74337. * The data in this array can only be present once
  74338. */
  74339. export class SmartArrayNoDuplicate<T> extends SmartArray<T> {
  74340. private _duplicateId;
  74341. /**
  74342. * Pushes a value at the end of the active data.
  74343. * THIS DOES NOT PREVENT DUPPLICATE DATA
  74344. * @param value defines the object to push in the array.
  74345. */
  74346. push(value: T): void;
  74347. /**
  74348. * Pushes a value at the end of the active data.
  74349. * If the data is already present, it won t be added again
  74350. * @param value defines the object to push in the array.
  74351. * @returns true if added false if it was already present
  74352. */
  74353. pushNoDuplicate(value: T): boolean;
  74354. /**
  74355. * Resets the active data to an empty array.
  74356. */
  74357. reset(): void;
  74358. /**
  74359. * Concats the active data with a given array.
  74360. * This ensures no dupplicate will be present in the result.
  74361. * @param array defines the data to concatenate with.
  74362. */
  74363. concatWithNoDuplicate(array: any): void;
  74364. }
  74365. }
  74366. declare module BABYLON {
  74367. /**
  74368. * @ignore
  74369. * This is a list of all the different input types that are available in the application.
  74370. * Fo instance: ArcRotateCameraGamepadInput...
  74371. */
  74372. export var CameraInputTypes: {};
  74373. /**
  74374. * This is the contract to implement in order to create a new input class.
  74375. * Inputs are dealing with listening to user actions and moving the camera accordingly.
  74376. */
  74377. export interface ICameraInput<TCamera extends Camera> {
  74378. /**
  74379. * Defines the camera the input is attached to.
  74380. */
  74381. camera: Nullable<TCamera>;
  74382. /**
  74383. * Gets the class name of the current intput.
  74384. * @returns the class name
  74385. */
  74386. getClassName(): string;
  74387. /**
  74388. * Get the friendly name associated with the input class.
  74389. * @returns the input friendly name
  74390. */
  74391. getSimpleName(): string;
  74392. /**
  74393. * Attach the input controls to a specific dom element to get the input from.
  74394. * @param element Defines the element the controls should be listened from
  74395. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  74396. */
  74397. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  74398. /**
  74399. * Detach the current controls from the specified dom element.
  74400. * @param element Defines the element to stop listening the inputs from
  74401. */
  74402. detachControl(element: Nullable<HTMLElement>): void;
  74403. /**
  74404. * Update the current camera state depending on the inputs that have been used this frame.
  74405. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  74406. */
  74407. checkInputs?: () => void;
  74408. }
  74409. /**
  74410. * Represents a map of input types to input instance or input index to input instance.
  74411. */
  74412. export interface CameraInputsMap<TCamera extends Camera> {
  74413. /**
  74414. * Accessor to the input by input type.
  74415. */
  74416. [name: string]: ICameraInput<TCamera>;
  74417. /**
  74418. * Accessor to the input by input index.
  74419. */
  74420. [idx: number]: ICameraInput<TCamera>;
  74421. }
  74422. /**
  74423. * This represents the input manager used within a camera.
  74424. * It helps dealing with all the different kind of input attached to a camera.
  74425. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  74426. */
  74427. export class CameraInputsManager<TCamera extends Camera> {
  74428. /**
  74429. * Defines the list of inputs attahed to the camera.
  74430. */
  74431. attached: CameraInputsMap<TCamera>;
  74432. /**
  74433. * Defines the dom element the camera is collecting inputs from.
  74434. * This is null if the controls have not been attached.
  74435. */
  74436. attachedElement: Nullable<HTMLElement>;
  74437. /**
  74438. * Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  74439. */
  74440. noPreventDefault: boolean;
  74441. /**
  74442. * Defined the camera the input manager belongs to.
  74443. */
  74444. camera: TCamera;
  74445. /**
  74446. * Update the current camera state depending on the inputs that have been used this frame.
  74447. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  74448. */
  74449. checkInputs: () => void;
  74450. /**
  74451. * Instantiate a new Camera Input Manager.
  74452. * @param camera Defines the camera the input manager blongs to
  74453. */
  74454. constructor(camera: TCamera);
  74455. /**
  74456. * Add an input method to a camera
  74457. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  74458. * @param input camera input method
  74459. */
  74460. add(input: ICameraInput<TCamera>): void;
  74461. /**
  74462. * Remove a specific input method from a camera
  74463. * example: camera.inputs.remove(camera.inputs.attached.mouse);
  74464. * @param inputToRemove camera input method
  74465. */
  74466. remove(inputToRemove: ICameraInput<TCamera>): void;
  74467. /**
  74468. * Remove a specific input type from a camera
  74469. * example: camera.inputs.remove("ArcRotateCameraGamepadInput");
  74470. * @param inputType the type of the input to remove
  74471. */
  74472. removeByType(inputType: string): void;
  74473. private _addCheckInputs;
  74474. /**
  74475. * Attach the input controls to the currently attached dom element to listen the events from.
  74476. * @param input Defines the input to attach
  74477. */
  74478. attachInput(input: ICameraInput<TCamera>): void;
  74479. /**
  74480. * Attach the current manager inputs controls to a specific dom element to listen the events from.
  74481. * @param element Defines the dom element to collect the events from
  74482. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  74483. */
  74484. attachElement(element: HTMLElement, noPreventDefault?: boolean): void;
  74485. /**
  74486. * Detach the current manager inputs controls from a specific dom element.
  74487. * @param element Defines the dom element to collect the events from
  74488. * @param disconnect Defines whether the input should be removed from the current list of attached inputs
  74489. */
  74490. detachElement(element: HTMLElement, disconnect?: boolean): void;
  74491. /**
  74492. * Rebuild the dynamic inputCheck function from the current list of
  74493. * defined inputs in the manager.
  74494. */
  74495. rebuildInputCheck(): void;
  74496. /**
  74497. * Remove all attached input methods from a camera
  74498. */
  74499. clear(): void;
  74500. /**
  74501. * Serialize the current input manager attached to a camera.
  74502. * This ensures than once parsed,
  74503. * the input associated to the camera will be identical to the current ones
  74504. * @param serializedCamera Defines the camera serialization JSON the input serialization should write to
  74505. */
  74506. serialize(serializedCamera: any): void;
  74507. /**
  74508. * Parses an input manager serialized JSON to restore the previous list of inputs
  74509. * and states associated to a camera.
  74510. * @param parsedCamera Defines the JSON to parse
  74511. */
  74512. parse(parsedCamera: any): void;
  74513. }
  74514. }
  74515. declare module BABYLON {
  74516. /**
  74517. * Class used to store data that will be store in GPU memory
  74518. */
  74519. export class Buffer {
  74520. private _engine;
  74521. private _buffer;
  74522. /** @hidden */
  74523. _data: Nullable<DataArray>;
  74524. private _updatable;
  74525. private _instanced;
  74526. private _divisor;
  74527. /**
  74528. * Gets the byte stride.
  74529. */
  74530. readonly byteStride: number;
  74531. /**
  74532. * Constructor
  74533. * @param engine the engine
  74534. * @param data the data to use for this buffer
  74535. * @param updatable whether the data is updatable
  74536. * @param stride the stride (optional)
  74537. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  74538. * @param instanced whether the buffer is instanced (optional)
  74539. * @param useBytes set to true if the stride in in bytes (optional)
  74540. * @param divisor sets an optional divisor for instances (1 by default)
  74541. */
  74542. constructor(engine: any, data: DataArray, updatable: boolean, stride?: number, postponeInternalCreation?: boolean, instanced?: boolean, useBytes?: boolean, divisor?: number);
  74543. /**
  74544. * Create a new VertexBuffer based on the current buffer
  74545. * @param kind defines the vertex buffer kind (position, normal, etc.)
  74546. * @param offset defines offset in the buffer (0 by default)
  74547. * @param size defines the size in floats of attributes (position is 3 for instance)
  74548. * @param stride defines the stride size in floats in the buffer (the offset to apply to reach next value when data is interleaved)
  74549. * @param instanced defines if the vertex buffer contains indexed data
  74550. * @param useBytes defines if the offset and stride are in bytes *
  74551. * @param divisor sets an optional divisor for instances (1 by default)
  74552. * @returns the new vertex buffer
  74553. */
  74554. createVertexBuffer(kind: string, offset: number, size: number, stride?: number, instanced?: boolean, useBytes?: boolean, divisor?: number): VertexBuffer;
  74555. /**
  74556. * Gets a boolean indicating if the Buffer is updatable?
  74557. * @returns true if the buffer is updatable
  74558. */
  74559. isUpdatable(): boolean;
  74560. /**
  74561. * Gets current buffer's data
  74562. * @returns a DataArray or null
  74563. */
  74564. getData(): Nullable<DataArray>;
  74565. /**
  74566. * Gets underlying native buffer
  74567. * @returns underlying native buffer
  74568. */
  74569. getBuffer(): Nullable<DataBuffer>;
  74570. /**
  74571. * Gets the stride in float32 units (i.e. byte stride / 4).
  74572. * May not be an integer if the byte stride is not divisible by 4.
  74573. * DEPRECATED. Use byteStride instead.
  74574. * @returns the stride in float32 units
  74575. */
  74576. getStrideSize(): number;
  74577. /**
  74578. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  74579. * @param data defines the data to store
  74580. */
  74581. create(data?: Nullable<DataArray>): void;
  74582. /** @hidden */
  74583. _rebuild(): void;
  74584. /**
  74585. * Update current buffer data
  74586. * @param data defines the data to store
  74587. */
  74588. update(data: DataArray): void;
  74589. /**
  74590. * Updates the data directly.
  74591. * @param data the new data
  74592. * @param offset the new offset
  74593. * @param vertexCount the vertex count (optional)
  74594. * @param useBytes set to true if the offset is in bytes
  74595. */
  74596. updateDirectly(data: DataArray, offset: number, vertexCount?: number, useBytes?: boolean): void;
  74597. /**
  74598. * Release all resources
  74599. */
  74600. dispose(): void;
  74601. }
  74602. /**
  74603. * Specialized buffer used to store vertex data
  74604. */
  74605. export class VertexBuffer {
  74606. /** @hidden */
  74607. _buffer: Buffer;
  74608. private _kind;
  74609. private _size;
  74610. private _ownsBuffer;
  74611. private _instanced;
  74612. private _instanceDivisor;
  74613. /**
  74614. * The byte type.
  74615. */
  74616. static readonly BYTE: number;
  74617. /**
  74618. * The unsigned byte type.
  74619. */
  74620. static readonly UNSIGNED_BYTE: number;
  74621. /**
  74622. * The short type.
  74623. */
  74624. static readonly SHORT: number;
  74625. /**
  74626. * The unsigned short type.
  74627. */
  74628. static readonly UNSIGNED_SHORT: number;
  74629. /**
  74630. * The integer type.
  74631. */
  74632. static readonly INT: number;
  74633. /**
  74634. * The unsigned integer type.
  74635. */
  74636. static readonly UNSIGNED_INT: number;
  74637. /**
  74638. * The float type.
  74639. */
  74640. static readonly FLOAT: number;
  74641. /**
  74642. * Gets or sets the instance divisor when in instanced mode
  74643. */
  74644. instanceDivisor: number;
  74645. /**
  74646. * Gets the byte stride.
  74647. */
  74648. readonly byteStride: number;
  74649. /**
  74650. * Gets the byte offset.
  74651. */
  74652. readonly byteOffset: number;
  74653. /**
  74654. * Gets whether integer data values should be normalized into a certain range when being casted to a float.
  74655. */
  74656. readonly normalized: boolean;
  74657. /**
  74658. * Gets the data type of each component in the array.
  74659. */
  74660. readonly type: number;
  74661. /**
  74662. * Constructor
  74663. * @param engine the engine
  74664. * @param data the data to use for this vertex buffer
  74665. * @param kind the vertex buffer kind
  74666. * @param updatable whether the data is updatable
  74667. * @param postponeInternalCreation whether to postpone creating the internal WebGL buffer (optional)
  74668. * @param stride the stride (optional)
  74669. * @param instanced whether the buffer is instanced (optional)
  74670. * @param offset the offset of the data (optional)
  74671. * @param size the number of components (optional)
  74672. * @param type the type of the component (optional)
  74673. * @param normalized whether the data contains normalized data (optional)
  74674. * @param useBytes set to true if stride and offset are in bytes (optional)
  74675. * @param divisor defines the instance divisor to use (1 by default)
  74676. */
  74677. 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);
  74678. /** @hidden */
  74679. _rebuild(): void;
  74680. /**
  74681. * Returns the kind of the VertexBuffer (string)
  74682. * @returns a string
  74683. */
  74684. getKind(): string;
  74685. /**
  74686. * Gets a boolean indicating if the VertexBuffer is updatable?
  74687. * @returns true if the buffer is updatable
  74688. */
  74689. isUpdatable(): boolean;
  74690. /**
  74691. * Gets current buffer's data
  74692. * @returns a DataArray or null
  74693. */
  74694. getData(): Nullable<DataArray>;
  74695. /**
  74696. * Gets underlying native buffer
  74697. * @returns underlying native buffer
  74698. */
  74699. getBuffer(): Nullable<DataBuffer>;
  74700. /**
  74701. * Gets the stride in float32 units (i.e. byte stride / 4).
  74702. * May not be an integer if the byte stride is not divisible by 4.
  74703. * DEPRECATED. Use byteStride instead.
  74704. * @returns the stride in float32 units
  74705. */
  74706. getStrideSize(): number;
  74707. /**
  74708. * Returns the offset as a multiple of the type byte length.
  74709. * DEPRECATED. Use byteOffset instead.
  74710. * @returns the offset in bytes
  74711. */
  74712. getOffset(): number;
  74713. /**
  74714. * Returns the number of components per vertex attribute (integer)
  74715. * @returns the size in float
  74716. */
  74717. getSize(): number;
  74718. /**
  74719. * Gets a boolean indicating is the internal buffer of the VertexBuffer is instanced
  74720. * @returns true if this buffer is instanced
  74721. */
  74722. getIsInstanced(): boolean;
  74723. /**
  74724. * Returns the instancing divisor, zero for non-instanced (integer).
  74725. * @returns a number
  74726. */
  74727. getInstanceDivisor(): number;
  74728. /**
  74729. * Store data into the buffer. If the buffer was already used it will be either recreated or updated depending on isUpdatable property
  74730. * @param data defines the data to store
  74731. */
  74732. create(data?: DataArray): void;
  74733. /**
  74734. * Updates the underlying buffer according to the passed numeric array or Float32Array.
  74735. * This function will create a new buffer if the current one is not updatable
  74736. * @param data defines the data to store
  74737. */
  74738. update(data: DataArray): void;
  74739. /**
  74740. * Updates directly the underlying WebGLBuffer according to the passed numeric array or Float32Array.
  74741. * Returns the directly updated WebGLBuffer.
  74742. * @param data the new data
  74743. * @param offset the new offset
  74744. * @param useBytes set to true if the offset is in bytes
  74745. */
  74746. updateDirectly(data: DataArray, offset: number, useBytes?: boolean): void;
  74747. /**
  74748. * Disposes the VertexBuffer and the underlying WebGLBuffer.
  74749. */
  74750. dispose(): void;
  74751. /**
  74752. * Enumerates each value of this vertex buffer as numbers.
  74753. * @param count the number of values to enumerate
  74754. * @param callback the callback function called for each value
  74755. */
  74756. forEach(count: number, callback: (value: number, index: number) => void): void;
  74757. /**
  74758. * Positions
  74759. */
  74760. static readonly PositionKind: string;
  74761. /**
  74762. * Normals
  74763. */
  74764. static readonly NormalKind: string;
  74765. /**
  74766. * Tangents
  74767. */
  74768. static readonly TangentKind: string;
  74769. /**
  74770. * Texture coordinates
  74771. */
  74772. static readonly UVKind: string;
  74773. /**
  74774. * Texture coordinates 2
  74775. */
  74776. static readonly UV2Kind: string;
  74777. /**
  74778. * Texture coordinates 3
  74779. */
  74780. static readonly UV3Kind: string;
  74781. /**
  74782. * Texture coordinates 4
  74783. */
  74784. static readonly UV4Kind: string;
  74785. /**
  74786. * Texture coordinates 5
  74787. */
  74788. static readonly UV5Kind: string;
  74789. /**
  74790. * Texture coordinates 6
  74791. */
  74792. static readonly UV6Kind: string;
  74793. /**
  74794. * Colors
  74795. */
  74796. static readonly ColorKind: string;
  74797. /**
  74798. * Matrix indices (for bones)
  74799. */
  74800. static readonly MatricesIndicesKind: string;
  74801. /**
  74802. * Matrix weights (for bones)
  74803. */
  74804. static readonly MatricesWeightsKind: string;
  74805. /**
  74806. * Additional matrix indices (for bones)
  74807. */
  74808. static readonly MatricesIndicesExtraKind: string;
  74809. /**
  74810. * Additional matrix weights (for bones)
  74811. */
  74812. static readonly MatricesWeightsExtraKind: string;
  74813. /**
  74814. * Deduces the stride given a kind.
  74815. * @param kind The kind string to deduce
  74816. * @returns The deduced stride
  74817. */
  74818. static DeduceStride(kind: string): number;
  74819. /**
  74820. * Gets the byte length of the given type.
  74821. * @param type the type
  74822. * @returns the number of bytes
  74823. */
  74824. static GetTypeByteLength(type: number): number;
  74825. /**
  74826. * Enumerates each value of the given parameters as numbers.
  74827. * @param data the data to enumerate
  74828. * @param byteOffset the byte offset of the data
  74829. * @param byteStride the byte stride of the data
  74830. * @param componentCount the number of components per element
  74831. * @param componentType the type of the component
  74832. * @param count the number of values to enumerate
  74833. * @param normalized whether the data is normalized
  74834. * @param callback the callback function called for each value
  74835. */
  74836. static ForEach(data: DataArray, byteOffset: number, byteStride: number, componentCount: number, componentType: number, count: number, normalized: boolean, callback: (value: number, index: number) => void): void;
  74837. private static _GetFloatValue;
  74838. }
  74839. }
  74840. declare module BABYLON {
  74841. /**
  74842. * @hidden
  74843. */
  74844. export class IntersectionInfo {
  74845. bu: Nullable<number>;
  74846. bv: Nullable<number>;
  74847. distance: number;
  74848. faceId: number;
  74849. subMeshId: number;
  74850. constructor(bu: Nullable<number>, bv: Nullable<number>, distance: number);
  74851. }
  74852. }
  74853. declare module BABYLON {
  74854. /**
  74855. * Represens a plane by the equation ax + by + cz + d = 0
  74856. */
  74857. export class Plane {
  74858. private static _TmpMatrix;
  74859. /**
  74860. * Normal of the plane (a,b,c)
  74861. */
  74862. normal: Vector3;
  74863. /**
  74864. * d component of the plane
  74865. */
  74866. d: number;
  74867. /**
  74868. * Creates a Plane object according to the given floats a, b, c, d and the plane equation : ax + by + cz + d = 0
  74869. * @param a a component of the plane
  74870. * @param b b component of the plane
  74871. * @param c c component of the plane
  74872. * @param d d component of the plane
  74873. */
  74874. constructor(a: number, b: number, c: number, d: number);
  74875. /**
  74876. * @returns the plane coordinates as a new array of 4 elements [a, b, c, d].
  74877. */
  74878. asArray(): number[];
  74879. /**
  74880. * @returns a new plane copied from the current Plane.
  74881. */
  74882. clone(): Plane;
  74883. /**
  74884. * @returns the string "Plane".
  74885. */
  74886. getClassName(): string;
  74887. /**
  74888. * @returns the Plane hash code.
  74889. */
  74890. getHashCode(): number;
  74891. /**
  74892. * Normalize the current Plane in place.
  74893. * @returns the updated Plane.
  74894. */
  74895. normalize(): Plane;
  74896. /**
  74897. * Applies a transformation the plane and returns the result
  74898. * @param transformation the transformation matrix to be applied to the plane
  74899. * @returns a new Plane as the result of the transformation of the current Plane by the given matrix.
  74900. */
  74901. transform(transformation: DeepImmutable<Matrix>): Plane;
  74902. /**
  74903. * Calcualtte the dot product between the point and the plane normal
  74904. * @param point point to calculate the dot product with
  74905. * @returns the dot product (float) of the point coordinates and the plane normal.
  74906. */
  74907. dotCoordinate(point: DeepImmutable<Vector3>): number;
  74908. /**
  74909. * Updates the current Plane from the plane defined by the three given points.
  74910. * @param point1 one of the points used to contruct the plane
  74911. * @param point2 one of the points used to contruct the plane
  74912. * @param point3 one of the points used to contruct the plane
  74913. * @returns the updated Plane.
  74914. */
  74915. copyFromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  74916. /**
  74917. * Checks if the plane is facing a given direction
  74918. * @param direction the direction to check if the plane is facing
  74919. * @param epsilon value the dot product is compared against (returns true if dot <= epsilon)
  74920. * @returns True is the vector "direction" is the same side than the plane normal.
  74921. */
  74922. isFrontFacingTo(direction: DeepImmutable<Vector3>, epsilon: number): boolean;
  74923. /**
  74924. * Calculates the distance to a point
  74925. * @param point point to calculate distance to
  74926. * @returns the signed distance (float) from the given point to the Plane.
  74927. */
  74928. signedDistanceTo(point: DeepImmutable<Vector3>): number;
  74929. /**
  74930. * Creates a plane from an array
  74931. * @param array the array to create a plane from
  74932. * @returns a new Plane from the given array.
  74933. */
  74934. static FromArray(array: DeepImmutable<ArrayLike<number>>): Plane;
  74935. /**
  74936. * Creates a plane from three points
  74937. * @param point1 point used to create the plane
  74938. * @param point2 point used to create the plane
  74939. * @param point3 point used to create the plane
  74940. * @returns a new Plane defined by the three given points.
  74941. */
  74942. static FromPoints(point1: DeepImmutable<Vector3>, point2: DeepImmutable<Vector3>, point3: DeepImmutable<Vector3>): Plane;
  74943. /**
  74944. * Creates a plane from an origin point and a normal
  74945. * @param origin origin of the plane to be constructed
  74946. * @param normal normal of the plane to be constructed
  74947. * @returns a new Plane the normal vector to this plane at the given origin point.
  74948. * Note : the vector "normal" is updated because normalized.
  74949. */
  74950. static FromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>): Plane;
  74951. /**
  74952. * Calculates the distance from a plane and a point
  74953. * @param origin origin of the plane to be constructed
  74954. * @param normal normal of the plane to be constructed
  74955. * @param point point to calculate distance to
  74956. * @returns the signed distance between the plane defined by the normal vector at the "origin"" point and the given other point.
  74957. */
  74958. static SignedDistanceToPlaneFromPositionAndNormal(origin: DeepImmutable<Vector3>, normal: DeepImmutable<Vector3>, point: DeepImmutable<Vector3>): number;
  74959. }
  74960. }
  74961. declare module BABYLON {
  74962. /**
  74963. * Class used to store bounding sphere information
  74964. */
  74965. export class BoundingSphere {
  74966. /**
  74967. * Gets the center of the bounding sphere in local space
  74968. */
  74969. readonly center: Vector3;
  74970. /**
  74971. * Radius of the bounding sphere in local space
  74972. */
  74973. radius: number;
  74974. /**
  74975. * Gets the center of the bounding sphere in world space
  74976. */
  74977. readonly centerWorld: Vector3;
  74978. /**
  74979. * Radius of the bounding sphere in world space
  74980. */
  74981. radiusWorld: number;
  74982. /**
  74983. * Gets the minimum vector in local space
  74984. */
  74985. readonly minimum: Vector3;
  74986. /**
  74987. * Gets the maximum vector in local space
  74988. */
  74989. readonly maximum: Vector3;
  74990. private _worldMatrix;
  74991. private static readonly TmpVector3;
  74992. /**
  74993. * Creates a new bounding sphere
  74994. * @param min defines the minimum vector (in local space)
  74995. * @param max defines the maximum vector (in local space)
  74996. * @param worldMatrix defines the new world matrix
  74997. */
  74998. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  74999. /**
  75000. * Recreates the entire bounding sphere from scratch as if we call the constructor in place
  75001. * @param min defines the new minimum vector (in local space)
  75002. * @param max defines the new maximum vector (in local space)
  75003. * @param worldMatrix defines the new world matrix
  75004. */
  75005. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  75006. /**
  75007. * Scale the current bounding sphere by applying a scale factor
  75008. * @param factor defines the scale factor to apply
  75009. * @returns the current bounding box
  75010. */
  75011. scale(factor: number): BoundingSphere;
  75012. /**
  75013. * Gets the world matrix of the bounding box
  75014. * @returns a matrix
  75015. */
  75016. getWorldMatrix(): DeepImmutable<Matrix>;
  75017. /** @hidden */
  75018. _update(worldMatrix: DeepImmutable<Matrix>): void;
  75019. /**
  75020. * Tests if the bounding sphere is intersecting the frustum planes
  75021. * @param frustumPlanes defines the frustum planes to test
  75022. * @returns true if there is an intersection
  75023. */
  75024. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  75025. /**
  75026. * Tests if the bounding sphere center is in between the frustum planes.
  75027. * Used for optimistic fast inclusion.
  75028. * @param frustumPlanes defines the frustum planes to test
  75029. * @returns true if the sphere center is in between the frustum planes
  75030. */
  75031. isCenterInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  75032. /**
  75033. * Tests if a point is inside the bounding sphere
  75034. * @param point defines the point to test
  75035. * @returns true if the point is inside the bounding sphere
  75036. */
  75037. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  75038. /**
  75039. * Checks if two sphere intersct
  75040. * @param sphere0 sphere 0
  75041. * @param sphere1 sphere 1
  75042. * @returns true if the speres intersect
  75043. */
  75044. static Intersects(sphere0: DeepImmutable<BoundingSphere>, sphere1: DeepImmutable<BoundingSphere>): boolean;
  75045. }
  75046. }
  75047. declare module BABYLON {
  75048. /**
  75049. * Class used to store bounding box information
  75050. */
  75051. export class BoundingBox implements ICullable {
  75052. /**
  75053. * Gets the 8 vectors representing the bounding box in local space
  75054. */
  75055. readonly vectors: Vector3[];
  75056. /**
  75057. * Gets the center of the bounding box in local space
  75058. */
  75059. readonly center: Vector3;
  75060. /**
  75061. * Gets the center of the bounding box in world space
  75062. */
  75063. readonly centerWorld: Vector3;
  75064. /**
  75065. * Gets the extend size in local space
  75066. */
  75067. readonly extendSize: Vector3;
  75068. /**
  75069. * Gets the extend size in world space
  75070. */
  75071. readonly extendSizeWorld: Vector3;
  75072. /**
  75073. * Gets the OBB (object bounding box) directions
  75074. */
  75075. readonly directions: Vector3[];
  75076. /**
  75077. * Gets the 8 vectors representing the bounding box in world space
  75078. */
  75079. readonly vectorsWorld: Vector3[];
  75080. /**
  75081. * Gets the minimum vector in world space
  75082. */
  75083. readonly minimumWorld: Vector3;
  75084. /**
  75085. * Gets the maximum vector in world space
  75086. */
  75087. readonly maximumWorld: Vector3;
  75088. /**
  75089. * Gets the minimum vector in local space
  75090. */
  75091. readonly minimum: Vector3;
  75092. /**
  75093. * Gets the maximum vector in local space
  75094. */
  75095. readonly maximum: Vector3;
  75096. private _worldMatrix;
  75097. private static readonly TmpVector3;
  75098. /**
  75099. * @hidden
  75100. */
  75101. _tag: number;
  75102. /**
  75103. * Creates a new bounding box
  75104. * @param min defines the minimum vector (in local space)
  75105. * @param max defines the maximum vector (in local space)
  75106. * @param worldMatrix defines the new world matrix
  75107. */
  75108. constructor(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  75109. /**
  75110. * Recreates the entire bounding box from scratch as if we call the constructor in place
  75111. * @param min defines the new minimum vector (in local space)
  75112. * @param max defines the new maximum vector (in local space)
  75113. * @param worldMatrix defines the new world matrix
  75114. */
  75115. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  75116. /**
  75117. * Scale the current bounding box by applying a scale factor
  75118. * @param factor defines the scale factor to apply
  75119. * @returns the current bounding box
  75120. */
  75121. scale(factor: number): BoundingBox;
  75122. /**
  75123. * Gets the world matrix of the bounding box
  75124. * @returns a matrix
  75125. */
  75126. getWorldMatrix(): DeepImmutable<Matrix>;
  75127. /** @hidden */
  75128. _update(world: DeepImmutable<Matrix>): void;
  75129. /**
  75130. * Tests if the bounding box is intersecting the frustum planes
  75131. * @param frustumPlanes defines the frustum planes to test
  75132. * @returns true if there is an intersection
  75133. */
  75134. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  75135. /**
  75136. * Tests if the bounding box is entirely inside the frustum planes
  75137. * @param frustumPlanes defines the frustum planes to test
  75138. * @returns true if there is an inclusion
  75139. */
  75140. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  75141. /**
  75142. * Tests if a point is inside the bounding box
  75143. * @param point defines the point to test
  75144. * @returns true if the point is inside the bounding box
  75145. */
  75146. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  75147. /**
  75148. * Tests if the bounding box intersects with a bounding sphere
  75149. * @param sphere defines the sphere to test
  75150. * @returns true if there is an intersection
  75151. */
  75152. intersectsSphere(sphere: DeepImmutable<BoundingSphere>): boolean;
  75153. /**
  75154. * Tests if the bounding box intersects with a box defined by a min and max vectors
  75155. * @param min defines the min vector to use
  75156. * @param max defines the max vector to use
  75157. * @returns true if there is an intersection
  75158. */
  75159. intersectsMinMax(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>): boolean;
  75160. /**
  75161. * Tests if two bounding boxes are intersections
  75162. * @param box0 defines the first box to test
  75163. * @param box1 defines the second box to test
  75164. * @returns true if there is an intersection
  75165. */
  75166. static Intersects(box0: DeepImmutable<BoundingBox>, box1: DeepImmutable<BoundingBox>): boolean;
  75167. /**
  75168. * Tests if a bounding box defines by a min/max vectors intersects a sphere
  75169. * @param minPoint defines the minimum vector of the bounding box
  75170. * @param maxPoint defines the maximum vector of the bounding box
  75171. * @param sphereCenter defines the sphere center
  75172. * @param sphereRadius defines the sphere radius
  75173. * @returns true if there is an intersection
  75174. */
  75175. static IntersectsSphere(minPoint: DeepImmutable<Vector3>, maxPoint: DeepImmutable<Vector3>, sphereCenter: DeepImmutable<Vector3>, sphereRadius: number): boolean;
  75176. /**
  75177. * Tests if a bounding box defined with 8 vectors is entirely inside frustum planes
  75178. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  75179. * @param frustumPlanes defines the frustum planes to test
  75180. * @return true if there is an inclusion
  75181. */
  75182. static IsCompletelyInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  75183. /**
  75184. * Tests if a bounding box defined with 8 vectors intersects frustum planes
  75185. * @param boundingVectors defines an array of 8 vectors representing a bounding box
  75186. * @param frustumPlanes defines the frustum planes to test
  75187. * @return true if there is an intersection
  75188. */
  75189. static IsInFrustum(boundingVectors: Array<DeepImmutable<Vector3>>, frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  75190. }
  75191. }
  75192. declare module BABYLON {
  75193. /** @hidden */
  75194. export class Collider {
  75195. /** Define if a collision was found */
  75196. collisionFound: boolean;
  75197. /**
  75198. * Define last intersection point in local space
  75199. */
  75200. intersectionPoint: Vector3;
  75201. /**
  75202. * Define last collided mesh
  75203. */
  75204. collidedMesh: Nullable<AbstractMesh>;
  75205. private _collisionPoint;
  75206. private _planeIntersectionPoint;
  75207. private _tempVector;
  75208. private _tempVector2;
  75209. private _tempVector3;
  75210. private _tempVector4;
  75211. private _edge;
  75212. private _baseToVertex;
  75213. private _destinationPoint;
  75214. private _slidePlaneNormal;
  75215. private _displacementVector;
  75216. /** @hidden */
  75217. _radius: Vector3;
  75218. /** @hidden */
  75219. _retry: number;
  75220. private _velocity;
  75221. private _basePoint;
  75222. private _epsilon;
  75223. /** @hidden */
  75224. _velocityWorldLength: number;
  75225. /** @hidden */
  75226. _basePointWorld: Vector3;
  75227. private _velocityWorld;
  75228. private _normalizedVelocity;
  75229. /** @hidden */
  75230. _initialVelocity: Vector3;
  75231. /** @hidden */
  75232. _initialPosition: Vector3;
  75233. private _nearestDistance;
  75234. private _collisionMask;
  75235. collisionMask: number;
  75236. /**
  75237. * Gets the plane normal used to compute the sliding response (in local space)
  75238. */
  75239. readonly slidePlaneNormal: Vector3;
  75240. /** @hidden */
  75241. _initialize(source: Vector3, dir: Vector3, e: number): void;
  75242. /** @hidden */
  75243. _checkPointInTriangle(point: Vector3, pa: Vector3, pb: Vector3, pc: Vector3, n: Vector3): boolean;
  75244. /** @hidden */
  75245. _canDoCollision(sphereCenter: Vector3, sphereRadius: number, vecMin: Vector3, vecMax: Vector3): boolean;
  75246. /** @hidden */
  75247. _testTriangle(faceIndex: number, trianglePlaneArray: Array<Plane>, p1: Vector3, p2: Vector3, p3: Vector3, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  75248. /** @hidden */
  75249. _collide(trianglePlaneArray: Array<Plane>, pts: Vector3[], indices: IndicesArray, indexStart: number, indexEnd: number, decal: number, hasMaterial: boolean, hostMesh: AbstractMesh): void;
  75250. /** @hidden */
  75251. _getResponse(pos: Vector3, vel: Vector3): void;
  75252. }
  75253. }
  75254. declare module BABYLON {
  75255. /**
  75256. * Interface for cullable objects
  75257. * @see https://doc.babylonjs.com/babylon101/materials#back-face-culling
  75258. */
  75259. export interface ICullable {
  75260. /**
  75261. * Checks if the object or part of the object is in the frustum
  75262. * @param frustumPlanes Camera near/planes
  75263. * @returns true if the object is in frustum otherwise false
  75264. */
  75265. isInFrustum(frustumPlanes: Plane[]): boolean;
  75266. /**
  75267. * Checks if a cullable object (mesh...) is in the camera frustum
  75268. * Unlike isInFrustum this cheks the full bounding box
  75269. * @param frustumPlanes Camera near/planes
  75270. * @returns true if the object is in frustum otherwise false
  75271. */
  75272. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  75273. }
  75274. /**
  75275. * Info for a bounding data of a mesh
  75276. */
  75277. export class BoundingInfo implements ICullable {
  75278. /**
  75279. * Bounding box for the mesh
  75280. */
  75281. readonly boundingBox: BoundingBox;
  75282. /**
  75283. * Bounding sphere for the mesh
  75284. */
  75285. readonly boundingSphere: BoundingSphere;
  75286. private _isLocked;
  75287. private static readonly TmpVector3;
  75288. /**
  75289. * Constructs bounding info
  75290. * @param minimum min vector of the bounding box/sphere
  75291. * @param maximum max vector of the bounding box/sphere
  75292. * @param worldMatrix defines the new world matrix
  75293. */
  75294. constructor(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>);
  75295. /**
  75296. * Recreates the entire bounding info from scratch as if we call the constructor in place
  75297. * @param min defines the new minimum vector (in local space)
  75298. * @param max defines the new maximum vector (in local space)
  75299. * @param worldMatrix defines the new world matrix
  75300. */
  75301. reConstruct(min: DeepImmutable<Vector3>, max: DeepImmutable<Vector3>, worldMatrix?: DeepImmutable<Matrix>): void;
  75302. /**
  75303. * min vector of the bounding box/sphere
  75304. */
  75305. readonly minimum: Vector3;
  75306. /**
  75307. * max vector of the bounding box/sphere
  75308. */
  75309. readonly maximum: Vector3;
  75310. /**
  75311. * If the info is locked and won't be updated to avoid perf overhead
  75312. */
  75313. isLocked: boolean;
  75314. /**
  75315. * Updates the bounding sphere and box
  75316. * @param world world matrix to be used to update
  75317. */
  75318. update(world: DeepImmutable<Matrix>): void;
  75319. /**
  75320. * Recreate the bounding info to be centered around a specific point given a specific extend.
  75321. * @param center New center of the bounding info
  75322. * @param extend New extend of the bounding info
  75323. * @returns the current bounding info
  75324. */
  75325. centerOn(center: DeepImmutable<Vector3>, extend: DeepImmutable<Vector3>): BoundingInfo;
  75326. /**
  75327. * Scale the current bounding info by applying a scale factor
  75328. * @param factor defines the scale factor to apply
  75329. * @returns the current bounding info
  75330. */
  75331. scale(factor: number): BoundingInfo;
  75332. /**
  75333. * Returns `true` if the bounding info is within the frustum defined by the passed array of planes.
  75334. * @param frustumPlanes defines the frustum to test
  75335. * @param strategy defines the strategy to use for the culling (default is BABYLON.AbstractMesh.CULLINGSTRATEGY_STANDARD)
  75336. * @returns true if the bounding info is in the frustum planes
  75337. */
  75338. isInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>, strategy?: number): boolean;
  75339. /**
  75340. * Gets the world distance between the min and max points of the bounding box
  75341. */
  75342. readonly diagonalLength: number;
  75343. /**
  75344. * Checks if a cullable object (mesh...) is in the camera frustum
  75345. * Unlike isInFrustum this cheks the full bounding box
  75346. * @param frustumPlanes Camera near/planes
  75347. * @returns true if the object is in frustum otherwise false
  75348. */
  75349. isCompletelyInFrustum(frustumPlanes: Array<DeepImmutable<Plane>>): boolean;
  75350. /** @hidden */
  75351. _checkCollision(collider: Collider): boolean;
  75352. /**
  75353. * Checks if a point is inside the bounding box and bounding sphere or the mesh
  75354. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  75355. * @param point the point to check intersection with
  75356. * @returns if the point intersects
  75357. */
  75358. intersectsPoint(point: DeepImmutable<Vector3>): boolean;
  75359. /**
  75360. * Checks if another bounding info intersects the bounding box and bounding sphere or the mesh
  75361. * @see https://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  75362. * @param boundingInfo the bounding info to check intersection with
  75363. * @param precise if the intersection should be done using OBB
  75364. * @returns if the bounding info intersects
  75365. */
  75366. intersects(boundingInfo: DeepImmutable<BoundingInfo>, precise: boolean): boolean;
  75367. }
  75368. }
  75369. declare module BABYLON {
  75370. /**
  75371. * Extracts minimum and maximum values from a list of indexed positions
  75372. * @param positions defines the positions to use
  75373. * @param indices defines the indices to the positions
  75374. * @param indexStart defines the start index
  75375. * @param indexCount defines the end index
  75376. * @param bias defines bias value to add to the result
  75377. * @return minimum and maximum values
  75378. */
  75379. export function extractMinAndMaxIndexed(positions: FloatArray, indices: IndicesArray, indexStart: number, indexCount: number, bias?: Nullable<Vector2>): {
  75380. minimum: Vector3;
  75381. maximum: Vector3;
  75382. };
  75383. /**
  75384. * Extracts minimum and maximum values from a list of positions
  75385. * @param positions defines the positions to use
  75386. * @param start defines the start index in the positions array
  75387. * @param count defines the number of positions to handle
  75388. * @param bias defines bias value to add to the result
  75389. * @param stride defines the stride size to use (distance between two positions in the positions array)
  75390. * @return minimum and maximum values
  75391. */
  75392. export function extractMinAndMax(positions: FloatArray, start: number, count: number, bias?: Nullable<Vector2>, stride?: number): {
  75393. minimum: Vector3;
  75394. maximum: Vector3;
  75395. };
  75396. }
  75397. declare module BABYLON {
  75398. /** @hidden */
  75399. export class WebGLDataBuffer extends DataBuffer {
  75400. private _buffer;
  75401. constructor(resource: WebGLBuffer);
  75402. readonly underlyingResource: any;
  75403. }
  75404. }
  75405. declare module BABYLON {
  75406. /** @hidden */
  75407. export class WebGLPipelineContext implements IPipelineContext {
  75408. engine: ThinEngine;
  75409. program: Nullable<WebGLProgram>;
  75410. context?: WebGLRenderingContext;
  75411. vertexShader?: WebGLShader;
  75412. fragmentShader?: WebGLShader;
  75413. isParallelCompiled: boolean;
  75414. onCompiled?: () => void;
  75415. transformFeedback?: WebGLTransformFeedback | null;
  75416. readonly isAsync: boolean;
  75417. readonly isReady: boolean;
  75418. _handlesSpectorRebuildCallback(onCompiled: (program: WebGLProgram) => void): void;
  75419. }
  75420. }
  75421. declare module BABYLON {
  75422. interface ThinEngine {
  75423. /**
  75424. * Create an uniform buffer
  75425. * @see http://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  75426. * @param elements defines the content of the uniform buffer
  75427. * @returns the webGL uniform buffer
  75428. */
  75429. createUniformBuffer(elements: FloatArray): DataBuffer;
  75430. /**
  75431. * Create a dynamic uniform buffer
  75432. * @see http://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  75433. * @param elements defines the content of the uniform buffer
  75434. * @returns the webGL uniform buffer
  75435. */
  75436. createDynamicUniformBuffer(elements: FloatArray): DataBuffer;
  75437. /**
  75438. * Update an existing uniform buffer
  75439. * @see http://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  75440. * @param uniformBuffer defines the target uniform buffer
  75441. * @param elements defines the content to update
  75442. * @param offset defines the offset in the uniform buffer where update should start
  75443. * @param count defines the size of the data to update
  75444. */
  75445. updateUniformBuffer(uniformBuffer: DataBuffer, elements: FloatArray, offset?: number, count?: number): void;
  75446. /**
  75447. * Bind an uniform buffer to the current webGL context
  75448. * @param buffer defines the buffer to bind
  75449. */
  75450. bindUniformBuffer(buffer: Nullable<DataBuffer>): void;
  75451. /**
  75452. * Bind a buffer to the current webGL context at a given location
  75453. * @param buffer defines the buffer to bind
  75454. * @param location defines the index where to bind the buffer
  75455. */
  75456. bindUniformBufferBase(buffer: DataBuffer, location: number): void;
  75457. /**
  75458. * Bind a specific block at a given index in a specific shader program
  75459. * @param pipelineContext defines the pipeline context to use
  75460. * @param blockName defines the block name
  75461. * @param index defines the index where to bind the block
  75462. */
  75463. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  75464. }
  75465. }
  75466. declare module BABYLON {
  75467. /**
  75468. * Uniform buffer objects.
  75469. *
  75470. * Handles blocks of uniform on the GPU.
  75471. *
  75472. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  75473. *
  75474. * For more information, please refer to :
  75475. * https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  75476. */
  75477. export class UniformBuffer {
  75478. private _engine;
  75479. private _buffer;
  75480. private _data;
  75481. private _bufferData;
  75482. private _dynamic?;
  75483. private _uniformLocations;
  75484. private _uniformSizes;
  75485. private _uniformLocationPointer;
  75486. private _needSync;
  75487. private _noUBO;
  75488. private _currentEffect;
  75489. /** @hidden */
  75490. _alreadyBound: boolean;
  75491. private static _MAX_UNIFORM_SIZE;
  75492. private static _tempBuffer;
  75493. /**
  75494. * Lambda to Update a 3x3 Matrix in a uniform buffer.
  75495. * This is dynamic to allow compat with webgl 1 and 2.
  75496. * You will need to pass the name of the uniform as well as the value.
  75497. */
  75498. updateMatrix3x3: (name: string, matrix: Float32Array) => void;
  75499. /**
  75500. * Lambda to Update a 2x2 Matrix in a uniform buffer.
  75501. * This is dynamic to allow compat with webgl 1 and 2.
  75502. * You will need to pass the name of the uniform as well as the value.
  75503. */
  75504. updateMatrix2x2: (name: string, matrix: Float32Array) => void;
  75505. /**
  75506. * Lambda to Update a single float in a uniform buffer.
  75507. * This is dynamic to allow compat with webgl 1 and 2.
  75508. * You will need to pass the name of the uniform as well as the value.
  75509. */
  75510. updateFloat: (name: string, x: number) => void;
  75511. /**
  75512. * Lambda to Update a vec2 of float in a uniform buffer.
  75513. * This is dynamic to allow compat with webgl 1 and 2.
  75514. * You will need to pass the name of the uniform as well as the value.
  75515. */
  75516. updateFloat2: (name: string, x: number, y: number, suffix?: string) => void;
  75517. /**
  75518. * Lambda to Update a vec3 of float in a uniform buffer.
  75519. * This is dynamic to allow compat with webgl 1 and 2.
  75520. * You will need to pass the name of the uniform as well as the value.
  75521. */
  75522. updateFloat3: (name: string, x: number, y: number, z: number, suffix?: string) => void;
  75523. /**
  75524. * Lambda to Update a vec4 of float in a uniform buffer.
  75525. * This is dynamic to allow compat with webgl 1 and 2.
  75526. * You will need to pass the name of the uniform as well as the value.
  75527. */
  75528. updateFloat4: (name: string, x: number, y: number, z: number, w: number, suffix?: string) => void;
  75529. /**
  75530. * Lambda to Update a 4x4 Matrix in a uniform buffer.
  75531. * This is dynamic to allow compat with webgl 1 and 2.
  75532. * You will need to pass the name of the uniform as well as the value.
  75533. */
  75534. updateMatrix: (name: string, mat: Matrix) => void;
  75535. /**
  75536. * Lambda to Update vec3 of float from a Vector in a uniform buffer.
  75537. * This is dynamic to allow compat with webgl 1 and 2.
  75538. * You will need to pass the name of the uniform as well as the value.
  75539. */
  75540. updateVector3: (name: string, vector: Vector3) => void;
  75541. /**
  75542. * Lambda to Update vec4 of float from a Vector in a uniform buffer.
  75543. * This is dynamic to allow compat with webgl 1 and 2.
  75544. * You will need to pass the name of the uniform as well as the value.
  75545. */
  75546. updateVector4: (name: string, vector: Vector4) => void;
  75547. /**
  75548. * Lambda to Update vec3 of float from a Color in a uniform buffer.
  75549. * This is dynamic to allow compat with webgl 1 and 2.
  75550. * You will need to pass the name of the uniform as well as the value.
  75551. */
  75552. updateColor3: (name: string, color: Color3, suffix?: string) => void;
  75553. /**
  75554. * Lambda to Update vec4 of float from a Color in a uniform buffer.
  75555. * This is dynamic to allow compat with webgl 1 and 2.
  75556. * You will need to pass the name of the uniform as well as the value.
  75557. */
  75558. updateColor4: (name: string, color: Color3, alpha: number, suffix?: string) => void;
  75559. /**
  75560. * Instantiates a new Uniform buffer objects.
  75561. *
  75562. * Handles blocks of uniform on the GPU.
  75563. *
  75564. * If WebGL 2 is not available, this class falls back on traditionnal setUniformXXX calls.
  75565. *
  75566. * For more information, please refer to :
  75567. * @see https://www.khronos.org/opengl/wiki/Uniform_Buffer_Object
  75568. * @param engine Define the engine the buffer is associated with
  75569. * @param data Define the data contained in the buffer
  75570. * @param dynamic Define if the buffer is updatable
  75571. */
  75572. constructor(engine: Engine, data?: number[], dynamic?: boolean);
  75573. /**
  75574. * Indicates if the buffer is using the WebGL2 UBO implementation,
  75575. * or just falling back on setUniformXXX calls.
  75576. */
  75577. readonly useUbo: boolean;
  75578. /**
  75579. * Indicates if the WebGL underlying uniform buffer is in sync
  75580. * with the javascript cache data.
  75581. */
  75582. readonly isSync: boolean;
  75583. /**
  75584. * Indicates if the WebGL underlying uniform buffer is dynamic.
  75585. * Also, a dynamic UniformBuffer will disable cache verification and always
  75586. * update the underlying WebGL uniform buffer to the GPU.
  75587. * @returns if Dynamic, otherwise false
  75588. */
  75589. isDynamic(): boolean;
  75590. /**
  75591. * The data cache on JS side.
  75592. * @returns the underlying data as a float array
  75593. */
  75594. getData(): Float32Array;
  75595. /**
  75596. * The underlying WebGL Uniform buffer.
  75597. * @returns the webgl buffer
  75598. */
  75599. getBuffer(): Nullable<DataBuffer>;
  75600. /**
  75601. * std140 layout specifies how to align data within an UBO structure.
  75602. * See https://khronos.org/registry/OpenGL/specs/gl/glspec45.core.pdf#page=159
  75603. * for specs.
  75604. */
  75605. private _fillAlignment;
  75606. /**
  75607. * Adds an uniform in the buffer.
  75608. * Warning : the subsequents calls of this function must be in the same order as declared in the shader
  75609. * for the layout to be correct !
  75610. * @param name Name of the uniform, as used in the uniform block in the shader.
  75611. * @param size Data size, or data directly.
  75612. */
  75613. addUniform(name: string, size: number | number[]): void;
  75614. /**
  75615. * Adds a Matrix 4x4 to the uniform buffer.
  75616. * @param name Name of the uniform, as used in the uniform block in the shader.
  75617. * @param mat A 4x4 matrix.
  75618. */
  75619. addMatrix(name: string, mat: Matrix): void;
  75620. /**
  75621. * Adds a vec2 to the uniform buffer.
  75622. * @param name Name of the uniform, as used in the uniform block in the shader.
  75623. * @param x Define the x component value of the vec2
  75624. * @param y Define the y component value of the vec2
  75625. */
  75626. addFloat2(name: string, x: number, y: number): void;
  75627. /**
  75628. * Adds a vec3 to the uniform buffer.
  75629. * @param name Name of the uniform, as used in the uniform block in the shader.
  75630. * @param x Define the x component value of the vec3
  75631. * @param y Define the y component value of the vec3
  75632. * @param z Define the z component value of the vec3
  75633. */
  75634. addFloat3(name: string, x: number, y: number, z: number): void;
  75635. /**
  75636. * Adds a vec3 to the uniform buffer.
  75637. * @param name Name of the uniform, as used in the uniform block in the shader.
  75638. * @param color Define the vec3 from a Color
  75639. */
  75640. addColor3(name: string, color: Color3): void;
  75641. /**
  75642. * Adds a vec4 to the uniform buffer.
  75643. * @param name Name of the uniform, as used in the uniform block in the shader.
  75644. * @param color Define the rgb components from a Color
  75645. * @param alpha Define the a component of the vec4
  75646. */
  75647. addColor4(name: string, color: Color3, alpha: number): void;
  75648. /**
  75649. * Adds a vec3 to the uniform buffer.
  75650. * @param name Name of the uniform, as used in the uniform block in the shader.
  75651. * @param vector Define the vec3 components from a Vector
  75652. */
  75653. addVector3(name: string, vector: Vector3): void;
  75654. /**
  75655. * Adds a Matrix 3x3 to the uniform buffer.
  75656. * @param name Name of the uniform, as used in the uniform block in the shader.
  75657. */
  75658. addMatrix3x3(name: string): void;
  75659. /**
  75660. * Adds a Matrix 2x2 to the uniform buffer.
  75661. * @param name Name of the uniform, as used in the uniform block in the shader.
  75662. */
  75663. addMatrix2x2(name: string): void;
  75664. /**
  75665. * Effectively creates the WebGL Uniform Buffer, once layout is completed with `addUniform`.
  75666. */
  75667. create(): void;
  75668. /** @hidden */
  75669. _rebuild(): void;
  75670. /**
  75671. * Updates the WebGL Uniform Buffer on the GPU.
  75672. * If the `dynamic` flag is set to true, no cache comparison is done.
  75673. * Otherwise, the buffer will be updated only if the cache differs.
  75674. */
  75675. update(): void;
  75676. /**
  75677. * Updates the value of an uniform. The `update` method must be called afterwards to make it effective in the GPU.
  75678. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  75679. * @param data Define the flattened data
  75680. * @param size Define the size of the data.
  75681. */
  75682. updateUniform(uniformName: string, data: FloatArray, size: number): void;
  75683. private _valueCache;
  75684. private _cacheMatrix;
  75685. private _updateMatrix3x3ForUniform;
  75686. private _updateMatrix3x3ForEffect;
  75687. private _updateMatrix2x2ForEffect;
  75688. private _updateMatrix2x2ForUniform;
  75689. private _updateFloatForEffect;
  75690. private _updateFloatForUniform;
  75691. private _updateFloat2ForEffect;
  75692. private _updateFloat2ForUniform;
  75693. private _updateFloat3ForEffect;
  75694. private _updateFloat3ForUniform;
  75695. private _updateFloat4ForEffect;
  75696. private _updateFloat4ForUniform;
  75697. private _updateMatrixForEffect;
  75698. private _updateMatrixForUniform;
  75699. private _updateVector3ForEffect;
  75700. private _updateVector3ForUniform;
  75701. private _updateVector4ForEffect;
  75702. private _updateVector4ForUniform;
  75703. private _updateColor3ForEffect;
  75704. private _updateColor3ForUniform;
  75705. private _updateColor4ForEffect;
  75706. private _updateColor4ForUniform;
  75707. /**
  75708. * Sets a sampler uniform on the effect.
  75709. * @param name Define the name of the sampler.
  75710. * @param texture Define the texture to set in the sampler
  75711. */
  75712. setTexture(name: string, texture: Nullable<BaseTexture>): void;
  75713. /**
  75714. * Directly updates the value of the uniform in the cache AND on the GPU.
  75715. * @param uniformName Define the name of the uniform, as used in the uniform block in the shader.
  75716. * @param data Define the flattened data
  75717. */
  75718. updateUniformDirectly(uniformName: string, data: FloatArray): void;
  75719. /**
  75720. * Binds this uniform buffer to an effect.
  75721. * @param effect Define the effect to bind the buffer to
  75722. * @param name Name of the uniform block in the shader.
  75723. */
  75724. bindToEffect(effect: Effect, name: string): void;
  75725. /**
  75726. * Disposes the uniform buffer.
  75727. */
  75728. dispose(): void;
  75729. }
  75730. }
  75731. declare module BABYLON {
  75732. /**
  75733. * Enum that determines the text-wrapping mode to use.
  75734. */
  75735. export enum InspectableType {
  75736. /**
  75737. * Checkbox for booleans
  75738. */
  75739. Checkbox = 0,
  75740. /**
  75741. * Sliders for numbers
  75742. */
  75743. Slider = 1,
  75744. /**
  75745. * Vector3
  75746. */
  75747. Vector3 = 2,
  75748. /**
  75749. * Quaternions
  75750. */
  75751. Quaternion = 3,
  75752. /**
  75753. * Color3
  75754. */
  75755. Color3 = 4,
  75756. /**
  75757. * String
  75758. */
  75759. String = 5
  75760. }
  75761. /**
  75762. * Interface used to define custom inspectable properties.
  75763. * This interface is used by the inspector to display custom property grids
  75764. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  75765. */
  75766. export interface IInspectable {
  75767. /**
  75768. * Gets the label to display
  75769. */
  75770. label: string;
  75771. /**
  75772. * Gets the name of the property to edit
  75773. */
  75774. propertyName: string;
  75775. /**
  75776. * Gets the type of the editor to use
  75777. */
  75778. type: InspectableType;
  75779. /**
  75780. * Gets the minimum value of the property when using in "slider" mode
  75781. */
  75782. min?: number;
  75783. /**
  75784. * Gets the maximum value of the property when using in "slider" mode
  75785. */
  75786. max?: number;
  75787. /**
  75788. * Gets the setp to use when using in "slider" mode
  75789. */
  75790. step?: number;
  75791. }
  75792. }
  75793. declare module BABYLON {
  75794. /**
  75795. * Class used to provide helper for timing
  75796. */
  75797. export class TimingTools {
  75798. /**
  75799. * Polyfill for setImmediate
  75800. * @param action defines the action to execute after the current execution block
  75801. */
  75802. static SetImmediate(action: () => void): void;
  75803. }
  75804. }
  75805. declare module BABYLON {
  75806. /**
  75807. * Class used to enable instatition of objects by class name
  75808. */
  75809. export class InstantiationTools {
  75810. /**
  75811. * Use this object to register external classes like custom textures or material
  75812. * to allow the laoders to instantiate them
  75813. */
  75814. static RegisteredExternalClasses: {
  75815. [key: string]: Object;
  75816. };
  75817. /**
  75818. * Tries to instantiate a new object from a given class name
  75819. * @param className defines the class name to instantiate
  75820. * @returns the new object or null if the system was not able to do the instantiation
  75821. */
  75822. static Instantiate(className: string): any;
  75823. }
  75824. }
  75825. declare module BABYLON {
  75826. /**
  75827. * Define options used to create a depth texture
  75828. */
  75829. export class DepthTextureCreationOptions {
  75830. /** Specifies whether or not a stencil should be allocated in the texture */
  75831. generateStencil?: boolean;
  75832. /** Specifies whether or not bilinear filtering is enable on the texture */
  75833. bilinearFiltering?: boolean;
  75834. /** Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode */
  75835. comparisonFunction?: number;
  75836. /** Specifies if the created texture is a cube texture */
  75837. isCube?: boolean;
  75838. }
  75839. }
  75840. declare module BABYLON {
  75841. interface ThinEngine {
  75842. /**
  75843. * Creates a depth stencil cube texture.
  75844. * This is only available in WebGL 2.
  75845. * @param size The size of face edge in the cube texture.
  75846. * @param options The options defining the cube texture.
  75847. * @returns The cube texture
  75848. */
  75849. _createDepthStencilCubeTexture(size: number, options: DepthTextureCreationOptions): InternalTexture;
  75850. /**
  75851. * Creates a cube texture
  75852. * @param rootUrl defines the url where the files to load is located
  75853. * @param scene defines the current scene
  75854. * @param files defines the list of files to load (1 per face)
  75855. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  75856. * @param onLoad defines an optional callback raised when the texture is loaded
  75857. * @param onError defines an optional callback raised if there is an issue to load the texture
  75858. * @param format defines the format of the data
  75859. * @param forcedExtension defines the extension to use to pick the right loader
  75860. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  75861. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  75862. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  75863. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  75864. * @param excludeLoaders array of texture loaders that should be excluded when picking a loader for the texture (defualt: empty array)
  75865. * @returns the cube texture as an InternalTexture
  75866. */
  75867. 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;
  75868. /**
  75869. * Creates a cube texture
  75870. * @param rootUrl defines the url where the files to load is located
  75871. * @param scene defines the current scene
  75872. * @param files defines the list of files to load (1 per face)
  75873. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  75874. * @param onLoad defines an optional callback raised when the texture is loaded
  75875. * @param onError defines an optional callback raised if there is an issue to load the texture
  75876. * @param format defines the format of the data
  75877. * @param forcedExtension defines the extension to use to pick the right loader
  75878. * @returns the cube texture as an InternalTexture
  75879. */
  75880. 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;
  75881. /**
  75882. * Creates a cube texture
  75883. * @param rootUrl defines the url where the files to load is located
  75884. * @param scene defines the current scene
  75885. * @param files defines the list of files to load (1 per face)
  75886. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  75887. * @param onLoad defines an optional callback raised when the texture is loaded
  75888. * @param onError defines an optional callback raised if there is an issue to load the texture
  75889. * @param format defines the format of the data
  75890. * @param forcedExtension defines the extension to use to pick the right loader
  75891. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  75892. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  75893. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  75894. * @returns the cube texture as an InternalTexture
  75895. */
  75896. 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;
  75897. /** @hidden */
  75898. _partialLoadFile(url: string, index: number, loadedFiles: (string | ArrayBuffer)[], onfinish: (files: (string | ArrayBuffer)[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>): void;
  75899. /** @hidden */
  75900. _cascadeLoadFiles(scene: Nullable<Scene>, onfinish: (images: (string | ArrayBuffer)[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>): void;
  75901. /** @hidden */
  75902. _cascadeLoadImgs(scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, files: string[], onError: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  75903. /** @hidden */
  75904. _partialLoadImg(url: string, index: number, loadedImages: HTMLImageElement[], scene: Nullable<Scene>, onfinish: (images: HTMLImageElement[]) => void, onErrorCallBack: Nullable<(message?: string, exception?: any) => void>, mimeType?: string): void;
  75905. /**
  75906. * @hidden
  75907. */
  75908. _setCubeMapTextureParams(loadMipmap: boolean): void;
  75909. }
  75910. }
  75911. declare module BABYLON {
  75912. /**
  75913. * Class for creating a cube texture
  75914. */
  75915. export class CubeTexture extends BaseTexture {
  75916. private _delayedOnLoad;
  75917. /**
  75918. * The url of the texture
  75919. */
  75920. url: string;
  75921. /**
  75922. * Gets or sets the center of the bounding box associated with the cube texture.
  75923. * It must define where the camera used to render the texture was set
  75924. * @see http://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  75925. */
  75926. boundingBoxPosition: Vector3;
  75927. private _boundingBoxSize;
  75928. /**
  75929. * Gets or sets the size of the bounding box associated with the cube texture
  75930. * When defined, the cubemap will switch to local mode
  75931. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  75932. * @example https://www.babylonjs-playground.com/#RNASML
  75933. */
  75934. /**
  75935. * Returns the bounding box size
  75936. * @see http://doc.babylonjs.com/how_to/reflect#using-local-cubemap-mode
  75937. */
  75938. boundingBoxSize: Vector3;
  75939. protected _rotationY: number;
  75940. /**
  75941. * Sets texture matrix rotation angle around Y axis in radians.
  75942. */
  75943. /**
  75944. * Gets texture matrix rotation angle around Y axis radians.
  75945. */
  75946. rotationY: number;
  75947. /**
  75948. * Are mip maps generated for this texture or not.
  75949. */
  75950. readonly noMipmap: boolean;
  75951. private _noMipmap;
  75952. private _files;
  75953. protected _forcedExtension: Nullable<string>;
  75954. private _extensions;
  75955. private _textureMatrix;
  75956. private _format;
  75957. private _createPolynomials;
  75958. /** @hidden */
  75959. _prefiltered: boolean;
  75960. /**
  75961. * Creates a cube texture from an array of image urls
  75962. * @param files defines an array of image urls
  75963. * @param scene defines the hosting scene
  75964. * @param noMipmap specifies if mip maps are not used
  75965. * @returns a cube texture
  75966. */
  75967. static CreateFromImages(files: string[], scene: Scene, noMipmap?: boolean): CubeTexture;
  75968. /**
  75969. * Creates and return a texture created from prefilterd data by tools like IBL Baker or Lys.
  75970. * @param url defines the url of the prefiltered texture
  75971. * @param scene defines the scene the texture is attached to
  75972. * @param forcedExtension defines the extension of the file if different from the url
  75973. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  75974. * @return the prefiltered texture
  75975. */
  75976. static CreateFromPrefilteredData(url: string, scene: Scene, forcedExtension?: any, createPolynomials?: boolean): CubeTexture;
  75977. /**
  75978. * Creates a cube texture to use with reflection for instance. It can be based upon dds or six images as well
  75979. * as prefiltered data.
  75980. * @param rootUrl defines the url of the texture or the root name of the six images
  75981. * @param scene defines the scene the texture is attached to
  75982. * @param extensions defines the suffixes add to the picture name in case six images are in use like _px.jpg...
  75983. * @param noMipmap defines if mipmaps should be created or not
  75984. * @param files defines the six files to load for the different faces in that order: px, py, pz, nx, ny, nz
  75985. * @param onLoad defines a callback triggered at the end of the file load if no errors occured
  75986. * @param onError defines a callback triggered in case of error during load
  75987. * @param format defines the internal format to use for the texture once loaded
  75988. * @param prefiltered defines whether or not the texture is created from prefiltered data
  75989. * @param forcedExtension defines the extensions to use (force a special type of file to load) in case it is different from the file name
  75990. * @param createPolynomials defines whether or not to create polynomial harmonics from the texture data if necessary
  75991. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  75992. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  75993. * @return the cube texture
  75994. */
  75995. 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);
  75996. /**
  75997. * Gets a boolean indicating if the cube texture contains prefiltered mips (used to simulate roughness with PBR)
  75998. */
  75999. readonly isPrefiltered: boolean;
  76000. /**
  76001. * Get the current class name of the texture useful for serialization or dynamic coding.
  76002. * @returns "CubeTexture"
  76003. */
  76004. getClassName(): string;
  76005. /**
  76006. * Update the url (and optional buffer) of this texture if url was null during construction.
  76007. * @param url the url of the texture
  76008. * @param forcedExtension defines the extension to use
  76009. * @param onLoad callback called when the texture is loaded (defaults to null)
  76010. */
  76011. updateURL(url: string, forcedExtension?: string, onLoad?: () => void): void;
  76012. /**
  76013. * Delays loading of the cube texture
  76014. * @param forcedExtension defines the extension to use
  76015. */
  76016. delayLoad(forcedExtension?: string): void;
  76017. /**
  76018. * Returns the reflection texture matrix
  76019. * @returns the reflection texture matrix
  76020. */
  76021. getReflectionTextureMatrix(): Matrix;
  76022. /**
  76023. * Sets the reflection texture matrix
  76024. * @param value Reflection texture matrix
  76025. */
  76026. setReflectionTextureMatrix(value: Matrix): void;
  76027. /**
  76028. * Parses text to create a cube texture
  76029. * @param parsedTexture define the serialized text to read from
  76030. * @param scene defines the hosting scene
  76031. * @param rootUrl defines the root url of the cube texture
  76032. * @returns a cube texture
  76033. */
  76034. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): CubeTexture;
  76035. /**
  76036. * Makes a clone, or deep copy, of the cube texture
  76037. * @returns a new cube texture
  76038. */
  76039. clone(): CubeTexture;
  76040. }
  76041. }
  76042. declare module BABYLON {
  76043. /**
  76044. * Manages the defines for the Material
  76045. */
  76046. export class MaterialDefines {
  76047. /** @hidden */
  76048. protected _keys: string[];
  76049. private _isDirty;
  76050. /** @hidden */
  76051. _renderId: number;
  76052. /** @hidden */
  76053. _areLightsDirty: boolean;
  76054. /** @hidden */
  76055. _areLightsDisposed: boolean;
  76056. /** @hidden */
  76057. _areAttributesDirty: boolean;
  76058. /** @hidden */
  76059. _areTexturesDirty: boolean;
  76060. /** @hidden */
  76061. _areFresnelDirty: boolean;
  76062. /** @hidden */
  76063. _areMiscDirty: boolean;
  76064. /** @hidden */
  76065. _areImageProcessingDirty: boolean;
  76066. /** @hidden */
  76067. _normals: boolean;
  76068. /** @hidden */
  76069. _uvs: boolean;
  76070. /** @hidden */
  76071. _needNormals: boolean;
  76072. /** @hidden */
  76073. _needUVs: boolean;
  76074. [id: string]: any;
  76075. /**
  76076. * Specifies if the material needs to be re-calculated
  76077. */
  76078. readonly isDirty: boolean;
  76079. /**
  76080. * Marks the material to indicate that it has been re-calculated
  76081. */
  76082. markAsProcessed(): void;
  76083. /**
  76084. * Marks the material to indicate that it needs to be re-calculated
  76085. */
  76086. markAsUnprocessed(): void;
  76087. /**
  76088. * Marks the material to indicate all of its defines need to be re-calculated
  76089. */
  76090. markAllAsDirty(): void;
  76091. /**
  76092. * Marks the material to indicate that image processing needs to be re-calculated
  76093. */
  76094. markAsImageProcessingDirty(): void;
  76095. /**
  76096. * Marks the material to indicate the lights need to be re-calculated
  76097. * @param disposed Defines whether the light is dirty due to dispose or not
  76098. */
  76099. markAsLightDirty(disposed?: boolean): void;
  76100. /**
  76101. * Marks the attribute state as changed
  76102. */
  76103. markAsAttributesDirty(): void;
  76104. /**
  76105. * Marks the texture state as changed
  76106. */
  76107. markAsTexturesDirty(): void;
  76108. /**
  76109. * Marks the fresnel state as changed
  76110. */
  76111. markAsFresnelDirty(): void;
  76112. /**
  76113. * Marks the misc state as changed
  76114. */
  76115. markAsMiscDirty(): void;
  76116. /**
  76117. * Rebuilds the material defines
  76118. */
  76119. rebuild(): void;
  76120. /**
  76121. * Specifies if two material defines are equal
  76122. * @param other - A material define instance to compare to
  76123. * @returns - Boolean indicating if the material defines are equal (true) or not (false)
  76124. */
  76125. isEqual(other: MaterialDefines): boolean;
  76126. /**
  76127. * Clones this instance's defines to another instance
  76128. * @param other - material defines to clone values to
  76129. */
  76130. cloneTo(other: MaterialDefines): void;
  76131. /**
  76132. * Resets the material define values
  76133. */
  76134. reset(): void;
  76135. /**
  76136. * Converts the material define values to a string
  76137. * @returns - String of material define information
  76138. */
  76139. toString(): string;
  76140. }
  76141. }
  76142. declare module BABYLON {
  76143. /**
  76144. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  76145. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  76146. * 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;
  76147. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  76148. */
  76149. export class ColorCurves {
  76150. private _dirty;
  76151. private _tempColor;
  76152. private _globalCurve;
  76153. private _highlightsCurve;
  76154. private _midtonesCurve;
  76155. private _shadowsCurve;
  76156. private _positiveCurve;
  76157. private _negativeCurve;
  76158. private _globalHue;
  76159. private _globalDensity;
  76160. private _globalSaturation;
  76161. private _globalExposure;
  76162. /**
  76163. * Gets the global Hue value.
  76164. * 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).
  76165. */
  76166. /**
  76167. * Sets the global Hue value.
  76168. * 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).
  76169. */
  76170. globalHue: number;
  76171. /**
  76172. * Gets the global Density value.
  76173. * 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.
  76174. * Values less than zero provide a filter of opposite hue.
  76175. */
  76176. /**
  76177. * Sets the global Density value.
  76178. * 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.
  76179. * Values less than zero provide a filter of opposite hue.
  76180. */
  76181. globalDensity: number;
  76182. /**
  76183. * Gets the global Saturation value.
  76184. * 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.
  76185. */
  76186. /**
  76187. * Sets the global Saturation value.
  76188. * 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.
  76189. */
  76190. globalSaturation: number;
  76191. /**
  76192. * Gets the global Exposure value.
  76193. * 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.
  76194. */
  76195. /**
  76196. * Sets the global Exposure value.
  76197. * 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.
  76198. */
  76199. globalExposure: number;
  76200. private _highlightsHue;
  76201. private _highlightsDensity;
  76202. private _highlightsSaturation;
  76203. private _highlightsExposure;
  76204. /**
  76205. * Gets the highlights Hue value.
  76206. * 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).
  76207. */
  76208. /**
  76209. * Sets the highlights Hue value.
  76210. * 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).
  76211. */
  76212. highlightsHue: number;
  76213. /**
  76214. * Gets the highlights Density value.
  76215. * 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.
  76216. * Values less than zero provide a filter of opposite hue.
  76217. */
  76218. /**
  76219. * Sets the highlights Density value.
  76220. * 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.
  76221. * Values less than zero provide a filter of opposite hue.
  76222. */
  76223. highlightsDensity: number;
  76224. /**
  76225. * Gets the highlights Saturation value.
  76226. * 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.
  76227. */
  76228. /**
  76229. * Sets the highlights Saturation value.
  76230. * 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.
  76231. */
  76232. highlightsSaturation: number;
  76233. /**
  76234. * Gets the highlights Exposure value.
  76235. * 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.
  76236. */
  76237. /**
  76238. * Sets the highlights Exposure value.
  76239. * 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.
  76240. */
  76241. highlightsExposure: number;
  76242. private _midtonesHue;
  76243. private _midtonesDensity;
  76244. private _midtonesSaturation;
  76245. private _midtonesExposure;
  76246. /**
  76247. * Gets the midtones Hue value.
  76248. * 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).
  76249. */
  76250. /**
  76251. * Sets the midtones Hue value.
  76252. * 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).
  76253. */
  76254. midtonesHue: number;
  76255. /**
  76256. * Gets the midtones Density value.
  76257. * 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.
  76258. * Values less than zero provide a filter of opposite hue.
  76259. */
  76260. /**
  76261. * Sets the midtones Density value.
  76262. * 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.
  76263. * Values less than zero provide a filter of opposite hue.
  76264. */
  76265. midtonesDensity: number;
  76266. /**
  76267. * Gets the midtones Saturation value.
  76268. * 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.
  76269. */
  76270. /**
  76271. * Sets the midtones Saturation value.
  76272. * 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.
  76273. */
  76274. midtonesSaturation: number;
  76275. /**
  76276. * Gets the midtones Exposure value.
  76277. * 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.
  76278. */
  76279. /**
  76280. * Sets the midtones Exposure value.
  76281. * 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.
  76282. */
  76283. midtonesExposure: number;
  76284. private _shadowsHue;
  76285. private _shadowsDensity;
  76286. private _shadowsSaturation;
  76287. private _shadowsExposure;
  76288. /**
  76289. * Gets the shadows Hue value.
  76290. * 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).
  76291. */
  76292. /**
  76293. * Sets the shadows Hue value.
  76294. * 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).
  76295. */
  76296. shadowsHue: number;
  76297. /**
  76298. * Gets the shadows Density value.
  76299. * 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.
  76300. * Values less than zero provide a filter of opposite hue.
  76301. */
  76302. /**
  76303. * Sets the shadows Density value.
  76304. * 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.
  76305. * Values less than zero provide a filter of opposite hue.
  76306. */
  76307. shadowsDensity: number;
  76308. /**
  76309. * Gets the shadows Saturation value.
  76310. * 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.
  76311. */
  76312. /**
  76313. * Sets the shadows Saturation value.
  76314. * 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.
  76315. */
  76316. shadowsSaturation: number;
  76317. /**
  76318. * Gets the shadows Exposure value.
  76319. * 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.
  76320. */
  76321. /**
  76322. * Sets the shadows Exposure value.
  76323. * 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.
  76324. */
  76325. shadowsExposure: number;
  76326. /**
  76327. * Returns the class name
  76328. * @returns The class name
  76329. */
  76330. getClassName(): string;
  76331. /**
  76332. * Binds the color curves to the shader.
  76333. * @param colorCurves The color curve to bind
  76334. * @param effect The effect to bind to
  76335. * @param positiveUniform The positive uniform shader parameter
  76336. * @param neutralUniform The neutral uniform shader parameter
  76337. * @param negativeUniform The negative uniform shader parameter
  76338. */
  76339. static Bind(colorCurves: ColorCurves, effect: Effect, positiveUniform?: string, neutralUniform?: string, negativeUniform?: string): void;
  76340. /**
  76341. * Prepare the list of uniforms associated with the ColorCurves effects.
  76342. * @param uniformsList The list of uniforms used in the effect
  76343. */
  76344. static PrepareUniforms(uniformsList: string[]): void;
  76345. /**
  76346. * Returns color grading data based on a hue, density, saturation and exposure value.
  76347. * @param filterHue The hue of the color filter.
  76348. * @param filterDensity The density of the color filter.
  76349. * @param saturation The saturation.
  76350. * @param exposure The exposure.
  76351. * @param result The result data container.
  76352. */
  76353. private getColorGradingDataToRef;
  76354. /**
  76355. * Takes an input slider value and returns an adjusted value that provides extra control near the centre.
  76356. * @param value The input slider value in range [-100,100].
  76357. * @returns Adjusted value.
  76358. */
  76359. private static applyColorGradingSliderNonlinear;
  76360. /**
  76361. * Returns an RGBA Color4 based on Hue, Saturation and Brightness (also referred to as value, HSV).
  76362. * @param hue The hue (H) input.
  76363. * @param saturation The saturation (S) input.
  76364. * @param brightness The brightness (B) input.
  76365. * @result An RGBA color represented as Vector4.
  76366. */
  76367. private static fromHSBToRef;
  76368. /**
  76369. * Returns a value clamped between min and max
  76370. * @param value The value to clamp
  76371. * @param min The minimum of value
  76372. * @param max The maximum of value
  76373. * @returns The clamped value.
  76374. */
  76375. private static clamp;
  76376. /**
  76377. * Clones the current color curve instance.
  76378. * @return The cloned curves
  76379. */
  76380. clone(): ColorCurves;
  76381. /**
  76382. * Serializes the current color curve instance to a json representation.
  76383. * @return a JSON representation
  76384. */
  76385. serialize(): any;
  76386. /**
  76387. * Parses the color curve from a json representation.
  76388. * @param source the JSON source to parse
  76389. * @return The parsed curves
  76390. */
  76391. static Parse(source: any): ColorCurves;
  76392. }
  76393. }
  76394. declare module BABYLON {
  76395. /**
  76396. * Interface to follow in your material defines to integrate easily the
  76397. * Image proccessing functions.
  76398. * @hidden
  76399. */
  76400. export interface IImageProcessingConfigurationDefines {
  76401. IMAGEPROCESSING: boolean;
  76402. VIGNETTE: boolean;
  76403. VIGNETTEBLENDMODEMULTIPLY: boolean;
  76404. VIGNETTEBLENDMODEOPAQUE: boolean;
  76405. TONEMAPPING: boolean;
  76406. TONEMAPPING_ACES: boolean;
  76407. CONTRAST: boolean;
  76408. EXPOSURE: boolean;
  76409. COLORCURVES: boolean;
  76410. COLORGRADING: boolean;
  76411. COLORGRADING3D: boolean;
  76412. SAMPLER3DGREENDEPTH: boolean;
  76413. SAMPLER3DBGRMAP: boolean;
  76414. IMAGEPROCESSINGPOSTPROCESS: boolean;
  76415. }
  76416. /**
  76417. * @hidden
  76418. */
  76419. export class ImageProcessingConfigurationDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  76420. IMAGEPROCESSING: boolean;
  76421. VIGNETTE: boolean;
  76422. VIGNETTEBLENDMODEMULTIPLY: boolean;
  76423. VIGNETTEBLENDMODEOPAQUE: boolean;
  76424. TONEMAPPING: boolean;
  76425. TONEMAPPING_ACES: boolean;
  76426. CONTRAST: boolean;
  76427. COLORCURVES: boolean;
  76428. COLORGRADING: boolean;
  76429. COLORGRADING3D: boolean;
  76430. SAMPLER3DGREENDEPTH: boolean;
  76431. SAMPLER3DBGRMAP: boolean;
  76432. IMAGEPROCESSINGPOSTPROCESS: boolean;
  76433. EXPOSURE: boolean;
  76434. constructor();
  76435. }
  76436. /**
  76437. * This groups together the common properties used for image processing either in direct forward pass
  76438. * or through post processing effect depending on the use of the image processing pipeline in your scene
  76439. * or not.
  76440. */
  76441. export class ImageProcessingConfiguration {
  76442. /**
  76443. * Default tone mapping applied in BabylonJS.
  76444. */
  76445. static readonly TONEMAPPING_STANDARD: number;
  76446. /**
  76447. * ACES Tone mapping (used by default in unreal and unity). This can help getting closer
  76448. * to other engines rendering to increase portability.
  76449. */
  76450. static readonly TONEMAPPING_ACES: number;
  76451. /**
  76452. * Color curves setup used in the effect if colorCurvesEnabled is set to true
  76453. */
  76454. colorCurves: Nullable<ColorCurves>;
  76455. private _colorCurvesEnabled;
  76456. /**
  76457. * Gets wether the color curves effect is enabled.
  76458. */
  76459. /**
  76460. * Sets wether the color curves effect is enabled.
  76461. */
  76462. colorCurvesEnabled: boolean;
  76463. private _colorGradingTexture;
  76464. /**
  76465. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  76466. */
  76467. /**
  76468. * Color grading LUT texture used in the effect if colorGradingEnabled is set to true
  76469. */
  76470. colorGradingTexture: Nullable<BaseTexture>;
  76471. private _colorGradingEnabled;
  76472. /**
  76473. * Gets wether the color grading effect is enabled.
  76474. */
  76475. /**
  76476. * Sets wether the color grading effect is enabled.
  76477. */
  76478. colorGradingEnabled: boolean;
  76479. private _colorGradingWithGreenDepth;
  76480. /**
  76481. * Gets wether the color grading effect is using a green depth for the 3d Texture.
  76482. */
  76483. /**
  76484. * Sets wether the color grading effect is using a green depth for the 3d Texture.
  76485. */
  76486. colorGradingWithGreenDepth: boolean;
  76487. private _colorGradingBGR;
  76488. /**
  76489. * Gets wether the color grading texture contains BGR values.
  76490. */
  76491. /**
  76492. * Sets wether the color grading texture contains BGR values.
  76493. */
  76494. colorGradingBGR: boolean;
  76495. /** @hidden */
  76496. _exposure: number;
  76497. /**
  76498. * Gets the Exposure used in the effect.
  76499. */
  76500. /**
  76501. * Sets the Exposure used in the effect.
  76502. */
  76503. exposure: number;
  76504. private _toneMappingEnabled;
  76505. /**
  76506. * Gets wether the tone mapping effect is enabled.
  76507. */
  76508. /**
  76509. * Sets wether the tone mapping effect is enabled.
  76510. */
  76511. toneMappingEnabled: boolean;
  76512. private _toneMappingType;
  76513. /**
  76514. * Gets the type of tone mapping effect.
  76515. */
  76516. /**
  76517. * Sets the type of tone mapping effect used in BabylonJS.
  76518. */
  76519. toneMappingType: number;
  76520. protected _contrast: number;
  76521. /**
  76522. * Gets the contrast used in the effect.
  76523. */
  76524. /**
  76525. * Sets the contrast used in the effect.
  76526. */
  76527. contrast: number;
  76528. /**
  76529. * Vignette stretch size.
  76530. */
  76531. vignetteStretch: number;
  76532. /**
  76533. * Vignette centre X Offset.
  76534. */
  76535. vignetteCentreX: number;
  76536. /**
  76537. * Vignette centre Y Offset.
  76538. */
  76539. vignetteCentreY: number;
  76540. /**
  76541. * Vignette weight or intensity of the vignette effect.
  76542. */
  76543. vignetteWeight: number;
  76544. /**
  76545. * Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  76546. * if vignetteEnabled is set to true.
  76547. */
  76548. vignetteColor: Color4;
  76549. /**
  76550. * Camera field of view used by the Vignette effect.
  76551. */
  76552. vignetteCameraFov: number;
  76553. private _vignetteBlendMode;
  76554. /**
  76555. * Gets the vignette blend mode allowing different kind of effect.
  76556. */
  76557. /**
  76558. * Sets the vignette blend mode allowing different kind of effect.
  76559. */
  76560. vignetteBlendMode: number;
  76561. private _vignetteEnabled;
  76562. /**
  76563. * Gets wether the vignette effect is enabled.
  76564. */
  76565. /**
  76566. * Sets wether the vignette effect is enabled.
  76567. */
  76568. vignetteEnabled: boolean;
  76569. private _applyByPostProcess;
  76570. /**
  76571. * Gets wether the image processing is applied through a post process or not.
  76572. */
  76573. /**
  76574. * Sets wether the image processing is applied through a post process or not.
  76575. */
  76576. applyByPostProcess: boolean;
  76577. private _isEnabled;
  76578. /**
  76579. * Gets wether the image processing is enabled or not.
  76580. */
  76581. /**
  76582. * Sets wether the image processing is enabled or not.
  76583. */
  76584. isEnabled: boolean;
  76585. /**
  76586. * An event triggered when the configuration changes and requires Shader to Update some parameters.
  76587. */
  76588. onUpdateParameters: Observable<ImageProcessingConfiguration>;
  76589. /**
  76590. * Method called each time the image processing information changes requires to recompile the effect.
  76591. */
  76592. protected _updateParameters(): void;
  76593. /**
  76594. * Gets the current class name.
  76595. * @return "ImageProcessingConfiguration"
  76596. */
  76597. getClassName(): string;
  76598. /**
  76599. * Prepare the list of uniforms associated with the Image Processing effects.
  76600. * @param uniforms The list of uniforms used in the effect
  76601. * @param defines the list of defines currently in use
  76602. */
  76603. static PrepareUniforms(uniforms: string[], defines: IImageProcessingConfigurationDefines): void;
  76604. /**
  76605. * Prepare the list of samplers associated with the Image Processing effects.
  76606. * @param samplersList The list of uniforms used in the effect
  76607. * @param defines the list of defines currently in use
  76608. */
  76609. static PrepareSamplers(samplersList: string[], defines: IImageProcessingConfigurationDefines): void;
  76610. /**
  76611. * Prepare the list of defines associated to the shader.
  76612. * @param defines the list of defines to complete
  76613. * @param forPostProcess Define if we are currently in post process mode or not
  76614. */
  76615. prepareDefines(defines: IImageProcessingConfigurationDefines, forPostProcess?: boolean): void;
  76616. /**
  76617. * Returns true if all the image processing information are ready.
  76618. * @returns True if ready, otherwise, false
  76619. */
  76620. isReady(): boolean;
  76621. /**
  76622. * Binds the image processing to the shader.
  76623. * @param effect The effect to bind to
  76624. * @param overrideAspectRatio Override the aspect ratio of the effect
  76625. */
  76626. bind(effect: Effect, overrideAspectRatio?: number): void;
  76627. /**
  76628. * Clones the current image processing instance.
  76629. * @return The cloned image processing
  76630. */
  76631. clone(): ImageProcessingConfiguration;
  76632. /**
  76633. * Serializes the current image processing instance to a json representation.
  76634. * @return a JSON representation
  76635. */
  76636. serialize(): any;
  76637. /**
  76638. * Parses the image processing from a json representation.
  76639. * @param source the JSON source to parse
  76640. * @return The parsed image processing
  76641. */
  76642. static Parse(source: any): ImageProcessingConfiguration;
  76643. private static _VIGNETTEMODE_MULTIPLY;
  76644. private static _VIGNETTEMODE_OPAQUE;
  76645. /**
  76646. * Used to apply the vignette as a mix with the pixel color.
  76647. */
  76648. static readonly VIGNETTEMODE_MULTIPLY: number;
  76649. /**
  76650. * Used to apply the vignette as a replacement of the pixel color.
  76651. */
  76652. static readonly VIGNETTEMODE_OPAQUE: number;
  76653. }
  76654. }
  76655. declare module BABYLON {
  76656. /** @hidden */
  76657. export var postprocessVertexShader: {
  76658. name: string;
  76659. shader: string;
  76660. };
  76661. }
  76662. declare module BABYLON {
  76663. interface ThinEngine {
  76664. /**
  76665. * Creates a new render target texture
  76666. * @param size defines the size of the texture
  76667. * @param options defines the options used to create the texture
  76668. * @returns a new render target texture stored in an InternalTexture
  76669. */
  76670. createRenderTargetTexture(size: number | {
  76671. width: number;
  76672. height: number;
  76673. }, options: boolean | RenderTargetCreationOptions): InternalTexture;
  76674. /**
  76675. * Creates a depth stencil texture.
  76676. * This is only available in WebGL 2 or with the depth texture extension available.
  76677. * @param size The size of face edge in the texture.
  76678. * @param options The options defining the texture.
  76679. * @returns The texture
  76680. */
  76681. createDepthStencilTexture(size: number | {
  76682. width: number;
  76683. height: number;
  76684. }, options: DepthTextureCreationOptions): InternalTexture;
  76685. /** @hidden */
  76686. _createDepthStencilTexture(size: number | {
  76687. width: number;
  76688. height: number;
  76689. }, options: DepthTextureCreationOptions): InternalTexture;
  76690. }
  76691. }
  76692. declare module BABYLON {
  76693. /** Defines supported spaces */
  76694. export enum Space {
  76695. /** Local (object) space */
  76696. LOCAL = 0,
  76697. /** World space */
  76698. WORLD = 1,
  76699. /** Bone space */
  76700. BONE = 2
  76701. }
  76702. /** Defines the 3 main axes */
  76703. export class Axis {
  76704. /** X axis */
  76705. static X: Vector3;
  76706. /** Y axis */
  76707. static Y: Vector3;
  76708. /** Z axis */
  76709. static Z: Vector3;
  76710. }
  76711. }
  76712. declare module BABYLON {
  76713. /**
  76714. * A target camera takes a mesh or position as a target and continues to look at it while it moves.
  76715. * This is the base of the follow, arc rotate cameras and Free camera
  76716. * @see http://doc.babylonjs.com/features/cameras
  76717. */
  76718. export class TargetCamera extends Camera {
  76719. private static _RigCamTransformMatrix;
  76720. private static _TargetTransformMatrix;
  76721. private static _TargetFocalPoint;
  76722. /**
  76723. * Define the current direction the camera is moving to
  76724. */
  76725. cameraDirection: Vector3;
  76726. /**
  76727. * Define the current rotation the camera is rotating to
  76728. */
  76729. cameraRotation: Vector2;
  76730. /**
  76731. * When set, the up vector of the camera will be updated by the rotation of the camera
  76732. */
  76733. updateUpVectorFromRotation: boolean;
  76734. private _tmpQuaternion;
  76735. /**
  76736. * Define the current rotation of the camera
  76737. */
  76738. rotation: Vector3;
  76739. /**
  76740. * Define the current rotation of the camera as a quaternion to prevent Gimbal lock
  76741. */
  76742. rotationQuaternion: Quaternion;
  76743. /**
  76744. * Define the current speed of the camera
  76745. */
  76746. speed: number;
  76747. /**
  76748. * Add constraint to the camera to prevent it to move freely in all directions and
  76749. * around all axis.
  76750. */
  76751. noRotationConstraint: boolean;
  76752. /**
  76753. * Define the current target of the camera as an object or a position.
  76754. */
  76755. lockedTarget: any;
  76756. /** @hidden */
  76757. _currentTarget: Vector3;
  76758. /** @hidden */
  76759. _initialFocalDistance: number;
  76760. /** @hidden */
  76761. _viewMatrix: Matrix;
  76762. /** @hidden */
  76763. _camMatrix: Matrix;
  76764. /** @hidden */
  76765. _cameraTransformMatrix: Matrix;
  76766. /** @hidden */
  76767. _cameraRotationMatrix: Matrix;
  76768. /** @hidden */
  76769. _referencePoint: Vector3;
  76770. /** @hidden */
  76771. _transformedReferencePoint: Vector3;
  76772. protected _globalCurrentTarget: Vector3;
  76773. protected _globalCurrentUpVector: Vector3;
  76774. /** @hidden */
  76775. _reset: () => void;
  76776. private _defaultUp;
  76777. /**
  76778. * Instantiates a target camera that takes a mesh or position as a target and continues to look at it while it moves.
  76779. * This is the base of the follow, arc rotate cameras and Free camera
  76780. * @see http://doc.babylonjs.com/features/cameras
  76781. * @param name Defines the name of the camera in the scene
  76782. * @param position Defines the start position of the camera in the scene
  76783. * @param scene Defines the scene the camera belongs to
  76784. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  76785. */
  76786. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  76787. /**
  76788. * Gets the position in front of the camera at a given distance.
  76789. * @param distance The distance from the camera we want the position to be
  76790. * @returns the position
  76791. */
  76792. getFrontPosition(distance: number): Vector3;
  76793. /** @hidden */
  76794. _getLockedTargetPosition(): Nullable<Vector3>;
  76795. private _storedPosition;
  76796. private _storedRotation;
  76797. private _storedRotationQuaternion;
  76798. /**
  76799. * Store current camera state of the camera (fov, position, rotation, etc..)
  76800. * @returns the camera
  76801. */
  76802. storeState(): Camera;
  76803. /**
  76804. * Restored camera state. You must call storeState() first
  76805. * @returns whether it was successful or not
  76806. * @hidden
  76807. */
  76808. _restoreStateValues(): boolean;
  76809. /** @hidden */
  76810. _initCache(): void;
  76811. /** @hidden */
  76812. _updateCache(ignoreParentClass?: boolean): void;
  76813. /** @hidden */
  76814. _isSynchronizedViewMatrix(): boolean;
  76815. /** @hidden */
  76816. _computeLocalCameraSpeed(): number;
  76817. /**
  76818. * Defines the target the camera should look at.
  76819. * @param target Defines the new target as a Vector or a mesh
  76820. */
  76821. setTarget(target: Vector3): void;
  76822. /**
  76823. * Return the current target position of the camera. This value is expressed in local space.
  76824. * @returns the target position
  76825. */
  76826. getTarget(): Vector3;
  76827. /** @hidden */
  76828. _decideIfNeedsToMove(): boolean;
  76829. /** @hidden */
  76830. _updatePosition(): void;
  76831. /** @hidden */
  76832. _checkInputs(): void;
  76833. protected _updateCameraRotationMatrix(): void;
  76834. /**
  76835. * 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)
  76836. * @returns the current camera
  76837. */
  76838. private _rotateUpVectorWithCameraRotationMatrix;
  76839. private _cachedRotationZ;
  76840. private _cachedQuaternionRotationZ;
  76841. /** @hidden */
  76842. _getViewMatrix(): Matrix;
  76843. protected _computeViewMatrix(position: Vector3, target: Vector3, up: Vector3): void;
  76844. /**
  76845. * @hidden
  76846. */
  76847. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  76848. /**
  76849. * @hidden
  76850. */
  76851. _updateRigCameras(): void;
  76852. private _getRigCamPositionAndTarget;
  76853. /**
  76854. * Gets the current object class name.
  76855. * @return the class name
  76856. */
  76857. getClassName(): string;
  76858. }
  76859. }
  76860. declare module BABYLON {
  76861. /**
  76862. * Gather the list of keyboard event types as constants.
  76863. */
  76864. export class KeyboardEventTypes {
  76865. /**
  76866. * The keydown event is fired when a key becomes active (pressed).
  76867. */
  76868. static readonly KEYDOWN: number;
  76869. /**
  76870. * The keyup event is fired when a key has been released.
  76871. */
  76872. static readonly KEYUP: number;
  76873. }
  76874. /**
  76875. * This class is used to store keyboard related info for the onKeyboardObservable event.
  76876. */
  76877. export class KeyboardInfo {
  76878. /**
  76879. * Defines the type of event (KeyboardEventTypes)
  76880. */
  76881. type: number;
  76882. /**
  76883. * Defines the related dom event
  76884. */
  76885. event: KeyboardEvent;
  76886. /**
  76887. * Instantiates a new keyboard info.
  76888. * This class is used to store keyboard related info for the onKeyboardObservable event.
  76889. * @param type Defines the type of event (KeyboardEventTypes)
  76890. * @param event Defines the related dom event
  76891. */
  76892. constructor(
  76893. /**
  76894. * Defines the type of event (KeyboardEventTypes)
  76895. */
  76896. type: number,
  76897. /**
  76898. * Defines the related dom event
  76899. */
  76900. event: KeyboardEvent);
  76901. }
  76902. /**
  76903. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  76904. * Set the skipOnKeyboardObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onKeyboardObservable
  76905. */
  76906. export class KeyboardInfoPre extends KeyboardInfo {
  76907. /**
  76908. * Defines the type of event (KeyboardEventTypes)
  76909. */
  76910. type: number;
  76911. /**
  76912. * Defines the related dom event
  76913. */
  76914. event: KeyboardEvent;
  76915. /**
  76916. * Defines whether the engine should skip the next onKeyboardObservable associated to this pre.
  76917. */
  76918. skipOnPointerObservable: boolean;
  76919. /**
  76920. * Instantiates a new keyboard pre info.
  76921. * This class is used to store keyboard related info for the onPreKeyboardObservable event.
  76922. * @param type Defines the type of event (KeyboardEventTypes)
  76923. * @param event Defines the related dom event
  76924. */
  76925. constructor(
  76926. /**
  76927. * Defines the type of event (KeyboardEventTypes)
  76928. */
  76929. type: number,
  76930. /**
  76931. * Defines the related dom event
  76932. */
  76933. event: KeyboardEvent);
  76934. }
  76935. }
  76936. declare module BABYLON {
  76937. /**
  76938. * Manage the keyboard inputs to control the movement of a free camera.
  76939. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  76940. */
  76941. export class FreeCameraKeyboardMoveInput implements ICameraInput<FreeCamera> {
  76942. /**
  76943. * Defines the camera the input is attached to.
  76944. */
  76945. camera: FreeCamera;
  76946. /**
  76947. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  76948. */
  76949. keysUp: number[];
  76950. /**
  76951. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  76952. */
  76953. keysDown: number[];
  76954. /**
  76955. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  76956. */
  76957. keysLeft: number[];
  76958. /**
  76959. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  76960. */
  76961. keysRight: number[];
  76962. private _keys;
  76963. private _onCanvasBlurObserver;
  76964. private _onKeyboardObserver;
  76965. private _engine;
  76966. private _scene;
  76967. /**
  76968. * Attach the input controls to a specific dom element to get the input from.
  76969. * @param element Defines the element the controls should be listened from
  76970. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  76971. */
  76972. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  76973. /**
  76974. * Detach the current controls from the specified dom element.
  76975. * @param element Defines the element to stop listening the inputs from
  76976. */
  76977. detachControl(element: Nullable<HTMLElement>): void;
  76978. /**
  76979. * Update the current camera state depending on the inputs that have been used this frame.
  76980. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  76981. */
  76982. checkInputs(): void;
  76983. /**
  76984. * Gets the class name of the current intput.
  76985. * @returns the class name
  76986. */
  76987. getClassName(): string;
  76988. /** @hidden */
  76989. _onLostFocus(): void;
  76990. /**
  76991. * Get the friendly name associated with the input class.
  76992. * @returns the input friendly name
  76993. */
  76994. getSimpleName(): string;
  76995. }
  76996. }
  76997. declare module BABYLON {
  76998. /**
  76999. * Interface describing all the common properties and methods a shadow light needs to implement.
  77000. * This helps both the shadow generator and materials to genrate the corresponding shadow maps
  77001. * as well as binding the different shadow properties to the effects.
  77002. */
  77003. export interface IShadowLight extends Light {
  77004. /**
  77005. * The light id in the scene (used in scene.findLighById for instance)
  77006. */
  77007. id: string;
  77008. /**
  77009. * The position the shdow will be casted from.
  77010. */
  77011. position: Vector3;
  77012. /**
  77013. * In 2d mode (needCube being false), the direction used to cast the shadow.
  77014. */
  77015. direction: Vector3;
  77016. /**
  77017. * The transformed position. Position of the light in world space taking parenting in account.
  77018. */
  77019. transformedPosition: Vector3;
  77020. /**
  77021. * The transformed direction. Direction of the light in world space taking parenting in account.
  77022. */
  77023. transformedDirection: Vector3;
  77024. /**
  77025. * The friendly name of the light in the scene.
  77026. */
  77027. name: string;
  77028. /**
  77029. * Defines the shadow projection clipping minimum z value.
  77030. */
  77031. shadowMinZ: number;
  77032. /**
  77033. * Defines the shadow projection clipping maximum z value.
  77034. */
  77035. shadowMaxZ: number;
  77036. /**
  77037. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  77038. * @returns true if the information has been computed, false if it does not need to (no parenting)
  77039. */
  77040. computeTransformedInformation(): boolean;
  77041. /**
  77042. * Gets the scene the light belongs to.
  77043. * @returns The scene
  77044. */
  77045. getScene(): Scene;
  77046. /**
  77047. * Callback defining a custom Projection Matrix Builder.
  77048. * This can be used to override the default projection matrix computation.
  77049. */
  77050. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  77051. /**
  77052. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  77053. * @param matrix The materix to updated with the projection information
  77054. * @param viewMatrix The transform matrix of the light
  77055. * @param renderList The list of mesh to render in the map
  77056. * @returns The current light
  77057. */
  77058. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  77059. /**
  77060. * Gets the current depth scale used in ESM.
  77061. * @returns The scale
  77062. */
  77063. getDepthScale(): number;
  77064. /**
  77065. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  77066. * @returns true if a cube texture needs to be use
  77067. */
  77068. needCube(): boolean;
  77069. /**
  77070. * Detects if the projection matrix requires to be recomputed this frame.
  77071. * @returns true if it requires to be recomputed otherwise, false.
  77072. */
  77073. needProjectionMatrixCompute(): boolean;
  77074. /**
  77075. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  77076. */
  77077. forceProjectionMatrixCompute(): void;
  77078. /**
  77079. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  77080. * @param faceIndex The index of the face we are computed the direction to generate shadow
  77081. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  77082. */
  77083. getShadowDirection(faceIndex?: number): Vector3;
  77084. /**
  77085. * Gets the minZ used for shadow according to both the scene and the light.
  77086. * @param activeCamera The camera we are returning the min for
  77087. * @returns the depth min z
  77088. */
  77089. getDepthMinZ(activeCamera: Camera): number;
  77090. /**
  77091. * Gets the maxZ used for shadow according to both the scene and the light.
  77092. * @param activeCamera The camera we are returning the max for
  77093. * @returns the depth max z
  77094. */
  77095. getDepthMaxZ(activeCamera: Camera): number;
  77096. }
  77097. /**
  77098. * Base implementation IShadowLight
  77099. * It groups all the common behaviour in order to reduce dupplication and better follow the DRY pattern.
  77100. */
  77101. export abstract class ShadowLight extends Light implements IShadowLight {
  77102. protected abstract _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  77103. protected _position: Vector3;
  77104. protected _setPosition(value: Vector3): void;
  77105. /**
  77106. * Sets the position the shadow will be casted from. Also use as the light position for both
  77107. * point and spot lights.
  77108. */
  77109. /**
  77110. * Sets the position the shadow will be casted from. Also use as the light position for both
  77111. * point and spot lights.
  77112. */
  77113. position: Vector3;
  77114. protected _direction: Vector3;
  77115. protected _setDirection(value: Vector3): void;
  77116. /**
  77117. * In 2d mode (needCube being false), gets the direction used to cast the shadow.
  77118. * Also use as the light direction on spot and directional lights.
  77119. */
  77120. /**
  77121. * In 2d mode (needCube being false), sets the direction used to cast the shadow.
  77122. * Also use as the light direction on spot and directional lights.
  77123. */
  77124. direction: Vector3;
  77125. private _shadowMinZ;
  77126. /**
  77127. * Gets the shadow projection clipping minimum z value.
  77128. */
  77129. /**
  77130. * Sets the shadow projection clipping minimum z value.
  77131. */
  77132. shadowMinZ: number;
  77133. private _shadowMaxZ;
  77134. /**
  77135. * Sets the shadow projection clipping maximum z value.
  77136. */
  77137. /**
  77138. * Gets the shadow projection clipping maximum z value.
  77139. */
  77140. shadowMaxZ: number;
  77141. /**
  77142. * Callback defining a custom Projection Matrix Builder.
  77143. * This can be used to override the default projection matrix computation.
  77144. */
  77145. customProjectionMatrixBuilder: (viewMatrix: Matrix, renderList: Array<AbstractMesh>, result: Matrix) => void;
  77146. /**
  77147. * The transformed position. Position of the light in world space taking parenting in account.
  77148. */
  77149. transformedPosition: Vector3;
  77150. /**
  77151. * The transformed direction. Direction of the light in world space taking parenting in account.
  77152. */
  77153. transformedDirection: Vector3;
  77154. private _needProjectionMatrixCompute;
  77155. /**
  77156. * Computes the transformed information (transformedPosition and transformedDirection in World space) of the current light
  77157. * @returns true if the information has been computed, false if it does not need to (no parenting)
  77158. */
  77159. computeTransformedInformation(): boolean;
  77160. /**
  77161. * Return the depth scale used for the shadow map.
  77162. * @returns the depth scale.
  77163. */
  77164. getDepthScale(): number;
  77165. /**
  77166. * Get the direction to use to render the shadow map. In case of cube texture, the face index can be passed.
  77167. * @param faceIndex The index of the face we are computed the direction to generate shadow
  77168. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  77169. */
  77170. getShadowDirection(faceIndex?: number): Vector3;
  77171. /**
  77172. * Returns the ShadowLight absolute position in the World.
  77173. * @returns the position vector in world space
  77174. */
  77175. getAbsolutePosition(): Vector3;
  77176. /**
  77177. * Sets the ShadowLight direction toward the passed target.
  77178. * @param target The point to target in local space
  77179. * @returns the updated ShadowLight direction
  77180. */
  77181. setDirectionToTarget(target: Vector3): Vector3;
  77182. /**
  77183. * Returns the light rotation in euler definition.
  77184. * @returns the x y z rotation in local space.
  77185. */
  77186. getRotation(): Vector3;
  77187. /**
  77188. * Returns whether or not the shadow generation require a cube texture or a 2d texture.
  77189. * @returns true if a cube texture needs to be use
  77190. */
  77191. needCube(): boolean;
  77192. /**
  77193. * Detects if the projection matrix requires to be recomputed this frame.
  77194. * @returns true if it requires to be recomputed otherwise, false.
  77195. */
  77196. needProjectionMatrixCompute(): boolean;
  77197. /**
  77198. * Forces the shadow generator to recompute the projection matrix even if position and direction did not changed.
  77199. */
  77200. forceProjectionMatrixCompute(): void;
  77201. /** @hidden */
  77202. _initCache(): void;
  77203. /** @hidden */
  77204. _isSynchronized(): boolean;
  77205. /**
  77206. * Computes the world matrix of the node
  77207. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  77208. * @returns the world matrix
  77209. */
  77210. computeWorldMatrix(force?: boolean): Matrix;
  77211. /**
  77212. * Gets the minZ used for shadow according to both the scene and the light.
  77213. * @param activeCamera The camera we are returning the min for
  77214. * @returns the depth min z
  77215. */
  77216. getDepthMinZ(activeCamera: Camera): number;
  77217. /**
  77218. * Gets the maxZ used for shadow according to both the scene and the light.
  77219. * @param activeCamera The camera we are returning the max for
  77220. * @returns the depth max z
  77221. */
  77222. getDepthMaxZ(activeCamera: Camera): number;
  77223. /**
  77224. * Sets the shadow projection matrix in parameter to the generated projection matrix.
  77225. * @param matrix The materix to updated with the projection information
  77226. * @param viewMatrix The transform matrix of the light
  77227. * @param renderList The list of mesh to render in the map
  77228. * @returns The current light
  77229. */
  77230. setShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): IShadowLight;
  77231. }
  77232. }
  77233. declare module BABYLON {
  77234. /**
  77235. * EffectFallbacks can be used to add fallbacks (properties to disable) to certain properties when desired to improve performance.
  77236. * (Eg. Start at high quality with reflection and fog, if fps is low, remove reflection, if still low remove fog)
  77237. */
  77238. export class EffectFallbacks implements IEffectFallbacks {
  77239. private _defines;
  77240. private _currentRank;
  77241. private _maxRank;
  77242. private _mesh;
  77243. /**
  77244. * Removes the fallback from the bound mesh.
  77245. */
  77246. unBindMesh(): void;
  77247. /**
  77248. * Adds a fallback on the specified property.
  77249. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  77250. * @param define The name of the define in the shader
  77251. */
  77252. addFallback(rank: number, define: string): void;
  77253. /**
  77254. * Sets the mesh to use CPU skinning when needing to fallback.
  77255. * @param rank The rank of the fallback (Lower ranks will be fallbacked to first)
  77256. * @param mesh The mesh to use the fallbacks.
  77257. */
  77258. addCPUSkinningFallback(rank: number, mesh: AbstractMesh): void;
  77259. /**
  77260. * Checks to see if more fallbacks are still availible.
  77261. */
  77262. readonly hasMoreFallbacks: boolean;
  77263. /**
  77264. * Removes the defines that should be removed when falling back.
  77265. * @param currentDefines defines the current define statements for the shader.
  77266. * @param effect defines the current effect we try to compile
  77267. * @returns The resulting defines with defines of the current rank removed.
  77268. */
  77269. reduce(currentDefines: string, effect: Effect): string;
  77270. }
  77271. }
  77272. declare module BABYLON {
  77273. /**
  77274. * "Static Class" containing the most commonly used helper while dealing with material for
  77275. * rendering purpose.
  77276. *
  77277. * It contains the basic tools to help defining defines, binding uniform for the common part of the materials.
  77278. *
  77279. * This works by convention in BabylonJS but is meant to be use only with shader following the in place naming rules and conventions.
  77280. */
  77281. export class MaterialHelper {
  77282. /**
  77283. * Bind the current view position to an effect.
  77284. * @param effect The effect to be bound
  77285. * @param scene The scene the eyes position is used from
  77286. */
  77287. static BindEyePosition(effect: Effect, scene: Scene): void;
  77288. /**
  77289. * Helps preparing the defines values about the UVs in used in the effect.
  77290. * UVs are shared as much as we can accross channels in the shaders.
  77291. * @param texture The texture we are preparing the UVs for
  77292. * @param defines The defines to update
  77293. * @param key The channel key "diffuse", "specular"... used in the shader
  77294. */
  77295. static PrepareDefinesForMergedUV(texture: BaseTexture, defines: any, key: string): void;
  77296. /**
  77297. * Binds a texture matrix value to its corrsponding uniform
  77298. * @param texture The texture to bind the matrix for
  77299. * @param uniformBuffer The uniform buffer receivin the data
  77300. * @param key The channel key "diffuse", "specular"... used in the shader
  77301. */
  77302. static BindTextureMatrix(texture: BaseTexture, uniformBuffer: UniformBuffer, key: string): void;
  77303. /**
  77304. * Gets the current status of the fog (should it be enabled?)
  77305. * @param mesh defines the mesh to evaluate for fog support
  77306. * @param scene defines the hosting scene
  77307. * @returns true if fog must be enabled
  77308. */
  77309. static GetFogState(mesh: AbstractMesh, scene: Scene): boolean;
  77310. /**
  77311. * Helper used to prepare the list of defines associated with misc. values for shader compilation
  77312. * @param mesh defines the current mesh
  77313. * @param scene defines the current scene
  77314. * @param useLogarithmicDepth defines if logarithmic depth has to be turned on
  77315. * @param pointsCloud defines if point cloud rendering has to be turned on
  77316. * @param fogEnabled defines if fog has to be turned on
  77317. * @param alphaTest defines if alpha testing has to be turned on
  77318. * @param defines defines the current list of defines
  77319. */
  77320. static PrepareDefinesForMisc(mesh: AbstractMesh, scene: Scene, useLogarithmicDepth: boolean, pointsCloud: boolean, fogEnabled: boolean, alphaTest: boolean, defines: any): void;
  77321. /**
  77322. * Helper used to prepare the list of defines associated with frame values for shader compilation
  77323. * @param scene defines the current scene
  77324. * @param engine defines the current engine
  77325. * @param defines specifies the list of active defines
  77326. * @param useInstances defines if instances have to be turned on
  77327. * @param useClipPlane defines if clip plane have to be turned on
  77328. */
  77329. static PrepareDefinesForFrameBoundValues(scene: Scene, engine: Engine, defines: any, useInstances: boolean, useClipPlane?: Nullable<boolean>): void;
  77330. /**
  77331. * Prepares the defines for bones
  77332. * @param mesh The mesh containing the geometry data we will draw
  77333. * @param defines The defines to update
  77334. */
  77335. static PrepareDefinesForBones(mesh: AbstractMesh, defines: any): void;
  77336. /**
  77337. * Prepares the defines for morph targets
  77338. * @param mesh The mesh containing the geometry data we will draw
  77339. * @param defines The defines to update
  77340. */
  77341. static PrepareDefinesForMorphTargets(mesh: AbstractMesh, defines: any): void;
  77342. /**
  77343. * Prepares the defines used in the shader depending on the attributes data available in the mesh
  77344. * @param mesh The mesh containing the geometry data we will draw
  77345. * @param defines The defines to update
  77346. * @param useVertexColor Precise whether vertex colors should be used or not (override mesh info)
  77347. * @param useBones Precise whether bones should be used or not (override mesh info)
  77348. * @param useMorphTargets Precise whether morph targets should be used or not (override mesh info)
  77349. * @param useVertexAlpha Precise whether vertex alpha should be used or not (override mesh info)
  77350. * @returns false if defines are considered not dirty and have not been checked
  77351. */
  77352. static PrepareDefinesForAttributes(mesh: AbstractMesh, defines: any, useVertexColor: boolean, useBones: boolean, useMorphTargets?: boolean, useVertexAlpha?: boolean): boolean;
  77353. /**
  77354. * Prepares the defines related to multiview
  77355. * @param scene The scene we are intending to draw
  77356. * @param defines The defines to update
  77357. */
  77358. static PrepareDefinesForMultiview(scene: Scene, defines: any): void;
  77359. /**
  77360. * Prepares the defines related to the light information passed in parameter
  77361. * @param scene The scene we are intending to draw
  77362. * @param mesh The mesh the effect is compiling for
  77363. * @param light The light the effect is compiling for
  77364. * @param lightIndex The index of the light
  77365. * @param defines The defines to update
  77366. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  77367. * @param state Defines the current state regarding what is needed (normals, etc...)
  77368. */
  77369. static PrepareDefinesForLight(scene: Scene, mesh: AbstractMesh, light: Light, lightIndex: number, defines: any, specularSupported: boolean, state: {
  77370. needNormals: boolean;
  77371. needRebuild: boolean;
  77372. shadowEnabled: boolean;
  77373. specularEnabled: boolean;
  77374. lightmapMode: boolean;
  77375. }): void;
  77376. /**
  77377. * Prepares the defines related to the light information passed in parameter
  77378. * @param scene The scene we are intending to draw
  77379. * @param mesh The mesh the effect is compiling for
  77380. * @param defines The defines to update
  77381. * @param specularSupported Specifies whether specular is supported or not (override lights data)
  77382. * @param maxSimultaneousLights Specfies how manuy lights can be added to the effect at max
  77383. * @param disableLighting Specifies whether the lighting is disabled (override scene and light)
  77384. * @returns true if normals will be required for the rest of the effect
  77385. */
  77386. static PrepareDefinesForLights(scene: Scene, mesh: AbstractMesh, defines: any, specularSupported: boolean, maxSimultaneousLights?: number, disableLighting?: boolean): boolean;
  77387. /**
  77388. * Prepares the uniforms and samplers list to be used in the effect (for a specific light)
  77389. * @param lightIndex defines the light index
  77390. * @param uniformsList The uniform list
  77391. * @param samplersList The sampler list
  77392. * @param projectedLightTexture defines if projected texture must be used
  77393. * @param uniformBuffersList defines an optional list of uniform buffers
  77394. */
  77395. static PrepareUniformsAndSamplersForLight(lightIndex: number, uniformsList: string[], samplersList: string[], projectedLightTexture?: any, uniformBuffersList?: Nullable<string[]>): void;
  77396. /**
  77397. * Prepares the uniforms and samplers list to be used in the effect
  77398. * @param uniformsListOrOptions The uniform names to prepare or an EffectCreationOptions containing the liist and extra information
  77399. * @param samplersList The sampler list
  77400. * @param defines The defines helping in the list generation
  77401. * @param maxSimultaneousLights The maximum number of simultanous light allowed in the effect
  77402. */
  77403. static PrepareUniformsAndSamplersList(uniformsListOrOptions: string[] | IEffectCreationOptions, samplersList?: string[], defines?: any, maxSimultaneousLights?: number): void;
  77404. /**
  77405. * This helps decreasing rank by rank the shadow quality (0 being the highest rank and quality)
  77406. * @param defines The defines to update while falling back
  77407. * @param fallbacks The authorized effect fallbacks
  77408. * @param maxSimultaneousLights The maximum number of lights allowed
  77409. * @param rank the current rank of the Effect
  77410. * @returns The newly affected rank
  77411. */
  77412. static HandleFallbacksForShadows(defines: any, fallbacks: EffectFallbacks, maxSimultaneousLights?: number, rank?: number): number;
  77413. private static _TmpMorphInfluencers;
  77414. /**
  77415. * Prepares the list of attributes required for morph targets according to the effect defines.
  77416. * @param attribs The current list of supported attribs
  77417. * @param mesh The mesh to prepare the morph targets attributes for
  77418. * @param influencers The number of influencers
  77419. */
  77420. static PrepareAttributesForMorphTargetsInfluencers(attribs: string[], mesh: AbstractMesh, influencers: number): void;
  77421. /**
  77422. * Prepares the list of attributes required for morph targets according to the effect defines.
  77423. * @param attribs The current list of supported attribs
  77424. * @param mesh The mesh to prepare the morph targets attributes for
  77425. * @param defines The current Defines of the effect
  77426. */
  77427. static PrepareAttributesForMorphTargets(attribs: string[], mesh: AbstractMesh, defines: any): void;
  77428. /**
  77429. * Prepares the list of attributes required for bones according to the effect defines.
  77430. * @param attribs The current list of supported attribs
  77431. * @param mesh The mesh to prepare the bones attributes for
  77432. * @param defines The current Defines of the effect
  77433. * @param fallbacks The current efffect fallback strategy
  77434. */
  77435. static PrepareAttributesForBones(attribs: string[], mesh: AbstractMesh, defines: any, fallbacks: EffectFallbacks): void;
  77436. /**
  77437. * Check and prepare the list of attributes required for instances according to the effect defines.
  77438. * @param attribs The current list of supported attribs
  77439. * @param defines The current MaterialDefines of the effect
  77440. */
  77441. static PrepareAttributesForInstances(attribs: string[], defines: MaterialDefines): void;
  77442. /**
  77443. * Add the list of attributes required for instances to the attribs array.
  77444. * @param attribs The current list of supported attribs
  77445. */
  77446. static PushAttributesForInstances(attribs: string[]): void;
  77447. /**
  77448. * Binds the light information to the effect.
  77449. * @param light The light containing the generator
  77450. * @param effect The effect we are binding the data to
  77451. * @param lightIndex The light index in the effect used to render
  77452. */
  77453. static BindLightProperties(light: Light, effect: Effect, lightIndex: number): void;
  77454. /**
  77455. * Binds the lights information from the scene to the effect for the given mesh.
  77456. * @param light Light to bind
  77457. * @param lightIndex Light index
  77458. * @param scene The scene where the light belongs to
  77459. * @param effect The effect we are binding the data to
  77460. * @param useSpecular Defines if specular is supported
  77461. * @param usePhysicalLightFalloff Specifies whether the light falloff is defined physically or not
  77462. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  77463. */
  77464. static BindLight(light: Light, lightIndex: number, scene: Scene, effect: Effect, useSpecular: boolean, usePhysicalLightFalloff?: boolean, rebuildInParallel?: boolean): void;
  77465. /**
  77466. * Binds the lights information from the scene to the effect for the given mesh.
  77467. * @param scene The scene the lights belongs to
  77468. * @param mesh The mesh we are binding the information to render
  77469. * @param effect The effect we are binding the data to
  77470. * @param defines The generated defines for the effect
  77471. * @param maxSimultaneousLights The maximum number of light that can be bound to the effect
  77472. * @param usePhysicalLightFalloff Specifies whether the light falloff is defined physically or not
  77473. * @param rebuildInParallel Specifies whether the shader is rebuilding in parallel
  77474. */
  77475. static BindLights(scene: Scene, mesh: AbstractMesh, effect: Effect, defines: any, maxSimultaneousLights?: number, usePhysicalLightFalloff?: boolean, rebuildInParallel?: boolean): void;
  77476. private static _tempFogColor;
  77477. /**
  77478. * Binds the fog information from the scene to the effect for the given mesh.
  77479. * @param scene The scene the lights belongs to
  77480. * @param mesh The mesh we are binding the information to render
  77481. * @param effect The effect we are binding the data to
  77482. * @param linearSpace Defines if the fog effect is applied in linear space
  77483. */
  77484. static BindFogParameters(scene: Scene, mesh: AbstractMesh, effect: Effect, linearSpace?: boolean): void;
  77485. /**
  77486. * Binds the bones information from the mesh to the effect.
  77487. * @param mesh The mesh we are binding the information to render
  77488. * @param effect The effect we are binding the data to
  77489. */
  77490. static BindBonesParameters(mesh?: AbstractMesh, effect?: Effect): void;
  77491. /**
  77492. * Binds the morph targets information from the mesh to the effect.
  77493. * @param abstractMesh The mesh we are binding the information to render
  77494. * @param effect The effect we are binding the data to
  77495. */
  77496. static BindMorphTargetParameters(abstractMesh: AbstractMesh, effect: Effect): void;
  77497. /**
  77498. * Binds the logarithmic depth information from the scene to the effect for the given defines.
  77499. * @param defines The generated defines used in the effect
  77500. * @param effect The effect we are binding the data to
  77501. * @param scene The scene we are willing to render with logarithmic scale for
  77502. */
  77503. static BindLogDepth(defines: any, effect: Effect, scene: Scene): void;
  77504. /**
  77505. * Binds the clip plane information from the scene to the effect.
  77506. * @param scene The scene the clip plane information are extracted from
  77507. * @param effect The effect we are binding the data to
  77508. */
  77509. static BindClipPlane(effect: Effect, scene: Scene): void;
  77510. }
  77511. }
  77512. declare module BABYLON {
  77513. /** @hidden */
  77514. export var packingFunctions: {
  77515. name: string;
  77516. shader: string;
  77517. };
  77518. }
  77519. declare module BABYLON {
  77520. /** @hidden */
  77521. export var shadowMapPixelShader: {
  77522. name: string;
  77523. shader: string;
  77524. };
  77525. }
  77526. declare module BABYLON {
  77527. /** @hidden */
  77528. export var bonesDeclaration: {
  77529. name: string;
  77530. shader: string;
  77531. };
  77532. }
  77533. declare module BABYLON {
  77534. /** @hidden */
  77535. export var morphTargetsVertexGlobalDeclaration: {
  77536. name: string;
  77537. shader: string;
  77538. };
  77539. }
  77540. declare module BABYLON {
  77541. /** @hidden */
  77542. export var morphTargetsVertexDeclaration: {
  77543. name: string;
  77544. shader: string;
  77545. };
  77546. }
  77547. declare module BABYLON {
  77548. /** @hidden */
  77549. export var instancesDeclaration: {
  77550. name: string;
  77551. shader: string;
  77552. };
  77553. }
  77554. declare module BABYLON {
  77555. /** @hidden */
  77556. export var helperFunctions: {
  77557. name: string;
  77558. shader: string;
  77559. };
  77560. }
  77561. declare module BABYLON {
  77562. /** @hidden */
  77563. export var morphTargetsVertex: {
  77564. name: string;
  77565. shader: string;
  77566. };
  77567. }
  77568. declare module BABYLON {
  77569. /** @hidden */
  77570. export var instancesVertex: {
  77571. name: string;
  77572. shader: string;
  77573. };
  77574. }
  77575. declare module BABYLON {
  77576. /** @hidden */
  77577. export var bonesVertex: {
  77578. name: string;
  77579. shader: string;
  77580. };
  77581. }
  77582. declare module BABYLON {
  77583. /** @hidden */
  77584. export var shadowMapVertexShader: {
  77585. name: string;
  77586. shader: string;
  77587. };
  77588. }
  77589. declare module BABYLON {
  77590. /** @hidden */
  77591. export var depthBoxBlurPixelShader: {
  77592. name: string;
  77593. shader: string;
  77594. };
  77595. }
  77596. declare module BABYLON {
  77597. /**
  77598. * Defines the options associated with the creation of a custom shader for a shadow generator.
  77599. */
  77600. export interface ICustomShaderOptions {
  77601. /**
  77602. * Gets or sets the custom shader name to use
  77603. */
  77604. shaderName: string;
  77605. /**
  77606. * The list of attribute names used in the shader
  77607. */
  77608. attributes?: string[];
  77609. /**
  77610. * The list of unifrom names used in the shader
  77611. */
  77612. uniforms?: string[];
  77613. /**
  77614. * The list of sampler names used in the shader
  77615. */
  77616. samplers?: string[];
  77617. /**
  77618. * The list of defines used in the shader
  77619. */
  77620. defines?: string[];
  77621. }
  77622. /**
  77623. * Interface to implement to create a shadow generator compatible with BJS.
  77624. */
  77625. export interface IShadowGenerator {
  77626. /**
  77627. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  77628. * @returns The render target texture if present otherwise, null
  77629. */
  77630. getShadowMap(): Nullable<RenderTargetTexture>;
  77631. /**
  77632. * Gets the RTT used during rendering (can be a blurred version of the shadow map or the shadow map itself).
  77633. * @returns The render target texture if the shadow map is present otherwise, null
  77634. */
  77635. getShadowMapForRendering(): Nullable<RenderTargetTexture>;
  77636. /**
  77637. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  77638. * @param subMesh The submesh we want to render in the shadow map
  77639. * @param useInstances Defines wether will draw in the map using instances
  77640. * @returns true if ready otherwise, false
  77641. */
  77642. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  77643. /**
  77644. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  77645. * @param defines Defines of the material we want to update
  77646. * @param lightIndex Index of the light in the enabled light list of the material
  77647. */
  77648. prepareDefines(defines: MaterialDefines, lightIndex: number): void;
  77649. /**
  77650. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  77651. * defined in the generator but impacting the effect).
  77652. * It implies the unifroms available on the materials are the standard BJS ones.
  77653. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  77654. * @param effect The effect we are binfing the information for
  77655. */
  77656. bindShadowLight(lightIndex: string, effect: Effect): void;
  77657. /**
  77658. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  77659. * (eq to shadow prjection matrix * light transform matrix)
  77660. * @returns The transform matrix used to create the shadow map
  77661. */
  77662. getTransformMatrix(): Matrix;
  77663. /**
  77664. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  77665. * Cube and 2D textures for instance.
  77666. */
  77667. recreateShadowMap(): void;
  77668. /**
  77669. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  77670. * @param onCompiled Callback triggered at the and of the effects compilation
  77671. * @param options Sets of optional options forcing the compilation with different modes
  77672. */
  77673. forceCompilation(onCompiled?: (generator: ShadowGenerator) => void, options?: Partial<{
  77674. useInstances: boolean;
  77675. }>): void;
  77676. /**
  77677. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  77678. * @param options Sets of optional options forcing the compilation with different modes
  77679. * @returns A promise that resolves when the compilation completes
  77680. */
  77681. forceCompilationAsync(options?: Partial<{
  77682. useInstances: boolean;
  77683. }>): Promise<void>;
  77684. /**
  77685. * Serializes the shadow generator setup to a json object.
  77686. * @returns The serialized JSON object
  77687. */
  77688. serialize(): any;
  77689. /**
  77690. * Disposes the Shadow map and related Textures and effects.
  77691. */
  77692. dispose(): void;
  77693. }
  77694. /**
  77695. * Default implementation IShadowGenerator.
  77696. * This is the main object responsible of generating shadows in the framework.
  77697. * Documentation: https://doc.babylonjs.com/babylon101/shadows
  77698. */
  77699. export class ShadowGenerator implements IShadowGenerator {
  77700. /**
  77701. * Shadow generator mode None: no filtering applied.
  77702. */
  77703. static readonly FILTER_NONE: number;
  77704. /**
  77705. * Shadow generator mode ESM: Exponential Shadow Mapping.
  77706. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  77707. */
  77708. static readonly FILTER_EXPONENTIALSHADOWMAP: number;
  77709. /**
  77710. * Shadow generator mode Poisson Sampling: Percentage Closer Filtering.
  77711. * (Multiple Tap around evenly distributed around the pixel are used to evaluate the shadow strength)
  77712. */
  77713. static readonly FILTER_POISSONSAMPLING: number;
  77714. /**
  77715. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping.
  77716. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  77717. */
  77718. static readonly FILTER_BLUREXPONENTIALSHADOWMAP: number;
  77719. /**
  77720. * Shadow generator mode ESM: Exponential Shadow Mapping using the inverse of the exponential preventing
  77721. * edge artifacts on steep falloff.
  77722. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  77723. */
  77724. static readonly FILTER_CLOSEEXPONENTIALSHADOWMAP: number;
  77725. /**
  77726. * Shadow generator mode ESM: Blurred Exponential Shadow Mapping using the inverse of the exponential preventing
  77727. * edge artifacts on steep falloff.
  77728. * (http://developer.download.nvidia.com/presentations/2008/GDC/GDC08_SoftShadowMapping.pdf)
  77729. */
  77730. static readonly FILTER_BLURCLOSEEXPONENTIALSHADOWMAP: number;
  77731. /**
  77732. * Shadow generator mode PCF: Percentage Closer Filtering
  77733. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  77734. * (https://developer.nvidia.com/gpugems/GPUGems/gpugems_ch11.html)
  77735. */
  77736. static readonly FILTER_PCF: number;
  77737. /**
  77738. * Shadow generator mode PCSS: Percentage Closering Soft Shadow.
  77739. * benefits from Webgl 2 shadow samplers. Fallback to Poisson Sampling in Webgl 1
  77740. * Contact Hardening
  77741. */
  77742. static readonly FILTER_PCSS: number;
  77743. /**
  77744. * Reserved for PCF and PCSS
  77745. * Highest Quality.
  77746. *
  77747. * Execute PCF on a 5*5 kernel improving a lot the shadow aliasing artifacts.
  77748. *
  77749. * Execute PCSS with 32 taps blocker search and 64 taps PCF.
  77750. */
  77751. static readonly QUALITY_HIGH: number;
  77752. /**
  77753. * Reserved for PCF and PCSS
  77754. * Good tradeoff for quality/perf cross devices
  77755. *
  77756. * Execute PCF on a 3*3 kernel.
  77757. *
  77758. * Execute PCSS with 16 taps blocker search and 32 taps PCF.
  77759. */
  77760. static readonly QUALITY_MEDIUM: number;
  77761. /**
  77762. * Reserved for PCF and PCSS
  77763. * The lowest quality but the fastest.
  77764. *
  77765. * Execute PCF on a 1*1 kernel.
  77766. *
  77767. * Execute PCSS with 16 taps blocker search and 16 taps PCF.
  77768. */
  77769. static readonly QUALITY_LOW: number;
  77770. /** Gets or sets the custom shader name to use */
  77771. customShaderOptions: ICustomShaderOptions;
  77772. /**
  77773. * Observable triggered before the shadow is rendered. Can be used to update internal effect state
  77774. */
  77775. onBeforeShadowMapRenderObservable: Observable<Effect>;
  77776. /**
  77777. * Observable triggered after the shadow is rendered. Can be used to restore internal effect state
  77778. */
  77779. onAfterShadowMapRenderObservable: Observable<Effect>;
  77780. /**
  77781. * Observable triggered before a mesh is rendered in the shadow map.
  77782. * Can be used to update internal effect state (that you can get from the onBeforeShadowMapRenderObservable)
  77783. */
  77784. onBeforeShadowMapRenderMeshObservable: Observable<Mesh>;
  77785. /**
  77786. * Observable triggered after a mesh is rendered in the shadow map.
  77787. * Can be used to update internal effect state (that you can get from the onAfterShadowMapRenderObservable)
  77788. */
  77789. onAfterShadowMapRenderMeshObservable: Observable<Mesh>;
  77790. private _bias;
  77791. /**
  77792. * Gets the bias: offset applied on the depth preventing acnea (in light direction).
  77793. */
  77794. /**
  77795. * Sets the bias: offset applied on the depth preventing acnea (in light direction).
  77796. */
  77797. bias: number;
  77798. private _normalBias;
  77799. /**
  77800. * Gets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  77801. */
  77802. /**
  77803. * Sets the normalBias: offset applied on the depth preventing acnea (along side the normal direction and proportinal to the light/normal angle).
  77804. */
  77805. normalBias: number;
  77806. private _blurBoxOffset;
  77807. /**
  77808. * Gets the blur box offset: offset applied during the blur pass.
  77809. * Only useful if useKernelBlur = false
  77810. */
  77811. /**
  77812. * Sets the blur box offset: offset applied during the blur pass.
  77813. * Only useful if useKernelBlur = false
  77814. */
  77815. blurBoxOffset: number;
  77816. private _blurScale;
  77817. /**
  77818. * Gets the blur scale: scale of the blurred texture compared to the main shadow map.
  77819. * 2 means half of the size.
  77820. */
  77821. /**
  77822. * Sets the blur scale: scale of the blurred texture compared to the main shadow map.
  77823. * 2 means half of the size.
  77824. */
  77825. blurScale: number;
  77826. private _blurKernel;
  77827. /**
  77828. * Gets the blur kernel: kernel size of the blur pass.
  77829. * Only useful if useKernelBlur = true
  77830. */
  77831. /**
  77832. * Sets the blur kernel: kernel size of the blur pass.
  77833. * Only useful if useKernelBlur = true
  77834. */
  77835. blurKernel: number;
  77836. private _useKernelBlur;
  77837. /**
  77838. * Gets whether the blur pass is a kernel blur (if true) or box blur.
  77839. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  77840. */
  77841. /**
  77842. * Sets whether the blur pass is a kernel blur (if true) or box blur.
  77843. * Only useful in filtered mode (useBlurExponentialShadowMap...)
  77844. */
  77845. useKernelBlur: boolean;
  77846. private _depthScale;
  77847. /**
  77848. * Gets the depth scale used in ESM mode.
  77849. */
  77850. /**
  77851. * Sets the depth scale used in ESM mode.
  77852. * This can override the scale stored on the light.
  77853. */
  77854. depthScale: number;
  77855. private _filter;
  77856. /**
  77857. * Gets the current mode of the shadow generator (normal, PCF, ESM...).
  77858. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  77859. */
  77860. /**
  77861. * Sets the current mode of the shadow generator (normal, PCF, ESM...).
  77862. * The returned value is a number equal to one of the available mode defined in ShadowMap.FILTER_x like _FILTER_NONE
  77863. */
  77864. filter: number;
  77865. /**
  77866. * Gets if the current filter is set to Poisson Sampling.
  77867. */
  77868. /**
  77869. * Sets the current filter to Poisson Sampling.
  77870. */
  77871. usePoissonSampling: boolean;
  77872. /**
  77873. * Gets if the current filter is set to ESM.
  77874. */
  77875. /**
  77876. * Sets the current filter is to ESM.
  77877. */
  77878. useExponentialShadowMap: boolean;
  77879. /**
  77880. * Gets if the current filter is set to filtered ESM.
  77881. */
  77882. /**
  77883. * Gets if the current filter is set to filtered ESM.
  77884. */
  77885. useBlurExponentialShadowMap: boolean;
  77886. /**
  77887. * Gets if the current filter is set to "close ESM" (using the inverse of the
  77888. * exponential to prevent steep falloff artifacts).
  77889. */
  77890. /**
  77891. * Sets the current filter to "close ESM" (using the inverse of the
  77892. * exponential to prevent steep falloff artifacts).
  77893. */
  77894. useCloseExponentialShadowMap: boolean;
  77895. /**
  77896. * Gets if the current filter is set to filtered "close ESM" (using the inverse of the
  77897. * exponential to prevent steep falloff artifacts).
  77898. */
  77899. /**
  77900. * Sets the current filter to filtered "close ESM" (using the inverse of the
  77901. * exponential to prevent steep falloff artifacts).
  77902. */
  77903. useBlurCloseExponentialShadowMap: boolean;
  77904. /**
  77905. * Gets if the current filter is set to "PCF" (percentage closer filtering).
  77906. */
  77907. /**
  77908. * Sets the current filter to "PCF" (percentage closer filtering).
  77909. */
  77910. usePercentageCloserFiltering: boolean;
  77911. private _filteringQuality;
  77912. /**
  77913. * Gets the PCF or PCSS Quality.
  77914. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  77915. */
  77916. /**
  77917. * Sets the PCF or PCSS Quality.
  77918. * Only valid if usePercentageCloserFiltering or usePercentageCloserFiltering is true.
  77919. */
  77920. filteringQuality: number;
  77921. /**
  77922. * Gets if the current filter is set to "PCSS" (contact hardening).
  77923. */
  77924. /**
  77925. * Sets the current filter to "PCSS" (contact hardening).
  77926. */
  77927. useContactHardeningShadow: boolean;
  77928. private _contactHardeningLightSizeUVRatio;
  77929. /**
  77930. * Gets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  77931. * Using a ratio helps keeping shape stability independently of the map size.
  77932. *
  77933. * It does not account for the light projection as it was having too much
  77934. * instability during the light setup or during light position changes.
  77935. *
  77936. * Only valid if useContactHardeningShadow is true.
  77937. */
  77938. /**
  77939. * Sets the Light Size (in shadow map uv unit) used in PCSS to determine the blocker search area and the penumbra size.
  77940. * Using a ratio helps keeping shape stability independently of the map size.
  77941. *
  77942. * It does not account for the light projection as it was having too much
  77943. * instability during the light setup or during light position changes.
  77944. *
  77945. * Only valid if useContactHardeningShadow is true.
  77946. */
  77947. contactHardeningLightSizeUVRatio: number;
  77948. private _darkness;
  77949. /** Gets or sets the actual darkness of a shadow */
  77950. darkness: number;
  77951. /**
  77952. * Returns the darkness value (float). This can only decrease the actual darkness of a shadow.
  77953. * 0 means strongest and 1 would means no shadow.
  77954. * @returns the darkness.
  77955. */
  77956. getDarkness(): number;
  77957. /**
  77958. * Sets the darkness value (float). This can only decrease the actual darkness of a shadow.
  77959. * @param darkness The darkness value 0 means strongest and 1 would means no shadow.
  77960. * @returns the shadow generator allowing fluent coding.
  77961. */
  77962. setDarkness(darkness: number): ShadowGenerator;
  77963. private _transparencyShadow;
  77964. /** Gets or sets the ability to have transparent shadow */
  77965. transparencyShadow: boolean;
  77966. /**
  77967. * Sets the ability to have transparent shadow (boolean).
  77968. * @param transparent True if transparent else False
  77969. * @returns the shadow generator allowing fluent coding
  77970. */
  77971. setTransparencyShadow(transparent: boolean): ShadowGenerator;
  77972. private _shadowMap;
  77973. private _shadowMap2;
  77974. /**
  77975. * Gets the main RTT containing the shadow map (usually storing depth from the light point of view).
  77976. * @returns The render target texture if present otherwise, null
  77977. */
  77978. getShadowMap(): Nullable<RenderTargetTexture>;
  77979. /**
  77980. * Gets the RTT used during rendering (can be a blurred version of the shadow map or the shadow map itself).
  77981. * @returns The render target texture if the shadow map is present otherwise, null
  77982. */
  77983. getShadowMapForRendering(): Nullable<RenderTargetTexture>;
  77984. /**
  77985. * Gets the class name of that object
  77986. * @returns "ShadowGenerator"
  77987. */
  77988. getClassName(): string;
  77989. /**
  77990. * Helper function to add a mesh and its descendants to the list of shadow casters.
  77991. * @param mesh Mesh to add
  77992. * @param includeDescendants boolean indicating if the descendants should be added. Default to true
  77993. * @returns the Shadow Generator itself
  77994. */
  77995. addShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  77996. /**
  77997. * Helper function to remove a mesh and its descendants from the list of shadow casters
  77998. * @param mesh Mesh to remove
  77999. * @param includeDescendants boolean indicating if the descendants should be removed. Default to true
  78000. * @returns the Shadow Generator itself
  78001. */
  78002. removeShadowCaster(mesh: AbstractMesh, includeDescendants?: boolean): ShadowGenerator;
  78003. /**
  78004. * Controls the extent to which the shadows fade out at the edge of the frustum
  78005. * Used only by directionals and spots
  78006. */
  78007. frustumEdgeFalloff: number;
  78008. private _light;
  78009. /**
  78010. * Returns the associated light object.
  78011. * @returns the light generating the shadow
  78012. */
  78013. getLight(): IShadowLight;
  78014. /**
  78015. * If true the shadow map is generated by rendering the back face of the mesh instead of the front face.
  78016. * This can help with self-shadowing as the geometry making up the back of objects is slightly offset.
  78017. * It might on the other hand introduce peter panning.
  78018. */
  78019. forceBackFacesOnly: boolean;
  78020. private _scene;
  78021. private _lightDirection;
  78022. private _effect;
  78023. private _viewMatrix;
  78024. private _projectionMatrix;
  78025. private _transformMatrix;
  78026. private _cachedPosition;
  78027. private _cachedDirection;
  78028. private _cachedDefines;
  78029. private _currentRenderID;
  78030. private _boxBlurPostprocess;
  78031. private _kernelBlurXPostprocess;
  78032. private _kernelBlurYPostprocess;
  78033. private _blurPostProcesses;
  78034. private _mapSize;
  78035. private _currentFaceIndex;
  78036. private _currentFaceIndexCache;
  78037. private _textureType;
  78038. private _defaultTextureMatrix;
  78039. private _storedUniqueId;
  78040. /** @hidden */
  78041. static _SceneComponentInitialization: (scene: Scene) => void;
  78042. /**
  78043. * Creates a ShadowGenerator object.
  78044. * A ShadowGenerator is the required tool to use the shadows.
  78045. * Each light casting shadows needs to use its own ShadowGenerator.
  78046. * Documentation : https://doc.babylonjs.com/babylon101/shadows
  78047. * @param mapSize The size of the texture what stores the shadows. Example : 1024.
  78048. * @param light The light object generating the shadows.
  78049. * @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.
  78050. */
  78051. constructor(mapSize: number, light: IShadowLight, usefulFloatFirst?: boolean);
  78052. private _initializeGenerator;
  78053. private _initializeShadowMap;
  78054. private _initializeBlurRTTAndPostProcesses;
  78055. private _renderForShadowMap;
  78056. private _renderSubMeshForShadowMap;
  78057. private _applyFilterValues;
  78058. /**
  78059. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  78060. * @param onCompiled Callback triggered at the and of the effects compilation
  78061. * @param options Sets of optional options forcing the compilation with different modes
  78062. */
  78063. forceCompilation(onCompiled?: (generator: ShadowGenerator) => void, options?: Partial<{
  78064. useInstances: boolean;
  78065. }>): void;
  78066. /**
  78067. * Forces all the attached effect to compile to enable rendering only once ready vs. lazyly compiling effects.
  78068. * @param options Sets of optional options forcing the compilation with different modes
  78069. * @returns A promise that resolves when the compilation completes
  78070. */
  78071. forceCompilationAsync(options?: Partial<{
  78072. useInstances: boolean;
  78073. }>): Promise<void>;
  78074. /**
  78075. * Determine wheter the shadow generator is ready or not (mainly all effects and related post processes needs to be ready).
  78076. * @param subMesh The submesh we want to render in the shadow map
  78077. * @param useInstances Defines wether will draw in the map using instances
  78078. * @returns true if ready otherwise, false
  78079. */
  78080. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  78081. /**
  78082. * Prepare all the defines in a material relying on a shadow map at the specified light index.
  78083. * @param defines Defines of the material we want to update
  78084. * @param lightIndex Index of the light in the enabled light list of the material
  78085. */
  78086. prepareDefines(defines: any, lightIndex: number): void;
  78087. /**
  78088. * Binds the shadow related information inside of an effect (information like near, far, darkness...
  78089. * defined in the generator but impacting the effect).
  78090. * @param lightIndex Index of the light in the enabled light list of the material owning the effect
  78091. * @param effect The effect we are binfing the information for
  78092. */
  78093. bindShadowLight(lightIndex: string, effect: Effect): void;
  78094. /**
  78095. * Gets the transformation matrix used to project the meshes into the map from the light point of view.
  78096. * (eq to shadow prjection matrix * light transform matrix)
  78097. * @returns The transform matrix used to create the shadow map
  78098. */
  78099. getTransformMatrix(): Matrix;
  78100. /**
  78101. * Recreates the shadow map dependencies like RTT and post processes. This can be used during the switch between
  78102. * Cube and 2D textures for instance.
  78103. */
  78104. recreateShadowMap(): void;
  78105. private _disposeBlurPostProcesses;
  78106. private _disposeRTTandPostProcesses;
  78107. /**
  78108. * Disposes the ShadowGenerator.
  78109. * Returns nothing.
  78110. */
  78111. dispose(): void;
  78112. /**
  78113. * Serializes the shadow generator setup to a json object.
  78114. * @returns The serialized JSON object
  78115. */
  78116. serialize(): any;
  78117. /**
  78118. * Parses a serialized ShadowGenerator and returns a new ShadowGenerator.
  78119. * @param parsedShadowGenerator The JSON object to parse
  78120. * @param scene The scene to create the shadow map for
  78121. * @returns The parsed shadow generator
  78122. */
  78123. static Parse(parsedShadowGenerator: any, scene: Scene): ShadowGenerator;
  78124. }
  78125. }
  78126. declare module BABYLON {
  78127. /**
  78128. * Base class of all the lights in Babylon. It groups all the generic information about lights.
  78129. * Lights are used, as you would expect, to affect how meshes are seen, in terms of both illumination and colour.
  78130. * 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.
  78131. */
  78132. export abstract class Light extends Node {
  78133. /**
  78134. * Falloff Default: light is falling off following the material specification:
  78135. * standard material is using standard falloff whereas pbr material can request special falloff per materials.
  78136. */
  78137. static readonly FALLOFF_DEFAULT: number;
  78138. /**
  78139. * Falloff Physical: light is falling off following the inverse squared distance law.
  78140. */
  78141. static readonly FALLOFF_PHYSICAL: number;
  78142. /**
  78143. * Falloff gltf: light is falling off as described in the gltf moving to PBR document
  78144. * to enhance interoperability with other engines.
  78145. */
  78146. static readonly FALLOFF_GLTF: number;
  78147. /**
  78148. * Falloff Standard: light is falling off like in the standard material
  78149. * to enhance interoperability with other materials.
  78150. */
  78151. static readonly FALLOFF_STANDARD: number;
  78152. /**
  78153. * If every light affecting the material is in this lightmapMode,
  78154. * material.lightmapTexture adds or multiplies
  78155. * (depends on material.useLightmapAsShadowmap)
  78156. * after every other light calculations.
  78157. */
  78158. static readonly LIGHTMAP_DEFAULT: number;
  78159. /**
  78160. * material.lightmapTexture as only diffuse lighting from this light
  78161. * adds only specular lighting from this light
  78162. * adds dynamic shadows
  78163. */
  78164. static readonly LIGHTMAP_SPECULAR: number;
  78165. /**
  78166. * material.lightmapTexture as only lighting
  78167. * no light calculation from this light
  78168. * only adds dynamic shadows from this light
  78169. */
  78170. static readonly LIGHTMAP_SHADOWSONLY: number;
  78171. /**
  78172. * Each light type uses the default quantity according to its type:
  78173. * point/spot lights use luminous intensity
  78174. * directional lights use illuminance
  78175. */
  78176. static readonly INTENSITYMODE_AUTOMATIC: number;
  78177. /**
  78178. * lumen (lm)
  78179. */
  78180. static readonly INTENSITYMODE_LUMINOUSPOWER: number;
  78181. /**
  78182. * candela (lm/sr)
  78183. */
  78184. static readonly INTENSITYMODE_LUMINOUSINTENSITY: number;
  78185. /**
  78186. * lux (lm/m^2)
  78187. */
  78188. static readonly INTENSITYMODE_ILLUMINANCE: number;
  78189. /**
  78190. * nit (cd/m^2)
  78191. */
  78192. static readonly INTENSITYMODE_LUMINANCE: number;
  78193. /**
  78194. * Light type const id of the point light.
  78195. */
  78196. static readonly LIGHTTYPEID_POINTLIGHT: number;
  78197. /**
  78198. * Light type const id of the directional light.
  78199. */
  78200. static readonly LIGHTTYPEID_DIRECTIONALLIGHT: number;
  78201. /**
  78202. * Light type const id of the spot light.
  78203. */
  78204. static readonly LIGHTTYPEID_SPOTLIGHT: number;
  78205. /**
  78206. * Light type const id of the hemispheric light.
  78207. */
  78208. static readonly LIGHTTYPEID_HEMISPHERICLIGHT: number;
  78209. /**
  78210. * Diffuse gives the basic color to an object.
  78211. */
  78212. diffuse: Color3;
  78213. /**
  78214. * Specular produces a highlight color on an object.
  78215. * Note: This is note affecting PBR materials.
  78216. */
  78217. specular: Color3;
  78218. /**
  78219. * Defines the falloff type for this light. This lets overrriding how punctual light are
  78220. * falling off base on range or angle.
  78221. * This can be set to any values in Light.FALLOFF_x.
  78222. *
  78223. * Note: This is only useful for PBR Materials at the moment. This could be extended if required to
  78224. * other types of materials.
  78225. */
  78226. falloffType: number;
  78227. /**
  78228. * Strength of the light.
  78229. * Note: By default it is define in the framework own unit.
  78230. * Note: In PBR materials the intensityMode can be use to chose what unit the intensity is defined in.
  78231. */
  78232. intensity: number;
  78233. private _range;
  78234. protected _inverseSquaredRange: number;
  78235. /**
  78236. * Defines how far from the source the light is impacting in scene units.
  78237. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  78238. */
  78239. /**
  78240. * Defines how far from the source the light is impacting in scene units.
  78241. * Note: Unused in PBR material as the distance light falloff is defined following the inverse squared falloff.
  78242. */
  78243. range: number;
  78244. /**
  78245. * Cached photometric scale default to 1.0 as the automatic intensity mode defaults to 1.0 for every type
  78246. * of light.
  78247. */
  78248. private _photometricScale;
  78249. private _intensityMode;
  78250. /**
  78251. * Gets the photometric scale used to interpret the intensity.
  78252. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  78253. */
  78254. /**
  78255. * Sets the photometric scale used to interpret the intensity.
  78256. * This is only relevant with PBR Materials where the light intensity can be defined in a physical way.
  78257. */
  78258. intensityMode: number;
  78259. private _radius;
  78260. /**
  78261. * Gets the light radius used by PBR Materials to simulate soft area lights.
  78262. */
  78263. /**
  78264. * sets the light radius used by PBR Materials to simulate soft area lights.
  78265. */
  78266. radius: number;
  78267. private _renderPriority;
  78268. /**
  78269. * Defines the rendering priority of the lights. It can help in case of fallback or number of lights
  78270. * exceeding the number allowed of the materials.
  78271. */
  78272. renderPriority: number;
  78273. private _shadowEnabled;
  78274. /**
  78275. * Gets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  78276. * the current shadow generator.
  78277. */
  78278. /**
  78279. * Sets wether or not the shadows are enabled for this light. This can help turning off/on shadow without detaching
  78280. * the current shadow generator.
  78281. */
  78282. shadowEnabled: boolean;
  78283. private _includedOnlyMeshes;
  78284. /**
  78285. * Gets the only meshes impacted by this light.
  78286. */
  78287. /**
  78288. * Sets the only meshes impacted by this light.
  78289. */
  78290. includedOnlyMeshes: AbstractMesh[];
  78291. private _excludedMeshes;
  78292. /**
  78293. * Gets the meshes not impacted by this light.
  78294. */
  78295. /**
  78296. * Sets the meshes not impacted by this light.
  78297. */
  78298. excludedMeshes: AbstractMesh[];
  78299. private _excludeWithLayerMask;
  78300. /**
  78301. * Gets the layer id use to find what meshes are not impacted by the light.
  78302. * Inactive if 0
  78303. */
  78304. /**
  78305. * Sets the layer id use to find what meshes are not impacted by the light.
  78306. * Inactive if 0
  78307. */
  78308. excludeWithLayerMask: number;
  78309. private _includeOnlyWithLayerMask;
  78310. /**
  78311. * Gets the layer id use to find what meshes are impacted by the light.
  78312. * Inactive if 0
  78313. */
  78314. /**
  78315. * Sets the layer id use to find what meshes are impacted by the light.
  78316. * Inactive if 0
  78317. */
  78318. includeOnlyWithLayerMask: number;
  78319. private _lightmapMode;
  78320. /**
  78321. * Gets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  78322. */
  78323. /**
  78324. * Sets the lightmap mode of this light (should be one of the constants defined by Light.LIGHTMAP_x)
  78325. */
  78326. lightmapMode: number;
  78327. /**
  78328. * Shadow generator associted to the light.
  78329. * @hidden Internal use only.
  78330. */
  78331. _shadowGenerator: Nullable<IShadowGenerator>;
  78332. /**
  78333. * @hidden Internal use only.
  78334. */
  78335. _excludedMeshesIds: string[];
  78336. /**
  78337. * @hidden Internal use only.
  78338. */
  78339. _includedOnlyMeshesIds: string[];
  78340. /**
  78341. * The current light unifom buffer.
  78342. * @hidden Internal use only.
  78343. */
  78344. _uniformBuffer: UniformBuffer;
  78345. /** @hidden */
  78346. _renderId: number;
  78347. /**
  78348. * Creates a Light object in the scene.
  78349. * Documentation : https://doc.babylonjs.com/babylon101/lights
  78350. * @param name The firendly name of the light
  78351. * @param scene The scene the light belongs too
  78352. */
  78353. constructor(name: string, scene: Scene);
  78354. protected abstract _buildUniformLayout(): void;
  78355. /**
  78356. * Sets the passed Effect "effect" with the Light information.
  78357. * @param effect The effect to update
  78358. * @param lightIndex The index of the light in the effect to update
  78359. * @returns The light
  78360. */
  78361. abstract transferToEffect(effect: Effect, lightIndex: string): Light;
  78362. /**
  78363. * Sets the passed Effect "effect" with the Light information.
  78364. * @param effect The effect to update
  78365. * @param lightDataUniformName The uniform used to store light data (position or direction)
  78366. * @returns The light
  78367. */
  78368. abstract transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  78369. /**
  78370. * Returns the string "Light".
  78371. * @returns the class name
  78372. */
  78373. getClassName(): string;
  78374. /** @hidden */
  78375. readonly _isLight: boolean;
  78376. /**
  78377. * Converts the light information to a readable string for debug purpose.
  78378. * @param fullDetails Supports for multiple levels of logging within scene loading
  78379. * @returns the human readable light info
  78380. */
  78381. toString(fullDetails?: boolean): string;
  78382. /** @hidden */
  78383. protected _syncParentEnabledState(): void;
  78384. /**
  78385. * Set the enabled state of this node.
  78386. * @param value - the new enabled state
  78387. */
  78388. setEnabled(value: boolean): void;
  78389. /**
  78390. * Returns the Light associated shadow generator if any.
  78391. * @return the associated shadow generator.
  78392. */
  78393. getShadowGenerator(): Nullable<IShadowGenerator>;
  78394. /**
  78395. * Returns a Vector3, the absolute light position in the World.
  78396. * @returns the world space position of the light
  78397. */
  78398. getAbsolutePosition(): Vector3;
  78399. /**
  78400. * Specifies if the light will affect the passed mesh.
  78401. * @param mesh The mesh to test against the light
  78402. * @return true the mesh is affected otherwise, false.
  78403. */
  78404. canAffectMesh(mesh: AbstractMesh): boolean;
  78405. /**
  78406. * Sort function to order lights for rendering.
  78407. * @param a First Light object to compare to second.
  78408. * @param b Second Light object to compare first.
  78409. * @return -1 to reduce's a's index relative to be, 0 for no change, 1 to increase a's index relative to b.
  78410. */
  78411. static CompareLightsPriority(a: Light, b: Light): number;
  78412. /**
  78413. * Releases resources associated with this node.
  78414. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  78415. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  78416. */
  78417. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  78418. /**
  78419. * Returns the light type ID (integer).
  78420. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  78421. */
  78422. getTypeID(): number;
  78423. /**
  78424. * Returns the intensity scaled by the Photometric Scale according to the light type and intensity mode.
  78425. * @returns the scaled intensity in intensity mode unit
  78426. */
  78427. getScaledIntensity(): number;
  78428. /**
  78429. * Returns a new Light object, named "name", from the current one.
  78430. * @param name The name of the cloned light
  78431. * @returns the new created light
  78432. */
  78433. clone(name: string): Nullable<Light>;
  78434. /**
  78435. * Serializes the current light into a Serialization object.
  78436. * @returns the serialized object.
  78437. */
  78438. serialize(): any;
  78439. /**
  78440. * Creates a new typed light from the passed type (integer) : point light = 0, directional light = 1, spot light = 2, hemispheric light = 3.
  78441. * This new light is named "name" and added to the passed scene.
  78442. * @param type Type according to the types available in Light.LIGHTTYPEID_x
  78443. * @param name The friendly name of the light
  78444. * @param scene The scene the new light will belong to
  78445. * @returns the constructor function
  78446. */
  78447. static GetConstructorFromName(type: number, name: string, scene: Scene): Nullable<() => Light>;
  78448. /**
  78449. * Parses the passed "parsedLight" and returns a new instanced Light from this parsing.
  78450. * @param parsedLight The JSON representation of the light
  78451. * @param scene The scene to create the parsed light in
  78452. * @returns the created light after parsing
  78453. */
  78454. static Parse(parsedLight: any, scene: Scene): Nullable<Light>;
  78455. private _hookArrayForExcluded;
  78456. private _hookArrayForIncludedOnly;
  78457. private _resyncMeshes;
  78458. /**
  78459. * Forces the meshes to update their light related information in their rendering used effects
  78460. * @hidden Internal Use Only
  78461. */
  78462. _markMeshesAsLightDirty(): void;
  78463. /**
  78464. * Recomputes the cached photometric scale if needed.
  78465. */
  78466. private _computePhotometricScale;
  78467. /**
  78468. * Returns the Photometric Scale according to the light type and intensity mode.
  78469. */
  78470. private _getPhotometricScale;
  78471. /**
  78472. * Reorder the light in the scene according to their defined priority.
  78473. * @hidden Internal Use Only
  78474. */
  78475. _reorderLightsInScene(): void;
  78476. /**
  78477. * Prepares the list of defines specific to the light type.
  78478. * @param defines the list of defines
  78479. * @param lightIndex defines the index of the light for the effect
  78480. */
  78481. abstract prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  78482. }
  78483. }
  78484. declare module BABYLON {
  78485. /**
  78486. * Interface used to define Action
  78487. */
  78488. export interface IAction {
  78489. /**
  78490. * Trigger for the action
  78491. */
  78492. trigger: number;
  78493. /** Options of the trigger */
  78494. triggerOptions: any;
  78495. /**
  78496. * Gets the trigger parameters
  78497. * @returns the trigger parameters
  78498. */
  78499. getTriggerParameter(): any;
  78500. /**
  78501. * Internal only - executes current action event
  78502. * @hidden
  78503. */
  78504. _executeCurrent(evt?: ActionEvent): void;
  78505. /**
  78506. * Serialize placeholder for child classes
  78507. * @param parent of child
  78508. * @returns the serialized object
  78509. */
  78510. serialize(parent: any): any;
  78511. /**
  78512. * Internal only
  78513. * @hidden
  78514. */
  78515. _prepare(): void;
  78516. /**
  78517. * Internal only - manager for action
  78518. * @hidden
  78519. */
  78520. _actionManager: AbstractActionManager;
  78521. /**
  78522. * Adds action to chain of actions, may be a DoNothingAction
  78523. * @param action defines the next action to execute
  78524. * @returns The action passed in
  78525. * @see https://www.babylonjs-playground.com/#1T30HR#0
  78526. */
  78527. then(action: IAction): IAction;
  78528. }
  78529. /**
  78530. * The action to be carried out following a trigger
  78531. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#available-actions
  78532. */
  78533. export class Action implements IAction {
  78534. /** the trigger, with or without parameters, for the action */
  78535. triggerOptions: any;
  78536. /**
  78537. * Trigger for the action
  78538. */
  78539. trigger: number;
  78540. /**
  78541. * Internal only - manager for action
  78542. * @hidden
  78543. */
  78544. _actionManager: ActionManager;
  78545. private _nextActiveAction;
  78546. private _child;
  78547. private _condition?;
  78548. private _triggerParameter;
  78549. /**
  78550. * An event triggered prior to action being executed.
  78551. */
  78552. onBeforeExecuteObservable: Observable<Action>;
  78553. /**
  78554. * Creates a new Action
  78555. * @param triggerOptions the trigger, with or without parameters, for the action
  78556. * @param condition an optional determinant of action
  78557. */
  78558. constructor(
  78559. /** the trigger, with or without parameters, for the action */
  78560. triggerOptions: any, condition?: Condition);
  78561. /**
  78562. * Internal only
  78563. * @hidden
  78564. */
  78565. _prepare(): void;
  78566. /**
  78567. * Gets the trigger parameters
  78568. * @returns the trigger parameters
  78569. */
  78570. getTriggerParameter(): any;
  78571. /**
  78572. * Internal only - executes current action event
  78573. * @hidden
  78574. */
  78575. _executeCurrent(evt?: ActionEvent): void;
  78576. /**
  78577. * Execute placeholder for child classes
  78578. * @param evt optional action event
  78579. */
  78580. execute(evt?: ActionEvent): void;
  78581. /**
  78582. * Skips to next active action
  78583. */
  78584. skipToNextActiveAction(): void;
  78585. /**
  78586. * Adds action to chain of actions, may be a DoNothingAction
  78587. * @param action defines the next action to execute
  78588. * @returns The action passed in
  78589. * @see https://www.babylonjs-playground.com/#1T30HR#0
  78590. */
  78591. then(action: Action): Action;
  78592. /**
  78593. * Internal only
  78594. * @hidden
  78595. */
  78596. _getProperty(propertyPath: string): string;
  78597. /**
  78598. * Internal only
  78599. * @hidden
  78600. */
  78601. _getEffectiveTarget(target: any, propertyPath: string): any;
  78602. /**
  78603. * Serialize placeholder for child classes
  78604. * @param parent of child
  78605. * @returns the serialized object
  78606. */
  78607. serialize(parent: any): any;
  78608. /**
  78609. * Internal only called by serialize
  78610. * @hidden
  78611. */
  78612. protected _serialize(serializedAction: any, parent?: any): any;
  78613. /**
  78614. * Internal only
  78615. * @hidden
  78616. */
  78617. static _SerializeValueAsString: (value: any) => string;
  78618. /**
  78619. * Internal only
  78620. * @hidden
  78621. */
  78622. static _GetTargetProperty: (target: Node | Scene) => {
  78623. name: string;
  78624. targetType: string;
  78625. value: string;
  78626. };
  78627. }
  78628. }
  78629. declare module BABYLON {
  78630. /**
  78631. * A Condition applied to an Action
  78632. */
  78633. export class Condition {
  78634. /**
  78635. * Internal only - manager for action
  78636. * @hidden
  78637. */
  78638. _actionManager: ActionManager;
  78639. /**
  78640. * Internal only
  78641. * @hidden
  78642. */
  78643. _evaluationId: number;
  78644. /**
  78645. * Internal only
  78646. * @hidden
  78647. */
  78648. _currentResult: boolean;
  78649. /**
  78650. * Creates a new Condition
  78651. * @param actionManager the manager of the action the condition is applied to
  78652. */
  78653. constructor(actionManager: ActionManager);
  78654. /**
  78655. * Check if the current condition is valid
  78656. * @returns a boolean
  78657. */
  78658. isValid(): boolean;
  78659. /**
  78660. * Internal only
  78661. * @hidden
  78662. */
  78663. _getProperty(propertyPath: string): string;
  78664. /**
  78665. * Internal only
  78666. * @hidden
  78667. */
  78668. _getEffectiveTarget(target: any, propertyPath: string): any;
  78669. /**
  78670. * Serialize placeholder for child classes
  78671. * @returns the serialized object
  78672. */
  78673. serialize(): any;
  78674. /**
  78675. * Internal only
  78676. * @hidden
  78677. */
  78678. protected _serialize(serializedCondition: any): any;
  78679. }
  78680. /**
  78681. * Defines specific conditional operators as extensions of Condition
  78682. */
  78683. export class ValueCondition extends Condition {
  78684. /** path to specify the property of the target the conditional operator uses */
  78685. propertyPath: string;
  78686. /** the value compared by the conditional operator against the current value of the property */
  78687. value: any;
  78688. /** the conditional operator, default ValueCondition.IsEqual */
  78689. operator: number;
  78690. /**
  78691. * Internal only
  78692. * @hidden
  78693. */
  78694. private static _IsEqual;
  78695. /**
  78696. * Internal only
  78697. * @hidden
  78698. */
  78699. private static _IsDifferent;
  78700. /**
  78701. * Internal only
  78702. * @hidden
  78703. */
  78704. private static _IsGreater;
  78705. /**
  78706. * Internal only
  78707. * @hidden
  78708. */
  78709. private static _IsLesser;
  78710. /**
  78711. * returns the number for IsEqual
  78712. */
  78713. static readonly IsEqual: number;
  78714. /**
  78715. * Returns the number for IsDifferent
  78716. */
  78717. static readonly IsDifferent: number;
  78718. /**
  78719. * Returns the number for IsGreater
  78720. */
  78721. static readonly IsGreater: number;
  78722. /**
  78723. * Returns the number for IsLesser
  78724. */
  78725. static readonly IsLesser: number;
  78726. /**
  78727. * Internal only The action manager for the condition
  78728. * @hidden
  78729. */
  78730. _actionManager: ActionManager;
  78731. /**
  78732. * Internal only
  78733. * @hidden
  78734. */
  78735. private _target;
  78736. /**
  78737. * Internal only
  78738. * @hidden
  78739. */
  78740. private _effectiveTarget;
  78741. /**
  78742. * Internal only
  78743. * @hidden
  78744. */
  78745. private _property;
  78746. /**
  78747. * Creates a new ValueCondition
  78748. * @param actionManager manager for the action the condition applies to
  78749. * @param target for the action
  78750. * @param propertyPath path to specify the property of the target the conditional operator uses
  78751. * @param value the value compared by the conditional operator against the current value of the property
  78752. * @param operator the conditional operator, default ValueCondition.IsEqual
  78753. */
  78754. constructor(actionManager: ActionManager, target: any,
  78755. /** path to specify the property of the target the conditional operator uses */
  78756. propertyPath: string,
  78757. /** the value compared by the conditional operator against the current value of the property */
  78758. value: any,
  78759. /** the conditional operator, default ValueCondition.IsEqual */
  78760. operator?: number);
  78761. /**
  78762. * Compares the given value with the property value for the specified conditional operator
  78763. * @returns the result of the comparison
  78764. */
  78765. isValid(): boolean;
  78766. /**
  78767. * Serialize the ValueCondition into a JSON compatible object
  78768. * @returns serialization object
  78769. */
  78770. serialize(): any;
  78771. /**
  78772. * Gets the name of the conditional operator for the ValueCondition
  78773. * @param operator the conditional operator
  78774. * @returns the name
  78775. */
  78776. static GetOperatorName(operator: number): string;
  78777. }
  78778. /**
  78779. * Defines a predicate condition as an extension of Condition
  78780. */
  78781. export class PredicateCondition extends Condition {
  78782. /** defines the predicate function used to validate the condition */
  78783. predicate: () => boolean;
  78784. /**
  78785. * Internal only - manager for action
  78786. * @hidden
  78787. */
  78788. _actionManager: ActionManager;
  78789. /**
  78790. * Creates a new PredicateCondition
  78791. * @param actionManager manager for the action the condition applies to
  78792. * @param predicate defines the predicate function used to validate the condition
  78793. */
  78794. constructor(actionManager: ActionManager,
  78795. /** defines the predicate function used to validate the condition */
  78796. predicate: () => boolean);
  78797. /**
  78798. * @returns the validity of the predicate condition
  78799. */
  78800. isValid(): boolean;
  78801. }
  78802. /**
  78803. * Defines a state condition as an extension of Condition
  78804. */
  78805. export class StateCondition extends Condition {
  78806. /** Value to compare with target state */
  78807. value: string;
  78808. /**
  78809. * Internal only - manager for action
  78810. * @hidden
  78811. */
  78812. _actionManager: ActionManager;
  78813. /**
  78814. * Internal only
  78815. * @hidden
  78816. */
  78817. private _target;
  78818. /**
  78819. * Creates a new StateCondition
  78820. * @param actionManager manager for the action the condition applies to
  78821. * @param target of the condition
  78822. * @param value to compare with target state
  78823. */
  78824. constructor(actionManager: ActionManager, target: any,
  78825. /** Value to compare with target state */
  78826. value: string);
  78827. /**
  78828. * Gets a boolean indicating if the current condition is met
  78829. * @returns the validity of the state
  78830. */
  78831. isValid(): boolean;
  78832. /**
  78833. * Serialize the StateCondition into a JSON compatible object
  78834. * @returns serialization object
  78835. */
  78836. serialize(): any;
  78837. }
  78838. }
  78839. declare module BABYLON {
  78840. /**
  78841. * This defines an action responsible to toggle a boolean once triggered.
  78842. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  78843. */
  78844. export class SwitchBooleanAction extends Action {
  78845. /**
  78846. * The path to the boolean property in the target object
  78847. */
  78848. propertyPath: string;
  78849. private _target;
  78850. private _effectiveTarget;
  78851. private _property;
  78852. /**
  78853. * Instantiate the action
  78854. * @param triggerOptions defines the trigger options
  78855. * @param target defines the object containing the boolean
  78856. * @param propertyPath defines the path to the boolean property in the target object
  78857. * @param condition defines the trigger related conditions
  78858. */
  78859. constructor(triggerOptions: any, target: any, propertyPath: string, condition?: Condition);
  78860. /** @hidden */
  78861. _prepare(): void;
  78862. /**
  78863. * Execute the action toggle the boolean value.
  78864. */
  78865. execute(): void;
  78866. /**
  78867. * Serializes the actions and its related information.
  78868. * @param parent defines the object to serialize in
  78869. * @returns the serialized object
  78870. */
  78871. serialize(parent: any): any;
  78872. }
  78873. /**
  78874. * This defines an action responsible to set a the state field of the target
  78875. * to a desired value once triggered.
  78876. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  78877. */
  78878. export class SetStateAction extends Action {
  78879. /**
  78880. * The value to store in the state field.
  78881. */
  78882. value: string;
  78883. private _target;
  78884. /**
  78885. * Instantiate the action
  78886. * @param triggerOptions defines the trigger options
  78887. * @param target defines the object containing the state property
  78888. * @param value defines the value to store in the state field
  78889. * @param condition defines the trigger related conditions
  78890. */
  78891. constructor(triggerOptions: any, target: any, value: string, condition?: Condition);
  78892. /**
  78893. * Execute the action and store the value on the target state property.
  78894. */
  78895. execute(): void;
  78896. /**
  78897. * Serializes the actions and its related information.
  78898. * @param parent defines the object to serialize in
  78899. * @returns the serialized object
  78900. */
  78901. serialize(parent: any): any;
  78902. }
  78903. /**
  78904. * This defines an action responsible to set a property of the target
  78905. * to a desired value once triggered.
  78906. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  78907. */
  78908. export class SetValueAction extends Action {
  78909. /**
  78910. * The path of the property to set in the target.
  78911. */
  78912. propertyPath: string;
  78913. /**
  78914. * The value to set in the property
  78915. */
  78916. value: any;
  78917. private _target;
  78918. private _effectiveTarget;
  78919. private _property;
  78920. /**
  78921. * Instantiate the action
  78922. * @param triggerOptions defines the trigger options
  78923. * @param target defines the object containing the property
  78924. * @param propertyPath defines the path of the property to set in the target
  78925. * @param value defines the value to set in the property
  78926. * @param condition defines the trigger related conditions
  78927. */
  78928. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  78929. /** @hidden */
  78930. _prepare(): void;
  78931. /**
  78932. * Execute the action and set the targetted property to the desired value.
  78933. */
  78934. execute(): void;
  78935. /**
  78936. * Serializes the actions and its related information.
  78937. * @param parent defines the object to serialize in
  78938. * @returns the serialized object
  78939. */
  78940. serialize(parent: any): any;
  78941. }
  78942. /**
  78943. * This defines an action responsible to increment the target value
  78944. * to a desired value once triggered.
  78945. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  78946. */
  78947. export class IncrementValueAction extends Action {
  78948. /**
  78949. * The path of the property to increment in the target.
  78950. */
  78951. propertyPath: string;
  78952. /**
  78953. * The value we should increment the property by.
  78954. */
  78955. value: any;
  78956. private _target;
  78957. private _effectiveTarget;
  78958. private _property;
  78959. /**
  78960. * Instantiate the action
  78961. * @param triggerOptions defines the trigger options
  78962. * @param target defines the object containing the property
  78963. * @param propertyPath defines the path of the property to increment in the target
  78964. * @param value defines the value value we should increment the property by
  78965. * @param condition defines the trigger related conditions
  78966. */
  78967. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, condition?: Condition);
  78968. /** @hidden */
  78969. _prepare(): void;
  78970. /**
  78971. * Execute the action and increment the target of the value amount.
  78972. */
  78973. execute(): void;
  78974. /**
  78975. * Serializes the actions and its related information.
  78976. * @param parent defines the object to serialize in
  78977. * @returns the serialized object
  78978. */
  78979. serialize(parent: any): any;
  78980. }
  78981. /**
  78982. * This defines an action responsible to start an animation once triggered.
  78983. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  78984. */
  78985. export class PlayAnimationAction extends Action {
  78986. /**
  78987. * Where the animation should start (animation frame)
  78988. */
  78989. from: number;
  78990. /**
  78991. * Where the animation should stop (animation frame)
  78992. */
  78993. to: number;
  78994. /**
  78995. * Define if the animation should loop or stop after the first play.
  78996. */
  78997. loop?: boolean;
  78998. private _target;
  78999. /**
  79000. * Instantiate the action
  79001. * @param triggerOptions defines the trigger options
  79002. * @param target defines the target animation or animation name
  79003. * @param from defines from where the animation should start (animation frame)
  79004. * @param end defines where the animation should stop (animation frame)
  79005. * @param loop defines if the animation should loop or stop after the first play
  79006. * @param condition defines the trigger related conditions
  79007. */
  79008. constructor(triggerOptions: any, target: any, from: number, to: number, loop?: boolean, condition?: Condition);
  79009. /** @hidden */
  79010. _prepare(): void;
  79011. /**
  79012. * Execute the action and play the animation.
  79013. */
  79014. execute(): void;
  79015. /**
  79016. * Serializes the actions and its related information.
  79017. * @param parent defines the object to serialize in
  79018. * @returns the serialized object
  79019. */
  79020. serialize(parent: any): any;
  79021. }
  79022. /**
  79023. * This defines an action responsible to stop an animation once triggered.
  79024. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  79025. */
  79026. export class StopAnimationAction extends Action {
  79027. private _target;
  79028. /**
  79029. * Instantiate the action
  79030. * @param triggerOptions defines the trigger options
  79031. * @param target defines the target animation or animation name
  79032. * @param condition defines the trigger related conditions
  79033. */
  79034. constructor(triggerOptions: any, target: any, condition?: Condition);
  79035. /** @hidden */
  79036. _prepare(): void;
  79037. /**
  79038. * Execute the action and stop the animation.
  79039. */
  79040. execute(): void;
  79041. /**
  79042. * Serializes the actions and its related information.
  79043. * @param parent defines the object to serialize in
  79044. * @returns the serialized object
  79045. */
  79046. serialize(parent: any): any;
  79047. }
  79048. /**
  79049. * This defines an action responsible that does nothing once triggered.
  79050. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  79051. */
  79052. export class DoNothingAction extends Action {
  79053. /**
  79054. * Instantiate the action
  79055. * @param triggerOptions defines the trigger options
  79056. * @param condition defines the trigger related conditions
  79057. */
  79058. constructor(triggerOptions?: any, condition?: Condition);
  79059. /**
  79060. * Execute the action and do nothing.
  79061. */
  79062. execute(): void;
  79063. /**
  79064. * Serializes the actions and its related information.
  79065. * @param parent defines the object to serialize in
  79066. * @returns the serialized object
  79067. */
  79068. serialize(parent: any): any;
  79069. }
  79070. /**
  79071. * This defines an action responsible to trigger several actions once triggered.
  79072. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  79073. */
  79074. export class CombineAction extends Action {
  79075. /**
  79076. * The list of aggregated animations to run.
  79077. */
  79078. children: Action[];
  79079. /**
  79080. * Instantiate the action
  79081. * @param triggerOptions defines the trigger options
  79082. * @param children defines the list of aggregated animations to run
  79083. * @param condition defines the trigger related conditions
  79084. */
  79085. constructor(triggerOptions: any, children: Action[], condition?: Condition);
  79086. /** @hidden */
  79087. _prepare(): void;
  79088. /**
  79089. * Execute the action and executes all the aggregated actions.
  79090. */
  79091. execute(evt: ActionEvent): void;
  79092. /**
  79093. * Serializes the actions and its related information.
  79094. * @param parent defines the object to serialize in
  79095. * @returns the serialized object
  79096. */
  79097. serialize(parent: any): any;
  79098. }
  79099. /**
  79100. * This defines an action responsible to run code (external event) once triggered.
  79101. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  79102. */
  79103. export class ExecuteCodeAction extends Action {
  79104. /**
  79105. * The callback function to run.
  79106. */
  79107. func: (evt: ActionEvent) => void;
  79108. /**
  79109. * Instantiate the action
  79110. * @param triggerOptions defines the trigger options
  79111. * @param func defines the callback function to run
  79112. * @param condition defines the trigger related conditions
  79113. */
  79114. constructor(triggerOptions: any, func: (evt: ActionEvent) => void, condition?: Condition);
  79115. /**
  79116. * Execute the action and run the attached code.
  79117. */
  79118. execute(evt: ActionEvent): void;
  79119. }
  79120. /**
  79121. * This defines an action responsible to set the parent property of the target once triggered.
  79122. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  79123. */
  79124. export class SetParentAction extends Action {
  79125. private _parent;
  79126. private _target;
  79127. /**
  79128. * Instantiate the action
  79129. * @param triggerOptions defines the trigger options
  79130. * @param target defines the target containing the parent property
  79131. * @param parent defines from where the animation should start (animation frame)
  79132. * @param condition defines the trigger related conditions
  79133. */
  79134. constructor(triggerOptions: any, target: any, parent: any, condition?: Condition);
  79135. /** @hidden */
  79136. _prepare(): void;
  79137. /**
  79138. * Execute the action and set the parent property.
  79139. */
  79140. execute(): void;
  79141. /**
  79142. * Serializes the actions and its related information.
  79143. * @param parent defines the object to serialize in
  79144. * @returns the serialized object
  79145. */
  79146. serialize(parent: any): any;
  79147. }
  79148. }
  79149. declare module BABYLON {
  79150. /**
  79151. * Action Manager manages all events to be triggered on a given mesh or the global scene.
  79152. * A single scene can have many Action Managers to handle predefined actions on specific meshes.
  79153. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  79154. */
  79155. export class ActionManager extends AbstractActionManager {
  79156. /**
  79157. * Nothing
  79158. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79159. */
  79160. static readonly NothingTrigger: number;
  79161. /**
  79162. * On pick
  79163. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79164. */
  79165. static readonly OnPickTrigger: number;
  79166. /**
  79167. * On left pick
  79168. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79169. */
  79170. static readonly OnLeftPickTrigger: number;
  79171. /**
  79172. * On right pick
  79173. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79174. */
  79175. static readonly OnRightPickTrigger: number;
  79176. /**
  79177. * On center pick
  79178. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79179. */
  79180. static readonly OnCenterPickTrigger: number;
  79181. /**
  79182. * On pick down
  79183. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79184. */
  79185. static readonly OnPickDownTrigger: number;
  79186. /**
  79187. * On double pick
  79188. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79189. */
  79190. static readonly OnDoublePickTrigger: number;
  79191. /**
  79192. * On pick up
  79193. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79194. */
  79195. static readonly OnPickUpTrigger: number;
  79196. /**
  79197. * On pick out.
  79198. * This trigger will only be raised if you also declared a OnPickDown
  79199. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79200. */
  79201. static readonly OnPickOutTrigger: number;
  79202. /**
  79203. * On long press
  79204. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79205. */
  79206. static readonly OnLongPressTrigger: number;
  79207. /**
  79208. * On pointer over
  79209. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79210. */
  79211. static readonly OnPointerOverTrigger: number;
  79212. /**
  79213. * On pointer out
  79214. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79215. */
  79216. static readonly OnPointerOutTrigger: number;
  79217. /**
  79218. * On every frame
  79219. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79220. */
  79221. static readonly OnEveryFrameTrigger: number;
  79222. /**
  79223. * On intersection enter
  79224. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79225. */
  79226. static readonly OnIntersectionEnterTrigger: number;
  79227. /**
  79228. * On intersection exit
  79229. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79230. */
  79231. static readonly OnIntersectionExitTrigger: number;
  79232. /**
  79233. * On key down
  79234. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79235. */
  79236. static readonly OnKeyDownTrigger: number;
  79237. /**
  79238. * On key up
  79239. * @see http://doc.babylonjs.com/how_to/how_to_use_actions#triggers
  79240. */
  79241. static readonly OnKeyUpTrigger: number;
  79242. private _scene;
  79243. /**
  79244. * Creates a new action manager
  79245. * @param scene defines the hosting scene
  79246. */
  79247. constructor(scene: Scene);
  79248. /**
  79249. * Releases all associated resources
  79250. */
  79251. dispose(): void;
  79252. /**
  79253. * Gets hosting scene
  79254. * @returns the hosting scene
  79255. */
  79256. getScene(): Scene;
  79257. /**
  79258. * Does this action manager handles actions of any of the given triggers
  79259. * @param triggers defines the triggers to be tested
  79260. * @return a boolean indicating whether one (or more) of the triggers is handled
  79261. */
  79262. hasSpecificTriggers(triggers: number[]): boolean;
  79263. /**
  79264. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  79265. * speed.
  79266. * @param triggerA defines the trigger to be tested
  79267. * @param triggerB defines the trigger to be tested
  79268. * @return a boolean indicating whether one (or more) of the triggers is handled
  79269. */
  79270. hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  79271. /**
  79272. * Does this action manager handles actions of a given trigger
  79273. * @param trigger defines the trigger to be tested
  79274. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  79275. * @return whether the trigger is handled
  79276. */
  79277. hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  79278. /**
  79279. * Does this action manager has pointer triggers
  79280. */
  79281. readonly hasPointerTriggers: boolean;
  79282. /**
  79283. * Does this action manager has pick triggers
  79284. */
  79285. readonly hasPickTriggers: boolean;
  79286. /**
  79287. * Registers an action to this action manager
  79288. * @param action defines the action to be registered
  79289. * @return the action amended (prepared) after registration
  79290. */
  79291. registerAction(action: IAction): Nullable<IAction>;
  79292. /**
  79293. * Unregisters an action to this action manager
  79294. * @param action defines the action to be unregistered
  79295. * @return a boolean indicating whether the action has been unregistered
  79296. */
  79297. unregisterAction(action: IAction): Boolean;
  79298. /**
  79299. * Process a specific trigger
  79300. * @param trigger defines the trigger to process
  79301. * @param evt defines the event details to be processed
  79302. */
  79303. processTrigger(trigger: number, evt?: IActionEvent): void;
  79304. /** @hidden */
  79305. _getEffectiveTarget(target: any, propertyPath: string): any;
  79306. /** @hidden */
  79307. _getProperty(propertyPath: string): string;
  79308. /**
  79309. * Serialize this manager to a JSON object
  79310. * @param name defines the property name to store this manager
  79311. * @returns a JSON representation of this manager
  79312. */
  79313. serialize(name: string): any;
  79314. /**
  79315. * Creates a new ActionManager from a JSON data
  79316. * @param parsedActions defines the JSON data to read from
  79317. * @param object defines the hosting mesh
  79318. * @param scene defines the hosting scene
  79319. */
  79320. static Parse(parsedActions: any, object: Nullable<AbstractMesh>, scene: Scene): void;
  79321. /**
  79322. * Get a trigger name by index
  79323. * @param trigger defines the trigger index
  79324. * @returns a trigger name
  79325. */
  79326. static GetTriggerName(trigger: number): string;
  79327. }
  79328. }
  79329. declare module BABYLON {
  79330. /**
  79331. * Class representing a ray with position and direction
  79332. */
  79333. export class Ray {
  79334. /** origin point */
  79335. origin: Vector3;
  79336. /** direction */
  79337. direction: Vector3;
  79338. /** length of the ray */
  79339. length: number;
  79340. private static readonly TmpVector3;
  79341. private _tmpRay;
  79342. /**
  79343. * Creates a new ray
  79344. * @param origin origin point
  79345. * @param direction direction
  79346. * @param length length of the ray
  79347. */
  79348. constructor(
  79349. /** origin point */
  79350. origin: Vector3,
  79351. /** direction */
  79352. direction: Vector3,
  79353. /** length of the ray */
  79354. length?: number);
  79355. /**
  79356. * Checks if the ray intersects a box
  79357. * @param minimum bound of the box
  79358. * @param maximum bound of the box
  79359. * @param intersectionTreshold extra extend to be added to the box in all direction
  79360. * @returns if the box was hit
  79361. */
  79362. intersectsBoxMinMax(minimum: DeepImmutable<Vector3>, maximum: DeepImmutable<Vector3>, intersectionTreshold?: number): boolean;
  79363. /**
  79364. * Checks if the ray intersects a box
  79365. * @param box the bounding box to check
  79366. * @param intersectionTreshold extra extend to be added to the BoundingBox in all direction
  79367. * @returns if the box was hit
  79368. */
  79369. intersectsBox(box: DeepImmutable<BoundingBox>, intersectionTreshold?: number): boolean;
  79370. /**
  79371. * If the ray hits a sphere
  79372. * @param sphere the bounding sphere to check
  79373. * @param intersectionTreshold extra extend to be added to the BoundingSphere in all direction
  79374. * @returns true if it hits the sphere
  79375. */
  79376. intersectsSphere(sphere: DeepImmutable<BoundingSphere>, intersectionTreshold?: number): boolean;
  79377. /**
  79378. * If the ray hits a triange
  79379. * @param vertex0 triangle vertex
  79380. * @param vertex1 triangle vertex
  79381. * @param vertex2 triangle vertex
  79382. * @returns intersection information if hit
  79383. */
  79384. intersectsTriangle(vertex0: DeepImmutable<Vector3>, vertex1: DeepImmutable<Vector3>, vertex2: DeepImmutable<Vector3>): Nullable<IntersectionInfo>;
  79385. /**
  79386. * Checks if ray intersects a plane
  79387. * @param plane the plane to check
  79388. * @returns the distance away it was hit
  79389. */
  79390. intersectsPlane(plane: DeepImmutable<Plane>): Nullable<number>;
  79391. /**
  79392. * Calculate the intercept of a ray on a given axis
  79393. * @param axis to check 'x' | 'y' | 'z'
  79394. * @param offset from axis interception (i.e. an offset of 1y is intercepted above ground)
  79395. * @returns a vector containing the coordinates where 'axis' is equal to zero (else offset), or null if there is no intercept.
  79396. */
  79397. intersectsAxis(axis: string, offset?: number): Nullable<Vector3>;
  79398. /**
  79399. * Checks if ray intersects a mesh
  79400. * @param mesh the mesh to check
  79401. * @param fastCheck if only the bounding box should checked
  79402. * @returns picking info of the intersecton
  79403. */
  79404. intersectsMesh(mesh: DeepImmutable<AbstractMesh>, fastCheck?: boolean): PickingInfo;
  79405. /**
  79406. * Checks if ray intersects a mesh
  79407. * @param meshes the meshes to check
  79408. * @param fastCheck if only the bounding box should checked
  79409. * @param results array to store result in
  79410. * @returns Array of picking infos
  79411. */
  79412. intersectsMeshes(meshes: Array<DeepImmutable<AbstractMesh>>, fastCheck?: boolean, results?: Array<PickingInfo>): Array<PickingInfo>;
  79413. private _comparePickingInfo;
  79414. private static smallnum;
  79415. private static rayl;
  79416. /**
  79417. * Intersection test between the ray and a given segment whithin a given tolerance (threshold)
  79418. * @param sega the first point of the segment to test the intersection against
  79419. * @param segb the second point of the segment to test the intersection against
  79420. * @param threshold the tolerance margin, if the ray doesn't intersect the segment but is close to the given threshold, the intersection is successful
  79421. * @return the distance from the ray origin to the intersection point if there's intersection, or -1 if there's no intersection
  79422. */
  79423. intersectionSegment(sega: DeepImmutable<Vector3>, segb: DeepImmutable<Vector3>, threshold: number): number;
  79424. /**
  79425. * Update the ray from viewport position
  79426. * @param x position
  79427. * @param y y position
  79428. * @param viewportWidth viewport width
  79429. * @param viewportHeight viewport height
  79430. * @param world world matrix
  79431. * @param view view matrix
  79432. * @param projection projection matrix
  79433. * @returns this ray updated
  79434. */
  79435. update(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  79436. /**
  79437. * Creates a ray with origin and direction of 0,0,0
  79438. * @returns the new ray
  79439. */
  79440. static Zero(): Ray;
  79441. /**
  79442. * Creates a new ray from screen space and viewport
  79443. * @param x position
  79444. * @param y y position
  79445. * @param viewportWidth viewport width
  79446. * @param viewportHeight viewport height
  79447. * @param world world matrix
  79448. * @param view view matrix
  79449. * @param projection projection matrix
  79450. * @returns new ray
  79451. */
  79452. static CreateNew(x: number, y: number, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): Ray;
  79453. /**
  79454. * 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
  79455. * transformed to the given world matrix.
  79456. * @param origin The origin point
  79457. * @param end The end point
  79458. * @param world a matrix to transform the ray to. Default is the identity matrix.
  79459. * @returns the new ray
  79460. */
  79461. static CreateNewFromTo(origin: DeepImmutable<Vector3>, end: DeepImmutable<Vector3>, world?: DeepImmutable<Matrix>): Ray;
  79462. /**
  79463. * Transforms a ray by a matrix
  79464. * @param ray ray to transform
  79465. * @param matrix matrix to apply
  79466. * @returns the resulting new ray
  79467. */
  79468. static Transform(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>): Ray;
  79469. /**
  79470. * Transforms a ray by a matrix
  79471. * @param ray ray to transform
  79472. * @param matrix matrix to apply
  79473. * @param result ray to store result in
  79474. */
  79475. static TransformToRef(ray: DeepImmutable<Ray>, matrix: DeepImmutable<Matrix>, result: Ray): void;
  79476. /**
  79477. * Unproject a ray from screen space to object space
  79478. * @param sourceX defines the screen space x coordinate to use
  79479. * @param sourceY defines the screen space y coordinate to use
  79480. * @param viewportWidth defines the current width of the viewport
  79481. * @param viewportHeight defines the current height of the viewport
  79482. * @param world defines the world matrix to use (can be set to Identity to go to world space)
  79483. * @param view defines the view matrix to use
  79484. * @param projection defines the projection matrix to use
  79485. */
  79486. unprojectRayToRef(sourceX: float, sourceY: float, viewportWidth: number, viewportHeight: number, world: DeepImmutable<Matrix>, view: DeepImmutable<Matrix>, projection: DeepImmutable<Matrix>): void;
  79487. }
  79488. /**
  79489. * Type used to define predicate used to select faces when a mesh intersection is detected
  79490. */
  79491. export type TrianglePickingPredicate = (p0: Vector3, p1: Vector3, p2: Vector3, ray: Ray) => boolean;
  79492. interface Scene {
  79493. /** @hidden */
  79494. _tempPickingRay: Nullable<Ray>;
  79495. /** @hidden */
  79496. _cachedRayForTransform: Ray;
  79497. /** @hidden */
  79498. _pickWithRayInverseMatrix: Matrix;
  79499. /** @hidden */
  79500. _internalPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  79501. /** @hidden */
  79502. _internalMultiPick(rayFunction: (world: Matrix) => Ray, predicate?: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  79503. }
  79504. }
  79505. declare module BABYLON {
  79506. /**
  79507. * Groups all the scene component constants in one place to ease maintenance.
  79508. * @hidden
  79509. */
  79510. export class SceneComponentConstants {
  79511. static readonly NAME_EFFECTLAYER: string;
  79512. static readonly NAME_LAYER: string;
  79513. static readonly NAME_LENSFLARESYSTEM: string;
  79514. static readonly NAME_BOUNDINGBOXRENDERER: string;
  79515. static readonly NAME_PARTICLESYSTEM: string;
  79516. static readonly NAME_GAMEPAD: string;
  79517. static readonly NAME_SIMPLIFICATIONQUEUE: string;
  79518. static readonly NAME_GEOMETRYBUFFERRENDERER: string;
  79519. static readonly NAME_DEPTHRENDERER: string;
  79520. static readonly NAME_POSTPROCESSRENDERPIPELINEMANAGER: string;
  79521. static readonly NAME_SPRITE: string;
  79522. static readonly NAME_OUTLINERENDERER: string;
  79523. static readonly NAME_PROCEDURALTEXTURE: string;
  79524. static readonly NAME_SHADOWGENERATOR: string;
  79525. static readonly NAME_OCTREE: string;
  79526. static readonly NAME_PHYSICSENGINE: string;
  79527. static readonly NAME_AUDIO: string;
  79528. static readonly STEP_ISREADYFORMESH_EFFECTLAYER: number;
  79529. static readonly STEP_BEFOREEVALUATEACTIVEMESH_BOUNDINGBOXRENDERER: number;
  79530. static readonly STEP_EVALUATESUBMESH_BOUNDINGBOXRENDERER: number;
  79531. static readonly STEP_ACTIVEMESH_BOUNDINGBOXRENDERER: number;
  79532. static readonly STEP_CAMERADRAWRENDERTARGET_EFFECTLAYER: number;
  79533. static readonly STEP_BEFORECAMERADRAW_EFFECTLAYER: number;
  79534. static readonly STEP_BEFORECAMERADRAW_LAYER: number;
  79535. static readonly STEP_BEFORERENDERTARGETDRAW_LAYER: number;
  79536. static readonly STEP_BEFORERENDERINGMESH_OUTLINE: number;
  79537. static readonly STEP_AFTERRENDERINGMESH_OUTLINE: number;
  79538. static readonly STEP_AFTERRENDERINGGROUPDRAW_EFFECTLAYER_DRAW: number;
  79539. static readonly STEP_AFTERRENDERINGGROUPDRAW_BOUNDINGBOXRENDERER: number;
  79540. static readonly STEP_BEFORECAMERAUPDATE_SIMPLIFICATIONQUEUE: number;
  79541. static readonly STEP_BEFORECAMERAUPDATE_GAMEPAD: number;
  79542. static readonly STEP_BEFORECLEAR_PROCEDURALTEXTURE: number;
  79543. static readonly STEP_AFTERRENDERTARGETDRAW_LAYER: number;
  79544. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER: number;
  79545. static readonly STEP_AFTERCAMERADRAW_LENSFLARESYSTEM: number;
  79546. static readonly STEP_AFTERCAMERADRAW_EFFECTLAYER_DRAW: number;
  79547. static readonly STEP_AFTERCAMERADRAW_LAYER: number;
  79548. static readonly STEP_AFTERRENDER_AUDIO: number;
  79549. static readonly STEP_GATHERRENDERTARGETS_SHADOWGENERATOR: number;
  79550. static readonly STEP_GATHERRENDERTARGETS_GEOMETRYBUFFERRENDERER: number;
  79551. static readonly STEP_GATHERRENDERTARGETS_DEPTHRENDERER: number;
  79552. static readonly STEP_GATHERRENDERTARGETS_POSTPROCESSRENDERPIPELINEMANAGER: number;
  79553. static readonly STEP_GATHERACTIVECAMERARENDERTARGETS_DEPTHRENDERER: number;
  79554. static readonly STEP_POINTERMOVE_SPRITE: number;
  79555. static readonly STEP_POINTERDOWN_SPRITE: number;
  79556. static readonly STEP_POINTERUP_SPRITE: number;
  79557. }
  79558. /**
  79559. * This represents a scene component.
  79560. *
  79561. * This is used to decouple the dependency the scene is having on the different workloads like
  79562. * layers, post processes...
  79563. */
  79564. export interface ISceneComponent {
  79565. /**
  79566. * The name of the component. Each component must have a unique name.
  79567. */
  79568. name: string;
  79569. /**
  79570. * The scene the component belongs to.
  79571. */
  79572. scene: Scene;
  79573. /**
  79574. * Register the component to one instance of a scene.
  79575. */
  79576. register(): void;
  79577. /**
  79578. * Rebuilds the elements related to this component in case of
  79579. * context lost for instance.
  79580. */
  79581. rebuild(): void;
  79582. /**
  79583. * Disposes the component and the associated ressources.
  79584. */
  79585. dispose(): void;
  79586. }
  79587. /**
  79588. * This represents a SERIALIZABLE scene component.
  79589. *
  79590. * This extends Scene Component to add Serialization methods on top.
  79591. */
  79592. export interface ISceneSerializableComponent extends ISceneComponent {
  79593. /**
  79594. * Adds all the elements from the container to the scene
  79595. * @param container the container holding the elements
  79596. */
  79597. addFromContainer(container: AbstractScene): void;
  79598. /**
  79599. * Removes all the elements in the container from the scene
  79600. * @param container contains the elements to remove
  79601. * @param dispose if the removed element should be disposed (default: false)
  79602. */
  79603. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  79604. /**
  79605. * Serializes the component data to the specified json object
  79606. * @param serializationObject The object to serialize to
  79607. */
  79608. serialize(serializationObject: any): void;
  79609. }
  79610. /**
  79611. * Strong typing of a Mesh related stage step action
  79612. */
  79613. export type MeshStageAction = (mesh: AbstractMesh, hardwareInstancedRendering: boolean) => boolean;
  79614. /**
  79615. * Strong typing of a Evaluate Sub Mesh related stage step action
  79616. */
  79617. export type EvaluateSubMeshStageAction = (mesh: AbstractMesh, subMesh: SubMesh) => void;
  79618. /**
  79619. * Strong typing of a Active Mesh related stage step action
  79620. */
  79621. export type ActiveMeshStageAction = (sourceMesh: AbstractMesh, mesh: AbstractMesh) => void;
  79622. /**
  79623. * Strong typing of a Camera related stage step action
  79624. */
  79625. export type CameraStageAction = (camera: Camera) => void;
  79626. /**
  79627. * Strong typing of a Camera Frame buffer related stage step action
  79628. */
  79629. export type CameraStageFrameBufferAction = (camera: Camera) => boolean;
  79630. /**
  79631. * Strong typing of a Render Target related stage step action
  79632. */
  79633. export type RenderTargetStageAction = (renderTarget: RenderTargetTexture) => void;
  79634. /**
  79635. * Strong typing of a RenderingGroup related stage step action
  79636. */
  79637. export type RenderingGroupStageAction = (renderingGroupId: number) => void;
  79638. /**
  79639. * Strong typing of a Mesh Render related stage step action
  79640. */
  79641. export type RenderingMeshStageAction = (mesh: Mesh, subMesh: SubMesh, batch: _InstancesBatch) => void;
  79642. /**
  79643. * Strong typing of a simple stage step action
  79644. */
  79645. export type SimpleStageAction = () => void;
  79646. /**
  79647. * Strong typing of a render target action.
  79648. */
  79649. export type RenderTargetsStageAction = (renderTargets: SmartArrayNoDuplicate<RenderTargetTexture>) => void;
  79650. /**
  79651. * Strong typing of a pointer move action.
  79652. */
  79653. export type PointerMoveStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, isMeshPicked: boolean, element: HTMLElement) => Nullable<PickingInfo>;
  79654. /**
  79655. * Strong typing of a pointer up/down action.
  79656. */
  79657. export type PointerUpDownStageAction = (unTranslatedPointerX: number, unTranslatedPointerY: number, pickResult: Nullable<PickingInfo>, evt: PointerEvent) => Nullable<PickingInfo>;
  79658. /**
  79659. * Representation of a stage in the scene (Basically a list of ordered steps)
  79660. * @hidden
  79661. */
  79662. export class Stage<T extends Function> extends Array<{
  79663. index: number;
  79664. component: ISceneComponent;
  79665. action: T;
  79666. }> {
  79667. /**
  79668. * Hide ctor from the rest of the world.
  79669. * @param items The items to add.
  79670. */
  79671. private constructor();
  79672. /**
  79673. * Creates a new Stage.
  79674. * @returns A new instance of a Stage
  79675. */
  79676. static Create<T extends Function>(): Stage<T>;
  79677. /**
  79678. * Registers a step in an ordered way in the targeted stage.
  79679. * @param index Defines the position to register the step in
  79680. * @param component Defines the component attached to the step
  79681. * @param action Defines the action to launch during the step
  79682. */
  79683. registerStep(index: number, component: ISceneComponent, action: T): void;
  79684. /**
  79685. * Clears all the steps from the stage.
  79686. */
  79687. clear(): void;
  79688. }
  79689. }
  79690. declare module BABYLON {
  79691. interface Scene {
  79692. /** @hidden */
  79693. _pointerOverSprite: Nullable<Sprite>;
  79694. /** @hidden */
  79695. _pickedDownSprite: Nullable<Sprite>;
  79696. /** @hidden */
  79697. _tempSpritePickingRay: Nullable<Ray>;
  79698. /**
  79699. * All of the sprite managers added to this scene
  79700. * @see http://doc.babylonjs.com/babylon101/sprites
  79701. */
  79702. spriteManagers: Array<ISpriteManager>;
  79703. /**
  79704. * An event triggered when sprites rendering is about to start
  79705. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  79706. */
  79707. onBeforeSpritesRenderingObservable: Observable<Scene>;
  79708. /**
  79709. * An event triggered when sprites rendering is done
  79710. * Note: This event can be trigger more than once per frame (because sprites can be rendered by render target textures as well)
  79711. */
  79712. onAfterSpritesRenderingObservable: Observable<Scene>;
  79713. /** @hidden */
  79714. _internalPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  79715. /** Launch a ray to try to pick a sprite in the scene
  79716. * @param x position on screen
  79717. * @param y position on screen
  79718. * @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
  79719. * @param fastCheck Launch a fast check only using the bounding boxes. Can be set to null.
  79720. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  79721. * @returns a PickingInfo
  79722. */
  79723. pickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  79724. /** Use the given ray to pick a sprite in the scene
  79725. * @param ray The ray (in world space) to use to pick meshes
  79726. * @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
  79727. * @param fastCheck Launch a fast check only using the bounding boxes. Can be set to null.
  79728. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  79729. * @returns a PickingInfo
  79730. */
  79731. pickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean, camera?: Camera): Nullable<PickingInfo>;
  79732. /** @hidden */
  79733. _internalMultiPickSprites(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  79734. /** Launch a ray to try to pick sprites in the scene
  79735. * @param x position on screen
  79736. * @param y position on screen
  79737. * @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
  79738. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  79739. * @returns a PickingInfo array
  79740. */
  79741. multiPickSprite(x: number, y: number, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  79742. /** Use the given ray to pick sprites in the scene
  79743. * @param ray The ray (in world space) to use to pick meshes
  79744. * @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
  79745. * @param camera camera to use. Can be set to null. In this case, the scene.activeCamera will be used
  79746. * @returns a PickingInfo array
  79747. */
  79748. multiPickSpriteWithRay(ray: Ray, predicate?: (sprite: Sprite) => boolean, camera?: Camera): Nullable<PickingInfo[]>;
  79749. /**
  79750. * Force the sprite under the pointer
  79751. * @param sprite defines the sprite to use
  79752. */
  79753. setPointerOverSprite(sprite: Nullable<Sprite>): void;
  79754. /**
  79755. * Gets the sprite under the pointer
  79756. * @returns a Sprite or null if no sprite is under the pointer
  79757. */
  79758. getPointerOverSprite(): Nullable<Sprite>;
  79759. }
  79760. /**
  79761. * Defines the sprite scene component responsible to manage sprites
  79762. * in a given scene.
  79763. */
  79764. export class SpriteSceneComponent implements ISceneComponent {
  79765. /**
  79766. * The component name helpfull to identify the component in the list of scene components.
  79767. */
  79768. readonly name: string;
  79769. /**
  79770. * The scene the component belongs to.
  79771. */
  79772. scene: Scene;
  79773. /** @hidden */
  79774. private _spritePredicate;
  79775. /**
  79776. * Creates a new instance of the component for the given scene
  79777. * @param scene Defines the scene to register the component in
  79778. */
  79779. constructor(scene: Scene);
  79780. /**
  79781. * Registers the component in a given scene
  79782. */
  79783. register(): void;
  79784. /**
  79785. * Rebuilds the elements related to this component in case of
  79786. * context lost for instance.
  79787. */
  79788. rebuild(): void;
  79789. /**
  79790. * Disposes the component and the associated ressources.
  79791. */
  79792. dispose(): void;
  79793. private _pickSpriteButKeepRay;
  79794. private _pointerMove;
  79795. private _pointerDown;
  79796. private _pointerUp;
  79797. }
  79798. }
  79799. declare module BABYLON {
  79800. /** @hidden */
  79801. export var fogFragmentDeclaration: {
  79802. name: string;
  79803. shader: string;
  79804. };
  79805. }
  79806. declare module BABYLON {
  79807. /** @hidden */
  79808. export var fogFragment: {
  79809. name: string;
  79810. shader: string;
  79811. };
  79812. }
  79813. declare module BABYLON {
  79814. /** @hidden */
  79815. export var spritesPixelShader: {
  79816. name: string;
  79817. shader: string;
  79818. };
  79819. }
  79820. declare module BABYLON {
  79821. /** @hidden */
  79822. export var fogVertexDeclaration: {
  79823. name: string;
  79824. shader: string;
  79825. };
  79826. }
  79827. declare module BABYLON {
  79828. /** @hidden */
  79829. export var spritesVertexShader: {
  79830. name: string;
  79831. shader: string;
  79832. };
  79833. }
  79834. declare module BABYLON {
  79835. /**
  79836. * Defines the minimum interface to fullfil in order to be a sprite manager.
  79837. */
  79838. export interface ISpriteManager extends IDisposable {
  79839. /**
  79840. * Restricts the camera to viewing objects with the same layerMask.
  79841. * A camera with a layerMask of 1 will render spriteManager.layerMask & camera.layerMask!== 0
  79842. */
  79843. layerMask: number;
  79844. /**
  79845. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  79846. */
  79847. isPickable: boolean;
  79848. /**
  79849. * Specifies the rendering group id for this mesh (0 by default)
  79850. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  79851. */
  79852. renderingGroupId: number;
  79853. /**
  79854. * Defines the list of sprites managed by the manager.
  79855. */
  79856. sprites: Array<Sprite>;
  79857. /**
  79858. * Tests the intersection of a sprite with a specific ray.
  79859. * @param ray The ray we are sending to test the collision
  79860. * @param camera The camera space we are sending rays in
  79861. * @param predicate A predicate allowing excluding sprites from the list of object to test
  79862. * @param fastCheck Is the hit test done in a OOBB or AOBB fashion the faster, the less precise
  79863. * @returns picking info or null.
  79864. */
  79865. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  79866. /**
  79867. * Intersects the sprites with a ray
  79868. * @param ray defines the ray to intersect with
  79869. * @param camera defines the current active camera
  79870. * @param predicate defines a predicate used to select candidate sprites
  79871. * @returns null if no hit or a PickingInfo array
  79872. */
  79873. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  79874. /**
  79875. * Renders the list of sprites on screen.
  79876. */
  79877. render(): void;
  79878. }
  79879. /**
  79880. * Class used to manage multiple sprites on the same spritesheet
  79881. * @see http://doc.babylonjs.com/babylon101/sprites
  79882. */
  79883. export class SpriteManager implements ISpriteManager {
  79884. /** defines the manager's name */
  79885. name: string;
  79886. /** Gets the list of sprites */
  79887. sprites: Sprite[];
  79888. /** Gets or sets the rendering group id (0 by default) */
  79889. renderingGroupId: number;
  79890. /** Gets or sets camera layer mask */
  79891. layerMask: number;
  79892. /** Gets or sets a boolean indicating if the manager must consider scene fog when rendering */
  79893. fogEnabled: boolean;
  79894. /** Gets or sets a boolean indicating if the sprites are pickable */
  79895. isPickable: boolean;
  79896. /** Defines the default width of a cell in the spritesheet */
  79897. cellWidth: number;
  79898. /** Defines the default height of a cell in the spritesheet */
  79899. cellHeight: number;
  79900. /** Associative array from JSON sprite data file */
  79901. private _cellData;
  79902. /** Array of sprite names from JSON sprite data file */
  79903. private _spriteMap;
  79904. /** True when packed cell data from JSON file is ready*/
  79905. private _packedAndReady;
  79906. /**
  79907. * An event triggered when the manager is disposed.
  79908. */
  79909. onDisposeObservable: Observable<SpriteManager>;
  79910. private _onDisposeObserver;
  79911. /**
  79912. * Callback called when the manager is disposed
  79913. */
  79914. onDispose: () => void;
  79915. private _capacity;
  79916. private _fromPacked;
  79917. private _spriteTexture;
  79918. private _epsilon;
  79919. private _scene;
  79920. private _vertexData;
  79921. private _buffer;
  79922. private _vertexBuffers;
  79923. private _indexBuffer;
  79924. private _effectBase;
  79925. private _effectFog;
  79926. /**
  79927. * Gets or sets the spritesheet texture
  79928. */
  79929. texture: Texture;
  79930. /**
  79931. * Creates a new sprite manager
  79932. * @param name defines the manager's name
  79933. * @param imgUrl defines the sprite sheet url
  79934. * @param capacity defines the maximum allowed number of sprites
  79935. * @param cellSize defines the size of a sprite cell
  79936. * @param scene defines the hosting scene
  79937. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  79938. * @param samplingMode defines the smapling mode to use with spritesheet
  79939. * @param fromPacked set to false; do not alter
  79940. * @param spriteJSON null otherwise a JSON object defining sprite sheet data; do not alter
  79941. */
  79942. constructor(
  79943. /** defines the manager's name */
  79944. name: string, imgUrl: string, capacity: number, cellSize: any, scene: Scene, epsilon?: number, samplingMode?: number, fromPacked?: boolean, spriteJSON?: string | null);
  79945. private _makePacked;
  79946. private _appendSpriteVertex;
  79947. /**
  79948. * Intersects the sprites with a ray
  79949. * @param ray defines the ray to intersect with
  79950. * @param camera defines the current active camera
  79951. * @param predicate defines a predicate used to select candidate sprites
  79952. * @param fastCheck defines if a fast check only must be done (the first potential sprite is will be used and not the closer)
  79953. * @returns null if no hit or a PickingInfo
  79954. */
  79955. intersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean, fastCheck?: boolean): Nullable<PickingInfo>;
  79956. /**
  79957. * Intersects the sprites with a ray
  79958. * @param ray defines the ray to intersect with
  79959. * @param camera defines the current active camera
  79960. * @param predicate defines a predicate used to select candidate sprites
  79961. * @returns null if no hit or a PickingInfo array
  79962. */
  79963. multiIntersects(ray: Ray, camera: Camera, predicate?: (sprite: Sprite) => boolean): Nullable<PickingInfo[]>;
  79964. /**
  79965. * Render all child sprites
  79966. */
  79967. render(): void;
  79968. /**
  79969. * Release associated resources
  79970. */
  79971. dispose(): void;
  79972. }
  79973. }
  79974. declare module BABYLON {
  79975. /**
  79976. * Class used to represent a sprite
  79977. * @see http://doc.babylonjs.com/babylon101/sprites
  79978. */
  79979. export class Sprite {
  79980. /** defines the name */
  79981. name: string;
  79982. /** Gets or sets the current world position */
  79983. position: Vector3;
  79984. /** Gets or sets the main color */
  79985. color: Color4;
  79986. /** Gets or sets the width */
  79987. width: number;
  79988. /** Gets or sets the height */
  79989. height: number;
  79990. /** Gets or sets rotation angle */
  79991. angle: number;
  79992. /** Gets or sets the cell index in the sprite sheet */
  79993. cellIndex: number;
  79994. /** Gets or sets the cell reference in the sprite sheet, uses sprite's filename when added to sprite sheet */
  79995. cellRef: string;
  79996. /** Gets or sets a boolean indicating if UV coordinates should be inverted in U axis */
  79997. invertU: number;
  79998. /** Gets or sets a boolean indicating if UV coordinates should be inverted in B axis */
  79999. invertV: number;
  80000. /** Gets or sets a boolean indicating that this sprite should be disposed after animation ends */
  80001. disposeWhenFinishedAnimating: boolean;
  80002. /** Gets the list of attached animations */
  80003. animations: Animation[];
  80004. /** Gets or sets a boolean indicating if the sprite can be picked */
  80005. isPickable: boolean;
  80006. /**
  80007. * Gets or sets the associated action manager
  80008. */
  80009. actionManager: Nullable<ActionManager>;
  80010. private _animationStarted;
  80011. private _loopAnimation;
  80012. private _fromIndex;
  80013. private _toIndex;
  80014. private _delay;
  80015. private _direction;
  80016. private _manager;
  80017. private _time;
  80018. private _onAnimationEnd;
  80019. /**
  80020. * Gets or sets a boolean indicating if the sprite is visible (renderable). Default is true
  80021. */
  80022. isVisible: boolean;
  80023. /**
  80024. * Gets or sets the sprite size
  80025. */
  80026. size: number;
  80027. /**
  80028. * Creates a new Sprite
  80029. * @param name defines the name
  80030. * @param manager defines the manager
  80031. */
  80032. constructor(
  80033. /** defines the name */
  80034. name: string, manager: ISpriteManager);
  80035. /**
  80036. * Starts an animation
  80037. * @param from defines the initial key
  80038. * @param to defines the end key
  80039. * @param loop defines if the animation must loop
  80040. * @param delay defines the start delay (in ms)
  80041. * @param onAnimationEnd defines a callback to call when animation ends
  80042. */
  80043. playAnimation(from: number, to: number, loop: boolean, delay: number, onAnimationEnd: () => void): void;
  80044. /** Stops current animation (if any) */
  80045. stopAnimation(): void;
  80046. /** @hidden */
  80047. _animate(deltaTime: number): void;
  80048. /** Release associated resources */
  80049. dispose(): void;
  80050. }
  80051. }
  80052. declare module BABYLON {
  80053. /**
  80054. * Information about the result of picking within a scene
  80055. * @see https://doc.babylonjs.com/babylon101/picking_collisions
  80056. */
  80057. export class PickingInfo {
  80058. /** @hidden */
  80059. _pickingUnavailable: boolean;
  80060. /**
  80061. * If the pick collided with an object
  80062. */
  80063. hit: boolean;
  80064. /**
  80065. * Distance away where the pick collided
  80066. */
  80067. distance: number;
  80068. /**
  80069. * The location of pick collision
  80070. */
  80071. pickedPoint: Nullable<Vector3>;
  80072. /**
  80073. * The mesh corresponding the the pick collision
  80074. */
  80075. pickedMesh: Nullable<AbstractMesh>;
  80076. /** (See getTextureCoordinates) The barycentric U coordinate that is used when calculating the texture coordinates of the collision.*/
  80077. bu: number;
  80078. /** (See getTextureCoordinates) The barycentric V coordinate that is used when calculating the texture coordinates of the collision.*/
  80079. bv: number;
  80080. /** The index of the face on the mesh that was picked, or the index of the Line if the picked Mesh is a LinesMesh */
  80081. faceId: number;
  80082. /** Id of the the submesh that was picked */
  80083. subMeshId: number;
  80084. /** If a sprite was picked, this will be the sprite the pick collided with */
  80085. pickedSprite: Nullable<Sprite>;
  80086. /**
  80087. * If a mesh was used to do the picking (eg. 6dof controller) this will be populated.
  80088. */
  80089. originMesh: Nullable<AbstractMesh>;
  80090. /**
  80091. * The ray that was used to perform the picking.
  80092. */
  80093. ray: Nullable<Ray>;
  80094. /**
  80095. * Gets the normal correspodning to the face the pick collided with
  80096. * @param useWorldCoordinates If the resulting normal should be relative to the world (default: false)
  80097. * @param useVerticesNormals If the vertices normals should be used to calculate the normal instead of the normal map
  80098. * @returns The normal correspodning to the face the pick collided with
  80099. */
  80100. getNormal(useWorldCoordinates?: boolean, useVerticesNormals?: boolean): Nullable<Vector3>;
  80101. /**
  80102. * Gets the texture coordinates of where the pick occured
  80103. * @returns the vector containing the coordnates of the texture
  80104. */
  80105. getTextureCoordinates(): Nullable<Vector2>;
  80106. }
  80107. }
  80108. declare module BABYLON {
  80109. /**
  80110. * Gather the list of pointer event types as constants.
  80111. */
  80112. export class PointerEventTypes {
  80113. /**
  80114. * 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.
  80115. */
  80116. static readonly POINTERDOWN: number;
  80117. /**
  80118. * The pointerup event is fired when a pointer is no longer active.
  80119. */
  80120. static readonly POINTERUP: number;
  80121. /**
  80122. * The pointermove event is fired when a pointer changes coordinates.
  80123. */
  80124. static readonly POINTERMOVE: number;
  80125. /**
  80126. * The pointerwheel event is fired when a mouse wheel has been rotated.
  80127. */
  80128. static readonly POINTERWHEEL: number;
  80129. /**
  80130. * The pointerpick event is fired when a mesh or sprite has been picked by the pointer.
  80131. */
  80132. static readonly POINTERPICK: number;
  80133. /**
  80134. * The pointertap event is fired when a the object has been touched and released without drag.
  80135. */
  80136. static readonly POINTERTAP: number;
  80137. /**
  80138. * The pointerdoubletap event is fired when a the object has been touched and released twice without drag.
  80139. */
  80140. static readonly POINTERDOUBLETAP: number;
  80141. }
  80142. /**
  80143. * Base class of pointer info types.
  80144. */
  80145. export class PointerInfoBase {
  80146. /**
  80147. * Defines the type of event (PointerEventTypes)
  80148. */
  80149. type: number;
  80150. /**
  80151. * Defines the related dom event
  80152. */
  80153. event: PointerEvent | MouseWheelEvent;
  80154. /**
  80155. * Instantiates the base class of pointers info.
  80156. * @param type Defines the type of event (PointerEventTypes)
  80157. * @param event Defines the related dom event
  80158. */
  80159. constructor(
  80160. /**
  80161. * Defines the type of event (PointerEventTypes)
  80162. */
  80163. type: number,
  80164. /**
  80165. * Defines the related dom event
  80166. */
  80167. event: PointerEvent | MouseWheelEvent);
  80168. }
  80169. /**
  80170. * This class is used to store pointer related info for the onPrePointerObservable event.
  80171. * Set the skipOnPointerObservable property to true if you want the engine to stop any process after this event is triggered, even not calling onPointerObservable
  80172. */
  80173. export class PointerInfoPre extends PointerInfoBase {
  80174. /**
  80175. * Ray from a pointer if availible (eg. 6dof controller)
  80176. */
  80177. ray: Nullable<Ray>;
  80178. /**
  80179. * Defines the local position of the pointer on the canvas.
  80180. */
  80181. localPosition: Vector2;
  80182. /**
  80183. * Defines whether the engine should skip the next OnPointerObservable associated to this pre.
  80184. */
  80185. skipOnPointerObservable: boolean;
  80186. /**
  80187. * Instantiates a PointerInfoPre to store pointer related info to the onPrePointerObservable event.
  80188. * @param type Defines the type of event (PointerEventTypes)
  80189. * @param event Defines the related dom event
  80190. * @param localX Defines the local x coordinates of the pointer when the event occured
  80191. * @param localY Defines the local y coordinates of the pointer when the event occured
  80192. */
  80193. constructor(type: number, event: PointerEvent | MouseWheelEvent, localX: number, localY: number);
  80194. }
  80195. /**
  80196. * This type contains all the data related to a pointer event in Babylon.js.
  80197. * 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.
  80198. */
  80199. export class PointerInfo extends PointerInfoBase {
  80200. /**
  80201. * Defines the picking info associated to the info (if any)\
  80202. */
  80203. pickInfo: Nullable<PickingInfo>;
  80204. /**
  80205. * Instantiates a PointerInfo to store pointer related info to the onPointerObservable event.
  80206. * @param type Defines the type of event (PointerEventTypes)
  80207. * @param event Defines the related dom event
  80208. * @param pickInfo Defines the picking info associated to the info (if any)\
  80209. */
  80210. constructor(type: number, event: PointerEvent | MouseWheelEvent,
  80211. /**
  80212. * Defines the picking info associated to the info (if any)\
  80213. */
  80214. pickInfo: Nullable<PickingInfo>);
  80215. }
  80216. /**
  80217. * Data relating to a touch event on the screen.
  80218. */
  80219. export interface PointerTouch {
  80220. /**
  80221. * X coordinate of touch.
  80222. */
  80223. x: number;
  80224. /**
  80225. * Y coordinate of touch.
  80226. */
  80227. y: number;
  80228. /**
  80229. * Id of touch. Unique for each finger.
  80230. */
  80231. pointerId: number;
  80232. /**
  80233. * Event type passed from DOM.
  80234. */
  80235. type: any;
  80236. }
  80237. }
  80238. declare module BABYLON {
  80239. /**
  80240. * Manage the mouse inputs to control the movement of a free camera.
  80241. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  80242. */
  80243. export class FreeCameraMouseInput implements ICameraInput<FreeCamera> {
  80244. /**
  80245. * Define if touch is enabled in the mouse input
  80246. */
  80247. touchEnabled: boolean;
  80248. /**
  80249. * Defines the camera the input is attached to.
  80250. */
  80251. camera: FreeCamera;
  80252. /**
  80253. * Defines the buttons associated with the input to handle camera move.
  80254. */
  80255. buttons: number[];
  80256. /**
  80257. * Defines the pointer angular sensibility along the X and Y axis or how fast is the camera rotating.
  80258. */
  80259. angularSensibility: number;
  80260. private _pointerInput;
  80261. private _onMouseMove;
  80262. private _observer;
  80263. private previousPosition;
  80264. /**
  80265. * Observable for when a pointer move event occurs containing the move offset
  80266. */
  80267. onPointerMovedObservable: Observable<{
  80268. offsetX: number;
  80269. offsetY: number;
  80270. }>;
  80271. /**
  80272. * @hidden
  80273. * If the camera should be rotated automatically based on pointer movement
  80274. */
  80275. _allowCameraRotation: boolean;
  80276. /**
  80277. * Manage the mouse inputs to control the movement of a free camera.
  80278. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  80279. * @param touchEnabled Defines if touch is enabled or not
  80280. */
  80281. constructor(
  80282. /**
  80283. * Define if touch is enabled in the mouse input
  80284. */
  80285. touchEnabled?: boolean);
  80286. /**
  80287. * Attach the input controls to a specific dom element to get the input from.
  80288. * @param element Defines the element the controls should be listened from
  80289. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  80290. */
  80291. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  80292. /**
  80293. * Called on JS contextmenu event.
  80294. * Override this method to provide functionality.
  80295. */
  80296. protected onContextMenu(evt: PointerEvent): void;
  80297. /**
  80298. * Detach the current controls from the specified dom element.
  80299. * @param element Defines the element to stop listening the inputs from
  80300. */
  80301. detachControl(element: Nullable<HTMLElement>): void;
  80302. /**
  80303. * Gets the class name of the current intput.
  80304. * @returns the class name
  80305. */
  80306. getClassName(): string;
  80307. /**
  80308. * Get the friendly name associated with the input class.
  80309. * @returns the input friendly name
  80310. */
  80311. getSimpleName(): string;
  80312. }
  80313. }
  80314. declare module BABYLON {
  80315. /**
  80316. * Manage the touch inputs to control the movement of a free camera.
  80317. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  80318. */
  80319. export class FreeCameraTouchInput implements ICameraInput<FreeCamera> {
  80320. /**
  80321. * Defines the camera the input is attached to.
  80322. */
  80323. camera: FreeCamera;
  80324. /**
  80325. * Defines the touch sensibility for rotation.
  80326. * The higher the faster.
  80327. */
  80328. touchAngularSensibility: number;
  80329. /**
  80330. * Defines the touch sensibility for move.
  80331. * The higher the faster.
  80332. */
  80333. touchMoveSensibility: number;
  80334. private _offsetX;
  80335. private _offsetY;
  80336. private _pointerPressed;
  80337. private _pointerInput;
  80338. private _observer;
  80339. private _onLostFocus;
  80340. /**
  80341. * Attach the input controls to a specific dom element to get the input from.
  80342. * @param element Defines the element the controls should be listened from
  80343. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  80344. */
  80345. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  80346. /**
  80347. * Detach the current controls from the specified dom element.
  80348. * @param element Defines the element to stop listening the inputs from
  80349. */
  80350. detachControl(element: Nullable<HTMLElement>): void;
  80351. /**
  80352. * Update the current camera state depending on the inputs that have been used this frame.
  80353. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  80354. */
  80355. checkInputs(): void;
  80356. /**
  80357. * Gets the class name of the current intput.
  80358. * @returns the class name
  80359. */
  80360. getClassName(): string;
  80361. /**
  80362. * Get the friendly name associated with the input class.
  80363. * @returns the input friendly name
  80364. */
  80365. getSimpleName(): string;
  80366. }
  80367. }
  80368. declare module BABYLON {
  80369. /**
  80370. * Default Inputs manager for the FreeCamera.
  80371. * It groups all the default supported inputs for ease of use.
  80372. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  80373. */
  80374. export class FreeCameraInputsManager extends CameraInputsManager<FreeCamera> {
  80375. /**
  80376. * @hidden
  80377. */
  80378. _mouseInput: Nullable<FreeCameraMouseInput>;
  80379. /**
  80380. * Instantiates a new FreeCameraInputsManager.
  80381. * @param camera Defines the camera the inputs belong to
  80382. */
  80383. constructor(camera: FreeCamera);
  80384. /**
  80385. * Add keyboard input support to the input manager.
  80386. * @returns the current input manager
  80387. */
  80388. addKeyboard(): FreeCameraInputsManager;
  80389. /**
  80390. * Add mouse input support to the input manager.
  80391. * @param touchEnabled if the FreeCameraMouseInput should support touch (default: true)
  80392. * @returns the current input manager
  80393. */
  80394. addMouse(touchEnabled?: boolean): FreeCameraInputsManager;
  80395. /**
  80396. * Removes the mouse input support from the manager
  80397. * @returns the current input manager
  80398. */
  80399. removeMouse(): FreeCameraInputsManager;
  80400. /**
  80401. * Add touch input support to the input manager.
  80402. * @returns the current input manager
  80403. */
  80404. addTouch(): FreeCameraInputsManager;
  80405. /**
  80406. * Remove all attached input methods from a camera
  80407. */
  80408. clear(): void;
  80409. }
  80410. }
  80411. declare module BABYLON {
  80412. /**
  80413. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  80414. * Please consider using the new UniversalCamera instead as it adds more functionality like the gamepad.
  80415. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  80416. */
  80417. export class FreeCamera extends TargetCamera {
  80418. /**
  80419. * Define the collision ellipsoid of the camera.
  80420. * This is helpful to simulate a camera body like the player body around the camera
  80421. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  80422. */
  80423. ellipsoid: Vector3;
  80424. /**
  80425. * Define an offset for the position of the ellipsoid around the camera.
  80426. * This can be helpful to determine the center of the body near the gravity center of the body
  80427. * instead of its head.
  80428. */
  80429. ellipsoidOffset: Vector3;
  80430. /**
  80431. * Enable or disable collisions of the camera with the rest of the scene objects.
  80432. */
  80433. checkCollisions: boolean;
  80434. /**
  80435. * Enable or disable gravity on the camera.
  80436. */
  80437. applyGravity: boolean;
  80438. /**
  80439. * Define the input manager associated to the camera.
  80440. */
  80441. inputs: FreeCameraInputsManager;
  80442. /**
  80443. * Gets the input sensibility for a mouse input. (default is 2000.0)
  80444. * Higher values reduce sensitivity.
  80445. */
  80446. /**
  80447. * Sets the input sensibility for a mouse input. (default is 2000.0)
  80448. * Higher values reduce sensitivity.
  80449. */
  80450. angularSensibility: number;
  80451. /**
  80452. * Gets or Set the list of keyboard keys used to control the forward move of the camera.
  80453. */
  80454. keysUp: number[];
  80455. /**
  80456. * Gets or Set the list of keyboard keys used to control the backward move of the camera.
  80457. */
  80458. keysDown: number[];
  80459. /**
  80460. * Gets or Set the list of keyboard keys used to control the left strafe move of the camera.
  80461. */
  80462. keysLeft: number[];
  80463. /**
  80464. * Gets or Set the list of keyboard keys used to control the right strafe move of the camera.
  80465. */
  80466. keysRight: number[];
  80467. /**
  80468. * Event raised when the camera collide with a mesh in the scene.
  80469. */
  80470. onCollide: (collidedMesh: AbstractMesh) => void;
  80471. private _collider;
  80472. private _needMoveForGravity;
  80473. private _oldPosition;
  80474. private _diffPosition;
  80475. private _newPosition;
  80476. /** @hidden */
  80477. _localDirection: Vector3;
  80478. /** @hidden */
  80479. _transformedDirection: Vector3;
  80480. /**
  80481. * Instantiates a Free Camera.
  80482. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  80483. * Please consider using the new UniversalCamera instead as it adds more functionality like touch to this camera.
  80484. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  80485. * @param name Define the name of the camera in the scene
  80486. * @param position Define the start position of the camera in the scene
  80487. * @param scene Define the scene the camera belongs to
  80488. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  80489. */
  80490. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  80491. /**
  80492. * Attached controls to the current camera.
  80493. * @param element Defines the element the controls should be listened from
  80494. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  80495. */
  80496. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  80497. /**
  80498. * Detach the current controls from the camera.
  80499. * The camera will stop reacting to inputs.
  80500. * @param element Defines the element to stop listening the inputs from
  80501. */
  80502. detachControl(element: HTMLElement): void;
  80503. private _collisionMask;
  80504. /**
  80505. * Define a collision mask to limit the list of object the camera can collide with
  80506. */
  80507. collisionMask: number;
  80508. /** @hidden */
  80509. _collideWithWorld(displacement: Vector3): void;
  80510. private _onCollisionPositionChange;
  80511. /** @hidden */
  80512. _checkInputs(): void;
  80513. /** @hidden */
  80514. _decideIfNeedsToMove(): boolean;
  80515. /** @hidden */
  80516. _updatePosition(): void;
  80517. /**
  80518. * Destroy the camera and release the current resources hold by it.
  80519. */
  80520. dispose(): void;
  80521. /**
  80522. * Gets the current object class name.
  80523. * @return the class name
  80524. */
  80525. getClassName(): string;
  80526. }
  80527. }
  80528. declare module BABYLON {
  80529. /**
  80530. * Represents a gamepad control stick position
  80531. */
  80532. export class StickValues {
  80533. /**
  80534. * The x component of the control stick
  80535. */
  80536. x: number;
  80537. /**
  80538. * The y component of the control stick
  80539. */
  80540. y: number;
  80541. /**
  80542. * Initializes the gamepad x and y control stick values
  80543. * @param x The x component of the gamepad control stick value
  80544. * @param y The y component of the gamepad control stick value
  80545. */
  80546. constructor(
  80547. /**
  80548. * The x component of the control stick
  80549. */
  80550. x: number,
  80551. /**
  80552. * The y component of the control stick
  80553. */
  80554. y: number);
  80555. }
  80556. /**
  80557. * An interface which manages callbacks for gamepad button changes
  80558. */
  80559. export interface GamepadButtonChanges {
  80560. /**
  80561. * Called when a gamepad has been changed
  80562. */
  80563. changed: boolean;
  80564. /**
  80565. * Called when a gamepad press event has been triggered
  80566. */
  80567. pressChanged: boolean;
  80568. /**
  80569. * Called when a touch event has been triggered
  80570. */
  80571. touchChanged: boolean;
  80572. /**
  80573. * Called when a value has changed
  80574. */
  80575. valueChanged: boolean;
  80576. }
  80577. /**
  80578. * Represents a gamepad
  80579. */
  80580. export class Gamepad {
  80581. /**
  80582. * The id of the gamepad
  80583. */
  80584. id: string;
  80585. /**
  80586. * The index of the gamepad
  80587. */
  80588. index: number;
  80589. /**
  80590. * The browser gamepad
  80591. */
  80592. browserGamepad: any;
  80593. /**
  80594. * Specifies what type of gamepad this represents
  80595. */
  80596. type: number;
  80597. private _leftStick;
  80598. private _rightStick;
  80599. /** @hidden */
  80600. _isConnected: boolean;
  80601. private _leftStickAxisX;
  80602. private _leftStickAxisY;
  80603. private _rightStickAxisX;
  80604. private _rightStickAxisY;
  80605. /**
  80606. * Triggered when the left control stick has been changed
  80607. */
  80608. private _onleftstickchanged;
  80609. /**
  80610. * Triggered when the right control stick has been changed
  80611. */
  80612. private _onrightstickchanged;
  80613. /**
  80614. * Represents a gamepad controller
  80615. */
  80616. static GAMEPAD: number;
  80617. /**
  80618. * Represents a generic controller
  80619. */
  80620. static GENERIC: number;
  80621. /**
  80622. * Represents an XBox controller
  80623. */
  80624. static XBOX: number;
  80625. /**
  80626. * Represents a pose-enabled controller
  80627. */
  80628. static POSE_ENABLED: number;
  80629. /**
  80630. * Represents an Dual Shock controller
  80631. */
  80632. static DUALSHOCK: number;
  80633. /**
  80634. * Specifies whether the left control stick should be Y-inverted
  80635. */
  80636. protected _invertLeftStickY: boolean;
  80637. /**
  80638. * Specifies if the gamepad has been connected
  80639. */
  80640. readonly isConnected: boolean;
  80641. /**
  80642. * Initializes the gamepad
  80643. * @param id The id of the gamepad
  80644. * @param index The index of the gamepad
  80645. * @param browserGamepad The browser gamepad
  80646. * @param leftStickX The x component of the left joystick
  80647. * @param leftStickY The y component of the left joystick
  80648. * @param rightStickX The x component of the right joystick
  80649. * @param rightStickY The y component of the right joystick
  80650. */
  80651. constructor(
  80652. /**
  80653. * The id of the gamepad
  80654. */
  80655. id: string,
  80656. /**
  80657. * The index of the gamepad
  80658. */
  80659. index: number,
  80660. /**
  80661. * The browser gamepad
  80662. */
  80663. browserGamepad: any, leftStickX?: number, leftStickY?: number, rightStickX?: number, rightStickY?: number);
  80664. /**
  80665. * Callback triggered when the left joystick has changed
  80666. * @param callback
  80667. */
  80668. onleftstickchanged(callback: (values: StickValues) => void): void;
  80669. /**
  80670. * Callback triggered when the right joystick has changed
  80671. * @param callback
  80672. */
  80673. onrightstickchanged(callback: (values: StickValues) => void): void;
  80674. /**
  80675. * Gets the left joystick
  80676. */
  80677. /**
  80678. * Sets the left joystick values
  80679. */
  80680. leftStick: StickValues;
  80681. /**
  80682. * Gets the right joystick
  80683. */
  80684. /**
  80685. * Sets the right joystick value
  80686. */
  80687. rightStick: StickValues;
  80688. /**
  80689. * Updates the gamepad joystick positions
  80690. */
  80691. update(): void;
  80692. /**
  80693. * Disposes the gamepad
  80694. */
  80695. dispose(): void;
  80696. }
  80697. /**
  80698. * Represents a generic gamepad
  80699. */
  80700. export class GenericPad extends Gamepad {
  80701. private _buttons;
  80702. private _onbuttondown;
  80703. private _onbuttonup;
  80704. /**
  80705. * Observable triggered when a button has been pressed
  80706. */
  80707. onButtonDownObservable: Observable<number>;
  80708. /**
  80709. * Observable triggered when a button has been released
  80710. */
  80711. onButtonUpObservable: Observable<number>;
  80712. /**
  80713. * Callback triggered when a button has been pressed
  80714. * @param callback Called when a button has been pressed
  80715. */
  80716. onbuttondown(callback: (buttonPressed: number) => void): void;
  80717. /**
  80718. * Callback triggered when a button has been released
  80719. * @param callback Called when a button has been released
  80720. */
  80721. onbuttonup(callback: (buttonReleased: number) => void): void;
  80722. /**
  80723. * Initializes the generic gamepad
  80724. * @param id The id of the generic gamepad
  80725. * @param index The index of the generic gamepad
  80726. * @param browserGamepad The browser gamepad
  80727. */
  80728. constructor(id: string, index: number, browserGamepad: any);
  80729. private _setButtonValue;
  80730. /**
  80731. * Updates the generic gamepad
  80732. */
  80733. update(): void;
  80734. /**
  80735. * Disposes the generic gamepad
  80736. */
  80737. dispose(): void;
  80738. }
  80739. }
  80740. declare module BABYLON {
  80741. interface Engine {
  80742. /**
  80743. * Creates a raw texture
  80744. * @param data defines the data to store in the texture
  80745. * @param width defines the width of the texture
  80746. * @param height defines the height of the texture
  80747. * @param format defines the format of the data
  80748. * @param generateMipMaps defines if the engine should generate the mip levels
  80749. * @param invertY defines if data must be stored with Y axis inverted
  80750. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  80751. * @param compression defines the compression used (null by default)
  80752. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  80753. * @returns the raw texture inside an InternalTexture
  80754. */
  80755. createRawTexture(data: Nullable<ArrayBufferView>, width: number, height: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, type: number): InternalTexture;
  80756. /**
  80757. * Update a raw texture
  80758. * @param texture defines the texture to update
  80759. * @param data defines the data to store in the texture
  80760. * @param format defines the format of the data
  80761. * @param invertY defines if data must be stored with Y axis inverted
  80762. */
  80763. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  80764. /**
  80765. * Update a raw texture
  80766. * @param texture defines the texture to update
  80767. * @param data defines the data to store in the texture
  80768. * @param format defines the format of the data
  80769. * @param invertY defines if data must be stored with Y axis inverted
  80770. * @param compression defines the compression used (null by default)
  80771. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  80772. */
  80773. updateRawTexture(texture: Nullable<InternalTexture>, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, type: number): void;
  80774. /**
  80775. * Creates a new raw cube texture
  80776. * @param data defines the array of data to use to create each face
  80777. * @param size defines the size of the textures
  80778. * @param format defines the format of the data
  80779. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  80780. * @param generateMipMaps defines if the engine should generate the mip levels
  80781. * @param invertY defines if data must be stored with Y axis inverted
  80782. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  80783. * @param compression defines the compression used (null by default)
  80784. * @returns the cube texture as an InternalTexture
  80785. */
  80786. createRawCubeTexture(data: Nullable<ArrayBufferView[]>, size: number, format: number, type: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>): InternalTexture;
  80787. /**
  80788. * Update a raw cube texture
  80789. * @param texture defines the texture to udpdate
  80790. * @param data defines the data to store
  80791. * @param format defines the data format
  80792. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  80793. * @param invertY defines if data must be stored with Y axis inverted
  80794. */
  80795. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean): void;
  80796. /**
  80797. * Update a raw cube texture
  80798. * @param texture defines the texture to udpdate
  80799. * @param data defines the data to store
  80800. * @param format defines the data format
  80801. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  80802. * @param invertY defines if data must be stored with Y axis inverted
  80803. * @param compression defines the compression used (null by default)
  80804. */
  80805. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>): void;
  80806. /**
  80807. * Update a raw cube texture
  80808. * @param texture defines the texture to udpdate
  80809. * @param data defines the data to store
  80810. * @param format defines the data format
  80811. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  80812. * @param invertY defines if data must be stored with Y axis inverted
  80813. * @param compression defines the compression used (null by default)
  80814. * @param level defines which level of the texture to update
  80815. */
  80816. updateRawCubeTexture(texture: InternalTexture, data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression: Nullable<string>, level: number): void;
  80817. /**
  80818. * Creates a new raw cube texture from a specified url
  80819. * @param url defines the url where the data is located
  80820. * @param scene defines the current scene
  80821. * @param size defines the size of the textures
  80822. * @param format defines the format of the data
  80823. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  80824. * @param noMipmap defines if the engine should avoid generating the mip levels
  80825. * @param callback defines a callback used to extract texture data from loaded data
  80826. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  80827. * @param onLoad defines a callback called when texture is loaded
  80828. * @param onError defines a callback called if there is an error
  80829. * @returns the cube texture as an InternalTexture
  80830. */
  80831. 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;
  80832. /**
  80833. * Creates a new raw cube texture from a specified url
  80834. * @param url defines the url where the data is located
  80835. * @param scene defines the current scene
  80836. * @param size defines the size of the textures
  80837. * @param format defines the format of the data
  80838. * @param type defines the type fo the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  80839. * @param noMipmap defines if the engine should avoid generating the mip levels
  80840. * @param callback defines a callback used to extract texture data from loaded data
  80841. * @param mipmapGenerator defines to provide an optional tool to generate mip levels
  80842. * @param onLoad defines a callback called when texture is loaded
  80843. * @param onError defines a callback called if there is an error
  80844. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  80845. * @param invertY defines if data must be stored with Y axis inverted
  80846. * @returns the cube texture as an InternalTexture
  80847. */
  80848. 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;
  80849. /**
  80850. * Creates a new raw 3D texture
  80851. * @param data defines the data used to create the texture
  80852. * @param width defines the width of the texture
  80853. * @param height defines the height of the texture
  80854. * @param depth defines the depth of the texture
  80855. * @param format defines the format of the texture
  80856. * @param generateMipMaps defines if the engine must generate mip levels
  80857. * @param invertY defines if data must be stored with Y axis inverted
  80858. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  80859. * @param compression defines the compressed used (can be null)
  80860. * @param textureType defines the compressed used (can be null)
  80861. * @returns a new raw 3D texture (stored in an InternalTexture)
  80862. */
  80863. createRawTexture3D(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  80864. /**
  80865. * Update a raw 3D texture
  80866. * @param texture defines the texture to update
  80867. * @param data defines the data to store
  80868. * @param format defines the data format
  80869. * @param invertY defines if data must be stored with Y axis inverted
  80870. */
  80871. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  80872. /**
  80873. * Update a raw 3D texture
  80874. * @param texture defines the texture to update
  80875. * @param data defines the data to store
  80876. * @param format defines the data format
  80877. * @param invertY defines if data must be stored with Y axis inverted
  80878. * @param compression defines the used compression (can be null)
  80879. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  80880. */
  80881. updateRawTexture3D(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  80882. /**
  80883. * Creates a new raw 2D array texture
  80884. * @param data defines the data used to create the texture
  80885. * @param width defines the width of the texture
  80886. * @param height defines the height of the texture
  80887. * @param depth defines the number of layers of the texture
  80888. * @param format defines the format of the texture
  80889. * @param generateMipMaps defines if the engine must generate mip levels
  80890. * @param invertY defines if data must be stored with Y axis inverted
  80891. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  80892. * @param compression defines the compressed used (can be null)
  80893. * @param textureType defines the compressed used (can be null)
  80894. * @returns a new raw 2D array texture (stored in an InternalTexture)
  80895. */
  80896. createRawTexture2DArray(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression: Nullable<string>, textureType: number): InternalTexture;
  80897. /**
  80898. * Update a raw 2D array texture
  80899. * @param texture defines the texture to update
  80900. * @param data defines the data to store
  80901. * @param format defines the data format
  80902. * @param invertY defines if data must be stored with Y axis inverted
  80903. */
  80904. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean): void;
  80905. /**
  80906. * Update a raw 2D array texture
  80907. * @param texture defines the texture to update
  80908. * @param data defines the data to store
  80909. * @param format defines the data format
  80910. * @param invertY defines if data must be stored with Y axis inverted
  80911. * @param compression defines the used compression (can be null)
  80912. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  80913. */
  80914. updateRawTexture2DArray(texture: InternalTexture, data: Nullable<ArrayBufferView>, format: number, invertY: boolean, compression: Nullable<string>, textureType: number): void;
  80915. }
  80916. }
  80917. declare module BABYLON {
  80918. /**
  80919. * Raw texture can help creating a texture directly from an array of data.
  80920. * This can be super useful if you either get the data from an uncompressed source or
  80921. * if you wish to create your texture pixel by pixel.
  80922. */
  80923. export class RawTexture extends Texture {
  80924. /**
  80925. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  80926. */
  80927. format: number;
  80928. private _engine;
  80929. /**
  80930. * Instantiates a new RawTexture.
  80931. * Raw texture can help creating a texture directly from an array of data.
  80932. * This can be super useful if you either get the data from an uncompressed source or
  80933. * if you wish to create your texture pixel by pixel.
  80934. * @param data define the array of data to use to create the texture
  80935. * @param width define the width of the texture
  80936. * @param height define the height of the texture
  80937. * @param format define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  80938. * @param scene define the scene the texture belongs to
  80939. * @param generateMipMaps define whether mip maps should be generated or not
  80940. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  80941. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  80942. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  80943. */
  80944. constructor(data: ArrayBufferView, width: number, height: number,
  80945. /**
  80946. * Define the format of the data (RGB, RGBA... Engine.TEXTUREFORMAT_xxx)
  80947. */
  80948. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number);
  80949. /**
  80950. * Updates the texture underlying data.
  80951. * @param data Define the new data of the texture
  80952. */
  80953. update(data: ArrayBufferView): void;
  80954. /**
  80955. * Creates a luminance texture from some data.
  80956. * @param data Define the texture data
  80957. * @param width Define the width of the texture
  80958. * @param height Define the height of the texture
  80959. * @param scene Define the scene the texture belongs to
  80960. * @param generateMipMaps Define whether or not to create mip maps for the texture
  80961. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  80962. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  80963. * @returns the luminance texture
  80964. */
  80965. static CreateLuminanceTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  80966. /**
  80967. * Creates a luminance alpha texture from some data.
  80968. * @param data Define the texture data
  80969. * @param width Define the width of the texture
  80970. * @param height Define the height of the texture
  80971. * @param scene Define the scene the texture belongs to
  80972. * @param generateMipMaps Define whether or not to create mip maps for the texture
  80973. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  80974. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  80975. * @returns the luminance alpha texture
  80976. */
  80977. static CreateLuminanceAlphaTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  80978. /**
  80979. * Creates an alpha texture from some data.
  80980. * @param data Define the texture data
  80981. * @param width Define the width of the texture
  80982. * @param height Define the height of the texture
  80983. * @param scene Define the scene the texture belongs to
  80984. * @param generateMipMaps Define whether or not to create mip maps for the texture
  80985. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  80986. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  80987. * @returns the alpha texture
  80988. */
  80989. static CreateAlphaTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number): RawTexture;
  80990. /**
  80991. * Creates a RGB texture from some data.
  80992. * @param data Define the texture data
  80993. * @param width Define the width of the texture
  80994. * @param height Define the height of the texture
  80995. * @param scene Define the scene the texture belongs to
  80996. * @param generateMipMaps Define whether or not to create mip maps for the texture
  80997. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  80998. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  80999. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  81000. * @returns the RGB alpha texture
  81001. */
  81002. static CreateRGBTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  81003. /**
  81004. * Creates a RGBA texture from some data.
  81005. * @param data Define the texture data
  81006. * @param width Define the width of the texture
  81007. * @param height Define the height of the texture
  81008. * @param scene Define the scene the texture belongs to
  81009. * @param generateMipMaps Define whether or not to create mip maps for the texture
  81010. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  81011. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  81012. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  81013. * @returns the RGBA texture
  81014. */
  81015. static CreateRGBATexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  81016. /**
  81017. * Creates a R texture from some data.
  81018. * @param data Define the texture data
  81019. * @param width Define the width of the texture
  81020. * @param height Define the height of the texture
  81021. * @param scene Define the scene the texture belongs to
  81022. * @param generateMipMaps Define whether or not to create mip maps for the texture
  81023. * @param invertY define if the data should be flipped on Y when uploaded to the GPU
  81024. * @param samplingMode define the texture sampling mode (Texture.xxx_SAMPLINGMODE)
  81025. * @param type define the format of the data (int, float... Engine.TEXTURETYPE_xxx)
  81026. * @returns the R texture
  81027. */
  81028. static CreateRTexture(data: ArrayBufferView, width: number, height: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, type?: number): RawTexture;
  81029. }
  81030. }
  81031. declare module BABYLON {
  81032. /**
  81033. * Interface for the size containing width and height
  81034. */
  81035. export interface ISize {
  81036. /**
  81037. * Width
  81038. */
  81039. width: number;
  81040. /**
  81041. * Heighht
  81042. */
  81043. height: number;
  81044. }
  81045. /**
  81046. * Size containing widht and height
  81047. */
  81048. export class Size implements ISize {
  81049. /**
  81050. * Width
  81051. */
  81052. width: number;
  81053. /**
  81054. * Height
  81055. */
  81056. height: number;
  81057. /**
  81058. * Creates a Size object from the given width and height (floats).
  81059. * @param width width of the new size
  81060. * @param height height of the new size
  81061. */
  81062. constructor(width: number, height: number);
  81063. /**
  81064. * Returns a string with the Size width and height
  81065. * @returns a string with the Size width and height
  81066. */
  81067. toString(): string;
  81068. /**
  81069. * "Size"
  81070. * @returns the string "Size"
  81071. */
  81072. getClassName(): string;
  81073. /**
  81074. * Returns the Size hash code.
  81075. * @returns a hash code for a unique width and height
  81076. */
  81077. getHashCode(): number;
  81078. /**
  81079. * Updates the current size from the given one.
  81080. * @param src the given size
  81081. */
  81082. copyFrom(src: Size): void;
  81083. /**
  81084. * Updates in place the current Size from the given floats.
  81085. * @param width width of the new size
  81086. * @param height height of the new size
  81087. * @returns the updated Size.
  81088. */
  81089. copyFromFloats(width: number, height: number): Size;
  81090. /**
  81091. * Updates in place the current Size from the given floats.
  81092. * @param width width to set
  81093. * @param height height to set
  81094. * @returns the updated Size.
  81095. */
  81096. set(width: number, height: number): Size;
  81097. /**
  81098. * Multiplies the width and height by numbers
  81099. * @param w factor to multiple the width by
  81100. * @param h factor to multiple the height by
  81101. * @returns a new Size set with the multiplication result of the current Size and the given floats.
  81102. */
  81103. multiplyByFloats(w: number, h: number): Size;
  81104. /**
  81105. * Clones the size
  81106. * @returns a new Size copied from the given one.
  81107. */
  81108. clone(): Size;
  81109. /**
  81110. * True if the current Size and the given one width and height are strictly equal.
  81111. * @param other the other size to compare against
  81112. * @returns True if the current Size and the given one width and height are strictly equal.
  81113. */
  81114. equals(other: Size): boolean;
  81115. /**
  81116. * The surface of the Size : width * height (float).
  81117. */
  81118. readonly surface: number;
  81119. /**
  81120. * Create a new size of zero
  81121. * @returns a new Size set to (0.0, 0.0)
  81122. */
  81123. static Zero(): Size;
  81124. /**
  81125. * Sums the width and height of two sizes
  81126. * @param otherSize size to add to this size
  81127. * @returns a new Size set as the addition result of the current Size and the given one.
  81128. */
  81129. add(otherSize: Size): Size;
  81130. /**
  81131. * Subtracts the width and height of two
  81132. * @param otherSize size to subtract to this size
  81133. * @returns a new Size set as the subtraction result of the given one from the current Size.
  81134. */
  81135. subtract(otherSize: Size): Size;
  81136. /**
  81137. * Creates a new Size set at the linear interpolation "amount" between "start" and "end"
  81138. * @param start starting size to lerp between
  81139. * @param end end size to lerp between
  81140. * @param amount amount to lerp between the start and end values
  81141. * @returns a new Size set at the linear interpolation "amount" between "start" and "end"
  81142. */
  81143. static Lerp(start: Size, end: Size, amount: number): Size;
  81144. }
  81145. }
  81146. declare module BABYLON {
  81147. /**
  81148. * Defines a runtime animation
  81149. */
  81150. export class RuntimeAnimation {
  81151. private _events;
  81152. /**
  81153. * The current frame of the runtime animation
  81154. */
  81155. private _currentFrame;
  81156. /**
  81157. * The animation used by the runtime animation
  81158. */
  81159. private _animation;
  81160. /**
  81161. * The target of the runtime animation
  81162. */
  81163. private _target;
  81164. /**
  81165. * The initiating animatable
  81166. */
  81167. private _host;
  81168. /**
  81169. * The original value of the runtime animation
  81170. */
  81171. private _originalValue;
  81172. /**
  81173. * The original blend value of the runtime animation
  81174. */
  81175. private _originalBlendValue;
  81176. /**
  81177. * The offsets cache of the runtime animation
  81178. */
  81179. private _offsetsCache;
  81180. /**
  81181. * The high limits cache of the runtime animation
  81182. */
  81183. private _highLimitsCache;
  81184. /**
  81185. * Specifies if the runtime animation has been stopped
  81186. */
  81187. private _stopped;
  81188. /**
  81189. * The blending factor of the runtime animation
  81190. */
  81191. private _blendingFactor;
  81192. /**
  81193. * The BabylonJS scene
  81194. */
  81195. private _scene;
  81196. /**
  81197. * The current value of the runtime animation
  81198. */
  81199. private _currentValue;
  81200. /** @hidden */
  81201. _animationState: _IAnimationState;
  81202. /**
  81203. * The active target of the runtime animation
  81204. */
  81205. private _activeTargets;
  81206. private _currentActiveTarget;
  81207. private _directTarget;
  81208. /**
  81209. * The target path of the runtime animation
  81210. */
  81211. private _targetPath;
  81212. /**
  81213. * The weight of the runtime animation
  81214. */
  81215. private _weight;
  81216. /**
  81217. * The ratio offset of the runtime animation
  81218. */
  81219. private _ratioOffset;
  81220. /**
  81221. * The previous delay of the runtime animation
  81222. */
  81223. private _previousDelay;
  81224. /**
  81225. * The previous ratio of the runtime animation
  81226. */
  81227. private _previousRatio;
  81228. private _enableBlending;
  81229. private _keys;
  81230. private _minFrame;
  81231. private _maxFrame;
  81232. private _minValue;
  81233. private _maxValue;
  81234. private _targetIsArray;
  81235. /**
  81236. * Gets the current frame of the runtime animation
  81237. */
  81238. readonly currentFrame: number;
  81239. /**
  81240. * Gets the weight of the runtime animation
  81241. */
  81242. readonly weight: number;
  81243. /**
  81244. * Gets the current value of the runtime animation
  81245. */
  81246. readonly currentValue: any;
  81247. /**
  81248. * Gets the target path of the runtime animation
  81249. */
  81250. readonly targetPath: string;
  81251. /**
  81252. * Gets the actual target of the runtime animation
  81253. */
  81254. readonly target: any;
  81255. /** @hidden */
  81256. _onLoop: () => void;
  81257. /**
  81258. * Create a new RuntimeAnimation object
  81259. * @param target defines the target of the animation
  81260. * @param animation defines the source animation object
  81261. * @param scene defines the hosting scene
  81262. * @param host defines the initiating Animatable
  81263. */
  81264. constructor(target: any, animation: Animation, scene: Scene, host: Animatable);
  81265. private _preparePath;
  81266. /**
  81267. * Gets the animation from the runtime animation
  81268. */
  81269. readonly animation: Animation;
  81270. /**
  81271. * Resets the runtime animation to the beginning
  81272. * @param restoreOriginal defines whether to restore the target property to the original value
  81273. */
  81274. reset(restoreOriginal?: boolean): void;
  81275. /**
  81276. * Specifies if the runtime animation is stopped
  81277. * @returns Boolean specifying if the runtime animation is stopped
  81278. */
  81279. isStopped(): boolean;
  81280. /**
  81281. * Disposes of the runtime animation
  81282. */
  81283. dispose(): void;
  81284. /**
  81285. * Apply the interpolated value to the target
  81286. * @param currentValue defines the value computed by the animation
  81287. * @param weight defines the weight to apply to this value (Defaults to 1.0)
  81288. */
  81289. setValue(currentValue: any, weight: number): void;
  81290. private _getOriginalValues;
  81291. private _setValue;
  81292. /**
  81293. * Gets the loop pmode of the runtime animation
  81294. * @returns Loop Mode
  81295. */
  81296. private _getCorrectLoopMode;
  81297. /**
  81298. * Move the current animation to a given frame
  81299. * @param frame defines the frame to move to
  81300. */
  81301. goToFrame(frame: number): void;
  81302. /**
  81303. * @hidden Internal use only
  81304. */
  81305. _prepareForSpeedRatioChange(newSpeedRatio: number): void;
  81306. /**
  81307. * Execute the current animation
  81308. * @param delay defines the delay to add to the current frame
  81309. * @param from defines the lower bound of the animation range
  81310. * @param to defines the upper bound of the animation range
  81311. * @param loop defines if the current animation must loop
  81312. * @param speedRatio defines the current speed ratio
  81313. * @param weight defines the weight of the animation (default is -1 so no weight)
  81314. * @param onLoop optional callback called when animation loops
  81315. * @returns a boolean indicating if the animation is running
  81316. */
  81317. animate(delay: number, from: number, to: number, loop: boolean, speedRatio: number, weight?: number): boolean;
  81318. }
  81319. }
  81320. declare module BABYLON {
  81321. /**
  81322. * Class used to store an actual running animation
  81323. */
  81324. export class Animatable {
  81325. /** defines the target object */
  81326. target: any;
  81327. /** defines the starting frame number (default is 0) */
  81328. fromFrame: number;
  81329. /** defines the ending frame number (default is 100) */
  81330. toFrame: number;
  81331. /** defines if the animation must loop (default is false) */
  81332. loopAnimation: boolean;
  81333. /** defines a callback to call when animation ends if it is not looping */
  81334. onAnimationEnd?: (() => void) | null | undefined;
  81335. /** defines a callback to call when animation loops */
  81336. onAnimationLoop?: (() => void) | null | undefined;
  81337. private _localDelayOffset;
  81338. private _pausedDelay;
  81339. private _runtimeAnimations;
  81340. private _paused;
  81341. private _scene;
  81342. private _speedRatio;
  81343. private _weight;
  81344. private _syncRoot;
  81345. /**
  81346. * Gets or sets a boolean indicating if the animatable must be disposed and removed at the end of the animation.
  81347. * This will only apply for non looping animation (default is true)
  81348. */
  81349. disposeOnEnd: boolean;
  81350. /**
  81351. * Gets a boolean indicating if the animation has started
  81352. */
  81353. animationStarted: boolean;
  81354. /**
  81355. * Observer raised when the animation ends
  81356. */
  81357. onAnimationEndObservable: Observable<Animatable>;
  81358. /**
  81359. * Observer raised when the animation loops
  81360. */
  81361. onAnimationLoopObservable: Observable<Animatable>;
  81362. /**
  81363. * Gets the root Animatable used to synchronize and normalize animations
  81364. */
  81365. readonly syncRoot: Nullable<Animatable>;
  81366. /**
  81367. * Gets the current frame of the first RuntimeAnimation
  81368. * Used to synchronize Animatables
  81369. */
  81370. readonly masterFrame: number;
  81371. /**
  81372. * Gets or sets the animatable weight (-1.0 by default meaning not weighted)
  81373. */
  81374. weight: number;
  81375. /**
  81376. * Gets or sets the speed ratio to apply to the animatable (1.0 by default)
  81377. */
  81378. speedRatio: number;
  81379. /**
  81380. * Creates a new Animatable
  81381. * @param scene defines the hosting scene
  81382. * @param target defines the target object
  81383. * @param fromFrame defines the starting frame number (default is 0)
  81384. * @param toFrame defines the ending frame number (default is 100)
  81385. * @param loopAnimation defines if the animation must loop (default is false)
  81386. * @param speedRatio defines the factor to apply to animation speed (default is 1)
  81387. * @param onAnimationEnd defines a callback to call when animation ends if it is not looping
  81388. * @param animations defines a group of animation to add to the new Animatable
  81389. * @param onAnimationLoop defines a callback to call when animation loops
  81390. */
  81391. constructor(scene: Scene,
  81392. /** defines the target object */
  81393. target: any,
  81394. /** defines the starting frame number (default is 0) */
  81395. fromFrame?: number,
  81396. /** defines the ending frame number (default is 100) */
  81397. toFrame?: number,
  81398. /** defines if the animation must loop (default is false) */
  81399. loopAnimation?: boolean, speedRatio?: number,
  81400. /** defines a callback to call when animation ends if it is not looping */
  81401. onAnimationEnd?: (() => void) | null | undefined, animations?: Animation[],
  81402. /** defines a callback to call when animation loops */
  81403. onAnimationLoop?: (() => void) | null | undefined);
  81404. /**
  81405. * Synchronize and normalize current Animatable with a source Animatable
  81406. * This is useful when using animation weights and when animations are not of the same length
  81407. * @param root defines the root Animatable to synchronize with
  81408. * @returns the current Animatable
  81409. */
  81410. syncWith(root: Animatable): Animatable;
  81411. /**
  81412. * Gets the list of runtime animations
  81413. * @returns an array of RuntimeAnimation
  81414. */
  81415. getAnimations(): RuntimeAnimation[];
  81416. /**
  81417. * Adds more animations to the current animatable
  81418. * @param target defines the target of the animations
  81419. * @param animations defines the new animations to add
  81420. */
  81421. appendAnimations(target: any, animations: Animation[]): void;
  81422. /**
  81423. * Gets the source animation for a specific property
  81424. * @param property defines the propertyu to look for
  81425. * @returns null or the source animation for the given property
  81426. */
  81427. getAnimationByTargetProperty(property: string): Nullable<Animation>;
  81428. /**
  81429. * Gets the runtime animation for a specific property
  81430. * @param property defines the propertyu to look for
  81431. * @returns null or the runtime animation for the given property
  81432. */
  81433. getRuntimeAnimationByTargetProperty(property: string): Nullable<RuntimeAnimation>;
  81434. /**
  81435. * Resets the animatable to its original state
  81436. */
  81437. reset(): void;
  81438. /**
  81439. * Allows the animatable to blend with current running animations
  81440. * @see http://doc.babylonjs.com/babylon101/animations#animation-blending
  81441. * @param blendingSpeed defines the blending speed to use
  81442. */
  81443. enableBlending(blendingSpeed: number): void;
  81444. /**
  81445. * Disable animation blending
  81446. * @see http://doc.babylonjs.com/babylon101/animations#animation-blending
  81447. */
  81448. disableBlending(): void;
  81449. /**
  81450. * Jump directly to a given frame
  81451. * @param frame defines the frame to jump to
  81452. */
  81453. goToFrame(frame: number): void;
  81454. /**
  81455. * Pause the animation
  81456. */
  81457. pause(): void;
  81458. /**
  81459. * Restart the animation
  81460. */
  81461. restart(): void;
  81462. private _raiseOnAnimationEnd;
  81463. /**
  81464. * Stop and delete the current animation
  81465. * @param animationName defines a string used to only stop some of the runtime animations instead of all
  81466. * @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)
  81467. */
  81468. stop(animationName?: string, targetMask?: (target: any) => boolean): void;
  81469. /**
  81470. * Wait asynchronously for the animation to end
  81471. * @returns a promise which will be fullfilled when the animation ends
  81472. */
  81473. waitAsync(): Promise<Animatable>;
  81474. /** @hidden */
  81475. _animate(delay: number): boolean;
  81476. }
  81477. interface Scene {
  81478. /** @hidden */
  81479. _registerTargetForLateAnimationBinding(runtimeAnimation: RuntimeAnimation, originalValue: any): void;
  81480. /** @hidden */
  81481. _processLateAnimationBindingsForMatrices(holder: {
  81482. totalWeight: number;
  81483. animations: RuntimeAnimation[];
  81484. originalValue: Matrix;
  81485. }): any;
  81486. /** @hidden */
  81487. _processLateAnimationBindingsForQuaternions(holder: {
  81488. totalWeight: number;
  81489. animations: RuntimeAnimation[];
  81490. originalValue: Quaternion;
  81491. }, refQuaternion: Quaternion): Quaternion;
  81492. /** @hidden */
  81493. _processLateAnimationBindings(): void;
  81494. /**
  81495. * Will start the animation sequence of a given target
  81496. * @param target defines the target
  81497. * @param from defines from which frame should animation start
  81498. * @param to defines until which frame should animation run.
  81499. * @param weight defines the weight to apply to the animation (1.0 by default)
  81500. * @param loop defines if the animation loops
  81501. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  81502. * @param onAnimationEnd defines the function to be executed when the animation ends
  81503. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  81504. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  81505. * @param onAnimationLoop defines the callback to call when an animation loops
  81506. * @returns the animatable object created for this animation
  81507. */
  81508. beginWeightedAnimation(target: any, from: number, to: number, weight: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, animatable?: Animatable, targetMask?: (target: any) => boolean, onAnimationLoop?: () => void): Animatable;
  81509. /**
  81510. * Will start the animation sequence of a given target
  81511. * @param target defines the target
  81512. * @param from defines from which frame should animation start
  81513. * @param to defines until which frame should animation run.
  81514. * @param loop defines if the animation loops
  81515. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  81516. * @param onAnimationEnd defines the function to be executed when the animation ends
  81517. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  81518. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  81519. * @param targetMask defines if the target should be animate if animations are present (this is called recursively on descendant animatables regardless of return value)
  81520. * @param onAnimationLoop defines the callback to call when an animation loops
  81521. * @returns the animatable object created for this animation
  81522. */
  81523. beginAnimation(target: any, from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, animatable?: Animatable, stopCurrent?: boolean, targetMask?: (target: any) => boolean, onAnimationLoop?: () => void): Animatable;
  81524. /**
  81525. * Will start the animation sequence of a given target and its hierarchy
  81526. * @param target defines the target
  81527. * @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.
  81528. * @param from defines from which frame should animation start
  81529. * @param to defines until which frame should animation run.
  81530. * @param loop defines if the animation loops
  81531. * @param speedRatio defines the speed in which to run the animation (1.0 by default)
  81532. * @param onAnimationEnd defines the function to be executed when the animation ends
  81533. * @param animatable defines an animatable object. If not provided a new one will be created from the given params
  81534. * @param stopCurrent defines if the current animations must be stopped first (true by default)
  81535. * @param targetMask defines if the target should be animated if animations are present (this is called recursively on descendant animatables regardless of return value)
  81536. * @param onAnimationLoop defines the callback to call when an animation loops
  81537. * @returns the list of created animatables
  81538. */
  81539. 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[];
  81540. /**
  81541. * Begin a new animation on a given node
  81542. * @param target defines the target where the animation will take place
  81543. * @param animations defines the list of animations to start
  81544. * @param from defines the initial value
  81545. * @param to defines the final value
  81546. * @param loop defines if you want animation to loop (off by default)
  81547. * @param speedRatio defines the speed ratio to apply to all animations
  81548. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  81549. * @param onAnimationLoop defines the callback to call when an animation loops
  81550. * @returns the list of created animatables
  81551. */
  81552. beginDirectAnimation(target: any, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void): Animatable;
  81553. /**
  81554. * Begin a new animation on a given node and its hierarchy
  81555. * @param target defines the root node where the animation will take place
  81556. * @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.
  81557. * @param animations defines the list of animations to start
  81558. * @param from defines the initial value
  81559. * @param to defines the final value
  81560. * @param loop defines if you want animation to loop (off by default)
  81561. * @param speedRatio defines the speed ratio to apply to all animations
  81562. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  81563. * @param onAnimationLoop defines the callback to call when an animation loops
  81564. * @returns the list of animatables created for all nodes
  81565. */
  81566. beginDirectHierarchyAnimation(target: Node, directDescendantsOnly: boolean, animations: Animation[], from: number, to: number, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void, onAnimationLoop?: () => void): Animatable[];
  81567. /**
  81568. * Gets the animatable associated with a specific target
  81569. * @param target defines the target of the animatable
  81570. * @returns the required animatable if found
  81571. */
  81572. getAnimatableByTarget(target: any): Nullable<Animatable>;
  81573. /**
  81574. * Gets all animatables associated with a given target
  81575. * @param target defines the target to look animatables for
  81576. * @returns an array of Animatables
  81577. */
  81578. getAllAnimatablesByTarget(target: any): Array<Animatable>;
  81579. /**
  81580. * Stops and removes all animations that have been applied to the scene
  81581. */
  81582. stopAllAnimations(): void;
  81583. /**
  81584. * Gets the current delta time used by animation engine
  81585. */
  81586. deltaTime: number;
  81587. }
  81588. interface Bone {
  81589. /**
  81590. * Copy an animation range from another bone
  81591. * @param source defines the source bone
  81592. * @param rangeName defines the range name to copy
  81593. * @param frameOffset defines the frame offset
  81594. * @param rescaleAsRequired defines if rescaling must be applied if required
  81595. * @param skelDimensionsRatio defines the scaling ratio
  81596. * @returns true if operation was successful
  81597. */
  81598. copyAnimationRange(source: Bone, rangeName: string, frameOffset: number, rescaleAsRequired: boolean, skelDimensionsRatio: Nullable<Vector3>): boolean;
  81599. }
  81600. }
  81601. declare module BABYLON {
  81602. /**
  81603. * Class used to override all child animations of a given target
  81604. */
  81605. export class AnimationPropertiesOverride {
  81606. /**
  81607. * Gets or sets a value indicating if animation blending must be used
  81608. */
  81609. enableBlending: boolean;
  81610. /**
  81611. * Gets or sets the blending speed to use when enableBlending is true
  81612. */
  81613. blendingSpeed: number;
  81614. /**
  81615. * Gets or sets the default loop mode to use
  81616. */
  81617. loopMode: number;
  81618. }
  81619. }
  81620. declare module BABYLON {
  81621. /**
  81622. * Class used to handle skinning animations
  81623. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  81624. */
  81625. export class Skeleton implements IAnimatable {
  81626. /** defines the skeleton name */
  81627. name: string;
  81628. /** defines the skeleton Id */
  81629. id: string;
  81630. /**
  81631. * Defines the list of child bones
  81632. */
  81633. bones: Bone[];
  81634. /**
  81635. * Defines an estimate of the dimension of the skeleton at rest
  81636. */
  81637. dimensionsAtRest: Vector3;
  81638. /**
  81639. * Defines a boolean indicating if the root matrix is provided by meshes or by the current skeleton (this is the default value)
  81640. */
  81641. needInitialSkinMatrix: boolean;
  81642. /**
  81643. * Defines a mesh that override the matrix used to get the world matrix (null by default).
  81644. */
  81645. overrideMesh: Nullable<AbstractMesh>;
  81646. /**
  81647. * Gets the list of animations attached to this skeleton
  81648. */
  81649. animations: Array<Animation>;
  81650. private _scene;
  81651. private _isDirty;
  81652. private _transformMatrices;
  81653. private _transformMatrixTexture;
  81654. private _meshesWithPoseMatrix;
  81655. private _animatables;
  81656. private _identity;
  81657. private _synchronizedWithMesh;
  81658. private _ranges;
  81659. private _lastAbsoluteTransformsUpdateId;
  81660. private _canUseTextureForBones;
  81661. private _uniqueId;
  81662. /** @hidden */
  81663. _numBonesWithLinkedTransformNode: number;
  81664. /** @hidden */
  81665. _hasWaitingData: Nullable<boolean>;
  81666. /**
  81667. * Specifies if the skeleton should be serialized
  81668. */
  81669. doNotSerialize: boolean;
  81670. private _useTextureToStoreBoneMatrices;
  81671. /**
  81672. * Gets or sets a boolean indicating that bone matrices should be stored as a texture instead of using shader uniforms (default is true).
  81673. * Please note that this option is not available if the hardware does not support it
  81674. */
  81675. useTextureToStoreBoneMatrices: boolean;
  81676. private _animationPropertiesOverride;
  81677. /**
  81678. * Gets or sets the animation properties override
  81679. */
  81680. animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  81681. /**
  81682. * List of inspectable custom properties (used by the Inspector)
  81683. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  81684. */
  81685. inspectableCustomProperties: IInspectable[];
  81686. /**
  81687. * An observable triggered before computing the skeleton's matrices
  81688. */
  81689. onBeforeComputeObservable: Observable<Skeleton>;
  81690. /**
  81691. * Gets a boolean indicating that the skeleton effectively stores matrices into a texture
  81692. */
  81693. readonly isUsingTextureForMatrices: boolean;
  81694. /**
  81695. * Gets the unique ID of this skeleton
  81696. */
  81697. readonly uniqueId: number;
  81698. /**
  81699. * Creates a new skeleton
  81700. * @param name defines the skeleton name
  81701. * @param id defines the skeleton Id
  81702. * @param scene defines the hosting scene
  81703. */
  81704. constructor(
  81705. /** defines the skeleton name */
  81706. name: string,
  81707. /** defines the skeleton Id */
  81708. id: string, scene: Scene);
  81709. /**
  81710. * Gets the current object class name.
  81711. * @return the class name
  81712. */
  81713. getClassName(): string;
  81714. /**
  81715. * Returns an array containing the root bones
  81716. * @returns an array containing the root bones
  81717. */
  81718. getChildren(): Array<Bone>;
  81719. /**
  81720. * Gets the list of transform matrices to send to shaders (one matrix per bone)
  81721. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  81722. * @returns a Float32Array containing matrices data
  81723. */
  81724. getTransformMatrices(mesh: AbstractMesh): Float32Array;
  81725. /**
  81726. * Gets the list of transform matrices to send to shaders inside a texture (one matrix per bone)
  81727. * @param mesh defines the mesh to use to get the root matrix (if needInitialSkinMatrix === true)
  81728. * @returns a raw texture containing the data
  81729. */
  81730. getTransformMatrixTexture(mesh: AbstractMesh): Nullable<RawTexture>;
  81731. /**
  81732. * Gets the current hosting scene
  81733. * @returns a scene object
  81734. */
  81735. getScene(): Scene;
  81736. /**
  81737. * Gets a string representing the current skeleton data
  81738. * @param fullDetails defines a boolean indicating if we want a verbose version
  81739. * @returns a string representing the current skeleton data
  81740. */
  81741. toString(fullDetails?: boolean): string;
  81742. /**
  81743. * Get bone's index searching by name
  81744. * @param name defines bone's name to search for
  81745. * @return the indice of the bone. Returns -1 if not found
  81746. */
  81747. getBoneIndexByName(name: string): number;
  81748. /**
  81749. * Creater a new animation range
  81750. * @param name defines the name of the range
  81751. * @param from defines the start key
  81752. * @param to defines the end key
  81753. */
  81754. createAnimationRange(name: string, from: number, to: number): void;
  81755. /**
  81756. * Delete a specific animation range
  81757. * @param name defines the name of the range
  81758. * @param deleteFrames defines if frames must be removed as well
  81759. */
  81760. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  81761. /**
  81762. * Gets a specific animation range
  81763. * @param name defines the name of the range to look for
  81764. * @returns the requested animation range or null if not found
  81765. */
  81766. getAnimationRange(name: string): Nullable<AnimationRange>;
  81767. /**
  81768. * Gets the list of all animation ranges defined on this skeleton
  81769. * @returns an array
  81770. */
  81771. getAnimationRanges(): Nullable<AnimationRange>[];
  81772. /**
  81773. * Copy animation range from a source skeleton.
  81774. * This is not for a complete retargeting, only between very similar skeleton's with only possible bone length differences
  81775. * @param source defines the source skeleton
  81776. * @param name defines the name of the range to copy
  81777. * @param rescaleAsRequired defines if rescaling must be applied if required
  81778. * @returns true if operation was successful
  81779. */
  81780. copyAnimationRange(source: Skeleton, name: string, rescaleAsRequired?: boolean): boolean;
  81781. /**
  81782. * Forces the skeleton to go to rest pose
  81783. */
  81784. returnToRest(): void;
  81785. private _getHighestAnimationFrame;
  81786. /**
  81787. * Begin a specific animation range
  81788. * @param name defines the name of the range to start
  81789. * @param loop defines if looping must be turned on (false by default)
  81790. * @param speedRatio defines the speed ratio to apply (1 by default)
  81791. * @param onAnimationEnd defines a callback which will be called when animation will end
  81792. * @returns a new animatable
  81793. */
  81794. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  81795. /** @hidden */
  81796. _markAsDirty(): void;
  81797. /** @hidden */
  81798. _registerMeshWithPoseMatrix(mesh: AbstractMesh): void;
  81799. /** @hidden */
  81800. _unregisterMeshWithPoseMatrix(mesh: AbstractMesh): void;
  81801. private _computeTransformMatrices;
  81802. /**
  81803. * Build all resources required to render a skeleton
  81804. */
  81805. prepare(): void;
  81806. /**
  81807. * Gets the list of animatables currently running for this skeleton
  81808. * @returns an array of animatables
  81809. */
  81810. getAnimatables(): IAnimatable[];
  81811. /**
  81812. * Clone the current skeleton
  81813. * @param name defines the name of the new skeleton
  81814. * @param id defines the id of the new skeleton
  81815. * @returns the new skeleton
  81816. */
  81817. clone(name: string, id?: string): Skeleton;
  81818. /**
  81819. * Enable animation blending for this skeleton
  81820. * @param blendingSpeed defines the blending speed to apply
  81821. * @see http://doc.babylonjs.com/babylon101/animations#animation-blending
  81822. */
  81823. enableBlending(blendingSpeed?: number): void;
  81824. /**
  81825. * Releases all resources associated with the current skeleton
  81826. */
  81827. dispose(): void;
  81828. /**
  81829. * Serialize the skeleton in a JSON object
  81830. * @returns a JSON object
  81831. */
  81832. serialize(): any;
  81833. /**
  81834. * Creates a new skeleton from serialized data
  81835. * @param parsedSkeleton defines the serialized data
  81836. * @param scene defines the hosting scene
  81837. * @returns a new skeleton
  81838. */
  81839. static Parse(parsedSkeleton: any, scene: Scene): Skeleton;
  81840. /**
  81841. * Compute all node absolute transforms
  81842. * @param forceUpdate defines if computation must be done even if cache is up to date
  81843. */
  81844. computeAbsoluteTransforms(forceUpdate?: boolean): void;
  81845. /**
  81846. * Gets the root pose matrix
  81847. * @returns a matrix
  81848. */
  81849. getPoseMatrix(): Nullable<Matrix>;
  81850. /**
  81851. * Sorts bones per internal index
  81852. */
  81853. sortBones(): void;
  81854. private _sortBones;
  81855. }
  81856. }
  81857. declare module BABYLON {
  81858. /**
  81859. * Class used to store bone information
  81860. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  81861. */
  81862. export class Bone extends Node {
  81863. /**
  81864. * defines the bone name
  81865. */
  81866. name: string;
  81867. private static _tmpVecs;
  81868. private static _tmpQuat;
  81869. private static _tmpMats;
  81870. /**
  81871. * Gets the list of child bones
  81872. */
  81873. children: Bone[];
  81874. /** Gets the animations associated with this bone */
  81875. animations: Animation[];
  81876. /**
  81877. * Gets or sets bone length
  81878. */
  81879. length: number;
  81880. /**
  81881. * @hidden Internal only
  81882. * Set this value to map this bone to a different index in the transform matrices
  81883. * Set this value to -1 to exclude the bone from the transform matrices
  81884. */
  81885. _index: Nullable<number>;
  81886. private _skeleton;
  81887. private _localMatrix;
  81888. private _restPose;
  81889. private _baseMatrix;
  81890. private _absoluteTransform;
  81891. private _invertedAbsoluteTransform;
  81892. private _parent;
  81893. private _scalingDeterminant;
  81894. private _worldTransform;
  81895. private _localScaling;
  81896. private _localRotation;
  81897. private _localPosition;
  81898. private _needToDecompose;
  81899. private _needToCompose;
  81900. /** @hidden */
  81901. _linkedTransformNode: Nullable<TransformNode>;
  81902. /** @hidden */
  81903. _waitingTransformNodeId: Nullable<string>;
  81904. /** @hidden */
  81905. /** @hidden */
  81906. _matrix: Matrix;
  81907. /**
  81908. * Create a new bone
  81909. * @param name defines the bone name
  81910. * @param skeleton defines the parent skeleton
  81911. * @param parentBone defines the parent (can be null if the bone is the root)
  81912. * @param localMatrix defines the local matrix
  81913. * @param restPose defines the rest pose matrix
  81914. * @param baseMatrix defines the base matrix
  81915. * @param index defines index of the bone in the hiearchy
  81916. */
  81917. constructor(
  81918. /**
  81919. * defines the bone name
  81920. */
  81921. name: string, skeleton: Skeleton, parentBone?: Nullable<Bone>, localMatrix?: Nullable<Matrix>, restPose?: Nullable<Matrix>, baseMatrix?: Nullable<Matrix>, index?: Nullable<number>);
  81922. /**
  81923. * Gets the current object class name.
  81924. * @return the class name
  81925. */
  81926. getClassName(): string;
  81927. /**
  81928. * Gets the parent skeleton
  81929. * @returns a skeleton
  81930. */
  81931. getSkeleton(): Skeleton;
  81932. /**
  81933. * Gets parent bone
  81934. * @returns a bone or null if the bone is the root of the bone hierarchy
  81935. */
  81936. getParent(): Nullable<Bone>;
  81937. /**
  81938. * Returns an array containing the root bones
  81939. * @returns an array containing the root bones
  81940. */
  81941. getChildren(): Array<Bone>;
  81942. /**
  81943. * Gets the node index in matrix array generated for rendering
  81944. * @returns the node index
  81945. */
  81946. getIndex(): number;
  81947. /**
  81948. * Sets the parent bone
  81949. * @param parent defines the parent (can be null if the bone is the root)
  81950. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  81951. */
  81952. setParent(parent: Nullable<Bone>, updateDifferenceMatrix?: boolean): void;
  81953. /**
  81954. * Gets the local matrix
  81955. * @returns a matrix
  81956. */
  81957. getLocalMatrix(): Matrix;
  81958. /**
  81959. * Gets the base matrix (initial matrix which remains unchanged)
  81960. * @returns a matrix
  81961. */
  81962. getBaseMatrix(): Matrix;
  81963. /**
  81964. * Gets the rest pose matrix
  81965. * @returns a matrix
  81966. */
  81967. getRestPose(): Matrix;
  81968. /**
  81969. * Gets a matrix used to store world matrix (ie. the matrix sent to shaders)
  81970. */
  81971. getWorldMatrix(): Matrix;
  81972. /**
  81973. * Sets the local matrix to rest pose matrix
  81974. */
  81975. returnToRest(): void;
  81976. /**
  81977. * Gets the inverse of the absolute transform matrix.
  81978. * This matrix will be multiplied by local matrix to get the difference matrix (ie. the difference between original state and current state)
  81979. * @returns a matrix
  81980. */
  81981. getInvertedAbsoluteTransform(): Matrix;
  81982. /**
  81983. * Gets the absolute transform matrix (ie base matrix * parent world matrix)
  81984. * @returns a matrix
  81985. */
  81986. getAbsoluteTransform(): Matrix;
  81987. /**
  81988. * Links with the given transform node.
  81989. * The local matrix of this bone is copied from the transform node every frame.
  81990. * @param transformNode defines the transform node to link to
  81991. */
  81992. linkTransformNode(transformNode: Nullable<TransformNode>): void;
  81993. /**
  81994. * Gets the node used to drive the bone's transformation
  81995. * @returns a transform node or null
  81996. */
  81997. getTransformNode(): Nullable<TransformNode>;
  81998. /** Gets or sets current position (in local space) */
  81999. position: Vector3;
  82000. /** Gets or sets current rotation (in local space) */
  82001. rotation: Vector3;
  82002. /** Gets or sets current rotation quaternion (in local space) */
  82003. rotationQuaternion: Quaternion;
  82004. /** Gets or sets current scaling (in local space) */
  82005. scaling: Vector3;
  82006. /**
  82007. * Gets the animation properties override
  82008. */
  82009. readonly animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  82010. private _decompose;
  82011. private _compose;
  82012. /**
  82013. * Update the base and local matrices
  82014. * @param matrix defines the new base or local matrix
  82015. * @param updateDifferenceMatrix defines if the difference matrix must be updated
  82016. * @param updateLocalMatrix defines if the local matrix should be updated
  82017. */
  82018. updateMatrix(matrix: Matrix, updateDifferenceMatrix?: boolean, updateLocalMatrix?: boolean): void;
  82019. /** @hidden */
  82020. _updateDifferenceMatrix(rootMatrix?: Matrix, updateChildren?: boolean): void;
  82021. /**
  82022. * Flag the bone as dirty (Forcing it to update everything)
  82023. */
  82024. markAsDirty(): void;
  82025. /** @hidden */
  82026. _markAsDirtyAndCompose(): void;
  82027. private _markAsDirtyAndDecompose;
  82028. /**
  82029. * Translate the bone in local or world space
  82030. * @param vec The amount to translate the bone
  82031. * @param space The space that the translation is in
  82032. * @param mesh The mesh that this bone is attached to. This is only used in world space
  82033. */
  82034. translate(vec: Vector3, space?: Space, mesh?: AbstractMesh): void;
  82035. /**
  82036. * Set the postion of the bone in local or world space
  82037. * @param position The position to set the bone
  82038. * @param space The space that the position is in
  82039. * @param mesh The mesh that this bone is attached to. This is only used in world space
  82040. */
  82041. setPosition(position: Vector3, space?: Space, mesh?: AbstractMesh): void;
  82042. /**
  82043. * Set the absolute position of the bone (world space)
  82044. * @param position The position to set the bone
  82045. * @param mesh The mesh that this bone is attached to
  82046. */
  82047. setAbsolutePosition(position: Vector3, mesh?: AbstractMesh): void;
  82048. /**
  82049. * Scale the bone on the x, y and z axes (in local space)
  82050. * @param x The amount to scale the bone on the x axis
  82051. * @param y The amount to scale the bone on the y axis
  82052. * @param z The amount to scale the bone on the z axis
  82053. * @param scaleChildren sets this to true if children of the bone should be scaled as well (false by default)
  82054. */
  82055. scale(x: number, y: number, z: number, scaleChildren?: boolean): void;
  82056. /**
  82057. * Set the bone scaling in local space
  82058. * @param scale defines the scaling vector
  82059. */
  82060. setScale(scale: Vector3): void;
  82061. /**
  82062. * Gets the current scaling in local space
  82063. * @returns the current scaling vector
  82064. */
  82065. getScale(): Vector3;
  82066. /**
  82067. * Gets the current scaling in local space and stores it in a target vector
  82068. * @param result defines the target vector
  82069. */
  82070. getScaleToRef(result: Vector3): void;
  82071. /**
  82072. * Set the yaw, pitch, and roll of the bone in local or world space
  82073. * @param yaw The rotation of the bone on the y axis
  82074. * @param pitch The rotation of the bone on the x axis
  82075. * @param roll The rotation of the bone on the z axis
  82076. * @param space The space that the axes of rotation are in
  82077. * @param mesh The mesh that this bone is attached to. This is only used in world space
  82078. */
  82079. setYawPitchRoll(yaw: number, pitch: number, roll: number, space?: Space, mesh?: AbstractMesh): void;
  82080. /**
  82081. * Add a rotation to the bone on an axis in local or world space
  82082. * @param axis The axis to rotate the bone on
  82083. * @param amount The amount to rotate the bone
  82084. * @param space The space that the axis is in
  82085. * @param mesh The mesh that this bone is attached to. This is only used in world space
  82086. */
  82087. rotate(axis: Vector3, amount: number, space?: Space, mesh?: AbstractMesh): void;
  82088. /**
  82089. * Set the rotation of the bone to a particular axis angle in local or world space
  82090. * @param axis The axis to rotate the bone on
  82091. * @param angle The angle that the bone should be rotated to
  82092. * @param space The space that the axis is in
  82093. * @param mesh The mesh that this bone is attached to. This is only used in world space
  82094. */
  82095. setAxisAngle(axis: Vector3, angle: number, space?: Space, mesh?: AbstractMesh): void;
  82096. /**
  82097. * Set the euler rotation of the bone in local of world space
  82098. * @param rotation The euler rotation that the bone should be set to
  82099. * @param space The space that the rotation is in
  82100. * @param mesh The mesh that this bone is attached to. This is only used in world space
  82101. */
  82102. setRotation(rotation: Vector3, space?: Space, mesh?: AbstractMesh): void;
  82103. /**
  82104. * Set the quaternion rotation of the bone in local of world space
  82105. * @param quat The quaternion rotation that the bone should be set to
  82106. * @param space The space that the rotation is in
  82107. * @param mesh The mesh that this bone is attached to. This is only used in world space
  82108. */
  82109. setRotationQuaternion(quat: Quaternion, space?: Space, mesh?: AbstractMesh): void;
  82110. /**
  82111. * Set the rotation matrix of the bone in local of world space
  82112. * @param rotMat The rotation matrix that the bone should be set to
  82113. * @param space The space that the rotation is in
  82114. * @param mesh The mesh that this bone is attached to. This is only used in world space
  82115. */
  82116. setRotationMatrix(rotMat: Matrix, space?: Space, mesh?: AbstractMesh): void;
  82117. private _rotateWithMatrix;
  82118. private _getNegativeRotationToRef;
  82119. /**
  82120. * Get the position of the bone in local or world space
  82121. * @param space The space that the returned position is in
  82122. * @param mesh The mesh that this bone is attached to. This is only used in world space
  82123. * @returns The position of the bone
  82124. */
  82125. getPosition(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  82126. /**
  82127. * Copy the position of the bone to a vector3 in local or world space
  82128. * @param space The space that the returned position is in
  82129. * @param mesh The mesh that this bone is attached to. This is only used in world space
  82130. * @param result The vector3 to copy the position to
  82131. */
  82132. getPositionToRef(space: Space | undefined, mesh: Nullable<AbstractMesh>, result: Vector3): void;
  82133. /**
  82134. * Get the absolute position of the bone (world space)
  82135. * @param mesh The mesh that this bone is attached to
  82136. * @returns The absolute position of the bone
  82137. */
  82138. getAbsolutePosition(mesh?: Nullable<AbstractMesh>): Vector3;
  82139. /**
  82140. * Copy the absolute position of the bone (world space) to the result param
  82141. * @param mesh The mesh that this bone is attached to
  82142. * @param result The vector3 to copy the absolute position to
  82143. */
  82144. getAbsolutePositionToRef(mesh: AbstractMesh, result: Vector3): void;
  82145. /**
  82146. * Compute the absolute transforms of this bone and its children
  82147. */
  82148. computeAbsoluteTransforms(): void;
  82149. /**
  82150. * Get the world direction from an axis that is in the local space of the bone
  82151. * @param localAxis The local direction that is used to compute the world direction
  82152. * @param mesh The mesh that this bone is attached to
  82153. * @returns The world direction
  82154. */
  82155. getDirection(localAxis: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  82156. /**
  82157. * Copy the world direction to a vector3 from an axis that is in the local space of the bone
  82158. * @param localAxis The local direction that is used to compute the world direction
  82159. * @param mesh The mesh that this bone is attached to
  82160. * @param result The vector3 that the world direction will be copied to
  82161. */
  82162. getDirectionToRef(localAxis: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  82163. /**
  82164. * Get the euler rotation of the bone in local or world space
  82165. * @param space The space that the rotation should be in
  82166. * @param mesh The mesh that this bone is attached to. This is only used in world space
  82167. * @returns The euler rotation
  82168. */
  82169. getRotation(space?: Space, mesh?: Nullable<AbstractMesh>): Vector3;
  82170. /**
  82171. * Copy the euler rotation of the bone to a vector3. The rotation can be in either local or world space
  82172. * @param space The space that the rotation should be in
  82173. * @param mesh The mesh that this bone is attached to. This is only used in world space
  82174. * @param result The vector3 that the rotation should be copied to
  82175. */
  82176. getRotationToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  82177. /**
  82178. * Get the quaternion rotation of the bone in either local or world space
  82179. * @param space The space that the rotation should be in
  82180. * @param mesh The mesh that this bone is attached to. This is only used in world space
  82181. * @returns The quaternion rotation
  82182. */
  82183. getRotationQuaternion(space?: Space, mesh?: Nullable<AbstractMesh>): Quaternion;
  82184. /**
  82185. * Copy the quaternion rotation of the bone to a quaternion. The rotation can be in either local or world space
  82186. * @param space The space that the rotation should be in
  82187. * @param mesh The mesh that this bone is attached to. This is only used in world space
  82188. * @param result The quaternion that the rotation should be copied to
  82189. */
  82190. getRotationQuaternionToRef(space: Space | undefined, mesh: AbstractMesh | null | undefined, result: Quaternion): void;
  82191. /**
  82192. * Get the rotation matrix of the bone in local or world space
  82193. * @param space The space that the rotation should be in
  82194. * @param mesh The mesh that this bone is attached to. This is only used in world space
  82195. * @returns The rotation matrix
  82196. */
  82197. getRotationMatrix(space: Space | undefined, mesh: AbstractMesh): Matrix;
  82198. /**
  82199. * Copy the rotation matrix of the bone to a matrix. The rotation can be in either local or world space
  82200. * @param space The space that the rotation should be in
  82201. * @param mesh The mesh that this bone is attached to. This is only used in world space
  82202. * @param result The quaternion that the rotation should be copied to
  82203. */
  82204. getRotationMatrixToRef(space: Space | undefined, mesh: AbstractMesh, result: Matrix): void;
  82205. /**
  82206. * Get the world position of a point that is in the local space of the bone
  82207. * @param position The local position
  82208. * @param mesh The mesh that this bone is attached to
  82209. * @returns The world position
  82210. */
  82211. getAbsolutePositionFromLocal(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  82212. /**
  82213. * Get the world position of a point that is in the local space of the bone and copy it to the result param
  82214. * @param position The local position
  82215. * @param mesh The mesh that this bone is attached to
  82216. * @param result The vector3 that the world position should be copied to
  82217. */
  82218. getAbsolutePositionFromLocalToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  82219. /**
  82220. * Get the local position of a point that is in world space
  82221. * @param position The world position
  82222. * @param mesh The mesh that this bone is attached to
  82223. * @returns The local position
  82224. */
  82225. getLocalPositionFromAbsolute(position: Vector3, mesh?: Nullable<AbstractMesh>): Vector3;
  82226. /**
  82227. * Get the local position of a point that is in world space and copy it to the result param
  82228. * @param position The world position
  82229. * @param mesh The mesh that this bone is attached to
  82230. * @param result The vector3 that the local position should be copied to
  82231. */
  82232. getLocalPositionFromAbsoluteToRef(position: Vector3, mesh: AbstractMesh | null | undefined, result: Vector3): void;
  82233. }
  82234. }
  82235. declare module BABYLON {
  82236. /**
  82237. * 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.
  82238. * @see https://doc.babylonjs.com/how_to/transformnode
  82239. */
  82240. export class TransformNode extends Node {
  82241. /**
  82242. * Object will not rotate to face the camera
  82243. */
  82244. static BILLBOARDMODE_NONE: number;
  82245. /**
  82246. * Object will rotate to face the camera but only on the x axis
  82247. */
  82248. static BILLBOARDMODE_X: number;
  82249. /**
  82250. * Object will rotate to face the camera but only on the y axis
  82251. */
  82252. static BILLBOARDMODE_Y: number;
  82253. /**
  82254. * Object will rotate to face the camera but only on the z axis
  82255. */
  82256. static BILLBOARDMODE_Z: number;
  82257. /**
  82258. * Object will rotate to face the camera
  82259. */
  82260. static BILLBOARDMODE_ALL: number;
  82261. /**
  82262. * Object will rotate to face the camera's position instead of orientation
  82263. */
  82264. static BILLBOARDMODE_USE_POSITION: number;
  82265. private _forward;
  82266. private _forwardInverted;
  82267. private _up;
  82268. private _right;
  82269. private _rightInverted;
  82270. private _position;
  82271. private _rotation;
  82272. private _rotationQuaternion;
  82273. protected _scaling: Vector3;
  82274. protected _isDirty: boolean;
  82275. private _transformToBoneReferal;
  82276. private _isAbsoluteSynced;
  82277. private _billboardMode;
  82278. /**
  82279. * Gets or sets the billboard mode. Default is 0.
  82280. *
  82281. * | Value | Type | Description |
  82282. * | --- | --- | --- |
  82283. * | 0 | BILLBOARDMODE_NONE | |
  82284. * | 1 | BILLBOARDMODE_X | |
  82285. * | 2 | BILLBOARDMODE_Y | |
  82286. * | 4 | BILLBOARDMODE_Z | |
  82287. * | 7 | BILLBOARDMODE_ALL | |
  82288. *
  82289. */
  82290. billboardMode: number;
  82291. private _preserveParentRotationForBillboard;
  82292. /**
  82293. * Gets or sets a boolean indicating that parent rotation should be preserved when using billboards.
  82294. * This could be useful for glTF objects where parent rotation helps converting from right handed to left handed
  82295. */
  82296. preserveParentRotationForBillboard: boolean;
  82297. /**
  82298. * 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
  82299. */
  82300. scalingDeterminant: number;
  82301. private _infiniteDistance;
  82302. /**
  82303. * Gets or sets the distance of the object to max, often used by skybox
  82304. */
  82305. infiniteDistance: boolean;
  82306. /**
  82307. * Gets or sets a boolean indicating that non uniform scaling (when at least one component is different from others) should be ignored.
  82308. * By default the system will update normals to compensate
  82309. */
  82310. ignoreNonUniformScaling: boolean;
  82311. /**
  82312. * 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
  82313. */
  82314. reIntegrateRotationIntoRotationQuaternion: boolean;
  82315. /** @hidden */
  82316. _poseMatrix: Nullable<Matrix>;
  82317. /** @hidden */
  82318. _localMatrix: Matrix;
  82319. private _usePivotMatrix;
  82320. private _absolutePosition;
  82321. private _absoluteScaling;
  82322. private _absoluteRotationQuaternion;
  82323. private _pivotMatrix;
  82324. private _pivotMatrixInverse;
  82325. protected _postMultiplyPivotMatrix: boolean;
  82326. protected _isWorldMatrixFrozen: boolean;
  82327. /** @hidden */
  82328. _indexInSceneTransformNodesArray: number;
  82329. /**
  82330. * An event triggered after the world matrix is updated
  82331. */
  82332. onAfterWorldMatrixUpdateObservable: Observable<TransformNode>;
  82333. constructor(name: string, scene?: Nullable<Scene>, isPure?: boolean);
  82334. /**
  82335. * Gets a string identifying the name of the class
  82336. * @returns "TransformNode" string
  82337. */
  82338. getClassName(): string;
  82339. /**
  82340. * Gets or set the node position (default is (0.0, 0.0, 0.0))
  82341. */
  82342. position: Vector3;
  82343. /**
  82344. * 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)).
  82345. * If rotation quaternion is set, this Vector3 will be ignored and copy from the quaternion
  82346. */
  82347. rotation: Vector3;
  82348. /**
  82349. * 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)).
  82350. */
  82351. scaling: Vector3;
  82352. /**
  82353. * 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).
  82354. * If set, only the rotationQuaternion is then used to compute the node rotation (ie. node.rotation will be ignored)
  82355. */
  82356. rotationQuaternion: Nullable<Quaternion>;
  82357. /**
  82358. * The forward direction of that transform in world space.
  82359. */
  82360. readonly forward: Vector3;
  82361. /**
  82362. * The up direction of that transform in world space.
  82363. */
  82364. readonly up: Vector3;
  82365. /**
  82366. * The right direction of that transform in world space.
  82367. */
  82368. readonly right: Vector3;
  82369. /**
  82370. * Copies the parameter passed Matrix into the mesh Pose matrix.
  82371. * @param matrix the matrix to copy the pose from
  82372. * @returns this TransformNode.
  82373. */
  82374. updatePoseMatrix(matrix: Matrix): TransformNode;
  82375. /**
  82376. * Returns the mesh Pose matrix.
  82377. * @returns the pose matrix
  82378. */
  82379. getPoseMatrix(): Matrix;
  82380. /** @hidden */
  82381. _isSynchronized(): boolean;
  82382. /** @hidden */
  82383. _initCache(): void;
  82384. /**
  82385. * Flag the transform node as dirty (Forcing it to update everything)
  82386. * @param property if set to "rotation" the objects rotationQuaternion will be set to null
  82387. * @returns this transform node
  82388. */
  82389. markAsDirty(property: string): TransformNode;
  82390. /**
  82391. * Returns the current mesh absolute position.
  82392. * Returns a Vector3.
  82393. */
  82394. readonly absolutePosition: Vector3;
  82395. /**
  82396. * Returns the current mesh absolute scaling.
  82397. * Returns a Vector3.
  82398. */
  82399. readonly absoluteScaling: Vector3;
  82400. /**
  82401. * Returns the current mesh absolute rotation.
  82402. * Returns a Quaternion.
  82403. */
  82404. readonly absoluteRotationQuaternion: Quaternion;
  82405. /**
  82406. * Sets a new matrix to apply before all other transformation
  82407. * @param matrix defines the transform matrix
  82408. * @returns the current TransformNode
  82409. */
  82410. setPreTransformMatrix(matrix: Matrix): TransformNode;
  82411. /**
  82412. * Sets a new pivot matrix to the current node
  82413. * @param matrix defines the new pivot matrix to use
  82414. * @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
  82415. * @returns the current TransformNode
  82416. */
  82417. setPivotMatrix(matrix: DeepImmutable<Matrix>, postMultiplyPivotMatrix?: boolean): TransformNode;
  82418. /**
  82419. * Returns the mesh pivot matrix.
  82420. * Default : Identity.
  82421. * @returns the matrix
  82422. */
  82423. getPivotMatrix(): Matrix;
  82424. /**
  82425. * Instantiate (when possible) or clone that node with its hierarchy
  82426. * @param newParent defines the new parent to use for the instance (or clone)
  82427. * @param options defines options to configure how copy is done
  82428. * @param onNewNodeCreated defines an option callback to call when a clone or an instance is created
  82429. * @returns an instance (or a clone) of the current node with its hiearchy
  82430. */
  82431. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  82432. doNotInstantiate: boolean;
  82433. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  82434. /**
  82435. * Prevents the World matrix to be computed any longer
  82436. * @param newWorldMatrix defines an optional matrix to use as world matrix
  82437. * @returns the TransformNode.
  82438. */
  82439. freezeWorldMatrix(newWorldMatrix?: Nullable<Matrix>): TransformNode;
  82440. /**
  82441. * Allows back the World matrix computation.
  82442. * @returns the TransformNode.
  82443. */
  82444. unfreezeWorldMatrix(): this;
  82445. /**
  82446. * True if the World matrix has been frozen.
  82447. */
  82448. readonly isWorldMatrixFrozen: boolean;
  82449. /**
  82450. * Retuns the mesh absolute position in the World.
  82451. * @returns a Vector3.
  82452. */
  82453. getAbsolutePosition(): Vector3;
  82454. /**
  82455. * Sets the mesh absolute position in the World from a Vector3 or an Array(3).
  82456. * @param absolutePosition the absolute position to set
  82457. * @returns the TransformNode.
  82458. */
  82459. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  82460. /**
  82461. * Sets the mesh position in its local space.
  82462. * @param vector3 the position to set in localspace
  82463. * @returns the TransformNode.
  82464. */
  82465. setPositionWithLocalVector(vector3: Vector3): TransformNode;
  82466. /**
  82467. * Returns the mesh position in the local space from the current World matrix values.
  82468. * @returns a new Vector3.
  82469. */
  82470. getPositionExpressedInLocalSpace(): Vector3;
  82471. /**
  82472. * Translates the mesh along the passed Vector3 in its local space.
  82473. * @param vector3 the distance to translate in localspace
  82474. * @returns the TransformNode.
  82475. */
  82476. locallyTranslate(vector3: Vector3): TransformNode;
  82477. private static _lookAtVectorCache;
  82478. /**
  82479. * Orients a mesh towards a target point. Mesh must be drawn facing user.
  82480. * @param targetPoint the position (must be in same space as current mesh) to look at
  82481. * @param yawCor optional yaw (y-axis) correction in radians
  82482. * @param pitchCor optional pitch (x-axis) correction in radians
  82483. * @param rollCor optional roll (z-axis) correction in radians
  82484. * @param space the choosen space of the target
  82485. * @returns the TransformNode.
  82486. */
  82487. lookAt(targetPoint: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number, space?: Space): TransformNode;
  82488. /**
  82489. * Returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  82490. * This Vector3 is expressed in the World space.
  82491. * @param localAxis axis to rotate
  82492. * @returns a new Vector3 that is the localAxis, expressed in the mesh local space, rotated like the mesh.
  82493. */
  82494. getDirection(localAxis: Vector3): Vector3;
  82495. /**
  82496. * Sets the Vector3 "result" as the rotated Vector3 "localAxis" in the same rotation than the mesh.
  82497. * localAxis is expressed in the mesh local space.
  82498. * result is computed in the Wordl space from the mesh World matrix.
  82499. * @param localAxis axis to rotate
  82500. * @param result the resulting transformnode
  82501. * @returns this TransformNode.
  82502. */
  82503. getDirectionToRef(localAxis: Vector3, result: Vector3): TransformNode;
  82504. /**
  82505. * Sets this transform node rotation to the given local axis.
  82506. * @param localAxis the axis in local space
  82507. * @param yawCor optional yaw (y-axis) correction in radians
  82508. * @param pitchCor optional pitch (x-axis) correction in radians
  82509. * @param rollCor optional roll (z-axis) correction in radians
  82510. * @returns this TransformNode
  82511. */
  82512. setDirection(localAxis: Vector3, yawCor?: number, pitchCor?: number, rollCor?: number): TransformNode;
  82513. /**
  82514. * Sets a new pivot point to the current node
  82515. * @param point defines the new pivot point to use
  82516. * @param space defines if the point is in world or local space (local by default)
  82517. * @returns the current TransformNode
  82518. */
  82519. setPivotPoint(point: Vector3, space?: Space): TransformNode;
  82520. /**
  82521. * Returns a new Vector3 set with the mesh pivot point coordinates in the local space.
  82522. * @returns the pivot point
  82523. */
  82524. getPivotPoint(): Vector3;
  82525. /**
  82526. * Sets the passed Vector3 "result" with the coordinates of the mesh pivot point in the local space.
  82527. * @param result the vector3 to store the result
  82528. * @returns this TransformNode.
  82529. */
  82530. getPivotPointToRef(result: Vector3): TransformNode;
  82531. /**
  82532. * Returns a new Vector3 set with the mesh pivot point World coordinates.
  82533. * @returns a new Vector3 set with the mesh pivot point World coordinates.
  82534. */
  82535. getAbsolutePivotPoint(): Vector3;
  82536. /**
  82537. * Sets the Vector3 "result" coordinates with the mesh pivot point World coordinates.
  82538. * @param result vector3 to store the result
  82539. * @returns this TransformNode.
  82540. */
  82541. getAbsolutePivotPointToRef(result: Vector3): TransformNode;
  82542. /**
  82543. * Defines the passed node as the parent of the current node.
  82544. * The node will remain exactly where it is and its position / rotation will be updated accordingly
  82545. * @see https://doc.babylonjs.com/how_to/parenting
  82546. * @param node the node ot set as the parent
  82547. * @returns this TransformNode.
  82548. */
  82549. setParent(node: Nullable<Node>): TransformNode;
  82550. private _nonUniformScaling;
  82551. /**
  82552. * True if the scaling property of this object is non uniform eg. (1,2,1)
  82553. */
  82554. readonly nonUniformScaling: boolean;
  82555. /** @hidden */
  82556. _updateNonUniformScalingState(value: boolean): boolean;
  82557. /**
  82558. * Attach the current TransformNode to another TransformNode associated with a bone
  82559. * @param bone Bone affecting the TransformNode
  82560. * @param affectedTransformNode TransformNode associated with the bone
  82561. * @returns this object
  82562. */
  82563. attachToBone(bone: Bone, affectedTransformNode: TransformNode): TransformNode;
  82564. /**
  82565. * Detach the transform node if its associated with a bone
  82566. * @returns this object
  82567. */
  82568. detachFromBone(): TransformNode;
  82569. private static _rotationAxisCache;
  82570. /**
  82571. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in the given space.
  82572. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  82573. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  82574. * The passed axis is also normalized.
  82575. * @param axis the axis to rotate around
  82576. * @param amount the amount to rotate in radians
  82577. * @param space Space to rotate in (Default: local)
  82578. * @returns the TransformNode.
  82579. */
  82580. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  82581. /**
  82582. * Rotates the mesh around the axis vector for the passed angle (amount) expressed in radians, in world space.
  82583. * Note that the property `rotationQuaternion` is then automatically updated and the property `rotation` is set to (0,0,0) and no longer used.
  82584. * The passed axis is also normalized. .
  82585. * Method is based on http://www.euclideanspace.com/maths/geometry/affine/aroundPoint/index.htm
  82586. * @param point the point to rotate around
  82587. * @param axis the axis to rotate around
  82588. * @param amount the amount to rotate in radians
  82589. * @returns the TransformNode
  82590. */
  82591. rotateAround(point: Vector3, axis: Vector3, amount: number): TransformNode;
  82592. /**
  82593. * Translates the mesh along the axis vector for the passed distance in the given space.
  82594. * space (default LOCAL) can be either Space.LOCAL, either Space.WORLD.
  82595. * @param axis the axis to translate in
  82596. * @param distance the distance to translate
  82597. * @param space Space to rotate in (Default: local)
  82598. * @returns the TransformNode.
  82599. */
  82600. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  82601. /**
  82602. * Adds a rotation step to the mesh current rotation.
  82603. * x, y, z are Euler angles expressed in radians.
  82604. * This methods updates the current mesh rotation, either mesh.rotation, either mesh.rotationQuaternion if it's set.
  82605. * This means this rotation is made in the mesh local space only.
  82606. * It's useful to set a custom rotation order different from the BJS standard one YXZ.
  82607. * Example : this rotates the mesh first around its local X axis, then around its local Z axis, finally around its local Y axis.
  82608. * ```javascript
  82609. * mesh.addRotation(x1, 0, 0).addRotation(0, 0, z2).addRotation(0, 0, y3);
  82610. * ```
  82611. * Note that `addRotation()` accumulates the passed rotation values to the current ones and computes the .rotation or .rotationQuaternion updated values.
  82612. * 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.
  82613. * @param x Rotation to add
  82614. * @param y Rotation to add
  82615. * @param z Rotation to add
  82616. * @returns the TransformNode.
  82617. */
  82618. addRotation(x: number, y: number, z: number): TransformNode;
  82619. /**
  82620. * @hidden
  82621. */
  82622. protected _getEffectiveParent(): Nullable<Node>;
  82623. /**
  82624. * Computes the world matrix of the node
  82625. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  82626. * @returns the world matrix
  82627. */
  82628. computeWorldMatrix(force?: boolean): Matrix;
  82629. protected _afterComputeWorldMatrix(): void;
  82630. /**
  82631. * If you'd like to be called back after the mesh position, rotation or scaling has been updated.
  82632. * @param func callback function to add
  82633. *
  82634. * @returns the TransformNode.
  82635. */
  82636. registerAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  82637. /**
  82638. * Removes a registered callback function.
  82639. * @param func callback function to remove
  82640. * @returns the TransformNode.
  82641. */
  82642. unregisterAfterWorldMatrixUpdate(func: (mesh: TransformNode) => void): TransformNode;
  82643. /**
  82644. * Gets the position of the current mesh in camera space
  82645. * @param camera defines the camera to use
  82646. * @returns a position
  82647. */
  82648. getPositionInCameraSpace(camera?: Nullable<Camera>): Vector3;
  82649. /**
  82650. * Returns the distance from the mesh to the active camera
  82651. * @param camera defines the camera to use
  82652. * @returns the distance
  82653. */
  82654. getDistanceToCamera(camera?: Nullable<Camera>): number;
  82655. /**
  82656. * Clone the current transform node
  82657. * @param name Name of the new clone
  82658. * @param newParent New parent for the clone
  82659. * @param doNotCloneChildren Do not clone children hierarchy
  82660. * @returns the new transform node
  82661. */
  82662. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<TransformNode>;
  82663. /**
  82664. * Serializes the objects information.
  82665. * @param currentSerializationObject defines the object to serialize in
  82666. * @returns the serialized object
  82667. */
  82668. serialize(currentSerializationObject?: any): any;
  82669. /**
  82670. * Returns a new TransformNode object parsed from the source provided.
  82671. * @param parsedTransformNode is the source.
  82672. * @param scene the scne the object belongs to
  82673. * @param rootUrl is a string, it's the root URL to prefix the `delayLoadingFile` property with
  82674. * @returns a new TransformNode object parsed from the source provided.
  82675. */
  82676. static Parse(parsedTransformNode: any, scene: Scene, rootUrl: string): TransformNode;
  82677. /**
  82678. * Get all child-transformNodes of this node
  82679. * @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
  82680. * @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
  82681. * @returns an array of TransformNode
  82682. */
  82683. getChildTransformNodes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): TransformNode[];
  82684. /**
  82685. * Releases resources associated with this transform node.
  82686. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  82687. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  82688. */
  82689. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  82690. /**
  82691. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  82692. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  82693. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  82694. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  82695. * @returns the current mesh
  82696. */
  82697. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): TransformNode;
  82698. private _syncAbsoluteScalingAndRotation;
  82699. }
  82700. }
  82701. declare module BABYLON {
  82702. /**
  82703. * Defines the types of pose enabled controllers that are supported
  82704. */
  82705. export enum PoseEnabledControllerType {
  82706. /**
  82707. * HTC Vive
  82708. */
  82709. VIVE = 0,
  82710. /**
  82711. * Oculus Rift
  82712. */
  82713. OCULUS = 1,
  82714. /**
  82715. * Windows mixed reality
  82716. */
  82717. WINDOWS = 2,
  82718. /**
  82719. * Samsung gear VR
  82720. */
  82721. GEAR_VR = 3,
  82722. /**
  82723. * Google Daydream
  82724. */
  82725. DAYDREAM = 4,
  82726. /**
  82727. * Generic
  82728. */
  82729. GENERIC = 5
  82730. }
  82731. /**
  82732. * Defines the MutableGamepadButton interface for the state of a gamepad button
  82733. */
  82734. export interface MutableGamepadButton {
  82735. /**
  82736. * Value of the button/trigger
  82737. */
  82738. value: number;
  82739. /**
  82740. * If the button/trigger is currently touched
  82741. */
  82742. touched: boolean;
  82743. /**
  82744. * If the button/trigger is currently pressed
  82745. */
  82746. pressed: boolean;
  82747. }
  82748. /**
  82749. * Defines the ExtendedGamepadButton interface for a gamepad button which includes state provided by a pose controller
  82750. * @hidden
  82751. */
  82752. export interface ExtendedGamepadButton extends GamepadButton {
  82753. /**
  82754. * If the button/trigger is currently pressed
  82755. */
  82756. readonly pressed: boolean;
  82757. /**
  82758. * If the button/trigger is currently touched
  82759. */
  82760. readonly touched: boolean;
  82761. /**
  82762. * Value of the button/trigger
  82763. */
  82764. readonly value: number;
  82765. }
  82766. /** @hidden */
  82767. export interface _GamePadFactory {
  82768. /**
  82769. * Returns wether or not the current gamepad can be created for this type of controller.
  82770. * @param gamepadInfo Defines the gamepad info as receveid from the controller APIs.
  82771. * @returns true if it can be created, otherwise false
  82772. */
  82773. canCreate(gamepadInfo: any): boolean;
  82774. /**
  82775. * Creates a new instance of the Gamepad.
  82776. * @param gamepadInfo Defines the gamepad info as receveid from the controller APIs.
  82777. * @returns the new gamepad instance
  82778. */
  82779. create(gamepadInfo: any): Gamepad;
  82780. }
  82781. /**
  82782. * Defines the PoseEnabledControllerHelper object that is used initialize a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  82783. */
  82784. export class PoseEnabledControllerHelper {
  82785. /** @hidden */
  82786. static _ControllerFactories: _GamePadFactory[];
  82787. /** @hidden */
  82788. static _DefaultControllerFactory: Nullable<(gamepadInfo: any) => Gamepad>;
  82789. /**
  82790. * Initializes a gamepad as the controller type it is specified as (eg. windows mixed reality controller)
  82791. * @param vrGamepad the gamepad to initialized
  82792. * @returns a vr controller of the type the gamepad identified as
  82793. */
  82794. static InitiateController(vrGamepad: any): Gamepad;
  82795. }
  82796. /**
  82797. * Defines the PoseEnabledController object that contains state of a vr capable controller
  82798. */
  82799. export class PoseEnabledController extends Gamepad implements PoseControlled {
  82800. /**
  82801. * If the controller is used in a webXR session
  82802. */
  82803. isXR: boolean;
  82804. private _deviceRoomPosition;
  82805. private _deviceRoomRotationQuaternion;
  82806. /**
  82807. * The device position in babylon space
  82808. */
  82809. devicePosition: Vector3;
  82810. /**
  82811. * The device rotation in babylon space
  82812. */
  82813. deviceRotationQuaternion: Quaternion;
  82814. /**
  82815. * The scale factor of the device in babylon space
  82816. */
  82817. deviceScaleFactor: number;
  82818. /**
  82819. * (Likely devicePosition should be used instead) The device position in its room space
  82820. */
  82821. position: Vector3;
  82822. /**
  82823. * (Likely deviceRotationQuaternion should be used instead) The device rotation in its room space
  82824. */
  82825. rotationQuaternion: Quaternion;
  82826. /**
  82827. * The type of controller (Eg. Windows mixed reality)
  82828. */
  82829. controllerType: PoseEnabledControllerType;
  82830. protected _calculatedPosition: Vector3;
  82831. private _calculatedRotation;
  82832. /**
  82833. * The raw pose from the device
  82834. */
  82835. rawPose: DevicePose;
  82836. private _trackPosition;
  82837. private _maxRotationDistFromHeadset;
  82838. private _draggedRoomRotation;
  82839. /**
  82840. * @hidden
  82841. */
  82842. _disableTrackPosition(fixedPosition: Vector3): void;
  82843. /**
  82844. * Internal, the mesh attached to the controller
  82845. * @hidden
  82846. */
  82847. _mesh: Nullable<AbstractMesh>;
  82848. private _poseControlledCamera;
  82849. private _leftHandSystemQuaternion;
  82850. /**
  82851. * Internal, matrix used to convert room space to babylon space
  82852. * @hidden
  82853. */
  82854. _deviceToWorld: Matrix;
  82855. /**
  82856. * Node to be used when casting a ray from the controller
  82857. * @hidden
  82858. */
  82859. _pointingPoseNode: Nullable<TransformNode>;
  82860. /**
  82861. * Name of the child mesh that can be used to cast a ray from the controller
  82862. */
  82863. static readonly POINTING_POSE: string;
  82864. /**
  82865. * Creates a new PoseEnabledController from a gamepad
  82866. * @param browserGamepad the gamepad that the PoseEnabledController should be created from
  82867. */
  82868. constructor(browserGamepad: any);
  82869. private _workingMatrix;
  82870. /**
  82871. * Updates the state of the pose enbaled controller and mesh based on the current position and rotation of the controller
  82872. */
  82873. update(): void;
  82874. /**
  82875. * Updates only the pose device and mesh without doing any button event checking
  82876. */
  82877. protected _updatePoseAndMesh(): void;
  82878. /**
  82879. * Updates the state of the pose enbaled controller based on the raw pose data from the device
  82880. * @param poseData raw pose fromthe device
  82881. */
  82882. updateFromDevice(poseData: DevicePose): void;
  82883. /**
  82884. * @hidden
  82885. */
  82886. _meshAttachedObservable: Observable<AbstractMesh>;
  82887. /**
  82888. * Attaches a mesh to the controller
  82889. * @param mesh the mesh to be attached
  82890. */
  82891. attachToMesh(mesh: AbstractMesh): void;
  82892. /**
  82893. * Attaches the controllers mesh to a camera
  82894. * @param camera the camera the mesh should be attached to
  82895. */
  82896. attachToPoseControlledCamera(camera: TargetCamera): void;
  82897. /**
  82898. * Disposes of the controller
  82899. */
  82900. dispose(): void;
  82901. /**
  82902. * The mesh that is attached to the controller
  82903. */
  82904. readonly mesh: Nullable<AbstractMesh>;
  82905. /**
  82906. * Gets the ray of the controller in the direction the controller is pointing
  82907. * @param length the length the resulting ray should be
  82908. * @returns a ray in the direction the controller is pointing
  82909. */
  82910. getForwardRay(length?: number): Ray;
  82911. }
  82912. }
  82913. declare module BABYLON {
  82914. /**
  82915. * Defines the WebVRController object that represents controllers tracked in 3D space
  82916. */
  82917. export abstract class WebVRController extends PoseEnabledController {
  82918. /**
  82919. * Internal, the default controller model for the controller
  82920. */
  82921. protected _defaultModel: Nullable<AbstractMesh>;
  82922. /**
  82923. * Fired when the trigger state has changed
  82924. */
  82925. onTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  82926. /**
  82927. * Fired when the main button state has changed
  82928. */
  82929. onMainButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  82930. /**
  82931. * Fired when the secondary button state has changed
  82932. */
  82933. onSecondaryButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  82934. /**
  82935. * Fired when the pad state has changed
  82936. */
  82937. onPadStateChangedObservable: Observable<ExtendedGamepadButton>;
  82938. /**
  82939. * Fired when controllers stick values have changed
  82940. */
  82941. onPadValuesChangedObservable: Observable<StickValues>;
  82942. /**
  82943. * Array of button availible on the controller
  82944. */
  82945. protected _buttons: Array<MutableGamepadButton>;
  82946. private _onButtonStateChange;
  82947. /**
  82948. * Fired when a controller button's state has changed
  82949. * @param callback the callback containing the button that was modified
  82950. */
  82951. onButtonStateChange(callback: (controlledIndex: number, buttonIndex: number, state: ExtendedGamepadButton) => void): void;
  82952. /**
  82953. * X and Y axis corresponding to the controllers joystick
  82954. */
  82955. pad: StickValues;
  82956. /**
  82957. * 'left' or 'right', see https://w3c.github.io/gamepad/extensions.html#gamepadhand-enum
  82958. */
  82959. hand: string;
  82960. /**
  82961. * The default controller model for the controller
  82962. */
  82963. readonly defaultModel: Nullable<AbstractMesh>;
  82964. /**
  82965. * Creates a new WebVRController from a gamepad
  82966. * @param vrGamepad the gamepad that the WebVRController should be created from
  82967. */
  82968. constructor(vrGamepad: any);
  82969. /**
  82970. * Updates the state of the controller and mesh based on the current position and rotation of the controller
  82971. */
  82972. update(): void;
  82973. /**
  82974. * Function to be called when a button is modified
  82975. */
  82976. protected abstract _handleButtonChange(buttonIdx: number, value: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  82977. /**
  82978. * Loads a mesh and attaches it to the controller
  82979. * @param scene the scene the mesh should be added to
  82980. * @param meshLoaded callback for when the mesh has been loaded
  82981. */
  82982. abstract initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  82983. private _setButtonValue;
  82984. private _changes;
  82985. private _checkChanges;
  82986. /**
  82987. * Disposes of th webVRCOntroller
  82988. */
  82989. dispose(): void;
  82990. }
  82991. }
  82992. declare module BABYLON {
  82993. /**
  82994. * The HemisphericLight simulates the ambient environment light,
  82995. * so the passed direction is the light reflection direction, not the incoming direction.
  82996. */
  82997. export class HemisphericLight extends Light {
  82998. /**
  82999. * The groundColor is the light in the opposite direction to the one specified during creation.
  83000. * 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.
  83001. */
  83002. groundColor: Color3;
  83003. /**
  83004. * The light reflection direction, not the incoming direction.
  83005. */
  83006. direction: Vector3;
  83007. /**
  83008. * Creates a HemisphericLight object in the scene according to the passed direction (Vector3).
  83009. * The HemisphericLight simulates the ambient environment light, so the passed direction is the light reflection direction, not the incoming direction.
  83010. * The HemisphericLight can't cast shadows.
  83011. * Documentation : https://doc.babylonjs.com/babylon101/lights
  83012. * @param name The friendly name of the light
  83013. * @param direction The direction of the light reflection
  83014. * @param scene The scene the light belongs to
  83015. */
  83016. constructor(name: string, direction: Vector3, scene: Scene);
  83017. protected _buildUniformLayout(): void;
  83018. /**
  83019. * Returns the string "HemisphericLight".
  83020. * @return The class name
  83021. */
  83022. getClassName(): string;
  83023. /**
  83024. * Sets the HemisphericLight direction towards the passed target (Vector3).
  83025. * Returns the updated direction.
  83026. * @param target The target the direction should point to
  83027. * @return The computed direction
  83028. */
  83029. setDirectionToTarget(target: Vector3): Vector3;
  83030. /**
  83031. * Returns the shadow generator associated to the light.
  83032. * @returns Always null for hemispheric lights because it does not support shadows.
  83033. */
  83034. getShadowGenerator(): Nullable<IShadowGenerator>;
  83035. /**
  83036. * Sets the passed Effect object with the HemisphericLight normalized direction and color and the passed name (string).
  83037. * @param effect The effect to update
  83038. * @param lightIndex The index of the light in the effect to update
  83039. * @returns The hemispheric light
  83040. */
  83041. transferToEffect(effect: Effect, lightIndex: string): HemisphericLight;
  83042. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  83043. /**
  83044. * Computes the world matrix of the node
  83045. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  83046. * @param useWasUpdatedFlag defines a reserved property
  83047. * @returns the world matrix
  83048. */
  83049. computeWorldMatrix(): Matrix;
  83050. /**
  83051. * Returns the integer 3.
  83052. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  83053. */
  83054. getTypeID(): number;
  83055. /**
  83056. * Prepares the list of defines specific to the light type.
  83057. * @param defines the list of defines
  83058. * @param lightIndex defines the index of the light for the effect
  83059. */
  83060. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  83061. }
  83062. }
  83063. declare module BABYLON {
  83064. /** @hidden */
  83065. export var vrMultiviewToSingleviewPixelShader: {
  83066. name: string;
  83067. shader: string;
  83068. };
  83069. }
  83070. declare module BABYLON {
  83071. /**
  83072. * Renders to multiple views with a single draw call
  83073. * @see https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/
  83074. */
  83075. export class MultiviewRenderTarget extends RenderTargetTexture {
  83076. /**
  83077. * Creates a multiview render target
  83078. * @param scene scene used with the render target
  83079. * @param size the size of the render target (used for each view)
  83080. */
  83081. constructor(scene: Scene, size?: number | {
  83082. width: number;
  83083. height: number;
  83084. } | {
  83085. ratio: number;
  83086. });
  83087. /**
  83088. * @hidden
  83089. * @param faceIndex the face index, if its a cube texture
  83090. */
  83091. _bindFrameBuffer(faceIndex?: number): void;
  83092. /**
  83093. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  83094. * @returns the view count
  83095. */
  83096. getViewCount(): number;
  83097. }
  83098. }
  83099. declare module BABYLON {
  83100. /**
  83101. * Represents a camera frustum
  83102. */
  83103. export class Frustum {
  83104. /**
  83105. * Gets the planes representing the frustum
  83106. * @param transform matrix to be applied to the returned planes
  83107. * @returns a new array of 6 Frustum planes computed by the given transformation matrix.
  83108. */
  83109. static GetPlanes(transform: DeepImmutable<Matrix>): Plane[];
  83110. /**
  83111. * Gets the near frustum plane transformed by the transform matrix
  83112. * @param transform transformation matrix to be applied to the resulting frustum plane
  83113. * @param frustumPlane the resuling frustum plane
  83114. */
  83115. static GetNearPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  83116. /**
  83117. * Gets the far frustum plane transformed by the transform matrix
  83118. * @param transform transformation matrix to be applied to the resulting frustum plane
  83119. * @param frustumPlane the resuling frustum plane
  83120. */
  83121. static GetFarPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  83122. /**
  83123. * Gets the left frustum plane transformed by the transform matrix
  83124. * @param transform transformation matrix to be applied to the resulting frustum plane
  83125. * @param frustumPlane the resuling frustum plane
  83126. */
  83127. static GetLeftPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  83128. /**
  83129. * Gets the right frustum plane transformed by the transform matrix
  83130. * @param transform transformation matrix to be applied to the resulting frustum plane
  83131. * @param frustumPlane the resuling frustum plane
  83132. */
  83133. static GetRightPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  83134. /**
  83135. * Gets the top frustum plane transformed by the transform matrix
  83136. * @param transform transformation matrix to be applied to the resulting frustum plane
  83137. * @param frustumPlane the resuling frustum plane
  83138. */
  83139. static GetTopPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  83140. /**
  83141. * Gets the bottom frustum plane transformed by the transform matrix
  83142. * @param transform transformation matrix to be applied to the resulting frustum plane
  83143. * @param frustumPlane the resuling frustum plane
  83144. */
  83145. static GetBottomPlaneToRef(transform: DeepImmutable<Matrix>, frustumPlane: Plane): void;
  83146. /**
  83147. * Sets the given array "frustumPlanes" with the 6 Frustum planes computed by the given transformation matrix.
  83148. * @param transform transformation matrix to be applied to the resulting frustum planes
  83149. * @param frustumPlanes the resuling frustum planes
  83150. */
  83151. static GetPlanesToRef(transform: DeepImmutable<Matrix>, frustumPlanes: Plane[]): void;
  83152. }
  83153. }
  83154. declare module BABYLON {
  83155. interface Engine {
  83156. /**
  83157. * Creates a new multiview render target
  83158. * @param width defines the width of the texture
  83159. * @param height defines the height of the texture
  83160. * @returns the created multiview texture
  83161. */
  83162. createMultiviewRenderTargetTexture(width: number, height: number): InternalTexture;
  83163. /**
  83164. * Binds a multiview framebuffer to be drawn to
  83165. * @param multiviewTexture texture to bind
  83166. */
  83167. bindMultiviewFramebuffer(multiviewTexture: InternalTexture): void;
  83168. }
  83169. interface Camera {
  83170. /**
  83171. * @hidden
  83172. * 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)
  83173. */
  83174. _useMultiviewToSingleView: boolean;
  83175. /**
  83176. * @hidden
  83177. * 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)
  83178. */
  83179. _multiviewTexture: Nullable<RenderTargetTexture>;
  83180. /**
  83181. * @hidden
  83182. * ensures the multiview texture of the camera exists and has the specified width/height
  83183. * @param width height to set on the multiview texture
  83184. * @param height width to set on the multiview texture
  83185. */
  83186. _resizeOrCreateMultiviewTexture(width: number, height: number): void;
  83187. }
  83188. interface Scene {
  83189. /** @hidden */
  83190. _transformMatrixR: Matrix;
  83191. /** @hidden */
  83192. _multiviewSceneUbo: Nullable<UniformBuffer>;
  83193. /** @hidden */
  83194. _createMultiviewUbo(): void;
  83195. /** @hidden */
  83196. _updateMultiviewUbo(viewR?: Matrix, projectionR?: Matrix): void;
  83197. /** @hidden */
  83198. _renderMultiviewToSingleView(camera: Camera): void;
  83199. }
  83200. }
  83201. declare module BABYLON {
  83202. /**
  83203. * VRMultiviewToSingleview used to convert multiview texture arrays to standard textures for scenarios such as webVR
  83204. * This will not be used for webXR as it supports displaying texture arrays directly
  83205. */
  83206. export class VRMultiviewToSingleviewPostProcess extends PostProcess {
  83207. /**
  83208. * Initializes a VRMultiviewToSingleview
  83209. * @param name name of the post process
  83210. * @param camera camera to be applied to
  83211. * @param scaleFactor scaling factor to the size of the output texture
  83212. */
  83213. constructor(name: string, camera: Camera, scaleFactor: number);
  83214. }
  83215. }
  83216. declare module BABYLON {
  83217. /**
  83218. * Interface used to define additional presentation attributes
  83219. */
  83220. export interface IVRPresentationAttributes {
  83221. /**
  83222. * Defines a boolean indicating that we want to get 72hz mode on Oculus Browser (default is off eg. 60hz)
  83223. */
  83224. highRefreshRate: boolean;
  83225. /**
  83226. * Enables foveation in VR to improve perf. 0 none, 1 low, 2 medium, 3 high (Default is 1)
  83227. */
  83228. foveationLevel: number;
  83229. }
  83230. interface Engine {
  83231. /** @hidden */
  83232. _vrDisplay: any;
  83233. /** @hidden */
  83234. _vrSupported: boolean;
  83235. /** @hidden */
  83236. _oldSize: Size;
  83237. /** @hidden */
  83238. _oldHardwareScaleFactor: number;
  83239. /** @hidden */
  83240. _vrExclusivePointerMode: boolean;
  83241. /** @hidden */
  83242. _webVRInitPromise: Promise<IDisplayChangedEventArgs>;
  83243. /** @hidden */
  83244. _onVRDisplayPointerRestricted: () => void;
  83245. /** @hidden */
  83246. _onVRDisplayPointerUnrestricted: () => void;
  83247. /** @hidden */
  83248. _onVrDisplayConnect: Nullable<(display: any) => void>;
  83249. /** @hidden */
  83250. _onVrDisplayDisconnect: Nullable<() => void>;
  83251. /** @hidden */
  83252. _onVrDisplayPresentChange: Nullable<() => void>;
  83253. /**
  83254. * Observable signaled when VR display mode changes
  83255. */
  83256. onVRDisplayChangedObservable: Observable<IDisplayChangedEventArgs>;
  83257. /**
  83258. * Observable signaled when VR request present is complete
  83259. */
  83260. onVRRequestPresentComplete: Observable<boolean>;
  83261. /**
  83262. * Observable signaled when VR request present starts
  83263. */
  83264. onVRRequestPresentStart: Observable<Engine>;
  83265. /**
  83266. * Gets a boolean indicating that the engine is currently in VR exclusive mode for the pointers
  83267. * @see https://docs.microsoft.com/en-us/microsoft-edge/webvr/essentials#mouse-input
  83268. */
  83269. isInVRExclusivePointerMode: boolean;
  83270. /**
  83271. * Gets a boolean indicating if a webVR device was detected
  83272. * @returns true if a webVR device was detected
  83273. */
  83274. isVRDevicePresent(): boolean;
  83275. /**
  83276. * Gets the current webVR device
  83277. * @returns the current webVR device (or null)
  83278. */
  83279. getVRDevice(): any;
  83280. /**
  83281. * Initializes a webVR display and starts listening to display change events
  83282. * The onVRDisplayChangedObservable will be notified upon these changes
  83283. * @returns A promise containing a VRDisplay and if vr is supported
  83284. */
  83285. initWebVRAsync(): Promise<IDisplayChangedEventArgs>;
  83286. /** @hidden */
  83287. _getVRDisplaysAsync(): Promise<IDisplayChangedEventArgs>;
  83288. /**
  83289. * Gets or sets the presentation attributes used to configure VR rendering
  83290. */
  83291. vrPresentationAttributes?: IVRPresentationAttributes;
  83292. /**
  83293. * Call this function to switch to webVR mode
  83294. * Will do nothing if webVR is not supported or if there is no webVR device
  83295. * @param options the webvr options provided to the camera. mainly used for multiview
  83296. * @see http://doc.babylonjs.com/how_to/webvr_camera
  83297. */
  83298. enableVR(options: WebVROptions): void;
  83299. /** @hidden */
  83300. _onVRFullScreenTriggered(): void;
  83301. }
  83302. }
  83303. declare module BABYLON {
  83304. /**
  83305. * This is a copy of VRPose. See https://developer.mozilla.org/en-US/docs/Web/API/VRPose
  83306. * IMPORTANT!! The data is right-hand data.
  83307. * @export
  83308. * @interface DevicePose
  83309. */
  83310. export interface DevicePose {
  83311. /**
  83312. * The position of the device, values in array are [x,y,z].
  83313. */
  83314. readonly position: Nullable<Float32Array>;
  83315. /**
  83316. * The linearVelocity of the device, values in array are [x,y,z].
  83317. */
  83318. readonly linearVelocity: Nullable<Float32Array>;
  83319. /**
  83320. * The linearAcceleration of the device, values in array are [x,y,z].
  83321. */
  83322. readonly linearAcceleration: Nullable<Float32Array>;
  83323. /**
  83324. * The orientation of the device in a quaternion array, values in array are [x,y,z,w].
  83325. */
  83326. readonly orientation: Nullable<Float32Array>;
  83327. /**
  83328. * The angularVelocity of the device, values in array are [x,y,z].
  83329. */
  83330. readonly angularVelocity: Nullable<Float32Array>;
  83331. /**
  83332. * The angularAcceleration of the device, values in array are [x,y,z].
  83333. */
  83334. readonly angularAcceleration: Nullable<Float32Array>;
  83335. }
  83336. /**
  83337. * Interface representing a pose controlled object in Babylon.
  83338. * A pose controlled object has both regular pose values as well as pose values
  83339. * from an external device such as a VR head mounted display
  83340. */
  83341. export interface PoseControlled {
  83342. /**
  83343. * The position of the object in babylon space.
  83344. */
  83345. position: Vector3;
  83346. /**
  83347. * The rotation quaternion of the object in babylon space.
  83348. */
  83349. rotationQuaternion: Quaternion;
  83350. /**
  83351. * The position of the device in babylon space.
  83352. */
  83353. devicePosition?: Vector3;
  83354. /**
  83355. * The rotation quaternion of the device in babylon space.
  83356. */
  83357. deviceRotationQuaternion: Quaternion;
  83358. /**
  83359. * The raw pose coming from the device.
  83360. */
  83361. rawPose: Nullable<DevicePose>;
  83362. /**
  83363. * The scale of the device to be used when translating from device space to babylon space.
  83364. */
  83365. deviceScaleFactor: number;
  83366. /**
  83367. * Updates the poseControlled values based on the input device pose.
  83368. * @param poseData the pose data to update the object with
  83369. */
  83370. updateFromDevice(poseData: DevicePose): void;
  83371. }
  83372. /**
  83373. * Set of options to customize the webVRCamera
  83374. */
  83375. export interface WebVROptions {
  83376. /**
  83377. * Sets if the webVR camera should be tracked to the vrDevice. (default: true)
  83378. */
  83379. trackPosition?: boolean;
  83380. /**
  83381. * Sets the scale of the vrDevice in babylon space. (default: 1)
  83382. */
  83383. positionScale?: number;
  83384. /**
  83385. * If there are more than one VRDisplays, this will choose the display matching this name. (default: pick first vrDisplay)
  83386. */
  83387. displayName?: string;
  83388. /**
  83389. * Should the native controller meshes be initialized. (default: true)
  83390. */
  83391. controllerMeshes?: boolean;
  83392. /**
  83393. * Creating a default HemiLight only on controllers. (default: true)
  83394. */
  83395. defaultLightingOnControllers?: boolean;
  83396. /**
  83397. * If you don't want to use the default VR button of the helper. (default: false)
  83398. */
  83399. useCustomVRButton?: boolean;
  83400. /**
  83401. * If you'd like to provide your own button to the VRHelper. (default: standard babylon vr button)
  83402. */
  83403. customVRButton?: HTMLButtonElement;
  83404. /**
  83405. * To change the length of the ray for gaze/controllers. Will be scaled by positionScale. (default: 100)
  83406. */
  83407. rayLength?: number;
  83408. /**
  83409. * To change the default offset from the ground to account for user's height in meters. Will be scaled by positionScale. (default: 1.7)
  83410. */
  83411. defaultHeight?: number;
  83412. /**
  83413. * If multiview should be used if availible (default: false)
  83414. */
  83415. useMultiview?: boolean;
  83416. }
  83417. /**
  83418. * This represents a WebVR camera.
  83419. * The WebVR camera is Babylon's simple interface to interaction with Windows Mixed Reality, HTC Vive and Oculus Rift.
  83420. * @example http://doc.babylonjs.com/how_to/webvr_camera
  83421. */
  83422. export class WebVRFreeCamera extends FreeCamera implements PoseControlled {
  83423. private webVROptions;
  83424. /**
  83425. * @hidden
  83426. * The vrDisplay tied to the camera. See https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay
  83427. */
  83428. _vrDevice: any;
  83429. /**
  83430. * The rawPose of the vrDevice.
  83431. */
  83432. rawPose: Nullable<DevicePose>;
  83433. private _onVREnabled;
  83434. private _specsVersion;
  83435. private _attached;
  83436. private _frameData;
  83437. protected _descendants: Array<Node>;
  83438. private _deviceRoomPosition;
  83439. /** @hidden */
  83440. _deviceRoomRotationQuaternion: Quaternion;
  83441. private _standingMatrix;
  83442. /**
  83443. * Represents device position in babylon space.
  83444. */
  83445. devicePosition: Vector3;
  83446. /**
  83447. * Represents device rotation in babylon space.
  83448. */
  83449. deviceRotationQuaternion: Quaternion;
  83450. /**
  83451. * The scale of the device to be used when translating from device space to babylon space.
  83452. */
  83453. deviceScaleFactor: number;
  83454. private _deviceToWorld;
  83455. private _worldToDevice;
  83456. /**
  83457. * References to the webVR controllers for the vrDevice.
  83458. */
  83459. controllers: Array<WebVRController>;
  83460. /**
  83461. * Emits an event when a controller is attached.
  83462. */
  83463. onControllersAttachedObservable: Observable<WebVRController[]>;
  83464. /**
  83465. * Emits an event when a controller's mesh has been loaded;
  83466. */
  83467. onControllerMeshLoadedObservable: Observable<WebVRController>;
  83468. /**
  83469. * Emits an event when the HMD's pose has been updated.
  83470. */
  83471. onPoseUpdatedFromDeviceObservable: Observable<any>;
  83472. private _poseSet;
  83473. /**
  83474. * If the rig cameras be used as parent instead of this camera.
  83475. */
  83476. rigParenting: boolean;
  83477. private _lightOnControllers;
  83478. private _defaultHeight?;
  83479. /**
  83480. * Instantiates a WebVRFreeCamera.
  83481. * @param name The name of the WebVRFreeCamera
  83482. * @param position The starting anchor position for the camera
  83483. * @param scene The scene the camera belongs to
  83484. * @param webVROptions a set of customizable options for the webVRCamera
  83485. */
  83486. constructor(name: string, position: Vector3, scene: Scene, webVROptions?: WebVROptions);
  83487. /**
  83488. * Gets the device distance from the ground in meters.
  83489. * @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.
  83490. */
  83491. deviceDistanceToRoomGround(): number;
  83492. /**
  83493. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  83494. * @param callback will be called when the standing matrix is set. Callback parameter is if the standing matrix is supported.
  83495. */
  83496. useStandingMatrix(callback?: (bool: boolean) => void): void;
  83497. /**
  83498. * Enables the standing matrix when supported. This can be used to position the user's view the correct height from the ground.
  83499. * @returns A promise with a boolean set to if the standing matrix is supported.
  83500. */
  83501. useStandingMatrixAsync(): Promise<boolean>;
  83502. /**
  83503. * Disposes the camera
  83504. */
  83505. dispose(): void;
  83506. /**
  83507. * Gets a vrController by name.
  83508. * @param name The name of the controller to retreive
  83509. * @returns the controller matching the name specified or null if not found
  83510. */
  83511. getControllerByName(name: string): Nullable<WebVRController>;
  83512. private _leftController;
  83513. /**
  83514. * The controller corresponding to the users left hand.
  83515. */
  83516. readonly leftController: Nullable<WebVRController>;
  83517. private _rightController;
  83518. /**
  83519. * The controller corresponding to the users right hand.
  83520. */
  83521. readonly rightController: Nullable<WebVRController>;
  83522. /**
  83523. * Casts a ray forward from the vrCamera's gaze.
  83524. * @param length Length of the ray (default: 100)
  83525. * @returns the ray corresponding to the gaze
  83526. */
  83527. getForwardRay(length?: number): Ray;
  83528. /**
  83529. * @hidden
  83530. * Updates the camera based on device's frame data
  83531. */
  83532. _checkInputs(): void;
  83533. /**
  83534. * Updates the poseControlled values based on the input device pose.
  83535. * @param poseData Pose coming from the device
  83536. */
  83537. updateFromDevice(poseData: DevicePose): void;
  83538. private _htmlElementAttached;
  83539. private _detachIfAttached;
  83540. /**
  83541. * WebVR's attach control will start broadcasting frames to the device.
  83542. * Note that in certain browsers (chrome for example) this function must be called
  83543. * within a user-interaction callback. Example:
  83544. * <pre> scene.onPointerDown = function() { camera.attachControl(canvas); }</pre>
  83545. *
  83546. * @param element html element to attach the vrDevice to
  83547. * @param noPreventDefault prevent the default html element operation when attaching the vrDevice
  83548. */
  83549. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  83550. /**
  83551. * Detaches the camera from the html element and disables VR
  83552. *
  83553. * @param element html element to detach from
  83554. */
  83555. detachControl(element: HTMLElement): void;
  83556. /**
  83557. * @returns the name of this class
  83558. */
  83559. getClassName(): string;
  83560. /**
  83561. * Calls resetPose on the vrDisplay
  83562. * See: https://developer.mozilla.org/en-US/docs/Web/API/VRDisplay/resetPose
  83563. */
  83564. resetToCurrentRotation(): void;
  83565. /**
  83566. * @hidden
  83567. * Updates the rig cameras (left and right eye)
  83568. */
  83569. _updateRigCameras(): void;
  83570. private _workingVector;
  83571. private _oneVector;
  83572. private _workingMatrix;
  83573. private updateCacheCalled;
  83574. private _correctPositionIfNotTrackPosition;
  83575. /**
  83576. * @hidden
  83577. * Updates the cached values of the camera
  83578. * @param ignoreParentClass ignores updating the parent class's cache (default: false)
  83579. */
  83580. _updateCache(ignoreParentClass?: boolean): void;
  83581. /**
  83582. * @hidden
  83583. * Get current device position in babylon world
  83584. */
  83585. _computeDevicePosition(): void;
  83586. /**
  83587. * Updates the current device position and rotation in the babylon world
  83588. */
  83589. update(): void;
  83590. /**
  83591. * @hidden
  83592. * Gets the view matrix of this camera (Always set to identity as left and right eye cameras contain the actual view matrix)
  83593. * @returns an identity matrix
  83594. */
  83595. _getViewMatrix(): Matrix;
  83596. private _tmpMatrix;
  83597. /**
  83598. * This function is called by the two RIG cameras.
  83599. * 'this' is the left or right camera (and NOT (!!!) the WebVRFreeCamera instance)
  83600. * @hidden
  83601. */
  83602. _getWebVRViewMatrix(): Matrix;
  83603. /** @hidden */
  83604. _getWebVRProjectionMatrix(): Matrix;
  83605. private _onGamepadConnectedObserver;
  83606. private _onGamepadDisconnectedObserver;
  83607. private _updateCacheWhenTrackingDisabledObserver;
  83608. /**
  83609. * Initializes the controllers and their meshes
  83610. */
  83611. initControllers(): void;
  83612. }
  83613. }
  83614. declare module BABYLON {
  83615. /**
  83616. * Size options for a post process
  83617. */
  83618. export type PostProcessOptions = {
  83619. width: number;
  83620. height: number;
  83621. };
  83622. /**
  83623. * PostProcess can be used to apply a shader to a texture after it has been rendered
  83624. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  83625. */
  83626. export class PostProcess {
  83627. /** Name of the PostProcess. */
  83628. name: string;
  83629. /**
  83630. * Gets or sets the unique id of the post process
  83631. */
  83632. uniqueId: number;
  83633. /**
  83634. * Width of the texture to apply the post process on
  83635. */
  83636. width: number;
  83637. /**
  83638. * Height of the texture to apply the post process on
  83639. */
  83640. height: number;
  83641. /**
  83642. * Internal, reference to the location where this postprocess was output to. (Typically the texture on the next postprocess in the chain)
  83643. * @hidden
  83644. */
  83645. _outputTexture: Nullable<InternalTexture>;
  83646. /**
  83647. * Sampling mode used by the shader
  83648. * See https://doc.babylonjs.com/classes/3.1/texture
  83649. */
  83650. renderTargetSamplingMode: number;
  83651. /**
  83652. * Clear color to use when screen clearing
  83653. */
  83654. clearColor: Color4;
  83655. /**
  83656. * If the buffer needs to be cleared before applying the post process. (default: true)
  83657. * Should be set to false if shader will overwrite all previous pixels.
  83658. */
  83659. autoClear: boolean;
  83660. /**
  83661. * Type of alpha mode to use when performing the post process (default: Engine.ALPHA_DISABLE)
  83662. */
  83663. alphaMode: number;
  83664. /**
  83665. * Sets the setAlphaBlendConstants of the babylon engine
  83666. */
  83667. alphaConstants: Color4;
  83668. /**
  83669. * Animations to be used for the post processing
  83670. */
  83671. animations: Animation[];
  83672. /**
  83673. * Enable Pixel Perfect mode where texture is not scaled to be power of 2.
  83674. * Can only be used on a single postprocess or on the last one of a chain. (default: false)
  83675. */
  83676. enablePixelPerfectMode: boolean;
  83677. /**
  83678. * Force the postprocess to be applied without taking in account viewport
  83679. */
  83680. forceFullscreenViewport: boolean;
  83681. /**
  83682. * List of inspectable custom properties (used by the Inspector)
  83683. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  83684. */
  83685. inspectableCustomProperties: IInspectable[];
  83686. /**
  83687. * Scale mode for the post process (default: Engine.SCALEMODE_FLOOR)
  83688. *
  83689. * | Value | Type | Description |
  83690. * | ----- | ----------------------------------- | ----------- |
  83691. * | 1 | SCALEMODE_FLOOR | [engine.scalemode_floor](http://doc.babylonjs.com/api/classes/babylon.engine#scalemode_floor) |
  83692. * | 2 | SCALEMODE_NEAREST | [engine.scalemode_nearest](http://doc.babylonjs.com/api/classes/babylon.engine#scalemode_nearest) |
  83693. * | 3 | SCALEMODE_CEILING | [engine.scalemode_ceiling](http://doc.babylonjs.com/api/classes/babylon.engine#scalemode_ceiling) |
  83694. *
  83695. */
  83696. scaleMode: number;
  83697. /**
  83698. * Force textures to be a power of two (default: false)
  83699. */
  83700. alwaysForcePOT: boolean;
  83701. private _samples;
  83702. /**
  83703. * Number of sample textures (default: 1)
  83704. */
  83705. samples: number;
  83706. /**
  83707. * Modify the scale of the post process to be the same as the viewport (default: false)
  83708. */
  83709. adaptScaleToCurrentViewport: boolean;
  83710. private _camera;
  83711. private _scene;
  83712. private _engine;
  83713. private _options;
  83714. private _reusable;
  83715. private _textureType;
  83716. /**
  83717. * Smart array of input and output textures for the post process.
  83718. * @hidden
  83719. */
  83720. _textures: SmartArray<InternalTexture>;
  83721. /**
  83722. * The index in _textures that corresponds to the output texture.
  83723. * @hidden
  83724. */
  83725. _currentRenderTextureInd: number;
  83726. private _effect;
  83727. private _samplers;
  83728. private _fragmentUrl;
  83729. private _vertexUrl;
  83730. private _parameters;
  83731. private _scaleRatio;
  83732. protected _indexParameters: any;
  83733. private _shareOutputWithPostProcess;
  83734. private _texelSize;
  83735. private _forcedOutputTexture;
  83736. /**
  83737. * Returns the fragment url or shader name used in the post process.
  83738. * @returns the fragment url or name in the shader store.
  83739. */
  83740. getEffectName(): string;
  83741. /**
  83742. * An event triggered when the postprocess is activated.
  83743. */
  83744. onActivateObservable: Observable<Camera>;
  83745. private _onActivateObserver;
  83746. /**
  83747. * A function that is added to the onActivateObservable
  83748. */
  83749. onActivate: Nullable<(camera: Camera) => void>;
  83750. /**
  83751. * An event triggered when the postprocess changes its size.
  83752. */
  83753. onSizeChangedObservable: Observable<PostProcess>;
  83754. private _onSizeChangedObserver;
  83755. /**
  83756. * A function that is added to the onSizeChangedObservable
  83757. */
  83758. onSizeChanged: (postProcess: PostProcess) => void;
  83759. /**
  83760. * An event triggered when the postprocess applies its effect.
  83761. */
  83762. onApplyObservable: Observable<Effect>;
  83763. private _onApplyObserver;
  83764. /**
  83765. * A function that is added to the onApplyObservable
  83766. */
  83767. onApply: (effect: Effect) => void;
  83768. /**
  83769. * An event triggered before rendering the postprocess
  83770. */
  83771. onBeforeRenderObservable: Observable<Effect>;
  83772. private _onBeforeRenderObserver;
  83773. /**
  83774. * A function that is added to the onBeforeRenderObservable
  83775. */
  83776. onBeforeRender: (effect: Effect) => void;
  83777. /**
  83778. * An event triggered after rendering the postprocess
  83779. */
  83780. onAfterRenderObservable: Observable<Effect>;
  83781. private _onAfterRenderObserver;
  83782. /**
  83783. * A function that is added to the onAfterRenderObservable
  83784. */
  83785. onAfterRender: (efect: Effect) => void;
  83786. /**
  83787. * 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
  83788. * render it's output into this texture and this texture will be used as textureSampler in the fragment shader of this post process.
  83789. */
  83790. inputTexture: InternalTexture;
  83791. /**
  83792. * Gets the camera which post process is applied to.
  83793. * @returns The camera the post process is applied to.
  83794. */
  83795. getCamera(): Camera;
  83796. /**
  83797. * Gets the texel size of the postprocess.
  83798. * See https://en.wikipedia.org/wiki/Texel_(graphics)
  83799. */
  83800. readonly texelSize: Vector2;
  83801. /**
  83802. * Creates a new instance PostProcess
  83803. * @param name The name of the PostProcess.
  83804. * @param fragmentUrl The url of the fragment shader to be used.
  83805. * @param parameters Array of the names of uniform non-sampler2D variables that will be passed to the shader.
  83806. * @param samplers Array of the names of uniform sampler2D variables that will be passed to the shader.
  83807. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  83808. * @param camera The camera to apply the render pass to.
  83809. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  83810. * @param engine The engine which the post process will be applied. (default: current engine)
  83811. * @param reusable If the post process can be reused on the same frame. (default: false)
  83812. * @param defines String of defines that will be set when running the fragment shader. (default: null)
  83813. * @param textureType Type of textures used when performing the post process. (default: 0)
  83814. * @param vertexUrl The url of the vertex shader to be used. (default: "postprocess")
  83815. * @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
  83816. * @param blockCompilation If the shader should not be compiled imediatly. (default: false)
  83817. */
  83818. constructor(
  83819. /** Name of the PostProcess. */
  83820. 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);
  83821. /**
  83822. * Gets a string idenfifying the name of the class
  83823. * @returns "PostProcess" string
  83824. */
  83825. getClassName(): string;
  83826. /**
  83827. * Gets the engine which this post process belongs to.
  83828. * @returns The engine the post process was enabled with.
  83829. */
  83830. getEngine(): Engine;
  83831. /**
  83832. * The effect that is created when initializing the post process.
  83833. * @returns The created effect corresponding the the postprocess.
  83834. */
  83835. getEffect(): Effect;
  83836. /**
  83837. * To avoid multiple redundant textures for multiple post process, the output the output texture for this post process can be shared with another.
  83838. * @param postProcess The post process to share the output with.
  83839. * @returns This post process.
  83840. */
  83841. shareOutputWith(postProcess: PostProcess): PostProcess;
  83842. /**
  83843. * Reverses the effect of calling shareOutputWith and returns the post process back to its original state.
  83844. * This should be called if the post process that shares output with this post process is disabled/disposed.
  83845. */
  83846. useOwnOutput(): void;
  83847. /**
  83848. * Updates the effect with the current post process compile time values and recompiles the shader.
  83849. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  83850. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  83851. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  83852. * @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
  83853. * @param onCompiled Called when the shader has been compiled.
  83854. * @param onError Called if there is an error when compiling a shader.
  83855. */
  83856. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  83857. /**
  83858. * The post process is reusable if it can be used multiple times within one frame.
  83859. * @returns If the post process is reusable
  83860. */
  83861. isReusable(): boolean;
  83862. /** invalidate frameBuffer to hint the postprocess to create a depth buffer */
  83863. markTextureDirty(): void;
  83864. /**
  83865. * Activates the post process by intializing the textures to be used when executed. Notifies onActivateObservable.
  83866. * 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.
  83867. * @param camera The camera that will be used in the post process. This camera will be used when calling onActivateObservable.
  83868. * @param sourceTexture The source texture to be inspected to get the width and height if not specified in the post process constructor. (default: null)
  83869. * @param forceDepthStencil If true, a depth and stencil buffer will be generated. (default: false)
  83870. * @returns The target texture that was bound to be written to.
  83871. */
  83872. activate(camera: Nullable<Camera>, sourceTexture?: Nullable<InternalTexture>, forceDepthStencil?: boolean): InternalTexture;
  83873. /**
  83874. * If the post process is supported.
  83875. */
  83876. readonly isSupported: boolean;
  83877. /**
  83878. * The aspect ratio of the output texture.
  83879. */
  83880. readonly aspectRatio: number;
  83881. /**
  83882. * Get a value indicating if the post-process is ready to be used
  83883. * @returns true if the post-process is ready (shader is compiled)
  83884. */
  83885. isReady(): boolean;
  83886. /**
  83887. * Binds all textures and uniforms to the shader, this will be run on every pass.
  83888. * @returns the effect corresponding to this post process. Null if not compiled or not ready.
  83889. */
  83890. apply(): Nullable<Effect>;
  83891. private _disposeTextures;
  83892. /**
  83893. * Disposes the post process.
  83894. * @param camera The camera to dispose the post process on.
  83895. */
  83896. dispose(camera?: Camera): void;
  83897. }
  83898. }
  83899. declare module BABYLON {
  83900. /** @hidden */
  83901. export var kernelBlurVaryingDeclaration: {
  83902. name: string;
  83903. shader: string;
  83904. };
  83905. }
  83906. declare module BABYLON {
  83907. /** @hidden */
  83908. export var kernelBlurFragment: {
  83909. name: string;
  83910. shader: string;
  83911. };
  83912. }
  83913. declare module BABYLON {
  83914. /** @hidden */
  83915. export var kernelBlurFragment2: {
  83916. name: string;
  83917. shader: string;
  83918. };
  83919. }
  83920. declare module BABYLON {
  83921. /** @hidden */
  83922. export var kernelBlurPixelShader: {
  83923. name: string;
  83924. shader: string;
  83925. };
  83926. }
  83927. declare module BABYLON {
  83928. /** @hidden */
  83929. export var kernelBlurVertex: {
  83930. name: string;
  83931. shader: string;
  83932. };
  83933. }
  83934. declare module BABYLON {
  83935. /** @hidden */
  83936. export var kernelBlurVertexShader: {
  83937. name: string;
  83938. shader: string;
  83939. };
  83940. }
  83941. declare module BABYLON {
  83942. /**
  83943. * The Blur Post Process which blurs an image based on a kernel and direction.
  83944. * Can be used twice in x and y directions to perform a guassian blur in two passes.
  83945. */
  83946. export class BlurPostProcess extends PostProcess {
  83947. /** The direction in which to blur the image. */
  83948. direction: Vector2;
  83949. private blockCompilation;
  83950. protected _kernel: number;
  83951. protected _idealKernel: number;
  83952. protected _packedFloat: boolean;
  83953. private _staticDefines;
  83954. /**
  83955. * Sets the length in pixels of the blur sample region
  83956. */
  83957. /**
  83958. * Gets the length in pixels of the blur sample region
  83959. */
  83960. kernel: number;
  83961. /**
  83962. * Sets wether or not the blur needs to unpack/repack floats
  83963. */
  83964. /**
  83965. * Gets wether or not the blur is unpacking/repacking floats
  83966. */
  83967. packedFloat: boolean;
  83968. /**
  83969. * Creates a new instance BlurPostProcess
  83970. * @param name The name of the effect.
  83971. * @param direction The direction in which to blur the image.
  83972. * @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.
  83973. * @param options The required width/height ratio to downsize to before computing the render pass. (Use 1.0 for full size)
  83974. * @param camera The camera to apply the render pass to.
  83975. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  83976. * @param engine The engine which the post process will be applied. (default: current engine)
  83977. * @param reusable If the post process can be reused on the same frame. (default: false)
  83978. * @param textureType Type of textures used when performing the post process. (default: 0)
  83979. * @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)
  83980. */
  83981. constructor(name: string,
  83982. /** The direction in which to blur the image. */
  83983. direction: Vector2, kernel: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, defines?: string, blockCompilation?: boolean);
  83984. /**
  83985. * Updates the effect with the current post process compile time values and recompiles the shader.
  83986. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  83987. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  83988. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  83989. * @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
  83990. * @param onCompiled Called when the shader has been compiled.
  83991. * @param onError Called if there is an error when compiling a shader.
  83992. */
  83993. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  83994. protected _updateParameters(onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  83995. /**
  83996. * Best kernels are odd numbers that when divided by 2, their integer part is even, so 5, 9 or 13.
  83997. * Other odd kernels optimize correctly but require proportionally more samples, even kernels are
  83998. * possible but will produce minor visual artifacts. Since each new kernel requires a new shader we
  83999. * want to minimize kernel changes, having gaps between physical kernels is helpful in that regard.
  84000. * The gaps between physical kernels are compensated for in the weighting of the samples
  84001. * @param idealKernel Ideal blur kernel.
  84002. * @return Nearest best kernel.
  84003. */
  84004. protected _nearestBestKernel(idealKernel: number): number;
  84005. /**
  84006. * Calculates the value of a Gaussian distribution with sigma 3 at a given point.
  84007. * @param x The point on the Gaussian distribution to sample.
  84008. * @return the value of the Gaussian function at x.
  84009. */
  84010. protected _gaussianWeight(x: number): number;
  84011. /**
  84012. * Generates a string that can be used as a floating point number in GLSL.
  84013. * @param x Value to print.
  84014. * @param decimalFigures Number of decimal places to print the number to (excluding trailing 0s).
  84015. * @return GLSL float string.
  84016. */
  84017. protected _glslFloat(x: number, decimalFigures?: number): string;
  84018. }
  84019. }
  84020. declare module BABYLON {
  84021. /**
  84022. * Mirror texture can be used to simulate the view from a mirror in a scene.
  84023. * It will dynamically be rendered every frame to adapt to the camera point of view.
  84024. * You can then easily use it as a reflectionTexture on a flat surface.
  84025. * In case the surface is not a plane, please consider relying on reflection probes.
  84026. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  84027. */
  84028. export class MirrorTexture extends RenderTargetTexture {
  84029. private scene;
  84030. /**
  84031. * Define the reflection plane we want to use. The mirrorPlane is usually set to the constructed reflector.
  84032. * 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.
  84033. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  84034. */
  84035. mirrorPlane: Plane;
  84036. /**
  84037. * Define the blur ratio used to blur the reflection if needed.
  84038. */
  84039. blurRatio: number;
  84040. /**
  84041. * Define the adaptive blur kernel used to blur the reflection if needed.
  84042. * This will autocompute the closest best match for the `blurKernel`
  84043. */
  84044. adaptiveBlurKernel: number;
  84045. /**
  84046. * Define the blur kernel used to blur the reflection if needed.
  84047. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  84048. */
  84049. blurKernel: number;
  84050. /**
  84051. * Define the blur kernel on the X Axis used to blur the reflection if needed.
  84052. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  84053. */
  84054. blurKernelX: number;
  84055. /**
  84056. * Define the blur kernel on the Y Axis used to blur the reflection if needed.
  84057. * Please consider using `adaptiveBlurKernel` as it could find the closest best value for you.
  84058. */
  84059. blurKernelY: number;
  84060. private _autoComputeBlurKernel;
  84061. protected _onRatioRescale(): void;
  84062. private _updateGammaSpace;
  84063. private _imageProcessingConfigChangeObserver;
  84064. private _transformMatrix;
  84065. private _mirrorMatrix;
  84066. private _savedViewMatrix;
  84067. private _blurX;
  84068. private _blurY;
  84069. private _adaptiveBlurKernel;
  84070. private _blurKernelX;
  84071. private _blurKernelY;
  84072. private _blurRatio;
  84073. /**
  84074. * Instantiates a Mirror Texture.
  84075. * Mirror texture can be used to simulate the view from a mirror in a scene.
  84076. * It will dynamically be rendered every frame to adapt to the camera point of view.
  84077. * You can then easily use it as a reflectionTexture on a flat surface.
  84078. * In case the surface is not a plane, please consider relying on reflection probes.
  84079. * @see https://doc.babylonjs.com/how_to/reflect#mirrors
  84080. * @param name
  84081. * @param size
  84082. * @param scene
  84083. * @param generateMipMaps
  84084. * @param type
  84085. * @param samplingMode
  84086. * @param generateDepthBuffer
  84087. */
  84088. constructor(name: string, size: number | {
  84089. width: number;
  84090. height: number;
  84091. } | {
  84092. ratio: number;
  84093. }, scene: Scene, generateMipMaps?: boolean, type?: number, samplingMode?: number, generateDepthBuffer?: boolean);
  84094. private _preparePostProcesses;
  84095. /**
  84096. * Clone the mirror texture.
  84097. * @returns the cloned texture
  84098. */
  84099. clone(): MirrorTexture;
  84100. /**
  84101. * Serialize the texture to a JSON representation you could use in Parse later on
  84102. * @returns the serialized JSON representation
  84103. */
  84104. serialize(): any;
  84105. /**
  84106. * Dispose the texture and release its associated resources.
  84107. */
  84108. dispose(): void;
  84109. }
  84110. }
  84111. declare module BABYLON {
  84112. /**
  84113. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  84114. * @see http://doc.babylonjs.com/babylon101/materials#texture
  84115. */
  84116. export class Texture extends BaseTexture {
  84117. /**
  84118. * Gets or sets a general boolean used to indicate that textures containing direct data (buffers) must be saved as part of the serialization process
  84119. */
  84120. static SerializeBuffers: boolean;
  84121. /** @hidden */
  84122. static _CubeTextureParser: (jsonTexture: any, scene: Scene, rootUrl: string) => CubeTexture;
  84123. /** @hidden */
  84124. static _CreateMirror: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => MirrorTexture;
  84125. /** @hidden */
  84126. static _CreateRenderTargetTexture: (name: string, renderTargetSize: number, scene: Scene, generateMipMaps: boolean) => RenderTargetTexture;
  84127. /** nearest is mag = nearest and min = nearest and mip = linear */
  84128. static readonly NEAREST_SAMPLINGMODE: number;
  84129. /** nearest is mag = nearest and min = nearest and mip = linear */
  84130. static readonly NEAREST_NEAREST_MIPLINEAR: number;
  84131. /** Bilinear is mag = linear and min = linear and mip = nearest */
  84132. static readonly BILINEAR_SAMPLINGMODE: number;
  84133. /** Bilinear is mag = linear and min = linear and mip = nearest */
  84134. static readonly LINEAR_LINEAR_MIPNEAREST: number;
  84135. /** Trilinear is mag = linear and min = linear and mip = linear */
  84136. static readonly TRILINEAR_SAMPLINGMODE: number;
  84137. /** Trilinear is mag = linear and min = linear and mip = linear */
  84138. static readonly LINEAR_LINEAR_MIPLINEAR: number;
  84139. /** mag = nearest and min = nearest and mip = nearest */
  84140. static readonly NEAREST_NEAREST_MIPNEAREST: number;
  84141. /** mag = nearest and min = linear and mip = nearest */
  84142. static readonly NEAREST_LINEAR_MIPNEAREST: number;
  84143. /** mag = nearest and min = linear and mip = linear */
  84144. static readonly NEAREST_LINEAR_MIPLINEAR: number;
  84145. /** mag = nearest and min = linear and mip = none */
  84146. static readonly NEAREST_LINEAR: number;
  84147. /** mag = nearest and min = nearest and mip = none */
  84148. static readonly NEAREST_NEAREST: number;
  84149. /** mag = linear and min = nearest and mip = nearest */
  84150. static readonly LINEAR_NEAREST_MIPNEAREST: number;
  84151. /** mag = linear and min = nearest and mip = linear */
  84152. static readonly LINEAR_NEAREST_MIPLINEAR: number;
  84153. /** mag = linear and min = linear and mip = none */
  84154. static readonly LINEAR_LINEAR: number;
  84155. /** mag = linear and min = nearest and mip = none */
  84156. static readonly LINEAR_NEAREST: number;
  84157. /** Explicit coordinates mode */
  84158. static readonly EXPLICIT_MODE: number;
  84159. /** Spherical coordinates mode */
  84160. static readonly SPHERICAL_MODE: number;
  84161. /** Planar coordinates mode */
  84162. static readonly PLANAR_MODE: number;
  84163. /** Cubic coordinates mode */
  84164. static readonly CUBIC_MODE: number;
  84165. /** Projection coordinates mode */
  84166. static readonly PROJECTION_MODE: number;
  84167. /** Inverse Cubic coordinates mode */
  84168. static readonly SKYBOX_MODE: number;
  84169. /** Inverse Cubic coordinates mode */
  84170. static readonly INVCUBIC_MODE: number;
  84171. /** Equirectangular coordinates mode */
  84172. static readonly EQUIRECTANGULAR_MODE: number;
  84173. /** Equirectangular Fixed coordinates mode */
  84174. static readonly FIXED_EQUIRECTANGULAR_MODE: number;
  84175. /** Equirectangular Fixed Mirrored coordinates mode */
  84176. static readonly FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  84177. /** Texture is not repeating outside of 0..1 UVs */
  84178. static readonly CLAMP_ADDRESSMODE: number;
  84179. /** Texture is repeating outside of 0..1 UVs */
  84180. static readonly WRAP_ADDRESSMODE: number;
  84181. /** Texture is repeating and mirrored */
  84182. static readonly MIRROR_ADDRESSMODE: number;
  84183. /**
  84184. * 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
  84185. */
  84186. static UseSerializedUrlIfAny: boolean;
  84187. /**
  84188. * Define the url of the texture.
  84189. */
  84190. url: Nullable<string>;
  84191. /**
  84192. * Define an offset on the texture to offset the u coordinates of the UVs
  84193. * @see http://doc.babylonjs.com/how_to/more_materials#offsetting
  84194. */
  84195. uOffset: number;
  84196. /**
  84197. * Define an offset on the texture to offset the v coordinates of the UVs
  84198. * @see http://doc.babylonjs.com/how_to/more_materials#offsetting
  84199. */
  84200. vOffset: number;
  84201. /**
  84202. * Define an offset on the texture to scale the u coordinates of the UVs
  84203. * @see http://doc.babylonjs.com/how_to/more_materials#tiling
  84204. */
  84205. uScale: number;
  84206. /**
  84207. * Define an offset on the texture to scale the v coordinates of the UVs
  84208. * @see http://doc.babylonjs.com/how_to/more_materials#tiling
  84209. */
  84210. vScale: number;
  84211. /**
  84212. * Define an offset on the texture to rotate around the u coordinates of the UVs
  84213. * @see http://doc.babylonjs.com/how_to/more_materials
  84214. */
  84215. uAng: number;
  84216. /**
  84217. * Define an offset on the texture to rotate around the v coordinates of the UVs
  84218. * @see http://doc.babylonjs.com/how_to/more_materials
  84219. */
  84220. vAng: number;
  84221. /**
  84222. * Define an offset on the texture to rotate around the w coordinates of the UVs (in case of 3d texture)
  84223. * @see http://doc.babylonjs.com/how_to/more_materials
  84224. */
  84225. wAng: number;
  84226. /**
  84227. * Defines the center of rotation (U)
  84228. */
  84229. uRotationCenter: number;
  84230. /**
  84231. * Defines the center of rotation (V)
  84232. */
  84233. vRotationCenter: number;
  84234. /**
  84235. * Defines the center of rotation (W)
  84236. */
  84237. wRotationCenter: number;
  84238. /**
  84239. * Are mip maps generated for this texture or not.
  84240. */
  84241. readonly noMipmap: boolean;
  84242. /**
  84243. * List of inspectable custom properties (used by the Inspector)
  84244. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  84245. */
  84246. inspectableCustomProperties: Nullable<IInspectable[]>;
  84247. private _noMipmap;
  84248. /** @hidden */
  84249. _invertY: boolean;
  84250. private _rowGenerationMatrix;
  84251. private _cachedTextureMatrix;
  84252. private _projectionModeMatrix;
  84253. private _t0;
  84254. private _t1;
  84255. private _t2;
  84256. private _cachedUOffset;
  84257. private _cachedVOffset;
  84258. private _cachedUScale;
  84259. private _cachedVScale;
  84260. private _cachedUAng;
  84261. private _cachedVAng;
  84262. private _cachedWAng;
  84263. private _cachedProjectionMatrixId;
  84264. private _cachedCoordinatesMode;
  84265. /** @hidden */
  84266. protected _initialSamplingMode: number;
  84267. /** @hidden */
  84268. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  84269. private _deleteBuffer;
  84270. protected _format: Nullable<number>;
  84271. private _delayedOnLoad;
  84272. private _delayedOnError;
  84273. private _mimeType?;
  84274. /**
  84275. * Observable triggered once the texture has been loaded.
  84276. */
  84277. onLoadObservable: Observable<Texture>;
  84278. protected _isBlocking: boolean;
  84279. /**
  84280. * Is the texture preventing material to render while loading.
  84281. * If false, a default texture will be used instead of the loading one during the preparation step.
  84282. */
  84283. isBlocking: boolean;
  84284. /**
  84285. * Get the current sampling mode associated with the texture.
  84286. */
  84287. readonly samplingMode: number;
  84288. /**
  84289. * Gets a boolean indicating if the texture needs to be inverted on the y axis during loading
  84290. */
  84291. readonly invertY: boolean;
  84292. /**
  84293. * Instantiates a new texture.
  84294. * This represents a texture in babylon. It can be easily loaded from a network, base64 or html input.
  84295. * @see http://doc.babylonjs.com/babylon101/materials#texture
  84296. * @param url defines the url of the picture to load as a texture
  84297. * @param scene defines the scene or engine the texture will belong to
  84298. * @param noMipmap defines if the texture will require mip maps or not
  84299. * @param invertY defines if the texture needs to be inverted on the y axis during loading
  84300. * @param samplingMode defines the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  84301. * @param onLoad defines a callback triggered when the texture has been loaded
  84302. * @param onError defines a callback triggered when an error occurred during the loading session
  84303. * @param buffer defines the buffer to load the texture from in case the texture is loaded from a buffer representation
  84304. * @param deleteBuffer defines if the buffer we are loading the texture from should be deleted after load
  84305. * @param format defines the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  84306. * @param mimeType defines an optional mime type information
  84307. */
  84308. 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);
  84309. /**
  84310. * Update the url (and optional buffer) of this texture if url was null during construction.
  84311. * @param url the url of the texture
  84312. * @param buffer the buffer of the texture (defaults to null)
  84313. * @param onLoad callback called when the texture is loaded (defaults to null)
  84314. */
  84315. updateURL(url: string, buffer?: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob>, onLoad?: () => void): void;
  84316. /**
  84317. * Finish the loading sequence of a texture flagged as delayed load.
  84318. * @hidden
  84319. */
  84320. delayLoad(): void;
  84321. private _prepareRowForTextureGeneration;
  84322. /**
  84323. * Get the current texture matrix which includes the requested offsetting, tiling and rotation components.
  84324. * @returns the transform matrix of the texture.
  84325. */
  84326. getTextureMatrix(): Matrix;
  84327. /**
  84328. * Get the current matrix used to apply reflection. This is useful to rotate an environment texture for instance.
  84329. * @returns The reflection texture transform
  84330. */
  84331. getReflectionTextureMatrix(): Matrix;
  84332. /**
  84333. * Clones the texture.
  84334. * @returns the cloned texture
  84335. */
  84336. clone(): Texture;
  84337. /**
  84338. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  84339. * @returns The JSON representation of the texture
  84340. */
  84341. serialize(): any;
  84342. /**
  84343. * Get the current class name of the texture useful for serialization or dynamic coding.
  84344. * @returns "Texture"
  84345. */
  84346. getClassName(): string;
  84347. /**
  84348. * Dispose the texture and release its associated resources.
  84349. */
  84350. dispose(): void;
  84351. /**
  84352. * Parse the JSON representation of a texture in order to recreate the texture in the given scene.
  84353. * @param parsedTexture Define the JSON representation of the texture
  84354. * @param scene Define the scene the parsed texture should be instantiated in
  84355. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  84356. * @returns The parsed texture if successful
  84357. */
  84358. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<BaseTexture>;
  84359. /**
  84360. * Creates a texture from its base 64 representation.
  84361. * @param data Define the base64 payload without the data: prefix
  84362. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  84363. * @param scene Define the scene the texture should belong to
  84364. * @param noMipmap Forces the texture to not create mip map information if true
  84365. * @param invertY define if the texture needs to be inverted on the y axis during loading
  84366. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  84367. * @param onLoad define a callback triggered when the texture has been loaded
  84368. * @param onError define a callback triggered when an error occurred during the loading session
  84369. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  84370. * @returns the created texture
  84371. */
  84372. static CreateFromBase64String(data: string, name: string, scene: Scene, noMipmap?: boolean, invertY?: boolean, samplingMode?: number, onLoad?: Nullable<() => void>, onError?: Nullable<() => void>, format?: number): Texture;
  84373. /**
  84374. * Creates a texture from its data: representation. (data: will be added in case only the payload has been passed in)
  84375. * @param data Define the base64 payload without the data: prefix
  84376. * @param name Define the name of the texture in the scene useful fo caching purpose for instance
  84377. * @param buffer define the buffer to load the texture from in case the texture is loaded from a buffer representation
  84378. * @param scene Define the scene the texture should belong to
  84379. * @param deleteBuffer define if the buffer we are loading the texture from should be deleted after load
  84380. * @param noMipmap Forces the texture to not create mip map information if true
  84381. * @param invertY define if the texture needs to be inverted on the y axis during loading
  84382. * @param samplingMode define the sampling mode we want for the texture while fectching from it (Texture.NEAREST_SAMPLINGMODE...)
  84383. * @param onLoad define a callback triggered when the texture has been loaded
  84384. * @param onError define a callback triggered when an error occurred during the loading session
  84385. * @param format define the format of the texture we are trying to load (Engine.TEXTUREFORMAT_RGBA...)
  84386. * @returns the created texture
  84387. */
  84388. 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;
  84389. }
  84390. }
  84391. declare module BABYLON {
  84392. /**
  84393. * PostProcessManager is used to manage one or more post processes or post process pipelines
  84394. * See https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  84395. */
  84396. export class PostProcessManager {
  84397. private _scene;
  84398. private _indexBuffer;
  84399. private _vertexBuffers;
  84400. /**
  84401. * Creates a new instance PostProcess
  84402. * @param scene The scene that the post process is associated with.
  84403. */
  84404. constructor(scene: Scene);
  84405. private _prepareBuffers;
  84406. private _buildIndexBuffer;
  84407. /**
  84408. * Rebuilds the vertex buffers of the manager.
  84409. * @hidden
  84410. */
  84411. _rebuild(): void;
  84412. /**
  84413. * Prepares a frame to be run through a post process.
  84414. * @param sourceTexture The input texture to the post procesess. (default: null)
  84415. * @param postProcesses An array of post processes to be run. (default: null)
  84416. * @returns True if the post processes were able to be run.
  84417. * @hidden
  84418. */
  84419. _prepareFrame(sourceTexture?: Nullable<InternalTexture>, postProcesses?: Nullable<PostProcess[]>): boolean;
  84420. /**
  84421. * Manually render a set of post processes to a texture.
  84422. * @param postProcesses An array of post processes to be run.
  84423. * @param targetTexture The target texture to render to.
  84424. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight
  84425. * @param faceIndex defines the face to render to if a cubemap is defined as the target
  84426. * @param lodLevel defines which lod of the texture to render to
  84427. */
  84428. directRender(postProcesses: PostProcess[], targetTexture?: Nullable<InternalTexture>, forceFullscreenViewport?: boolean, faceIndex?: number, lodLevel?: number): void;
  84429. /**
  84430. * Finalize the result of the output of the postprocesses.
  84431. * @param doNotPresent If true the result will not be displayed to the screen.
  84432. * @param targetTexture The target texture to render to.
  84433. * @param faceIndex The index of the face to bind the target texture to.
  84434. * @param postProcesses The array of post processes to render.
  84435. * @param forceFullscreenViewport force gl.viewport to be full screen eg. 0,0,textureWidth,textureHeight (default: false)
  84436. * @hidden
  84437. */
  84438. _finalizeFrame(doNotPresent?: boolean, targetTexture?: InternalTexture, faceIndex?: number, postProcesses?: Array<PostProcess>, forceFullscreenViewport?: boolean): void;
  84439. /**
  84440. * Disposes of the post process manager.
  84441. */
  84442. dispose(): void;
  84443. }
  84444. }
  84445. declare module BABYLON {
  84446. /** Interface used by value gradients (color, factor, ...) */
  84447. export interface IValueGradient {
  84448. /**
  84449. * Gets or sets the gradient value (between 0 and 1)
  84450. */
  84451. gradient: number;
  84452. }
  84453. /** Class used to store color4 gradient */
  84454. export class ColorGradient implements IValueGradient {
  84455. /**
  84456. * Gets or sets the gradient value (between 0 and 1)
  84457. */
  84458. gradient: number;
  84459. /**
  84460. * Gets or sets first associated color
  84461. */
  84462. color1: Color4;
  84463. /**
  84464. * Gets or sets second associated color
  84465. */
  84466. color2?: Color4;
  84467. /**
  84468. * Will get a color picked randomly between color1 and color2.
  84469. * If color2 is undefined then color1 will be used
  84470. * @param result defines the target Color4 to store the result in
  84471. */
  84472. getColorToRef(result: Color4): void;
  84473. }
  84474. /** Class used to store color 3 gradient */
  84475. export class Color3Gradient implements IValueGradient {
  84476. /**
  84477. * Gets or sets the gradient value (between 0 and 1)
  84478. */
  84479. gradient: number;
  84480. /**
  84481. * Gets or sets the associated color
  84482. */
  84483. color: Color3;
  84484. }
  84485. /** Class used to store factor gradient */
  84486. export class FactorGradient implements IValueGradient {
  84487. /**
  84488. * Gets or sets the gradient value (between 0 and 1)
  84489. */
  84490. gradient: number;
  84491. /**
  84492. * Gets or sets first associated factor
  84493. */
  84494. factor1: number;
  84495. /**
  84496. * Gets or sets second associated factor
  84497. */
  84498. factor2?: number;
  84499. /**
  84500. * Will get a number picked randomly between factor1 and factor2.
  84501. * If factor2 is undefined then factor1 will be used
  84502. * @returns the picked number
  84503. */
  84504. getFactor(): number;
  84505. }
  84506. /**
  84507. * Helper used to simplify some generic gradient tasks
  84508. */
  84509. export class GradientHelper {
  84510. /**
  84511. * Gets the current gradient from an array of IValueGradient
  84512. * @param ratio defines the current ratio to get
  84513. * @param gradients defines the array of IValueGradient
  84514. * @param updateFunc defines the callback function used to get the final value from the selected gradients
  84515. */
  84516. static GetCurrentGradient(ratio: number, gradients: IValueGradient[], updateFunc: (current: IValueGradient, next: IValueGradient, scale: number) => void): void;
  84517. }
  84518. }
  84519. declare module BABYLON {
  84520. interface ThinEngine {
  84521. /**
  84522. * Creates a dynamic texture
  84523. * @param width defines the width of the texture
  84524. * @param height defines the height of the texture
  84525. * @param generateMipMaps defines if the engine should generate the mip levels
  84526. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  84527. * @returns the dynamic texture inside an InternalTexture
  84528. */
  84529. createDynamicTexture(width: number, height: number, generateMipMaps: boolean, samplingMode: number): InternalTexture;
  84530. /**
  84531. * Update the content of a dynamic texture
  84532. * @param texture defines the texture to update
  84533. * @param canvas defines the canvas containing the source
  84534. * @param invertY defines if data must be stored with Y axis inverted
  84535. * @param premulAlpha defines if alpha is stored as premultiplied
  84536. * @param format defines the format of the data
  84537. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  84538. */
  84539. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement | OffscreenCanvas, invertY: boolean, premulAlpha?: boolean, format?: number, forceBindTexture?: boolean): void;
  84540. }
  84541. }
  84542. declare module BABYLON {
  84543. /**
  84544. * Helper class used to generate a canvas to manipulate images
  84545. */
  84546. export class CanvasGenerator {
  84547. /**
  84548. * Create a new canvas (or offscreen canvas depending on the context)
  84549. * @param width defines the expected width
  84550. * @param height defines the expected height
  84551. * @return a new canvas or offscreen canvas
  84552. */
  84553. static CreateCanvas(width: number, height: number): HTMLCanvasElement | OffscreenCanvas;
  84554. }
  84555. }
  84556. declare module BABYLON {
  84557. /**
  84558. * A class extending Texture allowing drawing on a texture
  84559. * @see http://doc.babylonjs.com/how_to/dynamictexture
  84560. */
  84561. export class DynamicTexture extends Texture {
  84562. private _generateMipMaps;
  84563. private _canvas;
  84564. private _context;
  84565. private _engine;
  84566. /**
  84567. * Creates a DynamicTexture
  84568. * @param name defines the name of the texture
  84569. * @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
  84570. * @param scene defines the scene where you want the texture
  84571. * @param generateMipMaps defines the use of MinMaps or not (default is false)
  84572. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  84573. * @param format defines the texture format to use (default is Engine.TEXTUREFORMAT_RGBA)
  84574. */
  84575. constructor(name: string, options: any, scene: Scene | null | undefined, generateMipMaps: boolean, samplingMode?: number, format?: number);
  84576. /**
  84577. * Get the current class name of the texture useful for serialization or dynamic coding.
  84578. * @returns "DynamicTexture"
  84579. */
  84580. getClassName(): string;
  84581. /**
  84582. * Gets the current state of canRescale
  84583. */
  84584. readonly canRescale: boolean;
  84585. private _recreate;
  84586. /**
  84587. * Scales the texture
  84588. * @param ratio the scale factor to apply to both width and height
  84589. */
  84590. scale(ratio: number): void;
  84591. /**
  84592. * Resizes the texture
  84593. * @param width the new width
  84594. * @param height the new height
  84595. */
  84596. scaleTo(width: number, height: number): void;
  84597. /**
  84598. * Gets the context of the canvas used by the texture
  84599. * @returns the canvas context of the dynamic texture
  84600. */
  84601. getContext(): CanvasRenderingContext2D;
  84602. /**
  84603. * Clears the texture
  84604. */
  84605. clear(): void;
  84606. /**
  84607. * Updates the texture
  84608. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  84609. * @param premulAlpha defines if alpha is stored as premultiplied (default is false)
  84610. */
  84611. update(invertY?: boolean, premulAlpha?: boolean): void;
  84612. /**
  84613. * Draws text onto the texture
  84614. * @param text defines the text to be drawn
  84615. * @param x defines the placement of the text from the left
  84616. * @param y defines the placement of the text from the top when invertY is true and from the bottom when false
  84617. * @param font defines the font to be used with font-style, font-size, font-name
  84618. * @param color defines the color used for the text
  84619. * @param clearColor defines the color for the canvas, use null to not overwrite canvas
  84620. * @param invertY defines the direction for the Y axis (default is true - y increases downwards)
  84621. * @param update defines whether texture is immediately update (default is true)
  84622. */
  84623. drawText(text: string, x: number, y: number, font: string, color: string, clearColor: string, invertY?: boolean, update?: boolean): void;
  84624. /**
  84625. * Clones the texture
  84626. * @returns the clone of the texture.
  84627. */
  84628. clone(): DynamicTexture;
  84629. /**
  84630. * Serializes the dynamic texture. The scene should be ready before the dynamic texture is serialized
  84631. * @returns a serialized dynamic texture object
  84632. */
  84633. serialize(): any;
  84634. /** @hidden */
  84635. _rebuild(): void;
  84636. }
  84637. }
  84638. declare module BABYLON {
  84639. interface AbstractScene {
  84640. /**
  84641. * The list of procedural textures added to the scene
  84642. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  84643. */
  84644. proceduralTextures: Array<ProceduralTexture>;
  84645. }
  84646. /**
  84647. * Defines the Procedural Texture scene component responsible to manage any Procedural Texture
  84648. * in a given scene.
  84649. */
  84650. export class ProceduralTextureSceneComponent implements ISceneComponent {
  84651. /**
  84652. * The component name helpfull to identify the component in the list of scene components.
  84653. */
  84654. readonly name: string;
  84655. /**
  84656. * The scene the component belongs to.
  84657. */
  84658. scene: Scene;
  84659. /**
  84660. * Creates a new instance of the component for the given scene
  84661. * @param scene Defines the scene to register the component in
  84662. */
  84663. constructor(scene: Scene);
  84664. /**
  84665. * Registers the component in a given scene
  84666. */
  84667. register(): void;
  84668. /**
  84669. * Rebuilds the elements related to this component in case of
  84670. * context lost for instance.
  84671. */
  84672. rebuild(): void;
  84673. /**
  84674. * Disposes the component and the associated ressources.
  84675. */
  84676. dispose(): void;
  84677. private _beforeClear;
  84678. }
  84679. }
  84680. declare module BABYLON {
  84681. interface ThinEngine {
  84682. /**
  84683. * Creates a new render target cube texture
  84684. * @param size defines the size of the texture
  84685. * @param options defines the options used to create the texture
  84686. * @returns a new render target cube texture stored in an InternalTexture
  84687. */
  84688. createRenderTargetCubeTexture(size: number, options?: Partial<RenderTargetCreationOptions>): InternalTexture;
  84689. }
  84690. }
  84691. declare module BABYLON {
  84692. /** @hidden */
  84693. export var proceduralVertexShader: {
  84694. name: string;
  84695. shader: string;
  84696. };
  84697. }
  84698. declare module BABYLON {
  84699. /**
  84700. * 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.
  84701. * This is the base class of any Procedural texture and contains most of the shareable code.
  84702. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  84703. */
  84704. export class ProceduralTexture extends Texture {
  84705. isCube: boolean;
  84706. /**
  84707. * Define if the texture is enabled or not (disabled texture will not render)
  84708. */
  84709. isEnabled: boolean;
  84710. /**
  84711. * Define if the texture must be cleared before rendering (default is true)
  84712. */
  84713. autoClear: boolean;
  84714. /**
  84715. * Callback called when the texture is generated
  84716. */
  84717. onGenerated: () => void;
  84718. /**
  84719. * Event raised when the texture is generated
  84720. */
  84721. onGeneratedObservable: Observable<ProceduralTexture>;
  84722. /** @hidden */
  84723. _generateMipMaps: boolean;
  84724. /** @hidden **/
  84725. _effect: Effect;
  84726. /** @hidden */
  84727. _textures: {
  84728. [key: string]: Texture;
  84729. };
  84730. private _size;
  84731. private _currentRefreshId;
  84732. private _refreshRate;
  84733. private _vertexBuffers;
  84734. private _indexBuffer;
  84735. private _uniforms;
  84736. private _samplers;
  84737. private _fragment;
  84738. private _floats;
  84739. private _ints;
  84740. private _floatsArrays;
  84741. private _colors3;
  84742. private _colors4;
  84743. private _vectors2;
  84744. private _vectors3;
  84745. private _matrices;
  84746. private _fallbackTexture;
  84747. private _fallbackTextureUsed;
  84748. private _engine;
  84749. private _cachedDefines;
  84750. private _contentUpdateId;
  84751. private _contentData;
  84752. /**
  84753. * Instantiates a new procedural texture.
  84754. * 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.
  84755. * This is the base class of any Procedural texture and contains most of the shareable code.
  84756. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures
  84757. * @param name Define the name of the texture
  84758. * @param size Define the size of the texture to create
  84759. * @param fragment Define the fragment shader to use to generate the texture or null if it is defined later
  84760. * @param scene Define the scene the texture belongs to
  84761. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  84762. * @param generateMipMaps Define if the texture should creates mip maps or not
  84763. * @param isCube Define if the texture is a cube texture or not (this will render each faces of the cube)
  84764. */
  84765. constructor(name: string, size: any, fragment: any, scene: Nullable<Scene>, fallbackTexture?: Nullable<Texture>, generateMipMaps?: boolean, isCube?: boolean);
  84766. /**
  84767. * The effect that is created when initializing the post process.
  84768. * @returns The created effect corresponding the the postprocess.
  84769. */
  84770. getEffect(): Effect;
  84771. /**
  84772. * Gets texture content (Use this function wisely as reading from a texture can be slow)
  84773. * @returns an ArrayBufferView (Uint8Array or Float32Array)
  84774. */
  84775. getContent(): Nullable<ArrayBufferView>;
  84776. private _createIndexBuffer;
  84777. /** @hidden */
  84778. _rebuild(): void;
  84779. /**
  84780. * Resets the texture in order to recreate its associated resources.
  84781. * This can be called in case of context loss
  84782. */
  84783. reset(): void;
  84784. protected _getDefines(): string;
  84785. /**
  84786. * Is the texture ready to be used ? (rendered at least once)
  84787. * @returns true if ready, otherwise, false.
  84788. */
  84789. isReady(): boolean;
  84790. /**
  84791. * Resets the refresh counter of the texture and start bak from scratch.
  84792. * Could be useful to regenerate the texture if it is setup to render only once.
  84793. */
  84794. resetRefreshCounter(): void;
  84795. /**
  84796. * Set the fragment shader to use in order to render the texture.
  84797. * @param fragment This can be set to a path (into the shader store) or to a json object containing a fragmentElement property.
  84798. */
  84799. setFragment(fragment: any): void;
  84800. /**
  84801. * Define the refresh rate of the texture or the rendering frequency.
  84802. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  84803. */
  84804. refreshRate: number;
  84805. /** @hidden */
  84806. _shouldRender(): boolean;
  84807. /**
  84808. * Get the size the texture is rendering at.
  84809. * @returns the size (texture is always squared)
  84810. */
  84811. getRenderSize(): number;
  84812. /**
  84813. * Resize the texture to new value.
  84814. * @param size Define the new size the texture should have
  84815. * @param generateMipMaps Define whether the new texture should create mip maps
  84816. */
  84817. resize(size: number, generateMipMaps: boolean): void;
  84818. private _checkUniform;
  84819. /**
  84820. * Set a texture in the shader program used to render.
  84821. * @param name Define the name of the uniform samplers as defined in the shader
  84822. * @param texture Define the texture to bind to this sampler
  84823. * @return the texture itself allowing "fluent" like uniform updates
  84824. */
  84825. setTexture(name: string, texture: Texture): ProceduralTexture;
  84826. /**
  84827. * Set a float in the shader.
  84828. * @param name Define the name of the uniform as defined in the shader
  84829. * @param value Define the value to give to the uniform
  84830. * @return the texture itself allowing "fluent" like uniform updates
  84831. */
  84832. setFloat(name: string, value: number): ProceduralTexture;
  84833. /**
  84834. * Set a int in the shader.
  84835. * @param name Define the name of the uniform as defined in the shader
  84836. * @param value Define the value to give to the uniform
  84837. * @return the texture itself allowing "fluent" like uniform updates
  84838. */
  84839. setInt(name: string, value: number): ProceduralTexture;
  84840. /**
  84841. * Set an array of floats in the shader.
  84842. * @param name Define the name of the uniform as defined in the shader
  84843. * @param value Define the value to give to the uniform
  84844. * @return the texture itself allowing "fluent" like uniform updates
  84845. */
  84846. setFloats(name: string, value: number[]): ProceduralTexture;
  84847. /**
  84848. * Set a vec3 in the shader from a Color3.
  84849. * @param name Define the name of the uniform as defined in the shader
  84850. * @param value Define the value to give to the uniform
  84851. * @return the texture itself allowing "fluent" like uniform updates
  84852. */
  84853. setColor3(name: string, value: Color3): ProceduralTexture;
  84854. /**
  84855. * Set a vec4 in the shader from a Color4.
  84856. * @param name Define the name of the uniform as defined in the shader
  84857. * @param value Define the value to give to the uniform
  84858. * @return the texture itself allowing "fluent" like uniform updates
  84859. */
  84860. setColor4(name: string, value: Color4): ProceduralTexture;
  84861. /**
  84862. * Set a vec2 in the shader from a Vector2.
  84863. * @param name Define the name of the uniform as defined in the shader
  84864. * @param value Define the value to give to the uniform
  84865. * @return the texture itself allowing "fluent" like uniform updates
  84866. */
  84867. setVector2(name: string, value: Vector2): ProceduralTexture;
  84868. /**
  84869. * Set a vec3 in the shader from a Vector3.
  84870. * @param name Define the name of the uniform as defined in the shader
  84871. * @param value Define the value to give to the uniform
  84872. * @return the texture itself allowing "fluent" like uniform updates
  84873. */
  84874. setVector3(name: string, value: Vector3): ProceduralTexture;
  84875. /**
  84876. * Set a mat4 in the shader from a MAtrix.
  84877. * @param name Define the name of the uniform as defined in the shader
  84878. * @param value Define the value to give to the uniform
  84879. * @return the texture itself allowing "fluent" like uniform updates
  84880. */
  84881. setMatrix(name: string, value: Matrix): ProceduralTexture;
  84882. /**
  84883. * Render the texture to its associated render target.
  84884. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  84885. */
  84886. render(useCameraPostProcess?: boolean): void;
  84887. /**
  84888. * Clone the texture.
  84889. * @returns the cloned texture
  84890. */
  84891. clone(): ProceduralTexture;
  84892. /**
  84893. * Dispose the texture and release its asoociated resources.
  84894. */
  84895. dispose(): void;
  84896. }
  84897. }
  84898. declare module BABYLON {
  84899. /**
  84900. * This represents the base class for particle system in Babylon.
  84901. * 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.
  84902. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  84903. * @example https://doc.babylonjs.com/babylon101/particles
  84904. */
  84905. export class BaseParticleSystem {
  84906. /**
  84907. * Source color is added to the destination color without alpha affecting the result
  84908. */
  84909. static BLENDMODE_ONEONE: number;
  84910. /**
  84911. * Blend current color and particle color using particle’s alpha
  84912. */
  84913. static BLENDMODE_STANDARD: number;
  84914. /**
  84915. * Add current color and particle color multiplied by particle’s alpha
  84916. */
  84917. static BLENDMODE_ADD: number;
  84918. /**
  84919. * Multiply current color with particle color
  84920. */
  84921. static BLENDMODE_MULTIPLY: number;
  84922. /**
  84923. * Multiply current color with particle color then add current color and particle color multiplied by particle’s alpha
  84924. */
  84925. static BLENDMODE_MULTIPLYADD: number;
  84926. /**
  84927. * List of animations used by the particle system.
  84928. */
  84929. animations: Animation[];
  84930. /**
  84931. * The id of the Particle system.
  84932. */
  84933. id: string;
  84934. /**
  84935. * The friendly name of the Particle system.
  84936. */
  84937. name: string;
  84938. /**
  84939. * The rendering group used by the Particle system to chose when to render.
  84940. */
  84941. renderingGroupId: number;
  84942. /**
  84943. * The emitter represents the Mesh or position we are attaching the particle system to.
  84944. */
  84945. emitter: Nullable<AbstractMesh | Vector3>;
  84946. /**
  84947. * The maximum number of particles to emit per frame
  84948. */
  84949. emitRate: number;
  84950. /**
  84951. * If you want to launch only a few particles at once, that can be done, as well.
  84952. */
  84953. manualEmitCount: number;
  84954. /**
  84955. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  84956. */
  84957. updateSpeed: number;
  84958. /**
  84959. * The amount of time the particle system is running (depends of the overall update speed).
  84960. */
  84961. targetStopDuration: number;
  84962. /**
  84963. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  84964. */
  84965. disposeOnStop: boolean;
  84966. /**
  84967. * Minimum power of emitting particles.
  84968. */
  84969. minEmitPower: number;
  84970. /**
  84971. * Maximum power of emitting particles.
  84972. */
  84973. maxEmitPower: number;
  84974. /**
  84975. * Minimum life time of emitting particles.
  84976. */
  84977. minLifeTime: number;
  84978. /**
  84979. * Maximum life time of emitting particles.
  84980. */
  84981. maxLifeTime: number;
  84982. /**
  84983. * Minimum Size of emitting particles.
  84984. */
  84985. minSize: number;
  84986. /**
  84987. * Maximum Size of emitting particles.
  84988. */
  84989. maxSize: number;
  84990. /**
  84991. * Minimum scale of emitting particles on X axis.
  84992. */
  84993. minScaleX: number;
  84994. /**
  84995. * Maximum scale of emitting particles on X axis.
  84996. */
  84997. maxScaleX: number;
  84998. /**
  84999. * Minimum scale of emitting particles on Y axis.
  85000. */
  85001. minScaleY: number;
  85002. /**
  85003. * Maximum scale of emitting particles on Y axis.
  85004. */
  85005. maxScaleY: number;
  85006. /**
  85007. * Gets or sets the minimal initial rotation in radians.
  85008. */
  85009. minInitialRotation: number;
  85010. /**
  85011. * Gets or sets the maximal initial rotation in radians.
  85012. */
  85013. maxInitialRotation: number;
  85014. /**
  85015. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  85016. */
  85017. minAngularSpeed: number;
  85018. /**
  85019. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  85020. */
  85021. maxAngularSpeed: number;
  85022. /**
  85023. * The texture used to render each particle. (this can be a spritesheet)
  85024. */
  85025. particleTexture: Nullable<Texture>;
  85026. /**
  85027. * The layer mask we are rendering the particles through.
  85028. */
  85029. layerMask: number;
  85030. /**
  85031. * This can help using your own shader to render the particle system.
  85032. * The according effect will be created
  85033. */
  85034. customShader: any;
  85035. /**
  85036. * By default particle system starts as soon as they are created. This prevents the
  85037. * automatic start to happen and let you decide when to start emitting particles.
  85038. */
  85039. preventAutoStart: boolean;
  85040. private _noiseTexture;
  85041. /**
  85042. * Gets or sets a texture used to add random noise to particle positions
  85043. */
  85044. noiseTexture: Nullable<ProceduralTexture>;
  85045. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  85046. noiseStrength: Vector3;
  85047. /**
  85048. * Callback triggered when the particle animation is ending.
  85049. */
  85050. onAnimationEnd: Nullable<() => void>;
  85051. /**
  85052. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE or ParticleSystem.BLENDMODE_STANDARD.
  85053. */
  85054. blendMode: number;
  85055. /**
  85056. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  85057. * to override the particles.
  85058. */
  85059. forceDepthWrite: boolean;
  85060. /** 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 */
  85061. preWarmCycles: number;
  85062. /** Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1) */
  85063. preWarmStepOffset: number;
  85064. /**
  85065. * 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)
  85066. */
  85067. spriteCellChangeSpeed: number;
  85068. /**
  85069. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  85070. */
  85071. startSpriteCellID: number;
  85072. /**
  85073. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  85074. */
  85075. endSpriteCellID: number;
  85076. /**
  85077. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  85078. */
  85079. spriteCellWidth: number;
  85080. /**
  85081. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  85082. */
  85083. spriteCellHeight: number;
  85084. /**
  85085. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  85086. */
  85087. spriteRandomStartCell: boolean;
  85088. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  85089. translationPivot: Vector2;
  85090. /** @hidden */
  85091. protected _isAnimationSheetEnabled: boolean;
  85092. /**
  85093. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  85094. */
  85095. beginAnimationOnStart: boolean;
  85096. /**
  85097. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  85098. */
  85099. beginAnimationFrom: number;
  85100. /**
  85101. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  85102. */
  85103. beginAnimationTo: number;
  85104. /**
  85105. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  85106. */
  85107. beginAnimationLoop: boolean;
  85108. /**
  85109. * Gets or sets a world offset applied to all particles
  85110. */
  85111. worldOffset: Vector3;
  85112. /**
  85113. * Gets or sets whether an animation sprite sheet is enabled or not on the particle system
  85114. */
  85115. isAnimationSheetEnabled: boolean;
  85116. /**
  85117. * Get hosting scene
  85118. * @returns the scene
  85119. */
  85120. getScene(): Scene;
  85121. /**
  85122. * You can use gravity if you want to give an orientation to your particles.
  85123. */
  85124. gravity: Vector3;
  85125. protected _colorGradients: Nullable<Array<ColorGradient>>;
  85126. protected _sizeGradients: Nullable<Array<FactorGradient>>;
  85127. protected _lifeTimeGradients: Nullable<Array<FactorGradient>>;
  85128. protected _angularSpeedGradients: Nullable<Array<FactorGradient>>;
  85129. protected _velocityGradients: Nullable<Array<FactorGradient>>;
  85130. protected _limitVelocityGradients: Nullable<Array<FactorGradient>>;
  85131. protected _dragGradients: Nullable<Array<FactorGradient>>;
  85132. protected _emitRateGradients: Nullable<Array<FactorGradient>>;
  85133. protected _startSizeGradients: Nullable<Array<FactorGradient>>;
  85134. protected _rampGradients: Nullable<Array<Color3Gradient>>;
  85135. protected _colorRemapGradients: Nullable<Array<FactorGradient>>;
  85136. protected _alphaRemapGradients: Nullable<Array<FactorGradient>>;
  85137. protected _hasTargetStopDurationDependantGradient(): boolean | null;
  85138. /**
  85139. * Defines the delay in milliseconds before starting the system (0 by default)
  85140. */
  85141. startDelay: number;
  85142. /**
  85143. * Gets the current list of drag gradients.
  85144. * You must use addDragGradient and removeDragGradient to udpate this list
  85145. * @returns the list of drag gradients
  85146. */
  85147. getDragGradients(): Nullable<Array<FactorGradient>>;
  85148. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  85149. limitVelocityDamping: number;
  85150. /**
  85151. * Gets the current list of limit velocity gradients.
  85152. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  85153. * @returns the list of limit velocity gradients
  85154. */
  85155. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  85156. /**
  85157. * Gets the current list of color gradients.
  85158. * You must use addColorGradient and removeColorGradient to udpate this list
  85159. * @returns the list of color gradients
  85160. */
  85161. getColorGradients(): Nullable<Array<ColorGradient>>;
  85162. /**
  85163. * Gets the current list of size gradients.
  85164. * You must use addSizeGradient and removeSizeGradient to udpate this list
  85165. * @returns the list of size gradients
  85166. */
  85167. getSizeGradients(): Nullable<Array<FactorGradient>>;
  85168. /**
  85169. * Gets the current list of color remap gradients.
  85170. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  85171. * @returns the list of color remap gradients
  85172. */
  85173. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  85174. /**
  85175. * Gets the current list of alpha remap gradients.
  85176. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  85177. * @returns the list of alpha remap gradients
  85178. */
  85179. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  85180. /**
  85181. * Gets the current list of life time gradients.
  85182. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  85183. * @returns the list of life time gradients
  85184. */
  85185. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  85186. /**
  85187. * Gets the current list of angular speed gradients.
  85188. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  85189. * @returns the list of angular speed gradients
  85190. */
  85191. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  85192. /**
  85193. * Gets the current list of velocity gradients.
  85194. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  85195. * @returns the list of velocity gradients
  85196. */
  85197. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  85198. /**
  85199. * Gets the current list of start size gradients.
  85200. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  85201. * @returns the list of start size gradients
  85202. */
  85203. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  85204. /**
  85205. * Gets the current list of emit rate gradients.
  85206. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  85207. * @returns the list of emit rate gradients
  85208. */
  85209. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  85210. /**
  85211. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  85212. * This only works when particleEmitterTyps is a BoxParticleEmitter
  85213. */
  85214. direction1: Vector3;
  85215. /**
  85216. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  85217. * This only works when particleEmitterTyps is a BoxParticleEmitter
  85218. */
  85219. direction2: Vector3;
  85220. /**
  85221. * 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.
  85222. * This only works when particleEmitterTyps is a BoxParticleEmitter
  85223. */
  85224. minEmitBox: Vector3;
  85225. /**
  85226. * 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.
  85227. * This only works when particleEmitterTyps is a BoxParticleEmitter
  85228. */
  85229. maxEmitBox: Vector3;
  85230. /**
  85231. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  85232. */
  85233. color1: Color4;
  85234. /**
  85235. * Random color of each particle after it has been emitted, between color1 and color2 vectors
  85236. */
  85237. color2: Color4;
  85238. /**
  85239. * Color the particle will have at the end of its lifetime
  85240. */
  85241. colorDead: Color4;
  85242. /**
  85243. * An optional mask to filter some colors out of the texture, or filter a part of the alpha channel
  85244. */
  85245. textureMask: Color4;
  85246. /**
  85247. * The particle emitter type defines the emitter used by the particle system.
  85248. * It can be for example box, sphere, or cone...
  85249. */
  85250. particleEmitterType: IParticleEmitterType;
  85251. /** @hidden */
  85252. _isSubEmitter: boolean;
  85253. /**
  85254. * Gets or sets the billboard mode to use when isBillboardBased = true.
  85255. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  85256. */
  85257. billboardMode: number;
  85258. protected _isBillboardBased: boolean;
  85259. /**
  85260. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  85261. */
  85262. isBillboardBased: boolean;
  85263. /**
  85264. * The scene the particle system belongs to.
  85265. */
  85266. protected _scene: Scene;
  85267. /**
  85268. * Local cache of defines for image processing.
  85269. */
  85270. protected _imageProcessingConfigurationDefines: ImageProcessingConfigurationDefines;
  85271. /**
  85272. * Default configuration related to image processing available in the standard Material.
  85273. */
  85274. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  85275. /**
  85276. * Gets the image processing configuration used either in this material.
  85277. */
  85278. /**
  85279. * Sets the Default image processing configuration used either in the this material.
  85280. *
  85281. * If sets to null, the scene one is in use.
  85282. */
  85283. imageProcessingConfiguration: ImageProcessingConfiguration;
  85284. /**
  85285. * Attaches a new image processing configuration to the Standard Material.
  85286. * @param configuration
  85287. */
  85288. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  85289. /** @hidden */
  85290. protected _reset(): void;
  85291. /** @hidden */
  85292. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: Nullable<RawTexture>): BaseParticleSystem;
  85293. /**
  85294. * Instantiates a particle system.
  85295. * 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.
  85296. * @param name The name of the particle system
  85297. */
  85298. constructor(name: string);
  85299. /**
  85300. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  85301. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  85302. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  85303. * @returns the emitter
  85304. */
  85305. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  85306. /**
  85307. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  85308. * @param radius The radius of the hemisphere to emit from
  85309. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  85310. * @returns the emitter
  85311. */
  85312. createHemisphericEmitter(radius?: number, radiusRange?: number): HemisphericParticleEmitter;
  85313. /**
  85314. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  85315. * @param radius The radius of the sphere to emit from
  85316. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  85317. * @returns the emitter
  85318. */
  85319. createSphereEmitter(radius?: number, radiusRange?: number): SphereParticleEmitter;
  85320. /**
  85321. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  85322. * @param radius The radius of the sphere to emit from
  85323. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  85324. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  85325. * @returns the emitter
  85326. */
  85327. createDirectedSphereEmitter(radius?: number, direction1?: Vector3, direction2?: Vector3): SphereDirectedParticleEmitter;
  85328. /**
  85329. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  85330. * @param radius The radius of the emission cylinder
  85331. * @param height The height of the emission cylinder
  85332. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  85333. * @param directionRandomizer How much to randomize the particle direction [0-1]
  85334. * @returns the emitter
  85335. */
  85336. createCylinderEmitter(radius?: number, height?: number, radiusRange?: number, directionRandomizer?: number): CylinderParticleEmitter;
  85337. /**
  85338. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  85339. * @param radius The radius of the cylinder to emit from
  85340. * @param height The height of the emission cylinder
  85341. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  85342. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  85343. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  85344. * @returns the emitter
  85345. */
  85346. createDirectedCylinderEmitter(radius?: number, height?: number, radiusRange?: number, direction1?: Vector3, direction2?: Vector3): CylinderDirectedParticleEmitter;
  85347. /**
  85348. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  85349. * @param radius The radius of the cone to emit from
  85350. * @param angle The base angle of the cone
  85351. * @returns the emitter
  85352. */
  85353. createConeEmitter(radius?: number, angle?: number): ConeParticleEmitter;
  85354. /**
  85355. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  85356. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  85357. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  85358. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  85359. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  85360. * @returns the emitter
  85361. */
  85362. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  85363. }
  85364. }
  85365. declare module BABYLON {
  85366. /**
  85367. * Type of sub emitter
  85368. */
  85369. export enum SubEmitterType {
  85370. /**
  85371. * Attached to the particle over it's lifetime
  85372. */
  85373. ATTACHED = 0,
  85374. /**
  85375. * Created when the particle dies
  85376. */
  85377. END = 1
  85378. }
  85379. /**
  85380. * Sub emitter class used to emit particles from an existing particle
  85381. */
  85382. export class SubEmitter {
  85383. /**
  85384. * the particle system to be used by the sub emitter
  85385. */
  85386. particleSystem: ParticleSystem;
  85387. /**
  85388. * Type of the submitter (Default: END)
  85389. */
  85390. type: SubEmitterType;
  85391. /**
  85392. * 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)
  85393. * Note: This only is supported when using an emitter of type Mesh
  85394. */
  85395. inheritDirection: boolean;
  85396. /**
  85397. * How much of the attached particles speed should be added to the sub emitted particle (default: 0)
  85398. */
  85399. inheritedVelocityAmount: number;
  85400. /**
  85401. * Creates a sub emitter
  85402. * @param particleSystem the particle system to be used by the sub emitter
  85403. */
  85404. constructor(
  85405. /**
  85406. * the particle system to be used by the sub emitter
  85407. */
  85408. particleSystem: ParticleSystem);
  85409. /**
  85410. * Clones the sub emitter
  85411. * @returns the cloned sub emitter
  85412. */
  85413. clone(): SubEmitter;
  85414. /**
  85415. * Serialize current object to a JSON object
  85416. * @returns the serialized object
  85417. */
  85418. serialize(): any;
  85419. /** @hidden */
  85420. static _ParseParticleSystem(system: any, scene: Scene, rootUrl: string): ParticleSystem;
  85421. /**
  85422. * Creates a new SubEmitter from a serialized JSON version
  85423. * @param serializationObject defines the JSON object to read from
  85424. * @param scene defines the hosting scene
  85425. * @param rootUrl defines the rootUrl for data loading
  85426. * @returns a new SubEmitter
  85427. */
  85428. static Parse(serializationObject: any, scene: Scene, rootUrl: string): SubEmitter;
  85429. /** Release associated resources */
  85430. dispose(): void;
  85431. }
  85432. }
  85433. declare module BABYLON {
  85434. /** @hidden */
  85435. export var clipPlaneFragmentDeclaration: {
  85436. name: string;
  85437. shader: string;
  85438. };
  85439. }
  85440. declare module BABYLON {
  85441. /** @hidden */
  85442. export var imageProcessingDeclaration: {
  85443. name: string;
  85444. shader: string;
  85445. };
  85446. }
  85447. declare module BABYLON {
  85448. /** @hidden */
  85449. export var imageProcessingFunctions: {
  85450. name: string;
  85451. shader: string;
  85452. };
  85453. }
  85454. declare module BABYLON {
  85455. /** @hidden */
  85456. export var clipPlaneFragment: {
  85457. name: string;
  85458. shader: string;
  85459. };
  85460. }
  85461. declare module BABYLON {
  85462. /** @hidden */
  85463. export var particlesPixelShader: {
  85464. name: string;
  85465. shader: string;
  85466. };
  85467. }
  85468. declare module BABYLON {
  85469. /** @hidden */
  85470. export var clipPlaneVertexDeclaration: {
  85471. name: string;
  85472. shader: string;
  85473. };
  85474. }
  85475. declare module BABYLON {
  85476. /** @hidden */
  85477. export var clipPlaneVertex: {
  85478. name: string;
  85479. shader: string;
  85480. };
  85481. }
  85482. declare module BABYLON {
  85483. /** @hidden */
  85484. export var particlesVertexShader: {
  85485. name: string;
  85486. shader: string;
  85487. };
  85488. }
  85489. declare module BABYLON {
  85490. /**
  85491. * This represents a particle system in Babylon.
  85492. * 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.
  85493. * Particles can take different shapes while emitted like box, sphere, cone or you can write your custom function.
  85494. * @example https://doc.babylonjs.com/babylon101/particles
  85495. */
  85496. export class ParticleSystem extends BaseParticleSystem implements IDisposable, IAnimatable, IParticleSystem {
  85497. /**
  85498. * Billboard mode will only apply to Y axis
  85499. */
  85500. static readonly BILLBOARDMODE_Y: number;
  85501. /**
  85502. * Billboard mode will apply to all axes
  85503. */
  85504. static readonly BILLBOARDMODE_ALL: number;
  85505. /**
  85506. * Special billboard mode where the particle will be biilboard to the camera but rotated to align with direction
  85507. */
  85508. static readonly BILLBOARDMODE_STRETCHED: number;
  85509. /**
  85510. * This function can be defined to provide custom update for active particles.
  85511. * This function will be called instead of regular update (age, position, color, etc.).
  85512. * Do not forget that this function will be called on every frame so try to keep it simple and fast :)
  85513. */
  85514. updateFunction: (particles: Particle[]) => void;
  85515. private _emitterWorldMatrix;
  85516. /**
  85517. * This function can be defined to specify initial direction for every new particle.
  85518. * It by default use the emitterType defined function
  85519. */
  85520. startDirectionFunction: (worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle) => void;
  85521. /**
  85522. * This function can be defined to specify initial position for every new particle.
  85523. * It by default use the emitterType defined function
  85524. */
  85525. startPositionFunction: (worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle) => void;
  85526. /**
  85527. * @hidden
  85528. */
  85529. _inheritedVelocityOffset: Vector3;
  85530. /**
  85531. * An event triggered when the system is disposed
  85532. */
  85533. onDisposeObservable: Observable<ParticleSystem>;
  85534. private _onDisposeObserver;
  85535. /**
  85536. * Sets a callback that will be triggered when the system is disposed
  85537. */
  85538. onDispose: () => void;
  85539. private _particles;
  85540. private _epsilon;
  85541. private _capacity;
  85542. private _stockParticles;
  85543. private _newPartsExcess;
  85544. private _vertexData;
  85545. private _vertexBuffer;
  85546. private _vertexBuffers;
  85547. private _spriteBuffer;
  85548. private _indexBuffer;
  85549. private _effect;
  85550. private _customEffect;
  85551. private _cachedDefines;
  85552. private _scaledColorStep;
  85553. private _colorDiff;
  85554. private _scaledDirection;
  85555. private _scaledGravity;
  85556. private _currentRenderId;
  85557. private _alive;
  85558. private _useInstancing;
  85559. private _started;
  85560. private _stopped;
  85561. private _actualFrame;
  85562. private _scaledUpdateSpeed;
  85563. private _vertexBufferSize;
  85564. /** @hidden */
  85565. _currentEmitRateGradient: Nullable<FactorGradient>;
  85566. /** @hidden */
  85567. _currentEmitRate1: number;
  85568. /** @hidden */
  85569. _currentEmitRate2: number;
  85570. /** @hidden */
  85571. _currentStartSizeGradient: Nullable<FactorGradient>;
  85572. /** @hidden */
  85573. _currentStartSize1: number;
  85574. /** @hidden */
  85575. _currentStartSize2: number;
  85576. private readonly _rawTextureWidth;
  85577. private _rampGradientsTexture;
  85578. private _useRampGradients;
  85579. /** Gets or sets a boolean indicating that ramp gradients must be used
  85580. * @see http://doc.babylonjs.com/babylon101/particles#ramp-gradients
  85581. */
  85582. useRampGradients: boolean;
  85583. /**
  85584. * 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.
  85585. * 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: [])
  85586. */
  85587. subEmitters: Array<ParticleSystem | SubEmitter | Array<SubEmitter>>;
  85588. private _subEmitters;
  85589. /**
  85590. * @hidden
  85591. * If the particle systems emitter should be disposed when the particle system is disposed
  85592. */
  85593. _disposeEmitterOnDispose: boolean;
  85594. /**
  85595. * The current active Sub-systems, this property is used by the root particle system only.
  85596. */
  85597. activeSubSystems: Array<ParticleSystem>;
  85598. private _rootParticleSystem;
  85599. /**
  85600. * Gets the current list of active particles
  85601. */
  85602. readonly particles: Particle[];
  85603. /**
  85604. * Returns the string "ParticleSystem"
  85605. * @returns a string containing the class name
  85606. */
  85607. getClassName(): string;
  85608. /**
  85609. * Instantiates a particle system.
  85610. * 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.
  85611. * @param name The name of the particle system
  85612. * @param capacity The max number of particles alive at the same time
  85613. * @param scene The scene the particle system belongs to
  85614. * @param customEffect a custom effect used to change the way particles are rendered by default
  85615. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  85616. * @param epsilon Offset used to render the particles
  85617. */
  85618. constructor(name: string, capacity: number, scene: Scene, customEffect?: Nullable<Effect>, isAnimationSheetEnabled?: boolean, epsilon?: number);
  85619. private _addFactorGradient;
  85620. private _removeFactorGradient;
  85621. /**
  85622. * Adds a new life time gradient
  85623. * @param gradient defines the gradient to use (between 0 and 1)
  85624. * @param factor defines the life time factor to affect to the specified gradient
  85625. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  85626. * @returns the current particle system
  85627. */
  85628. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  85629. /**
  85630. * Remove a specific life time gradient
  85631. * @param gradient defines the gradient to remove
  85632. * @returns the current particle system
  85633. */
  85634. removeLifeTimeGradient(gradient: number): IParticleSystem;
  85635. /**
  85636. * Adds a new size gradient
  85637. * @param gradient defines the gradient to use (between 0 and 1)
  85638. * @param factor defines the size factor to affect to the specified gradient
  85639. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  85640. * @returns the current particle system
  85641. */
  85642. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  85643. /**
  85644. * Remove a specific size gradient
  85645. * @param gradient defines the gradient to remove
  85646. * @returns the current particle system
  85647. */
  85648. removeSizeGradient(gradient: number): IParticleSystem;
  85649. /**
  85650. * Adds a new color remap gradient
  85651. * @param gradient defines the gradient to use (between 0 and 1)
  85652. * @param min defines the color remap minimal range
  85653. * @param max defines the color remap maximal range
  85654. * @returns the current particle system
  85655. */
  85656. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  85657. /**
  85658. * Remove a specific color remap gradient
  85659. * @param gradient defines the gradient to remove
  85660. * @returns the current particle system
  85661. */
  85662. removeColorRemapGradient(gradient: number): IParticleSystem;
  85663. /**
  85664. * Adds a new alpha remap gradient
  85665. * @param gradient defines the gradient to use (between 0 and 1)
  85666. * @param min defines the alpha remap minimal range
  85667. * @param max defines the alpha remap maximal range
  85668. * @returns the current particle system
  85669. */
  85670. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  85671. /**
  85672. * Remove a specific alpha remap gradient
  85673. * @param gradient defines the gradient to remove
  85674. * @returns the current particle system
  85675. */
  85676. removeAlphaRemapGradient(gradient: number): IParticleSystem;
  85677. /**
  85678. * Adds a new angular speed gradient
  85679. * @param gradient defines the gradient to use (between 0 and 1)
  85680. * @param factor defines the angular speed to affect to the specified gradient
  85681. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  85682. * @returns the current particle system
  85683. */
  85684. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  85685. /**
  85686. * Remove a specific angular speed gradient
  85687. * @param gradient defines the gradient to remove
  85688. * @returns the current particle system
  85689. */
  85690. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  85691. /**
  85692. * Adds a new velocity gradient
  85693. * @param gradient defines the gradient to use (between 0 and 1)
  85694. * @param factor defines the velocity to affect to the specified gradient
  85695. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  85696. * @returns the current particle system
  85697. */
  85698. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  85699. /**
  85700. * Remove a specific velocity gradient
  85701. * @param gradient defines the gradient to remove
  85702. * @returns the current particle system
  85703. */
  85704. removeVelocityGradient(gradient: number): IParticleSystem;
  85705. /**
  85706. * Adds a new limit velocity gradient
  85707. * @param gradient defines the gradient to use (between 0 and 1)
  85708. * @param factor defines the limit velocity value to affect to the specified gradient
  85709. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  85710. * @returns the current particle system
  85711. */
  85712. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  85713. /**
  85714. * Remove a specific limit velocity gradient
  85715. * @param gradient defines the gradient to remove
  85716. * @returns the current particle system
  85717. */
  85718. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  85719. /**
  85720. * Adds a new drag gradient
  85721. * @param gradient defines the gradient to use (between 0 and 1)
  85722. * @param factor defines the drag value to affect to the specified gradient
  85723. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  85724. * @returns the current particle system
  85725. */
  85726. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  85727. /**
  85728. * Remove a specific drag gradient
  85729. * @param gradient defines the gradient to remove
  85730. * @returns the current particle system
  85731. */
  85732. removeDragGradient(gradient: number): IParticleSystem;
  85733. /**
  85734. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  85735. * @param gradient defines the gradient to use (between 0 and 1)
  85736. * @param factor defines the emit rate value to affect to the specified gradient
  85737. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  85738. * @returns the current particle system
  85739. */
  85740. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  85741. /**
  85742. * Remove a specific emit rate gradient
  85743. * @param gradient defines the gradient to remove
  85744. * @returns the current particle system
  85745. */
  85746. removeEmitRateGradient(gradient: number): IParticleSystem;
  85747. /**
  85748. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  85749. * @param gradient defines the gradient to use (between 0 and 1)
  85750. * @param factor defines the start size value to affect to the specified gradient
  85751. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  85752. * @returns the current particle system
  85753. */
  85754. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  85755. /**
  85756. * Remove a specific start size gradient
  85757. * @param gradient defines the gradient to remove
  85758. * @returns the current particle system
  85759. */
  85760. removeStartSizeGradient(gradient: number): IParticleSystem;
  85761. private _createRampGradientTexture;
  85762. /**
  85763. * Gets the current list of ramp gradients.
  85764. * You must use addRampGradient and removeRampGradient to udpate this list
  85765. * @returns the list of ramp gradients
  85766. */
  85767. getRampGradients(): Nullable<Array<Color3Gradient>>;
  85768. /**
  85769. * Adds a new ramp gradient used to remap particle colors
  85770. * @param gradient defines the gradient to use (between 0 and 1)
  85771. * @param color defines the color to affect to the specified gradient
  85772. * @returns the current particle system
  85773. */
  85774. addRampGradient(gradient: number, color: Color3): ParticleSystem;
  85775. /**
  85776. * Remove a specific ramp gradient
  85777. * @param gradient defines the gradient to remove
  85778. * @returns the current particle system
  85779. */
  85780. removeRampGradient(gradient: number): ParticleSystem;
  85781. /**
  85782. * Adds a new color gradient
  85783. * @param gradient defines the gradient to use (between 0 and 1)
  85784. * @param color1 defines the color to affect to the specified gradient
  85785. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  85786. * @returns this particle system
  85787. */
  85788. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  85789. /**
  85790. * Remove a specific color gradient
  85791. * @param gradient defines the gradient to remove
  85792. * @returns this particle system
  85793. */
  85794. removeColorGradient(gradient: number): IParticleSystem;
  85795. private _fetchR;
  85796. protected _reset(): void;
  85797. private _resetEffect;
  85798. private _createVertexBuffers;
  85799. private _createIndexBuffer;
  85800. /**
  85801. * Gets the maximum number of particles active at the same time.
  85802. * @returns The max number of active particles.
  85803. */
  85804. getCapacity(): number;
  85805. /**
  85806. * Gets whether there are still active particles in the system.
  85807. * @returns True if it is alive, otherwise false.
  85808. */
  85809. isAlive(): boolean;
  85810. /**
  85811. * Gets if the system has been started. (Note: this will still be true after stop is called)
  85812. * @returns True if it has been started, otherwise false.
  85813. */
  85814. isStarted(): boolean;
  85815. private _prepareSubEmitterInternalArray;
  85816. /**
  85817. * Starts the particle system and begins to emit
  85818. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  85819. */
  85820. start(delay?: number): void;
  85821. /**
  85822. * Stops the particle system.
  85823. * @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.
  85824. */
  85825. stop(stopSubEmitters?: boolean): void;
  85826. /**
  85827. * Remove all active particles
  85828. */
  85829. reset(): void;
  85830. /**
  85831. * @hidden (for internal use only)
  85832. */
  85833. _appendParticleVertex(index: number, particle: Particle, offsetX: number, offsetY: number): void;
  85834. /**
  85835. * "Recycles" one of the particle by copying it back to the "stock" of particles and removing it from the active list.
  85836. * Its lifetime will start back at 0.
  85837. */
  85838. recycleParticle: (particle: Particle) => void;
  85839. private _stopSubEmitters;
  85840. private _createParticle;
  85841. private _removeFromRoot;
  85842. private _emitFromParticle;
  85843. private _update;
  85844. /** @hidden */
  85845. static _GetAttributeNamesOrOptions(isAnimationSheetEnabled?: boolean, isBillboardBased?: boolean, useRampGradients?: boolean): string[];
  85846. /** @hidden */
  85847. static _GetEffectCreationOptions(isAnimationSheetEnabled?: boolean): string[];
  85848. /** @hidden */
  85849. private _getEffect;
  85850. /**
  85851. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  85852. * @param preWarmOnly will prevent the system from updating the vertex buffer (default is false)
  85853. */
  85854. animate(preWarmOnly?: boolean): void;
  85855. private _appendParticleVertices;
  85856. /**
  85857. * Rebuilds the particle system.
  85858. */
  85859. rebuild(): void;
  85860. /**
  85861. * Is this system ready to be used/rendered
  85862. * @return true if the system is ready
  85863. */
  85864. isReady(): boolean;
  85865. private _render;
  85866. /**
  85867. * Renders the particle system in its current state.
  85868. * @returns the current number of particles
  85869. */
  85870. render(): number;
  85871. /**
  85872. * Disposes the particle system and free the associated resources
  85873. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  85874. */
  85875. dispose(disposeTexture?: boolean): void;
  85876. /**
  85877. * Clones the particle system.
  85878. * @param name The name of the cloned object
  85879. * @param newEmitter The new emitter to use
  85880. * @returns the cloned particle system
  85881. */
  85882. clone(name: string, newEmitter: any): ParticleSystem;
  85883. /**
  85884. * Serializes the particle system to a JSON object.
  85885. * @returns the JSON object
  85886. */
  85887. serialize(): any;
  85888. /** @hidden */
  85889. static _Serialize(serializationObject: any, particleSystem: IParticleSystem): void;
  85890. /** @hidden */
  85891. static _Parse(parsedParticleSystem: any, particleSystem: IParticleSystem, scene: Scene, rootUrl: string): void;
  85892. /**
  85893. * Parses a JSON object to create a particle system.
  85894. * @param parsedParticleSystem The JSON object to parse
  85895. * @param scene The scene to create the particle system in
  85896. * @param rootUrl The root url to use to load external dependencies like texture
  85897. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  85898. * @returns the Parsed particle system
  85899. */
  85900. static Parse(parsedParticleSystem: any, scene: Scene, rootUrl: string, doNotStart?: boolean): ParticleSystem;
  85901. }
  85902. }
  85903. declare module BABYLON {
  85904. /**
  85905. * A particle represents one of the element emitted by a particle system.
  85906. * This is mainly define by its coordinates, direction, velocity and age.
  85907. */
  85908. export class Particle {
  85909. /**
  85910. * The particle system the particle belongs to.
  85911. */
  85912. particleSystem: ParticleSystem;
  85913. private static _Count;
  85914. /**
  85915. * Unique ID of the particle
  85916. */
  85917. id: number;
  85918. /**
  85919. * The world position of the particle in the scene.
  85920. */
  85921. position: Vector3;
  85922. /**
  85923. * The world direction of the particle in the scene.
  85924. */
  85925. direction: Vector3;
  85926. /**
  85927. * The color of the particle.
  85928. */
  85929. color: Color4;
  85930. /**
  85931. * The color change of the particle per step.
  85932. */
  85933. colorStep: Color4;
  85934. /**
  85935. * Defines how long will the life of the particle be.
  85936. */
  85937. lifeTime: number;
  85938. /**
  85939. * The current age of the particle.
  85940. */
  85941. age: number;
  85942. /**
  85943. * The current size of the particle.
  85944. */
  85945. size: number;
  85946. /**
  85947. * The current scale of the particle.
  85948. */
  85949. scale: Vector2;
  85950. /**
  85951. * The current angle of the particle.
  85952. */
  85953. angle: number;
  85954. /**
  85955. * Defines how fast is the angle changing.
  85956. */
  85957. angularSpeed: number;
  85958. /**
  85959. * Defines the cell index used by the particle to be rendered from a sprite.
  85960. */
  85961. cellIndex: number;
  85962. /**
  85963. * The information required to support color remapping
  85964. */
  85965. remapData: Vector4;
  85966. /** @hidden */
  85967. _randomCellOffset?: number;
  85968. /** @hidden */
  85969. _initialDirection: Nullable<Vector3>;
  85970. /** @hidden */
  85971. _attachedSubEmitters: Nullable<Array<SubEmitter>>;
  85972. /** @hidden */
  85973. _initialStartSpriteCellID: number;
  85974. /** @hidden */
  85975. _initialEndSpriteCellID: number;
  85976. /** @hidden */
  85977. _currentColorGradient: Nullable<ColorGradient>;
  85978. /** @hidden */
  85979. _currentColor1: Color4;
  85980. /** @hidden */
  85981. _currentColor2: Color4;
  85982. /** @hidden */
  85983. _currentSizeGradient: Nullable<FactorGradient>;
  85984. /** @hidden */
  85985. _currentSize1: number;
  85986. /** @hidden */
  85987. _currentSize2: number;
  85988. /** @hidden */
  85989. _currentAngularSpeedGradient: Nullable<FactorGradient>;
  85990. /** @hidden */
  85991. _currentAngularSpeed1: number;
  85992. /** @hidden */
  85993. _currentAngularSpeed2: number;
  85994. /** @hidden */
  85995. _currentVelocityGradient: Nullable<FactorGradient>;
  85996. /** @hidden */
  85997. _currentVelocity1: number;
  85998. /** @hidden */
  85999. _currentVelocity2: number;
  86000. /** @hidden */
  86001. _currentLimitVelocityGradient: Nullable<FactorGradient>;
  86002. /** @hidden */
  86003. _currentLimitVelocity1: number;
  86004. /** @hidden */
  86005. _currentLimitVelocity2: number;
  86006. /** @hidden */
  86007. _currentDragGradient: Nullable<FactorGradient>;
  86008. /** @hidden */
  86009. _currentDrag1: number;
  86010. /** @hidden */
  86011. _currentDrag2: number;
  86012. /** @hidden */
  86013. _randomNoiseCoordinates1: Vector3;
  86014. /** @hidden */
  86015. _randomNoiseCoordinates2: Vector3;
  86016. /**
  86017. * Creates a new instance Particle
  86018. * @param particleSystem the particle system the particle belongs to
  86019. */
  86020. constructor(
  86021. /**
  86022. * The particle system the particle belongs to.
  86023. */
  86024. particleSystem: ParticleSystem);
  86025. private updateCellInfoFromSystem;
  86026. /**
  86027. * Defines how the sprite cell index is updated for the particle
  86028. */
  86029. updateCellIndex(): void;
  86030. /** @hidden */
  86031. _inheritParticleInfoToSubEmitter(subEmitter: SubEmitter): void;
  86032. /** @hidden */
  86033. _inheritParticleInfoToSubEmitters(): void;
  86034. /** @hidden */
  86035. _reset(): void;
  86036. /**
  86037. * Copy the properties of particle to another one.
  86038. * @param other the particle to copy the information to.
  86039. */
  86040. copyTo(other: Particle): void;
  86041. }
  86042. }
  86043. declare module BABYLON {
  86044. /**
  86045. * Particle emitter represents a volume emitting particles.
  86046. * This is the responsibility of the implementation to define the volume shape like cone/sphere/box.
  86047. */
  86048. export interface IParticleEmitterType {
  86049. /**
  86050. * Called by the particle System when the direction is computed for the created particle.
  86051. * @param worldMatrix is the world matrix of the particle system
  86052. * @param directionToUpdate is the direction vector to update with the result
  86053. * @param particle is the particle we are computed the direction for
  86054. */
  86055. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  86056. /**
  86057. * Called by the particle System when the position is computed for the created particle.
  86058. * @param worldMatrix is the world matrix of the particle system
  86059. * @param positionToUpdate is the position vector to update with the result
  86060. * @param particle is the particle we are computed the position for
  86061. */
  86062. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  86063. /**
  86064. * Clones the current emitter and returns a copy of it
  86065. * @returns the new emitter
  86066. */
  86067. clone(): IParticleEmitterType;
  86068. /**
  86069. * Called by the GPUParticleSystem to setup the update shader
  86070. * @param effect defines the update shader
  86071. */
  86072. applyToShader(effect: Effect): void;
  86073. /**
  86074. * Returns a string to use to update the GPU particles update shader
  86075. * @returns the effect defines string
  86076. */
  86077. getEffectDefines(): string;
  86078. /**
  86079. * Returns a string representing the class name
  86080. * @returns a string containing the class name
  86081. */
  86082. getClassName(): string;
  86083. /**
  86084. * Serializes the particle system to a JSON object.
  86085. * @returns the JSON object
  86086. */
  86087. serialize(): any;
  86088. /**
  86089. * Parse properties from a JSON object
  86090. * @param serializationObject defines the JSON object
  86091. */
  86092. parse(serializationObject: any): void;
  86093. }
  86094. }
  86095. declare module BABYLON {
  86096. /**
  86097. * Particle emitter emitting particles from the inside of a box.
  86098. * It emits the particles randomly between 2 given directions.
  86099. */
  86100. export class BoxParticleEmitter implements IParticleEmitterType {
  86101. /**
  86102. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  86103. */
  86104. direction1: Vector3;
  86105. /**
  86106. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  86107. */
  86108. direction2: Vector3;
  86109. /**
  86110. * 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.
  86111. */
  86112. minEmitBox: Vector3;
  86113. /**
  86114. * 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.
  86115. */
  86116. maxEmitBox: Vector3;
  86117. /**
  86118. * Creates a new instance BoxParticleEmitter
  86119. */
  86120. constructor();
  86121. /**
  86122. * Called by the particle System when the direction is computed for the created particle.
  86123. * @param worldMatrix is the world matrix of the particle system
  86124. * @param directionToUpdate is the direction vector to update with the result
  86125. * @param particle is the particle we are computed the direction for
  86126. */
  86127. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  86128. /**
  86129. * Called by the particle System when the position is computed for the created particle.
  86130. * @param worldMatrix is the world matrix of the particle system
  86131. * @param positionToUpdate is the position vector to update with the result
  86132. * @param particle is the particle we are computed the position for
  86133. */
  86134. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  86135. /**
  86136. * Clones the current emitter and returns a copy of it
  86137. * @returns the new emitter
  86138. */
  86139. clone(): BoxParticleEmitter;
  86140. /**
  86141. * Called by the GPUParticleSystem to setup the update shader
  86142. * @param effect defines the update shader
  86143. */
  86144. applyToShader(effect: Effect): void;
  86145. /**
  86146. * Returns a string to use to update the GPU particles update shader
  86147. * @returns a string containng the defines string
  86148. */
  86149. getEffectDefines(): string;
  86150. /**
  86151. * Returns the string "BoxParticleEmitter"
  86152. * @returns a string containing the class name
  86153. */
  86154. getClassName(): string;
  86155. /**
  86156. * Serializes the particle system to a JSON object.
  86157. * @returns the JSON object
  86158. */
  86159. serialize(): any;
  86160. /**
  86161. * Parse properties from a JSON object
  86162. * @param serializationObject defines the JSON object
  86163. */
  86164. parse(serializationObject: any): void;
  86165. }
  86166. }
  86167. declare module BABYLON {
  86168. /**
  86169. * Particle emitter emitting particles from the inside of a cone.
  86170. * It emits the particles alongside the cone volume from the base to the particle.
  86171. * The emission direction might be randomized.
  86172. */
  86173. export class ConeParticleEmitter implements IParticleEmitterType {
  86174. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  86175. directionRandomizer: number;
  86176. private _radius;
  86177. private _angle;
  86178. private _height;
  86179. /**
  86180. * Gets or sets a value indicating where on the radius the start position should be picked (1 = everywhere, 0 = only surface)
  86181. */
  86182. radiusRange: number;
  86183. /**
  86184. * Gets or sets a value indicating where on the height the start position should be picked (1 = everywhere, 0 = only surface)
  86185. */
  86186. heightRange: number;
  86187. /**
  86188. * Gets or sets a value indicating if all the particles should be emitted from the spawn point only (the base of the cone)
  86189. */
  86190. emitFromSpawnPointOnly: boolean;
  86191. /**
  86192. * Gets or sets the radius of the emission cone
  86193. */
  86194. radius: number;
  86195. /**
  86196. * Gets or sets the angle of the emission cone
  86197. */
  86198. angle: number;
  86199. private _buildHeight;
  86200. /**
  86201. * Creates a new instance ConeParticleEmitter
  86202. * @param radius the radius of the emission cone (1 by default)
  86203. * @param angle the cone base angle (PI by default)
  86204. * @param directionRandomizer defines how much to randomize the particle direction [0-1] (default is 0)
  86205. */
  86206. constructor(radius?: number, angle?: number,
  86207. /** defines how much to randomize the particle direction [0-1] (default is 0) */
  86208. directionRandomizer?: number);
  86209. /**
  86210. * Called by the particle System when the direction is computed for the created particle.
  86211. * @param worldMatrix is the world matrix of the particle system
  86212. * @param directionToUpdate is the direction vector to update with the result
  86213. * @param particle is the particle we are computed the direction for
  86214. */
  86215. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  86216. /**
  86217. * Called by the particle System when the position is computed for the created particle.
  86218. * @param worldMatrix is the world matrix of the particle system
  86219. * @param positionToUpdate is the position vector to update with the result
  86220. * @param particle is the particle we are computed the position for
  86221. */
  86222. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  86223. /**
  86224. * Clones the current emitter and returns a copy of it
  86225. * @returns the new emitter
  86226. */
  86227. clone(): ConeParticleEmitter;
  86228. /**
  86229. * Called by the GPUParticleSystem to setup the update shader
  86230. * @param effect defines the update shader
  86231. */
  86232. applyToShader(effect: Effect): void;
  86233. /**
  86234. * Returns a string to use to update the GPU particles update shader
  86235. * @returns a string containng the defines string
  86236. */
  86237. getEffectDefines(): string;
  86238. /**
  86239. * Returns the string "ConeParticleEmitter"
  86240. * @returns a string containing the class name
  86241. */
  86242. getClassName(): string;
  86243. /**
  86244. * Serializes the particle system to a JSON object.
  86245. * @returns the JSON object
  86246. */
  86247. serialize(): any;
  86248. /**
  86249. * Parse properties from a JSON object
  86250. * @param serializationObject defines the JSON object
  86251. */
  86252. parse(serializationObject: any): void;
  86253. }
  86254. }
  86255. declare module BABYLON {
  86256. /**
  86257. * Particle emitter emitting particles from the inside of a cylinder.
  86258. * It emits the particles alongside the cylinder radius. The emission direction might be randomized.
  86259. */
  86260. export class CylinderParticleEmitter implements IParticleEmitterType {
  86261. /**
  86262. * The radius of the emission cylinder.
  86263. */
  86264. radius: number;
  86265. /**
  86266. * The height of the emission cylinder.
  86267. */
  86268. height: number;
  86269. /**
  86270. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  86271. */
  86272. radiusRange: number;
  86273. /**
  86274. * How much to randomize the particle direction [0-1].
  86275. */
  86276. directionRandomizer: number;
  86277. /**
  86278. * Creates a new instance CylinderParticleEmitter
  86279. * @param radius the radius of the emission cylinder (1 by default)
  86280. * @param height the height of the emission cylinder (1 by default)
  86281. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  86282. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  86283. */
  86284. constructor(
  86285. /**
  86286. * The radius of the emission cylinder.
  86287. */
  86288. radius?: number,
  86289. /**
  86290. * The height of the emission cylinder.
  86291. */
  86292. height?: number,
  86293. /**
  86294. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  86295. */
  86296. radiusRange?: number,
  86297. /**
  86298. * How much to randomize the particle direction [0-1].
  86299. */
  86300. directionRandomizer?: number);
  86301. /**
  86302. * Called by the particle System when the direction is computed for the created particle.
  86303. * @param worldMatrix is the world matrix of the particle system
  86304. * @param directionToUpdate is the direction vector to update with the result
  86305. * @param particle is the particle we are computed the direction for
  86306. */
  86307. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  86308. /**
  86309. * Called by the particle System when the position is computed for the created particle.
  86310. * @param worldMatrix is the world matrix of the particle system
  86311. * @param positionToUpdate is the position vector to update with the result
  86312. * @param particle is the particle we are computed the position for
  86313. */
  86314. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  86315. /**
  86316. * Clones the current emitter and returns a copy of it
  86317. * @returns the new emitter
  86318. */
  86319. clone(): CylinderParticleEmitter;
  86320. /**
  86321. * Called by the GPUParticleSystem to setup the update shader
  86322. * @param effect defines the update shader
  86323. */
  86324. applyToShader(effect: Effect): void;
  86325. /**
  86326. * Returns a string to use to update the GPU particles update shader
  86327. * @returns a string containng the defines string
  86328. */
  86329. getEffectDefines(): string;
  86330. /**
  86331. * Returns the string "CylinderParticleEmitter"
  86332. * @returns a string containing the class name
  86333. */
  86334. getClassName(): string;
  86335. /**
  86336. * Serializes the particle system to a JSON object.
  86337. * @returns the JSON object
  86338. */
  86339. serialize(): any;
  86340. /**
  86341. * Parse properties from a JSON object
  86342. * @param serializationObject defines the JSON object
  86343. */
  86344. parse(serializationObject: any): void;
  86345. }
  86346. /**
  86347. * Particle emitter emitting particles from the inside of a cylinder.
  86348. * It emits the particles randomly between two vectors.
  86349. */
  86350. export class CylinderDirectedParticleEmitter extends CylinderParticleEmitter {
  86351. /**
  86352. * The min limit of the emission direction.
  86353. */
  86354. direction1: Vector3;
  86355. /**
  86356. * The max limit of the emission direction.
  86357. */
  86358. direction2: Vector3;
  86359. /**
  86360. * Creates a new instance CylinderDirectedParticleEmitter
  86361. * @param radius the radius of the emission cylinder (1 by default)
  86362. * @param height the height of the emission cylinder (1 by default)
  86363. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  86364. * @param direction1 the min limit of the emission direction (up vector by default)
  86365. * @param direction2 the max limit of the emission direction (up vector by default)
  86366. */
  86367. constructor(radius?: number, height?: number, radiusRange?: number,
  86368. /**
  86369. * The min limit of the emission direction.
  86370. */
  86371. direction1?: Vector3,
  86372. /**
  86373. * The max limit of the emission direction.
  86374. */
  86375. direction2?: Vector3);
  86376. /**
  86377. * Called by the particle System when the direction is computed for the created particle.
  86378. * @param worldMatrix is the world matrix of the particle system
  86379. * @param directionToUpdate is the direction vector to update with the result
  86380. * @param particle is the particle we are computed the direction for
  86381. */
  86382. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  86383. /**
  86384. * Clones the current emitter and returns a copy of it
  86385. * @returns the new emitter
  86386. */
  86387. clone(): CylinderDirectedParticleEmitter;
  86388. /**
  86389. * Called by the GPUParticleSystem to setup the update shader
  86390. * @param effect defines the update shader
  86391. */
  86392. applyToShader(effect: Effect): void;
  86393. /**
  86394. * Returns a string to use to update the GPU particles update shader
  86395. * @returns a string containng the defines string
  86396. */
  86397. getEffectDefines(): string;
  86398. /**
  86399. * Returns the string "CylinderDirectedParticleEmitter"
  86400. * @returns a string containing the class name
  86401. */
  86402. getClassName(): string;
  86403. /**
  86404. * Serializes the particle system to a JSON object.
  86405. * @returns the JSON object
  86406. */
  86407. serialize(): any;
  86408. /**
  86409. * Parse properties from a JSON object
  86410. * @param serializationObject defines the JSON object
  86411. */
  86412. parse(serializationObject: any): void;
  86413. }
  86414. }
  86415. declare module BABYLON {
  86416. /**
  86417. * Particle emitter emitting particles from the inside of a hemisphere.
  86418. * It emits the particles alongside the hemisphere radius. The emission direction might be randomized.
  86419. */
  86420. export class HemisphericParticleEmitter implements IParticleEmitterType {
  86421. /**
  86422. * The radius of the emission hemisphere.
  86423. */
  86424. radius: number;
  86425. /**
  86426. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  86427. */
  86428. radiusRange: number;
  86429. /**
  86430. * How much to randomize the particle direction [0-1].
  86431. */
  86432. directionRandomizer: number;
  86433. /**
  86434. * Creates a new instance HemisphericParticleEmitter
  86435. * @param radius the radius of the emission hemisphere (1 by default)
  86436. * @param radiusRange the range of the emission hemisphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  86437. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  86438. */
  86439. constructor(
  86440. /**
  86441. * The radius of the emission hemisphere.
  86442. */
  86443. radius?: number,
  86444. /**
  86445. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  86446. */
  86447. radiusRange?: number,
  86448. /**
  86449. * How much to randomize the particle direction [0-1].
  86450. */
  86451. directionRandomizer?: number);
  86452. /**
  86453. * Called by the particle System when the direction is computed for the created particle.
  86454. * @param worldMatrix is the world matrix of the particle system
  86455. * @param directionToUpdate is the direction vector to update with the result
  86456. * @param particle is the particle we are computed the direction for
  86457. */
  86458. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  86459. /**
  86460. * Called by the particle System when the position is computed for the created particle.
  86461. * @param worldMatrix is the world matrix of the particle system
  86462. * @param positionToUpdate is the position vector to update with the result
  86463. * @param particle is the particle we are computed the position for
  86464. */
  86465. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  86466. /**
  86467. * Clones the current emitter and returns a copy of it
  86468. * @returns the new emitter
  86469. */
  86470. clone(): HemisphericParticleEmitter;
  86471. /**
  86472. * Called by the GPUParticleSystem to setup the update shader
  86473. * @param effect defines the update shader
  86474. */
  86475. applyToShader(effect: Effect): void;
  86476. /**
  86477. * Returns a string to use to update the GPU particles update shader
  86478. * @returns a string containng the defines string
  86479. */
  86480. getEffectDefines(): string;
  86481. /**
  86482. * Returns the string "HemisphericParticleEmitter"
  86483. * @returns a string containing the class name
  86484. */
  86485. getClassName(): string;
  86486. /**
  86487. * Serializes the particle system to a JSON object.
  86488. * @returns the JSON object
  86489. */
  86490. serialize(): any;
  86491. /**
  86492. * Parse properties from a JSON object
  86493. * @param serializationObject defines the JSON object
  86494. */
  86495. parse(serializationObject: any): void;
  86496. }
  86497. }
  86498. declare module BABYLON {
  86499. /**
  86500. * Particle emitter emitting particles from a point.
  86501. * It emits the particles randomly between 2 given directions.
  86502. */
  86503. export class PointParticleEmitter implements IParticleEmitterType {
  86504. /**
  86505. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  86506. */
  86507. direction1: Vector3;
  86508. /**
  86509. * Random direction of each particle after it has been emitted, between direction1 and direction2 vectors.
  86510. */
  86511. direction2: Vector3;
  86512. /**
  86513. * Creates a new instance PointParticleEmitter
  86514. */
  86515. constructor();
  86516. /**
  86517. * Called by the particle System when the direction is computed for the created particle.
  86518. * @param worldMatrix is the world matrix of the particle system
  86519. * @param directionToUpdate is the direction vector to update with the result
  86520. * @param particle is the particle we are computed the direction for
  86521. */
  86522. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  86523. /**
  86524. * Called by the particle System when the position is computed for the created particle.
  86525. * @param worldMatrix is the world matrix of the particle system
  86526. * @param positionToUpdate is the position vector to update with the result
  86527. * @param particle is the particle we are computed the position for
  86528. */
  86529. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  86530. /**
  86531. * Clones the current emitter and returns a copy of it
  86532. * @returns the new emitter
  86533. */
  86534. clone(): PointParticleEmitter;
  86535. /**
  86536. * Called by the GPUParticleSystem to setup the update shader
  86537. * @param effect defines the update shader
  86538. */
  86539. applyToShader(effect: Effect): void;
  86540. /**
  86541. * Returns a string to use to update the GPU particles update shader
  86542. * @returns a string containng the defines string
  86543. */
  86544. getEffectDefines(): string;
  86545. /**
  86546. * Returns the string "PointParticleEmitter"
  86547. * @returns a string containing the class name
  86548. */
  86549. getClassName(): string;
  86550. /**
  86551. * Serializes the particle system to a JSON object.
  86552. * @returns the JSON object
  86553. */
  86554. serialize(): any;
  86555. /**
  86556. * Parse properties from a JSON object
  86557. * @param serializationObject defines the JSON object
  86558. */
  86559. parse(serializationObject: any): void;
  86560. }
  86561. }
  86562. declare module BABYLON {
  86563. /**
  86564. * Particle emitter emitting particles from the inside of a sphere.
  86565. * It emits the particles alongside the sphere radius. The emission direction might be randomized.
  86566. */
  86567. export class SphereParticleEmitter implements IParticleEmitterType {
  86568. /**
  86569. * The radius of the emission sphere.
  86570. */
  86571. radius: number;
  86572. /**
  86573. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  86574. */
  86575. radiusRange: number;
  86576. /**
  86577. * How much to randomize the particle direction [0-1].
  86578. */
  86579. directionRandomizer: number;
  86580. /**
  86581. * Creates a new instance SphereParticleEmitter
  86582. * @param radius the radius of the emission sphere (1 by default)
  86583. * @param radiusRange the range of the emission sphere [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  86584. * @param directionRandomizer defines how much to randomize the particle direction [0-1]
  86585. */
  86586. constructor(
  86587. /**
  86588. * The radius of the emission sphere.
  86589. */
  86590. radius?: number,
  86591. /**
  86592. * The range of emission [0-1] 0 Surface only, 1 Entire Radius.
  86593. */
  86594. radiusRange?: number,
  86595. /**
  86596. * How much to randomize the particle direction [0-1].
  86597. */
  86598. directionRandomizer?: number);
  86599. /**
  86600. * Called by the particle System when the direction is computed for the created particle.
  86601. * @param worldMatrix is the world matrix of the particle system
  86602. * @param directionToUpdate is the direction vector to update with the result
  86603. * @param particle is the particle we are computed the direction for
  86604. */
  86605. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  86606. /**
  86607. * Called by the particle System when the position is computed for the created particle.
  86608. * @param worldMatrix is the world matrix of the particle system
  86609. * @param positionToUpdate is the position vector to update with the result
  86610. * @param particle is the particle we are computed the position for
  86611. */
  86612. startPositionFunction(worldMatrix: Matrix, positionToUpdate: Vector3, particle: Particle): void;
  86613. /**
  86614. * Clones the current emitter and returns a copy of it
  86615. * @returns the new emitter
  86616. */
  86617. clone(): SphereParticleEmitter;
  86618. /**
  86619. * Called by the GPUParticleSystem to setup the update shader
  86620. * @param effect defines the update shader
  86621. */
  86622. applyToShader(effect: Effect): void;
  86623. /**
  86624. * Returns a string to use to update the GPU particles update shader
  86625. * @returns a string containng the defines string
  86626. */
  86627. getEffectDefines(): string;
  86628. /**
  86629. * Returns the string "SphereParticleEmitter"
  86630. * @returns a string containing the class name
  86631. */
  86632. getClassName(): string;
  86633. /**
  86634. * Serializes the particle system to a JSON object.
  86635. * @returns the JSON object
  86636. */
  86637. serialize(): any;
  86638. /**
  86639. * Parse properties from a JSON object
  86640. * @param serializationObject defines the JSON object
  86641. */
  86642. parse(serializationObject: any): void;
  86643. }
  86644. /**
  86645. * Particle emitter emitting particles from the inside of a sphere.
  86646. * It emits the particles randomly between two vectors.
  86647. */
  86648. export class SphereDirectedParticleEmitter extends SphereParticleEmitter {
  86649. /**
  86650. * The min limit of the emission direction.
  86651. */
  86652. direction1: Vector3;
  86653. /**
  86654. * The max limit of the emission direction.
  86655. */
  86656. direction2: Vector3;
  86657. /**
  86658. * Creates a new instance SphereDirectedParticleEmitter
  86659. * @param radius the radius of the emission sphere (1 by default)
  86660. * @param direction1 the min limit of the emission direction (up vector by default)
  86661. * @param direction2 the max limit of the emission direction (up vector by default)
  86662. */
  86663. constructor(radius?: number,
  86664. /**
  86665. * The min limit of the emission direction.
  86666. */
  86667. direction1?: Vector3,
  86668. /**
  86669. * The max limit of the emission direction.
  86670. */
  86671. direction2?: Vector3);
  86672. /**
  86673. * Called by the particle System when the direction is computed for the created particle.
  86674. * @param worldMatrix is the world matrix of the particle system
  86675. * @param directionToUpdate is the direction vector to update with the result
  86676. * @param particle is the particle we are computed the direction for
  86677. */
  86678. startDirectionFunction(worldMatrix: Matrix, directionToUpdate: Vector3, particle: Particle): void;
  86679. /**
  86680. * Clones the current emitter and returns a copy of it
  86681. * @returns the new emitter
  86682. */
  86683. clone(): SphereDirectedParticleEmitter;
  86684. /**
  86685. * Called by the GPUParticleSystem to setup the update shader
  86686. * @param effect defines the update shader
  86687. */
  86688. applyToShader(effect: Effect): void;
  86689. /**
  86690. * Returns a string to use to update the GPU particles update shader
  86691. * @returns a string containng the defines string
  86692. */
  86693. getEffectDefines(): string;
  86694. /**
  86695. * Returns the string "SphereDirectedParticleEmitter"
  86696. * @returns a string containing the class name
  86697. */
  86698. getClassName(): string;
  86699. /**
  86700. * Serializes the particle system to a JSON object.
  86701. * @returns the JSON object
  86702. */
  86703. serialize(): any;
  86704. /**
  86705. * Parse properties from a JSON object
  86706. * @param serializationObject defines the JSON object
  86707. */
  86708. parse(serializationObject: any): void;
  86709. }
  86710. }
  86711. declare module BABYLON {
  86712. /**
  86713. * Interface representing a particle system in Babylon.js.
  86714. * This groups the common functionalities that needs to be implemented in order to create a particle system.
  86715. * A particle system represents a way to manage particles from their emission to their animation and rendering.
  86716. */
  86717. export interface IParticleSystem {
  86718. /**
  86719. * List of animations used by the particle system.
  86720. */
  86721. animations: Animation[];
  86722. /**
  86723. * The id of the Particle system.
  86724. */
  86725. id: string;
  86726. /**
  86727. * The name of the Particle system.
  86728. */
  86729. name: string;
  86730. /**
  86731. * The emitter represents the Mesh or position we are attaching the particle system to.
  86732. */
  86733. emitter: Nullable<AbstractMesh | Vector3>;
  86734. /**
  86735. * Gets or sets a boolean indicating if the particles must be rendered as billboard or aligned with the direction
  86736. */
  86737. isBillboardBased: boolean;
  86738. /**
  86739. * The rendering group used by the Particle system to chose when to render.
  86740. */
  86741. renderingGroupId: number;
  86742. /**
  86743. * The layer mask we are rendering the particles through.
  86744. */
  86745. layerMask: number;
  86746. /**
  86747. * The overall motion speed (0.01 is default update speed, faster updates = faster animation)
  86748. */
  86749. updateSpeed: number;
  86750. /**
  86751. * The amount of time the particle system is running (depends of the overall update speed).
  86752. */
  86753. targetStopDuration: number;
  86754. /**
  86755. * The texture used to render each particle. (this can be a spritesheet)
  86756. */
  86757. particleTexture: Nullable<Texture>;
  86758. /**
  86759. * Blend mode use to render the particle, it can be either ParticleSystem.BLENDMODE_ONEONE, ParticleSystem.BLENDMODE_STANDARD or ParticleSystem.BLENDMODE_ADD.
  86760. */
  86761. blendMode: number;
  86762. /**
  86763. * Minimum life time of emitting particles.
  86764. */
  86765. minLifeTime: number;
  86766. /**
  86767. * Maximum life time of emitting particles.
  86768. */
  86769. maxLifeTime: number;
  86770. /**
  86771. * Minimum Size of emitting particles.
  86772. */
  86773. minSize: number;
  86774. /**
  86775. * Maximum Size of emitting particles.
  86776. */
  86777. maxSize: number;
  86778. /**
  86779. * Minimum scale of emitting particles on X axis.
  86780. */
  86781. minScaleX: number;
  86782. /**
  86783. * Maximum scale of emitting particles on X axis.
  86784. */
  86785. maxScaleX: number;
  86786. /**
  86787. * Minimum scale of emitting particles on Y axis.
  86788. */
  86789. minScaleY: number;
  86790. /**
  86791. * Maximum scale of emitting particles on Y axis.
  86792. */
  86793. maxScaleY: number;
  86794. /**
  86795. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  86796. */
  86797. color1: Color4;
  86798. /**
  86799. * Random color of each particle after it has been emitted, between color1 and color2 vectors.
  86800. */
  86801. color2: Color4;
  86802. /**
  86803. * Color the particle will have at the end of its lifetime.
  86804. */
  86805. colorDead: Color4;
  86806. /**
  86807. * The maximum number of particles to emit per frame until we reach the activeParticleCount value
  86808. */
  86809. emitRate: number;
  86810. /**
  86811. * You can use gravity if you want to give an orientation to your particles.
  86812. */
  86813. gravity: Vector3;
  86814. /**
  86815. * Minimum power of emitting particles.
  86816. */
  86817. minEmitPower: number;
  86818. /**
  86819. * Maximum power of emitting particles.
  86820. */
  86821. maxEmitPower: number;
  86822. /**
  86823. * Minimum angular speed of emitting particles (Z-axis rotation for each particle).
  86824. */
  86825. minAngularSpeed: number;
  86826. /**
  86827. * Maximum angular speed of emitting particles (Z-axis rotation for each particle).
  86828. */
  86829. maxAngularSpeed: number;
  86830. /**
  86831. * Gets or sets the minimal initial rotation in radians.
  86832. */
  86833. minInitialRotation: number;
  86834. /**
  86835. * Gets or sets the maximal initial rotation in radians.
  86836. */
  86837. maxInitialRotation: number;
  86838. /**
  86839. * The particle emitter type defines the emitter used by the particle system.
  86840. * It can be for example box, sphere, or cone...
  86841. */
  86842. particleEmitterType: Nullable<IParticleEmitterType>;
  86843. /**
  86844. * Defines the delay in milliseconds before starting the system (0 by default)
  86845. */
  86846. startDelay: number;
  86847. /**
  86848. * 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
  86849. */
  86850. preWarmCycles: number;
  86851. /**
  86852. * Gets or sets a value indicating the time step multiplier to use in pre-warm mode (default is 1)
  86853. */
  86854. preWarmStepOffset: number;
  86855. /**
  86856. * 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)
  86857. */
  86858. spriteCellChangeSpeed: number;
  86859. /**
  86860. * If using a spritesheet (isAnimationSheetEnabled) defines the first sprite cell to display
  86861. */
  86862. startSpriteCellID: number;
  86863. /**
  86864. * If using a spritesheet (isAnimationSheetEnabled) defines the last sprite cell to display
  86865. */
  86866. endSpriteCellID: number;
  86867. /**
  86868. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell width to use
  86869. */
  86870. spriteCellWidth: number;
  86871. /**
  86872. * If using a spritesheet (isAnimationSheetEnabled), defines the sprite cell height to use
  86873. */
  86874. spriteCellHeight: number;
  86875. /**
  86876. * This allows the system to random pick the start cell ID between startSpriteCellID and endSpriteCellID
  86877. */
  86878. spriteRandomStartCell: boolean;
  86879. /**
  86880. * Gets or sets a boolean indicating if a spritesheet is used to animate the particles texture
  86881. */
  86882. isAnimationSheetEnabled: boolean;
  86883. /** Gets or sets a Vector2 used to move the pivot (by default (0,0)) */
  86884. translationPivot: Vector2;
  86885. /**
  86886. * Gets or sets a texture used to add random noise to particle positions
  86887. */
  86888. noiseTexture: Nullable<BaseTexture>;
  86889. /** Gets or sets the strength to apply to the noise value (default is (10, 10, 10)) */
  86890. noiseStrength: Vector3;
  86891. /**
  86892. * Gets or sets the billboard mode to use when isBillboardBased = true.
  86893. * Value can be: ParticleSystem.BILLBOARDMODE_ALL, ParticleSystem.BILLBOARDMODE_Y, ParticleSystem.BILLBOARDMODE_STRETCHED
  86894. */
  86895. billboardMode: number;
  86896. /** Gets or sets a value indicating the damping to apply if the limit velocity factor is reached */
  86897. limitVelocityDamping: number;
  86898. /**
  86899. * Gets or sets a boolean indicating that hosted animations (in the system.animations array) must be started when system.start() is called
  86900. */
  86901. beginAnimationOnStart: boolean;
  86902. /**
  86903. * Gets or sets the frame to start the animation from when beginAnimationOnStart is true
  86904. */
  86905. beginAnimationFrom: number;
  86906. /**
  86907. * Gets or sets the frame to end the animation on when beginAnimationOnStart is true
  86908. */
  86909. beginAnimationTo: number;
  86910. /**
  86911. * Gets or sets a boolean indicating if animations must loop when beginAnimationOnStart is true
  86912. */
  86913. beginAnimationLoop: boolean;
  86914. /**
  86915. * Specifies whether the particle system will be disposed once it reaches the end of the animation.
  86916. */
  86917. disposeOnStop: boolean;
  86918. /**
  86919. * Gets the maximum number of particles active at the same time.
  86920. * @returns The max number of active particles.
  86921. */
  86922. getCapacity(): number;
  86923. /**
  86924. * Gets if the system has been started. (Note: this will still be true after stop is called)
  86925. * @returns True if it has been started, otherwise false.
  86926. */
  86927. isStarted(): boolean;
  86928. /**
  86929. * Animates the particle system for this frame.
  86930. */
  86931. animate(): void;
  86932. /**
  86933. * Renders the particle system in its current state.
  86934. * @returns the current number of particles
  86935. */
  86936. render(): number;
  86937. /**
  86938. * Dispose the particle system and frees its associated resources.
  86939. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  86940. */
  86941. dispose(disposeTexture?: boolean): void;
  86942. /**
  86943. * Clones the particle system.
  86944. * @param name The name of the cloned object
  86945. * @param newEmitter The new emitter to use
  86946. * @returns the cloned particle system
  86947. */
  86948. clone(name: string, newEmitter: any): Nullable<IParticleSystem>;
  86949. /**
  86950. * Serializes the particle system to a JSON object.
  86951. * @returns the JSON object
  86952. */
  86953. serialize(): any;
  86954. /**
  86955. * Rebuild the particle system
  86956. */
  86957. rebuild(): void;
  86958. /**
  86959. * Starts the particle system and begins to emit
  86960. * @param delay defines the delay in milliseconds before starting the system (0 by default)
  86961. */
  86962. start(delay?: number): void;
  86963. /**
  86964. * Stops the particle system.
  86965. */
  86966. stop(): void;
  86967. /**
  86968. * Remove all active particles
  86969. */
  86970. reset(): void;
  86971. /**
  86972. * Is this system ready to be used/rendered
  86973. * @return true if the system is ready
  86974. */
  86975. isReady(): boolean;
  86976. /**
  86977. * Adds a new color gradient
  86978. * @param gradient defines the gradient to use (between 0 and 1)
  86979. * @param color1 defines the color to affect to the specified gradient
  86980. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  86981. * @returns the current particle system
  86982. */
  86983. addColorGradient(gradient: number, color1: Color4, color2?: Color4): IParticleSystem;
  86984. /**
  86985. * Remove a specific color gradient
  86986. * @param gradient defines the gradient to remove
  86987. * @returns the current particle system
  86988. */
  86989. removeColorGradient(gradient: number): IParticleSystem;
  86990. /**
  86991. * Adds a new size gradient
  86992. * @param gradient defines the gradient to use (between 0 and 1)
  86993. * @param factor defines the size factor to affect to the specified gradient
  86994. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  86995. * @returns the current particle system
  86996. */
  86997. addSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  86998. /**
  86999. * Remove a specific size gradient
  87000. * @param gradient defines the gradient to remove
  87001. * @returns the current particle system
  87002. */
  87003. removeSizeGradient(gradient: number): IParticleSystem;
  87004. /**
  87005. * Gets the current list of color gradients.
  87006. * You must use addColorGradient and removeColorGradient to udpate this list
  87007. * @returns the list of color gradients
  87008. */
  87009. getColorGradients(): Nullable<Array<ColorGradient>>;
  87010. /**
  87011. * Gets the current list of size gradients.
  87012. * You must use addSizeGradient and removeSizeGradient to udpate this list
  87013. * @returns the list of size gradients
  87014. */
  87015. getSizeGradients(): Nullable<Array<FactorGradient>>;
  87016. /**
  87017. * Gets the current list of angular speed gradients.
  87018. * You must use addAngularSpeedGradient and removeAngularSpeedGradient to udpate this list
  87019. * @returns the list of angular speed gradients
  87020. */
  87021. getAngularSpeedGradients(): Nullable<Array<FactorGradient>>;
  87022. /**
  87023. * Adds a new angular speed gradient
  87024. * @param gradient defines the gradient to use (between 0 and 1)
  87025. * @param factor defines the angular speed to affect to the specified gradient
  87026. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  87027. * @returns the current particle system
  87028. */
  87029. addAngularSpeedGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  87030. /**
  87031. * Remove a specific angular speed gradient
  87032. * @param gradient defines the gradient to remove
  87033. * @returns the current particle system
  87034. */
  87035. removeAngularSpeedGradient(gradient: number): IParticleSystem;
  87036. /**
  87037. * Gets the current list of velocity gradients.
  87038. * You must use addVelocityGradient and removeVelocityGradient to udpate this list
  87039. * @returns the list of velocity gradients
  87040. */
  87041. getVelocityGradients(): Nullable<Array<FactorGradient>>;
  87042. /**
  87043. * Adds a new velocity gradient
  87044. * @param gradient defines the gradient to use (between 0 and 1)
  87045. * @param factor defines the velocity to affect to the specified gradient
  87046. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  87047. * @returns the current particle system
  87048. */
  87049. addVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  87050. /**
  87051. * Remove a specific velocity gradient
  87052. * @param gradient defines the gradient to remove
  87053. * @returns the current particle system
  87054. */
  87055. removeVelocityGradient(gradient: number): IParticleSystem;
  87056. /**
  87057. * Gets the current list of limit velocity gradients.
  87058. * You must use addLimitVelocityGradient and removeLimitVelocityGradient to udpate this list
  87059. * @returns the list of limit velocity gradients
  87060. */
  87061. getLimitVelocityGradients(): Nullable<Array<FactorGradient>>;
  87062. /**
  87063. * Adds a new limit velocity gradient
  87064. * @param gradient defines the gradient to use (between 0 and 1)
  87065. * @param factor defines the limit velocity to affect to the specified gradient
  87066. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  87067. * @returns the current particle system
  87068. */
  87069. addLimitVelocityGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  87070. /**
  87071. * Remove a specific limit velocity gradient
  87072. * @param gradient defines the gradient to remove
  87073. * @returns the current particle system
  87074. */
  87075. removeLimitVelocityGradient(gradient: number): IParticleSystem;
  87076. /**
  87077. * Adds a new drag gradient
  87078. * @param gradient defines the gradient to use (between 0 and 1)
  87079. * @param factor defines the drag to affect to the specified gradient
  87080. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  87081. * @returns the current particle system
  87082. */
  87083. addDragGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  87084. /**
  87085. * Remove a specific drag gradient
  87086. * @param gradient defines the gradient to remove
  87087. * @returns the current particle system
  87088. */
  87089. removeDragGradient(gradient: number): IParticleSystem;
  87090. /**
  87091. * Gets the current list of drag gradients.
  87092. * You must use addDragGradient and removeDragGradient to udpate this list
  87093. * @returns the list of drag gradients
  87094. */
  87095. getDragGradients(): Nullable<Array<FactorGradient>>;
  87096. /**
  87097. * Adds a new emit rate gradient (please note that this will only work if you set the targetStopDuration property)
  87098. * @param gradient defines the gradient to use (between 0 and 1)
  87099. * @param factor defines the emit rate to affect to the specified gradient
  87100. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  87101. * @returns the current particle system
  87102. */
  87103. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  87104. /**
  87105. * Remove a specific emit rate gradient
  87106. * @param gradient defines the gradient to remove
  87107. * @returns the current particle system
  87108. */
  87109. removeEmitRateGradient(gradient: number): IParticleSystem;
  87110. /**
  87111. * Gets the current list of emit rate gradients.
  87112. * You must use addEmitRateGradient and removeEmitRateGradient to udpate this list
  87113. * @returns the list of emit rate gradients
  87114. */
  87115. getEmitRateGradients(): Nullable<Array<FactorGradient>>;
  87116. /**
  87117. * Adds a new start size gradient (please note that this will only work if you set the targetStopDuration property)
  87118. * @param gradient defines the gradient to use (between 0 and 1)
  87119. * @param factor defines the start size to affect to the specified gradient
  87120. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  87121. * @returns the current particle system
  87122. */
  87123. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  87124. /**
  87125. * Remove a specific start size gradient
  87126. * @param gradient defines the gradient to remove
  87127. * @returns the current particle system
  87128. */
  87129. removeStartSizeGradient(gradient: number): IParticleSystem;
  87130. /**
  87131. * Gets the current list of start size gradients.
  87132. * You must use addStartSizeGradient and removeStartSizeGradient to udpate this list
  87133. * @returns the list of start size gradients
  87134. */
  87135. getStartSizeGradients(): Nullable<Array<FactorGradient>>;
  87136. /**
  87137. * Adds a new life time gradient
  87138. * @param gradient defines the gradient to use (between 0 and 1)
  87139. * @param factor defines the life time factor to affect to the specified gradient
  87140. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  87141. * @returns the current particle system
  87142. */
  87143. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  87144. /**
  87145. * Remove a specific life time gradient
  87146. * @param gradient defines the gradient to remove
  87147. * @returns the current particle system
  87148. */
  87149. removeLifeTimeGradient(gradient: number): IParticleSystem;
  87150. /**
  87151. * Gets the current list of life time gradients.
  87152. * You must use addLifeTimeGradient and removeLifeTimeGradient to udpate this list
  87153. * @returns the list of life time gradients
  87154. */
  87155. getLifeTimeGradients(): Nullable<Array<FactorGradient>>;
  87156. /**
  87157. * Gets the current list of color gradients.
  87158. * You must use addColorGradient and removeColorGradient to udpate this list
  87159. * @returns the list of color gradients
  87160. */
  87161. getColorGradients(): Nullable<Array<ColorGradient>>;
  87162. /**
  87163. * Adds a new ramp gradient used to remap particle colors
  87164. * @param gradient defines the gradient to use (between 0 and 1)
  87165. * @param color defines the color to affect to the specified gradient
  87166. * @returns the current particle system
  87167. */
  87168. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  87169. /**
  87170. * Gets the current list of ramp gradients.
  87171. * You must use addRampGradient and removeRampGradient to udpate this list
  87172. * @returns the list of ramp gradients
  87173. */
  87174. getRampGradients(): Nullable<Array<Color3Gradient>>;
  87175. /** Gets or sets a boolean indicating that ramp gradients must be used
  87176. * @see http://doc.babylonjs.com/babylon101/particles#ramp-gradients
  87177. */
  87178. useRampGradients: boolean;
  87179. /**
  87180. * Adds a new color remap gradient
  87181. * @param gradient defines the gradient to use (between 0 and 1)
  87182. * @param min defines the color remap minimal range
  87183. * @param max defines the color remap maximal range
  87184. * @returns the current particle system
  87185. */
  87186. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  87187. /**
  87188. * Gets the current list of color remap gradients.
  87189. * You must use addColorRemapGradient and removeColorRemapGradient to udpate this list
  87190. * @returns the list of color remap gradients
  87191. */
  87192. getColorRemapGradients(): Nullable<Array<FactorGradient>>;
  87193. /**
  87194. * Adds a new alpha remap gradient
  87195. * @param gradient defines the gradient to use (between 0 and 1)
  87196. * @param min defines the alpha remap minimal range
  87197. * @param max defines the alpha remap maximal range
  87198. * @returns the current particle system
  87199. */
  87200. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  87201. /**
  87202. * Gets the current list of alpha remap gradients.
  87203. * You must use addAlphaRemapGradient and removeAlphaRemapGradient to udpate this list
  87204. * @returns the list of alpha remap gradients
  87205. */
  87206. getAlphaRemapGradients(): Nullable<Array<FactorGradient>>;
  87207. /**
  87208. * Creates a Point Emitter for the particle system (emits directly from the emitter position)
  87209. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  87210. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  87211. * @returns the emitter
  87212. */
  87213. createPointEmitter(direction1: Vector3, direction2: Vector3): PointParticleEmitter;
  87214. /**
  87215. * Creates a Hemisphere Emitter for the particle system (emits along the hemisphere radius)
  87216. * @param radius The radius of the hemisphere to emit from
  87217. * @param radiusRange The range of the hemisphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  87218. * @returns the emitter
  87219. */
  87220. createHemisphericEmitter(radius: number, radiusRange: number): HemisphericParticleEmitter;
  87221. /**
  87222. * Creates a Sphere Emitter for the particle system (emits along the sphere radius)
  87223. * @param radius The radius of the sphere to emit from
  87224. * @param radiusRange The range of the sphere to emit from [0-1] 0 Surface Only, 1 Entire Radius
  87225. * @returns the emitter
  87226. */
  87227. createSphereEmitter(radius: number, radiusRange: number): SphereParticleEmitter;
  87228. /**
  87229. * Creates a Directed Sphere Emitter for the particle system (emits between direction1 and direction2)
  87230. * @param radius The radius of the sphere to emit from
  87231. * @param direction1 Particles are emitted between the direction1 and direction2 from within the sphere
  87232. * @param direction2 Particles are emitted between the direction1 and direction2 from within the sphere
  87233. * @returns the emitter
  87234. */
  87235. createDirectedSphereEmitter(radius: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  87236. /**
  87237. * Creates a Cylinder Emitter for the particle system (emits from the cylinder to the particle position)
  87238. * @param radius The radius of the emission cylinder
  87239. * @param height The height of the emission cylinder
  87240. * @param radiusRange The range of emission [0-1] 0 Surface only, 1 Entire Radius
  87241. * @param directionRandomizer How much to randomize the particle direction [0-1]
  87242. * @returns the emitter
  87243. */
  87244. createCylinderEmitter(radius: number, height: number, radiusRange: number, directionRandomizer: number): CylinderParticleEmitter;
  87245. /**
  87246. * Creates a Directed Cylinder Emitter for the particle system (emits between direction1 and direction2)
  87247. * @param radius The radius of the cylinder to emit from
  87248. * @param height The height of the emission cylinder
  87249. * @param radiusRange the range of the emission cylinder [0-1] 0 Surface only, 1 Entire Radius (1 by default)
  87250. * @param direction1 Particles are emitted between the direction1 and direction2 from within the cylinder
  87251. * @param direction2 Particles are emitted between the direction1 and direction2 from within the cylinder
  87252. * @returns the emitter
  87253. */
  87254. createDirectedCylinderEmitter(radius: number, height: number, radiusRange: number, direction1: Vector3, direction2: Vector3): SphereDirectedParticleEmitter;
  87255. /**
  87256. * Creates a Cone Emitter for the particle system (emits from the cone to the particle position)
  87257. * @param radius The radius of the cone to emit from
  87258. * @param angle The base angle of the cone
  87259. * @returns the emitter
  87260. */
  87261. createConeEmitter(radius: number, angle: number): ConeParticleEmitter;
  87262. /**
  87263. * Creates a Box Emitter for the particle system. (emits between direction1 and direction2 from withing the box defined by minEmitBox and maxEmitBox)
  87264. * @param direction1 Particles are emitted between the direction1 and direction2 from within the box
  87265. * @param direction2 Particles are emitted between the direction1 and direction2 from within the box
  87266. * @param minEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  87267. * @param maxEmitBox Particles are emitted from the box between minEmitBox and maxEmitBox
  87268. * @returns the emitter
  87269. */
  87270. createBoxEmitter(direction1: Vector3, direction2: Vector3, minEmitBox: Vector3, maxEmitBox: Vector3): BoxParticleEmitter;
  87271. /**
  87272. * Get hosting scene
  87273. * @returns the scene
  87274. */
  87275. getScene(): Scene;
  87276. }
  87277. }
  87278. declare module BABYLON {
  87279. /**
  87280. * Creates an instance based on a source mesh.
  87281. */
  87282. export class InstancedMesh extends AbstractMesh {
  87283. private _sourceMesh;
  87284. private _currentLOD;
  87285. /** @hidden */
  87286. _indexInSourceMeshInstanceArray: number;
  87287. constructor(name: string, source: Mesh);
  87288. /**
  87289. * Returns the string "InstancedMesh".
  87290. */
  87291. getClassName(): string;
  87292. /** Gets the list of lights affecting that mesh */
  87293. readonly lightSources: Light[];
  87294. _resyncLightSources(): void;
  87295. _resyncLighSource(light: Light): void;
  87296. _removeLightSource(light: Light, dispose: boolean): void;
  87297. /**
  87298. * If the source mesh receives shadows
  87299. */
  87300. readonly receiveShadows: boolean;
  87301. /**
  87302. * The material of the source mesh
  87303. */
  87304. readonly material: Nullable<Material>;
  87305. /**
  87306. * Visibility of the source mesh
  87307. */
  87308. readonly visibility: number;
  87309. /**
  87310. * Skeleton of the source mesh
  87311. */
  87312. readonly skeleton: Nullable<Skeleton>;
  87313. /**
  87314. * Rendering ground id of the source mesh
  87315. */
  87316. renderingGroupId: number;
  87317. /**
  87318. * Returns the total number of vertices (integer).
  87319. */
  87320. getTotalVertices(): number;
  87321. /**
  87322. * Returns a positive integer : the total number of indices in this mesh geometry.
  87323. * @returns the numner of indices or zero if the mesh has no geometry.
  87324. */
  87325. getTotalIndices(): number;
  87326. /**
  87327. * The source mesh of the instance
  87328. */
  87329. readonly sourceMesh: Mesh;
  87330. /**
  87331. * Is this node ready to be used/rendered
  87332. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  87333. * @return {boolean} is it ready
  87334. */
  87335. isReady(completeCheck?: boolean): boolean;
  87336. /**
  87337. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  87338. * @param kind kind of verticies to retreive (eg. positons, normals, uvs, etc.)
  87339. * @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.
  87340. * @returns a float array or a Float32Array of the requested kind of data : positons, normals, uvs, etc.
  87341. */
  87342. getVerticesData(kind: string, copyWhenShared?: boolean): Nullable<FloatArray>;
  87343. /**
  87344. * Sets the vertex data of the mesh geometry for the requested `kind`.
  87345. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  87346. * The `data` are either a numeric array either a Float32Array.
  87347. * The parameter `updatable` is passed as is to the underlying Geometry object constructor (if initianilly none) or updater.
  87348. * 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).
  87349. * Note that a new underlying VertexBuffer object is created each call.
  87350. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  87351. *
  87352. * Possible `kind` values :
  87353. * - VertexBuffer.PositionKind
  87354. * - VertexBuffer.UVKind
  87355. * - VertexBuffer.UV2Kind
  87356. * - VertexBuffer.UV3Kind
  87357. * - VertexBuffer.UV4Kind
  87358. * - VertexBuffer.UV5Kind
  87359. * - VertexBuffer.UV6Kind
  87360. * - VertexBuffer.ColorKind
  87361. * - VertexBuffer.MatricesIndicesKind
  87362. * - VertexBuffer.MatricesIndicesExtraKind
  87363. * - VertexBuffer.MatricesWeightsKind
  87364. * - VertexBuffer.MatricesWeightsExtraKind
  87365. *
  87366. * Returns the Mesh.
  87367. */
  87368. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  87369. /**
  87370. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  87371. * If the mesh has no geometry, it is simply returned as it is.
  87372. * The `data` are either a numeric array either a Float32Array.
  87373. * No new underlying VertexBuffer object is created.
  87374. * 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.
  87375. * If the parameter `makeItUnique` is true, a new global geometry is created from this positions and is set to the mesh.
  87376. *
  87377. * Possible `kind` values :
  87378. * - VertexBuffer.PositionKind
  87379. * - VertexBuffer.UVKind
  87380. * - VertexBuffer.UV2Kind
  87381. * - VertexBuffer.UV3Kind
  87382. * - VertexBuffer.UV4Kind
  87383. * - VertexBuffer.UV5Kind
  87384. * - VertexBuffer.UV6Kind
  87385. * - VertexBuffer.ColorKind
  87386. * - VertexBuffer.MatricesIndicesKind
  87387. * - VertexBuffer.MatricesIndicesExtraKind
  87388. * - VertexBuffer.MatricesWeightsKind
  87389. * - VertexBuffer.MatricesWeightsExtraKind
  87390. *
  87391. * Returns the Mesh.
  87392. */
  87393. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): Mesh;
  87394. /**
  87395. * Sets the mesh indices.
  87396. * Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array).
  87397. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  87398. * This method creates a new index buffer each call.
  87399. * Returns the Mesh.
  87400. */
  87401. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>): Mesh;
  87402. /**
  87403. * Boolean : True if the mesh owns the requested kind of data.
  87404. */
  87405. isVerticesDataPresent(kind: string): boolean;
  87406. /**
  87407. * Returns an array of indices (IndicesArray).
  87408. */
  87409. getIndices(): Nullable<IndicesArray>;
  87410. readonly _positions: Nullable<Vector3[]>;
  87411. /**
  87412. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  87413. * This means the mesh underlying bounding box and sphere are recomputed.
  87414. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  87415. * @returns the current mesh
  87416. */
  87417. refreshBoundingInfo(applySkeleton?: boolean): InstancedMesh;
  87418. /** @hidden */
  87419. _preActivate(): InstancedMesh;
  87420. /** @hidden */
  87421. _activate(renderId: number, intermediateRendering: boolean): boolean;
  87422. /** @hidden */
  87423. _postActivate(): void;
  87424. getWorldMatrix(): Matrix;
  87425. readonly isAnInstance: boolean;
  87426. /**
  87427. * Returns the current associated LOD AbstractMesh.
  87428. */
  87429. getLOD(camera: Camera): AbstractMesh;
  87430. /** @hidden */
  87431. _syncSubMeshes(): InstancedMesh;
  87432. /** @hidden */
  87433. _generatePointsArray(): boolean;
  87434. /**
  87435. * Creates a new InstancedMesh from the current mesh.
  87436. * - name (string) : the cloned mesh name
  87437. * - newParent (optional Node) : the optional Node to parent the clone to.
  87438. * - doNotCloneChildren (optional boolean, default `false`) : if `true` the model children aren't cloned.
  87439. *
  87440. * Returns the clone.
  87441. */
  87442. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  87443. /**
  87444. * Disposes the InstancedMesh.
  87445. * Returns nothing.
  87446. */
  87447. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  87448. }
  87449. interface Mesh {
  87450. /**
  87451. * Register a custom buffer that will be instanced
  87452. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  87453. * @param kind defines the buffer kind
  87454. * @param stride defines the stride in floats
  87455. */
  87456. registerInstancedBuffer(kind: string, stride: number): void;
  87457. /** @hidden */
  87458. _userInstancedBuffersStorage: {
  87459. data: {
  87460. [key: string]: Float32Array;
  87461. };
  87462. sizes: {
  87463. [key: string]: number;
  87464. };
  87465. vertexBuffers: {
  87466. [key: string]: Nullable<VertexBuffer>;
  87467. };
  87468. strides: {
  87469. [key: string]: number;
  87470. };
  87471. };
  87472. }
  87473. interface AbstractMesh {
  87474. /**
  87475. * Object used to store instanced buffers defined by user
  87476. * @see https://doc.babylonjs.com/how_to/how_to_use_instances#custom-buffers
  87477. */
  87478. instancedBuffers: {
  87479. [key: string]: any;
  87480. };
  87481. }
  87482. }
  87483. declare module BABYLON {
  87484. /**
  87485. * Defines the options associated with the creation of a shader material.
  87486. */
  87487. export interface IShaderMaterialOptions {
  87488. /**
  87489. * Does the material work in alpha blend mode
  87490. */
  87491. needAlphaBlending: boolean;
  87492. /**
  87493. * Does the material work in alpha test mode
  87494. */
  87495. needAlphaTesting: boolean;
  87496. /**
  87497. * The list of attribute names used in the shader
  87498. */
  87499. attributes: string[];
  87500. /**
  87501. * The list of unifrom names used in the shader
  87502. */
  87503. uniforms: string[];
  87504. /**
  87505. * The list of UBO names used in the shader
  87506. */
  87507. uniformBuffers: string[];
  87508. /**
  87509. * The list of sampler names used in the shader
  87510. */
  87511. samplers: string[];
  87512. /**
  87513. * The list of defines used in the shader
  87514. */
  87515. defines: string[];
  87516. }
  87517. /**
  87518. * 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.
  87519. *
  87520. * This returned material effects how the mesh will look based on the code in the shaders.
  87521. *
  87522. * @see http://doc.babylonjs.com/how_to/shader_material
  87523. */
  87524. export class ShaderMaterial extends Material {
  87525. private _shaderPath;
  87526. private _options;
  87527. private _textures;
  87528. private _textureArrays;
  87529. private _floats;
  87530. private _ints;
  87531. private _floatsArrays;
  87532. private _colors3;
  87533. private _colors3Arrays;
  87534. private _colors4;
  87535. private _colors4Arrays;
  87536. private _vectors2;
  87537. private _vectors3;
  87538. private _vectors4;
  87539. private _matrices;
  87540. private _matrixArrays;
  87541. private _matrices3x3;
  87542. private _matrices2x2;
  87543. private _vectors2Arrays;
  87544. private _vectors3Arrays;
  87545. private _vectors4Arrays;
  87546. private _cachedWorldViewMatrix;
  87547. private _cachedWorldViewProjectionMatrix;
  87548. private _renderId;
  87549. private _multiview;
  87550. /**
  87551. * Instantiate a new shader material.
  87552. * 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.
  87553. * This returned material effects how the mesh will look based on the code in the shaders.
  87554. * @see http://doc.babylonjs.com/how_to/shader_material
  87555. * @param name Define the name of the material in the scene
  87556. * @param scene Define the scene the material belongs to
  87557. * @param shaderPath Defines the route to the shader code in one of three ways:
  87558. * * object: { vertex: "custom", fragment: "custom" }, used with Effect.ShadersStore["customVertexShader"] and Effect.ShadersStore["customFragmentShader"]
  87559. * * object: { vertexElement: "vertexShaderCode", fragmentElement: "fragmentShaderCode" }, used with shader code in script tags
  87560. * * object: { vertexSource: "vertex shader code string", fragmentSource: "fragment shader code string" } using with strings containing the shaders code
  87561. * * string: "./COMMON_NAME", used with external files COMMON_NAME.vertex.fx and COMMON_NAME.fragment.fx in index.html folder.
  87562. * @param options Define the options used to create the shader
  87563. */
  87564. constructor(name: string, scene: Scene, shaderPath: any, options?: Partial<IShaderMaterialOptions>);
  87565. /**
  87566. * Gets the shader path used to define the shader code
  87567. * It can be modified to trigger a new compilation
  87568. */
  87569. /**
  87570. * Sets the shader path used to define the shader code
  87571. * It can be modified to trigger a new compilation
  87572. */
  87573. shaderPath: any;
  87574. /**
  87575. * Gets the options used to compile the shader.
  87576. * They can be modified to trigger a new compilation
  87577. */
  87578. readonly options: IShaderMaterialOptions;
  87579. /**
  87580. * Gets the current class name of the material e.g. "ShaderMaterial"
  87581. * Mainly use in serialization.
  87582. * @returns the class name
  87583. */
  87584. getClassName(): string;
  87585. /**
  87586. * Specifies if the material will require alpha blending
  87587. * @returns a boolean specifying if alpha blending is needed
  87588. */
  87589. needAlphaBlending(): boolean;
  87590. /**
  87591. * Specifies if this material should be rendered in alpha test mode
  87592. * @returns a boolean specifying if an alpha test is needed.
  87593. */
  87594. needAlphaTesting(): boolean;
  87595. private _checkUniform;
  87596. /**
  87597. * Set a texture in the shader.
  87598. * @param name Define the name of the uniform samplers as defined in the shader
  87599. * @param texture Define the texture to bind to this sampler
  87600. * @return the material itself allowing "fluent" like uniform updates
  87601. */
  87602. setTexture(name: string, texture: Texture): ShaderMaterial;
  87603. /**
  87604. * Set a texture array in the shader.
  87605. * @param name Define the name of the uniform sampler array as defined in the shader
  87606. * @param textures Define the list of textures to bind to this sampler
  87607. * @return the material itself allowing "fluent" like uniform updates
  87608. */
  87609. setTextureArray(name: string, textures: Texture[]): ShaderMaterial;
  87610. /**
  87611. * Set a float in the shader.
  87612. * @param name Define the name of the uniform as defined in the shader
  87613. * @param value Define the value to give to the uniform
  87614. * @return the material itself allowing "fluent" like uniform updates
  87615. */
  87616. setFloat(name: string, value: number): ShaderMaterial;
  87617. /**
  87618. * Set a int in the shader.
  87619. * @param name Define the name of the uniform as defined in the shader
  87620. * @param value Define the value to give to the uniform
  87621. * @return the material itself allowing "fluent" like uniform updates
  87622. */
  87623. setInt(name: string, value: number): ShaderMaterial;
  87624. /**
  87625. * Set an array of floats in the shader.
  87626. * @param name Define the name of the uniform as defined in the shader
  87627. * @param value Define the value to give to the uniform
  87628. * @return the material itself allowing "fluent" like uniform updates
  87629. */
  87630. setFloats(name: string, value: number[]): ShaderMaterial;
  87631. /**
  87632. * Set a vec3 in the shader from a Color3.
  87633. * @param name Define the name of the uniform as defined in the shader
  87634. * @param value Define the value to give to the uniform
  87635. * @return the material itself allowing "fluent" like uniform updates
  87636. */
  87637. setColor3(name: string, value: Color3): ShaderMaterial;
  87638. /**
  87639. * Set a vec3 array in the shader from a Color3 array.
  87640. * @param name Define the name of the uniform as defined in the shader
  87641. * @param value Define the value to give to the uniform
  87642. * @return the material itself allowing "fluent" like uniform updates
  87643. */
  87644. setColor3Array(name: string, value: Color3[]): ShaderMaterial;
  87645. /**
  87646. * Set a vec4 in the shader from a Color4.
  87647. * @param name Define the name of the uniform as defined in the shader
  87648. * @param value Define the value to give to the uniform
  87649. * @return the material itself allowing "fluent" like uniform updates
  87650. */
  87651. setColor4(name: string, value: Color4): ShaderMaterial;
  87652. /**
  87653. * Set a vec4 array in the shader from a Color4 array.
  87654. * @param name Define the name of the uniform as defined in the shader
  87655. * @param value Define the value to give to the uniform
  87656. * @return the material itself allowing "fluent" like uniform updates
  87657. */
  87658. setColor4Array(name: string, value: Color4[]): ShaderMaterial;
  87659. /**
  87660. * Set a vec2 in the shader from a Vector2.
  87661. * @param name Define the name of the uniform as defined in the shader
  87662. * @param value Define the value to give to the uniform
  87663. * @return the material itself allowing "fluent" like uniform updates
  87664. */
  87665. setVector2(name: string, value: Vector2): ShaderMaterial;
  87666. /**
  87667. * Set a vec3 in the shader from a Vector3.
  87668. * @param name Define the name of the uniform as defined in the shader
  87669. * @param value Define the value to give to the uniform
  87670. * @return the material itself allowing "fluent" like uniform updates
  87671. */
  87672. setVector3(name: string, value: Vector3): ShaderMaterial;
  87673. /**
  87674. * Set a vec4 in the shader from a Vector4.
  87675. * @param name Define the name of the uniform as defined in the shader
  87676. * @param value Define the value to give to the uniform
  87677. * @return the material itself allowing "fluent" like uniform updates
  87678. */
  87679. setVector4(name: string, value: Vector4): ShaderMaterial;
  87680. /**
  87681. * Set a mat4 in the shader from a Matrix.
  87682. * @param name Define the name of the uniform as defined in the shader
  87683. * @param value Define the value to give to the uniform
  87684. * @return the material itself allowing "fluent" like uniform updates
  87685. */
  87686. setMatrix(name: string, value: Matrix): ShaderMaterial;
  87687. /**
  87688. * Set a float32Array in the shader from a matrix array.
  87689. * @param name Define the name of the uniform as defined in the shader
  87690. * @param value Define the value to give to the uniform
  87691. * @return the material itself allowing "fluent" like uniform updates
  87692. */
  87693. setMatrices(name: string, value: Matrix[]): ShaderMaterial;
  87694. /**
  87695. * Set a mat3 in the shader from a Float32Array.
  87696. * @param name Define the name of the uniform as defined in the shader
  87697. * @param value Define the value to give to the uniform
  87698. * @return the material itself allowing "fluent" like uniform updates
  87699. */
  87700. setMatrix3x3(name: string, value: Float32Array): ShaderMaterial;
  87701. /**
  87702. * Set a mat2 in the shader from a Float32Array.
  87703. * @param name Define the name of the uniform as defined in the shader
  87704. * @param value Define the value to give to the uniform
  87705. * @return the material itself allowing "fluent" like uniform updates
  87706. */
  87707. setMatrix2x2(name: string, value: Float32Array): ShaderMaterial;
  87708. /**
  87709. * Set a vec2 array in the shader from a number array.
  87710. * @param name Define the name of the uniform as defined in the shader
  87711. * @param value Define the value to give to the uniform
  87712. * @return the material itself allowing "fluent" like uniform updates
  87713. */
  87714. setArray2(name: string, value: number[]): ShaderMaterial;
  87715. /**
  87716. * Set a vec3 array in the shader from a number array.
  87717. * @param name Define the name of the uniform as defined in the shader
  87718. * @param value Define the value to give to the uniform
  87719. * @return the material itself allowing "fluent" like uniform updates
  87720. */
  87721. setArray3(name: string, value: number[]): ShaderMaterial;
  87722. /**
  87723. * Set a vec4 array in the shader from a number array.
  87724. * @param name Define the name of the uniform as defined in the shader
  87725. * @param value Define the value to give to the uniform
  87726. * @return the material itself allowing "fluent" like uniform updates
  87727. */
  87728. setArray4(name: string, value: number[]): ShaderMaterial;
  87729. private _checkCache;
  87730. /**
  87731. * Specifies that the submesh is ready to be used
  87732. * @param mesh defines the mesh to check
  87733. * @param subMesh defines which submesh to check
  87734. * @param useInstances specifies that instances should be used
  87735. * @returns a boolean indicating that the submesh is ready or not
  87736. */
  87737. isReadyForSubMesh(mesh: AbstractMesh, subMesh: BaseSubMesh, useInstances?: boolean): boolean;
  87738. /**
  87739. * Checks if the material is ready to render the requested mesh
  87740. * @param mesh Define the mesh to render
  87741. * @param useInstances Define whether or not the material is used with instances
  87742. * @returns true if ready, otherwise false
  87743. */
  87744. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  87745. /**
  87746. * Binds the world matrix to the material
  87747. * @param world defines the world transformation matrix
  87748. */
  87749. bindOnlyWorldMatrix(world: Matrix): void;
  87750. /**
  87751. * Binds the material to the mesh
  87752. * @param world defines the world transformation matrix
  87753. * @param mesh defines the mesh to bind the material to
  87754. */
  87755. bind(world: Matrix, mesh?: Mesh): void;
  87756. /**
  87757. * Gets the active textures from the material
  87758. * @returns an array of textures
  87759. */
  87760. getActiveTextures(): BaseTexture[];
  87761. /**
  87762. * Specifies if the material uses a texture
  87763. * @param texture defines the texture to check against the material
  87764. * @returns a boolean specifying if the material uses the texture
  87765. */
  87766. hasTexture(texture: BaseTexture): boolean;
  87767. /**
  87768. * Makes a duplicate of the material, and gives it a new name
  87769. * @param name defines the new name for the duplicated material
  87770. * @returns the cloned material
  87771. */
  87772. clone(name: string): ShaderMaterial;
  87773. /**
  87774. * Disposes the material
  87775. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  87776. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  87777. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  87778. */
  87779. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  87780. /**
  87781. * Serializes this material in a JSON representation
  87782. * @returns the serialized material object
  87783. */
  87784. serialize(): any;
  87785. /**
  87786. * Creates a shader material from parsed shader material data
  87787. * @param source defines the JSON represnetation of the material
  87788. * @param scene defines the hosting scene
  87789. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  87790. * @returns a new material
  87791. */
  87792. static Parse(source: any, scene: Scene, rootUrl: string): ShaderMaterial;
  87793. }
  87794. }
  87795. declare module BABYLON {
  87796. /** @hidden */
  87797. export var colorPixelShader: {
  87798. name: string;
  87799. shader: string;
  87800. };
  87801. }
  87802. declare module BABYLON {
  87803. /** @hidden */
  87804. export var colorVertexShader: {
  87805. name: string;
  87806. shader: string;
  87807. };
  87808. }
  87809. declare module BABYLON {
  87810. /**
  87811. * Line mesh
  87812. * @see https://doc.babylonjs.com/babylon101/parametric_shapes
  87813. */
  87814. export class LinesMesh extends Mesh {
  87815. /**
  87816. * If vertex color should be applied to the mesh
  87817. */
  87818. readonly useVertexColor?: boolean | undefined;
  87819. /**
  87820. * If vertex alpha should be applied to the mesh
  87821. */
  87822. readonly useVertexAlpha?: boolean | undefined;
  87823. /**
  87824. * Color of the line (Default: White)
  87825. */
  87826. color: Color3;
  87827. /**
  87828. * Alpha of the line (Default: 1)
  87829. */
  87830. alpha: number;
  87831. /**
  87832. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  87833. * This margin is expressed in world space coordinates, so its value may vary.
  87834. * Default value is 0.1
  87835. */
  87836. intersectionThreshold: number;
  87837. private _colorShader;
  87838. private color4;
  87839. /**
  87840. * Creates a new LinesMesh
  87841. * @param name defines the name
  87842. * @param scene defines the hosting scene
  87843. * @param parent defines the parent mesh if any
  87844. * @param source defines the optional source LinesMesh used to clone data from
  87845. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  87846. * When false, achieved by calling a clone(), also passing False.
  87847. * This will make creation of children, recursive.
  87848. * @param useVertexColor defines if this LinesMesh supports vertex color
  87849. * @param useVertexAlpha defines if this LinesMesh supports vertex alpha
  87850. */
  87851. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<LinesMesh>, doNotCloneChildren?: boolean,
  87852. /**
  87853. * If vertex color should be applied to the mesh
  87854. */
  87855. useVertexColor?: boolean | undefined,
  87856. /**
  87857. * If vertex alpha should be applied to the mesh
  87858. */
  87859. useVertexAlpha?: boolean | undefined);
  87860. private _addClipPlaneDefine;
  87861. private _removeClipPlaneDefine;
  87862. isReady(): boolean;
  87863. /**
  87864. * Returns the string "LineMesh"
  87865. */
  87866. getClassName(): string;
  87867. /**
  87868. * @hidden
  87869. */
  87870. /**
  87871. * @hidden
  87872. */
  87873. material: Material;
  87874. /**
  87875. * @hidden
  87876. */
  87877. readonly checkCollisions: boolean;
  87878. /** @hidden */
  87879. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  87880. /** @hidden */
  87881. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  87882. /**
  87883. * Disposes of the line mesh
  87884. * @param doNotRecurse If children should be disposed
  87885. */
  87886. dispose(doNotRecurse?: boolean): void;
  87887. /**
  87888. * Returns a new LineMesh object cloned from the current one.
  87889. */
  87890. clone(name: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  87891. /**
  87892. * Creates a new InstancedLinesMesh object from the mesh model.
  87893. * @see http://doc.babylonjs.com/how_to/how_to_use_instances
  87894. * @param name defines the name of the new instance
  87895. * @returns a new InstancedLinesMesh
  87896. */
  87897. createInstance(name: string): InstancedLinesMesh;
  87898. }
  87899. /**
  87900. * Creates an instance based on a source LinesMesh
  87901. */
  87902. export class InstancedLinesMesh extends InstancedMesh {
  87903. /**
  87904. * The intersection Threshold is the margin applied when intersection a segment of the LinesMesh with a Ray.
  87905. * This margin is expressed in world space coordinates, so its value may vary.
  87906. * Initilized with the intersectionThreshold value of the source LinesMesh
  87907. */
  87908. intersectionThreshold: number;
  87909. constructor(name: string, source: LinesMesh);
  87910. /**
  87911. * Returns the string "InstancedLinesMesh".
  87912. */
  87913. getClassName(): string;
  87914. }
  87915. }
  87916. declare module BABYLON {
  87917. /** @hidden */
  87918. export var linePixelShader: {
  87919. name: string;
  87920. shader: string;
  87921. };
  87922. }
  87923. declare module BABYLON {
  87924. /** @hidden */
  87925. export var lineVertexShader: {
  87926. name: string;
  87927. shader: string;
  87928. };
  87929. }
  87930. declare module BABYLON {
  87931. interface AbstractMesh {
  87932. /**
  87933. * Gets the edgesRenderer associated with the mesh
  87934. */
  87935. edgesRenderer: Nullable<EdgesRenderer>;
  87936. }
  87937. interface LinesMesh {
  87938. /**
  87939. * Enables the edge rendering mode on the mesh.
  87940. * This mode makes the mesh edges visible
  87941. * @param epsilon defines the maximal distance between two angles to detect a face
  87942. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  87943. * @returns the currentAbstractMesh
  87944. * @see https://www.babylonjs-playground.com/#19O9TU#0
  87945. */
  87946. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  87947. }
  87948. interface InstancedLinesMesh {
  87949. /**
  87950. * Enables the edge rendering mode on the mesh.
  87951. * This mode makes the mesh edges visible
  87952. * @param epsilon defines the maximal distance between two angles to detect a face
  87953. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  87954. * @returns the current InstancedLinesMesh
  87955. * @see https://www.babylonjs-playground.com/#19O9TU#0
  87956. */
  87957. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): InstancedLinesMesh;
  87958. }
  87959. /**
  87960. * Defines the minimum contract an Edges renderer should follow.
  87961. */
  87962. export interface IEdgesRenderer extends IDisposable {
  87963. /**
  87964. * Gets or sets a boolean indicating if the edgesRenderer is active
  87965. */
  87966. isEnabled: boolean;
  87967. /**
  87968. * Renders the edges of the attached mesh,
  87969. */
  87970. render(): void;
  87971. /**
  87972. * Checks wether or not the edges renderer is ready to render.
  87973. * @return true if ready, otherwise false.
  87974. */
  87975. isReady(): boolean;
  87976. }
  87977. /**
  87978. * This class is used to generate edges of the mesh that could then easily be rendered in a scene.
  87979. */
  87980. export class EdgesRenderer implements IEdgesRenderer {
  87981. /**
  87982. * Define the size of the edges with an orthographic camera
  87983. */
  87984. edgesWidthScalerForOrthographic: number;
  87985. /**
  87986. * Define the size of the edges with a perspective camera
  87987. */
  87988. edgesWidthScalerForPerspective: number;
  87989. protected _source: AbstractMesh;
  87990. protected _linesPositions: number[];
  87991. protected _linesNormals: number[];
  87992. protected _linesIndices: number[];
  87993. protected _epsilon: number;
  87994. protected _indicesCount: number;
  87995. protected _lineShader: ShaderMaterial;
  87996. protected _ib: DataBuffer;
  87997. protected _buffers: {
  87998. [key: string]: Nullable<VertexBuffer>;
  87999. };
  88000. protected _checkVerticesInsteadOfIndices: boolean;
  88001. private _meshRebuildObserver;
  88002. private _meshDisposeObserver;
  88003. /** Gets or sets a boolean indicating if the edgesRenderer is active */
  88004. isEnabled: boolean;
  88005. /**
  88006. * Creates an instance of the EdgesRenderer. It is primarily use to display edges of a mesh.
  88007. * Beware when you use this class with complex objects as the adjacencies computation can be really long
  88008. * @param source Mesh used to create edges
  88009. * @param epsilon sum of angles in adjacency to check for edge
  88010. * @param checkVerticesInsteadOfIndices bases the edges detection on vertices vs indices
  88011. * @param generateEdgesLines - should generate Lines or only prepare resources.
  88012. */
  88013. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean, generateEdgesLines?: boolean);
  88014. protected _prepareRessources(): void;
  88015. /** @hidden */
  88016. _rebuild(): void;
  88017. /**
  88018. * Releases the required resources for the edges renderer
  88019. */
  88020. dispose(): void;
  88021. protected _processEdgeForAdjacencies(pa: number, pb: number, p0: number, p1: number, p2: number): number;
  88022. protected _processEdgeForAdjacenciesWithVertices(pa: Vector3, pb: Vector3, p0: Vector3, p1: Vector3, p2: Vector3): number;
  88023. /**
  88024. * Checks if the pair of p0 and p1 is en edge
  88025. * @param faceIndex
  88026. * @param edge
  88027. * @param faceNormals
  88028. * @param p0
  88029. * @param p1
  88030. * @private
  88031. */
  88032. protected _checkEdge(faceIndex: number, edge: number, faceNormals: Array<Vector3>, p0: Vector3, p1: Vector3): void;
  88033. /**
  88034. * push line into the position, normal and index buffer
  88035. * @protected
  88036. */
  88037. protected createLine(p0: Vector3, p1: Vector3, offset: number): void;
  88038. /**
  88039. * Generates lines edges from adjacencjes
  88040. * @private
  88041. */
  88042. _generateEdgesLines(): void;
  88043. /**
  88044. * Checks wether or not the edges renderer is ready to render.
  88045. * @return true if ready, otherwise false.
  88046. */
  88047. isReady(): boolean;
  88048. /**
  88049. * Renders the edges of the attached mesh,
  88050. */
  88051. render(): void;
  88052. }
  88053. /**
  88054. * LineEdgesRenderer for LineMeshes to remove unnecessary triangulation
  88055. */
  88056. export class LineEdgesRenderer extends EdgesRenderer {
  88057. /**
  88058. * This constructor turns off auto generating edges line in Edges Renderer to make it here.
  88059. * @param source LineMesh used to generate edges
  88060. * @param epsilon not important (specified angle for edge detection)
  88061. * @param checkVerticesInsteadOfIndices not important for LineMesh
  88062. */
  88063. constructor(source: AbstractMesh, epsilon?: number, checkVerticesInsteadOfIndices?: boolean);
  88064. /**
  88065. * Generate edges for each line in LinesMesh. Every Line should be rendered as edge.
  88066. */
  88067. _generateEdgesLines(): void;
  88068. }
  88069. }
  88070. declare module BABYLON {
  88071. /**
  88072. * This represents the object necessary to create a rendering group.
  88073. * This is exclusively used and created by the rendering manager.
  88074. * To modify the behavior, you use the available helpers in your scene or meshes.
  88075. * @hidden
  88076. */
  88077. export class RenderingGroup {
  88078. index: number;
  88079. private static _zeroVector;
  88080. private _scene;
  88081. private _opaqueSubMeshes;
  88082. private _transparentSubMeshes;
  88083. private _alphaTestSubMeshes;
  88084. private _depthOnlySubMeshes;
  88085. private _particleSystems;
  88086. private _spriteManagers;
  88087. private _opaqueSortCompareFn;
  88088. private _alphaTestSortCompareFn;
  88089. private _transparentSortCompareFn;
  88090. private _renderOpaque;
  88091. private _renderAlphaTest;
  88092. private _renderTransparent;
  88093. /** @hidden */
  88094. _edgesRenderers: SmartArray<IEdgesRenderer>;
  88095. onBeforeTransparentRendering: () => void;
  88096. /**
  88097. * Set the opaque sort comparison function.
  88098. * If null the sub meshes will be render in the order they were created
  88099. */
  88100. opaqueSortCompareFn: Nullable<(a: SubMesh, b: SubMesh) => number>;
  88101. /**
  88102. * Set the alpha test sort comparison function.
  88103. * If null the sub meshes will be render in the order they were created
  88104. */
  88105. alphaTestSortCompareFn: Nullable<(a: SubMesh, b: SubMesh) => number>;
  88106. /**
  88107. * Set the transparent sort comparison function.
  88108. * If null the sub meshes will be render in the order they were created
  88109. */
  88110. transparentSortCompareFn: Nullable<(a: SubMesh, b: SubMesh) => number>;
  88111. /**
  88112. * Creates a new rendering group.
  88113. * @param index The rendering group index
  88114. * @param opaqueSortCompareFn The opaque sort comparison function. If null no order is applied
  88115. * @param alphaTestSortCompareFn The alpha test sort comparison function. If null no order is applied
  88116. * @param transparentSortCompareFn The transparent sort comparison function. If null back to front + alpha index sort is applied
  88117. */
  88118. 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>);
  88119. /**
  88120. * Render all the sub meshes contained in the group.
  88121. * @param customRenderFunction Used to override the default render behaviour of the group.
  88122. * @returns true if rendered some submeshes.
  88123. */
  88124. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, renderSprites: boolean, renderParticles: boolean, activeMeshes: Nullable<AbstractMesh[]>): void;
  88125. /**
  88126. * Renders the opaque submeshes in the order from the opaqueSortCompareFn.
  88127. * @param subMeshes The submeshes to render
  88128. */
  88129. private renderOpaqueSorted;
  88130. /**
  88131. * Renders the opaque submeshes in the order from the alphatestSortCompareFn.
  88132. * @param subMeshes The submeshes to render
  88133. */
  88134. private renderAlphaTestSorted;
  88135. /**
  88136. * Renders the opaque submeshes in the order from the transparentSortCompareFn.
  88137. * @param subMeshes The submeshes to render
  88138. */
  88139. private renderTransparentSorted;
  88140. /**
  88141. * Renders the submeshes in a specified order.
  88142. * @param subMeshes The submeshes to sort before render
  88143. * @param sortCompareFn The comparison function use to sort
  88144. * @param cameraPosition The camera position use to preprocess the submeshes to help sorting
  88145. * @param transparent Specifies to activate blending if true
  88146. */
  88147. private static renderSorted;
  88148. /**
  88149. * Renders the submeshes in the order they were dispatched (no sort applied).
  88150. * @param subMeshes The submeshes to render
  88151. */
  88152. private static renderUnsorted;
  88153. /**
  88154. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  88155. * are rendered back to front if in the same alpha index.
  88156. *
  88157. * @param a The first submesh
  88158. * @param b The second submesh
  88159. * @returns The result of the comparison
  88160. */
  88161. static defaultTransparentSortCompare(a: SubMesh, b: SubMesh): number;
  88162. /**
  88163. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  88164. * are rendered back to front.
  88165. *
  88166. * @param a The first submesh
  88167. * @param b The second submesh
  88168. * @returns The result of the comparison
  88169. */
  88170. static backToFrontSortCompare(a: SubMesh, b: SubMesh): number;
  88171. /**
  88172. * Build in function which can be applied to ensure meshes of a special queue (opaque, alpha test, transparent)
  88173. * are rendered front to back (prevent overdraw).
  88174. *
  88175. * @param a The first submesh
  88176. * @param b The second submesh
  88177. * @returns The result of the comparison
  88178. */
  88179. static frontToBackSortCompare(a: SubMesh, b: SubMesh): number;
  88180. /**
  88181. * Resets the different lists of submeshes to prepare a new frame.
  88182. */
  88183. prepare(): void;
  88184. dispose(): void;
  88185. /**
  88186. * Inserts the submesh in its correct queue depending on its material.
  88187. * @param subMesh The submesh to dispatch
  88188. * @param [mesh] Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  88189. * @param [material] Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  88190. */
  88191. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  88192. dispatchSprites(spriteManager: ISpriteManager): void;
  88193. dispatchParticles(particleSystem: IParticleSystem): void;
  88194. private _renderParticles;
  88195. private _renderSprites;
  88196. }
  88197. }
  88198. declare module BABYLON {
  88199. /**
  88200. * Interface describing the different options available in the rendering manager
  88201. * regarding Auto Clear between groups.
  88202. */
  88203. export interface IRenderingManagerAutoClearSetup {
  88204. /**
  88205. * Defines whether or not autoclear is enable.
  88206. */
  88207. autoClear: boolean;
  88208. /**
  88209. * Defines whether or not to autoclear the depth buffer.
  88210. */
  88211. depth: boolean;
  88212. /**
  88213. * Defines whether or not to autoclear the stencil buffer.
  88214. */
  88215. stencil: boolean;
  88216. }
  88217. /**
  88218. * This class is used by the onRenderingGroupObservable
  88219. */
  88220. export class RenderingGroupInfo {
  88221. /**
  88222. * The Scene that being rendered
  88223. */
  88224. scene: Scene;
  88225. /**
  88226. * The camera currently used for the rendering pass
  88227. */
  88228. camera: Nullable<Camera>;
  88229. /**
  88230. * The ID of the renderingGroup being processed
  88231. */
  88232. renderingGroupId: number;
  88233. }
  88234. /**
  88235. * This is the manager responsible of all the rendering for meshes sprites and particles.
  88236. * It is enable to manage the different groups as well as the different necessary sort functions.
  88237. * This should not be used directly aside of the few static configurations
  88238. */
  88239. export class RenderingManager {
  88240. /**
  88241. * The max id used for rendering groups (not included)
  88242. */
  88243. static MAX_RENDERINGGROUPS: number;
  88244. /**
  88245. * The min id used for rendering groups (included)
  88246. */
  88247. static MIN_RENDERINGGROUPS: number;
  88248. /**
  88249. * Used to globally prevent autoclearing scenes.
  88250. */
  88251. static AUTOCLEAR: boolean;
  88252. /**
  88253. * @hidden
  88254. */
  88255. _useSceneAutoClearSetup: boolean;
  88256. private _scene;
  88257. private _renderingGroups;
  88258. private _depthStencilBufferAlreadyCleaned;
  88259. private _autoClearDepthStencil;
  88260. private _customOpaqueSortCompareFn;
  88261. private _customAlphaTestSortCompareFn;
  88262. private _customTransparentSortCompareFn;
  88263. private _renderingGroupInfo;
  88264. /**
  88265. * Instantiates a new rendering group for a particular scene
  88266. * @param scene Defines the scene the groups belongs to
  88267. */
  88268. constructor(scene: Scene);
  88269. private _clearDepthStencilBuffer;
  88270. /**
  88271. * Renders the entire managed groups. This is used by the scene or the different rennder targets.
  88272. * @hidden
  88273. */
  88274. render(customRenderFunction: Nullable<(opaqueSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>) => void>, activeMeshes: Nullable<AbstractMesh[]>, renderParticles: boolean, renderSprites: boolean): void;
  88275. /**
  88276. * Resets the different information of the group to prepare a new frame
  88277. * @hidden
  88278. */
  88279. reset(): void;
  88280. /**
  88281. * Dispose and release the group and its associated resources.
  88282. * @hidden
  88283. */
  88284. dispose(): void;
  88285. /**
  88286. * Clear the info related to rendering groups preventing retention points during dispose.
  88287. */
  88288. freeRenderingGroups(): void;
  88289. private _prepareRenderingGroup;
  88290. /**
  88291. * Add a sprite manager to the rendering manager in order to render it this frame.
  88292. * @param spriteManager Define the sprite manager to render
  88293. */
  88294. dispatchSprites(spriteManager: ISpriteManager): void;
  88295. /**
  88296. * Add a particle system to the rendering manager in order to render it this frame.
  88297. * @param particleSystem Define the particle system to render
  88298. */
  88299. dispatchParticles(particleSystem: IParticleSystem): void;
  88300. /**
  88301. * Add a submesh to the manager in order to render it this frame
  88302. * @param subMesh The submesh to dispatch
  88303. * @param mesh Optional reference to the submeshes's mesh. Provide if you have an exiting reference to improve performance.
  88304. * @param material Optional reference to the submeshes's material. Provide if you have an exiting reference to improve performance.
  88305. */
  88306. dispatch(subMesh: SubMesh, mesh?: AbstractMesh, material?: Nullable<Material>): void;
  88307. /**
  88308. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  88309. * This allowed control for front to back rendering or reversly depending of the special needs.
  88310. *
  88311. * @param renderingGroupId The rendering group id corresponding to its index
  88312. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  88313. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  88314. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  88315. */
  88316. 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;
  88317. /**
  88318. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  88319. *
  88320. * @param renderingGroupId The rendering group id corresponding to its index
  88321. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  88322. * @param depth Automatically clears depth between groups if true and autoClear is true.
  88323. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  88324. */
  88325. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  88326. /**
  88327. * Gets the current auto clear configuration for one rendering group of the rendering
  88328. * manager.
  88329. * @param index the rendering group index to get the information for
  88330. * @returns The auto clear setup for the requested rendering group
  88331. */
  88332. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  88333. }
  88334. }
  88335. declare module BABYLON {
  88336. /**
  88337. * This Helps creating a texture that will be created from a camera in your scene.
  88338. * It is basically a dynamic texture that could be used to create special effects for instance.
  88339. * Actually, It is the base of lot of effects in the framework like post process, shadows, effect layers and rendering pipelines...
  88340. */
  88341. export class RenderTargetTexture extends Texture {
  88342. isCube: boolean;
  88343. /**
  88344. * The texture will only be rendered once which can be useful to improve performance if everything in your render is static for instance.
  88345. */
  88346. static readonly REFRESHRATE_RENDER_ONCE: number;
  88347. /**
  88348. * The texture will only be rendered rendered every frame and is recomended for dynamic contents.
  88349. */
  88350. static readonly REFRESHRATE_RENDER_ONEVERYFRAME: number;
  88351. /**
  88352. * The texture will be rendered every 2 frames which could be enough if your dynamic objects are not
  88353. * the central point of your effect and can save a lot of performances.
  88354. */
  88355. static readonly REFRESHRATE_RENDER_ONEVERYTWOFRAMES: number;
  88356. /**
  88357. * Use this predicate to dynamically define the list of mesh you want to render.
  88358. * If set, the renderList property will be overwritten.
  88359. */
  88360. renderListPredicate: (AbstractMesh: AbstractMesh) => boolean;
  88361. private _renderList;
  88362. /**
  88363. * Use this list to define the list of mesh you want to render.
  88364. */
  88365. renderList: Nullable<Array<AbstractMesh>>;
  88366. private _hookArray;
  88367. /**
  88368. * Define if particles should be rendered in your texture.
  88369. */
  88370. renderParticles: boolean;
  88371. /**
  88372. * Define if sprites should be rendered in your texture.
  88373. */
  88374. renderSprites: boolean;
  88375. /**
  88376. * Override the default coordinates mode to projection for RTT as it is the most common case for rendered textures.
  88377. */
  88378. coordinatesMode: number;
  88379. /**
  88380. * Define the camera used to render the texture.
  88381. */
  88382. activeCamera: Nullable<Camera>;
  88383. /**
  88384. * Override the render function of the texture with your own one.
  88385. */
  88386. customRenderFunction: (opaqueSubMeshes: SmartArray<SubMesh>, alphaTestSubMeshes: SmartArray<SubMesh>, transparentSubMeshes: SmartArray<SubMesh>, depthOnlySubMeshes: SmartArray<SubMesh>, beforeTransparents?: () => void) => void;
  88387. /**
  88388. * Define if camera post processes should be use while rendering the texture.
  88389. */
  88390. useCameraPostProcesses: boolean;
  88391. /**
  88392. * Define if the camera viewport should be respected while rendering the texture or if the render should be done to the entire texture.
  88393. */
  88394. ignoreCameraViewport: boolean;
  88395. private _postProcessManager;
  88396. private _postProcesses;
  88397. private _resizeObserver;
  88398. /**
  88399. * An event triggered when the texture is unbind.
  88400. */
  88401. onBeforeBindObservable: Observable<RenderTargetTexture>;
  88402. /**
  88403. * An event triggered when the texture is unbind.
  88404. */
  88405. onAfterUnbindObservable: Observable<RenderTargetTexture>;
  88406. private _onAfterUnbindObserver;
  88407. /**
  88408. * Set a after unbind callback in the texture.
  88409. * This has been kept for backward compatibility and use of onAfterUnbindObservable is recommended.
  88410. */
  88411. onAfterUnbind: () => void;
  88412. /**
  88413. * An event triggered before rendering the texture
  88414. */
  88415. onBeforeRenderObservable: Observable<number>;
  88416. private _onBeforeRenderObserver;
  88417. /**
  88418. * Set a before render callback in the texture.
  88419. * This has been kept for backward compatibility and use of onBeforeRenderObservable is recommended.
  88420. */
  88421. onBeforeRender: (faceIndex: number) => void;
  88422. /**
  88423. * An event triggered after rendering the texture
  88424. */
  88425. onAfterRenderObservable: Observable<number>;
  88426. private _onAfterRenderObserver;
  88427. /**
  88428. * Set a after render callback in the texture.
  88429. * This has been kept for backward compatibility and use of onAfterRenderObservable is recommended.
  88430. */
  88431. onAfterRender: (faceIndex: number) => void;
  88432. /**
  88433. * An event triggered after the texture clear
  88434. */
  88435. onClearObservable: Observable<Engine>;
  88436. private _onClearObserver;
  88437. /**
  88438. * Set a clear callback in the texture.
  88439. * This has been kept for backward compatibility and use of onClearObservable is recommended.
  88440. */
  88441. onClear: (Engine: Engine) => void;
  88442. /**
  88443. * An event triggered when the texture is resized.
  88444. */
  88445. onResizeObservable: Observable<RenderTargetTexture>;
  88446. /**
  88447. * Define the clear color of the Render Target if it should be different from the scene.
  88448. */
  88449. clearColor: Color4;
  88450. protected _size: number | {
  88451. width: number;
  88452. height: number;
  88453. };
  88454. protected _initialSizeParameter: number | {
  88455. width: number;
  88456. height: number;
  88457. } | {
  88458. ratio: number;
  88459. };
  88460. protected _sizeRatio: Nullable<number>;
  88461. /** @hidden */
  88462. _generateMipMaps: boolean;
  88463. protected _renderingManager: RenderingManager;
  88464. /** @hidden */
  88465. _waitingRenderList: string[];
  88466. protected _doNotChangeAspectRatio: boolean;
  88467. protected _currentRefreshId: number;
  88468. protected _refreshRate: number;
  88469. protected _textureMatrix: Matrix;
  88470. protected _samples: number;
  88471. protected _renderTargetOptions: RenderTargetCreationOptions;
  88472. /**
  88473. * Gets render target creation options that were used.
  88474. */
  88475. readonly renderTargetOptions: RenderTargetCreationOptions;
  88476. protected _engine: Engine;
  88477. protected _onRatioRescale(): void;
  88478. /**
  88479. * Gets or sets the center of the bounding box associated with the texture (when in cube mode)
  88480. * It must define where the camera used to render the texture is set
  88481. */
  88482. boundingBoxPosition: Vector3;
  88483. private _boundingBoxSize;
  88484. /**
  88485. * Gets or sets the size of the bounding box associated with the texture (when in cube mode)
  88486. * When defined, the cubemap will switch to local mode
  88487. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  88488. * @example https://www.babylonjs-playground.com/#RNASML
  88489. */
  88490. boundingBoxSize: Vector3;
  88491. /**
  88492. * In case the RTT has been created with a depth texture, get the associated
  88493. * depth texture.
  88494. * Otherwise, return null.
  88495. */
  88496. depthStencilTexture: Nullable<InternalTexture>;
  88497. /**
  88498. * Instantiate a render target texture. This is mainly used to render of screen the scene to for instance apply post processse
  88499. * or used a shadow, depth texture...
  88500. * @param name The friendly name of the texture
  88501. * @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)
  88502. * @param scene The scene the RTT belongs to. The latest created scene will be used if not precised.
  88503. * @param generateMipMaps True if mip maps need to be generated after render.
  88504. * @param doNotChangeAspectRatio True to not change the aspect ratio of the scene in the RTT
  88505. * @param type The type of the buffer in the RTT (int, half float, float...)
  88506. * @param isCube True if a cube texture needs to be created
  88507. * @param samplingMode The sampling mode to be usedwith the render target (Linear, Nearest...)
  88508. * @param generateDepthBuffer True to generate a depth buffer
  88509. * @param generateStencilBuffer True to generate a stencil buffer
  88510. * @param isMulti True if multiple textures need to be created (Draw Buffers)
  88511. * @param format The internal format of the buffer in the RTT (RED, RG, RGB, RGBA, ALPHA...)
  88512. * @param delayAllocation if the texture allocation should be delayed (default: false)
  88513. */
  88514. constructor(name: string, size: number | {
  88515. width: number;
  88516. height: number;
  88517. } | {
  88518. ratio: number;
  88519. }, scene: Nullable<Scene>, generateMipMaps?: boolean, doNotChangeAspectRatio?: boolean, type?: number, isCube?: boolean, samplingMode?: number, generateDepthBuffer?: boolean, generateStencilBuffer?: boolean, isMulti?: boolean, format?: number, delayAllocation?: boolean);
  88520. /**
  88521. * Creates a depth stencil texture.
  88522. * This is only available in WebGL 2 or with the depth texture extension available.
  88523. * @param comparisonFunction Specifies the comparison function to set on the texture. If 0 or undefined, the texture is not in comparison mode
  88524. * @param bilinearFiltering Specifies whether or not bilinear filtering is enable on the texture
  88525. * @param generateStencil Specifies whether or not a stencil should be allocated in the texture
  88526. */
  88527. createDepthStencilTexture(comparisonFunction?: number, bilinearFiltering?: boolean, generateStencil?: boolean): void;
  88528. private _processSizeParameter;
  88529. /**
  88530. * Define the number of samples to use in case of MSAA.
  88531. * It defaults to one meaning no MSAA has been enabled.
  88532. */
  88533. samples: number;
  88534. /**
  88535. * Resets the refresh counter of the texture and start bak from scratch.
  88536. * Could be useful to regenerate the texture if it is setup to render only once.
  88537. */
  88538. resetRefreshCounter(): void;
  88539. /**
  88540. * Define the refresh rate of the texture or the rendering frequency.
  88541. * Use 0 to render just once, 1 to render on every frame, 2 to render every two frames and so on...
  88542. */
  88543. refreshRate: number;
  88544. /**
  88545. * Adds a post process to the render target rendering passes.
  88546. * @param postProcess define the post process to add
  88547. */
  88548. addPostProcess(postProcess: PostProcess): void;
  88549. /**
  88550. * Clear all the post processes attached to the render target
  88551. * @param dispose define if the cleared post processesshould also be disposed (false by default)
  88552. */
  88553. clearPostProcesses(dispose?: boolean): void;
  88554. /**
  88555. * Remove one of the post process from the list of attached post processes to the texture
  88556. * @param postProcess define the post process to remove from the list
  88557. */
  88558. removePostProcess(postProcess: PostProcess): void;
  88559. /** @hidden */
  88560. _shouldRender(): boolean;
  88561. /**
  88562. * Gets the actual render size of the texture.
  88563. * @returns the width of the render size
  88564. */
  88565. getRenderSize(): number;
  88566. /**
  88567. * Gets the actual render width of the texture.
  88568. * @returns the width of the render size
  88569. */
  88570. getRenderWidth(): number;
  88571. /**
  88572. * Gets the actual render height of the texture.
  88573. * @returns the height of the render size
  88574. */
  88575. getRenderHeight(): number;
  88576. /**
  88577. * Get if the texture can be rescaled or not.
  88578. */
  88579. readonly canRescale: boolean;
  88580. /**
  88581. * Resize the texture using a ratio.
  88582. * @param ratio the ratio to apply to the texture size in order to compute the new target size
  88583. */
  88584. scale(ratio: number): void;
  88585. /**
  88586. * Get the texture reflection matrix used to rotate/transform the reflection.
  88587. * @returns the reflection matrix
  88588. */
  88589. getReflectionTextureMatrix(): Matrix;
  88590. /**
  88591. * Resize the texture to a new desired size.
  88592. * Be carrefull as it will recreate all the data in the new texture.
  88593. * @param size Define the new size. It can be:
  88594. * - a number for squared texture,
  88595. * - an object containing { width: number, height: number }
  88596. * - or an object containing a ratio { ratio: number }
  88597. */
  88598. resize(size: number | {
  88599. width: number;
  88600. height: number;
  88601. } | {
  88602. ratio: number;
  88603. }): void;
  88604. /**
  88605. * Renders all the objects from the render list into the texture.
  88606. * @param useCameraPostProcess Define if camera post processes should be used during the rendering
  88607. * @param dumpForDebug Define if the rendering result should be dumped (copied) for debugging purpose
  88608. */
  88609. render(useCameraPostProcess?: boolean, dumpForDebug?: boolean): void;
  88610. private _bestReflectionRenderTargetDimension;
  88611. /**
  88612. * @hidden
  88613. * @param faceIndex face index to bind to if this is a cubetexture
  88614. */
  88615. _bindFrameBuffer(faceIndex?: number): void;
  88616. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  88617. private renderToTarget;
  88618. /**
  88619. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  88620. * This allowed control for front to back rendering or reversly depending of the special needs.
  88621. *
  88622. * @param renderingGroupId The rendering group id corresponding to its index
  88623. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  88624. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  88625. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  88626. */
  88627. 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;
  88628. /**
  88629. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  88630. *
  88631. * @param renderingGroupId The rendering group id corresponding to its index
  88632. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  88633. */
  88634. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  88635. /**
  88636. * Clones the texture.
  88637. * @returns the cloned texture
  88638. */
  88639. clone(): RenderTargetTexture;
  88640. /**
  88641. * Serialize the texture to a JSON representation we can easily use in the resepective Parse function.
  88642. * @returns The JSON representation of the texture
  88643. */
  88644. serialize(): any;
  88645. /**
  88646. * This will remove the attached framebuffer objects. The texture will not be able to be used as render target anymore
  88647. */
  88648. disposeFramebufferObjects(): void;
  88649. /**
  88650. * Dispose the texture and release its associated resources.
  88651. */
  88652. dispose(): void;
  88653. /** @hidden */
  88654. _rebuild(): void;
  88655. /**
  88656. * Clear the info related to rendering groups preventing retention point in material dispose.
  88657. */
  88658. freeRenderingGroups(): void;
  88659. /**
  88660. * Gets the number of views the corresponding to the texture (eg. a MultiviewRenderTarget will have > 1)
  88661. * @returns the view count
  88662. */
  88663. getViewCount(): number;
  88664. }
  88665. }
  88666. declare module BABYLON {
  88667. /**
  88668. * Options for compiling materials.
  88669. */
  88670. export interface IMaterialCompilationOptions {
  88671. /**
  88672. * Defines whether clip planes are enabled.
  88673. */
  88674. clipPlane: boolean;
  88675. /**
  88676. * Defines whether instances are enabled.
  88677. */
  88678. useInstances: boolean;
  88679. }
  88680. /**
  88681. * Base class for the main features of a material in Babylon.js
  88682. */
  88683. export class Material implements IAnimatable {
  88684. /**
  88685. * Returns the triangle fill mode
  88686. */
  88687. static readonly TriangleFillMode: number;
  88688. /**
  88689. * Returns the wireframe mode
  88690. */
  88691. static readonly WireFrameFillMode: number;
  88692. /**
  88693. * Returns the point fill mode
  88694. */
  88695. static readonly PointFillMode: number;
  88696. /**
  88697. * Returns the point list draw mode
  88698. */
  88699. static readonly PointListDrawMode: number;
  88700. /**
  88701. * Returns the line list draw mode
  88702. */
  88703. static readonly LineListDrawMode: number;
  88704. /**
  88705. * Returns the line loop draw mode
  88706. */
  88707. static readonly LineLoopDrawMode: number;
  88708. /**
  88709. * Returns the line strip draw mode
  88710. */
  88711. static readonly LineStripDrawMode: number;
  88712. /**
  88713. * Returns the triangle strip draw mode
  88714. */
  88715. static readonly TriangleStripDrawMode: number;
  88716. /**
  88717. * Returns the triangle fan draw mode
  88718. */
  88719. static readonly TriangleFanDrawMode: number;
  88720. /**
  88721. * Stores the clock-wise side orientation
  88722. */
  88723. static readonly ClockWiseSideOrientation: number;
  88724. /**
  88725. * Stores the counter clock-wise side orientation
  88726. */
  88727. static readonly CounterClockWiseSideOrientation: number;
  88728. /**
  88729. * The dirty texture flag value
  88730. */
  88731. static readonly TextureDirtyFlag: number;
  88732. /**
  88733. * The dirty light flag value
  88734. */
  88735. static readonly LightDirtyFlag: number;
  88736. /**
  88737. * The dirty fresnel flag value
  88738. */
  88739. static readonly FresnelDirtyFlag: number;
  88740. /**
  88741. * The dirty attribute flag value
  88742. */
  88743. static readonly AttributesDirtyFlag: number;
  88744. /**
  88745. * The dirty misc flag value
  88746. */
  88747. static readonly MiscDirtyFlag: number;
  88748. /**
  88749. * The all dirty flag value
  88750. */
  88751. static readonly AllDirtyFlag: number;
  88752. /**
  88753. * The ID of the material
  88754. */
  88755. id: string;
  88756. /**
  88757. * Gets or sets the unique id of the material
  88758. */
  88759. uniqueId: number;
  88760. /**
  88761. * The name of the material
  88762. */
  88763. name: string;
  88764. /**
  88765. * Gets or sets user defined metadata
  88766. */
  88767. metadata: any;
  88768. /**
  88769. * For internal use only. Please do not use.
  88770. */
  88771. reservedDataStore: any;
  88772. /**
  88773. * Specifies if the ready state should be checked on each call
  88774. */
  88775. checkReadyOnEveryCall: boolean;
  88776. /**
  88777. * Specifies if the ready state should be checked once
  88778. */
  88779. checkReadyOnlyOnce: boolean;
  88780. /**
  88781. * The state of the material
  88782. */
  88783. state: string;
  88784. /**
  88785. * The alpha value of the material
  88786. */
  88787. protected _alpha: number;
  88788. /**
  88789. * List of inspectable custom properties (used by the Inspector)
  88790. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  88791. */
  88792. inspectableCustomProperties: IInspectable[];
  88793. /**
  88794. * Sets the alpha value of the material
  88795. */
  88796. /**
  88797. * Gets the alpha value of the material
  88798. */
  88799. alpha: number;
  88800. /**
  88801. * Specifies if back face culling is enabled
  88802. */
  88803. protected _backFaceCulling: boolean;
  88804. /**
  88805. * Sets the back-face culling state
  88806. */
  88807. /**
  88808. * Gets the back-face culling state
  88809. */
  88810. backFaceCulling: boolean;
  88811. /**
  88812. * Stores the value for side orientation
  88813. */
  88814. sideOrientation: number;
  88815. /**
  88816. * Callback triggered when the material is compiled
  88817. */
  88818. onCompiled: Nullable<(effect: Effect) => void>;
  88819. /**
  88820. * Callback triggered when an error occurs
  88821. */
  88822. onError: Nullable<(effect: Effect, errors: string) => void>;
  88823. /**
  88824. * Callback triggered to get the render target textures
  88825. */
  88826. getRenderTargetTextures: Nullable<() => SmartArray<RenderTargetTexture>>;
  88827. /**
  88828. * Gets a boolean indicating that current material needs to register RTT
  88829. */
  88830. readonly hasRenderTargetTextures: boolean;
  88831. /**
  88832. * Specifies if the material should be serialized
  88833. */
  88834. doNotSerialize: boolean;
  88835. /**
  88836. * @hidden
  88837. */
  88838. _storeEffectOnSubMeshes: boolean;
  88839. /**
  88840. * Stores the animations for the material
  88841. */
  88842. animations: Nullable<Array<Animation>>;
  88843. /**
  88844. * An event triggered when the material is disposed
  88845. */
  88846. onDisposeObservable: Observable<Material>;
  88847. /**
  88848. * An observer which watches for dispose events
  88849. */
  88850. private _onDisposeObserver;
  88851. private _onUnBindObservable;
  88852. /**
  88853. * Called during a dispose event
  88854. */
  88855. onDispose: () => void;
  88856. private _onBindObservable;
  88857. /**
  88858. * An event triggered when the material is bound
  88859. */
  88860. readonly onBindObservable: Observable<AbstractMesh>;
  88861. /**
  88862. * An observer which watches for bind events
  88863. */
  88864. private _onBindObserver;
  88865. /**
  88866. * Called during a bind event
  88867. */
  88868. onBind: (Mesh: AbstractMesh) => void;
  88869. /**
  88870. * An event triggered when the material is unbound
  88871. */
  88872. readonly onUnBindObservable: Observable<Material>;
  88873. /**
  88874. * Stores the value of the alpha mode
  88875. */
  88876. private _alphaMode;
  88877. /**
  88878. * Sets the value of the alpha mode.
  88879. *
  88880. * | Value | Type | Description |
  88881. * | --- | --- | --- |
  88882. * | 0 | ALPHA_DISABLE | |
  88883. * | 1 | ALPHA_ADD | |
  88884. * | 2 | ALPHA_COMBINE | |
  88885. * | 3 | ALPHA_SUBTRACT | |
  88886. * | 4 | ALPHA_MULTIPLY | |
  88887. * | 5 | ALPHA_MAXIMIZED | |
  88888. * | 6 | ALPHA_ONEONE | |
  88889. * | 7 | ALPHA_PREMULTIPLIED | |
  88890. * | 8 | ALPHA_PREMULTIPLIED_PORTERDUFF | |
  88891. * | 9 | ALPHA_INTERPOLATE | |
  88892. * | 10 | ALPHA_SCREENMODE | |
  88893. *
  88894. */
  88895. /**
  88896. * Gets the value of the alpha mode
  88897. */
  88898. alphaMode: number;
  88899. /**
  88900. * Stores the state of the need depth pre-pass value
  88901. */
  88902. private _needDepthPrePass;
  88903. /**
  88904. * Sets the need depth pre-pass value
  88905. */
  88906. /**
  88907. * Gets the depth pre-pass value
  88908. */
  88909. needDepthPrePass: boolean;
  88910. /**
  88911. * Specifies if depth writing should be disabled
  88912. */
  88913. disableDepthWrite: boolean;
  88914. /**
  88915. * Specifies if depth writing should be forced
  88916. */
  88917. forceDepthWrite: boolean;
  88918. /**
  88919. * Specifies the depth function that should be used. 0 means the default engine function
  88920. */
  88921. depthFunction: number;
  88922. /**
  88923. * Specifies if there should be a separate pass for culling
  88924. */
  88925. separateCullingPass: boolean;
  88926. /**
  88927. * Stores the state specifing if fog should be enabled
  88928. */
  88929. private _fogEnabled;
  88930. /**
  88931. * Sets the state for enabling fog
  88932. */
  88933. /**
  88934. * Gets the value of the fog enabled state
  88935. */
  88936. fogEnabled: boolean;
  88937. /**
  88938. * Stores the size of points
  88939. */
  88940. pointSize: number;
  88941. /**
  88942. * Stores the z offset value
  88943. */
  88944. zOffset: number;
  88945. /**
  88946. * Gets a value specifying if wireframe mode is enabled
  88947. */
  88948. /**
  88949. * Sets the state of wireframe mode
  88950. */
  88951. wireframe: boolean;
  88952. /**
  88953. * Gets the value specifying if point clouds are enabled
  88954. */
  88955. /**
  88956. * Sets the state of point cloud mode
  88957. */
  88958. pointsCloud: boolean;
  88959. /**
  88960. * Gets the material fill mode
  88961. */
  88962. /**
  88963. * Sets the material fill mode
  88964. */
  88965. fillMode: number;
  88966. /**
  88967. * @hidden
  88968. * Stores the effects for the material
  88969. */
  88970. _effect: Nullable<Effect>;
  88971. /**
  88972. * @hidden
  88973. * Specifies if the material was previously ready
  88974. */
  88975. _wasPreviouslyReady: boolean;
  88976. /**
  88977. * Specifies if uniform buffers should be used
  88978. */
  88979. private _useUBO;
  88980. /**
  88981. * Stores a reference to the scene
  88982. */
  88983. private _scene;
  88984. /**
  88985. * Stores the fill mode state
  88986. */
  88987. private _fillMode;
  88988. /**
  88989. * Specifies if the depth write state should be cached
  88990. */
  88991. private _cachedDepthWriteState;
  88992. /**
  88993. * Specifies if the depth function state should be cached
  88994. */
  88995. private _cachedDepthFunctionState;
  88996. /**
  88997. * Stores the uniform buffer
  88998. */
  88999. protected _uniformBuffer: UniformBuffer;
  89000. /** @hidden */
  89001. _indexInSceneMaterialArray: number;
  89002. /** @hidden */
  89003. meshMap: Nullable<{
  89004. [id: string]: AbstractMesh | undefined;
  89005. }>;
  89006. /**
  89007. * Creates a material instance
  89008. * @param name defines the name of the material
  89009. * @param scene defines the scene to reference
  89010. * @param doNotAdd specifies if the material should be added to the scene
  89011. */
  89012. constructor(name: string, scene: Scene, doNotAdd?: boolean);
  89013. /**
  89014. * Returns a string representation of the current material
  89015. * @param fullDetails defines a boolean indicating which levels of logging is desired
  89016. * @returns a string with material information
  89017. */
  89018. toString(fullDetails?: boolean): string;
  89019. /**
  89020. * Gets the class name of the material
  89021. * @returns a string with the class name of the material
  89022. */
  89023. getClassName(): string;
  89024. /**
  89025. * Specifies if updates for the material been locked
  89026. */
  89027. readonly isFrozen: boolean;
  89028. /**
  89029. * Locks updates for the material
  89030. */
  89031. freeze(): void;
  89032. /**
  89033. * Unlocks updates for the material
  89034. */
  89035. unfreeze(): void;
  89036. /**
  89037. * Specifies if the material is ready to be used
  89038. * @param mesh defines the mesh to check
  89039. * @param useInstances specifies if instances should be used
  89040. * @returns a boolean indicating if the material is ready to be used
  89041. */
  89042. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  89043. /**
  89044. * Specifies that the submesh is ready to be used
  89045. * @param mesh defines the mesh to check
  89046. * @param subMesh defines which submesh to check
  89047. * @param useInstances specifies that instances should be used
  89048. * @returns a boolean indicating that the submesh is ready or not
  89049. */
  89050. isReadyForSubMesh(mesh: AbstractMesh, subMesh: BaseSubMesh, useInstances?: boolean): boolean;
  89051. /**
  89052. * Returns the material effect
  89053. * @returns the effect associated with the material
  89054. */
  89055. getEffect(): Nullable<Effect>;
  89056. /**
  89057. * Returns the current scene
  89058. * @returns a Scene
  89059. */
  89060. getScene(): Scene;
  89061. /**
  89062. * Specifies if the material will require alpha blending
  89063. * @returns a boolean specifying if alpha blending is needed
  89064. */
  89065. needAlphaBlending(): boolean;
  89066. /**
  89067. * Specifies if the mesh will require alpha blending
  89068. * @param mesh defines the mesh to check
  89069. * @returns a boolean specifying if alpha blending is needed for the mesh
  89070. */
  89071. needAlphaBlendingForMesh(mesh: AbstractMesh): boolean;
  89072. /**
  89073. * Specifies if this material should be rendered in alpha test mode
  89074. * @returns a boolean specifying if an alpha test is needed.
  89075. */
  89076. needAlphaTesting(): boolean;
  89077. /**
  89078. * Gets the texture used for the alpha test
  89079. * @returns the texture to use for alpha testing
  89080. */
  89081. getAlphaTestTexture(): Nullable<BaseTexture>;
  89082. /**
  89083. * Marks the material to indicate that it needs to be re-calculated
  89084. */
  89085. markDirty(): void;
  89086. /** @hidden */
  89087. _preBind(effect?: Effect, overrideOrientation?: Nullable<number>): boolean;
  89088. /**
  89089. * Binds the material to the mesh
  89090. * @param world defines the world transformation matrix
  89091. * @param mesh defines the mesh to bind the material to
  89092. */
  89093. bind(world: Matrix, mesh?: Mesh): void;
  89094. /**
  89095. * Binds the submesh to the material
  89096. * @param world defines the world transformation matrix
  89097. * @param mesh defines the mesh containing the submesh
  89098. * @param subMesh defines the submesh to bind the material to
  89099. */
  89100. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  89101. /**
  89102. * Binds the world matrix to the material
  89103. * @param world defines the world transformation matrix
  89104. */
  89105. bindOnlyWorldMatrix(world: Matrix): void;
  89106. /**
  89107. * Binds the scene's uniform buffer to the effect.
  89108. * @param effect defines the effect to bind to the scene uniform buffer
  89109. * @param sceneUbo defines the uniform buffer storing scene data
  89110. */
  89111. bindSceneUniformBuffer(effect: Effect, sceneUbo: UniformBuffer): void;
  89112. /**
  89113. * Binds the view matrix to the effect
  89114. * @param effect defines the effect to bind the view matrix to
  89115. */
  89116. bindView(effect: Effect): void;
  89117. /**
  89118. * Binds the view projection matrix to the effect
  89119. * @param effect defines the effect to bind the view projection matrix to
  89120. */
  89121. bindViewProjection(effect: Effect): void;
  89122. /**
  89123. * Specifies if material alpha testing should be turned on for the mesh
  89124. * @param mesh defines the mesh to check
  89125. */
  89126. protected _shouldTurnAlphaTestOn(mesh: AbstractMesh): boolean;
  89127. /**
  89128. * Processes to execute after binding the material to a mesh
  89129. * @param mesh defines the rendered mesh
  89130. */
  89131. protected _afterBind(mesh?: Mesh): void;
  89132. /**
  89133. * Unbinds the material from the mesh
  89134. */
  89135. unbind(): void;
  89136. /**
  89137. * Gets the active textures from the material
  89138. * @returns an array of textures
  89139. */
  89140. getActiveTextures(): BaseTexture[];
  89141. /**
  89142. * Specifies if the material uses a texture
  89143. * @param texture defines the texture to check against the material
  89144. * @returns a boolean specifying if the material uses the texture
  89145. */
  89146. hasTexture(texture: BaseTexture): boolean;
  89147. /**
  89148. * Makes a duplicate of the material, and gives it a new name
  89149. * @param name defines the new name for the duplicated material
  89150. * @returns the cloned material
  89151. */
  89152. clone(name: string): Nullable<Material>;
  89153. /**
  89154. * Gets the meshes bound to the material
  89155. * @returns an array of meshes bound to the material
  89156. */
  89157. getBindedMeshes(): AbstractMesh[];
  89158. /**
  89159. * Force shader compilation
  89160. * @param mesh defines the mesh associated with this material
  89161. * @param onCompiled defines a function to execute once the material is compiled
  89162. * @param options defines the options to configure the compilation
  89163. * @param onError defines a function to execute if the material fails compiling
  89164. */
  89165. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>, onError?: (reason: string) => void): void;
  89166. /**
  89167. * Force shader compilation
  89168. * @param mesh defines the mesh that will use this material
  89169. * @param options defines additional options for compiling the shaders
  89170. * @returns a promise that resolves when the compilation completes
  89171. */
  89172. forceCompilationAsync(mesh: AbstractMesh, options?: Partial<IMaterialCompilationOptions>): Promise<void>;
  89173. private static readonly _AllDirtyCallBack;
  89174. private static readonly _ImageProcessingDirtyCallBack;
  89175. private static readonly _TextureDirtyCallBack;
  89176. private static readonly _FresnelDirtyCallBack;
  89177. private static readonly _MiscDirtyCallBack;
  89178. private static readonly _LightsDirtyCallBack;
  89179. private static readonly _AttributeDirtyCallBack;
  89180. private static _FresnelAndMiscDirtyCallBack;
  89181. private static _TextureAndMiscDirtyCallBack;
  89182. private static readonly _DirtyCallbackArray;
  89183. private static readonly _RunDirtyCallBacks;
  89184. /**
  89185. * Marks a define in the material to indicate that it needs to be re-computed
  89186. * @param flag defines a flag used to determine which parts of the material have to be marked as dirty
  89187. */
  89188. markAsDirty(flag: number): void;
  89189. /**
  89190. * Marks all submeshes of a material to indicate that their material defines need to be re-calculated
  89191. * @param func defines a function which checks material defines against the submeshes
  89192. */
  89193. protected _markAllSubMeshesAsDirty(func: (defines: MaterialDefines) => void): void;
  89194. /**
  89195. * Indicates that we need to re-calculated for all submeshes
  89196. */
  89197. protected _markAllSubMeshesAsAllDirty(): void;
  89198. /**
  89199. * Indicates that image processing needs to be re-calculated for all submeshes
  89200. */
  89201. protected _markAllSubMeshesAsImageProcessingDirty(): void;
  89202. /**
  89203. * Indicates that textures need to be re-calculated for all submeshes
  89204. */
  89205. protected _markAllSubMeshesAsTexturesDirty(): void;
  89206. /**
  89207. * Indicates that fresnel needs to be re-calculated for all submeshes
  89208. */
  89209. protected _markAllSubMeshesAsFresnelDirty(): void;
  89210. /**
  89211. * Indicates that fresnel and misc need to be re-calculated for all submeshes
  89212. */
  89213. protected _markAllSubMeshesAsFresnelAndMiscDirty(): void;
  89214. /**
  89215. * Indicates that lights need to be re-calculated for all submeshes
  89216. */
  89217. protected _markAllSubMeshesAsLightsDirty(): void;
  89218. /**
  89219. * Indicates that attributes need to be re-calculated for all submeshes
  89220. */
  89221. protected _markAllSubMeshesAsAttributesDirty(): void;
  89222. /**
  89223. * Indicates that misc needs to be re-calculated for all submeshes
  89224. */
  89225. protected _markAllSubMeshesAsMiscDirty(): void;
  89226. /**
  89227. * Indicates that textures and misc need to be re-calculated for all submeshes
  89228. */
  89229. protected _markAllSubMeshesAsTexturesAndMiscDirty(): void;
  89230. /**
  89231. * Disposes the material
  89232. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  89233. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  89234. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  89235. */
  89236. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  89237. /** @hidden */
  89238. private releaseVertexArrayObject;
  89239. /**
  89240. * Serializes this material
  89241. * @returns the serialized material object
  89242. */
  89243. serialize(): any;
  89244. /**
  89245. * Creates a material from parsed material data
  89246. * @param parsedMaterial defines parsed material data
  89247. * @param scene defines the hosting scene
  89248. * @param rootUrl defines the root URL to use to load textures
  89249. * @returns a new material
  89250. */
  89251. static Parse(parsedMaterial: any, scene: Scene, rootUrl: string): Nullable<Material>;
  89252. }
  89253. }
  89254. declare module BABYLON {
  89255. /**
  89256. * A multi-material is used to apply different materials to different parts of the same object without the need of
  89257. * separate meshes. This can be use to improve performances.
  89258. * @see http://doc.babylonjs.com/how_to/multi_materials
  89259. */
  89260. export class MultiMaterial extends Material {
  89261. private _subMaterials;
  89262. /**
  89263. * Gets or Sets the list of Materials used within the multi material.
  89264. * They need to be ordered according to the submeshes order in the associated mesh
  89265. */
  89266. subMaterials: Nullable<Material>[];
  89267. /**
  89268. * Function used to align with Node.getChildren()
  89269. * @returns the list of Materials used within the multi material
  89270. */
  89271. getChildren(): Nullable<Material>[];
  89272. /**
  89273. * Instantiates a new Multi Material
  89274. * A multi-material is used to apply different materials to different parts of the same object without the need of
  89275. * separate meshes. This can be use to improve performances.
  89276. * @see http://doc.babylonjs.com/how_to/multi_materials
  89277. * @param name Define the name in the scene
  89278. * @param scene Define the scene the material belongs to
  89279. */
  89280. constructor(name: string, scene: Scene);
  89281. private _hookArray;
  89282. /**
  89283. * Get one of the submaterial by its index in the submaterials array
  89284. * @param index The index to look the sub material at
  89285. * @returns The Material if the index has been defined
  89286. */
  89287. getSubMaterial(index: number): Nullable<Material>;
  89288. /**
  89289. * Get the list of active textures for the whole sub materials list.
  89290. * @returns All the textures that will be used during the rendering
  89291. */
  89292. getActiveTextures(): BaseTexture[];
  89293. /**
  89294. * Gets the current class name of the material e.g. "MultiMaterial"
  89295. * Mainly use in serialization.
  89296. * @returns the class name
  89297. */
  89298. getClassName(): string;
  89299. /**
  89300. * Checks if the material is ready to render the requested sub mesh
  89301. * @param mesh Define the mesh the submesh belongs to
  89302. * @param subMesh Define the sub mesh to look readyness for
  89303. * @param useInstances Define whether or not the material is used with instances
  89304. * @returns true if ready, otherwise false
  89305. */
  89306. isReadyForSubMesh(mesh: AbstractMesh, subMesh: BaseSubMesh, useInstances?: boolean): boolean;
  89307. /**
  89308. * Clones the current material and its related sub materials
  89309. * @param name Define the name of the newly cloned material
  89310. * @param cloneChildren Define if submaterial will be cloned or shared with the parent instance
  89311. * @returns the cloned material
  89312. */
  89313. clone(name: string, cloneChildren?: boolean): MultiMaterial;
  89314. /**
  89315. * Serializes the materials into a JSON representation.
  89316. * @returns the JSON representation
  89317. */
  89318. serialize(): any;
  89319. /**
  89320. * Dispose the material and release its associated resources
  89321. * @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)
  89322. * @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)
  89323. * @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)
  89324. */
  89325. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, forceDisposeChildren?: boolean): void;
  89326. /**
  89327. * Creates a MultiMaterial from parsed MultiMaterial data.
  89328. * @param parsedMultiMaterial defines parsed MultiMaterial data.
  89329. * @param scene defines the hosting scene
  89330. * @returns a new MultiMaterial
  89331. */
  89332. static ParseMultiMaterial(parsedMultiMaterial: any, scene: Scene): MultiMaterial;
  89333. }
  89334. }
  89335. declare module BABYLON {
  89336. /**
  89337. * Base class for submeshes
  89338. */
  89339. export class BaseSubMesh {
  89340. /** @hidden */
  89341. _materialDefines: Nullable<MaterialDefines>;
  89342. /** @hidden */
  89343. _materialEffect: Nullable<Effect>;
  89344. /**
  89345. * Gets associated effect
  89346. */
  89347. readonly effect: Nullable<Effect>;
  89348. /**
  89349. * Sets associated effect (effect used to render this submesh)
  89350. * @param effect defines the effect to associate with
  89351. * @param defines defines the set of defines used to compile this effect
  89352. */
  89353. setEffect(effect: Nullable<Effect>, defines?: Nullable<MaterialDefines>): void;
  89354. }
  89355. /**
  89356. * Defines a subdivision inside a mesh
  89357. */
  89358. export class SubMesh extends BaseSubMesh implements ICullable {
  89359. /** the material index to use */
  89360. materialIndex: number;
  89361. /** vertex index start */
  89362. verticesStart: number;
  89363. /** vertices count */
  89364. verticesCount: number;
  89365. /** index start */
  89366. indexStart: number;
  89367. /** indices count */
  89368. indexCount: number;
  89369. /** @hidden */
  89370. _linesIndexCount: number;
  89371. private _mesh;
  89372. private _renderingMesh;
  89373. private _boundingInfo;
  89374. private _linesIndexBuffer;
  89375. /** @hidden */
  89376. _lastColliderWorldVertices: Nullable<Vector3[]>;
  89377. /** @hidden */
  89378. _trianglePlanes: Plane[];
  89379. /** @hidden */
  89380. _lastColliderTransformMatrix: Nullable<Matrix>;
  89381. /** @hidden */
  89382. _renderId: number;
  89383. /** @hidden */
  89384. _alphaIndex: number;
  89385. /** @hidden */
  89386. _distanceToCamera: number;
  89387. /** @hidden */
  89388. _id: number;
  89389. private _currentMaterial;
  89390. /**
  89391. * Add a new submesh to a mesh
  89392. * @param materialIndex defines the material index to use
  89393. * @param verticesStart defines vertex index start
  89394. * @param verticesCount defines vertices count
  89395. * @param indexStart defines index start
  89396. * @param indexCount defines indices count
  89397. * @param mesh defines the parent mesh
  89398. * @param renderingMesh defines an optional rendering mesh
  89399. * @param createBoundingBox defines if bounding box should be created for this submesh
  89400. * @returns the new submesh
  89401. */
  89402. static AddToMesh(materialIndex: number, verticesStart: number, verticesCount: number, indexStart: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean): SubMesh;
  89403. /**
  89404. * Creates a new submesh
  89405. * @param materialIndex defines the material index to use
  89406. * @param verticesStart defines vertex index start
  89407. * @param verticesCount defines vertices count
  89408. * @param indexStart defines index start
  89409. * @param indexCount defines indices count
  89410. * @param mesh defines the parent mesh
  89411. * @param renderingMesh defines an optional rendering mesh
  89412. * @param createBoundingBox defines if bounding box should be created for this submesh
  89413. */
  89414. constructor(
  89415. /** the material index to use */
  89416. materialIndex: number,
  89417. /** vertex index start */
  89418. verticesStart: number,
  89419. /** vertices count */
  89420. verticesCount: number,
  89421. /** index start */
  89422. indexStart: number,
  89423. /** indices count */
  89424. indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh, createBoundingBox?: boolean);
  89425. /**
  89426. * Returns true if this submesh covers the entire parent mesh
  89427. * @ignorenaming
  89428. */
  89429. readonly IsGlobal: boolean;
  89430. /**
  89431. * Returns the submesh BoudingInfo object
  89432. * @returns current bounding info (or mesh's one if the submesh is global)
  89433. */
  89434. getBoundingInfo(): BoundingInfo;
  89435. /**
  89436. * Sets the submesh BoundingInfo
  89437. * @param boundingInfo defines the new bounding info to use
  89438. * @returns the SubMesh
  89439. */
  89440. setBoundingInfo(boundingInfo: BoundingInfo): SubMesh;
  89441. /**
  89442. * Returns the mesh of the current submesh
  89443. * @return the parent mesh
  89444. */
  89445. getMesh(): AbstractMesh;
  89446. /**
  89447. * Returns the rendering mesh of the submesh
  89448. * @returns the rendering mesh (could be different from parent mesh)
  89449. */
  89450. getRenderingMesh(): Mesh;
  89451. /**
  89452. * Returns the submesh material
  89453. * @returns null or the current material
  89454. */
  89455. getMaterial(): Nullable<Material>;
  89456. /**
  89457. * Sets a new updated BoundingInfo object to the submesh
  89458. * @param data defines an optional position array to use to determine the bounding info
  89459. * @returns the SubMesh
  89460. */
  89461. refreshBoundingInfo(data?: Nullable<FloatArray>): SubMesh;
  89462. /** @hidden */
  89463. _checkCollision(collider: Collider): boolean;
  89464. /**
  89465. * Updates the submesh BoundingInfo
  89466. * @param world defines the world matrix to use to update the bounding info
  89467. * @returns the submesh
  89468. */
  89469. updateBoundingInfo(world: DeepImmutable<Matrix>): SubMesh;
  89470. /**
  89471. * True is the submesh bounding box intersects the frustum defined by the passed array of planes.
  89472. * @param frustumPlanes defines the frustum planes
  89473. * @returns true if the submesh is intersecting with the frustum
  89474. */
  89475. isInFrustum(frustumPlanes: Plane[]): boolean;
  89476. /**
  89477. * True is the submesh bounding box is completely inside the frustum defined by the passed array of planes
  89478. * @param frustumPlanes defines the frustum planes
  89479. * @returns true if the submesh is inside the frustum
  89480. */
  89481. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  89482. /**
  89483. * Renders the submesh
  89484. * @param enableAlphaMode defines if alpha needs to be used
  89485. * @returns the submesh
  89486. */
  89487. render(enableAlphaMode: boolean): SubMesh;
  89488. /**
  89489. * @hidden
  89490. */
  89491. _getLinesIndexBuffer(indices: IndicesArray, engine: Engine): DataBuffer;
  89492. /**
  89493. * Checks if the submesh intersects with a ray
  89494. * @param ray defines the ray to test
  89495. * @returns true is the passed ray intersects the submesh bounding box
  89496. */
  89497. canIntersects(ray: Ray): boolean;
  89498. /**
  89499. * Intersects current submesh with a ray
  89500. * @param ray defines the ray to test
  89501. * @param positions defines mesh's positions array
  89502. * @param indices defines mesh's indices array
  89503. * @param fastCheck defines if only bounding info should be used
  89504. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  89505. * @returns intersection info or null if no intersection
  89506. */
  89507. intersects(ray: Ray, positions: Vector3[], indices: IndicesArray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<IntersectionInfo>;
  89508. /** @hidden */
  89509. private _intersectLines;
  89510. /** @hidden */
  89511. private _intersectUnIndexedLines;
  89512. /** @hidden */
  89513. private _intersectTriangles;
  89514. /** @hidden */
  89515. private _intersectUnIndexedTriangles;
  89516. /** @hidden */
  89517. _rebuild(): void;
  89518. /**
  89519. * Creates a new submesh from the passed mesh
  89520. * @param newMesh defines the new hosting mesh
  89521. * @param newRenderingMesh defines an optional rendering mesh
  89522. * @returns the new submesh
  89523. */
  89524. clone(newMesh: AbstractMesh, newRenderingMesh?: Mesh): SubMesh;
  89525. /**
  89526. * Release associated resources
  89527. */
  89528. dispose(): void;
  89529. /**
  89530. * Gets the class name
  89531. * @returns the string "SubMesh".
  89532. */
  89533. getClassName(): string;
  89534. /**
  89535. * Creates a new submesh from indices data
  89536. * @param materialIndex the index of the main mesh material
  89537. * @param startIndex the index where to start the copy in the mesh indices array
  89538. * @param indexCount the number of indices to copy then from the startIndex
  89539. * @param mesh the main mesh to create the submesh from
  89540. * @param renderingMesh the optional rendering mesh
  89541. * @returns a new submesh
  89542. */
  89543. static CreateFromIndices(materialIndex: number, startIndex: number, indexCount: number, mesh: AbstractMesh, renderingMesh?: Mesh): SubMesh;
  89544. }
  89545. }
  89546. declare module BABYLON {
  89547. /**
  89548. * Class used to represent data loading progression
  89549. */
  89550. export class SceneLoaderFlags {
  89551. private static _ForceFullSceneLoadingForIncremental;
  89552. private static _ShowLoadingScreen;
  89553. private static _CleanBoneMatrixWeights;
  89554. private static _loggingLevel;
  89555. /**
  89556. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  89557. */
  89558. static ForceFullSceneLoadingForIncremental: boolean;
  89559. /**
  89560. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  89561. */
  89562. static ShowLoadingScreen: boolean;
  89563. /**
  89564. * Defines the current logging level (while loading the scene)
  89565. * @ignorenaming
  89566. */
  89567. static loggingLevel: number;
  89568. /**
  89569. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  89570. */
  89571. static CleanBoneMatrixWeights: boolean;
  89572. }
  89573. }
  89574. declare module BABYLON {
  89575. /**
  89576. * Class used to store geometry data (vertex buffers + index buffer)
  89577. */
  89578. export class Geometry implements IGetSetVerticesData {
  89579. /**
  89580. * Gets or sets the ID of the geometry
  89581. */
  89582. id: string;
  89583. /**
  89584. * Gets or sets the unique ID of the geometry
  89585. */
  89586. uniqueId: number;
  89587. /**
  89588. * Gets the delay loading state of the geometry (none by default which means not delayed)
  89589. */
  89590. delayLoadState: number;
  89591. /**
  89592. * Gets the file containing the data to load when running in delay load state
  89593. */
  89594. delayLoadingFile: Nullable<string>;
  89595. /**
  89596. * Callback called when the geometry is updated
  89597. */
  89598. onGeometryUpdated: (geometry: Geometry, kind?: string) => void;
  89599. private _scene;
  89600. private _engine;
  89601. private _meshes;
  89602. private _totalVertices;
  89603. /** @hidden */
  89604. _indices: IndicesArray;
  89605. /** @hidden */
  89606. _vertexBuffers: {
  89607. [key: string]: VertexBuffer;
  89608. };
  89609. private _isDisposed;
  89610. private _extend;
  89611. private _boundingBias;
  89612. /** @hidden */
  89613. _delayInfo: Array<string>;
  89614. private _indexBuffer;
  89615. private _indexBufferIsUpdatable;
  89616. /** @hidden */
  89617. _boundingInfo: Nullable<BoundingInfo>;
  89618. /** @hidden */
  89619. _delayLoadingFunction: Nullable<(any: any, geometry: Geometry) => void>;
  89620. /** @hidden */
  89621. _softwareSkinningFrameId: number;
  89622. private _vertexArrayObjects;
  89623. private _updatable;
  89624. /** @hidden */
  89625. _positions: Nullable<Vector3[]>;
  89626. /**
  89627. * 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
  89628. */
  89629. /**
  89630. * 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
  89631. */
  89632. boundingBias: Vector2;
  89633. /**
  89634. * Static function used to attach a new empty geometry to a mesh
  89635. * @param mesh defines the mesh to attach the geometry to
  89636. * @returns the new Geometry
  89637. */
  89638. static CreateGeometryForMesh(mesh: Mesh): Geometry;
  89639. /**
  89640. * Creates a new geometry
  89641. * @param id defines the unique ID
  89642. * @param scene defines the hosting scene
  89643. * @param vertexData defines the VertexData used to get geometry data
  89644. * @param updatable defines if geometry must be updatable (false by default)
  89645. * @param mesh defines the mesh that will be associated with the geometry
  89646. */
  89647. constructor(id: string, scene: Scene, vertexData?: VertexData, updatable?: boolean, mesh?: Nullable<Mesh>);
  89648. /**
  89649. * Gets the current extend of the geometry
  89650. */
  89651. readonly extend: {
  89652. minimum: Vector3;
  89653. maximum: Vector3;
  89654. };
  89655. /**
  89656. * Gets the hosting scene
  89657. * @returns the hosting Scene
  89658. */
  89659. getScene(): Scene;
  89660. /**
  89661. * Gets the hosting engine
  89662. * @returns the hosting Engine
  89663. */
  89664. getEngine(): Engine;
  89665. /**
  89666. * Defines if the geometry is ready to use
  89667. * @returns true if the geometry is ready to be used
  89668. */
  89669. isReady(): boolean;
  89670. /**
  89671. * Gets a value indicating that the geometry should not be serialized
  89672. */
  89673. readonly doNotSerialize: boolean;
  89674. /** @hidden */
  89675. _rebuild(): void;
  89676. /**
  89677. * Affects all geometry data in one call
  89678. * @param vertexData defines the geometry data
  89679. * @param updatable defines if the geometry must be flagged as updatable (false as default)
  89680. */
  89681. setAllVerticesData(vertexData: VertexData, updatable?: boolean): void;
  89682. /**
  89683. * Set specific vertex data
  89684. * @param kind defines the data kind (Position, normal, etc...)
  89685. * @param data defines the vertex data to use
  89686. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  89687. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  89688. */
  89689. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): void;
  89690. /**
  89691. * Removes a specific vertex data
  89692. * @param kind defines the data kind (Position, normal, etc...)
  89693. */
  89694. removeVerticesData(kind: string): void;
  89695. /**
  89696. * Affect a vertex buffer to the geometry. the vertexBuffer.getKind() function is used to determine where to store the data
  89697. * @param buffer defines the vertex buffer to use
  89698. * @param totalVertices defines the total number of vertices for position kind (could be null)
  89699. */
  89700. setVerticesBuffer(buffer: VertexBuffer, totalVertices?: Nullable<number>): void;
  89701. /**
  89702. * Update a specific vertex buffer
  89703. * This function will directly update the underlying DataBuffer according to the passed numeric array or Float32Array
  89704. * It will do nothing if the buffer is not updatable
  89705. * @param kind defines the data kind (Position, normal, etc...)
  89706. * @param data defines the data to use
  89707. * @param offset defines the offset in the target buffer where to store the data
  89708. * @param useBytes set to true if the offset is in bytes
  89709. */
  89710. updateVerticesDataDirectly(kind: string, data: DataArray, offset: number, useBytes?: boolean): void;
  89711. /**
  89712. * Update a specific vertex buffer
  89713. * This function will create a new buffer if the current one is not updatable
  89714. * @param kind defines the data kind (Position, normal, etc...)
  89715. * @param data defines the data to use
  89716. * @param updateExtends defines if the geometry extends must be recomputed (false by default)
  89717. */
  89718. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean): void;
  89719. private _updateBoundingInfo;
  89720. /** @hidden */
  89721. _bind(effect: Nullable<Effect>, indexToBind?: Nullable<DataBuffer>): void;
  89722. /**
  89723. * Gets total number of vertices
  89724. * @returns the total number of vertices
  89725. */
  89726. getTotalVertices(): number;
  89727. /**
  89728. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  89729. * @param kind defines the data kind (Position, normal, etc...)
  89730. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  89731. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  89732. * @returns a float array containing vertex data
  89733. */
  89734. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  89735. /**
  89736. * Returns a boolean defining if the vertex data for the requested `kind` is updatable
  89737. * @param kind defines the data kind (Position, normal, etc...)
  89738. * @returns true if the vertex buffer with the specified kind is updatable
  89739. */
  89740. isVertexBufferUpdatable(kind: string): boolean;
  89741. /**
  89742. * Gets a specific vertex buffer
  89743. * @param kind defines the data kind (Position, normal, etc...)
  89744. * @returns a VertexBuffer
  89745. */
  89746. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  89747. /**
  89748. * Returns all vertex buffers
  89749. * @return an object holding all vertex buffers indexed by kind
  89750. */
  89751. getVertexBuffers(): Nullable<{
  89752. [key: string]: VertexBuffer;
  89753. }>;
  89754. /**
  89755. * Gets a boolean indicating if specific vertex buffer is present
  89756. * @param kind defines the data kind (Position, normal, etc...)
  89757. * @returns true if data is present
  89758. */
  89759. isVerticesDataPresent(kind: string): boolean;
  89760. /**
  89761. * Gets a list of all attached data kinds (Position, normal, etc...)
  89762. * @returns a list of string containing all kinds
  89763. */
  89764. getVerticesDataKinds(): string[];
  89765. /**
  89766. * Update index buffer
  89767. * @param indices defines the indices to store in the index buffer
  89768. * @param offset defines the offset in the target buffer where to store the data
  89769. * @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)
  89770. */
  89771. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): void;
  89772. /**
  89773. * Creates a new index buffer
  89774. * @param indices defines the indices to store in the index buffer
  89775. * @param totalVertices defines the total number of vertices (could be null)
  89776. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  89777. */
  89778. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): void;
  89779. /**
  89780. * Return the total number of indices
  89781. * @returns the total number of indices
  89782. */
  89783. getTotalIndices(): number;
  89784. /**
  89785. * Gets the index buffer array
  89786. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  89787. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  89788. * @returns the index buffer array
  89789. */
  89790. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  89791. /**
  89792. * Gets the index buffer
  89793. * @return the index buffer
  89794. */
  89795. getIndexBuffer(): Nullable<DataBuffer>;
  89796. /** @hidden */
  89797. _releaseVertexArrayObject(effect?: Nullable<Effect>): void;
  89798. /**
  89799. * Release the associated resources for a specific mesh
  89800. * @param mesh defines the source mesh
  89801. * @param shouldDispose defines if the geometry must be disposed if there is no more mesh pointing to it
  89802. */
  89803. releaseForMesh(mesh: Mesh, shouldDispose?: boolean): void;
  89804. /**
  89805. * Apply current geometry to a given mesh
  89806. * @param mesh defines the mesh to apply geometry to
  89807. */
  89808. applyToMesh(mesh: Mesh): void;
  89809. private _updateExtend;
  89810. private _applyToMesh;
  89811. private notifyUpdate;
  89812. /**
  89813. * Load the geometry if it was flagged as delay loaded
  89814. * @param scene defines the hosting scene
  89815. * @param onLoaded defines a callback called when the geometry is loaded
  89816. */
  89817. load(scene: Scene, onLoaded?: () => void): void;
  89818. private _queueLoad;
  89819. /**
  89820. * Invert the geometry to move from a right handed system to a left handed one.
  89821. */
  89822. toLeftHanded(): void;
  89823. /** @hidden */
  89824. _resetPointsArrayCache(): void;
  89825. /** @hidden */
  89826. _generatePointsArray(): boolean;
  89827. /**
  89828. * Gets a value indicating if the geometry is disposed
  89829. * @returns true if the geometry was disposed
  89830. */
  89831. isDisposed(): boolean;
  89832. private _disposeVertexArrayObjects;
  89833. /**
  89834. * Free all associated resources
  89835. */
  89836. dispose(): void;
  89837. /**
  89838. * Clone the current geometry into a new geometry
  89839. * @param id defines the unique ID of the new geometry
  89840. * @returns a new geometry object
  89841. */
  89842. copy(id: string): Geometry;
  89843. /**
  89844. * Serialize the current geometry info (and not the vertices data) into a JSON object
  89845. * @return a JSON representation of the current geometry data (without the vertices data)
  89846. */
  89847. serialize(): any;
  89848. private toNumberArray;
  89849. /**
  89850. * Serialize all vertices data into a JSON oject
  89851. * @returns a JSON representation of the current geometry data
  89852. */
  89853. serializeVerticeData(): any;
  89854. /**
  89855. * Extracts a clone of a mesh geometry
  89856. * @param mesh defines the source mesh
  89857. * @param id defines the unique ID of the new geometry object
  89858. * @returns the new geometry object
  89859. */
  89860. static ExtractFromMesh(mesh: Mesh, id: string): Nullable<Geometry>;
  89861. /**
  89862. * You should now use Tools.RandomId(), this method is still here for legacy reasons.
  89863. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  89864. * Be aware Math.random() could cause collisions, but:
  89865. * "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"
  89866. * @returns a string containing a new GUID
  89867. */
  89868. static RandomId(): string;
  89869. /** @hidden */
  89870. static _ImportGeometry(parsedGeometry: any, mesh: Mesh): void;
  89871. private static _CleanMatricesWeights;
  89872. /**
  89873. * Create a new geometry from persisted data (Using .babylon file format)
  89874. * @param parsedVertexData defines the persisted data
  89875. * @param scene defines the hosting scene
  89876. * @param rootUrl defines the root url to use to load assets (like delayed data)
  89877. * @returns the new geometry object
  89878. */
  89879. static Parse(parsedVertexData: any, scene: Scene, rootUrl: string): Nullable<Geometry>;
  89880. }
  89881. }
  89882. declare module BABYLON {
  89883. /**
  89884. * Define an interface for all classes that will get and set the data on vertices
  89885. */
  89886. export interface IGetSetVerticesData {
  89887. /**
  89888. * Gets a boolean indicating if specific vertex data is present
  89889. * @param kind defines the vertex data kind to use
  89890. * @returns true is data kind is present
  89891. */
  89892. isVerticesDataPresent(kind: string): boolean;
  89893. /**
  89894. * Gets a specific vertex data attached to this geometry. Float data is constructed if the vertex buffer data cannot be returned directly.
  89895. * @param kind defines the data kind (Position, normal, etc...)
  89896. * @param copyWhenShared defines if the returned array must be cloned upon returning it if the current geometry is shared between multiple meshes
  89897. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  89898. * @returns a float array containing vertex data
  89899. */
  89900. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  89901. /**
  89902. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  89903. * @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.
  89904. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  89905. * @returns the indices array or an empty array if the mesh has no geometry
  89906. */
  89907. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  89908. /**
  89909. * Set specific vertex data
  89910. * @param kind defines the data kind (Position, normal, etc...)
  89911. * @param data defines the vertex data to use
  89912. * @param updatable defines if the vertex must be flagged as updatable (false as default)
  89913. * @param stride defines the stride to use (0 by default). This value is deduced from the kind value if not specified
  89914. */
  89915. setVerticesData(kind: string, data: FloatArray, updatable: boolean): void;
  89916. /**
  89917. * Update a specific associated vertex buffer
  89918. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  89919. * - VertexBuffer.PositionKind
  89920. * - VertexBuffer.UVKind
  89921. * - VertexBuffer.UV2Kind
  89922. * - VertexBuffer.UV3Kind
  89923. * - VertexBuffer.UV4Kind
  89924. * - VertexBuffer.UV5Kind
  89925. * - VertexBuffer.UV6Kind
  89926. * - VertexBuffer.ColorKind
  89927. * - VertexBuffer.MatricesIndicesKind
  89928. * - VertexBuffer.MatricesIndicesExtraKind
  89929. * - VertexBuffer.MatricesWeightsKind
  89930. * - VertexBuffer.MatricesWeightsExtraKind
  89931. * @param data defines the data source
  89932. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  89933. * @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)
  89934. */
  89935. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): void;
  89936. /**
  89937. * Creates a new index buffer
  89938. * @param indices defines the indices to store in the index buffer
  89939. * @param totalVertices defines the total number of vertices (could be null)
  89940. * @param updatable defines if the index buffer must be flagged as updatable (false by default)
  89941. */
  89942. setIndices(indices: IndicesArray, totalVertices: Nullable<number>, updatable?: boolean): void;
  89943. }
  89944. /**
  89945. * This class contains the various kinds of data on every vertex of a mesh used in determining its shape and appearance
  89946. */
  89947. export class VertexData {
  89948. /**
  89949. * Mesh side orientation : usually the external or front surface
  89950. */
  89951. static readonly FRONTSIDE: number;
  89952. /**
  89953. * Mesh side orientation : usually the internal or back surface
  89954. */
  89955. static readonly BACKSIDE: number;
  89956. /**
  89957. * Mesh side orientation : both internal and external or front and back surfaces
  89958. */
  89959. static readonly DOUBLESIDE: number;
  89960. /**
  89961. * Mesh side orientation : by default, `FRONTSIDE`
  89962. */
  89963. static readonly DEFAULTSIDE: number;
  89964. /**
  89965. * An array of the x, y, z position of each vertex [...., x, y, z, .....]
  89966. */
  89967. positions: Nullable<FloatArray>;
  89968. /**
  89969. * An array of the x, y, z normal vector of each vertex [...., x, y, z, .....]
  89970. */
  89971. normals: Nullable<FloatArray>;
  89972. /**
  89973. * An array of the x, y, z tangent vector of each vertex [...., x, y, z, .....]
  89974. */
  89975. tangents: Nullable<FloatArray>;
  89976. /**
  89977. * An array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  89978. */
  89979. uvs: Nullable<FloatArray>;
  89980. /**
  89981. * A second array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  89982. */
  89983. uvs2: Nullable<FloatArray>;
  89984. /**
  89985. * A third array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  89986. */
  89987. uvs3: Nullable<FloatArray>;
  89988. /**
  89989. * A fourth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  89990. */
  89991. uvs4: Nullable<FloatArray>;
  89992. /**
  89993. * A fifth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  89994. */
  89995. uvs5: Nullable<FloatArray>;
  89996. /**
  89997. * A sixth array of u,v which maps a texture image onto each vertex [...., u, v, .....]
  89998. */
  89999. uvs6: Nullable<FloatArray>;
  90000. /**
  90001. * An array of the r, g, b, a, color of each vertex [...., r, g, b, a, .....]
  90002. */
  90003. colors: Nullable<FloatArray>;
  90004. /**
  90005. * 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).
  90006. */
  90007. matricesIndices: Nullable<FloatArray>;
  90008. /**
  90009. * An array containing the list of weights defining the weight of each indexed matrix in the final computation
  90010. */
  90011. matricesWeights: Nullable<FloatArray>;
  90012. /**
  90013. * An array extending the number of possible indices
  90014. */
  90015. matricesIndicesExtra: Nullable<FloatArray>;
  90016. /**
  90017. * An array extending the number of possible weights when the number of indices is extended
  90018. */
  90019. matricesWeightsExtra: Nullable<FloatArray>;
  90020. /**
  90021. * An array of i, j, k the three vertex indices required for each triangular facet [...., i, j, k .....]
  90022. */
  90023. indices: Nullable<IndicesArray>;
  90024. /**
  90025. * Uses the passed data array to set the set the values for the specified kind of data
  90026. * @param data a linear array of floating numbers
  90027. * @param kind the type of data that is being set, eg positions, colors etc
  90028. */
  90029. set(data: FloatArray, kind: string): void;
  90030. /**
  90031. * Associates the vertexData to the passed Mesh.
  90032. * Sets it as updatable or not (default `false`)
  90033. * @param mesh the mesh the vertexData is applied to
  90034. * @param updatable when used and having the value true allows new data to update the vertexData
  90035. * @returns the VertexData
  90036. */
  90037. applyToMesh(mesh: Mesh, updatable?: boolean): VertexData;
  90038. /**
  90039. * Associates the vertexData to the passed Geometry.
  90040. * Sets it as updatable or not (default `false`)
  90041. * @param geometry the geometry the vertexData is applied to
  90042. * @param updatable when used and having the value true allows new data to update the vertexData
  90043. * @returns VertexData
  90044. */
  90045. applyToGeometry(geometry: Geometry, updatable?: boolean): VertexData;
  90046. /**
  90047. * Updates the associated mesh
  90048. * @param mesh the mesh to be updated
  90049. * @param updateExtends when true the mesh BoundingInfo will be renewed when and if position kind is updated, optional with default false
  90050. * @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
  90051. * @returns VertexData
  90052. */
  90053. updateMesh(mesh: Mesh): VertexData;
  90054. /**
  90055. * Updates the associated geometry
  90056. * @param geometry the geometry to be updated
  90057. * @param updateExtends when true BoundingInfo will be renewed when and if position kind is updated, optional with default false
  90058. * @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
  90059. * @returns VertexData.
  90060. */
  90061. updateGeometry(geometry: Geometry): VertexData;
  90062. private _applyTo;
  90063. private _update;
  90064. /**
  90065. * Transforms each position and each normal of the vertexData according to the passed Matrix
  90066. * @param matrix the transforming matrix
  90067. * @returns the VertexData
  90068. */
  90069. transform(matrix: Matrix): VertexData;
  90070. /**
  90071. * Merges the passed VertexData into the current one
  90072. * @param other the VertexData to be merged into the current one
  90073. * @param use32BitsIndices defines a boolean indicating if indices must be store in a 32 bits array
  90074. * @returns the modified VertexData
  90075. */
  90076. merge(other: VertexData, use32BitsIndices?: boolean): VertexData;
  90077. private _mergeElement;
  90078. private _validate;
  90079. /**
  90080. * Serializes the VertexData
  90081. * @returns a serialized object
  90082. */
  90083. serialize(): any;
  90084. /**
  90085. * Extracts the vertexData from a mesh
  90086. * @param mesh the mesh from which to extract the VertexData
  90087. * @param copyWhenShared defines if the VertexData must be cloned when shared between multiple meshes, optional, default false
  90088. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  90089. * @returns the object VertexData associated to the passed mesh
  90090. */
  90091. static ExtractFromMesh(mesh: Mesh, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  90092. /**
  90093. * Extracts the vertexData from the geometry
  90094. * @param geometry the geometry from which to extract the VertexData
  90095. * @param copyWhenShared defines if the VertexData must be cloned when the geometrty is shared between multiple meshes, optional, default false
  90096. * @param forceCopy indicating that the VertexData must be cloned, optional, default false
  90097. * @returns the object VertexData associated to the passed mesh
  90098. */
  90099. static ExtractFromGeometry(geometry: Geometry, copyWhenShared?: boolean, forceCopy?: boolean): VertexData;
  90100. private static _ExtractFrom;
  90101. /**
  90102. * Creates the VertexData for a Ribbon
  90103. * @param options an object used to set the following optional parameters for the ribbon, required but can be empty
  90104. * * pathArray array of paths, each of which an array of successive Vector3
  90105. * * closeArray creates a seam between the first and the last paths of the pathArray, optional, default false
  90106. * * closePath creates a seam between the first and the last points of each path of the path array, optional, default false
  90107. * * 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
  90108. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  90109. * * 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)
  90110. * * 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)
  90111. * * invertUV swaps in the U and V coordinates when applying a texture, optional, default false
  90112. * * uvs a linear array, of length 2 * number of vertices, of custom UV values, optional
  90113. * * colors a linear array, of length 4 * number of vertices, of custom color values, optional
  90114. * @returns the VertexData of the ribbon
  90115. */
  90116. static CreateRibbon(options: {
  90117. pathArray: Vector3[][];
  90118. closeArray?: boolean;
  90119. closePath?: boolean;
  90120. offset?: number;
  90121. sideOrientation?: number;
  90122. frontUVs?: Vector4;
  90123. backUVs?: Vector4;
  90124. invertUV?: boolean;
  90125. uvs?: Vector2[];
  90126. colors?: Color4[];
  90127. }): VertexData;
  90128. /**
  90129. * Creates the VertexData for a box
  90130. * @param options an object used to set the following optional parameters for the box, required but can be empty
  90131. * * size sets the width, height and depth of the box to the value of size, optional default 1
  90132. * * width sets the width (x direction) of the box, overwrites the width set by size, optional, default size
  90133. * * height sets the height (y direction) of the box, overwrites the height set by size, optional, default size
  90134. * * depth sets the depth (z direction) of the box, overwrites the depth set by size, optional, default size
  90135. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  90136. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  90137. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  90138. * * 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)
  90139. * * 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)
  90140. * @returns the VertexData of the box
  90141. */
  90142. static CreateBox(options: {
  90143. size?: number;
  90144. width?: number;
  90145. height?: number;
  90146. depth?: number;
  90147. faceUV?: Vector4[];
  90148. faceColors?: Color4[];
  90149. sideOrientation?: number;
  90150. frontUVs?: Vector4;
  90151. backUVs?: Vector4;
  90152. }): VertexData;
  90153. /**
  90154. * Creates the VertexData for a tiled box
  90155. * @param options an object used to set the following optional parameters for the box, required but can be empty
  90156. * * faceTiles sets the pattern, tile size and number of tiles for a face
  90157. * * faceUV an array of 6 Vector4 elements used to set different images to each box side
  90158. * * faceColors an array of 6 Color3 elements used to set different colors to each box side
  90159. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  90160. * @returns the VertexData of the box
  90161. */
  90162. static CreateTiledBox(options: {
  90163. pattern?: number;
  90164. width?: number;
  90165. height?: number;
  90166. depth?: number;
  90167. tileSize?: number;
  90168. tileWidth?: number;
  90169. tileHeight?: number;
  90170. alignHorizontal?: number;
  90171. alignVertical?: number;
  90172. faceUV?: Vector4[];
  90173. faceColors?: Color4[];
  90174. sideOrientation?: number;
  90175. }): VertexData;
  90176. /**
  90177. * Creates the VertexData for a tiled plane
  90178. * @param options an object used to set the following optional parameters for the box, required but can be empty
  90179. * * pattern a limited pattern arrangement depending on the number
  90180. * * tileSize sets the width, height and depth of the tile to the value of size, optional default 1
  90181. * * tileWidth sets the width (x direction) of the tile, overwrites the width set by size, optional, default size
  90182. * * tileHeight sets the height (y direction) of the tile, overwrites the height set by size, optional, default size
  90183. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  90184. * * 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)
  90185. * * 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)
  90186. * @returns the VertexData of the tiled plane
  90187. */
  90188. static CreateTiledPlane(options: {
  90189. pattern?: number;
  90190. tileSize?: number;
  90191. tileWidth?: number;
  90192. tileHeight?: number;
  90193. size?: number;
  90194. width?: number;
  90195. height?: number;
  90196. alignHorizontal?: number;
  90197. alignVertical?: number;
  90198. sideOrientation?: number;
  90199. frontUVs?: Vector4;
  90200. backUVs?: Vector4;
  90201. }): VertexData;
  90202. /**
  90203. * Creates the VertexData for an ellipsoid, defaults to a sphere
  90204. * @param options an object used to set the following optional parameters for the box, required but can be empty
  90205. * * segments sets the number of horizontal strips optional, default 32
  90206. * * diameter sets the axes dimensions, diameterX, diameterY and diameterZ to the value of diameter, optional default 1
  90207. * * diameterX sets the diameterX (x direction) of the ellipsoid, overwrites the diameterX set by diameter, optional, default diameter
  90208. * * diameterY sets the diameterY (y direction) of the ellipsoid, overwrites the diameterY set by diameter, optional, default diameter
  90209. * * diameterZ sets the diameterZ (z direction) of the ellipsoid, overwrites the diameterZ set by diameter, optional, default diameter
  90210. * * 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
  90211. * * 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
  90212. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  90213. * * 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)
  90214. * * 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)
  90215. * @returns the VertexData of the ellipsoid
  90216. */
  90217. static CreateSphere(options: {
  90218. segments?: number;
  90219. diameter?: number;
  90220. diameterX?: number;
  90221. diameterY?: number;
  90222. diameterZ?: number;
  90223. arc?: number;
  90224. slice?: number;
  90225. sideOrientation?: number;
  90226. frontUVs?: Vector4;
  90227. backUVs?: Vector4;
  90228. }): VertexData;
  90229. /**
  90230. * Creates the VertexData for a cylinder, cone or prism
  90231. * @param options an object used to set the following optional parameters for the box, required but can be empty
  90232. * * height sets the height (y direction) of the cylinder, optional, default 2
  90233. * * diameterTop sets the diameter of the top of the cone, overwrites diameter, optional, default diameter
  90234. * * diameterBottom sets the diameter of the bottom of the cone, overwrites diameter, optional, default diameter
  90235. * * diameter sets the diameter of the top and bottom of the cone, optional default 1
  90236. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  90237. * * subdivisions` the number of rings along the cylinder height, optional, default 1
  90238. * * 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
  90239. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  90240. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  90241. * * hasRings when true makes each subdivision independantly treated as a face for faceUV and faceColors, optional, default false
  90242. * * enclose when true closes an open cylinder by adding extra flat faces between the height axis and vertical edges, think cut cake
  90243. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  90244. * * 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)
  90245. * * 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)
  90246. * @returns the VertexData of the cylinder, cone or prism
  90247. */
  90248. static CreateCylinder(options: {
  90249. height?: number;
  90250. diameterTop?: number;
  90251. diameterBottom?: number;
  90252. diameter?: number;
  90253. tessellation?: number;
  90254. subdivisions?: number;
  90255. arc?: number;
  90256. faceColors?: Color4[];
  90257. faceUV?: Vector4[];
  90258. hasRings?: boolean;
  90259. enclose?: boolean;
  90260. sideOrientation?: number;
  90261. frontUVs?: Vector4;
  90262. backUVs?: Vector4;
  90263. }): VertexData;
  90264. /**
  90265. * Creates the VertexData for a torus
  90266. * @param options an object used to set the following optional parameters for the box, required but can be empty
  90267. * * diameter the diameter of the torus, optional default 1
  90268. * * thickness the diameter of the tube forming the torus, optional default 0.5
  90269. * * tessellation the number of prism sides, 3 for a triangular prism, optional, default 24
  90270. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  90271. * * 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)
  90272. * * 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)
  90273. * @returns the VertexData of the torus
  90274. */
  90275. static CreateTorus(options: {
  90276. diameter?: number;
  90277. thickness?: number;
  90278. tessellation?: number;
  90279. sideOrientation?: number;
  90280. frontUVs?: Vector4;
  90281. backUVs?: Vector4;
  90282. }): VertexData;
  90283. /**
  90284. * Creates the VertexData of the LineSystem
  90285. * @param options an object used to set the following optional parameters for the LineSystem, required but can be empty
  90286. * - lines an array of lines, each line being an array of successive Vector3
  90287. * - colors an array of line colors, each of the line colors being an array of successive Color4, one per line point
  90288. * @returns the VertexData of the LineSystem
  90289. */
  90290. static CreateLineSystem(options: {
  90291. lines: Vector3[][];
  90292. colors?: Nullable<Color4[][]>;
  90293. }): VertexData;
  90294. /**
  90295. * Create the VertexData for a DashedLines
  90296. * @param options an object used to set the following optional parameters for the DashedLines, required but can be empty
  90297. * - points an array successive Vector3
  90298. * - dashSize the size of the dashes relative to the dash number, optional, default 3
  90299. * - gapSize the size of the gap between two successive dashes relative to the dash number, optional, default 1
  90300. * - dashNb the intended total number of dashes, optional, default 200
  90301. * @returns the VertexData for the DashedLines
  90302. */
  90303. static CreateDashedLines(options: {
  90304. points: Vector3[];
  90305. dashSize?: number;
  90306. gapSize?: number;
  90307. dashNb?: number;
  90308. }): VertexData;
  90309. /**
  90310. * Creates the VertexData for a Ground
  90311. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  90312. * - width the width (x direction) of the ground, optional, default 1
  90313. * - height the height (z direction) of the ground, optional, default 1
  90314. * - subdivisions the number of subdivisions per side, optional, default 1
  90315. * @returns the VertexData of the Ground
  90316. */
  90317. static CreateGround(options: {
  90318. width?: number;
  90319. height?: number;
  90320. subdivisions?: number;
  90321. subdivisionsX?: number;
  90322. subdivisionsY?: number;
  90323. }): VertexData;
  90324. /**
  90325. * Creates the VertexData for a TiledGround by subdividing the ground into tiles
  90326. * @param options an object used to set the following optional parameters for the Ground, required but can be empty
  90327. * * xmin the ground minimum X coordinate, optional, default -1
  90328. * * zmin the ground minimum Z coordinate, optional, default -1
  90329. * * xmax the ground maximum X coordinate, optional, default 1
  90330. * * zmax the ground maximum Z coordinate, optional, default 1
  90331. * * 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}
  90332. * * 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}
  90333. * @returns the VertexData of the TiledGround
  90334. */
  90335. static CreateTiledGround(options: {
  90336. xmin: number;
  90337. zmin: number;
  90338. xmax: number;
  90339. zmax: number;
  90340. subdivisions?: {
  90341. w: number;
  90342. h: number;
  90343. };
  90344. precision?: {
  90345. w: number;
  90346. h: number;
  90347. };
  90348. }): VertexData;
  90349. /**
  90350. * Creates the VertexData of the Ground designed from a heightmap
  90351. * @param options an object used to set the following parameters for the Ground, required and provided by MeshBuilder.CreateGroundFromHeightMap
  90352. * * width the width (x direction) of the ground
  90353. * * height the height (z direction) of the ground
  90354. * * subdivisions the number of subdivisions per side
  90355. * * minHeight the minimum altitude on the ground, optional, default 0
  90356. * * maxHeight the maximum altitude on the ground, optional default 1
  90357. * * colorFilter the filter to apply to the image pixel colors to compute the height, optional Color3, default (0.3, 0.59, 0.11)
  90358. * * buffer the array holding the image color data
  90359. * * bufferWidth the width of image
  90360. * * bufferHeight the height of image
  90361. * * alphaFilter Remove any data where the alpha channel is below this value, defaults 0 (all data visible)
  90362. * @returns the VertexData of the Ground designed from a heightmap
  90363. */
  90364. static CreateGroundFromHeightMap(options: {
  90365. width: number;
  90366. height: number;
  90367. subdivisions: number;
  90368. minHeight: number;
  90369. maxHeight: number;
  90370. colorFilter: Color3;
  90371. buffer: Uint8Array;
  90372. bufferWidth: number;
  90373. bufferHeight: number;
  90374. alphaFilter: number;
  90375. }): VertexData;
  90376. /**
  90377. * Creates the VertexData for a Plane
  90378. * @param options an object used to set the following optional parameters for the plane, required but can be empty
  90379. * * size sets the width and height of the plane to the value of size, optional default 1
  90380. * * width sets the width (x direction) of the plane, overwrites the width set by size, optional, default size
  90381. * * height sets the height (y direction) of the plane, overwrites the height set by size, optional, default size
  90382. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  90383. * * 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)
  90384. * * 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)
  90385. * @returns the VertexData of the box
  90386. */
  90387. static CreatePlane(options: {
  90388. size?: number;
  90389. width?: number;
  90390. height?: number;
  90391. sideOrientation?: number;
  90392. frontUVs?: Vector4;
  90393. backUVs?: Vector4;
  90394. }): VertexData;
  90395. /**
  90396. * Creates the VertexData of the Disc or regular Polygon
  90397. * @param options an object used to set the following optional parameters for the disc, required but can be empty
  90398. * * radius the radius of the disc, optional default 0.5
  90399. * * tessellation the number of polygon sides, optional, default 64
  90400. * * 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
  90401. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  90402. * * 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)
  90403. * * 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)
  90404. * @returns the VertexData of the box
  90405. */
  90406. static CreateDisc(options: {
  90407. radius?: number;
  90408. tessellation?: number;
  90409. arc?: number;
  90410. sideOrientation?: number;
  90411. frontUVs?: Vector4;
  90412. backUVs?: Vector4;
  90413. }): VertexData;
  90414. /**
  90415. * Creates the VertexData for an irregular Polygon in the XoZ plane using a mesh built by polygonTriangulation.build()
  90416. * All parameters are provided by MeshBuilder.CreatePolygon as needed
  90417. * @param polygon a mesh built from polygonTriangulation.build()
  90418. * @param sideOrientation takes the values Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  90419. * @param fUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  90420. * @param fColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  90421. * @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)
  90422. * @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)
  90423. * @returns the VertexData of the Polygon
  90424. */
  90425. static CreatePolygon(polygon: Mesh, sideOrientation: number, fUV?: Vector4[], fColors?: Color4[], frontUVs?: Vector4, backUVs?: Vector4): VertexData;
  90426. /**
  90427. * Creates the VertexData of the IcoSphere
  90428. * @param options an object used to set the following optional parameters for the IcoSphere, required but can be empty
  90429. * * radius the radius of the IcoSphere, optional default 1
  90430. * * radiusX allows stretching in the x direction, optional, default radius
  90431. * * radiusY allows stretching in the y direction, optional, default radius
  90432. * * radiusZ allows stretching in the z direction, optional, default radius
  90433. * * flat when true creates a flat shaded mesh, optional, default true
  90434. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  90435. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  90436. * * 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)
  90437. * * 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)
  90438. * @returns the VertexData of the IcoSphere
  90439. */
  90440. static CreateIcoSphere(options: {
  90441. radius?: number;
  90442. radiusX?: number;
  90443. radiusY?: number;
  90444. radiusZ?: number;
  90445. flat?: boolean;
  90446. subdivisions?: number;
  90447. sideOrientation?: number;
  90448. frontUVs?: Vector4;
  90449. backUVs?: Vector4;
  90450. }): VertexData;
  90451. /**
  90452. * Creates the VertexData for a Polyhedron
  90453. * @param options an object used to set the following optional parameters for the polyhedron, required but can be empty
  90454. * * type provided types are:
  90455. * * 0 : Tetrahedron, 1 : Octahedron, 2 : Dodecahedron, 3 : Icosahedron, 4 : Rhombicuboctahedron, 5 : Triangular Prism, 6 : Pentagonal Prism, 7 : Hexagonal Prism, 8 : Square Pyramid (J1)
  90456. * * 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)
  90457. * * size the size of the IcoSphere, optional default 1
  90458. * * sizeX allows stretching in the x direction, optional, default size
  90459. * * sizeY allows stretching in the y direction, optional, default size
  90460. * * sizeZ allows stretching in the z direction, optional, default size
  90461. * * 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
  90462. * * faceUV an array of Vector4 elements used to set different images to the top, rings and bottom respectively
  90463. * * faceColors an array of Color3 elements used to set different colors to the top, rings and bottom respectively
  90464. * * flat when true creates a flat shaded mesh, optional, default true
  90465. * * subdivisions increasing the subdivisions increases the number of faces, optional, default 4
  90466. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  90467. * * 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)
  90468. * * 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)
  90469. * @returns the VertexData of the Polyhedron
  90470. */
  90471. static CreatePolyhedron(options: {
  90472. type?: number;
  90473. size?: number;
  90474. sizeX?: number;
  90475. sizeY?: number;
  90476. sizeZ?: number;
  90477. custom?: any;
  90478. faceUV?: Vector4[];
  90479. faceColors?: Color4[];
  90480. flat?: boolean;
  90481. sideOrientation?: number;
  90482. frontUVs?: Vector4;
  90483. backUVs?: Vector4;
  90484. }): VertexData;
  90485. /**
  90486. * Creates the VertexData for a TorusKnot
  90487. * @param options an object used to set the following optional parameters for the TorusKnot, required but can be empty
  90488. * * radius the radius of the torus knot, optional, default 2
  90489. * * tube the thickness of the tube, optional, default 0.5
  90490. * * radialSegments the number of sides on each tube segments, optional, default 32
  90491. * * tubularSegments the number of tubes to decompose the knot into, optional, default 32
  90492. * * p the number of windings around the z axis, optional, default 2
  90493. * * q the number of windings around the x axis, optional, default 3
  90494. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  90495. * * 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)
  90496. * * 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)
  90497. * @returns the VertexData of the Torus Knot
  90498. */
  90499. static CreateTorusKnot(options: {
  90500. radius?: number;
  90501. tube?: number;
  90502. radialSegments?: number;
  90503. tubularSegments?: number;
  90504. p?: number;
  90505. q?: number;
  90506. sideOrientation?: number;
  90507. frontUVs?: Vector4;
  90508. backUVs?: Vector4;
  90509. }): VertexData;
  90510. /**
  90511. * Compute normals for given positions and indices
  90512. * @param positions an array of vertex positions, [...., x, y, z, ......]
  90513. * @param indices an array of indices in groups of three for each triangular facet, [...., i, j, k, ......]
  90514. * @param normals an array of vertex normals, [...., x, y, z, ......]
  90515. * @param options an object used to set the following optional parameters for the TorusKnot, optional
  90516. * * facetNormals : optional array of facet normals (vector3)
  90517. * * facetPositions : optional array of facet positions (vector3)
  90518. * * facetPartitioning : optional partitioning array. facetPositions is required for facetPartitioning computation
  90519. * * ratio : optional partitioning ratio / bounding box, required for facetPartitioning computation
  90520. * * bInfo : optional bounding info, required for facetPartitioning computation
  90521. * * bbSize : optional bounding box size data, required for facetPartitioning computation
  90522. * * subDiv : optional partitioning data about subdivsions on each axis (int), required for facetPartitioning computation
  90523. * * useRightHandedSystem: optional boolean to for right handed system computation
  90524. * * depthSort : optional boolean to enable the facet depth sort computation
  90525. * * distanceTo : optional Vector3 to compute the facet depth from this location
  90526. * * depthSortedFacets : optional array of depthSortedFacets to store the facet distances from the reference location
  90527. */
  90528. static ComputeNormals(positions: any, indices: any, normals: any, options?: {
  90529. facetNormals?: any;
  90530. facetPositions?: any;
  90531. facetPartitioning?: any;
  90532. ratio?: number;
  90533. bInfo?: any;
  90534. bbSize?: Vector3;
  90535. subDiv?: any;
  90536. useRightHandedSystem?: boolean;
  90537. depthSort?: boolean;
  90538. distanceTo?: Vector3;
  90539. depthSortedFacets?: any;
  90540. }): void;
  90541. /** @hidden */
  90542. static _ComputeSides(sideOrientation: number, positions: FloatArray, indices: FloatArray, normals: FloatArray, uvs: FloatArray, frontUVs?: Vector4, backUVs?: Vector4): void;
  90543. /**
  90544. * Applies VertexData created from the imported parameters to the geometry
  90545. * @param parsedVertexData the parsed data from an imported file
  90546. * @param geometry the geometry to apply the VertexData to
  90547. */
  90548. static ImportVertexData(parsedVertexData: any, geometry: Geometry): void;
  90549. }
  90550. }
  90551. declare module BABYLON {
  90552. /**
  90553. * Defines a target to use with MorphTargetManager
  90554. * @see http://doc.babylonjs.com/how_to/how_to_use_morphtargets
  90555. */
  90556. export class MorphTarget implements IAnimatable {
  90557. /** defines the name of the target */
  90558. name: string;
  90559. /**
  90560. * Gets or sets the list of animations
  90561. */
  90562. animations: Animation[];
  90563. private _scene;
  90564. private _positions;
  90565. private _normals;
  90566. private _tangents;
  90567. private _uvs;
  90568. private _influence;
  90569. private _uniqueId;
  90570. /**
  90571. * Observable raised when the influence changes
  90572. */
  90573. onInfluenceChanged: Observable<boolean>;
  90574. /** @hidden */
  90575. _onDataLayoutChanged: Observable<void>;
  90576. /**
  90577. * Gets or sets the influence of this target (ie. its weight in the overall morphing)
  90578. */
  90579. influence: number;
  90580. /**
  90581. * Gets or sets the id of the morph Target
  90582. */
  90583. id: string;
  90584. private _animationPropertiesOverride;
  90585. /**
  90586. * Gets or sets the animation properties override
  90587. */
  90588. animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  90589. /**
  90590. * Creates a new MorphTarget
  90591. * @param name defines the name of the target
  90592. * @param influence defines the influence to use
  90593. * @param scene defines the scene the morphtarget belongs to
  90594. */
  90595. constructor(
  90596. /** defines the name of the target */
  90597. name: string, influence?: number, scene?: Nullable<Scene>);
  90598. /**
  90599. * Gets the unique ID of this manager
  90600. */
  90601. readonly uniqueId: number;
  90602. /**
  90603. * Gets a boolean defining if the target contains position data
  90604. */
  90605. readonly hasPositions: boolean;
  90606. /**
  90607. * Gets a boolean defining if the target contains normal data
  90608. */
  90609. readonly hasNormals: boolean;
  90610. /**
  90611. * Gets a boolean defining if the target contains tangent data
  90612. */
  90613. readonly hasTangents: boolean;
  90614. /**
  90615. * Gets a boolean defining if the target contains texture coordinates data
  90616. */
  90617. readonly hasUVs: boolean;
  90618. /**
  90619. * Affects position data to this target
  90620. * @param data defines the position data to use
  90621. */
  90622. setPositions(data: Nullable<FloatArray>): void;
  90623. /**
  90624. * Gets the position data stored in this target
  90625. * @returns a FloatArray containing the position data (or null if not present)
  90626. */
  90627. getPositions(): Nullable<FloatArray>;
  90628. /**
  90629. * Affects normal data to this target
  90630. * @param data defines the normal data to use
  90631. */
  90632. setNormals(data: Nullable<FloatArray>): void;
  90633. /**
  90634. * Gets the normal data stored in this target
  90635. * @returns a FloatArray containing the normal data (or null if not present)
  90636. */
  90637. getNormals(): Nullable<FloatArray>;
  90638. /**
  90639. * Affects tangent data to this target
  90640. * @param data defines the tangent data to use
  90641. */
  90642. setTangents(data: Nullable<FloatArray>): void;
  90643. /**
  90644. * Gets the tangent data stored in this target
  90645. * @returns a FloatArray containing the tangent data (or null if not present)
  90646. */
  90647. getTangents(): Nullable<FloatArray>;
  90648. /**
  90649. * Affects texture coordinates data to this target
  90650. * @param data defines the texture coordinates data to use
  90651. */
  90652. setUVs(data: Nullable<FloatArray>): void;
  90653. /**
  90654. * Gets the texture coordinates data stored in this target
  90655. * @returns a FloatArray containing the texture coordinates data (or null if not present)
  90656. */
  90657. getUVs(): Nullable<FloatArray>;
  90658. /**
  90659. * Clone the current target
  90660. * @returns a new MorphTarget
  90661. */
  90662. clone(): MorphTarget;
  90663. /**
  90664. * Serializes the current target into a Serialization object
  90665. * @returns the serialized object
  90666. */
  90667. serialize(): any;
  90668. /**
  90669. * Returns the string "MorphTarget"
  90670. * @returns "MorphTarget"
  90671. */
  90672. getClassName(): string;
  90673. /**
  90674. * Creates a new target from serialized data
  90675. * @param serializationObject defines the serialized data to use
  90676. * @returns a new MorphTarget
  90677. */
  90678. static Parse(serializationObject: any): MorphTarget;
  90679. /**
  90680. * Creates a MorphTarget from mesh data
  90681. * @param mesh defines the source mesh
  90682. * @param name defines the name to use for the new target
  90683. * @param influence defines the influence to attach to the target
  90684. * @returns a new MorphTarget
  90685. */
  90686. static FromMesh(mesh: AbstractMesh, name?: string, influence?: number): MorphTarget;
  90687. }
  90688. }
  90689. declare module BABYLON {
  90690. /**
  90691. * This class is used to deform meshes using morphing between different targets
  90692. * @see http://doc.babylonjs.com/how_to/how_to_use_morphtargets
  90693. */
  90694. export class MorphTargetManager {
  90695. private _targets;
  90696. private _targetInfluenceChangedObservers;
  90697. private _targetDataLayoutChangedObservers;
  90698. private _activeTargets;
  90699. private _scene;
  90700. private _influences;
  90701. private _supportsNormals;
  90702. private _supportsTangents;
  90703. private _supportsUVs;
  90704. private _vertexCount;
  90705. private _uniqueId;
  90706. private _tempInfluences;
  90707. /**
  90708. * Gets or sets a boolean indicating if normals must be morphed
  90709. */
  90710. enableNormalMorphing: boolean;
  90711. /**
  90712. * Gets or sets a boolean indicating if tangents must be morphed
  90713. */
  90714. enableTangentMorphing: boolean;
  90715. /**
  90716. * Gets or sets a boolean indicating if UV must be morphed
  90717. */
  90718. enableUVMorphing: boolean;
  90719. /**
  90720. * Creates a new MorphTargetManager
  90721. * @param scene defines the current scene
  90722. */
  90723. constructor(scene?: Nullable<Scene>);
  90724. /**
  90725. * Gets the unique ID of this manager
  90726. */
  90727. readonly uniqueId: number;
  90728. /**
  90729. * Gets the number of vertices handled by this manager
  90730. */
  90731. readonly vertexCount: number;
  90732. /**
  90733. * Gets a boolean indicating if this manager supports morphing of normals
  90734. */
  90735. readonly supportsNormals: boolean;
  90736. /**
  90737. * Gets a boolean indicating if this manager supports morphing of tangents
  90738. */
  90739. readonly supportsTangents: boolean;
  90740. /**
  90741. * Gets a boolean indicating if this manager supports morphing of texture coordinates
  90742. */
  90743. readonly supportsUVs: boolean;
  90744. /**
  90745. * Gets the number of targets stored in this manager
  90746. */
  90747. readonly numTargets: number;
  90748. /**
  90749. * Gets the number of influencers (ie. the number of targets with influences > 0)
  90750. */
  90751. readonly numInfluencers: number;
  90752. /**
  90753. * Gets the list of influences (one per target)
  90754. */
  90755. readonly influences: Float32Array;
  90756. /**
  90757. * Gets the active target at specified index. An active target is a target with an influence > 0
  90758. * @param index defines the index to check
  90759. * @returns the requested target
  90760. */
  90761. getActiveTarget(index: number): MorphTarget;
  90762. /**
  90763. * Gets the target at specified index
  90764. * @param index defines the index to check
  90765. * @returns the requested target
  90766. */
  90767. getTarget(index: number): MorphTarget;
  90768. /**
  90769. * Add a new target to this manager
  90770. * @param target defines the target to add
  90771. */
  90772. addTarget(target: MorphTarget): void;
  90773. /**
  90774. * Removes a target from the manager
  90775. * @param target defines the target to remove
  90776. */
  90777. removeTarget(target: MorphTarget): void;
  90778. /**
  90779. * Clone the current manager
  90780. * @returns a new MorphTargetManager
  90781. */
  90782. clone(): MorphTargetManager;
  90783. /**
  90784. * Serializes the current manager into a Serialization object
  90785. * @returns the serialized object
  90786. */
  90787. serialize(): any;
  90788. private _syncActiveTargets;
  90789. /**
  90790. * Syncrhonize the targets with all the meshes using this morph target manager
  90791. */
  90792. synchronize(): void;
  90793. /**
  90794. * Creates a new MorphTargetManager from serialized data
  90795. * @param serializationObject defines the serialized data
  90796. * @param scene defines the hosting scene
  90797. * @returns the new MorphTargetManager
  90798. */
  90799. static Parse(serializationObject: any, scene: Scene): MorphTargetManager;
  90800. }
  90801. }
  90802. declare module BABYLON {
  90803. /**
  90804. * Class used to represent a specific level of detail of a mesh
  90805. * @see http://doc.babylonjs.com/how_to/how_to_use_lod
  90806. */
  90807. export class MeshLODLevel {
  90808. /** Defines the distance where this level should start being displayed */
  90809. distance: number;
  90810. /** Defines the mesh to use to render this level */
  90811. mesh: Nullable<Mesh>;
  90812. /**
  90813. * Creates a new LOD level
  90814. * @param distance defines the distance where this level should star being displayed
  90815. * @param mesh defines the mesh to use to render this level
  90816. */
  90817. constructor(
  90818. /** Defines the distance where this level should start being displayed */
  90819. distance: number,
  90820. /** Defines the mesh to use to render this level */
  90821. mesh: Nullable<Mesh>);
  90822. }
  90823. }
  90824. declare module BABYLON {
  90825. /**
  90826. * Mesh representing the gorund
  90827. */
  90828. export class GroundMesh extends Mesh {
  90829. /** If octree should be generated */
  90830. generateOctree: boolean;
  90831. private _heightQuads;
  90832. /** @hidden */
  90833. _subdivisionsX: number;
  90834. /** @hidden */
  90835. _subdivisionsY: number;
  90836. /** @hidden */
  90837. _width: number;
  90838. /** @hidden */
  90839. _height: number;
  90840. /** @hidden */
  90841. _minX: number;
  90842. /** @hidden */
  90843. _maxX: number;
  90844. /** @hidden */
  90845. _minZ: number;
  90846. /** @hidden */
  90847. _maxZ: number;
  90848. constructor(name: string, scene: Scene);
  90849. /**
  90850. * "GroundMesh"
  90851. * @returns "GroundMesh"
  90852. */
  90853. getClassName(): string;
  90854. /**
  90855. * The minimum of x and y subdivisions
  90856. */
  90857. readonly subdivisions: number;
  90858. /**
  90859. * X subdivisions
  90860. */
  90861. readonly subdivisionsX: number;
  90862. /**
  90863. * Y subdivisions
  90864. */
  90865. readonly subdivisionsY: number;
  90866. /**
  90867. * This function will update an octree to help to select the right submeshes for rendering, picking and collision computations.
  90868. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  90869. * @param chunksCount the number of subdivisions for x and y
  90870. * @param octreeBlocksSize (Default: 32)
  90871. */
  90872. optimize(chunksCount: number, octreeBlocksSize?: number): void;
  90873. /**
  90874. * Returns a height (y) value in the Worl system :
  90875. * the ground altitude at the coordinates (x, z) expressed in the World system.
  90876. * @param x x coordinate
  90877. * @param z z coordinate
  90878. * @returns the ground y position if (x, z) are outside the ground surface.
  90879. */
  90880. getHeightAtCoordinates(x: number, z: number): number;
  90881. /**
  90882. * Returns a normalized vector (Vector3) orthogonal to the ground
  90883. * at the ground coordinates (x, z) expressed in the World system.
  90884. * @param x x coordinate
  90885. * @param z z coordinate
  90886. * @returns Vector3(0.0, 1.0, 0.0) if (x, z) are outside the ground surface.
  90887. */
  90888. getNormalAtCoordinates(x: number, z: number): Vector3;
  90889. /**
  90890. * Updates the Vector3 passed a reference with a normalized vector orthogonal to the ground
  90891. * at the ground coordinates (x, z) expressed in the World system.
  90892. * Doesn't uptade the reference Vector3 if (x, z) are outside the ground surface.
  90893. * @param x x coordinate
  90894. * @param z z coordinate
  90895. * @param ref vector to store the result
  90896. * @returns the GroundMesh.
  90897. */
  90898. getNormalAtCoordinatesToRef(x: number, z: number, ref: Vector3): GroundMesh;
  90899. /**
  90900. * Force the heights to be recomputed for getHeightAtCoordinates() or getNormalAtCoordinates()
  90901. * if the ground has been updated.
  90902. * This can be used in the render loop.
  90903. * @returns the GroundMesh.
  90904. */
  90905. updateCoordinateHeights(): GroundMesh;
  90906. private _getFacetAt;
  90907. private _initHeightQuads;
  90908. private _computeHeightQuads;
  90909. /**
  90910. * Serializes this ground mesh
  90911. * @param serializationObject object to write serialization to
  90912. */
  90913. serialize(serializationObject: any): void;
  90914. /**
  90915. * Parses a serialized ground mesh
  90916. * @param parsedMesh the serialized mesh
  90917. * @param scene the scene to create the ground mesh in
  90918. * @returns the created ground mesh
  90919. */
  90920. static Parse(parsedMesh: any, scene: Scene): GroundMesh;
  90921. }
  90922. }
  90923. declare module BABYLON {
  90924. /**
  90925. * Interface for Physics-Joint data
  90926. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  90927. */
  90928. export interface PhysicsJointData {
  90929. /**
  90930. * The main pivot of the joint
  90931. */
  90932. mainPivot?: Vector3;
  90933. /**
  90934. * The connected pivot of the joint
  90935. */
  90936. connectedPivot?: Vector3;
  90937. /**
  90938. * The main axis of the joint
  90939. */
  90940. mainAxis?: Vector3;
  90941. /**
  90942. * The connected axis of the joint
  90943. */
  90944. connectedAxis?: Vector3;
  90945. /**
  90946. * The collision of the joint
  90947. */
  90948. collision?: boolean;
  90949. /**
  90950. * Native Oimo/Cannon/Energy data
  90951. */
  90952. nativeParams?: any;
  90953. }
  90954. /**
  90955. * This is a holder class for the physics joint created by the physics plugin
  90956. * It holds a set of functions to control the underlying joint
  90957. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  90958. */
  90959. export class PhysicsJoint {
  90960. /**
  90961. * The type of the physics joint
  90962. */
  90963. type: number;
  90964. /**
  90965. * The data for the physics joint
  90966. */
  90967. jointData: PhysicsJointData;
  90968. private _physicsJoint;
  90969. protected _physicsPlugin: IPhysicsEnginePlugin;
  90970. /**
  90971. * Initializes the physics joint
  90972. * @param type The type of the physics joint
  90973. * @param jointData The data for the physics joint
  90974. */
  90975. constructor(
  90976. /**
  90977. * The type of the physics joint
  90978. */
  90979. type: number,
  90980. /**
  90981. * The data for the physics joint
  90982. */
  90983. jointData: PhysicsJointData);
  90984. /**
  90985. * Gets the physics joint
  90986. */
  90987. /**
  90988. * Sets the physics joint
  90989. */
  90990. physicsJoint: any;
  90991. /**
  90992. * Sets the physics plugin
  90993. */
  90994. physicsPlugin: IPhysicsEnginePlugin;
  90995. /**
  90996. * Execute a function that is physics-plugin specific.
  90997. * @param {Function} func the function that will be executed.
  90998. * It accepts two parameters: the physics world and the physics joint
  90999. */
  91000. executeNativeFunction(func: (world: any, physicsJoint: any) => void): void;
  91001. /**
  91002. * Distance-Joint type
  91003. */
  91004. static DistanceJoint: number;
  91005. /**
  91006. * Hinge-Joint type
  91007. */
  91008. static HingeJoint: number;
  91009. /**
  91010. * Ball-and-Socket joint type
  91011. */
  91012. static BallAndSocketJoint: number;
  91013. /**
  91014. * Wheel-Joint type
  91015. */
  91016. static WheelJoint: number;
  91017. /**
  91018. * Slider-Joint type
  91019. */
  91020. static SliderJoint: number;
  91021. /**
  91022. * Prismatic-Joint type
  91023. */
  91024. static PrismaticJoint: number;
  91025. /**
  91026. * Universal-Joint type
  91027. * ENERGY FTW! (compare with this - @see http://ode-wiki.org/wiki/index.php?title=Manual:_Joint_Types_and_Functions)
  91028. */
  91029. static UniversalJoint: number;
  91030. /**
  91031. * Hinge-Joint 2 type
  91032. */
  91033. static Hinge2Joint: number;
  91034. /**
  91035. * Point to Point Joint type. Similar to a Ball-Joint. Different in parameters
  91036. */
  91037. static PointToPointJoint: number;
  91038. /**
  91039. * Spring-Joint type
  91040. */
  91041. static SpringJoint: number;
  91042. /**
  91043. * Lock-Joint type
  91044. */
  91045. static LockJoint: number;
  91046. }
  91047. /**
  91048. * A class representing a physics distance joint
  91049. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  91050. */
  91051. export class DistanceJoint extends PhysicsJoint {
  91052. /**
  91053. *
  91054. * @param jointData The data for the Distance-Joint
  91055. */
  91056. constructor(jointData: DistanceJointData);
  91057. /**
  91058. * Update the predefined distance.
  91059. * @param maxDistance The maximum preferred distance
  91060. * @param minDistance The minimum preferred distance
  91061. */
  91062. updateDistance(maxDistance: number, minDistance?: number): void;
  91063. }
  91064. /**
  91065. * Represents a Motor-Enabled Joint
  91066. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  91067. */
  91068. export class MotorEnabledJoint extends PhysicsJoint implements IMotorEnabledJoint {
  91069. /**
  91070. * Initializes the Motor-Enabled Joint
  91071. * @param type The type of the joint
  91072. * @param jointData The physica joint data for the joint
  91073. */
  91074. constructor(type: number, jointData: PhysicsJointData);
  91075. /**
  91076. * Set the motor values.
  91077. * Attention, this function is plugin specific. Engines won't react 100% the same.
  91078. * @param force the force to apply
  91079. * @param maxForce max force for this motor.
  91080. */
  91081. setMotor(force?: number, maxForce?: number): void;
  91082. /**
  91083. * Set the motor's limits.
  91084. * Attention, this function is plugin specific. Engines won't react 100% the same.
  91085. * @param upperLimit The upper limit of the motor
  91086. * @param lowerLimit The lower limit of the motor
  91087. */
  91088. setLimit(upperLimit: number, lowerLimit?: number): void;
  91089. }
  91090. /**
  91091. * This class represents a single physics Hinge-Joint
  91092. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  91093. */
  91094. export class HingeJoint extends MotorEnabledJoint {
  91095. /**
  91096. * Initializes the Hinge-Joint
  91097. * @param jointData The joint data for the Hinge-Joint
  91098. */
  91099. constructor(jointData: PhysicsJointData);
  91100. /**
  91101. * Set the motor values.
  91102. * Attention, this function is plugin specific. Engines won't react 100% the same.
  91103. * @param {number} force the force to apply
  91104. * @param {number} maxForce max force for this motor.
  91105. */
  91106. setMotor(force?: number, maxForce?: number): void;
  91107. /**
  91108. * Set the motor's limits.
  91109. * Attention, this function is plugin specific. Engines won't react 100% the same.
  91110. * @param upperLimit The upper limit of the motor
  91111. * @param lowerLimit The lower limit of the motor
  91112. */
  91113. setLimit(upperLimit: number, lowerLimit?: number): void;
  91114. }
  91115. /**
  91116. * This class represents a dual hinge physics joint (same as wheel joint)
  91117. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  91118. */
  91119. export class Hinge2Joint extends MotorEnabledJoint {
  91120. /**
  91121. * Initializes the Hinge2-Joint
  91122. * @param jointData The joint data for the Hinge2-Joint
  91123. */
  91124. constructor(jointData: PhysicsJointData);
  91125. /**
  91126. * Set the motor values.
  91127. * Attention, this function is plugin specific. Engines won't react 100% the same.
  91128. * @param {number} targetSpeed the speed the motor is to reach
  91129. * @param {number} maxForce max force for this motor.
  91130. * @param {motorIndex} the motor's index, 0 or 1.
  91131. */
  91132. setMotor(targetSpeed?: number, maxForce?: number, motorIndex?: number): void;
  91133. /**
  91134. * Set the motor limits.
  91135. * Attention, this function is plugin specific. Engines won't react 100% the same.
  91136. * @param {number} upperLimit the upper limit
  91137. * @param {number} lowerLimit lower limit
  91138. * @param {motorIndex} the motor's index, 0 or 1.
  91139. */
  91140. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  91141. }
  91142. /**
  91143. * Interface for a motor enabled joint
  91144. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  91145. */
  91146. export interface IMotorEnabledJoint {
  91147. /**
  91148. * Physics joint
  91149. */
  91150. physicsJoint: any;
  91151. /**
  91152. * Sets the motor of the motor-enabled joint
  91153. * @param force The force of the motor
  91154. * @param maxForce The maximum force of the motor
  91155. * @param motorIndex The index of the motor
  91156. */
  91157. setMotor(force?: number, maxForce?: number, motorIndex?: number): void;
  91158. /**
  91159. * Sets the limit of the motor
  91160. * @param upperLimit The upper limit of the motor
  91161. * @param lowerLimit The lower limit of the motor
  91162. * @param motorIndex The index of the motor
  91163. */
  91164. setLimit(upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  91165. }
  91166. /**
  91167. * Joint data for a Distance-Joint
  91168. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  91169. */
  91170. export interface DistanceJointData extends PhysicsJointData {
  91171. /**
  91172. * Max distance the 2 joint objects can be apart
  91173. */
  91174. maxDistance: number;
  91175. }
  91176. /**
  91177. * Joint data from a spring joint
  91178. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  91179. */
  91180. export interface SpringJointData extends PhysicsJointData {
  91181. /**
  91182. * Length of the spring
  91183. */
  91184. length: number;
  91185. /**
  91186. * Stiffness of the spring
  91187. */
  91188. stiffness: number;
  91189. /**
  91190. * Damping of the spring
  91191. */
  91192. damping: number;
  91193. /** this callback will be called when applying the force to the impostors. */
  91194. forceApplicationCallback: () => void;
  91195. }
  91196. }
  91197. declare module BABYLON {
  91198. /**
  91199. * Holds the data for the raycast result
  91200. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  91201. */
  91202. export class PhysicsRaycastResult {
  91203. private _hasHit;
  91204. private _hitDistance;
  91205. private _hitNormalWorld;
  91206. private _hitPointWorld;
  91207. private _rayFromWorld;
  91208. private _rayToWorld;
  91209. /**
  91210. * Gets if there was a hit
  91211. */
  91212. readonly hasHit: boolean;
  91213. /**
  91214. * Gets the distance from the hit
  91215. */
  91216. readonly hitDistance: number;
  91217. /**
  91218. * Gets the hit normal/direction in the world
  91219. */
  91220. readonly hitNormalWorld: Vector3;
  91221. /**
  91222. * Gets the hit point in the world
  91223. */
  91224. readonly hitPointWorld: Vector3;
  91225. /**
  91226. * Gets the ray "start point" of the ray in the world
  91227. */
  91228. readonly rayFromWorld: Vector3;
  91229. /**
  91230. * Gets the ray "end point" of the ray in the world
  91231. */
  91232. readonly rayToWorld: Vector3;
  91233. /**
  91234. * Sets the hit data (normal & point in world space)
  91235. * @param hitNormalWorld defines the normal in world space
  91236. * @param hitPointWorld defines the point in world space
  91237. */
  91238. setHitData(hitNormalWorld: IXYZ, hitPointWorld: IXYZ): void;
  91239. /**
  91240. * Sets the distance from the start point to the hit point
  91241. * @param distance
  91242. */
  91243. setHitDistance(distance: number): void;
  91244. /**
  91245. * Calculates the distance manually
  91246. */
  91247. calculateHitDistance(): void;
  91248. /**
  91249. * Resets all the values to default
  91250. * @param from The from point on world space
  91251. * @param to The to point on world space
  91252. */
  91253. reset(from?: Vector3, to?: Vector3): void;
  91254. }
  91255. /**
  91256. * Interface for the size containing width and height
  91257. */
  91258. interface IXYZ {
  91259. /**
  91260. * X
  91261. */
  91262. x: number;
  91263. /**
  91264. * Y
  91265. */
  91266. y: number;
  91267. /**
  91268. * Z
  91269. */
  91270. z: number;
  91271. }
  91272. }
  91273. declare module BABYLON {
  91274. /**
  91275. * Interface used to describe a physics joint
  91276. */
  91277. export interface PhysicsImpostorJoint {
  91278. /** Defines the main impostor to which the joint is linked */
  91279. mainImpostor: PhysicsImpostor;
  91280. /** Defines the impostor that is connected to the main impostor using this joint */
  91281. connectedImpostor: PhysicsImpostor;
  91282. /** Defines the joint itself */
  91283. joint: PhysicsJoint;
  91284. }
  91285. /** @hidden */
  91286. export interface IPhysicsEnginePlugin {
  91287. world: any;
  91288. name: string;
  91289. setGravity(gravity: Vector3): void;
  91290. setTimeStep(timeStep: number): void;
  91291. getTimeStep(): number;
  91292. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  91293. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  91294. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  91295. generatePhysicsBody(impostor: PhysicsImpostor): void;
  91296. removePhysicsBody(impostor: PhysicsImpostor): void;
  91297. generateJoint(joint: PhysicsImpostorJoint): void;
  91298. removeJoint(joint: PhysicsImpostorJoint): void;
  91299. isSupported(): boolean;
  91300. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  91301. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  91302. setLinearVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  91303. setAngularVelocity(impostor: PhysicsImpostor, velocity: Nullable<Vector3>): void;
  91304. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  91305. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  91306. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  91307. getBodyMass(impostor: PhysicsImpostor): number;
  91308. getBodyFriction(impostor: PhysicsImpostor): number;
  91309. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  91310. getBodyRestitution(impostor: PhysicsImpostor): number;
  91311. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  91312. getBodyPressure?(impostor: PhysicsImpostor): number;
  91313. setBodyPressure?(impostor: PhysicsImpostor, pressure: number): void;
  91314. getBodyStiffness?(impostor: PhysicsImpostor): number;
  91315. setBodyStiffness?(impostor: PhysicsImpostor, stiffness: number): void;
  91316. getBodyVelocityIterations?(impostor: PhysicsImpostor): number;
  91317. setBodyVelocityIterations?(impostor: PhysicsImpostor, velocityIterations: number): void;
  91318. getBodyPositionIterations?(impostor: PhysicsImpostor): number;
  91319. setBodyPositionIterations?(impostor: PhysicsImpostor, positionIterations: number): void;
  91320. appendAnchor?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  91321. appendHook?(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): void;
  91322. sleepBody(impostor: PhysicsImpostor): void;
  91323. wakeUpBody(impostor: PhysicsImpostor): void;
  91324. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  91325. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  91326. setMotor(joint: IMotorEnabledJoint, speed: number, maxForce?: number, motorIndex?: number): void;
  91327. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  91328. getRadius(impostor: PhysicsImpostor): number;
  91329. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  91330. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  91331. dispose(): void;
  91332. }
  91333. /**
  91334. * Interface used to define a physics engine
  91335. * @see http://doc.babylonjs.com/how_to/using_the_physics_engine
  91336. */
  91337. export interface IPhysicsEngine {
  91338. /**
  91339. * Gets the gravity vector used by the simulation
  91340. */
  91341. gravity: Vector3;
  91342. /**
  91343. * Sets the gravity vector used by the simulation
  91344. * @param gravity defines the gravity vector to use
  91345. */
  91346. setGravity(gravity: Vector3): void;
  91347. /**
  91348. * Set the time step of the physics engine.
  91349. * Default is 1/60.
  91350. * To slow it down, enter 1/600 for example.
  91351. * To speed it up, 1/30
  91352. * @param newTimeStep the new timestep to apply to this world.
  91353. */
  91354. setTimeStep(newTimeStep: number): void;
  91355. /**
  91356. * Get the time step of the physics engine.
  91357. * @returns the current time step
  91358. */
  91359. getTimeStep(): number;
  91360. /**
  91361. * Release all resources
  91362. */
  91363. dispose(): void;
  91364. /**
  91365. * Gets the name of the current physics plugin
  91366. * @returns the name of the plugin
  91367. */
  91368. getPhysicsPluginName(): string;
  91369. /**
  91370. * Adding a new impostor for the impostor tracking.
  91371. * This will be done by the impostor itself.
  91372. * @param impostor the impostor to add
  91373. */
  91374. addImpostor(impostor: PhysicsImpostor): void;
  91375. /**
  91376. * Remove an impostor from the engine.
  91377. * This impostor and its mesh will not longer be updated by the physics engine.
  91378. * @param impostor the impostor to remove
  91379. */
  91380. removeImpostor(impostor: PhysicsImpostor): void;
  91381. /**
  91382. * Add a joint to the physics engine
  91383. * @param mainImpostor defines the main impostor to which the joint is added.
  91384. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  91385. * @param joint defines the joint that will connect both impostors.
  91386. */
  91387. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  91388. /**
  91389. * Removes a joint from the simulation
  91390. * @param mainImpostor defines the impostor used with the joint
  91391. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  91392. * @param joint defines the joint to remove
  91393. */
  91394. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  91395. /**
  91396. * Gets the current plugin used to run the simulation
  91397. * @returns current plugin
  91398. */
  91399. getPhysicsPlugin(): IPhysicsEnginePlugin;
  91400. /**
  91401. * Gets the list of physic impostors
  91402. * @returns an array of PhysicsImpostor
  91403. */
  91404. getImpostors(): Array<PhysicsImpostor>;
  91405. /**
  91406. * Gets the impostor for a physics enabled object
  91407. * @param object defines the object impersonated by the impostor
  91408. * @returns the PhysicsImpostor or null if not found
  91409. */
  91410. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  91411. /**
  91412. * Gets the impostor for a physics body object
  91413. * @param body defines physics body used by the impostor
  91414. * @returns the PhysicsImpostor or null if not found
  91415. */
  91416. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  91417. /**
  91418. * Does a raycast in the physics world
  91419. * @param from when should the ray start?
  91420. * @param to when should the ray end?
  91421. * @returns PhysicsRaycastResult
  91422. */
  91423. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  91424. /**
  91425. * Called by the scene. No need to call it.
  91426. * @param delta defines the timespam between frames
  91427. */
  91428. _step(delta: number): void;
  91429. }
  91430. }
  91431. declare module BABYLON {
  91432. /**
  91433. * The interface for the physics imposter parameters
  91434. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  91435. */
  91436. export interface PhysicsImpostorParameters {
  91437. /**
  91438. * The mass of the physics imposter
  91439. */
  91440. mass: number;
  91441. /**
  91442. * The friction of the physics imposter
  91443. */
  91444. friction?: number;
  91445. /**
  91446. * The coefficient of restitution of the physics imposter
  91447. */
  91448. restitution?: number;
  91449. /**
  91450. * The native options of the physics imposter
  91451. */
  91452. nativeOptions?: any;
  91453. /**
  91454. * Specifies if the parent should be ignored
  91455. */
  91456. ignoreParent?: boolean;
  91457. /**
  91458. * Specifies if bi-directional transformations should be disabled
  91459. */
  91460. disableBidirectionalTransformation?: boolean;
  91461. /**
  91462. * The pressure inside the physics imposter, soft object only
  91463. */
  91464. pressure?: number;
  91465. /**
  91466. * The stiffness the physics imposter, soft object only
  91467. */
  91468. stiffness?: number;
  91469. /**
  91470. * The number of iterations used in maintaining consistent vertex velocities, soft object only
  91471. */
  91472. velocityIterations?: number;
  91473. /**
  91474. * The number of iterations used in maintaining consistent vertex positions, soft object only
  91475. */
  91476. positionIterations?: number;
  91477. /**
  91478. * The number used to fix points on a cloth (0, 1, 2, 4, 8) or rope (0, 1, 2) only
  91479. * 0 None, 1, back left or top, 2, back right or bottom, 4, front left, 8, front right
  91480. * Add to fix multiple points
  91481. */
  91482. fixedPoints?: number;
  91483. /**
  91484. * The collision margin around a soft object
  91485. */
  91486. margin?: number;
  91487. /**
  91488. * The collision margin around a soft object
  91489. */
  91490. damping?: number;
  91491. /**
  91492. * The path for a rope based on an extrusion
  91493. */
  91494. path?: any;
  91495. /**
  91496. * The shape of an extrusion used for a rope based on an extrusion
  91497. */
  91498. shape?: any;
  91499. }
  91500. /**
  91501. * Interface for a physics-enabled object
  91502. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  91503. */
  91504. export interface IPhysicsEnabledObject {
  91505. /**
  91506. * The position of the physics-enabled object
  91507. */
  91508. position: Vector3;
  91509. /**
  91510. * The rotation of the physics-enabled object
  91511. */
  91512. rotationQuaternion: Nullable<Quaternion>;
  91513. /**
  91514. * The scale of the physics-enabled object
  91515. */
  91516. scaling: Vector3;
  91517. /**
  91518. * The rotation of the physics-enabled object
  91519. */
  91520. rotation?: Vector3;
  91521. /**
  91522. * The parent of the physics-enabled object
  91523. */
  91524. parent?: any;
  91525. /**
  91526. * The bounding info of the physics-enabled object
  91527. * @returns The bounding info of the physics-enabled object
  91528. */
  91529. getBoundingInfo(): BoundingInfo;
  91530. /**
  91531. * Computes the world matrix
  91532. * @param force Specifies if the world matrix should be computed by force
  91533. * @returns A world matrix
  91534. */
  91535. computeWorldMatrix(force: boolean): Matrix;
  91536. /**
  91537. * Gets the world matrix
  91538. * @returns A world matrix
  91539. */
  91540. getWorldMatrix?(): Matrix;
  91541. /**
  91542. * Gets the child meshes
  91543. * @param directDescendantsOnly Specifies if only direct-descendants should be obtained
  91544. * @returns An array of abstract meshes
  91545. */
  91546. getChildMeshes?(directDescendantsOnly?: boolean): Array<AbstractMesh>;
  91547. /**
  91548. * Gets the vertex data
  91549. * @param kind The type of vertex data
  91550. * @returns A nullable array of numbers, or a float32 array
  91551. */
  91552. getVerticesData(kind: string): Nullable<Array<number> | Float32Array>;
  91553. /**
  91554. * Gets the indices from the mesh
  91555. * @returns A nullable array of index arrays
  91556. */
  91557. getIndices?(): Nullable<IndicesArray>;
  91558. /**
  91559. * Gets the scene from the mesh
  91560. * @returns the indices array or null
  91561. */
  91562. getScene?(): Scene;
  91563. /**
  91564. * Gets the absolute position from the mesh
  91565. * @returns the absolute position
  91566. */
  91567. getAbsolutePosition(): Vector3;
  91568. /**
  91569. * Gets the absolute pivot point from the mesh
  91570. * @returns the absolute pivot point
  91571. */
  91572. getAbsolutePivotPoint(): Vector3;
  91573. /**
  91574. * Rotates the mesh
  91575. * @param axis The axis of rotation
  91576. * @param amount The amount of rotation
  91577. * @param space The space of the rotation
  91578. * @returns The rotation transform node
  91579. */
  91580. rotate(axis: Vector3, amount: number, space?: Space): TransformNode;
  91581. /**
  91582. * Translates the mesh
  91583. * @param axis The axis of translation
  91584. * @param distance The distance of translation
  91585. * @param space The space of the translation
  91586. * @returns The transform node
  91587. */
  91588. translate(axis: Vector3, distance: number, space?: Space): TransformNode;
  91589. /**
  91590. * Sets the absolute position of the mesh
  91591. * @param absolutePosition The absolute position of the mesh
  91592. * @returns The transform node
  91593. */
  91594. setAbsolutePosition(absolutePosition: Vector3): TransformNode;
  91595. /**
  91596. * Gets the class name of the mesh
  91597. * @returns The class name
  91598. */
  91599. getClassName(): string;
  91600. }
  91601. /**
  91602. * Represents a physics imposter
  91603. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  91604. */
  91605. export class PhysicsImpostor {
  91606. /**
  91607. * The physics-enabled object used as the physics imposter
  91608. */
  91609. object: IPhysicsEnabledObject;
  91610. /**
  91611. * The type of the physics imposter
  91612. */
  91613. type: number;
  91614. private _options;
  91615. private _scene?;
  91616. /**
  91617. * The default object size of the imposter
  91618. */
  91619. static DEFAULT_OBJECT_SIZE: Vector3;
  91620. /**
  91621. * The identity quaternion of the imposter
  91622. */
  91623. static IDENTITY_QUATERNION: Quaternion;
  91624. /** @hidden */
  91625. _pluginData: any;
  91626. private _physicsEngine;
  91627. private _physicsBody;
  91628. private _bodyUpdateRequired;
  91629. private _onBeforePhysicsStepCallbacks;
  91630. private _onAfterPhysicsStepCallbacks;
  91631. /** @hidden */
  91632. _onPhysicsCollideCallbacks: Array<{
  91633. callback: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void;
  91634. otherImpostors: Array<PhysicsImpostor>;
  91635. }>;
  91636. private _deltaPosition;
  91637. private _deltaRotation;
  91638. private _deltaRotationConjugated;
  91639. /** @hidden */
  91640. _isFromLine: boolean;
  91641. private _parent;
  91642. private _isDisposed;
  91643. private static _tmpVecs;
  91644. private static _tmpQuat;
  91645. /**
  91646. * Specifies if the physics imposter is disposed
  91647. */
  91648. readonly isDisposed: boolean;
  91649. /**
  91650. * Gets the mass of the physics imposter
  91651. */
  91652. mass: number;
  91653. /**
  91654. * Gets the coefficient of friction
  91655. */
  91656. /**
  91657. * Sets the coefficient of friction
  91658. */
  91659. friction: number;
  91660. /**
  91661. * Gets the coefficient of restitution
  91662. */
  91663. /**
  91664. * Sets the coefficient of restitution
  91665. */
  91666. restitution: number;
  91667. /**
  91668. * Gets the pressure of a soft body; only supported by the AmmoJSPlugin
  91669. */
  91670. /**
  91671. * Sets the pressure of a soft body; only supported by the AmmoJSPlugin
  91672. */
  91673. pressure: number;
  91674. /**
  91675. * Gets the stiffness of a soft body; only supported by the AmmoJSPlugin
  91676. */
  91677. /**
  91678. * Sets the stiffness of a soft body; only supported by the AmmoJSPlugin
  91679. */
  91680. stiffness: number;
  91681. /**
  91682. * Gets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  91683. */
  91684. /**
  91685. * Sets the velocityIterations of a soft body; only supported by the AmmoJSPlugin
  91686. */
  91687. velocityIterations: number;
  91688. /**
  91689. * Gets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  91690. */
  91691. /**
  91692. * Sets the positionIterations of a soft body; only supported by the AmmoJSPlugin
  91693. */
  91694. positionIterations: number;
  91695. /**
  91696. * The unique id of the physics imposter
  91697. * set by the physics engine when adding this impostor to the array
  91698. */
  91699. uniqueId: number;
  91700. /**
  91701. * @hidden
  91702. */
  91703. soft: boolean;
  91704. /**
  91705. * @hidden
  91706. */
  91707. segments: number;
  91708. private _joints;
  91709. /**
  91710. * Initializes the physics imposter
  91711. * @param object The physics-enabled object used as the physics imposter
  91712. * @param type The type of the physics imposter
  91713. * @param _options The options for the physics imposter
  91714. * @param _scene The Babylon scene
  91715. */
  91716. constructor(
  91717. /**
  91718. * The physics-enabled object used as the physics imposter
  91719. */
  91720. object: IPhysicsEnabledObject,
  91721. /**
  91722. * The type of the physics imposter
  91723. */
  91724. type: number, _options?: PhysicsImpostorParameters, _scene?: Scene | undefined);
  91725. /**
  91726. * This function will completly initialize this impostor.
  91727. * It will create a new body - but only if this mesh has no parent.
  91728. * If it has, this impostor will not be used other than to define the impostor
  91729. * of the child mesh.
  91730. * @hidden
  91731. */
  91732. _init(): void;
  91733. private _getPhysicsParent;
  91734. /**
  91735. * Should a new body be generated.
  91736. * @returns boolean specifying if body initialization is required
  91737. */
  91738. isBodyInitRequired(): boolean;
  91739. /**
  91740. * Sets the updated scaling
  91741. * @param updated Specifies if the scaling is updated
  91742. */
  91743. setScalingUpdated(): void;
  91744. /**
  91745. * Force a regeneration of this or the parent's impostor's body.
  91746. * Use under cautious - This will remove all joints already implemented.
  91747. */
  91748. forceUpdate(): void;
  91749. /**
  91750. * Gets the body that holds this impostor. Either its own, or its parent.
  91751. */
  91752. /**
  91753. * Set the physics body. Used mainly by the physics engine/plugin
  91754. */
  91755. physicsBody: any;
  91756. /**
  91757. * Get the parent of the physics imposter
  91758. * @returns Physics imposter or null
  91759. */
  91760. /**
  91761. * Sets the parent of the physics imposter
  91762. */
  91763. parent: Nullable<PhysicsImpostor>;
  91764. /**
  91765. * Resets the update flags
  91766. */
  91767. resetUpdateFlags(): void;
  91768. /**
  91769. * Gets the object extend size
  91770. * @returns the object extend size
  91771. */
  91772. getObjectExtendSize(): Vector3;
  91773. /**
  91774. * Gets the object center
  91775. * @returns The object center
  91776. */
  91777. getObjectCenter(): Vector3;
  91778. /**
  91779. * Get a specific parametes from the options parameter
  91780. * @param paramName The object parameter name
  91781. * @returns The object parameter
  91782. */
  91783. getParam(paramName: string): any;
  91784. /**
  91785. * Sets a specific parameter in the options given to the physics plugin
  91786. * @param paramName The parameter name
  91787. * @param value The value of the parameter
  91788. */
  91789. setParam(paramName: string, value: number): void;
  91790. /**
  91791. * Specifically change the body's mass option. Won't recreate the physics body object
  91792. * @param mass The mass of the physics imposter
  91793. */
  91794. setMass(mass: number): void;
  91795. /**
  91796. * Gets the linear velocity
  91797. * @returns linear velocity or null
  91798. */
  91799. getLinearVelocity(): Nullable<Vector3>;
  91800. /**
  91801. * Sets the linear velocity
  91802. * @param velocity linear velocity or null
  91803. */
  91804. setLinearVelocity(velocity: Nullable<Vector3>): void;
  91805. /**
  91806. * Gets the angular velocity
  91807. * @returns angular velocity or null
  91808. */
  91809. getAngularVelocity(): Nullable<Vector3>;
  91810. /**
  91811. * Sets the angular velocity
  91812. * @param velocity The velocity or null
  91813. */
  91814. setAngularVelocity(velocity: Nullable<Vector3>): void;
  91815. /**
  91816. * Execute a function with the physics plugin native code
  91817. * Provide a function the will have two variables - the world object and the physics body object
  91818. * @param func The function to execute with the physics plugin native code
  91819. */
  91820. executeNativeFunction(func: (world: any, physicsBody: any) => void): void;
  91821. /**
  91822. * Register a function that will be executed before the physics world is stepping forward
  91823. * @param func The function to execute before the physics world is stepped forward
  91824. */
  91825. registerBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  91826. /**
  91827. * Unregister a function that will be executed before the physics world is stepping forward
  91828. * @param func The function to execute before the physics world is stepped forward
  91829. */
  91830. unregisterBeforePhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  91831. /**
  91832. * Register a function that will be executed after the physics step
  91833. * @param func The function to execute after physics step
  91834. */
  91835. registerAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  91836. /**
  91837. * Unregisters a function that will be executed after the physics step
  91838. * @param func The function to execute after physics step
  91839. */
  91840. unregisterAfterPhysicsStep(func: (impostor: PhysicsImpostor) => void): void;
  91841. /**
  91842. * register a function that will be executed when this impostor collides against a different body
  91843. * @param collideAgainst Physics imposter, or array of physics imposters to collide against
  91844. * @param func Callback that is executed on collision
  91845. */
  91846. registerOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor) => void): void;
  91847. /**
  91848. * Unregisters the physics imposter on contact
  91849. * @param collideAgainst The physics object to collide against
  91850. * @param func Callback to execute on collision
  91851. */
  91852. unregisterOnPhysicsCollide(collideAgainst: PhysicsImpostor | Array<PhysicsImpostor>, func: (collider: PhysicsImpostor, collidedAgainst: PhysicsImpostor | Array<PhysicsImpostor>) => void): void;
  91853. private _tmpQuat;
  91854. private _tmpQuat2;
  91855. /**
  91856. * Get the parent rotation
  91857. * @returns The parent rotation
  91858. */
  91859. getParentsRotation(): Quaternion;
  91860. /**
  91861. * this function is executed by the physics engine.
  91862. */
  91863. beforeStep: () => void;
  91864. /**
  91865. * this function is executed by the physics engine
  91866. */
  91867. afterStep: () => void;
  91868. /**
  91869. * Legacy collision detection event support
  91870. */
  91871. onCollideEvent: Nullable<(collider: PhysicsImpostor, collidedWith: PhysicsImpostor) => void>;
  91872. /**
  91873. * event and body object due to cannon's event-based architecture.
  91874. */
  91875. onCollide: (e: {
  91876. body: any;
  91877. }) => void;
  91878. /**
  91879. * Apply a force
  91880. * @param force The force to apply
  91881. * @param contactPoint The contact point for the force
  91882. * @returns The physics imposter
  91883. */
  91884. applyForce(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  91885. /**
  91886. * Apply an impulse
  91887. * @param force The impulse force
  91888. * @param contactPoint The contact point for the impulse force
  91889. * @returns The physics imposter
  91890. */
  91891. applyImpulse(force: Vector3, contactPoint: Vector3): PhysicsImpostor;
  91892. /**
  91893. * A help function to create a joint
  91894. * @param otherImpostor A physics imposter used to create a joint
  91895. * @param jointType The type of joint
  91896. * @param jointData The data for the joint
  91897. * @returns The physics imposter
  91898. */
  91899. createJoint(otherImpostor: PhysicsImpostor, jointType: number, jointData: PhysicsJointData): PhysicsImpostor;
  91900. /**
  91901. * Add a joint to this impostor with a different impostor
  91902. * @param otherImpostor A physics imposter used to add a joint
  91903. * @param joint The joint to add
  91904. * @returns The physics imposter
  91905. */
  91906. addJoint(otherImpostor: PhysicsImpostor, joint: PhysicsJoint): PhysicsImpostor;
  91907. /**
  91908. * Add an anchor to a cloth impostor
  91909. * @param otherImpostor rigid impostor to anchor to
  91910. * @param width ratio across width from 0 to 1
  91911. * @param height ratio up height from 0 to 1
  91912. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  91913. * @param noCollisionBetweenLinkedBodies when true collisions between cloth impostor and anchor are ignored; default false
  91914. * @returns impostor the soft imposter
  91915. */
  91916. addAnchor(otherImpostor: PhysicsImpostor, width: number, height: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  91917. /**
  91918. * Add a hook to a rope impostor
  91919. * @param otherImpostor rigid impostor to anchor to
  91920. * @param length ratio across rope from 0 to 1
  91921. * @param influence the elasticity between rope impostor and anchor from 0, very stretchy to 1, little strech
  91922. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  91923. * @returns impostor the rope imposter
  91924. */
  91925. addHook(otherImpostor: PhysicsImpostor, length: number, influence: number, noCollisionBetweenLinkedBodies: boolean): PhysicsImpostor;
  91926. /**
  91927. * Will keep this body still, in a sleep mode.
  91928. * @returns the physics imposter
  91929. */
  91930. sleep(): PhysicsImpostor;
  91931. /**
  91932. * Wake the body up.
  91933. * @returns The physics imposter
  91934. */
  91935. wakeUp(): PhysicsImpostor;
  91936. /**
  91937. * Clones the physics imposter
  91938. * @param newObject The physics imposter clones to this physics-enabled object
  91939. * @returns A nullable physics imposter
  91940. */
  91941. clone(newObject: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  91942. /**
  91943. * Disposes the physics imposter
  91944. */
  91945. dispose(): void;
  91946. /**
  91947. * Sets the delta position
  91948. * @param position The delta position amount
  91949. */
  91950. setDeltaPosition(position: Vector3): void;
  91951. /**
  91952. * Sets the delta rotation
  91953. * @param rotation The delta rotation amount
  91954. */
  91955. setDeltaRotation(rotation: Quaternion): void;
  91956. /**
  91957. * Gets the box size of the physics imposter and stores the result in the input parameter
  91958. * @param result Stores the box size
  91959. * @returns The physics imposter
  91960. */
  91961. getBoxSizeToRef(result: Vector3): PhysicsImpostor;
  91962. /**
  91963. * Gets the radius of the physics imposter
  91964. * @returns Radius of the physics imposter
  91965. */
  91966. getRadius(): number;
  91967. /**
  91968. * Sync a bone with this impostor
  91969. * @param bone The bone to sync to the impostor.
  91970. * @param boneMesh The mesh that the bone is influencing.
  91971. * @param jointPivot The pivot of the joint / bone in local space.
  91972. * @param distToJoint Optional distance from the impostor to the joint.
  91973. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  91974. */
  91975. syncBoneWithImpostor(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion): void;
  91976. /**
  91977. * Sync impostor to a bone
  91978. * @param bone The bone that the impostor will be synced to.
  91979. * @param boneMesh The mesh that the bone is influencing.
  91980. * @param jointPivot The pivot of the joint / bone in local space.
  91981. * @param distToJoint Optional distance from the impostor to the joint.
  91982. * @param adjustRotation Optional quaternion for adjusting the local rotation of the bone.
  91983. * @param boneAxis Optional vector3 axis the bone is aligned with
  91984. */
  91985. syncImpostorWithBone(bone: Bone, boneMesh: AbstractMesh, jointPivot: Vector3, distToJoint?: number, adjustRotation?: Quaternion, boneAxis?: Vector3): void;
  91986. /**
  91987. * No-Imposter type
  91988. */
  91989. static NoImpostor: number;
  91990. /**
  91991. * Sphere-Imposter type
  91992. */
  91993. static SphereImpostor: number;
  91994. /**
  91995. * Box-Imposter type
  91996. */
  91997. static BoxImpostor: number;
  91998. /**
  91999. * Plane-Imposter type
  92000. */
  92001. static PlaneImpostor: number;
  92002. /**
  92003. * Mesh-imposter type
  92004. */
  92005. static MeshImpostor: number;
  92006. /**
  92007. * Capsule-Impostor type (Ammo.js plugin only)
  92008. */
  92009. static CapsuleImpostor: number;
  92010. /**
  92011. * Cylinder-Imposter type
  92012. */
  92013. static CylinderImpostor: number;
  92014. /**
  92015. * Particle-Imposter type
  92016. */
  92017. static ParticleImpostor: number;
  92018. /**
  92019. * Heightmap-Imposter type
  92020. */
  92021. static HeightmapImpostor: number;
  92022. /**
  92023. * ConvexHull-Impostor type (Ammo.js plugin only)
  92024. */
  92025. static ConvexHullImpostor: number;
  92026. /**
  92027. * Rope-Imposter type
  92028. */
  92029. static RopeImpostor: number;
  92030. /**
  92031. * Cloth-Imposter type
  92032. */
  92033. static ClothImpostor: number;
  92034. /**
  92035. * Softbody-Imposter type
  92036. */
  92037. static SoftbodyImpostor: number;
  92038. }
  92039. }
  92040. declare module BABYLON {
  92041. /**
  92042. * @hidden
  92043. **/
  92044. export class _CreationDataStorage {
  92045. closePath?: boolean;
  92046. closeArray?: boolean;
  92047. idx: number[];
  92048. dashSize: number;
  92049. gapSize: number;
  92050. path3D: Path3D;
  92051. pathArray: Vector3[][];
  92052. arc: number;
  92053. radius: number;
  92054. cap: number;
  92055. tessellation: number;
  92056. }
  92057. /**
  92058. * @hidden
  92059. **/
  92060. class _InstanceDataStorage {
  92061. visibleInstances: any;
  92062. batchCache: _InstancesBatch;
  92063. instancesBufferSize: number;
  92064. instancesBuffer: Nullable<Buffer>;
  92065. instancesData: Float32Array;
  92066. overridenInstanceCount: number;
  92067. isFrozen: boolean;
  92068. previousBatch: Nullable<_InstancesBatch>;
  92069. hardwareInstancedRendering: boolean;
  92070. sideOrientation: number;
  92071. manualUpdate: boolean;
  92072. }
  92073. /**
  92074. * @hidden
  92075. **/
  92076. export class _InstancesBatch {
  92077. mustReturn: boolean;
  92078. visibleInstances: Nullable<InstancedMesh[]>[];
  92079. renderSelf: boolean[];
  92080. hardwareInstancedRendering: boolean[];
  92081. }
  92082. /**
  92083. * Class used to represent renderable models
  92084. */
  92085. export class Mesh extends AbstractMesh implements IGetSetVerticesData {
  92086. /**
  92087. * Mesh side orientation : usually the external or front surface
  92088. */
  92089. static readonly FRONTSIDE: number;
  92090. /**
  92091. * Mesh side orientation : usually the internal or back surface
  92092. */
  92093. static readonly BACKSIDE: number;
  92094. /**
  92095. * Mesh side orientation : both internal and external or front and back surfaces
  92096. */
  92097. static readonly DOUBLESIDE: number;
  92098. /**
  92099. * Mesh side orientation : by default, `FRONTSIDE`
  92100. */
  92101. static readonly DEFAULTSIDE: number;
  92102. /**
  92103. * Mesh cap setting : no cap
  92104. */
  92105. static readonly NO_CAP: number;
  92106. /**
  92107. * Mesh cap setting : one cap at the beginning of the mesh
  92108. */
  92109. static readonly CAP_START: number;
  92110. /**
  92111. * Mesh cap setting : one cap at the end of the mesh
  92112. */
  92113. static readonly CAP_END: number;
  92114. /**
  92115. * Mesh cap setting : two caps, one at the beginning and one at the end of the mesh
  92116. */
  92117. static readonly CAP_ALL: number;
  92118. /**
  92119. * Mesh pattern setting : no flip or rotate
  92120. */
  92121. static readonly NO_FLIP: number;
  92122. /**
  92123. * Mesh pattern setting : flip (reflect in y axis) alternate tiles on each row or column
  92124. */
  92125. static readonly FLIP_TILE: number;
  92126. /**
  92127. * Mesh pattern setting : rotate (180degs) alternate tiles on each row or column
  92128. */
  92129. static readonly ROTATE_TILE: number;
  92130. /**
  92131. * Mesh pattern setting : flip (reflect in y axis) all tiles on alternate rows
  92132. */
  92133. static readonly FLIP_ROW: number;
  92134. /**
  92135. * Mesh pattern setting : rotate (180degs) all tiles on alternate rows
  92136. */
  92137. static readonly ROTATE_ROW: number;
  92138. /**
  92139. * Mesh pattern setting : flip and rotate alternate tiles on each row or column
  92140. */
  92141. static readonly FLIP_N_ROTATE_TILE: number;
  92142. /**
  92143. * Mesh pattern setting : rotate pattern and rotate
  92144. */
  92145. static readonly FLIP_N_ROTATE_ROW: number;
  92146. /**
  92147. * Mesh tile positioning : part tiles same on left/right or top/bottom
  92148. */
  92149. static readonly CENTER: number;
  92150. /**
  92151. * Mesh tile positioning : part tiles on left
  92152. */
  92153. static readonly LEFT: number;
  92154. /**
  92155. * Mesh tile positioning : part tiles on right
  92156. */
  92157. static readonly RIGHT: number;
  92158. /**
  92159. * Mesh tile positioning : part tiles on top
  92160. */
  92161. static readonly TOP: number;
  92162. /**
  92163. * Mesh tile positioning : part tiles on bottom
  92164. */
  92165. static readonly BOTTOM: number;
  92166. /**
  92167. * Gets the default side orientation.
  92168. * @param orientation the orientation to value to attempt to get
  92169. * @returns the default orientation
  92170. * @hidden
  92171. */
  92172. static _GetDefaultSideOrientation(orientation?: number): number;
  92173. private _internalMeshDataInfo;
  92174. /**
  92175. * An event triggered before rendering the mesh
  92176. */
  92177. readonly onBeforeRenderObservable: Observable<Mesh>;
  92178. /**
  92179. * An event triggered before binding the mesh
  92180. */
  92181. readonly onBeforeBindObservable: Observable<Mesh>;
  92182. /**
  92183. * An event triggered after rendering the mesh
  92184. */
  92185. readonly onAfterRenderObservable: Observable<Mesh>;
  92186. /**
  92187. * An event triggered before drawing the mesh
  92188. */
  92189. readonly onBeforeDrawObservable: Observable<Mesh>;
  92190. private _onBeforeDrawObserver;
  92191. /**
  92192. * Sets a callback to call before drawing the mesh. It is recommended to use onBeforeDrawObservable instead
  92193. */
  92194. onBeforeDraw: () => void;
  92195. readonly hasInstances: boolean;
  92196. /**
  92197. * Gets the delay loading state of the mesh (when delay loading is turned on)
  92198. * @see http://doc.babylonjs.com/how_to/using_the_incremental_loading_system
  92199. */
  92200. delayLoadState: number;
  92201. /**
  92202. * Gets the list of instances created from this mesh
  92203. * it is not supposed to be modified manually.
  92204. * Note also that the order of the InstancedMesh wihin the array is not significant and might change.
  92205. * @see http://doc.babylonjs.com/how_to/how_to_use_instances
  92206. */
  92207. instances: InstancedMesh[];
  92208. /**
  92209. * Gets the file containing delay loading data for this mesh
  92210. */
  92211. delayLoadingFile: string;
  92212. /** @hidden */
  92213. _binaryInfo: any;
  92214. /**
  92215. * User defined function used to change how LOD level selection is done
  92216. * @see http://doc.babylonjs.com/how_to/how_to_use_lod
  92217. */
  92218. onLODLevelSelection: (distance: number, mesh: Mesh, selectedLevel: Nullable<Mesh>) => void;
  92219. /**
  92220. * Gets or sets the morph target manager
  92221. * @see http://doc.babylonjs.com/how_to/how_to_use_morphtargets
  92222. */
  92223. morphTargetManager: Nullable<MorphTargetManager>;
  92224. /** @hidden */
  92225. _creationDataStorage: Nullable<_CreationDataStorage>;
  92226. /** @hidden */
  92227. _geometry: Nullable<Geometry>;
  92228. /** @hidden */
  92229. _delayInfo: Array<string>;
  92230. /** @hidden */
  92231. _delayLoadingFunction: (any: any, mesh: Mesh) => void;
  92232. /** @hidden */
  92233. _instanceDataStorage: _InstanceDataStorage;
  92234. private _effectiveMaterial;
  92235. /** @hidden */
  92236. _shouldGenerateFlatShading: boolean;
  92237. /** @hidden */
  92238. _originalBuilderSideOrientation: number;
  92239. /**
  92240. * Use this property to change the original side orientation defined at construction time
  92241. */
  92242. overrideMaterialSideOrientation: Nullable<number>;
  92243. /**
  92244. * Gets the source mesh (the one used to clone this one from)
  92245. */
  92246. readonly source: Nullable<Mesh>;
  92247. /**
  92248. * Gets or sets a boolean indicating that this mesh does not use index buffer
  92249. */
  92250. isUnIndexed: boolean;
  92251. /** Gets the array buffer used to store the instanced buffer used for instances' world matrices */
  92252. readonly worldMatrixInstancedBuffer: Float32Array;
  92253. /** Gets or sets a boolean indicating that the update of the instance buffer of the world matrices is manual */
  92254. manualUpdateOfWorldMatrixInstancedBuffer: boolean;
  92255. /**
  92256. * @constructor
  92257. * @param name The value used by scene.getMeshByName() to do a lookup.
  92258. * @param scene The scene to add this mesh to.
  92259. * @param parent The parent of this mesh, if it has one
  92260. * @param source An optional Mesh from which geometry is shared, cloned.
  92261. * @param doNotCloneChildren When cloning, skip cloning child meshes of source, default False.
  92262. * When false, achieved by calling a clone(), also passing False.
  92263. * This will make creation of children, recursive.
  92264. * @param clonePhysicsImpostor When cloning, include cloning mesh physics impostor, default True.
  92265. */
  92266. constructor(name: string, scene?: Nullable<Scene>, parent?: Nullable<Node>, source?: Nullable<Mesh>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean);
  92267. instantiateHierarchy(newParent?: Nullable<TransformNode>, options?: {
  92268. doNotInstantiate: boolean;
  92269. }, onNewNodeCreated?: (source: TransformNode, clone: TransformNode) => void): Nullable<TransformNode>;
  92270. /**
  92271. * Gets the class name
  92272. * @returns the string "Mesh".
  92273. */
  92274. getClassName(): string;
  92275. /** @hidden */
  92276. readonly _isMesh: boolean;
  92277. /**
  92278. * Returns a description of this mesh
  92279. * @param fullDetails define if full details about this mesh must be used
  92280. * @returns a descriptive string representing this mesh
  92281. */
  92282. toString(fullDetails?: boolean): string;
  92283. /** @hidden */
  92284. _unBindEffect(): void;
  92285. /**
  92286. * Gets a boolean indicating if this mesh has LOD
  92287. */
  92288. readonly hasLODLevels: boolean;
  92289. /**
  92290. * Gets the list of MeshLODLevel associated with the current mesh
  92291. * @returns an array of MeshLODLevel
  92292. */
  92293. getLODLevels(): MeshLODLevel[];
  92294. private _sortLODLevels;
  92295. /**
  92296. * Add a mesh as LOD level triggered at the given distance.
  92297. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  92298. * @param distance The distance from the center of the object to show this level
  92299. * @param mesh The mesh to be added as LOD level (can be null)
  92300. * @return This mesh (for chaining)
  92301. */
  92302. addLODLevel(distance: number, mesh: Nullable<Mesh>): Mesh;
  92303. /**
  92304. * Returns the LOD level mesh at the passed distance or null if not found.
  92305. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  92306. * @param distance The distance from the center of the object to show this level
  92307. * @returns a Mesh or `null`
  92308. */
  92309. getLODLevelAtDistance(distance: number): Nullable<Mesh>;
  92310. /**
  92311. * Remove a mesh from the LOD array
  92312. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  92313. * @param mesh defines the mesh to be removed
  92314. * @return This mesh (for chaining)
  92315. */
  92316. removeLODLevel(mesh: Mesh): Mesh;
  92317. /**
  92318. * Returns the registered LOD mesh distant from the parameter `camera` position if any, else returns the current mesh.
  92319. * @see https://doc.babylonjs.com/how_to/how_to_use_lod
  92320. * @param camera defines the camera to use to compute distance
  92321. * @param boundingSphere defines a custom bounding sphere to use instead of the one from this mesh
  92322. * @return This mesh (for chaining)
  92323. */
  92324. getLOD(camera: Camera, boundingSphere?: BoundingSphere): Nullable<AbstractMesh>;
  92325. /**
  92326. * Gets the mesh internal Geometry object
  92327. */
  92328. readonly geometry: Nullable<Geometry>;
  92329. /**
  92330. * Returns the total number of vertices within the mesh geometry or zero if the mesh has no geometry.
  92331. * @returns the total number of vertices
  92332. */
  92333. getTotalVertices(): number;
  92334. /**
  92335. * Returns the content of an associated vertex buffer
  92336. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  92337. * - VertexBuffer.PositionKind
  92338. * - VertexBuffer.UVKind
  92339. * - VertexBuffer.UV2Kind
  92340. * - VertexBuffer.UV3Kind
  92341. * - VertexBuffer.UV4Kind
  92342. * - VertexBuffer.UV5Kind
  92343. * - VertexBuffer.UV6Kind
  92344. * - VertexBuffer.ColorKind
  92345. * - VertexBuffer.MatricesIndicesKind
  92346. * - VertexBuffer.MatricesIndicesExtraKind
  92347. * - VertexBuffer.MatricesWeightsKind
  92348. * - VertexBuffer.MatricesWeightsExtraKind
  92349. * @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
  92350. * @param forceCopy defines a boolean forcing the copy of the buffer no matter what the value of copyWhenShared is
  92351. * @returns a FloatArray or null if the mesh has no geometry or no vertex buffer for this kind.
  92352. */
  92353. getVerticesData(kind: string, copyWhenShared?: boolean, forceCopy?: boolean): Nullable<FloatArray>;
  92354. /**
  92355. * Returns the mesh VertexBuffer object from the requested `kind`
  92356. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  92357. * - VertexBuffer.PositionKind
  92358. * - VertexBuffer.NormalKind
  92359. * - VertexBuffer.UVKind
  92360. * - VertexBuffer.UV2Kind
  92361. * - VertexBuffer.UV3Kind
  92362. * - VertexBuffer.UV4Kind
  92363. * - VertexBuffer.UV5Kind
  92364. * - VertexBuffer.UV6Kind
  92365. * - VertexBuffer.ColorKind
  92366. * - VertexBuffer.MatricesIndicesKind
  92367. * - VertexBuffer.MatricesIndicesExtraKind
  92368. * - VertexBuffer.MatricesWeightsKind
  92369. * - VertexBuffer.MatricesWeightsExtraKind
  92370. * @returns a FloatArray or null if the mesh has no vertex buffer for this kind.
  92371. */
  92372. getVertexBuffer(kind: string): Nullable<VertexBuffer>;
  92373. /**
  92374. * Tests if a specific vertex buffer is associated with this mesh
  92375. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  92376. * - VertexBuffer.PositionKind
  92377. * - VertexBuffer.NormalKind
  92378. * - VertexBuffer.UVKind
  92379. * - VertexBuffer.UV2Kind
  92380. * - VertexBuffer.UV3Kind
  92381. * - VertexBuffer.UV4Kind
  92382. * - VertexBuffer.UV5Kind
  92383. * - VertexBuffer.UV6Kind
  92384. * - VertexBuffer.ColorKind
  92385. * - VertexBuffer.MatricesIndicesKind
  92386. * - VertexBuffer.MatricesIndicesExtraKind
  92387. * - VertexBuffer.MatricesWeightsKind
  92388. * - VertexBuffer.MatricesWeightsExtraKind
  92389. * @returns a boolean
  92390. */
  92391. isVerticesDataPresent(kind: string): boolean;
  92392. /**
  92393. * Returns a boolean defining if the vertex data for the requested `kind` is updatable.
  92394. * @param kind defines which buffer to check (positions, indices, normals, etc). Possible `kind` values :
  92395. * - VertexBuffer.PositionKind
  92396. * - VertexBuffer.UVKind
  92397. * - VertexBuffer.UV2Kind
  92398. * - VertexBuffer.UV3Kind
  92399. * - VertexBuffer.UV4Kind
  92400. * - VertexBuffer.UV5Kind
  92401. * - VertexBuffer.UV6Kind
  92402. * - VertexBuffer.ColorKind
  92403. * - VertexBuffer.MatricesIndicesKind
  92404. * - VertexBuffer.MatricesIndicesExtraKind
  92405. * - VertexBuffer.MatricesWeightsKind
  92406. * - VertexBuffer.MatricesWeightsExtraKind
  92407. * @returns a boolean
  92408. */
  92409. isVertexBufferUpdatable(kind: string): boolean;
  92410. /**
  92411. * Returns a string which contains the list of existing `kinds` of Vertex Data associated with this mesh.
  92412. * @param kind defines which buffer to read from (positions, indices, normals, etc). Possible `kind` values :
  92413. * - VertexBuffer.PositionKind
  92414. * - VertexBuffer.NormalKind
  92415. * - VertexBuffer.UVKind
  92416. * - VertexBuffer.UV2Kind
  92417. * - VertexBuffer.UV3Kind
  92418. * - VertexBuffer.UV4Kind
  92419. * - VertexBuffer.UV5Kind
  92420. * - VertexBuffer.UV6Kind
  92421. * - VertexBuffer.ColorKind
  92422. * - VertexBuffer.MatricesIndicesKind
  92423. * - VertexBuffer.MatricesIndicesExtraKind
  92424. * - VertexBuffer.MatricesWeightsKind
  92425. * - VertexBuffer.MatricesWeightsExtraKind
  92426. * @returns an array of strings
  92427. */
  92428. getVerticesDataKinds(): string[];
  92429. /**
  92430. * Returns a positive integer : the total number of indices in this mesh geometry.
  92431. * @returns the numner of indices or zero if the mesh has no geometry.
  92432. */
  92433. getTotalIndices(): number;
  92434. /**
  92435. * Returns an array of integers or a typed array (Int32Array, Uint32Array, Uint16Array) populated with the mesh indices.
  92436. * @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.
  92437. * @param forceCopy defines a boolean indicating that the returned array must be cloned upon returning it
  92438. * @returns the indices array or an empty array if the mesh has no geometry
  92439. */
  92440. getIndices(copyWhenShared?: boolean, forceCopy?: boolean): Nullable<IndicesArray>;
  92441. readonly isBlocked: boolean;
  92442. /**
  92443. * Determine if the current mesh is ready to be rendered
  92444. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  92445. * @param forceInstanceSupport will check if the mesh will be ready when used with instances (false by default)
  92446. * @returns true if all associated assets are ready (material, textures, shaders)
  92447. */
  92448. isReady(completeCheck?: boolean, forceInstanceSupport?: boolean): boolean;
  92449. /**
  92450. * 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.
  92451. */
  92452. readonly areNormalsFrozen: boolean;
  92453. /**
  92454. * 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.
  92455. * @returns the current mesh
  92456. */
  92457. freezeNormals(): Mesh;
  92458. /**
  92459. * 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
  92460. * @returns the current mesh
  92461. */
  92462. unfreezeNormals(): Mesh;
  92463. /**
  92464. * Sets a value overriding the instance count. Only applicable when custom instanced InterleavedVertexBuffer are used rather than InstancedMeshs
  92465. */
  92466. overridenInstanceCount: number;
  92467. /** @hidden */
  92468. _preActivate(): Mesh;
  92469. /** @hidden */
  92470. _preActivateForIntermediateRendering(renderId: number): Mesh;
  92471. /** @hidden */
  92472. _registerInstanceForRenderId(instance: InstancedMesh, renderId: number): Mesh;
  92473. /**
  92474. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  92475. * This means the mesh underlying bounding box and sphere are recomputed.
  92476. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  92477. * @returns the current mesh
  92478. */
  92479. refreshBoundingInfo(applySkeleton?: boolean): Mesh;
  92480. /** @hidden */
  92481. _createGlobalSubMesh(force: boolean): Nullable<SubMesh>;
  92482. /**
  92483. * This function will subdivide the mesh into multiple submeshes
  92484. * @param count defines the expected number of submeshes
  92485. */
  92486. subdivide(count: number): void;
  92487. /**
  92488. * Copy a FloatArray into a specific associated vertex buffer
  92489. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  92490. * - VertexBuffer.PositionKind
  92491. * - VertexBuffer.UVKind
  92492. * - VertexBuffer.UV2Kind
  92493. * - VertexBuffer.UV3Kind
  92494. * - VertexBuffer.UV4Kind
  92495. * - VertexBuffer.UV5Kind
  92496. * - VertexBuffer.UV6Kind
  92497. * - VertexBuffer.ColorKind
  92498. * - VertexBuffer.MatricesIndicesKind
  92499. * - VertexBuffer.MatricesIndicesExtraKind
  92500. * - VertexBuffer.MatricesWeightsKind
  92501. * - VertexBuffer.MatricesWeightsExtraKind
  92502. * @param data defines the data source
  92503. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  92504. * @param stride defines the data stride size (can be null)
  92505. * @returns the current mesh
  92506. */
  92507. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  92508. /**
  92509. * Delete a vertex buffer associated with this mesh
  92510. * @param kind defines which buffer to delete (positions, indices, normals, etc). Possible `kind` values :
  92511. * - VertexBuffer.PositionKind
  92512. * - VertexBuffer.UVKind
  92513. * - VertexBuffer.UV2Kind
  92514. * - VertexBuffer.UV3Kind
  92515. * - VertexBuffer.UV4Kind
  92516. * - VertexBuffer.UV5Kind
  92517. * - VertexBuffer.UV6Kind
  92518. * - VertexBuffer.ColorKind
  92519. * - VertexBuffer.MatricesIndicesKind
  92520. * - VertexBuffer.MatricesIndicesExtraKind
  92521. * - VertexBuffer.MatricesWeightsKind
  92522. * - VertexBuffer.MatricesWeightsExtraKind
  92523. */
  92524. removeVerticesData(kind: string): void;
  92525. /**
  92526. * Flags an associated vertex buffer as updatable
  92527. * @param kind defines which buffer to use (positions, indices, normals, etc). Possible `kind` values :
  92528. * - VertexBuffer.PositionKind
  92529. * - VertexBuffer.UVKind
  92530. * - VertexBuffer.UV2Kind
  92531. * - VertexBuffer.UV3Kind
  92532. * - VertexBuffer.UV4Kind
  92533. * - VertexBuffer.UV5Kind
  92534. * - VertexBuffer.UV6Kind
  92535. * - VertexBuffer.ColorKind
  92536. * - VertexBuffer.MatricesIndicesKind
  92537. * - VertexBuffer.MatricesIndicesExtraKind
  92538. * - VertexBuffer.MatricesWeightsKind
  92539. * - VertexBuffer.MatricesWeightsExtraKind
  92540. * @param updatable defines if the updated vertex buffer must be flagged as updatable
  92541. */
  92542. markVerticesDataAsUpdatable(kind: string, updatable?: boolean): void;
  92543. /**
  92544. * Sets the mesh global Vertex Buffer
  92545. * @param buffer defines the buffer to use
  92546. * @returns the current mesh
  92547. */
  92548. setVerticesBuffer(buffer: VertexBuffer): Mesh;
  92549. /**
  92550. * Update a specific associated vertex buffer
  92551. * @param kind defines which buffer to write to (positions, indices, normals, etc). Possible `kind` values :
  92552. * - VertexBuffer.PositionKind
  92553. * - VertexBuffer.UVKind
  92554. * - VertexBuffer.UV2Kind
  92555. * - VertexBuffer.UV3Kind
  92556. * - VertexBuffer.UV4Kind
  92557. * - VertexBuffer.UV5Kind
  92558. * - VertexBuffer.UV6Kind
  92559. * - VertexBuffer.ColorKind
  92560. * - VertexBuffer.MatricesIndicesKind
  92561. * - VertexBuffer.MatricesIndicesExtraKind
  92562. * - VertexBuffer.MatricesWeightsKind
  92563. * - VertexBuffer.MatricesWeightsExtraKind
  92564. * @param data defines the data source
  92565. * @param updateExtends defines if extends info of the mesh must be updated (can be null). This is mostly useful for "position" kind
  92566. * @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)
  92567. * @returns the current mesh
  92568. */
  92569. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  92570. /**
  92571. * This method updates the vertex positions of an updatable mesh according to the `positionFunction` returned values.
  92572. * @see http://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh#other-shapes-updatemeshpositions
  92573. * @param positionFunction is a simple JS function what is passed the mesh `positions` array. It doesn't need to return anything
  92574. * @param computeNormals is a boolean (default true) to enable/disable the mesh normal recomputation after the vertex position update
  92575. * @returns the current mesh
  92576. */
  92577. updateMeshPositions(positionFunction: (data: FloatArray) => void, computeNormals?: boolean): Mesh;
  92578. /**
  92579. * Creates a un-shared specific occurence of the geometry for the mesh.
  92580. * @returns the current mesh
  92581. */
  92582. makeGeometryUnique(): Mesh;
  92583. /**
  92584. * Set the index buffer of this mesh
  92585. * @param indices defines the source data
  92586. * @param totalVertices defines the total number of vertices referenced by this index data (can be null)
  92587. * @param updatable defines if the updated index buffer must be flagged as updatable (default is false)
  92588. * @returns the current mesh
  92589. */
  92590. setIndices(indices: IndicesArray, totalVertices?: Nullable<number>, updatable?: boolean): AbstractMesh;
  92591. /**
  92592. * Update the current index buffer
  92593. * @param indices defines the source data
  92594. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  92595. * @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)
  92596. * @returns the current mesh
  92597. */
  92598. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  92599. /**
  92600. * Invert the geometry to move from a right handed system to a left handed one.
  92601. * @returns the current mesh
  92602. */
  92603. toLeftHanded(): Mesh;
  92604. /** @hidden */
  92605. _bind(subMesh: SubMesh, effect: Effect, fillMode: number): Mesh;
  92606. /** @hidden */
  92607. _draw(subMesh: SubMesh, fillMode: number, instancesCount?: number): Mesh;
  92608. /**
  92609. * Registers for this mesh a javascript function called just before the rendering process
  92610. * @param func defines the function to call before rendering this mesh
  92611. * @returns the current mesh
  92612. */
  92613. registerBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  92614. /**
  92615. * Disposes a previously registered javascript function called before the rendering
  92616. * @param func defines the function to remove
  92617. * @returns the current mesh
  92618. */
  92619. unregisterBeforeRender(func: (mesh: AbstractMesh) => void): Mesh;
  92620. /**
  92621. * Registers for this mesh a javascript function called just after the rendering is complete
  92622. * @param func defines the function to call after rendering this mesh
  92623. * @returns the current mesh
  92624. */
  92625. registerAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  92626. /**
  92627. * Disposes a previously registered javascript function called after the rendering.
  92628. * @param func defines the function to remove
  92629. * @returns the current mesh
  92630. */
  92631. unregisterAfterRender(func: (mesh: AbstractMesh) => void): Mesh;
  92632. /** @hidden */
  92633. _getInstancesRenderList(subMeshId: number, isReplacementMode?: boolean): _InstancesBatch;
  92634. /** @hidden */
  92635. _renderWithInstances(subMesh: SubMesh, fillMode: number, batch: _InstancesBatch, effect: Effect, engine: Engine): Mesh;
  92636. /** @hidden */
  92637. _processInstancedBuffers(visibleInstances: InstancedMesh[], renderSelf: boolean): void;
  92638. /** @hidden */
  92639. _processRendering(subMesh: SubMesh, effect: Effect, fillMode: number, batch: _InstancesBatch, hardwareInstancedRendering: boolean, onBeforeDraw: (isInstance: boolean, world: Matrix, effectiveMaterial?: Material) => void, effectiveMaterial?: Material): Mesh;
  92640. /** @hidden */
  92641. _rebuild(): void;
  92642. /** @hidden */
  92643. _freeze(): void;
  92644. /** @hidden */
  92645. _unFreeze(): void;
  92646. /**
  92647. * 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
  92648. * @param subMesh defines the subMesh to render
  92649. * @param enableAlphaMode defines if alpha mode can be changed
  92650. * @param effectiveMeshReplacement defines an optional mesh used to provide info for the rendering
  92651. * @returns the current mesh
  92652. */
  92653. render(subMesh: SubMesh, enableAlphaMode: boolean, effectiveMeshReplacement?: AbstractMesh): Mesh;
  92654. private _onBeforeDraw;
  92655. /**
  92656. * Renormalize the mesh and patch it up if there are no weights
  92657. * Similar to normalization by adding the weights compute the reciprocal and multiply all elements, this wil ensure that everything adds to 1.
  92658. * However in the case of zero weights then we set just a single influence to 1.
  92659. * We check in the function for extra's present and if so we use the normalizeSkinWeightsWithExtras rather than the FourWeights version.
  92660. */
  92661. cleanMatrixWeights(): void;
  92662. private normalizeSkinFourWeights;
  92663. private normalizeSkinWeightsAndExtra;
  92664. /**
  92665. * ValidateSkinning is used to determine that a mesh has valid skinning data along with skin metrics, if missing weights,
  92666. * or not normalized it is returned as invalid mesh the string can be used for console logs, or on screen messages to let
  92667. * the user know there was an issue with importing the mesh
  92668. * @returns a validation object with skinned, valid and report string
  92669. */
  92670. validateSkinning(): {
  92671. skinned: boolean;
  92672. valid: boolean;
  92673. report: string;
  92674. };
  92675. /** @hidden */
  92676. _checkDelayState(): Mesh;
  92677. private _queueLoad;
  92678. /**
  92679. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  92680. * A mesh is in the frustum if its bounding box intersects the frustum
  92681. * @param frustumPlanes defines the frustum to test
  92682. * @returns true if the mesh is in the frustum planes
  92683. */
  92684. isInFrustum(frustumPlanes: Plane[]): boolean;
  92685. /**
  92686. * Sets the mesh material by the material or multiMaterial `id` property
  92687. * @param id is a string identifying the material or the multiMaterial
  92688. * @returns the current mesh
  92689. */
  92690. setMaterialByID(id: string): Mesh;
  92691. /**
  92692. * Returns as a new array populated with the mesh material and/or skeleton, if any.
  92693. * @returns an array of IAnimatable
  92694. */
  92695. getAnimatables(): IAnimatable[];
  92696. /**
  92697. * Modifies the mesh geometry according to the passed transformation matrix.
  92698. * This method returns nothing but it really modifies the mesh even if it's originally not set as updatable.
  92699. * The mesh normals are modified using the same transformation.
  92700. * Note that, under the hood, this method sets a new VertexBuffer each call.
  92701. * @param transform defines the transform matrix to use
  92702. * @see http://doc.babylonjs.com/resources/baking_transformations
  92703. * @returns the current mesh
  92704. */
  92705. bakeTransformIntoVertices(transform: Matrix): Mesh;
  92706. /**
  92707. * Modifies the mesh geometry according to its own current World Matrix.
  92708. * The mesh World Matrix is then reset.
  92709. * This method returns nothing but really modifies the mesh even if it's originally not set as updatable.
  92710. * Note that, under the hood, this method sets a new VertexBuffer each call.
  92711. * @see http://doc.babylonjs.com/resources/baking_transformations
  92712. * @returns the current mesh
  92713. */
  92714. bakeCurrentTransformIntoVertices(): Mesh;
  92715. /** @hidden */
  92716. readonly _positions: Nullable<Vector3[]>;
  92717. /** @hidden */
  92718. _resetPointsArrayCache(): Mesh;
  92719. /** @hidden */
  92720. _generatePointsArray(): boolean;
  92721. /**
  92722. * Returns a new Mesh object generated from the current mesh properties.
  92723. * This method must not get confused with createInstance()
  92724. * @param name is a string, the name given to the new mesh
  92725. * @param newParent can be any Node object (default `null`)
  92726. * @param doNotCloneChildren allows/denies the recursive cloning of the original mesh children if any (default `false`)
  92727. * @param clonePhysicsImpostor allows/denies the cloning in the same time of the original mesh `body` used by the physics engine, if any (default `true`)
  92728. * @returns a new mesh
  92729. */
  92730. clone(name?: string, newParent?: Nullable<Node>, doNotCloneChildren?: boolean, clonePhysicsImpostor?: boolean): Nullable<AbstractMesh>;
  92731. /**
  92732. * Releases resources associated with this mesh.
  92733. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  92734. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  92735. */
  92736. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  92737. /** @hidden */
  92738. _disposeInstanceSpecificData(): void;
  92739. /**
  92740. * Modifies the mesh geometry according to a displacement map.
  92741. * 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.
  92742. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  92743. * @param url is a string, the URL from the image file is to be downloaded.
  92744. * @param minHeight is the lower limit of the displacement.
  92745. * @param maxHeight is the upper limit of the displacement.
  92746. * @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.
  92747. * @param uvOffset is an optional vector2 used to offset UV.
  92748. * @param uvScale is an optional vector2 used to scale UV.
  92749. * @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.
  92750. * @returns the Mesh.
  92751. */
  92752. applyDisplacementMap(url: string, minHeight: number, maxHeight: number, onSuccess?: (mesh: Mesh) => void, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  92753. /**
  92754. * Modifies the mesh geometry according to a displacementMap buffer.
  92755. * 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.
  92756. * The mesh must be set as updatable. Its internal geometry is directly modified, no new buffer are allocated.
  92757. * @param buffer is a `Uint8Array` buffer containing series of `Uint8` lower than 255, the red, green, blue and alpha values of each successive pixel.
  92758. * @param heightMapWidth is the width of the buffer image.
  92759. * @param heightMapHeight is the height of the buffer image.
  92760. * @param minHeight is the lower limit of the displacement.
  92761. * @param maxHeight is the upper limit of the displacement.
  92762. * @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.
  92763. * @param uvOffset is an optional vector2 used to offset UV.
  92764. * @param uvScale is an optional vector2 used to scale UV.
  92765. * @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.
  92766. * @returns the Mesh.
  92767. */
  92768. applyDisplacementMapFromBuffer(buffer: Uint8Array, heightMapWidth: number, heightMapHeight: number, minHeight: number, maxHeight: number, uvOffset?: Vector2, uvScale?: Vector2, forceUpdate?: boolean): Mesh;
  92769. /**
  92770. * Modify the mesh to get a flat shading rendering.
  92771. * This means each mesh facet will then have its own normals. Usually new vertices are added in the mesh geometry to get this result.
  92772. * Warning : the mesh is really modified even if not set originally as updatable and, under the hood, a new VertexBuffer is allocated.
  92773. * @returns current mesh
  92774. */
  92775. convertToFlatShadedMesh(): Mesh;
  92776. /**
  92777. * This method removes all the mesh indices and add new vertices (duplication) in order to unfold facets into buffers.
  92778. * In other words, more vertices, no more indices and a single bigger VBO.
  92779. * The mesh is really modified even if not set originally as updatable. Under the hood, a new VertexBuffer is allocated.
  92780. * @returns current mesh
  92781. */
  92782. convertToUnIndexedMesh(): Mesh;
  92783. /**
  92784. * Inverses facet orientations.
  92785. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  92786. * @param flipNormals will also inverts the normals
  92787. * @returns current mesh
  92788. */
  92789. flipFaces(flipNormals?: boolean): Mesh;
  92790. /**
  92791. * Increase the number of facets and hence vertices in a mesh
  92792. * Vertex normals are interpolated from existing vertex normals
  92793. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  92794. * @param numberPerEdge the number of new vertices to add to each edge of a facet, optional default 1
  92795. */
  92796. increaseVertices(numberPerEdge: number): void;
  92797. /**
  92798. * Force adjacent facets to share vertices and remove any facets that have all vertices in a line
  92799. * This will undo any application of covertToFlatShadedMesh
  92800. * Warning : the mesh is really modified even if not set originally as updatable. A new VertexBuffer is created under the hood each call.
  92801. */
  92802. forceSharedVertices(): void;
  92803. /** @hidden */
  92804. static _instancedMeshFactory(name: string, mesh: Mesh): InstancedMesh;
  92805. /** @hidden */
  92806. static _PhysicsImpostorParser(scene: Scene, physicObject: IPhysicsEnabledObject, jsonObject: any): PhysicsImpostor;
  92807. /**
  92808. * Creates a new InstancedMesh object from the mesh model.
  92809. * @see http://doc.babylonjs.com/how_to/how_to_use_instances
  92810. * @param name defines the name of the new instance
  92811. * @returns a new InstancedMesh
  92812. */
  92813. createInstance(name: string): InstancedMesh;
  92814. /**
  92815. * Synchronises all the mesh instance submeshes to the current mesh submeshes, if any.
  92816. * After this call, all the mesh instances have the same submeshes than the current mesh.
  92817. * @returns the current mesh
  92818. */
  92819. synchronizeInstances(): Mesh;
  92820. /**
  92821. * Optimization of the mesh's indices, in case a mesh has duplicated vertices.
  92822. * The function will only reorder the indices and will not remove unused vertices to avoid problems with submeshes.
  92823. * This should be used together with the simplification to avoid disappearing triangles.
  92824. * @param successCallback an optional success callback to be called after the optimization finished.
  92825. * @returns the current mesh
  92826. */
  92827. optimizeIndices(successCallback?: (mesh?: Mesh) => void): Mesh;
  92828. /**
  92829. * Serialize current mesh
  92830. * @param serializationObject defines the object which will receive the serialization data
  92831. */
  92832. serialize(serializationObject: any): void;
  92833. /** @hidden */
  92834. _syncGeometryWithMorphTargetManager(): void;
  92835. /** @hidden */
  92836. static _GroundMeshParser: (parsedMesh: any, scene: Scene) => Mesh;
  92837. /**
  92838. * Returns a new Mesh object parsed from the source provided.
  92839. * @param parsedMesh is the source
  92840. * @param scene defines the hosting scene
  92841. * @param rootUrl is the root URL to prefix the `delayLoadingFile` property with
  92842. * @returns a new Mesh
  92843. */
  92844. static Parse(parsedMesh: any, scene: Scene, rootUrl: string): Mesh;
  92845. /**
  92846. * Creates a ribbon mesh. Please consider using the same method from the MeshBuilder class instead
  92847. * @see http://doc.babylonjs.com/how_to/parametric_shapes
  92848. * @param name defines the name of the mesh to create
  92849. * @param pathArray is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry.
  92850. * @param closeArray creates a seam between the first and the last paths of the path array (default is false)
  92851. * @param closePath creates a seam between the first and the last points of each path of the path array
  92852. * @param offset is taken in account only if the `pathArray` is containing a single path
  92853. * @param scene defines the hosting scene
  92854. * @param updatable defines if the mesh must be flagged as updatable
  92855. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  92856. * @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)
  92857. * @returns a new Mesh
  92858. */
  92859. static CreateRibbon(name: string, pathArray: Vector3[][], closeArray: boolean, closePath: boolean, offset: number, scene?: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  92860. /**
  92861. * Creates a plane polygonal mesh. By default, this is a disc. Please consider using the same method from the MeshBuilder class instead
  92862. * @param name defines the name of the mesh to create
  92863. * @param radius sets the radius size (float) of the polygon (default 0.5)
  92864. * @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
  92865. * @param scene defines the hosting scene
  92866. * @param updatable defines if the mesh must be flagged as updatable
  92867. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  92868. * @returns a new Mesh
  92869. */
  92870. static CreateDisc(name: string, radius: number, tessellation: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  92871. /**
  92872. * Creates a box mesh. Please consider using the same method from the MeshBuilder class instead
  92873. * @param name defines the name of the mesh to create
  92874. * @param size sets the size (float) of each box side (default 1)
  92875. * @param scene defines the hosting scene
  92876. * @param updatable defines if the mesh must be flagged as updatable
  92877. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  92878. * @returns a new Mesh
  92879. */
  92880. static CreateBox(name: string, size: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number): Mesh;
  92881. /**
  92882. * Creates a sphere mesh. Please consider using the same method from the MeshBuilder class instead
  92883. * @param name defines the name of the mesh to create
  92884. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  92885. * @param diameter sets the diameter size (float) of the sphere (default 1)
  92886. * @param scene defines the hosting scene
  92887. * @param updatable defines if the mesh must be flagged as updatable
  92888. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  92889. * @returns a new Mesh
  92890. */
  92891. static CreateSphere(name: string, segments: number, diameter: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  92892. /**
  92893. * Creates a hemisphere mesh. Please consider using the same method from the MeshBuilder class instead
  92894. * @param name defines the name of the mesh to create
  92895. * @param segments sets the sphere number of horizontal stripes (positive integer, default 32)
  92896. * @param diameter sets the diameter size (float) of the sphere (default 1)
  92897. * @param scene defines the hosting scene
  92898. * @returns a new Mesh
  92899. */
  92900. static CreateHemisphere(name: string, segments: number, diameter: number, scene?: Scene): Mesh;
  92901. /**
  92902. * Creates a cylinder or a cone mesh. Please consider using the same method from the MeshBuilder class instead
  92903. * @param name defines the name of the mesh to create
  92904. * @param height sets the height size (float) of the cylinder/cone (float, default 2)
  92905. * @param diameterTop set the top cap diameter (floats, default 1)
  92906. * @param diameterBottom set the bottom cap diameter (floats, default 1). This value can't be zero
  92907. * @param tessellation sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance
  92908. * @param subdivisions sets the number of rings along the cylinder height (positive integer, default 1)
  92909. * @param scene defines the hosting scene
  92910. * @param updatable defines if the mesh must be flagged as updatable
  92911. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  92912. * @returns a new Mesh
  92913. */
  92914. static CreateCylinder(name: string, height: number, diameterTop: number, diameterBottom: number, tessellation: number, subdivisions: any, scene?: Scene, updatable?: any, sideOrientation?: number): Mesh;
  92915. /**
  92916. * Creates a torus mesh. Please consider using the same method from the MeshBuilder class instead
  92917. * @param name defines the name of the mesh to create
  92918. * @param diameter sets the diameter size (float) of the torus (default 1)
  92919. * @param thickness sets the diameter size of the tube of the torus (float, default 0.5)
  92920. * @param tessellation sets the number of torus sides (postive integer, default 16)
  92921. * @param scene defines the hosting scene
  92922. * @param updatable defines if the mesh must be flagged as updatable
  92923. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  92924. * @returns a new Mesh
  92925. */
  92926. static CreateTorus(name: string, diameter: number, thickness: number, tessellation: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  92927. /**
  92928. * Creates a torus knot mesh. Please consider using the same method from the MeshBuilder class instead
  92929. * @param name defines the name of the mesh to create
  92930. * @param radius sets the global radius size (float) of the torus knot (default 2)
  92931. * @param tube sets the diameter size of the tube of the torus (float, default 0.5)
  92932. * @param radialSegments sets the number of sides on each tube segments (positive integer, default 32)
  92933. * @param tubularSegments sets the number of tubes to decompose the knot into (positive integer, default 32)
  92934. * @param p the number of windings on X axis (positive integers, default 2)
  92935. * @param q the number of windings on Y axis (positive integers, default 3)
  92936. * @param scene defines the hosting scene
  92937. * @param updatable defines if the mesh must be flagged as updatable
  92938. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  92939. * @returns a new Mesh
  92940. */
  92941. static CreateTorusKnot(name: string, radius: number, tube: number, radialSegments: number, tubularSegments: number, p: number, q: number, scene?: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  92942. /**
  92943. * Creates a line mesh. Please consider using the same method from the MeshBuilder class instead.
  92944. * @param name defines the name of the mesh to create
  92945. * @param points is an array successive Vector3
  92946. * @param scene defines the hosting scene
  92947. * @param updatable defines if the mesh must be flagged as updatable
  92948. * @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).
  92949. * @returns a new Mesh
  92950. */
  92951. static CreateLines(name: string, points: Vector3[], scene?: Nullable<Scene>, updatable?: boolean, instance?: Nullable<LinesMesh>): LinesMesh;
  92952. /**
  92953. * Creates a dashed line mesh. Please consider using the same method from the MeshBuilder class instead
  92954. * @param name defines the name of the mesh to create
  92955. * @param points is an array successive Vector3
  92956. * @param dashSize is the size of the dashes relatively the dash number (positive float, default 3)
  92957. * @param gapSize is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  92958. * @param dashNb is the intended total number of dashes (positive integer, default 200)
  92959. * @param scene defines the hosting scene
  92960. * @param updatable defines if the mesh must be flagged as updatable
  92961. * @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)
  92962. * @returns a new Mesh
  92963. */
  92964. static CreateDashedLines(name: string, points: Vector3[], dashSize: number, gapSize: number, dashNb: number, scene?: Nullable<Scene>, updatable?: boolean, instance?: LinesMesh): LinesMesh;
  92965. /**
  92966. * Creates a polygon mesh.Please consider using the same method from the MeshBuilder class instead
  92967. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh.
  92968. * 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.
  92969. * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  92970. * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  92971. * Remember you can only change the shape positions, not their number when updating a polygon.
  92972. * @see http://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  92973. * @param name defines the name of the mesh to create
  92974. * @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
  92975. * @param scene defines the hosting scene
  92976. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  92977. * @param updatable defines if the mesh must be flagged as updatable
  92978. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  92979. * @param earcutInjection can be used to inject your own earcut reference
  92980. * @returns a new Mesh
  92981. */
  92982. static CreatePolygon(name: string, shape: Vector3[], scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  92983. /**
  92984. * Creates an extruded polygon mesh, with depth in the Y direction. Please consider using the same method from the MeshBuilder class instead.
  92985. * @see http://doc.babylonjs.com/how_to/parametric_shapes#extruded-non-regular-polygon
  92986. * @param name defines the name of the mesh to create
  92987. * @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
  92988. * @param depth defines the height of extrusion
  92989. * @param scene defines the hosting scene
  92990. * @param holes is a required array of arrays of successive Vector3 used to defines holes in the polygon
  92991. * @param updatable defines if the mesh must be flagged as updatable
  92992. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  92993. * @param earcutInjection can be used to inject your own earcut reference
  92994. * @returns a new Mesh
  92995. */
  92996. static ExtrudePolygon(name: string, shape: Vector3[], depth: number, scene: Scene, holes?: Vector3[][], updatable?: boolean, sideOrientation?: number, earcutInjection?: any): Mesh;
  92997. /**
  92998. * Creates an extruded shape mesh.
  92999. * 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
  93000. * @see http://doc.babylonjs.com/how_to/parametric_shapes
  93001. * @see http://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  93002. * @param name defines the name of the mesh to create
  93003. * @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
  93004. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  93005. * @param scale is the value to scale the shape
  93006. * @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
  93007. * @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
  93008. * @param scene defines the hosting scene
  93009. * @param updatable defines if the mesh must be flagged as updatable
  93010. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  93011. * @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)
  93012. * @returns a new Mesh
  93013. */
  93014. static ExtrudeShape(name: string, shape: Vector3[], path: Vector3[], scale: number, rotation: number, cap: number, scene?: Nullable<Scene>, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  93015. /**
  93016. * Creates an custom extruded shape mesh.
  93017. * The custom extrusion is a parametric shape.
  93018. * It has no predefined shape. Its final shape will depend on the input parameters.
  93019. * Please consider using the same method from the MeshBuilder class instead
  93020. * @see http://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  93021. * @param name defines the name of the mesh to create
  93022. * @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
  93023. * @param path is a required array of successive Vector3. This is the axis curve the shape is extruded along
  93024. * @param scaleFunction is a custom Javascript function called on each path point
  93025. * @param rotationFunction is a custom Javascript function called on each path point
  93026. * @param ribbonCloseArray forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  93027. * @param ribbonClosePath forces the extrusion underlying ribbon to close its `pathArray`
  93028. * @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
  93029. * @param scene defines the hosting scene
  93030. * @param updatable defines if the mesh must be flagged as updatable
  93031. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  93032. * @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)
  93033. * @returns a new Mesh
  93034. */
  93035. 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;
  93036. /**
  93037. * Creates lathe mesh.
  93038. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe.
  93039. * Please consider using the same method from the MeshBuilder class instead
  93040. * @param name defines the name of the mesh to create
  93041. * @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
  93042. * @param radius is the radius value of the lathe
  93043. * @param tessellation is the side number of the lathe.
  93044. * @param scene defines the hosting scene
  93045. * @param updatable defines if the mesh must be flagged as updatable
  93046. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  93047. * @returns a new Mesh
  93048. */
  93049. static CreateLathe(name: string, shape: Vector3[], radius: number, tessellation: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  93050. /**
  93051. * Creates a plane mesh. Please consider using the same method from the MeshBuilder class instead
  93052. * @param name defines the name of the mesh to create
  93053. * @param size sets the size (float) of both sides of the plane at once (default 1)
  93054. * @param scene defines the hosting scene
  93055. * @param updatable defines if the mesh must be flagged as updatable
  93056. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  93057. * @returns a new Mesh
  93058. */
  93059. static CreatePlane(name: string, size: number, scene: Scene, updatable?: boolean, sideOrientation?: number): Mesh;
  93060. /**
  93061. * Creates a ground mesh.
  93062. * Please consider using the same method from the MeshBuilder class instead
  93063. * @param name defines the name of the mesh to create
  93064. * @param width set the width of the ground
  93065. * @param height set the height of the ground
  93066. * @param subdivisions sets the number of subdivisions per side
  93067. * @param scene defines the hosting scene
  93068. * @param updatable defines if the mesh must be flagged as updatable
  93069. * @returns a new Mesh
  93070. */
  93071. static CreateGround(name: string, width: number, height: number, subdivisions: number, scene?: Scene, updatable?: boolean): Mesh;
  93072. /**
  93073. * Creates a tiled ground mesh.
  93074. * Please consider using the same method from the MeshBuilder class instead
  93075. * @param name defines the name of the mesh to create
  93076. * @param xmin set the ground minimum X coordinate
  93077. * @param zmin set the ground minimum Y coordinate
  93078. * @param xmax set the ground maximum X coordinate
  93079. * @param zmax set the ground maximum Z coordinate
  93080. * @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
  93081. * @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
  93082. * @param scene defines the hosting scene
  93083. * @param updatable defines if the mesh must be flagged as updatable
  93084. * @returns a new Mesh
  93085. */
  93086. static CreateTiledGround(name: string, xmin: number, zmin: number, xmax: number, zmax: number, subdivisions: {
  93087. w: number;
  93088. h: number;
  93089. }, precision: {
  93090. w: number;
  93091. h: number;
  93092. }, scene: Scene, updatable?: boolean): Mesh;
  93093. /**
  93094. * Creates a ground mesh from a height map.
  93095. * Please consider using the same method from the MeshBuilder class instead
  93096. * @see http://doc.babylonjs.com/babylon101/height_map
  93097. * @param name defines the name of the mesh to create
  93098. * @param url sets the URL of the height map image resource
  93099. * @param width set the ground width size
  93100. * @param height set the ground height size
  93101. * @param subdivisions sets the number of subdivision per side
  93102. * @param minHeight is the minimum altitude on the ground
  93103. * @param maxHeight is the maximum altitude on the ground
  93104. * @param scene defines the hosting scene
  93105. * @param updatable defines if the mesh must be flagged as updatable
  93106. * @param onReady is a callback function that will be called once the mesh is built (the height map download can last some time)
  93107. * @param alphaFilter will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  93108. * @returns a new Mesh
  93109. */
  93110. 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;
  93111. /**
  93112. * Creates a tube mesh.
  93113. * The tube is a parametric shape.
  93114. * It has no predefined shape. Its final shape will depend on the input parameters.
  93115. * Please consider using the same method from the MeshBuilder class instead
  93116. * @see http://doc.babylonjs.com/how_to/parametric_shapes
  93117. * @param name defines the name of the mesh to create
  93118. * @param path is a required array of successive Vector3. It is the curve used as the axis of the tube
  93119. * @param radius sets the tube radius size
  93120. * @param tessellation is the number of sides on the tubular surface
  93121. * @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
  93122. * @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
  93123. * @param scene defines the hosting scene
  93124. * @param updatable defines if the mesh must be flagged as updatable
  93125. * @param sideOrientation defines the mesh side orientation (http://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation)
  93126. * @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)
  93127. * @returns a new Mesh
  93128. */
  93129. static CreateTube(name: string, path: Vector3[], radius: number, tessellation: number, radiusFunction: {
  93130. (i: number, distance: number): number;
  93131. }, cap: number, scene: Scene, updatable?: boolean, sideOrientation?: number, instance?: Mesh): Mesh;
  93132. /**
  93133. * Creates a polyhedron mesh.
  93134. * Please consider using the same method from the MeshBuilder class instead.
  93135. * * 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
  93136. * * The parameter `size` (positive float, default 1) sets the polygon size
  93137. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  93138. * * 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`
  93139. * * 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
  93140. * * 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)`)
  93141. * * 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
  93142. * * 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
  93143. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  93144. * * If you create a double-sided mesh, you can choose what parts of 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
  93145. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  93146. * @param name defines the name of the mesh to create
  93147. * @param options defines the options used to create the mesh
  93148. * @param scene defines the hosting scene
  93149. * @returns a new Mesh
  93150. */
  93151. static CreatePolyhedron(name: string, options: {
  93152. type?: number;
  93153. size?: number;
  93154. sizeX?: number;
  93155. sizeY?: number;
  93156. sizeZ?: number;
  93157. custom?: any;
  93158. faceUV?: Vector4[];
  93159. faceColors?: Color4[];
  93160. updatable?: boolean;
  93161. sideOrientation?: number;
  93162. }, scene: Scene): Mesh;
  93163. /**
  93164. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  93165. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  93166. * * 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`)
  93167. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  93168. * * 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
  93169. * * You can also set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  93170. * * If you create a double-sided mesh, you can choose what parts of 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
  93171. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  93172. * @param name defines the name of the mesh
  93173. * @param options defines the options used to create the mesh
  93174. * @param scene defines the hosting scene
  93175. * @returns a new Mesh
  93176. * @see http://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  93177. */
  93178. static CreateIcoSphere(name: string, options: {
  93179. radius?: number;
  93180. flat?: boolean;
  93181. subdivisions?: number;
  93182. sideOrientation?: number;
  93183. updatable?: boolean;
  93184. }, scene: Scene): Mesh;
  93185. /**
  93186. * Creates a decal mesh.
  93187. * Please consider using the same method from the MeshBuilder class instead.
  93188. * A decal is a mesh usually applied as a model onto the surface of another mesh
  93189. * @param name defines the name of the mesh
  93190. * @param sourceMesh defines the mesh receiving the decal
  93191. * @param position sets the position of the decal in world coordinates
  93192. * @param normal sets the normal of the mesh where the decal is applied onto in world coordinates
  93193. * @param size sets the decal scaling
  93194. * @param angle sets the angle to rotate the decal
  93195. * @returns a new Mesh
  93196. */
  93197. static CreateDecal(name: string, sourceMesh: AbstractMesh, position: Vector3, normal: Vector3, size: Vector3, angle: number): Mesh;
  93198. /**
  93199. * Prepare internal position array for software CPU skinning
  93200. * @returns original positions used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh
  93201. */
  93202. setPositionsForCPUSkinning(): Float32Array;
  93203. /**
  93204. * Prepare internal normal array for software CPU skinning
  93205. * @returns original normals used for CPU skinning. Useful for integrating Morphing with skeletons in same mesh.
  93206. */
  93207. setNormalsForCPUSkinning(): Float32Array;
  93208. /**
  93209. * Updates the vertex buffer by applying transformation from the bones
  93210. * @param skeleton defines the skeleton to apply to current mesh
  93211. * @returns the current mesh
  93212. */
  93213. applySkeleton(skeleton: Skeleton): Mesh;
  93214. /**
  93215. * 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
  93216. * @param meshes defines the list of meshes to scan
  93217. * @returns an object `{min:` Vector3`, max:` Vector3`}`
  93218. */
  93219. static MinMax(meshes: AbstractMesh[]): {
  93220. min: Vector3;
  93221. max: Vector3;
  93222. };
  93223. /**
  93224. * Returns the center of the `{min:` Vector3`, max:` Vector3`}` or the center of MinMax vector3 computed from a mesh array
  93225. * @param meshesOrMinMaxVector could be an array of meshes or a `{min:` Vector3`, max:` Vector3`}` object
  93226. * @returns a vector3
  93227. */
  93228. static Center(meshesOrMinMaxVector: {
  93229. min: Vector3;
  93230. max: Vector3;
  93231. } | AbstractMesh[]): Vector3;
  93232. /**
  93233. * Merge the array of meshes into a single mesh for performance reasons.
  93234. * @param meshes defines he vertices source. They should all be of the same material. Entries can empty
  93235. * @param disposeSource when true (default), dispose of the vertices from the source meshes
  93236. * @param allow32BitsIndices when the sum of the vertices > 64k, this must be set to true
  93237. * @param meshSubclass when set, vertices inserted into this Mesh. Meshes can then be merged into a Mesh sub-class.
  93238. * @param subdivideWithSubMeshes when true (false default), subdivide mesh to his subMesh array with meshes source.
  93239. * @param multiMultiMaterials when true (false default), subdivide mesh and accept multiple multi materials, ignores subdivideWithSubMeshes.
  93240. * @returns a new mesh
  93241. */
  93242. static MergeMeshes(meshes: Array<Mesh>, disposeSource?: boolean, allow32BitsIndices?: boolean, meshSubclass?: Mesh, subdivideWithSubMeshes?: boolean, multiMultiMaterials?: boolean): Nullable<Mesh>;
  93243. /** @hidden */
  93244. addInstance(instance: InstancedMesh): void;
  93245. /** @hidden */
  93246. removeInstance(instance: InstancedMesh): void;
  93247. }
  93248. }
  93249. declare module BABYLON {
  93250. /**
  93251. * This is the base class of all the camera used in the application.
  93252. * @see http://doc.babylonjs.com/features/cameras
  93253. */
  93254. export class Camera extends Node {
  93255. /** @hidden */
  93256. static _createDefaultParsedCamera: (name: string, scene: Scene) => Camera;
  93257. /**
  93258. * This is the default projection mode used by the cameras.
  93259. * It helps recreating a feeling of perspective and better appreciate depth.
  93260. * This is the best way to simulate real life cameras.
  93261. */
  93262. static readonly PERSPECTIVE_CAMERA: number;
  93263. /**
  93264. * This helps creating camera with an orthographic mode.
  93265. * 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.
  93266. */
  93267. static readonly ORTHOGRAPHIC_CAMERA: number;
  93268. /**
  93269. * This is the default FOV mode for perspective cameras.
  93270. * This setting aligns the upper and lower bounds of the viewport to the upper and lower bounds of the camera frustum.
  93271. */
  93272. static readonly FOVMODE_VERTICAL_FIXED: number;
  93273. /**
  93274. * This setting aligns the left and right bounds of the viewport to the left and right bounds of the camera frustum.
  93275. */
  93276. static readonly FOVMODE_HORIZONTAL_FIXED: number;
  93277. /**
  93278. * This specifies ther is no need for a camera rig.
  93279. * Basically only one eye is rendered corresponding to the camera.
  93280. */
  93281. static readonly RIG_MODE_NONE: number;
  93282. /**
  93283. * Simulates a camera Rig with one blue eye and one red eye.
  93284. * This can be use with 3d blue and red glasses.
  93285. */
  93286. static readonly RIG_MODE_STEREOSCOPIC_ANAGLYPH: number;
  93287. /**
  93288. * Defines that both eyes of the camera will be rendered side by side with a parallel target.
  93289. */
  93290. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_PARALLEL: number;
  93291. /**
  93292. * Defines that both eyes of the camera will be rendered side by side with a none parallel target.
  93293. */
  93294. static readonly RIG_MODE_STEREOSCOPIC_SIDEBYSIDE_CROSSEYED: number;
  93295. /**
  93296. * Defines that both eyes of the camera will be rendered over under each other.
  93297. */
  93298. static readonly RIG_MODE_STEREOSCOPIC_OVERUNDER: number;
  93299. /**
  93300. * Defines that both eyes of the camera should be renderered in a VR mode (carbox).
  93301. */
  93302. static readonly RIG_MODE_VR: number;
  93303. /**
  93304. * Defines that both eyes of the camera should be renderered in a VR mode (webVR).
  93305. */
  93306. static readonly RIG_MODE_WEBVR: number;
  93307. /**
  93308. * Custom rig mode allowing rig cameras to be populated manually with any number of cameras
  93309. */
  93310. static readonly RIG_MODE_CUSTOM: number;
  93311. /**
  93312. * Defines if by default attaching controls should prevent the default javascript event to continue.
  93313. */
  93314. static ForceAttachControlToAlwaysPreventDefault: boolean;
  93315. /**
  93316. * Define the input manager associated with the camera.
  93317. */
  93318. inputs: CameraInputsManager<Camera>;
  93319. /** @hidden */
  93320. _position: Vector3;
  93321. /**
  93322. * Define the current local position of the camera in the scene
  93323. */
  93324. position: Vector3;
  93325. /**
  93326. * The vector the camera should consider as up.
  93327. * (default is Vector3(0, 1, 0) aka Vector3.Up())
  93328. */
  93329. upVector: Vector3;
  93330. /**
  93331. * Define the current limit on the left side for an orthographic camera
  93332. * In scene unit
  93333. */
  93334. orthoLeft: Nullable<number>;
  93335. /**
  93336. * Define the current limit on the right side for an orthographic camera
  93337. * In scene unit
  93338. */
  93339. orthoRight: Nullable<number>;
  93340. /**
  93341. * Define the current limit on the bottom side for an orthographic camera
  93342. * In scene unit
  93343. */
  93344. orthoBottom: Nullable<number>;
  93345. /**
  93346. * Define the current limit on the top side for an orthographic camera
  93347. * In scene unit
  93348. */
  93349. orthoTop: Nullable<number>;
  93350. /**
  93351. * Field Of View is set in Radians. (default is 0.8)
  93352. */
  93353. fov: number;
  93354. /**
  93355. * Define the minimum distance the camera can see from.
  93356. * This is important to note that the depth buffer are not infinite and the closer it starts
  93357. * the more your scene might encounter depth fighting issue.
  93358. */
  93359. minZ: number;
  93360. /**
  93361. * Define the maximum distance the camera can see to.
  93362. * This is important to note that the depth buffer are not infinite and the further it end
  93363. * the more your scene might encounter depth fighting issue.
  93364. */
  93365. maxZ: number;
  93366. /**
  93367. * Define the default inertia of the camera.
  93368. * This helps giving a smooth feeling to the camera movement.
  93369. */
  93370. inertia: number;
  93371. /**
  93372. * Define the mode of the camera (Camera.PERSPECTIVE_CAMERA or Camera.ORTHOGRAPHIC_CAMERA)
  93373. */
  93374. mode: number;
  93375. /**
  93376. * Define wether the camera is intermediate.
  93377. * This is useful to not present the output directly to the screen in case of rig without post process for instance
  93378. */
  93379. isIntermediate: boolean;
  93380. /**
  93381. * Define the viewport of the camera.
  93382. * This correspond to the portion of the screen the camera will render to in normalized 0 to 1 unit.
  93383. */
  93384. viewport: Viewport;
  93385. /**
  93386. * Restricts the camera to viewing objects with the same layerMask.
  93387. * A camera with a layerMask of 1 will render mesh.layerMask & camera.layerMask!== 0
  93388. */
  93389. layerMask: number;
  93390. /**
  93391. * fovMode sets the camera frustum bounds to the viewport bounds. (default is FOVMODE_VERTICAL_FIXED)
  93392. */
  93393. fovMode: number;
  93394. /**
  93395. * Rig mode of the camera.
  93396. * This is useful to create the camera with two "eyes" instead of one to create VR or stereoscopic scenes.
  93397. * This is normally controlled byt the camera themselves as internal use.
  93398. */
  93399. cameraRigMode: number;
  93400. /**
  93401. * Defines the distance between both "eyes" in case of a RIG
  93402. */
  93403. interaxialDistance: number;
  93404. /**
  93405. * Defines if stereoscopic rendering is done side by side or over under.
  93406. */
  93407. isStereoscopicSideBySide: boolean;
  93408. /**
  93409. * 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
  93410. * This is pretty helpfull if you wish to make a camera render to a texture you could reuse somewhere
  93411. * else in the scene. (Eg. security camera)
  93412. *
  93413. * 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)
  93414. */
  93415. customRenderTargets: RenderTargetTexture[];
  93416. /**
  93417. * When set, the camera will render to this render target instead of the default canvas
  93418. *
  93419. * If the desire is to use the output of a camera as a texture in the scene consider using camera.customRenderTargets instead
  93420. */
  93421. outputRenderTarget: Nullable<RenderTargetTexture>;
  93422. /**
  93423. * Observable triggered when the camera view matrix has changed.
  93424. */
  93425. onViewMatrixChangedObservable: Observable<Camera>;
  93426. /**
  93427. * Observable triggered when the camera Projection matrix has changed.
  93428. */
  93429. onProjectionMatrixChangedObservable: Observable<Camera>;
  93430. /**
  93431. * Observable triggered when the inputs have been processed.
  93432. */
  93433. onAfterCheckInputsObservable: Observable<Camera>;
  93434. /**
  93435. * Observable triggered when reset has been called and applied to the camera.
  93436. */
  93437. onRestoreStateObservable: Observable<Camera>;
  93438. /** @hidden */
  93439. _cameraRigParams: any;
  93440. /** @hidden */
  93441. _rigCameras: Camera[];
  93442. /** @hidden */
  93443. _rigPostProcess: Nullable<PostProcess>;
  93444. protected _webvrViewMatrix: Matrix;
  93445. /** @hidden */
  93446. _skipRendering: boolean;
  93447. /** @hidden */
  93448. _projectionMatrix: Matrix;
  93449. /** @hidden */
  93450. _postProcesses: Nullable<PostProcess>[];
  93451. /** @hidden */
  93452. _activeMeshes: SmartArray<AbstractMesh>;
  93453. protected _globalPosition: Vector3;
  93454. /** @hidden */
  93455. _computedViewMatrix: Matrix;
  93456. private _doNotComputeProjectionMatrix;
  93457. private _transformMatrix;
  93458. private _frustumPlanes;
  93459. private _refreshFrustumPlanes;
  93460. private _storedFov;
  93461. private _stateStored;
  93462. /**
  93463. * Instantiates a new camera object.
  93464. * This should not be used directly but through the inherited cameras: ArcRotate, Free...
  93465. * @see http://doc.babylonjs.com/features/cameras
  93466. * @param name Defines the name of the camera in the scene
  93467. * @param position Defines the position of the camera
  93468. * @param scene Defines the scene the camera belongs too
  93469. * @param setActiveOnSceneIfNoneActive Defines if the camera should be set as active after creation if no other camera have been defined in the scene
  93470. */
  93471. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  93472. /**
  93473. * Store current camera state (fov, position, etc..)
  93474. * @returns the camera
  93475. */
  93476. storeState(): Camera;
  93477. /**
  93478. * Restores the camera state values if it has been stored. You must call storeState() first
  93479. */
  93480. protected _restoreStateValues(): boolean;
  93481. /**
  93482. * Restored camera state. You must call storeState() first.
  93483. * @returns true if restored and false otherwise
  93484. */
  93485. restoreState(): boolean;
  93486. /**
  93487. * Gets the class name of the camera.
  93488. * @returns the class name
  93489. */
  93490. getClassName(): string;
  93491. /** @hidden */
  93492. readonly _isCamera: boolean;
  93493. /**
  93494. * Gets a string representation of the camera useful for debug purpose.
  93495. * @param fullDetails Defines that a more verboe level of logging is required
  93496. * @returns the string representation
  93497. */
  93498. toString(fullDetails?: boolean): string;
  93499. /**
  93500. * Gets the current world space position of the camera.
  93501. */
  93502. readonly globalPosition: Vector3;
  93503. /**
  93504. * Gets the list of active meshes this frame (meshes no culled or excluded by lod s in the frame)
  93505. * @returns the active meshe list
  93506. */
  93507. getActiveMeshes(): SmartArray<AbstractMesh>;
  93508. /**
  93509. * Check wether a mesh is part of the current active mesh list of the camera
  93510. * @param mesh Defines the mesh to check
  93511. * @returns true if active, false otherwise
  93512. */
  93513. isActiveMesh(mesh: Mesh): boolean;
  93514. /**
  93515. * Is this camera ready to be used/rendered
  93516. * @param completeCheck defines if a complete check (including post processes) has to be done (false by default)
  93517. * @return true if the camera is ready
  93518. */
  93519. isReady(completeCheck?: boolean): boolean;
  93520. /** @hidden */
  93521. _initCache(): void;
  93522. /** @hidden */
  93523. _updateCache(ignoreParentClass?: boolean): void;
  93524. /** @hidden */
  93525. _isSynchronized(): boolean;
  93526. /** @hidden */
  93527. _isSynchronizedViewMatrix(): boolean;
  93528. /** @hidden */
  93529. _isSynchronizedProjectionMatrix(): boolean;
  93530. /**
  93531. * Attach the input controls to a specific dom element to get the input from.
  93532. * @param element Defines the element the controls should be listened from
  93533. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  93534. */
  93535. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  93536. /**
  93537. * Detach the current controls from the specified dom element.
  93538. * @param element Defines the element to stop listening the inputs from
  93539. */
  93540. detachControl(element: HTMLElement): void;
  93541. /**
  93542. * Update the camera state according to the different inputs gathered during the frame.
  93543. */
  93544. update(): void;
  93545. /** @hidden */
  93546. _checkInputs(): void;
  93547. /** @hidden */
  93548. readonly rigCameras: Camera[];
  93549. /**
  93550. * Gets the post process used by the rig cameras
  93551. */
  93552. readonly rigPostProcess: Nullable<PostProcess>;
  93553. /**
  93554. * Internal, gets the first post proces.
  93555. * @returns the first post process to be run on this camera.
  93556. */
  93557. _getFirstPostProcess(): Nullable<PostProcess>;
  93558. private _cascadePostProcessesToRigCams;
  93559. /**
  93560. * Attach a post process to the camera.
  93561. * @see http://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  93562. * @param postProcess The post process to attach to the camera
  93563. * @param insertAt The position of the post process in case several of them are in use in the scene
  93564. * @returns the position the post process has been inserted at
  93565. */
  93566. attachPostProcess(postProcess: PostProcess, insertAt?: Nullable<number>): number;
  93567. /**
  93568. * Detach a post process to the camera.
  93569. * @see http://doc.babylonjs.com/how_to/how_to_use_postprocesses#attach-postprocess
  93570. * @param postProcess The post process to detach from the camera
  93571. */
  93572. detachPostProcess(postProcess: PostProcess): void;
  93573. /**
  93574. * Gets the current world matrix of the camera
  93575. */
  93576. getWorldMatrix(): Matrix;
  93577. /** @hidden */
  93578. _getViewMatrix(): Matrix;
  93579. /**
  93580. * Gets the current view matrix of the camera.
  93581. * @param force forces the camera to recompute the matrix without looking at the cached state
  93582. * @returns the view matrix
  93583. */
  93584. getViewMatrix(force?: boolean): Matrix;
  93585. /**
  93586. * Freeze the projection matrix.
  93587. * It will prevent the cache check of the camera projection compute and can speed up perf
  93588. * if no parameter of the camera are meant to change
  93589. * @param projection Defines manually a projection if necessary
  93590. */
  93591. freezeProjectionMatrix(projection?: Matrix): void;
  93592. /**
  93593. * Unfreeze the projection matrix if it has previously been freezed by freezeProjectionMatrix.
  93594. */
  93595. unfreezeProjectionMatrix(): void;
  93596. /**
  93597. * Gets the current projection matrix of the camera.
  93598. * @param force forces the camera to recompute the matrix without looking at the cached state
  93599. * @returns the projection matrix
  93600. */
  93601. getProjectionMatrix(force?: boolean): Matrix;
  93602. /**
  93603. * Gets the transformation matrix (ie. the multiplication of view by projection matrices)
  93604. * @returns a Matrix
  93605. */
  93606. getTransformationMatrix(): Matrix;
  93607. private _updateFrustumPlanes;
  93608. /**
  93609. * Checks if a cullable object (mesh...) is in the camera frustum
  93610. * This checks the bounding box center. See isCompletelyInFrustum for a full bounding check
  93611. * @param target The object to check
  93612. * @param checkRigCameras If the rig cameras should be checked (eg. with webVR camera both eyes should be checked) (Default: false)
  93613. * @returns true if the object is in frustum otherwise false
  93614. */
  93615. isInFrustum(target: ICullable, checkRigCameras?: boolean): boolean;
  93616. /**
  93617. * Checks if a cullable object (mesh...) is in the camera frustum
  93618. * Unlike isInFrustum this cheks the full bounding box
  93619. * @param target The object to check
  93620. * @returns true if the object is in frustum otherwise false
  93621. */
  93622. isCompletelyInFrustum(target: ICullable): boolean;
  93623. /**
  93624. * Gets a ray in the forward direction from the camera.
  93625. * @param length Defines the length of the ray to create
  93626. * @param transform Defines the transform to apply to the ray, by default the world matrx is used to create a workd space ray
  93627. * @param origin Defines the start point of the ray which defaults to the camera position
  93628. * @returns the forward ray
  93629. */
  93630. getForwardRay(length?: number, transform?: Matrix, origin?: Vector3): Ray;
  93631. /**
  93632. * Releases resources associated with this node.
  93633. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  93634. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  93635. */
  93636. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  93637. /** @hidden */
  93638. _isLeftCamera: boolean;
  93639. /**
  93640. * Gets the left camera of a rig setup in case of Rigged Camera
  93641. */
  93642. readonly isLeftCamera: boolean;
  93643. /** @hidden */
  93644. _isRightCamera: boolean;
  93645. /**
  93646. * Gets the right camera of a rig setup in case of Rigged Camera
  93647. */
  93648. readonly isRightCamera: boolean;
  93649. /**
  93650. * Gets the left camera of a rig setup in case of Rigged Camera
  93651. */
  93652. readonly leftCamera: Nullable<FreeCamera>;
  93653. /**
  93654. * Gets the right camera of a rig setup in case of Rigged Camera
  93655. */
  93656. readonly rightCamera: Nullable<FreeCamera>;
  93657. /**
  93658. * Gets the left camera target of a rig setup in case of Rigged Camera
  93659. * @returns the target position
  93660. */
  93661. getLeftTarget(): Nullable<Vector3>;
  93662. /**
  93663. * Gets the right camera target of a rig setup in case of Rigged Camera
  93664. * @returns the target position
  93665. */
  93666. getRightTarget(): Nullable<Vector3>;
  93667. /**
  93668. * @hidden
  93669. */
  93670. setCameraRigMode(mode: number, rigParams: any): void;
  93671. /** @hidden */
  93672. static _setStereoscopicRigMode(camera: Camera): void;
  93673. /** @hidden */
  93674. static _setStereoscopicAnaglyphRigMode(camera: Camera): void;
  93675. /** @hidden */
  93676. static _setVRRigMode(camera: Camera, rigParams: any): void;
  93677. /** @hidden */
  93678. static _setWebVRRigMode(camera: Camera, rigParams: any): void;
  93679. /** @hidden */
  93680. _getVRProjectionMatrix(): Matrix;
  93681. protected _updateCameraRotationMatrix(): void;
  93682. protected _updateWebVRCameraRotationMatrix(): void;
  93683. /**
  93684. * This function MUST be overwritten by the different WebVR cameras available.
  93685. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  93686. * @hidden
  93687. */
  93688. _getWebVRProjectionMatrix(): Matrix;
  93689. /**
  93690. * This function MUST be overwritten by the different WebVR cameras available.
  93691. * The context in which it is running is the RIG camera. So 'this' is the TargetCamera, left or right.
  93692. * @hidden
  93693. */
  93694. _getWebVRViewMatrix(): Matrix;
  93695. /** @hidden */
  93696. setCameraRigParameter(name: string, value: any): void;
  93697. /**
  93698. * needs to be overridden by children so sub has required properties to be copied
  93699. * @hidden
  93700. */
  93701. createRigCamera(name: string, cameraIndex: number): Nullable<Camera>;
  93702. /**
  93703. * May need to be overridden by children
  93704. * @hidden
  93705. */
  93706. _updateRigCameras(): void;
  93707. /** @hidden */
  93708. _setupInputs(): void;
  93709. /**
  93710. * Serialiaze the camera setup to a json represention
  93711. * @returns the JSON representation
  93712. */
  93713. serialize(): any;
  93714. /**
  93715. * Clones the current camera.
  93716. * @param name The cloned camera name
  93717. * @returns the cloned camera
  93718. */
  93719. clone(name: string): Camera;
  93720. /**
  93721. * Gets the direction of the camera relative to a given local axis.
  93722. * @param localAxis Defines the reference axis to provide a relative direction.
  93723. * @return the direction
  93724. */
  93725. getDirection(localAxis: Vector3): Vector3;
  93726. /**
  93727. * Returns the current camera absolute rotation
  93728. */
  93729. readonly absoluteRotation: Quaternion;
  93730. /**
  93731. * Gets the direction of the camera relative to a given local axis into a passed vector.
  93732. * @param localAxis Defines the reference axis to provide a relative direction.
  93733. * @param result Defines the vector to store the result in
  93734. */
  93735. getDirectionToRef(localAxis: Vector3, result: Vector3): void;
  93736. /**
  93737. * Gets a camera constructor for a given camera type
  93738. * @param type The type of the camera to construct (should be equal to one of the camera class name)
  93739. * @param name The name of the camera the result will be able to instantiate
  93740. * @param scene The scene the result will construct the camera in
  93741. * @param interaxial_distance In case of stereoscopic setup, the distance between both eyes
  93742. * @param isStereoscopicSideBySide In case of stereoscopic setup, should the sereo be side b side
  93743. * @returns a factory method to construc the camera
  93744. */
  93745. static GetConstructorFromName(type: string, name: string, scene: Scene, interaxial_distance?: number, isStereoscopicSideBySide?: boolean): () => Camera;
  93746. /**
  93747. * Compute the world matrix of the camera.
  93748. * @returns the camera world matrix
  93749. */
  93750. computeWorldMatrix(): Matrix;
  93751. /**
  93752. * Parse a JSON and creates the camera from the parsed information
  93753. * @param parsedCamera The JSON to parse
  93754. * @param scene The scene to instantiate the camera in
  93755. * @returns the newly constructed camera
  93756. */
  93757. static Parse(parsedCamera: any, scene: Scene): Camera;
  93758. }
  93759. }
  93760. declare module BABYLON {
  93761. /**
  93762. * Class containing static functions to help procedurally build meshes
  93763. */
  93764. export class DiscBuilder {
  93765. /**
  93766. * Creates a plane polygonal mesh. By default, this is a disc
  93767. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  93768. * * 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
  93769. * * 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
  93770. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  93771. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  93772. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  93773. * @param name defines the name of the mesh
  93774. * @param options defines the options used to create the mesh
  93775. * @param scene defines the hosting scene
  93776. * @returns the plane polygonal mesh
  93777. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  93778. */
  93779. static CreateDisc(name: string, options: {
  93780. radius?: number;
  93781. tessellation?: number;
  93782. arc?: number;
  93783. updatable?: boolean;
  93784. sideOrientation?: number;
  93785. frontUVs?: Vector4;
  93786. backUVs?: Vector4;
  93787. }, scene?: Nullable<Scene>): Mesh;
  93788. }
  93789. }
  93790. declare module BABYLON {
  93791. /**
  93792. * The SPS is a single updatable mesh. The solid particles are simply separate parts or faces fo this big mesh.
  93793. *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.
  93794. * The SPS is also a particle system. It provides some methods to manage the particles.
  93795. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  93796. *
  93797. * Full documentation here : http://doc.babylonjs.com/how_to/Solid_Particle_System
  93798. */
  93799. export class SolidParticleSystem implements IDisposable {
  93800. /**
  93801. * The SPS array of Solid Particle objects. Just access each particle as with any classic array.
  93802. * Example : var p = SPS.particles[i];
  93803. */
  93804. particles: SolidParticle[];
  93805. /**
  93806. * The SPS total number of particles. Read only. Use SPS.counter instead if you need to set your own value.
  93807. */
  93808. nbParticles: number;
  93809. /**
  93810. * If the particles must ever face the camera (default false). Useful for planar particles.
  93811. */
  93812. billboard: boolean;
  93813. /**
  93814. * Recompute normals when adding a shape
  93815. */
  93816. recomputeNormals: boolean;
  93817. /**
  93818. * This a counter ofr your own usage. It's not set by any SPS functions.
  93819. */
  93820. counter: number;
  93821. /**
  93822. * The SPS name. This name is also given to the underlying mesh.
  93823. */
  93824. name: string;
  93825. /**
  93826. * The SPS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  93827. */
  93828. mesh: Mesh;
  93829. /**
  93830. * This empty object is intended to store some SPS specific or temporary values in order to lower the Garbage Collector activity.
  93831. * Please read : http://doc.babylonjs.com/how_to/Solid_Particle_System#garbage-collector-concerns
  93832. */
  93833. vars: any;
  93834. /**
  93835. * This array is populated when the SPS is set as 'pickable'.
  93836. * Each key of this array is a `faceId` value that you can get from a pickResult object.
  93837. * Each element of this array is an object `{idx: int, faceId: int}`.
  93838. * `idx` is the picked particle index in the `SPS.particles` array
  93839. * `faceId` is the picked face index counted within this particle.
  93840. * Please read : http://doc.babylonjs.com/how_to/Solid_Particle_System#pickable-particles
  93841. */
  93842. pickedParticles: {
  93843. idx: number;
  93844. faceId: number;
  93845. }[];
  93846. /**
  93847. * This array is populated when `enableDepthSort` is set to true.
  93848. * Each element of this array is an instance of the class DepthSortedParticle.
  93849. */
  93850. depthSortedParticles: DepthSortedParticle[];
  93851. /**
  93852. * If the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster). (Internal use only)
  93853. * @hidden
  93854. */
  93855. _bSphereOnly: boolean;
  93856. /**
  93857. * A number to multiply the boundind sphere radius by in order to reduce it for instance. (Internal use only)
  93858. * @hidden
  93859. */
  93860. _bSphereRadiusFactor: number;
  93861. private _scene;
  93862. private _positions;
  93863. private _indices;
  93864. private _normals;
  93865. private _colors;
  93866. private _uvs;
  93867. private _indices32;
  93868. private _positions32;
  93869. private _normals32;
  93870. private _fixedNormal32;
  93871. private _colors32;
  93872. private _uvs32;
  93873. private _index;
  93874. private _updatable;
  93875. private _pickable;
  93876. private _isVisibilityBoxLocked;
  93877. private _alwaysVisible;
  93878. private _depthSort;
  93879. private _expandable;
  93880. private _shapeCounter;
  93881. private _copy;
  93882. private _color;
  93883. private _computeParticleColor;
  93884. private _computeParticleTexture;
  93885. private _computeParticleRotation;
  93886. private _computeParticleVertex;
  93887. private _computeBoundingBox;
  93888. private _depthSortParticles;
  93889. private _camera;
  93890. private _mustUnrotateFixedNormals;
  93891. private _particlesIntersect;
  93892. private _needs32Bits;
  93893. private _isNotBuilt;
  93894. private _lastParticleId;
  93895. private _idxOfId;
  93896. /**
  93897. * Creates a SPS (Solid Particle System) object.
  93898. * @param name (String) is the SPS name, this will be the underlying mesh name.
  93899. * @param scene (Scene) is the scene in which the SPS is added.
  93900. * @param options defines the options of the sps e.g.
  93901. * * updatable (optional boolean, default true) : if the SPS must be updatable or immutable.
  93902. * * isPickable (optional boolean, default false) : if the solid particles must be pickable.
  93903. * * enableDepthSort (optional boolean, default false) : if the solid particles must be sorted in the geometry according to their distance to the camera.
  93904. * * expandable (optional boolean, default false) : if particles can still be added after the initial SPS mesh creation.
  93905. * * particleIntersection (optional boolean, default false) : if the solid particle intersections must be computed.
  93906. * * boundingSphereOnly (optional boolean, default false) : if the particle intersection must be computed only with the bounding sphere (no bounding box computation, so faster).
  93907. * * bSphereRadiusFactor (optional float, default 1.0) : a number to multiply the boundind sphere radius by in order to reduce it for instance.
  93908. * @example bSphereRadiusFactor = 1.0 / Math.sqrt(3.0) => the bounding sphere exactly matches a spherical mesh.
  93909. */
  93910. constructor(name: string, scene: Scene, options?: {
  93911. updatable?: boolean;
  93912. isPickable?: boolean;
  93913. enableDepthSort?: boolean;
  93914. particleIntersection?: boolean;
  93915. boundingSphereOnly?: boolean;
  93916. bSphereRadiusFactor?: number;
  93917. expandable?: boolean;
  93918. });
  93919. /**
  93920. * Builds the SPS underlying mesh. Returns a standard Mesh.
  93921. * If no model shape was added to the SPS, the returned mesh is just a single triangular plane.
  93922. * @returns the created mesh
  93923. */
  93924. buildMesh(): Mesh;
  93925. /**
  93926. * Digests the mesh and generates as many solid particles in the system as wanted. Returns the SPS.
  93927. * These particles will have the same geometry than the mesh parts and will be positioned at the same localisation than the mesh original places.
  93928. * Thus the particles generated from `digest()` have their property `position` set yet.
  93929. * @param mesh ( Mesh ) is the mesh to be digested
  93930. * @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
  93931. * {delta} (optional integer, default 0) is the random extra number of facets per particle , each particle will have between `facetNb` and `facetNb + delta` facets
  93932. * {number} (optional positive integer) is the wanted number of particles : each particle is built with `mesh_total_facets / number` facets
  93933. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  93934. * @returns the current SPS
  93935. */
  93936. digest(mesh: Mesh, options?: {
  93937. facetNb?: number;
  93938. number?: number;
  93939. delta?: number;
  93940. storage?: [];
  93941. }): SolidParticleSystem;
  93942. /**
  93943. * Unrotate the fixed normals in case the mesh was built with pre-rotated particles, ex : use of positionFunction in addShape()
  93944. * @hidden
  93945. */
  93946. private _unrotateFixedNormals;
  93947. /**
  93948. * Resets the temporary working copy particle
  93949. * @hidden
  93950. */
  93951. private _resetCopy;
  93952. /**
  93953. * Inserts the shape model geometry in the global SPS mesh by updating the positions, indices, normals, colors, uvs arrays
  93954. * @param p the current index in the positions array to be updated
  93955. * @param shape a Vector3 array, the shape geometry
  93956. * @param positions the positions array to be updated
  93957. * @param meshInd the shape indices array
  93958. * @param indices the indices array to be updated
  93959. * @param meshUV the shape uv array
  93960. * @param uvs the uv array to be updated
  93961. * @param meshCol the shape color array
  93962. * @param colors the color array to be updated
  93963. * @param meshNor the shape normals array
  93964. * @param normals the normals array to be updated
  93965. * @param idx the particle index
  93966. * @param idxInShape the particle index in its shape
  93967. * @param options the addShape() method passed options
  93968. * @hidden
  93969. */
  93970. private _meshBuilder;
  93971. /**
  93972. * Returns a shape Vector3 array from positions float array
  93973. * @param positions float array
  93974. * @returns a vector3 array
  93975. * @hidden
  93976. */
  93977. private _posToShape;
  93978. /**
  93979. * Returns a shapeUV array from a float uvs (array deep copy)
  93980. * @param uvs as a float array
  93981. * @returns a shapeUV array
  93982. * @hidden
  93983. */
  93984. private _uvsToShapeUV;
  93985. /**
  93986. * Adds a new particle object in the particles array
  93987. * @param idx particle index in particles array
  93988. * @param id particle id
  93989. * @param idxpos positionIndex : the starting index of the particle vertices in the SPS "positions" array
  93990. * @param idxind indiceIndex : he starting index of the particle indices in the SPS "indices" array
  93991. * @param model particle ModelShape object
  93992. * @param shapeId model shape identifier
  93993. * @param idxInShape index of the particle in the current model
  93994. * @param bInfo model bounding info object
  93995. * @param storage target storage array, if any
  93996. * @hidden
  93997. */
  93998. private _addParticle;
  93999. /**
  94000. * Adds some particles to the SPS from the model shape. Returns the shape id.
  94001. * Please read the doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#create-an-immutable-sps
  94002. * @param mesh is any Mesh object that will be used as a model for the solid particles.
  94003. * @param nb (positive integer) the number of particles to be created from this model
  94004. * @param options {positionFunction} is an optional javascript function to called for each particle on SPS creation.
  94005. * {vertexFunction} is an optional javascript function to called for each vertex of each particle on SPS creation
  94006. * {storage} (optional existing array) is an array where the particles will be stored for a further use instead of being inserted in the SPS.
  94007. * @returns the number of shapes in the system
  94008. */
  94009. addShape(mesh: Mesh, nb: number, options?: {
  94010. positionFunction?: any;
  94011. vertexFunction?: any;
  94012. storage?: [];
  94013. }): number;
  94014. /**
  94015. * Rebuilds a particle back to its just built status : if needed, recomputes the custom positions and vertices
  94016. * @hidden
  94017. */
  94018. private _rebuildParticle;
  94019. /**
  94020. * Rebuilds the whole mesh and updates the VBO : custom positions and vertices are recomputed if needed.
  94021. * @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.
  94022. * @returns the SPS.
  94023. */
  94024. rebuildMesh(reset?: boolean): SolidParticleSystem;
  94025. /** Removes the particles from the start-th to the end-th included from an expandable SPS (required).
  94026. * Returns an array with the removed particles.
  94027. * 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.
  94028. * The SPS can't be empty so at least one particle needs to remain in place.
  94029. * Under the hood, the VertexData array, so the VBO buffer, is recreated each call.
  94030. * @param start index of the first particle to remove
  94031. * @param end index of the last particle to remove (included)
  94032. * @returns an array populated with the removed particles
  94033. */
  94034. removeParticles(start: number, end: number): SolidParticle[];
  94035. /**
  94036. * Inserts some pre-created particles in the solid particle system so that they can be managed by setParticles().
  94037. * @param solidParticleArray an array populated with Solid Particles objects
  94038. * @returns the SPS
  94039. */
  94040. insertParticlesFromArray(solidParticleArray: SolidParticle[]): SolidParticleSystem;
  94041. /**
  94042. * Creates a new particle and modifies the SPS mesh geometry :
  94043. * - calls _meshBuilder() to increase the SPS mesh geometry step by step
  94044. * - calls _addParticle() to populate the particle array
  94045. * factorized code from addShape() and insertParticlesFromArray()
  94046. * @param idx particle index in the particles array
  94047. * @param i particle index in its shape
  94048. * @param modelShape particle ModelShape object
  94049. * @param shape shape vertex array
  94050. * @param meshInd shape indices array
  94051. * @param meshUV shape uv array
  94052. * @param meshCol shape color array
  94053. * @param meshNor shape normals array
  94054. * @param bbInfo shape bounding info
  94055. * @param storage target particle storage
  94056. * @options addShape() passed options
  94057. * @hidden
  94058. */
  94059. private _insertNewParticle;
  94060. /**
  94061. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  94062. * This method calls `updateParticle()` for each particle of the SPS.
  94063. * For an animated SPS, it is usually called within the render loop.
  94064. * 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.
  94065. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  94066. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  94067. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  94068. * @returns the SPS.
  94069. */
  94070. setParticles(start?: number, end?: number, update?: boolean): SolidParticleSystem;
  94071. /**
  94072. * Disposes the SPS.
  94073. */
  94074. dispose(): void;
  94075. /**
  94076. * Returns a SolidParticle object from its identifier : particle.id
  94077. * @param id (integer) the particle Id
  94078. * @returns the searched particle or null if not found in the SPS.
  94079. */
  94080. getParticleById(id: number): Nullable<SolidParticle>;
  94081. /**
  94082. * Returns a new array populated with the particles having the passed shapeId.
  94083. * @param shapeId (integer) the shape identifier
  94084. * @returns a new solid particle array
  94085. */
  94086. getParticlesByShapeId(shapeId: number): SolidParticle[];
  94087. /**
  94088. * Populates the passed array "ref" with the particles having the passed shapeId.
  94089. * @param shapeId the shape identifier
  94090. * @returns the SPS
  94091. * @param ref
  94092. */
  94093. getParticlesByShapeIdToRef(shapeId: number, ref: SolidParticle[]): SolidParticleSystem;
  94094. /**
  94095. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  94096. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  94097. * @returns the SPS.
  94098. */
  94099. refreshVisibleSize(): SolidParticleSystem;
  94100. /**
  94101. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  94102. * @param size the size (float) of the visibility box
  94103. * note : this doesn't lock the SPS mesh bounding box.
  94104. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  94105. */
  94106. setVisibilityBox(size: number): void;
  94107. /**
  94108. * Gets whether the SPS as always visible or not
  94109. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  94110. */
  94111. /**
  94112. * Sets the SPS as always visible or not
  94113. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  94114. */
  94115. isAlwaysVisible: boolean;
  94116. /**
  94117. * Sets the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  94118. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  94119. */
  94120. /**
  94121. * Gets if the SPS visibility box as locked or not. This enables/disables the underlying mesh bounding box updates.
  94122. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#sps-visibility
  94123. */
  94124. isVisibilityBoxLocked: boolean;
  94125. /**
  94126. * Tells to `setParticles()` to compute the particle rotations or not.
  94127. * Default value : true. The SPS is faster when it's set to false.
  94128. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  94129. */
  94130. /**
  94131. * Gets if `setParticles()` computes the particle rotations or not.
  94132. * Default value : true. The SPS is faster when it's set to false.
  94133. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate.
  94134. */
  94135. computeParticleRotation: boolean;
  94136. /**
  94137. * Tells to `setParticles()` to compute the particle colors or not.
  94138. * Default value : true. The SPS is faster when it's set to false.
  94139. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  94140. */
  94141. /**
  94142. * Gets if `setParticles()` computes the particle colors or not.
  94143. * Default value : true. The SPS is faster when it's set to false.
  94144. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  94145. */
  94146. computeParticleColor: boolean;
  94147. /**
  94148. * Gets if `setParticles()` computes the particle textures or not.
  94149. * Default value : true. The SPS is faster when it's set to false.
  94150. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  94151. */
  94152. computeParticleTexture: boolean;
  94153. /**
  94154. * Tells to `setParticles()` to call the vertex function for each vertex of each particle, or not.
  94155. * Default value : false. The SPS is faster when it's set to false.
  94156. * Note : the particle custom vertex positions aren't stored values.
  94157. */
  94158. /**
  94159. * Gets if `setParticles()` calls the vertex function for each vertex of each particle, or not.
  94160. * Default value : false. The SPS is faster when it's set to false.
  94161. * Note : the particle custom vertex positions aren't stored values.
  94162. */
  94163. computeParticleVertex: boolean;
  94164. /**
  94165. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  94166. */
  94167. /**
  94168. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  94169. */
  94170. computeBoundingBox: boolean;
  94171. /**
  94172. * Tells to `setParticles()` to sort or not the distance between each particle and the camera.
  94173. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  94174. * Default : `true`
  94175. */
  94176. /**
  94177. * Gets if `setParticles()` sorts or not the distance between each particle and the camera.
  94178. * Skipped when `enableDepthSort` is set to `false` (default) at construction time.
  94179. * Default : `true`
  94180. */
  94181. depthSortParticles: boolean;
  94182. /**
  94183. * Gets if the SPS is created as expandable at construction time.
  94184. * Default : `false`
  94185. */
  94186. readonly expandable: boolean;
  94187. /**
  94188. * This function does nothing. It may be overwritten to set all the particle first values.
  94189. * The SPS doesn't call this function, you may have to call it by your own.
  94190. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  94191. */
  94192. initParticles(): void;
  94193. /**
  94194. * This function does nothing. It may be overwritten to recycle a particle.
  94195. * The SPS doesn't call this function, you may have to call it by your own.
  94196. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  94197. * @param particle The particle to recycle
  94198. * @returns the recycled particle
  94199. */
  94200. recycleParticle(particle: SolidParticle): SolidParticle;
  94201. /**
  94202. * Updates a particle : this function should be overwritten by the user.
  94203. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  94204. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#particle-management
  94205. * @example : just set a particle position or velocity and recycle conditions
  94206. * @param particle The particle to update
  94207. * @returns the updated particle
  94208. */
  94209. updateParticle(particle: SolidParticle): SolidParticle;
  94210. /**
  94211. * Updates a vertex of a particle : it can be overwritten by the user.
  94212. * This will be called on each vertex particle by `setParticles()` if `computeParticleVertex` is set to true only.
  94213. * @param particle the current particle
  94214. * @param vertex the current index of the current particle
  94215. * @param pt the index of the current vertex in the particle shape
  94216. * doc : http://doc.babylonjs.com/how_to/Solid_Particle_System#update-each-particle-shape
  94217. * @example : just set a vertex particle position
  94218. * @returns the updated vertex
  94219. */
  94220. updateParticleVertex(particle: SolidParticle, vertex: Vector3, pt: number): Vector3;
  94221. /**
  94222. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  94223. * This does nothing and may be overwritten by the user.
  94224. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  94225. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  94226. * @param update the boolean update value actually passed to setParticles()
  94227. */
  94228. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  94229. /**
  94230. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  94231. * This will be passed three parameters.
  94232. * This does nothing and may be overwritten by the user.
  94233. * @param start the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  94234. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  94235. * @param update the boolean update value actually passed to setParticles()
  94236. */
  94237. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  94238. }
  94239. }
  94240. declare module BABYLON {
  94241. /**
  94242. * Represents one particle of a solid particle system.
  94243. */
  94244. export class SolidParticle {
  94245. /**
  94246. * particle global index
  94247. */
  94248. idx: number;
  94249. /**
  94250. * particle identifier
  94251. */
  94252. id: number;
  94253. /**
  94254. * The color of the particle
  94255. */
  94256. color: Nullable<Color4>;
  94257. /**
  94258. * The world space position of the particle.
  94259. */
  94260. position: Vector3;
  94261. /**
  94262. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  94263. */
  94264. rotation: Vector3;
  94265. /**
  94266. * The world space rotation quaternion of the particle.
  94267. */
  94268. rotationQuaternion: Nullable<Quaternion>;
  94269. /**
  94270. * The scaling of the particle.
  94271. */
  94272. scaling: Vector3;
  94273. /**
  94274. * The uvs of the particle.
  94275. */
  94276. uvs: Vector4;
  94277. /**
  94278. * The current speed of the particle.
  94279. */
  94280. velocity: Vector3;
  94281. /**
  94282. * The pivot point in the particle local space.
  94283. */
  94284. pivot: Vector3;
  94285. /**
  94286. * Must the particle be translated from its pivot point in its local space ?
  94287. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  94288. * Default : false
  94289. */
  94290. translateFromPivot: boolean;
  94291. /**
  94292. * Is the particle active or not ?
  94293. */
  94294. alive: boolean;
  94295. /**
  94296. * Is the particle visible or not ?
  94297. */
  94298. isVisible: boolean;
  94299. /**
  94300. * Index of this particle in the global "positions" array (Internal use)
  94301. * @hidden
  94302. */
  94303. _pos: number;
  94304. /**
  94305. * @hidden Index of this particle in the global "indices" array (Internal use)
  94306. */
  94307. _ind: number;
  94308. /**
  94309. * @hidden ModelShape of this particle (Internal use)
  94310. */
  94311. _model: ModelShape;
  94312. /**
  94313. * ModelShape id of this particle
  94314. */
  94315. shapeId: number;
  94316. /**
  94317. * Index of the particle in its shape id
  94318. */
  94319. idxInShape: number;
  94320. /**
  94321. * @hidden Reference to the shape model BoundingInfo object (Internal use)
  94322. */
  94323. _modelBoundingInfo: BoundingInfo;
  94324. /**
  94325. * @hidden Particle BoundingInfo object (Internal use)
  94326. */
  94327. _boundingInfo: BoundingInfo;
  94328. /**
  94329. * @hidden Reference to the SPS what the particle belongs to (Internal use)
  94330. */
  94331. _sps: SolidParticleSystem;
  94332. /**
  94333. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  94334. */
  94335. _stillInvisible: boolean;
  94336. /**
  94337. * @hidden Last computed particle rotation matrix
  94338. */
  94339. _rotationMatrix: number[];
  94340. /**
  94341. * Parent particle Id, if any.
  94342. * Default null.
  94343. */
  94344. parentId: Nullable<number>;
  94345. /**
  94346. * The culling strategy to use to check whether the solid particle must be culled or not when using isInFrustum().
  94347. * The possible values are :
  94348. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  94349. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  94350. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  94351. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  94352. * The default value for solid particles is AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  94353. * Please read each static variable documentation in the class AbstractMesh to get details about the culling process.
  94354. * */
  94355. cullingStrategy: number;
  94356. /**
  94357. * @hidden Internal global position in the SPS.
  94358. */
  94359. _globalPosition: Vector3;
  94360. /**
  94361. * Creates a Solid Particle object.
  94362. * Don't create particles manually, use instead the Solid Particle System internal tools like _addParticle()
  94363. * @param particleIndex (integer) is the particle index in the Solid Particle System pool.
  94364. * @param particleId (integer) is the particle identifier. Unless some particles are removed from the SPS, it's the same value than the particle idx.
  94365. * @param positionIndex (integer) is the starting index of the particle vertices in the SPS "positions" array.
  94366. * @param indiceIndex (integer) is the starting index of the particle indices in the SPS "indices" array.
  94367. * @param model (ModelShape) is a reference to the model shape on what the particle is designed.
  94368. * @param shapeId (integer) is the model shape identifier in the SPS.
  94369. * @param idxInShape (integer) is the index of the particle in the current model (ex: the 10th box of addShape(box, 30))
  94370. * @param sps defines the sps it is associated to
  94371. * @param modelBoundingInfo is the reference to the model BoundingInfo used for intersection computations.
  94372. */
  94373. constructor(particleIndex: number, particleId: number, positionIndex: number, indiceIndex: number, model: Nullable<ModelShape>, shapeId: number, idxInShape: number, sps: SolidParticleSystem, modelBoundingInfo?: Nullable<BoundingInfo>);
  94374. /**
  94375. * Copies the particle property values into the existing target : position, rotation, scaling, uvs, colors, pivot, parent, visibility, alive
  94376. * @param target the particle target
  94377. * @returns the current particle
  94378. */
  94379. copyToRef(target: SolidParticle): SolidParticle;
  94380. /**
  94381. * Legacy support, changed scale to scaling
  94382. */
  94383. /**
  94384. * Legacy support, changed scale to scaling
  94385. */
  94386. scale: Vector3;
  94387. /**
  94388. * Legacy support, changed quaternion to rotationQuaternion
  94389. */
  94390. /**
  94391. * Legacy support, changed quaternion to rotationQuaternion
  94392. */
  94393. quaternion: Nullable<Quaternion>;
  94394. /**
  94395. * Returns a boolean. True if the particle intersects another particle or another mesh, else false.
  94396. * The intersection is computed on the particle bounding sphere and Axis Aligned Bounding Box (AABB)
  94397. * @param target is the object (solid particle or mesh) what the intersection is computed against.
  94398. * @returns true if it intersects
  94399. */
  94400. intersectsMesh(target: Mesh | SolidParticle): boolean;
  94401. /**
  94402. * Returns `true` if the solid particle is within the frustum defined by the passed array of planes.
  94403. * A particle is in the frustum if its bounding box intersects the frustum
  94404. * @param frustumPlanes defines the frustum to test
  94405. * @returns true if the particle is in the frustum planes
  94406. */
  94407. isInFrustum(frustumPlanes: Plane[]): boolean;
  94408. /**
  94409. * get the rotation matrix of the particle
  94410. * @hidden
  94411. */
  94412. getRotationMatrix(m: Matrix): void;
  94413. }
  94414. /**
  94415. * Represents the shape of the model used by one particle of a solid particle system.
  94416. * SPS internal tool, don't use it manually.
  94417. */
  94418. export class ModelShape {
  94419. /**
  94420. * The shape id
  94421. * @hidden
  94422. */
  94423. shapeID: number;
  94424. /**
  94425. * flat array of model positions (internal use)
  94426. * @hidden
  94427. */
  94428. _shape: Vector3[];
  94429. /**
  94430. * flat array of model UVs (internal use)
  94431. * @hidden
  94432. */
  94433. _shapeUV: number[];
  94434. /**
  94435. * color array of the model
  94436. * @hidden
  94437. */
  94438. _shapeColors: number[];
  94439. /**
  94440. * indices array of the model
  94441. * @hidden
  94442. */
  94443. _indices: number[];
  94444. /**
  94445. * normals array of the model
  94446. * @hidden
  94447. */
  94448. _normals: number[];
  94449. /**
  94450. * length of the shape in the model indices array (internal use)
  94451. * @hidden
  94452. */
  94453. _indicesLength: number;
  94454. /**
  94455. * Custom position function (internal use)
  94456. * @hidden
  94457. */
  94458. _positionFunction: Nullable<(particle: SolidParticle, i: number, s: number) => void>;
  94459. /**
  94460. * Custom vertex function (internal use)
  94461. * @hidden
  94462. */
  94463. _vertexFunction: Nullable<(particle: SolidParticle, vertex: Vector3, i: number) => void>;
  94464. /**
  94465. * 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.
  94466. * SPS internal tool, don't use it manually.
  94467. * @hidden
  94468. */
  94469. 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>);
  94470. }
  94471. /**
  94472. * Represents a Depth Sorted Particle in the solid particle system.
  94473. */
  94474. export class DepthSortedParticle {
  94475. /**
  94476. * Index of the particle in the "indices" array
  94477. */
  94478. ind: number;
  94479. /**
  94480. * Length of the particle shape in the "indices" array
  94481. */
  94482. indicesLength: number;
  94483. /**
  94484. * Squared distance from the particle to the camera
  94485. */
  94486. sqDistance: number;
  94487. }
  94488. }
  94489. declare module BABYLON {
  94490. /**
  94491. * @hidden
  94492. */
  94493. export class _MeshCollisionData {
  94494. _checkCollisions: boolean;
  94495. _collisionMask: number;
  94496. _collisionGroup: number;
  94497. _collider: Nullable<Collider>;
  94498. _oldPositionForCollisions: Vector3;
  94499. _diffPositionForCollisions: Vector3;
  94500. _onCollideObserver: Nullable<Observer<AbstractMesh>>;
  94501. _onCollisionPositionChangeObserver: Nullable<Observer<Vector3>>;
  94502. }
  94503. }
  94504. declare module BABYLON {
  94505. /** @hidden */
  94506. class _FacetDataStorage {
  94507. facetPositions: Vector3[];
  94508. facetNormals: Vector3[];
  94509. facetPartitioning: number[][];
  94510. facetNb: number;
  94511. partitioningSubdivisions: number;
  94512. partitioningBBoxRatio: number;
  94513. facetDataEnabled: boolean;
  94514. facetParameters: any;
  94515. bbSize: Vector3;
  94516. subDiv: {
  94517. max: number;
  94518. X: number;
  94519. Y: number;
  94520. Z: number;
  94521. };
  94522. facetDepthSort: boolean;
  94523. facetDepthSortEnabled: boolean;
  94524. depthSortedIndices: IndicesArray;
  94525. depthSortedFacets: {
  94526. ind: number;
  94527. sqDistance: number;
  94528. }[];
  94529. facetDepthSortFunction: (f1: {
  94530. ind: number;
  94531. sqDistance: number;
  94532. }, f2: {
  94533. ind: number;
  94534. sqDistance: number;
  94535. }) => number;
  94536. facetDepthSortFrom: Vector3;
  94537. facetDepthSortOrigin: Vector3;
  94538. invertedMatrix: Matrix;
  94539. }
  94540. /**
  94541. * @hidden
  94542. **/
  94543. class _InternalAbstractMeshDataInfo {
  94544. _hasVertexAlpha: boolean;
  94545. _useVertexColors: boolean;
  94546. _numBoneInfluencers: number;
  94547. _applyFog: boolean;
  94548. _receiveShadows: boolean;
  94549. _facetData: _FacetDataStorage;
  94550. _visibility: number;
  94551. _skeleton: Nullable<Skeleton>;
  94552. _layerMask: number;
  94553. _computeBonesUsingShaders: boolean;
  94554. _isActive: boolean;
  94555. _onlyForInstances: boolean;
  94556. _isActiveIntermediate: boolean;
  94557. _onlyForInstancesIntermediate: boolean;
  94558. _actAsRegularMesh: boolean;
  94559. }
  94560. /**
  94561. * Class used to store all common mesh properties
  94562. */
  94563. export class AbstractMesh extends TransformNode implements IDisposable, ICullable, IGetSetVerticesData {
  94564. /** No occlusion */
  94565. static OCCLUSION_TYPE_NONE: number;
  94566. /** Occlusion set to optimisitic */
  94567. static OCCLUSION_TYPE_OPTIMISTIC: number;
  94568. /** Occlusion set to strict */
  94569. static OCCLUSION_TYPE_STRICT: number;
  94570. /** Use an accurante occlusion algorithm */
  94571. static OCCLUSION_ALGORITHM_TYPE_ACCURATE: number;
  94572. /** Use a conservative occlusion algorithm */
  94573. static OCCLUSION_ALGORITHM_TYPE_CONSERVATIVE: number;
  94574. /** Default culling strategy : this is an exclusion test and it's the more accurate.
  94575. * Test order :
  94576. * Is the bounding sphere outside the frustum ?
  94577. * If not, are the bounding box vertices outside the frustum ?
  94578. * It not, then the cullable object is in the frustum.
  94579. */
  94580. static readonly CULLINGSTRATEGY_STANDARD: number;
  94581. /** Culling strategy : Bounding Sphere Only.
  94582. * This is an exclusion test. It's faster than the standard strategy because the bounding box is not tested.
  94583. * It's also less accurate than the standard because some not visible objects can still be selected.
  94584. * Test : is the bounding sphere outside the frustum ?
  94585. * If not, then the cullable object is in the frustum.
  94586. */
  94587. static readonly CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY: number;
  94588. /** Culling strategy : Optimistic Inclusion.
  94589. * This in an inclusion test first, then the standard exclusion test.
  94590. * This can be faster when a cullable object is expected to be almost always in the camera frustum.
  94591. * 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.
  94592. * Anyway, it's as accurate as the standard strategy.
  94593. * Test :
  94594. * Is the cullable object bounding sphere center in the frustum ?
  94595. * If not, apply the default culling strategy.
  94596. */
  94597. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION: number;
  94598. /** Culling strategy : Optimistic Inclusion then Bounding Sphere Only.
  94599. * This in an inclusion test first, then the bounding sphere only exclusion test.
  94600. * This can be the fastest test when a cullable object is expected to be almost always in the camera frustum.
  94601. * 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.
  94602. * It's less accurate than the standard strategy and as accurate as the BoundingSphereOnly strategy.
  94603. * Test :
  94604. * Is the cullable object bounding sphere center in the frustum ?
  94605. * If not, apply the Bounding Sphere Only strategy. No Bounding Box is tested here.
  94606. */
  94607. static readonly CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY: number;
  94608. /**
  94609. * No billboard
  94610. */
  94611. static readonly BILLBOARDMODE_NONE: number;
  94612. /** Billboard on X axis */
  94613. static readonly BILLBOARDMODE_X: number;
  94614. /** Billboard on Y axis */
  94615. static readonly BILLBOARDMODE_Y: number;
  94616. /** Billboard on Z axis */
  94617. static readonly BILLBOARDMODE_Z: number;
  94618. /** Billboard on all axes */
  94619. static readonly BILLBOARDMODE_ALL: number;
  94620. /** Billboard on using position instead of orientation */
  94621. static readonly BILLBOARDMODE_USE_POSITION: number;
  94622. /** @hidden */
  94623. _internalAbstractMeshDataInfo: _InternalAbstractMeshDataInfo;
  94624. /**
  94625. * The culling strategy to use to check whether the mesh must be rendered or not.
  94626. * This value can be changed at any time and will be used on the next render mesh selection.
  94627. * The possible values are :
  94628. * - AbstractMesh.CULLINGSTRATEGY_STANDARD
  94629. * - AbstractMesh.CULLINGSTRATEGY_BOUNDINGSPHERE_ONLY
  94630. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION
  94631. * - AbstractMesh.CULLINGSTRATEGY_OPTIMISTIC_INCLUSION_THEN_BSPHERE_ONLY
  94632. * Please read each static variable documentation to get details about the culling process.
  94633. * */
  94634. cullingStrategy: number;
  94635. /**
  94636. * Gets the number of facets in the mesh
  94637. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  94638. */
  94639. readonly facetNb: number;
  94640. /**
  94641. * Gets or set the number (integer) of subdivisions per axis in the partioning space
  94642. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  94643. */
  94644. partitioningSubdivisions: number;
  94645. /**
  94646. * The ratio (float) to apply to the bouding box size to set to the partioning space.
  94647. * Ex : 1.01 (default) the partioning space is 1% bigger than the bounding box
  94648. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#tweaking-the-partitioning
  94649. */
  94650. partitioningBBoxRatio: number;
  94651. /**
  94652. * Gets or sets a boolean indicating that the facets must be depth sorted on next call to `updateFacetData()`.
  94653. * Works only for updatable meshes.
  94654. * Doesn't work with multi-materials
  94655. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  94656. */
  94657. mustDepthSortFacets: boolean;
  94658. /**
  94659. * The location (Vector3) where the facet depth sort must be computed from.
  94660. * By default, the active camera position.
  94661. * Used only when facet depth sort is enabled
  94662. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#facet-depth-sort
  94663. */
  94664. facetDepthSortFrom: Vector3;
  94665. /**
  94666. * gets a boolean indicating if facetData is enabled
  94667. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata#what-is-a-mesh-facet
  94668. */
  94669. readonly isFacetDataEnabled: boolean;
  94670. /** @hidden */
  94671. _updateNonUniformScalingState(value: boolean): boolean;
  94672. /**
  94673. * An event triggered when this mesh collides with another one
  94674. */
  94675. onCollideObservable: Observable<AbstractMesh>;
  94676. /** Set a function to call when this mesh collides with another one */
  94677. onCollide: () => void;
  94678. /**
  94679. * An event triggered when the collision's position changes
  94680. */
  94681. onCollisionPositionChangeObservable: Observable<Vector3>;
  94682. /** Set a function to call when the collision's position changes */
  94683. onCollisionPositionChange: () => void;
  94684. /**
  94685. * An event triggered when material is changed
  94686. */
  94687. onMaterialChangedObservable: Observable<AbstractMesh>;
  94688. /**
  94689. * Gets or sets the orientation for POV movement & rotation
  94690. */
  94691. definedFacingForward: boolean;
  94692. /** @hidden */
  94693. _occlusionQuery: Nullable<WebGLQuery>;
  94694. /** @hidden */
  94695. _renderingGroup: Nullable<RenderingGroup>;
  94696. /**
  94697. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  94698. */
  94699. /**
  94700. * Gets or sets mesh visibility between 0 and 1 (default is 1)
  94701. */
  94702. visibility: number;
  94703. /** Gets or sets the alpha index used to sort transparent meshes
  94704. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#alpha-index
  94705. */
  94706. alphaIndex: number;
  94707. /**
  94708. * Gets or sets a boolean indicating if the mesh is visible (renderable). Default is true
  94709. */
  94710. isVisible: boolean;
  94711. /**
  94712. * Gets or sets a boolean indicating if the mesh can be picked (by scene.pick for instance or through actions). Default is true
  94713. */
  94714. isPickable: boolean;
  94715. /** Gets or sets a boolean indicating that bounding boxes of subMeshes must be rendered as well (false by default) */
  94716. showSubMeshesBoundingBox: boolean;
  94717. /** Gets or sets a boolean indicating if the mesh must be considered as a ray blocker for lens flares (false by default)
  94718. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  94719. */
  94720. isBlocker: boolean;
  94721. /**
  94722. * Gets or sets a boolean indicating that pointer move events must be supported on this mesh (false by default)
  94723. */
  94724. enablePointerMoveEvents: boolean;
  94725. /**
  94726. * Specifies the rendering group id for this mesh (0 by default)
  94727. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered#rendering-groups
  94728. */
  94729. renderingGroupId: number;
  94730. private _material;
  94731. /** Gets or sets current material */
  94732. material: Nullable<Material>;
  94733. /**
  94734. * Gets or sets a boolean indicating that this mesh can receive realtime shadows
  94735. * @see http://doc.babylonjs.com/babylon101/shadows
  94736. */
  94737. receiveShadows: boolean;
  94738. /** Defines color to use when rendering outline */
  94739. outlineColor: Color3;
  94740. /** Define width to use when rendering outline */
  94741. outlineWidth: number;
  94742. /** Defines color to use when rendering overlay */
  94743. overlayColor: Color3;
  94744. /** Defines alpha to use when rendering overlay */
  94745. overlayAlpha: number;
  94746. /** Gets or sets a boolean indicating that this mesh contains vertex color data with alpha values */
  94747. hasVertexAlpha: boolean;
  94748. /** 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) */
  94749. useVertexColors: boolean;
  94750. /**
  94751. * Gets or sets a boolean indicating that bone animations must be computed by the CPU (false by default)
  94752. */
  94753. computeBonesUsingShaders: boolean;
  94754. /** Gets or sets the number of allowed bone influences per vertex (4 by default) */
  94755. numBoneInfluencers: number;
  94756. /** Gets or sets a boolean indicating that this mesh will allow fog to be rendered on it (true by default) */
  94757. applyFog: boolean;
  94758. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes selection (true by default) */
  94759. useOctreeForRenderingSelection: boolean;
  94760. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes picking (true by default) */
  94761. useOctreeForPicking: boolean;
  94762. /** Gets or sets a boolean indicating that internal octree (if available) can be used to boost submeshes collision (true by default) */
  94763. useOctreeForCollisions: boolean;
  94764. /**
  94765. * Gets or sets the current layer mask (default is 0x0FFFFFFF)
  94766. * @see http://doc.babylonjs.com/how_to/layermasks_and_multi-cam_textures
  94767. */
  94768. layerMask: number;
  94769. /**
  94770. * True if the mesh must be rendered in any case (this will shortcut the frustum clipping phase)
  94771. */
  94772. alwaysSelectAsActiveMesh: boolean;
  94773. /**
  94774. * Gets or sets a boolean indicating that the bounding info does not need to be kept in sync (for performance reason)
  94775. */
  94776. doNotSyncBoundingInfo: boolean;
  94777. /**
  94778. * Gets or sets the current action manager
  94779. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  94780. */
  94781. actionManager: Nullable<AbstractActionManager>;
  94782. private _meshCollisionData;
  94783. /**
  94784. * Gets or sets the ellipsoid used to impersonate this mesh when using collision engine (default is (0.5, 1, 0.5))
  94785. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  94786. */
  94787. ellipsoid: Vector3;
  94788. /**
  94789. * Gets or sets the ellipsoid offset used to impersonate this mesh when using collision engine (default is (0, 0, 0))
  94790. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  94791. */
  94792. ellipsoidOffset: Vector3;
  94793. /**
  94794. * Gets or sets a collision mask used to mask collisions (default is -1).
  94795. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  94796. */
  94797. collisionMask: number;
  94798. /**
  94799. * Gets or sets the current collision group mask (-1 by default).
  94800. * A collision between A and B will happen if A.collisionGroup & b.collisionMask !== 0
  94801. */
  94802. collisionGroup: number;
  94803. /**
  94804. * Defines edge width used when edgesRenderer is enabled
  94805. * @see https://www.babylonjs-playground.com/#10OJSG#13
  94806. */
  94807. edgesWidth: number;
  94808. /**
  94809. * Defines edge color used when edgesRenderer is enabled
  94810. * @see https://www.babylonjs-playground.com/#10OJSG#13
  94811. */
  94812. edgesColor: Color4;
  94813. /** @hidden */
  94814. _edgesRenderer: Nullable<IEdgesRenderer>;
  94815. /** @hidden */
  94816. _masterMesh: Nullable<AbstractMesh>;
  94817. /** @hidden */
  94818. _boundingInfo: Nullable<BoundingInfo>;
  94819. /** @hidden */
  94820. _renderId: number;
  94821. /**
  94822. * Gets or sets the list of subMeshes
  94823. * @see http://doc.babylonjs.com/how_to/multi_materials
  94824. */
  94825. subMeshes: SubMesh[];
  94826. /** @hidden */
  94827. _intersectionsInProgress: AbstractMesh[];
  94828. /** @hidden */
  94829. _unIndexed: boolean;
  94830. /** @hidden */
  94831. _lightSources: Light[];
  94832. /** Gets the list of lights affecting that mesh */
  94833. readonly lightSources: Light[];
  94834. /** @hidden */
  94835. readonly _positions: Nullable<Vector3[]>;
  94836. /** @hidden */
  94837. _waitingData: {
  94838. lods: Nullable<any>;
  94839. actions: Nullable<any>;
  94840. freezeWorldMatrix: Nullable<boolean>;
  94841. };
  94842. /** @hidden */
  94843. _bonesTransformMatrices: Nullable<Float32Array>;
  94844. /** @hidden */
  94845. _transformMatrixTexture: Nullable<RawTexture>;
  94846. /**
  94847. * Gets or sets a skeleton to apply skining transformations
  94848. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  94849. */
  94850. skeleton: Nullable<Skeleton>;
  94851. /**
  94852. * An event triggered when the mesh is rebuilt.
  94853. */
  94854. onRebuildObservable: Observable<AbstractMesh>;
  94855. /**
  94856. * Creates a new AbstractMesh
  94857. * @param name defines the name of the mesh
  94858. * @param scene defines the hosting scene
  94859. */
  94860. constructor(name: string, scene?: Nullable<Scene>);
  94861. /**
  94862. * Returns the string "AbstractMesh"
  94863. * @returns "AbstractMesh"
  94864. */
  94865. getClassName(): string;
  94866. /**
  94867. * Gets a string representation of the current mesh
  94868. * @param fullDetails defines a boolean indicating if full details must be included
  94869. * @returns a string representation of the current mesh
  94870. */
  94871. toString(fullDetails?: boolean): string;
  94872. /**
  94873. * @hidden
  94874. */
  94875. protected _getEffectiveParent(): Nullable<Node>;
  94876. /** @hidden */
  94877. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  94878. /** @hidden */
  94879. _rebuild(): void;
  94880. /** @hidden */
  94881. _resyncLightSources(): void;
  94882. /** @hidden */
  94883. _resyncLighSource(light: Light): void;
  94884. /** @hidden */
  94885. _unBindEffect(): void;
  94886. /** @hidden */
  94887. _removeLightSource(light: Light, dispose: boolean): void;
  94888. private _markSubMeshesAsDirty;
  94889. /** @hidden */
  94890. _markSubMeshesAsLightDirty(dispose?: boolean): void;
  94891. /** @hidden */
  94892. _markSubMeshesAsAttributesDirty(): void;
  94893. /** @hidden */
  94894. _markSubMeshesAsMiscDirty(): void;
  94895. /**
  94896. * Gets or sets a Vector3 depicting the mesh scaling along each local axis X, Y, Z. Default is (1.0, 1.0, 1.0)
  94897. */
  94898. scaling: Vector3;
  94899. /**
  94900. * Returns true if the mesh is blocked. Implemented by child classes
  94901. */
  94902. readonly isBlocked: boolean;
  94903. /**
  94904. * Returns the mesh itself by default. Implemented by child classes
  94905. * @param camera defines the camera to use to pick the right LOD level
  94906. * @returns the currentAbstractMesh
  94907. */
  94908. getLOD(camera: Camera): Nullable<AbstractMesh>;
  94909. /**
  94910. * Returns 0 by default. Implemented by child classes
  94911. * @returns an integer
  94912. */
  94913. getTotalVertices(): number;
  94914. /**
  94915. * Returns a positive integer : the total number of indices in this mesh geometry.
  94916. * @returns the numner of indices or zero if the mesh has no geometry.
  94917. */
  94918. getTotalIndices(): number;
  94919. /**
  94920. * Returns null by default. Implemented by child classes
  94921. * @returns null
  94922. */
  94923. getIndices(): Nullable<IndicesArray>;
  94924. /**
  94925. * Returns the array of the requested vertex data kind. Implemented by child classes
  94926. * @param kind defines the vertex data kind to use
  94927. * @returns null
  94928. */
  94929. getVerticesData(kind: string): Nullable<FloatArray>;
  94930. /**
  94931. * Sets the vertex data of the mesh geometry for the requested `kind`.
  94932. * If the mesh has no geometry, a new Geometry object is set to the mesh and then passed this vertex data.
  94933. * Note that a new underlying VertexBuffer object is created each call.
  94934. * If the `kind` is the `PositionKind`, the mesh BoundingInfo is renewed, so the bounding box and sphere, and the mesh World Matrix is recomputed.
  94935. * @param kind defines vertex data kind:
  94936. * * VertexBuffer.PositionKind
  94937. * * VertexBuffer.UVKind
  94938. * * VertexBuffer.UV2Kind
  94939. * * VertexBuffer.UV3Kind
  94940. * * VertexBuffer.UV4Kind
  94941. * * VertexBuffer.UV5Kind
  94942. * * VertexBuffer.UV6Kind
  94943. * * VertexBuffer.ColorKind
  94944. * * VertexBuffer.MatricesIndicesKind
  94945. * * VertexBuffer.MatricesIndicesExtraKind
  94946. * * VertexBuffer.MatricesWeightsKind
  94947. * * VertexBuffer.MatricesWeightsExtraKind
  94948. * @param data defines the data source
  94949. * @param updatable defines if the data must be flagged as updatable (or static)
  94950. * @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
  94951. * @returns the current mesh
  94952. */
  94953. setVerticesData(kind: string, data: FloatArray, updatable?: boolean, stride?: number): AbstractMesh;
  94954. /**
  94955. * Updates the existing vertex data of the mesh geometry for the requested `kind`.
  94956. * If the mesh has no geometry, it is simply returned as it is.
  94957. * @param kind defines vertex data kind:
  94958. * * VertexBuffer.PositionKind
  94959. * * VertexBuffer.UVKind
  94960. * * VertexBuffer.UV2Kind
  94961. * * VertexBuffer.UV3Kind
  94962. * * VertexBuffer.UV4Kind
  94963. * * VertexBuffer.UV5Kind
  94964. * * VertexBuffer.UV6Kind
  94965. * * VertexBuffer.ColorKind
  94966. * * VertexBuffer.MatricesIndicesKind
  94967. * * VertexBuffer.MatricesIndicesExtraKind
  94968. * * VertexBuffer.MatricesWeightsKind
  94969. * * VertexBuffer.MatricesWeightsExtraKind
  94970. * @param data defines the data source
  94971. * @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
  94972. * @param makeItUnique If true, a new global geometry is created from this data and is set to the mesh
  94973. * @returns the current mesh
  94974. */
  94975. updateVerticesData(kind: string, data: FloatArray, updateExtends?: boolean, makeItUnique?: boolean): AbstractMesh;
  94976. /**
  94977. * Sets the mesh indices,
  94978. * If the mesh has no geometry, a new Geometry object is created and set to the mesh.
  94979. * @param indices Expects an array populated with integers or a typed array (Int32Array, Uint32Array, Uint16Array)
  94980. * @param totalVertices Defines the total number of vertices
  94981. * @returns the current mesh
  94982. */
  94983. setIndices(indices: IndicesArray, totalVertices: Nullable<number>): AbstractMesh;
  94984. /**
  94985. * Gets a boolean indicating if specific vertex data is present
  94986. * @param kind defines the vertex data kind to use
  94987. * @returns true is data kind is present
  94988. */
  94989. isVerticesDataPresent(kind: string): boolean;
  94990. /**
  94991. * Returns the mesh BoundingInfo object or creates a new one and returns if it was undefined.
  94992. * Note that it returns a shallow bounding of the mesh (i.e. it does not include children).
  94993. * To get the full bounding of all children, call `getHierarchyBoundingVectors` instead.
  94994. * @returns a BoundingInfo
  94995. */
  94996. getBoundingInfo(): BoundingInfo;
  94997. /**
  94998. * Uniformly scales the mesh to fit inside of a unit cube (1 X 1 X 1 units)
  94999. * @param includeDescendants Use the hierarchy's bounding box instead of the mesh's bounding box. Default is false
  95000. * @param ignoreRotation ignore rotation when computing the scale (ie. object will be axis aligned). Default is false
  95001. * @param predicate predicate that is passed in to getHierarchyBoundingVectors when selecting which object should be included when scaling
  95002. * @returns the current mesh
  95003. */
  95004. normalizeToUnitCube(includeDescendants?: boolean, ignoreRotation?: boolean, predicate?: Nullable<(node: AbstractMesh) => boolean>): AbstractMesh;
  95005. /**
  95006. * Overwrite the current bounding info
  95007. * @param boundingInfo defines the new bounding info
  95008. * @returns the current mesh
  95009. */
  95010. setBoundingInfo(boundingInfo: BoundingInfo): AbstractMesh;
  95011. /** Gets a boolean indicating if this mesh has skinning data and an attached skeleton */
  95012. readonly useBones: boolean;
  95013. /** @hidden */
  95014. _preActivate(): void;
  95015. /** @hidden */
  95016. _preActivateForIntermediateRendering(renderId: number): void;
  95017. /** @hidden */
  95018. _activate(renderId: number, intermediateRendering: boolean): boolean;
  95019. /** @hidden */
  95020. _postActivate(): void;
  95021. /** @hidden */
  95022. _freeze(): void;
  95023. /** @hidden */
  95024. _unFreeze(): void;
  95025. /**
  95026. * Gets the current world matrix
  95027. * @returns a Matrix
  95028. */
  95029. getWorldMatrix(): Matrix;
  95030. /** @hidden */
  95031. _getWorldMatrixDeterminant(): number;
  95032. /**
  95033. * Gets a boolean indicating if this mesh is an instance or a regular mesh
  95034. */
  95035. readonly isAnInstance: boolean;
  95036. /**
  95037. * Gets a boolean indicating if this mesh has instances
  95038. */
  95039. readonly hasInstances: boolean;
  95040. /**
  95041. * Perform relative position change from the point of view of behind the front of the mesh.
  95042. * This is performed taking into account the meshes current rotation, so you do not have to care.
  95043. * Supports definition of mesh facing forward or backward
  95044. * @param amountRight defines the distance on the right axis
  95045. * @param amountUp defines the distance on the up axis
  95046. * @param amountForward defines the distance on the forward axis
  95047. * @returns the current mesh
  95048. */
  95049. movePOV(amountRight: number, amountUp: number, amountForward: number): AbstractMesh;
  95050. /**
  95051. * Calculate relative position change from the point of view of behind the front of the mesh.
  95052. * This is performed taking into account the meshes current rotation, so you do not have to care.
  95053. * Supports definition of mesh facing forward or backward
  95054. * @param amountRight defines the distance on the right axis
  95055. * @param amountUp defines the distance on the up axis
  95056. * @param amountForward defines the distance on the forward axis
  95057. * @returns the new displacement vector
  95058. */
  95059. calcMovePOV(amountRight: number, amountUp: number, amountForward: number): Vector3;
  95060. /**
  95061. * Perform relative rotation change from the point of view of behind the front of the mesh.
  95062. * Supports definition of mesh facing forward or backward
  95063. * @param flipBack defines the flip
  95064. * @param twirlClockwise defines the twirl
  95065. * @param tiltRight defines the tilt
  95066. * @returns the current mesh
  95067. */
  95068. rotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): AbstractMesh;
  95069. /**
  95070. * Calculate relative rotation change from the point of view of behind the front of the mesh.
  95071. * Supports definition of mesh facing forward or backward.
  95072. * @param flipBack defines the flip
  95073. * @param twirlClockwise defines the twirl
  95074. * @param tiltRight defines the tilt
  95075. * @returns the new rotation vector
  95076. */
  95077. calcRotatePOV(flipBack: number, twirlClockwise: number, tiltRight: number): Vector3;
  95078. /**
  95079. * This method recomputes and sets a new BoundingInfo to the mesh unless it is locked.
  95080. * This means the mesh underlying bounding box and sphere are recomputed.
  95081. * @param applySkeleton defines whether to apply the skeleton before computing the bounding info
  95082. * @returns the current mesh
  95083. */
  95084. refreshBoundingInfo(applySkeleton?: boolean): AbstractMesh;
  95085. /** @hidden */
  95086. _refreshBoundingInfo(data: Nullable<FloatArray>, bias: Nullable<Vector2>): void;
  95087. /** @hidden */
  95088. _getPositionData(applySkeleton: boolean): Nullable<FloatArray>;
  95089. /** @hidden */
  95090. _updateBoundingInfo(): AbstractMesh;
  95091. /** @hidden */
  95092. _updateSubMeshesBoundingInfo(matrix: DeepImmutable<Matrix>): AbstractMesh;
  95093. /** @hidden */
  95094. protected _afterComputeWorldMatrix(): void;
  95095. /** @hidden */
  95096. readonly _effectiveMesh: AbstractMesh;
  95097. /**
  95098. * Returns `true` if the mesh is within the frustum defined by the passed array of planes.
  95099. * A mesh is in the frustum if its bounding box intersects the frustum
  95100. * @param frustumPlanes defines the frustum to test
  95101. * @returns true if the mesh is in the frustum planes
  95102. */
  95103. isInFrustum(frustumPlanes: Plane[]): boolean;
  95104. /**
  95105. * Returns `true` if the mesh is completely in the frustum defined be the passed array of planes.
  95106. * A mesh is completely in the frustum if its bounding box it completely inside the frustum.
  95107. * @param frustumPlanes defines the frustum to test
  95108. * @returns true if the mesh is completely in the frustum planes
  95109. */
  95110. isCompletelyInFrustum(frustumPlanes: Plane[]): boolean;
  95111. /**
  95112. * True if the mesh intersects another mesh or a SolidParticle object
  95113. * @param mesh defines a target mesh or SolidParticle to test
  95114. * @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)
  95115. * @param includeDescendants Can be set to true to test if the mesh defined in parameters intersects with the current mesh or any child meshes
  95116. * @returns true if there is an intersection
  95117. */
  95118. intersectsMesh(mesh: AbstractMesh | SolidParticle, precise?: boolean, includeDescendants?: boolean): boolean;
  95119. /**
  95120. * Returns true if the passed point (Vector3) is inside the mesh bounding box
  95121. * @param point defines the point to test
  95122. * @returns true if there is an intersection
  95123. */
  95124. intersectsPoint(point: Vector3): boolean;
  95125. /**
  95126. * Gets or sets a boolean indicating that this mesh can be used in the collision engine
  95127. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  95128. */
  95129. checkCollisions: boolean;
  95130. /**
  95131. * Gets Collider object used to compute collisions (not physics)
  95132. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  95133. */
  95134. readonly collider: Nullable<Collider>;
  95135. /**
  95136. * Move the mesh using collision engine
  95137. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  95138. * @param displacement defines the requested displacement vector
  95139. * @returns the current mesh
  95140. */
  95141. moveWithCollisions(displacement: Vector3): AbstractMesh;
  95142. private _onCollisionPositionChange;
  95143. /** @hidden */
  95144. _collideForSubMesh(subMesh: SubMesh, transformMatrix: Matrix, collider: Collider): AbstractMesh;
  95145. /** @hidden */
  95146. _processCollisionsForSubMeshes(collider: Collider, transformMatrix: Matrix): AbstractMesh;
  95147. /** @hidden */
  95148. _checkCollision(collider: Collider): AbstractMesh;
  95149. /** @hidden */
  95150. _generatePointsArray(): boolean;
  95151. /**
  95152. * Checks if the passed Ray intersects with the mesh
  95153. * @param ray defines the ray to use
  95154. * @param fastCheck defines if fast mode (but less precise) must be used (false by default)
  95155. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  95156. * @returns the picking info
  95157. * @see http://doc.babylonjs.com/babylon101/intersect_collisions_-_mesh
  95158. */
  95159. intersects(ray: Ray, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): PickingInfo;
  95160. /**
  95161. * Clones the current mesh
  95162. * @param name defines the mesh name
  95163. * @param newParent defines the new mesh parent
  95164. * @param doNotCloneChildren defines a boolean indicating that children must not be cloned (false by default)
  95165. * @returns the new mesh
  95166. */
  95167. clone(name: string, newParent: Nullable<Node>, doNotCloneChildren?: boolean): Nullable<AbstractMesh>;
  95168. /**
  95169. * Disposes all the submeshes of the current meshnp
  95170. * @returns the current mesh
  95171. */
  95172. releaseSubMeshes(): AbstractMesh;
  95173. /**
  95174. * Releases resources associated with this abstract mesh.
  95175. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  95176. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  95177. */
  95178. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  95179. /**
  95180. * Adds the passed mesh as a child to the current mesh
  95181. * @param mesh defines the child mesh
  95182. * @returns the current mesh
  95183. */
  95184. addChild(mesh: AbstractMesh): AbstractMesh;
  95185. /**
  95186. * Removes the passed mesh from the current mesh children list
  95187. * @param mesh defines the child mesh
  95188. * @returns the current mesh
  95189. */
  95190. removeChild(mesh: AbstractMesh): AbstractMesh;
  95191. /** @hidden */
  95192. private _initFacetData;
  95193. /**
  95194. * Updates the mesh facetData arrays and the internal partitioning when the mesh is morphed or updated.
  95195. * This method can be called within the render loop.
  95196. * 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
  95197. * @returns the current mesh
  95198. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  95199. */
  95200. updateFacetData(): AbstractMesh;
  95201. /**
  95202. * Returns the facetLocalNormals array.
  95203. * The normals are expressed in the mesh local spac
  95204. * @returns an array of Vector3
  95205. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  95206. */
  95207. getFacetLocalNormals(): Vector3[];
  95208. /**
  95209. * Returns the facetLocalPositions array.
  95210. * The facet positions are expressed in the mesh local space
  95211. * @returns an array of Vector3
  95212. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  95213. */
  95214. getFacetLocalPositions(): Vector3[];
  95215. /**
  95216. * Returns the facetLocalPartioning array
  95217. * @returns an array of array of numbers
  95218. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  95219. */
  95220. getFacetLocalPartitioning(): number[][];
  95221. /**
  95222. * Returns the i-th facet position in the world system.
  95223. * This method allocates a new Vector3 per call
  95224. * @param i defines the facet index
  95225. * @returns a new Vector3
  95226. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  95227. */
  95228. getFacetPosition(i: number): Vector3;
  95229. /**
  95230. * Sets the reference Vector3 with the i-th facet position in the world system
  95231. * @param i defines the facet index
  95232. * @param ref defines the target vector
  95233. * @returns the current mesh
  95234. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  95235. */
  95236. getFacetPositionToRef(i: number, ref: Vector3): AbstractMesh;
  95237. /**
  95238. * Returns the i-th facet normal in the world system.
  95239. * This method allocates a new Vector3 per call
  95240. * @param i defines the facet index
  95241. * @returns a new Vector3
  95242. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  95243. */
  95244. getFacetNormal(i: number): Vector3;
  95245. /**
  95246. * Sets the reference Vector3 with the i-th facet normal in the world system
  95247. * @param i defines the facet index
  95248. * @param ref defines the target vector
  95249. * @returns the current mesh
  95250. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  95251. */
  95252. getFacetNormalToRef(i: number, ref: Vector3): this;
  95253. /**
  95254. * 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)
  95255. * @param x defines x coordinate
  95256. * @param y defines y coordinate
  95257. * @param z defines z coordinate
  95258. * @returns the array of facet indexes
  95259. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  95260. */
  95261. getFacetsAtLocalCoordinates(x: number, y: number, z: number): Nullable<number[]>;
  95262. /**
  95263. * Returns the closest mesh facet index at (x,y,z) World coordinates, null if not found
  95264. * @param projected sets as the (x,y,z) world projection on the facet
  95265. * @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
  95266. * @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
  95267. * @param x defines x coordinate
  95268. * @param y defines y coordinate
  95269. * @param z defines z coordinate
  95270. * @returns the face index if found (or null instead)
  95271. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  95272. */
  95273. getClosestFacetAtCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  95274. /**
  95275. * Returns the closest mesh facet index at (x,y,z) local coordinates, null if not found
  95276. * @param projected sets as the (x,y,z) local projection on the facet
  95277. * @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
  95278. * @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
  95279. * @param x defines x coordinate
  95280. * @param y defines y coordinate
  95281. * @param z defines z coordinate
  95282. * @returns the face index if found (or null instead)
  95283. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  95284. */
  95285. getClosestFacetAtLocalCoordinates(x: number, y: number, z: number, projected?: Vector3, checkFace?: boolean, facing?: boolean): Nullable<number>;
  95286. /**
  95287. * Returns the object "parameter" set with all the expected parameters for facetData computation by ComputeNormals()
  95288. * @returns the parameters
  95289. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  95290. */
  95291. getFacetDataParameters(): any;
  95292. /**
  95293. * Disables the feature FacetData and frees the related memory
  95294. * @returns the current mesh
  95295. * @see http://doc.babylonjs.com/how_to/how_to_use_facetdata
  95296. */
  95297. disableFacetData(): AbstractMesh;
  95298. /**
  95299. * Updates the AbstractMesh indices array
  95300. * @param indices defines the data source
  95301. * @param offset defines the offset in the index buffer where to store the new data (can be null)
  95302. * @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)
  95303. * @returns the current mesh
  95304. */
  95305. updateIndices(indices: IndicesArray, offset?: number, gpuMemoryOnly?: boolean): AbstractMesh;
  95306. /**
  95307. * Creates new normals data for the mesh
  95308. * @param updatable defines if the normal vertex buffer must be flagged as updatable
  95309. * @returns the current mesh
  95310. */
  95311. createNormals(updatable: boolean): AbstractMesh;
  95312. /**
  95313. * Align the mesh with a normal
  95314. * @param normal defines the normal to use
  95315. * @param upDirection can be used to redefined the up vector to use (will use the (0, 1, 0) by default)
  95316. * @returns the current mesh
  95317. */
  95318. alignWithNormal(normal: Vector3, upDirection?: Vector3): AbstractMesh;
  95319. /** @hidden */
  95320. _checkOcclusionQuery(): boolean;
  95321. /**
  95322. * Disables the mesh edge rendering mode
  95323. * @returns the currentAbstractMesh
  95324. */
  95325. disableEdgesRendering(): AbstractMesh;
  95326. /**
  95327. * Enables the edge rendering mode on the mesh.
  95328. * This mode makes the mesh edges visible
  95329. * @param epsilon defines the maximal distance between two angles to detect a face
  95330. * @param checkVerticesInsteadOfIndices indicates that we should check vertex list directly instead of faces
  95331. * @returns the currentAbstractMesh
  95332. * @see https://www.babylonjs-playground.com/#19O9TU#0
  95333. */
  95334. enableEdgesRendering(epsilon?: number, checkVerticesInsteadOfIndices?: boolean): AbstractMesh;
  95335. }
  95336. }
  95337. declare module BABYLON {
  95338. /**
  95339. * Interface used to define ActionEvent
  95340. */
  95341. export interface IActionEvent {
  95342. /** The mesh or sprite that triggered the action */
  95343. source: any;
  95344. /** The X mouse cursor position at the time of the event */
  95345. pointerX: number;
  95346. /** The Y mouse cursor position at the time of the event */
  95347. pointerY: number;
  95348. /** The mesh that is currently pointed at (can be null) */
  95349. meshUnderPointer: Nullable<AbstractMesh>;
  95350. /** the original (browser) event that triggered the ActionEvent */
  95351. sourceEvent?: any;
  95352. /** additional data for the event */
  95353. additionalData?: any;
  95354. }
  95355. /**
  95356. * ActionEvent is the event being sent when an action is triggered.
  95357. */
  95358. export class ActionEvent implements IActionEvent {
  95359. /** The mesh or sprite that triggered the action */
  95360. source: any;
  95361. /** The X mouse cursor position at the time of the event */
  95362. pointerX: number;
  95363. /** The Y mouse cursor position at the time of the event */
  95364. pointerY: number;
  95365. /** The mesh that is currently pointed at (can be null) */
  95366. meshUnderPointer: Nullable<AbstractMesh>;
  95367. /** the original (browser) event that triggered the ActionEvent */
  95368. sourceEvent?: any;
  95369. /** additional data for the event */
  95370. additionalData?: any;
  95371. /**
  95372. * Creates a new ActionEvent
  95373. * @param source The mesh or sprite that triggered the action
  95374. * @param pointerX The X mouse cursor position at the time of the event
  95375. * @param pointerY The Y mouse cursor position at the time of the event
  95376. * @param meshUnderPointer The mesh that is currently pointed at (can be null)
  95377. * @param sourceEvent the original (browser) event that triggered the ActionEvent
  95378. * @param additionalData additional data for the event
  95379. */
  95380. constructor(
  95381. /** The mesh or sprite that triggered the action */
  95382. source: any,
  95383. /** The X mouse cursor position at the time of the event */
  95384. pointerX: number,
  95385. /** The Y mouse cursor position at the time of the event */
  95386. pointerY: number,
  95387. /** The mesh that is currently pointed at (can be null) */
  95388. meshUnderPointer: Nullable<AbstractMesh>,
  95389. /** the original (browser) event that triggered the ActionEvent */
  95390. sourceEvent?: any,
  95391. /** additional data for the event */
  95392. additionalData?: any);
  95393. /**
  95394. * Helper function to auto-create an ActionEvent from a source mesh.
  95395. * @param source The source mesh that triggered the event
  95396. * @param evt The original (browser) event
  95397. * @param additionalData additional data for the event
  95398. * @returns the new ActionEvent
  95399. */
  95400. static CreateNew(source: AbstractMesh, evt?: Event, additionalData?: any): ActionEvent;
  95401. /**
  95402. * Helper function to auto-create an ActionEvent from a source sprite
  95403. * @param source The source sprite that triggered the event
  95404. * @param scene Scene associated with the sprite
  95405. * @param evt The original (browser) event
  95406. * @param additionalData additional data for the event
  95407. * @returns the new ActionEvent
  95408. */
  95409. static CreateNewFromSprite(source: Sprite, scene: Scene, evt?: Event, additionalData?: any): ActionEvent;
  95410. /**
  95411. * Helper function to auto-create an ActionEvent from a scene. If triggered by a mesh use ActionEvent.CreateNew
  95412. * @param scene the scene where the event occurred
  95413. * @param evt The original (browser) event
  95414. * @returns the new ActionEvent
  95415. */
  95416. static CreateNewFromScene(scene: Scene, evt: Event): ActionEvent;
  95417. /**
  95418. * Helper function to auto-create an ActionEvent from a primitive
  95419. * @param prim defines the target primitive
  95420. * @param pointerPos defines the pointer position
  95421. * @param evt The original (browser) event
  95422. * @param additionalData additional data for the event
  95423. * @returns the new ActionEvent
  95424. */
  95425. static CreateNewFromPrimitive(prim: any, pointerPos: Vector2, evt?: Event, additionalData?: any): ActionEvent;
  95426. }
  95427. }
  95428. declare module BABYLON {
  95429. /**
  95430. * Abstract class used to decouple action Manager from scene and meshes.
  95431. * Do not instantiate.
  95432. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  95433. */
  95434. export abstract class AbstractActionManager implements IDisposable {
  95435. /** Gets the list of active triggers */
  95436. static Triggers: {
  95437. [key: string]: number;
  95438. };
  95439. /** Gets the cursor to use when hovering items */
  95440. hoverCursor: string;
  95441. /** Gets the list of actions */
  95442. actions: IAction[];
  95443. /**
  95444. * Gets or sets a boolean indicating that the manager is recursive meaning that it can trigger action from children
  95445. */
  95446. isRecursive: boolean;
  95447. /**
  95448. * Releases all associated resources
  95449. */
  95450. abstract dispose(): void;
  95451. /**
  95452. * Does this action manager has pointer triggers
  95453. */
  95454. abstract readonly hasPointerTriggers: boolean;
  95455. /**
  95456. * Does this action manager has pick triggers
  95457. */
  95458. abstract readonly hasPickTriggers: boolean;
  95459. /**
  95460. * Process a specific trigger
  95461. * @param trigger defines the trigger to process
  95462. * @param evt defines the event details to be processed
  95463. */
  95464. abstract processTrigger(trigger: number, evt?: IActionEvent): void;
  95465. /**
  95466. * Does this action manager handles actions of any of the given triggers
  95467. * @param triggers defines the triggers to be tested
  95468. * @return a boolean indicating whether one (or more) of the triggers is handled
  95469. */
  95470. abstract hasSpecificTriggers(triggers: number[]): boolean;
  95471. /**
  95472. * Does this action manager handles actions of any of the given triggers. This function takes two arguments for
  95473. * speed.
  95474. * @param triggerA defines the trigger to be tested
  95475. * @param triggerB defines the trigger to be tested
  95476. * @return a boolean indicating whether one (or more) of the triggers is handled
  95477. */
  95478. abstract hasSpecificTriggers2(triggerA: number, triggerB: number): boolean;
  95479. /**
  95480. * Does this action manager handles actions of a given trigger
  95481. * @param trigger defines the trigger to be tested
  95482. * @param parameterPredicate defines an optional predicate to filter triggers by parameter
  95483. * @return whether the trigger is handled
  95484. */
  95485. abstract hasSpecificTrigger(trigger: number, parameterPredicate?: (parameter: any) => boolean): boolean;
  95486. /**
  95487. * Serialize this manager to a JSON object
  95488. * @param name defines the property name to store this manager
  95489. * @returns a JSON representation of this manager
  95490. */
  95491. abstract serialize(name: string): any;
  95492. /**
  95493. * Registers an action to this action manager
  95494. * @param action defines the action to be registered
  95495. * @return the action amended (prepared) after registration
  95496. */
  95497. abstract registerAction(action: IAction): Nullable<IAction>;
  95498. /**
  95499. * Unregisters an action to this action manager
  95500. * @param action defines the action to be unregistered
  95501. * @return a boolean indicating whether the action has been unregistered
  95502. */
  95503. abstract unregisterAction(action: IAction): Boolean;
  95504. /**
  95505. * Does exist one action manager with at least one trigger
  95506. **/
  95507. static readonly HasTriggers: boolean;
  95508. /**
  95509. * Does exist one action manager with at least one pick trigger
  95510. **/
  95511. static readonly HasPickTriggers: boolean;
  95512. /**
  95513. * Does exist one action manager that handles actions of a given trigger
  95514. * @param trigger defines the trigger to be tested
  95515. * @return a boolean indicating whether the trigger is handeled by at least one action manager
  95516. **/
  95517. static HasSpecificTrigger(trigger: number): boolean;
  95518. }
  95519. }
  95520. declare module BABYLON {
  95521. /**
  95522. * Defines how a node can be built from a string name.
  95523. */
  95524. export type NodeConstructor = (name: string, scene: Scene, options?: any) => () => Node;
  95525. /**
  95526. * Node is the basic class for all scene objects (Mesh, Light, Camera.)
  95527. */
  95528. export class Node implements IBehaviorAware<Node> {
  95529. /** @hidden */
  95530. static _AnimationRangeFactory: (name: string, from: number, to: number) => AnimationRange;
  95531. private static _NodeConstructors;
  95532. /**
  95533. * Add a new node constructor
  95534. * @param type defines the type name of the node to construct
  95535. * @param constructorFunc defines the constructor function
  95536. */
  95537. static AddNodeConstructor(type: string, constructorFunc: NodeConstructor): void;
  95538. /**
  95539. * Returns a node constructor based on type name
  95540. * @param type defines the type name
  95541. * @param name defines the new node name
  95542. * @param scene defines the hosting scene
  95543. * @param options defines optional options to transmit to constructors
  95544. * @returns the new constructor or null
  95545. */
  95546. static Construct(type: string, name: string, scene: Scene, options?: any): Nullable<() => Node>;
  95547. /**
  95548. * Gets or sets the name of the node
  95549. */
  95550. name: string;
  95551. /**
  95552. * Gets or sets the id of the node
  95553. */
  95554. id: string;
  95555. /**
  95556. * Gets or sets the unique id of the node
  95557. */
  95558. uniqueId: number;
  95559. /**
  95560. * Gets or sets a string used to store user defined state for the node
  95561. */
  95562. state: string;
  95563. /**
  95564. * Gets or sets an object used to store user defined information for the node
  95565. */
  95566. metadata: any;
  95567. /**
  95568. * For internal use only. Please do not use.
  95569. */
  95570. reservedDataStore: any;
  95571. /**
  95572. * List of inspectable custom properties (used by the Inspector)
  95573. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  95574. */
  95575. inspectableCustomProperties: IInspectable[];
  95576. private _doNotSerialize;
  95577. /**
  95578. * Gets or sets a boolean used to define if the node must be serialized
  95579. */
  95580. doNotSerialize: boolean;
  95581. /** @hidden */
  95582. _isDisposed: boolean;
  95583. /**
  95584. * Gets a list of Animations associated with the node
  95585. */
  95586. animations: Animation[];
  95587. protected _ranges: {
  95588. [name: string]: Nullable<AnimationRange>;
  95589. };
  95590. /**
  95591. * Callback raised when the node is ready to be used
  95592. */
  95593. onReady: Nullable<(node: Node) => void>;
  95594. private _isEnabled;
  95595. private _isParentEnabled;
  95596. private _isReady;
  95597. /** @hidden */
  95598. _currentRenderId: number;
  95599. private _parentUpdateId;
  95600. /** @hidden */
  95601. _childUpdateId: number;
  95602. /** @hidden */
  95603. _waitingParentId: Nullable<string>;
  95604. /** @hidden */
  95605. _scene: Scene;
  95606. /** @hidden */
  95607. _cache: any;
  95608. private _parentNode;
  95609. private _children;
  95610. /** @hidden */
  95611. _worldMatrix: Matrix;
  95612. /** @hidden */
  95613. _worldMatrixDeterminant: number;
  95614. /** @hidden */
  95615. _worldMatrixDeterminantIsDirty: boolean;
  95616. /** @hidden */
  95617. private _sceneRootNodesIndex;
  95618. /**
  95619. * Gets a boolean indicating if the node has been disposed
  95620. * @returns true if the node was disposed
  95621. */
  95622. isDisposed(): boolean;
  95623. /**
  95624. * Gets or sets the parent of the node (without keeping the current position in the scene)
  95625. * @see https://doc.babylonjs.com/how_to/parenting
  95626. */
  95627. parent: Nullable<Node>;
  95628. /** @hidden */
  95629. _addToSceneRootNodes(): void;
  95630. /** @hidden */
  95631. _removeFromSceneRootNodes(): void;
  95632. private _animationPropertiesOverride;
  95633. /**
  95634. * Gets or sets the animation properties override
  95635. */
  95636. animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  95637. /**
  95638. * Gets a string idenfifying the name of the class
  95639. * @returns "Node" string
  95640. */
  95641. getClassName(): string;
  95642. /** @hidden */
  95643. readonly _isNode: boolean;
  95644. /**
  95645. * An event triggered when the mesh is disposed
  95646. */
  95647. onDisposeObservable: Observable<Node>;
  95648. private _onDisposeObserver;
  95649. /**
  95650. * Sets a callback that will be raised when the node will be disposed
  95651. */
  95652. onDispose: () => void;
  95653. /**
  95654. * Creates a new Node
  95655. * @param name the name and id to be given to this node
  95656. * @param scene the scene this node will be added to
  95657. */
  95658. constructor(name: string, scene?: Nullable<Scene>);
  95659. /**
  95660. * Gets the scene of the node
  95661. * @returns a scene
  95662. */
  95663. getScene(): Scene;
  95664. /**
  95665. * Gets the engine of the node
  95666. * @returns a Engine
  95667. */
  95668. getEngine(): Engine;
  95669. private _behaviors;
  95670. /**
  95671. * Attach a behavior to the node
  95672. * @see http://doc.babylonjs.com/features/behaviour
  95673. * @param behavior defines the behavior to attach
  95674. * @param attachImmediately defines that the behavior must be attached even if the scene is still loading
  95675. * @returns the current Node
  95676. */
  95677. addBehavior(behavior: Behavior<Node>, attachImmediately?: boolean): Node;
  95678. /**
  95679. * Remove an attached behavior
  95680. * @see http://doc.babylonjs.com/features/behaviour
  95681. * @param behavior defines the behavior to attach
  95682. * @returns the current Node
  95683. */
  95684. removeBehavior(behavior: Behavior<Node>): Node;
  95685. /**
  95686. * Gets the list of attached behaviors
  95687. * @see http://doc.babylonjs.com/features/behaviour
  95688. */
  95689. readonly behaviors: Behavior<Node>[];
  95690. /**
  95691. * Gets an attached behavior by name
  95692. * @param name defines the name of the behavior to look for
  95693. * @see http://doc.babylonjs.com/features/behaviour
  95694. * @returns null if behavior was not found else the requested behavior
  95695. */
  95696. getBehaviorByName(name: string): Nullable<Behavior<Node>>;
  95697. /**
  95698. * Returns the latest update of the World matrix
  95699. * @returns a Matrix
  95700. */
  95701. getWorldMatrix(): Matrix;
  95702. /** @hidden */
  95703. _getWorldMatrixDeterminant(): number;
  95704. /**
  95705. * Returns directly the latest state of the mesh World matrix.
  95706. * A Matrix is returned.
  95707. */
  95708. readonly worldMatrixFromCache: Matrix;
  95709. /** @hidden */
  95710. _initCache(): void;
  95711. /** @hidden */
  95712. updateCache(force?: boolean): void;
  95713. /** @hidden */
  95714. _getActionManagerForTrigger(trigger?: number, initialCall?: boolean): Nullable<AbstractActionManager>;
  95715. /** @hidden */
  95716. _updateCache(ignoreParentClass?: boolean): void;
  95717. /** @hidden */
  95718. _isSynchronized(): boolean;
  95719. /** @hidden */
  95720. _markSyncedWithParent(): void;
  95721. /** @hidden */
  95722. isSynchronizedWithParent(): boolean;
  95723. /** @hidden */
  95724. isSynchronized(): boolean;
  95725. /**
  95726. * Is this node ready to be used/rendered
  95727. * @param completeCheck defines if a complete check (including materials and lights) has to be done (false by default)
  95728. * @return true if the node is ready
  95729. */
  95730. isReady(completeCheck?: boolean): boolean;
  95731. /**
  95732. * Is this node enabled?
  95733. * 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
  95734. * @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
  95735. * @return whether this node (and its parent) is enabled
  95736. */
  95737. isEnabled(checkAncestors?: boolean): boolean;
  95738. /** @hidden */
  95739. protected _syncParentEnabledState(): void;
  95740. /**
  95741. * Set the enabled state of this node
  95742. * @param value defines the new enabled state
  95743. */
  95744. setEnabled(value: boolean): void;
  95745. /**
  95746. * Is this node a descendant of the given node?
  95747. * The function will iterate up the hierarchy until the ancestor was found or no more parents defined
  95748. * @param ancestor defines the parent node to inspect
  95749. * @returns a boolean indicating if this node is a descendant of the given node
  95750. */
  95751. isDescendantOf(ancestor: Node): boolean;
  95752. /** @hidden */
  95753. _getDescendants(results: Node[], directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): void;
  95754. /**
  95755. * Will return all nodes that have this node as ascendant
  95756. * @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
  95757. * @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
  95758. * @return all children nodes of all types
  95759. */
  95760. getDescendants(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): Node[];
  95761. /**
  95762. * Get all child-meshes of this node
  95763. * @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)
  95764. * @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
  95765. * @returns an array of AbstractMesh
  95766. */
  95767. getChildMeshes(directDescendantsOnly?: boolean, predicate?: (node: Node) => boolean): AbstractMesh[];
  95768. /**
  95769. * Get all direct children of this node
  95770. * @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
  95771. * @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)
  95772. * @returns an array of Node
  95773. */
  95774. getChildren(predicate?: (node: Node) => boolean, directDescendantsOnly?: boolean): Node[];
  95775. /** @hidden */
  95776. _setReady(state: boolean): void;
  95777. /**
  95778. * Get an animation by name
  95779. * @param name defines the name of the animation to look for
  95780. * @returns null if not found else the requested animation
  95781. */
  95782. getAnimationByName(name: string): Nullable<Animation>;
  95783. /**
  95784. * Creates an animation range for this node
  95785. * @param name defines the name of the range
  95786. * @param from defines the starting key
  95787. * @param to defines the end key
  95788. */
  95789. createAnimationRange(name: string, from: number, to: number): void;
  95790. /**
  95791. * Delete a specific animation range
  95792. * @param name defines the name of the range to delete
  95793. * @param deleteFrames defines if animation frames from the range must be deleted as well
  95794. */
  95795. deleteAnimationRange(name: string, deleteFrames?: boolean): void;
  95796. /**
  95797. * Get an animation range by name
  95798. * @param name defines the name of the animation range to look for
  95799. * @returns null if not found else the requested animation range
  95800. */
  95801. getAnimationRange(name: string): Nullable<AnimationRange>;
  95802. /**
  95803. * Gets the list of all animation ranges defined on this node
  95804. * @returns an array
  95805. */
  95806. getAnimationRanges(): Nullable<AnimationRange>[];
  95807. /**
  95808. * Will start the animation sequence
  95809. * @param name defines the range frames for animation sequence
  95810. * @param loop defines if the animation should loop (false by default)
  95811. * @param speedRatio defines the speed factor in which to run the animation (1 by default)
  95812. * @param onAnimationEnd defines a function to be executed when the animation ended (undefined by default)
  95813. * @returns the object created for this animation. If range does not exist, it will return null
  95814. */
  95815. beginAnimation(name: string, loop?: boolean, speedRatio?: number, onAnimationEnd?: () => void): Nullable<Animatable>;
  95816. /**
  95817. * Serialize animation ranges into a JSON compatible object
  95818. * @returns serialization object
  95819. */
  95820. serializeAnimationRanges(): any;
  95821. /**
  95822. * Computes the world matrix of the node
  95823. * @param force defines if the cache version should be invalidated forcing the world matrix to be created from scratch
  95824. * @returns the world matrix
  95825. */
  95826. computeWorldMatrix(force?: boolean): Matrix;
  95827. /**
  95828. * Releases resources associated with this node.
  95829. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  95830. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  95831. */
  95832. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  95833. /**
  95834. * Parse animation range data from a serialization object and store them into a given node
  95835. * @param node defines where to store the animation ranges
  95836. * @param parsedNode defines the serialization object to read data from
  95837. * @param scene defines the hosting scene
  95838. */
  95839. static ParseAnimationRanges(node: Node, parsedNode: any, scene: Scene): void;
  95840. /**
  95841. * Return the minimum and maximum world vectors of the entire hierarchy under current node
  95842. * @param includeDescendants Include bounding info from descendants as well (true by default)
  95843. * @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
  95844. * @returns the new bounding vectors
  95845. */
  95846. getHierarchyBoundingVectors(includeDescendants?: boolean, predicate?: Nullable<(abstractMesh: AbstractMesh) => boolean>): {
  95847. min: Vector3;
  95848. max: Vector3;
  95849. };
  95850. }
  95851. }
  95852. declare module BABYLON {
  95853. /**
  95854. * @hidden
  95855. */
  95856. export class _IAnimationState {
  95857. key: number;
  95858. repeatCount: number;
  95859. workValue?: any;
  95860. loopMode?: number;
  95861. offsetValue?: any;
  95862. highLimitValue?: any;
  95863. }
  95864. /**
  95865. * Class used to store any kind of animation
  95866. */
  95867. export class Animation {
  95868. /**Name of the animation */
  95869. name: string;
  95870. /**Property to animate */
  95871. targetProperty: string;
  95872. /**The frames per second of the animation */
  95873. framePerSecond: number;
  95874. /**The data type of the animation */
  95875. dataType: number;
  95876. /**The loop mode of the animation */
  95877. loopMode?: number | undefined;
  95878. /**Specifies if blending should be enabled */
  95879. enableBlending?: boolean | undefined;
  95880. /**
  95881. * Use matrix interpolation instead of using direct key value when animating matrices
  95882. */
  95883. static AllowMatricesInterpolation: boolean;
  95884. /**
  95885. * When matrix interpolation is enabled, this boolean forces the system to use Matrix.DecomposeLerp instead of Matrix.Lerp. Interpolation is more precise but slower
  95886. */
  95887. static AllowMatrixDecomposeForInterpolation: boolean;
  95888. /**
  95889. * Stores the key frames of the animation
  95890. */
  95891. private _keys;
  95892. /**
  95893. * Stores the easing function of the animation
  95894. */
  95895. private _easingFunction;
  95896. /**
  95897. * @hidden Internal use only
  95898. */
  95899. _runtimeAnimations: RuntimeAnimation[];
  95900. /**
  95901. * The set of event that will be linked to this animation
  95902. */
  95903. private _events;
  95904. /**
  95905. * Stores an array of target property paths
  95906. */
  95907. targetPropertyPath: string[];
  95908. /**
  95909. * Stores the blending speed of the animation
  95910. */
  95911. blendingSpeed: number;
  95912. /**
  95913. * Stores the animation ranges for the animation
  95914. */
  95915. private _ranges;
  95916. /**
  95917. * @hidden Internal use
  95918. */
  95919. static _PrepareAnimation(name: string, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction): Nullable<Animation>;
  95920. /**
  95921. * Sets up an animation
  95922. * @param property The property to animate
  95923. * @param animationType The animation type to apply
  95924. * @param framePerSecond The frames per second of the animation
  95925. * @param easingFunction The easing function used in the animation
  95926. * @returns The created animation
  95927. */
  95928. static CreateAnimation(property: string, animationType: number, framePerSecond: number, easingFunction: EasingFunction): Animation;
  95929. /**
  95930. * Create and start an animation on a node
  95931. * @param name defines the name of the global animation that will be run on all nodes
  95932. * @param node defines the root node where the animation will take place
  95933. * @param targetProperty defines property to animate
  95934. * @param framePerSecond defines the number of frame per second yo use
  95935. * @param totalFrame defines the number of frames in total
  95936. * @param from defines the initial value
  95937. * @param to defines the final value
  95938. * @param loopMode defines which loop mode you want to use (off by default)
  95939. * @param easingFunction defines the easing function to use (linear by default)
  95940. * @param onAnimationEnd defines the callback to call when animation end
  95941. * @returns the animatable created for this animation
  95942. */
  95943. static CreateAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  95944. /**
  95945. * Create and start an animation on a node and its descendants
  95946. * @param name defines the name of the global animation that will be run on all nodes
  95947. * @param node defines the root node where the animation will take place
  95948. * @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
  95949. * @param targetProperty defines property to animate
  95950. * @param framePerSecond defines the number of frame per second to use
  95951. * @param totalFrame defines the number of frames in total
  95952. * @param from defines the initial value
  95953. * @param to defines the final value
  95954. * @param loopMode defines which loop mode you want to use (off by default)
  95955. * @param easingFunction defines the easing function to use (linear by default)
  95956. * @param onAnimationEnd defines the callback to call when an animation ends (will be called once per node)
  95957. * @returns the list of animatables created for all nodes
  95958. * @example https://www.babylonjs-playground.com/#MH0VLI
  95959. */
  95960. 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[]>;
  95961. /**
  95962. * Creates a new animation, merges it with the existing animations and starts it
  95963. * @param name Name of the animation
  95964. * @param node Node which contains the scene that begins the animations
  95965. * @param targetProperty Specifies which property to animate
  95966. * @param framePerSecond The frames per second of the animation
  95967. * @param totalFrame The total number of frames
  95968. * @param from The frame at the beginning of the animation
  95969. * @param to The frame at the end of the animation
  95970. * @param loopMode Specifies the loop mode of the animation
  95971. * @param easingFunction (Optional) The easing function of the animation, which allow custom mathematical formulas for animations
  95972. * @param onAnimationEnd Callback to run once the animation is complete
  95973. * @returns Nullable animation
  95974. */
  95975. static CreateMergeAndStartAnimation(name: string, node: Node, targetProperty: string, framePerSecond: number, totalFrame: number, from: any, to: any, loopMode?: number, easingFunction?: EasingFunction, onAnimationEnd?: () => void): Nullable<Animatable>;
  95976. /**
  95977. * Transition property of an host to the target Value
  95978. * @param property The property to transition
  95979. * @param targetValue The target Value of the property
  95980. * @param host The object where the property to animate belongs
  95981. * @param scene Scene used to run the animation
  95982. * @param frameRate Framerate (in frame/s) to use
  95983. * @param transition The transition type we want to use
  95984. * @param duration The duration of the animation, in milliseconds
  95985. * @param onAnimationEnd Callback trigger at the end of the animation
  95986. * @returns Nullable animation
  95987. */
  95988. static TransitionTo(property: string, targetValue: any, host: any, scene: Scene, frameRate: number, transition: Animation, duration: number, onAnimationEnd?: Nullable<() => void>): Nullable<Animatable>;
  95989. /**
  95990. * Return the array of runtime animations currently using this animation
  95991. */
  95992. readonly runtimeAnimations: RuntimeAnimation[];
  95993. /**
  95994. * Specifies if any of the runtime animations are currently running
  95995. */
  95996. readonly hasRunningRuntimeAnimations: boolean;
  95997. /**
  95998. * Initializes the animation
  95999. * @param name Name of the animation
  96000. * @param targetProperty Property to animate
  96001. * @param framePerSecond The frames per second of the animation
  96002. * @param dataType The data type of the animation
  96003. * @param loopMode The loop mode of the animation
  96004. * @param enableBlending Specifies if blending should be enabled
  96005. */
  96006. constructor(
  96007. /**Name of the animation */
  96008. name: string,
  96009. /**Property to animate */
  96010. targetProperty: string,
  96011. /**The frames per second of the animation */
  96012. framePerSecond: number,
  96013. /**The data type of the animation */
  96014. dataType: number,
  96015. /**The loop mode of the animation */
  96016. loopMode?: number | undefined,
  96017. /**Specifies if blending should be enabled */
  96018. enableBlending?: boolean | undefined);
  96019. /**
  96020. * Converts the animation to a string
  96021. * @param fullDetails support for multiple levels of logging within scene loading
  96022. * @returns String form of the animation
  96023. */
  96024. toString(fullDetails?: boolean): string;
  96025. /**
  96026. * Add an event to this animation
  96027. * @param event Event to add
  96028. */
  96029. addEvent(event: AnimationEvent): void;
  96030. /**
  96031. * Remove all events found at the given frame
  96032. * @param frame The frame to remove events from
  96033. */
  96034. removeEvents(frame: number): void;
  96035. /**
  96036. * Retrieves all the events from the animation
  96037. * @returns Events from the animation
  96038. */
  96039. getEvents(): AnimationEvent[];
  96040. /**
  96041. * Creates an animation range
  96042. * @param name Name of the animation range
  96043. * @param from Starting frame of the animation range
  96044. * @param to Ending frame of the animation
  96045. */
  96046. createRange(name: string, from: number, to: number): void;
  96047. /**
  96048. * Deletes an animation range by name
  96049. * @param name Name of the animation range to delete
  96050. * @param deleteFrames Specifies if the key frames for the range should also be deleted (true) or not (false)
  96051. */
  96052. deleteRange(name: string, deleteFrames?: boolean): void;
  96053. /**
  96054. * Gets the animation range by name, or null if not defined
  96055. * @param name Name of the animation range
  96056. * @returns Nullable animation range
  96057. */
  96058. getRange(name: string): Nullable<AnimationRange>;
  96059. /**
  96060. * Gets the key frames from the animation
  96061. * @returns The key frames of the animation
  96062. */
  96063. getKeys(): Array<IAnimationKey>;
  96064. /**
  96065. * Gets the highest frame rate of the animation
  96066. * @returns Highest frame rate of the animation
  96067. */
  96068. getHighestFrame(): number;
  96069. /**
  96070. * Gets the easing function of the animation
  96071. * @returns Easing function of the animation
  96072. */
  96073. getEasingFunction(): IEasingFunction;
  96074. /**
  96075. * Sets the easing function of the animation
  96076. * @param easingFunction A custom mathematical formula for animation
  96077. */
  96078. setEasingFunction(easingFunction: EasingFunction): void;
  96079. /**
  96080. * Interpolates a scalar linearly
  96081. * @param startValue Start value of the animation curve
  96082. * @param endValue End value of the animation curve
  96083. * @param gradient Scalar amount to interpolate
  96084. * @returns Interpolated scalar value
  96085. */
  96086. floatInterpolateFunction(startValue: number, endValue: number, gradient: number): number;
  96087. /**
  96088. * Interpolates a scalar cubically
  96089. * @param startValue Start value of the animation curve
  96090. * @param outTangent End tangent of the animation
  96091. * @param endValue End value of the animation curve
  96092. * @param inTangent Start tangent of the animation curve
  96093. * @param gradient Scalar amount to interpolate
  96094. * @returns Interpolated scalar value
  96095. */
  96096. floatInterpolateFunctionWithTangents(startValue: number, outTangent: number, endValue: number, inTangent: number, gradient: number): number;
  96097. /**
  96098. * Interpolates a quaternion using a spherical linear interpolation
  96099. * @param startValue Start value of the animation curve
  96100. * @param endValue End value of the animation curve
  96101. * @param gradient Scalar amount to interpolate
  96102. * @returns Interpolated quaternion value
  96103. */
  96104. quaternionInterpolateFunction(startValue: Quaternion, endValue: Quaternion, gradient: number): Quaternion;
  96105. /**
  96106. * Interpolates a quaternion cubically
  96107. * @param startValue Start value of the animation curve
  96108. * @param outTangent End tangent of the animation curve
  96109. * @param endValue End value of the animation curve
  96110. * @param inTangent Start tangent of the animation curve
  96111. * @param gradient Scalar amount to interpolate
  96112. * @returns Interpolated quaternion value
  96113. */
  96114. quaternionInterpolateFunctionWithTangents(startValue: Quaternion, outTangent: Quaternion, endValue: Quaternion, inTangent: Quaternion, gradient: number): Quaternion;
  96115. /**
  96116. * Interpolates a Vector3 linearl
  96117. * @param startValue Start value of the animation curve
  96118. * @param endValue End value of the animation curve
  96119. * @param gradient Scalar amount to interpolate
  96120. * @returns Interpolated scalar value
  96121. */
  96122. vector3InterpolateFunction(startValue: Vector3, endValue: Vector3, gradient: number): Vector3;
  96123. /**
  96124. * Interpolates a Vector3 cubically
  96125. * @param startValue Start value of the animation curve
  96126. * @param outTangent End tangent of the animation
  96127. * @param endValue End value of the animation curve
  96128. * @param inTangent Start tangent of the animation curve
  96129. * @param gradient Scalar amount to interpolate
  96130. * @returns InterpolatedVector3 value
  96131. */
  96132. vector3InterpolateFunctionWithTangents(startValue: Vector3, outTangent: Vector3, endValue: Vector3, inTangent: Vector3, gradient: number): Vector3;
  96133. /**
  96134. * Interpolates a Vector2 linearly
  96135. * @param startValue Start value of the animation curve
  96136. * @param endValue End value of the animation curve
  96137. * @param gradient Scalar amount to interpolate
  96138. * @returns Interpolated Vector2 value
  96139. */
  96140. vector2InterpolateFunction(startValue: Vector2, endValue: Vector2, gradient: number): Vector2;
  96141. /**
  96142. * Interpolates a Vector2 cubically
  96143. * @param startValue Start value of the animation curve
  96144. * @param outTangent End tangent of the animation
  96145. * @param endValue End value of the animation curve
  96146. * @param inTangent Start tangent of the animation curve
  96147. * @param gradient Scalar amount to interpolate
  96148. * @returns Interpolated Vector2 value
  96149. */
  96150. vector2InterpolateFunctionWithTangents(startValue: Vector2, outTangent: Vector2, endValue: Vector2, inTangent: Vector2, gradient: number): Vector2;
  96151. /**
  96152. * Interpolates a size linearly
  96153. * @param startValue Start value of the animation curve
  96154. * @param endValue End value of the animation curve
  96155. * @param gradient Scalar amount to interpolate
  96156. * @returns Interpolated Size value
  96157. */
  96158. sizeInterpolateFunction(startValue: Size, endValue: Size, gradient: number): Size;
  96159. /**
  96160. * Interpolates a Color3 linearly
  96161. * @param startValue Start value of the animation curve
  96162. * @param endValue End value of the animation curve
  96163. * @param gradient Scalar amount to interpolate
  96164. * @returns Interpolated Color3 value
  96165. */
  96166. color3InterpolateFunction(startValue: Color3, endValue: Color3, gradient: number): Color3;
  96167. /**
  96168. * Interpolates a Color4 linearly
  96169. * @param startValue Start value of the animation curve
  96170. * @param endValue End value of the animation curve
  96171. * @param gradient Scalar amount to interpolate
  96172. * @returns Interpolated Color3 value
  96173. */
  96174. color4InterpolateFunction(startValue: Color4, endValue: Color4, gradient: number): Color4;
  96175. /**
  96176. * @hidden Internal use only
  96177. */
  96178. _getKeyValue(value: any): any;
  96179. /**
  96180. * @hidden Internal use only
  96181. */
  96182. _interpolate(currentFrame: number, state: _IAnimationState): any;
  96183. /**
  96184. * Defines the function to use to interpolate matrices
  96185. * @param startValue defines the start matrix
  96186. * @param endValue defines the end matrix
  96187. * @param gradient defines the gradient between both matrices
  96188. * @param result defines an optional target matrix where to store the interpolation
  96189. * @returns the interpolated matrix
  96190. */
  96191. matrixInterpolateFunction(startValue: Matrix, endValue: Matrix, gradient: number, result?: Matrix): Matrix;
  96192. /**
  96193. * Makes a copy of the animation
  96194. * @returns Cloned animation
  96195. */
  96196. clone(): Animation;
  96197. /**
  96198. * Sets the key frames of the animation
  96199. * @param values The animation key frames to set
  96200. */
  96201. setKeys(values: Array<IAnimationKey>): void;
  96202. /**
  96203. * Serializes the animation to an object
  96204. * @returns Serialized object
  96205. */
  96206. serialize(): any;
  96207. /**
  96208. * Float animation type
  96209. */
  96210. static readonly ANIMATIONTYPE_FLOAT: number;
  96211. /**
  96212. * Vector3 animation type
  96213. */
  96214. static readonly ANIMATIONTYPE_VECTOR3: number;
  96215. /**
  96216. * Quaternion animation type
  96217. */
  96218. static readonly ANIMATIONTYPE_QUATERNION: number;
  96219. /**
  96220. * Matrix animation type
  96221. */
  96222. static readonly ANIMATIONTYPE_MATRIX: number;
  96223. /**
  96224. * Color3 animation type
  96225. */
  96226. static readonly ANIMATIONTYPE_COLOR3: number;
  96227. /**
  96228. * Color3 animation type
  96229. */
  96230. static readonly ANIMATIONTYPE_COLOR4: number;
  96231. /**
  96232. * Vector2 animation type
  96233. */
  96234. static readonly ANIMATIONTYPE_VECTOR2: number;
  96235. /**
  96236. * Size animation type
  96237. */
  96238. static readonly ANIMATIONTYPE_SIZE: number;
  96239. /**
  96240. * Relative Loop Mode
  96241. */
  96242. static readonly ANIMATIONLOOPMODE_RELATIVE: number;
  96243. /**
  96244. * Cycle Loop Mode
  96245. */
  96246. static readonly ANIMATIONLOOPMODE_CYCLE: number;
  96247. /**
  96248. * Constant Loop Mode
  96249. */
  96250. static readonly ANIMATIONLOOPMODE_CONSTANT: number;
  96251. /** @hidden */
  96252. static _UniversalLerp(left: any, right: any, amount: number): any;
  96253. /**
  96254. * Parses an animation object and creates an animation
  96255. * @param parsedAnimation Parsed animation object
  96256. * @returns Animation object
  96257. */
  96258. static Parse(parsedAnimation: any): Animation;
  96259. /**
  96260. * Appends the serialized animations from the source animations
  96261. * @param source Source containing the animations
  96262. * @param destination Target to store the animations
  96263. */
  96264. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  96265. }
  96266. }
  96267. declare module BABYLON {
  96268. /**
  96269. * Interface containing an array of animations
  96270. */
  96271. export interface IAnimatable {
  96272. /**
  96273. * Array of animations
  96274. */
  96275. animations: Nullable<Array<Animation>>;
  96276. }
  96277. }
  96278. declare module BABYLON {
  96279. /**
  96280. * This represents all the required information to add a fresnel effect on a material:
  96281. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  96282. */
  96283. export class FresnelParameters {
  96284. private _isEnabled;
  96285. /**
  96286. * Define if the fresnel effect is enable or not.
  96287. */
  96288. isEnabled: boolean;
  96289. /**
  96290. * Define the color used on edges (grazing angle)
  96291. */
  96292. leftColor: Color3;
  96293. /**
  96294. * Define the color used on center
  96295. */
  96296. rightColor: Color3;
  96297. /**
  96298. * Define bias applied to computed fresnel term
  96299. */
  96300. bias: number;
  96301. /**
  96302. * Defined the power exponent applied to fresnel term
  96303. */
  96304. power: number;
  96305. /**
  96306. * Clones the current fresnel and its valuues
  96307. * @returns a clone fresnel configuration
  96308. */
  96309. clone(): FresnelParameters;
  96310. /**
  96311. * Serializes the current fresnel parameters to a JSON representation.
  96312. * @return the JSON serialization
  96313. */
  96314. serialize(): any;
  96315. /**
  96316. * Parse a JSON object and deserialize it to a new Fresnel parameter object.
  96317. * @param parsedFresnelParameters Define the JSON representation
  96318. * @returns the parsed parameters
  96319. */
  96320. static Parse(parsedFresnelParameters: any): FresnelParameters;
  96321. }
  96322. }
  96323. declare module BABYLON {
  96324. export function expandToProperty(callback: string, targetKey?: Nullable<string>): (target: any, propertyKey: string) => void;
  96325. export function serialize(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  96326. export function serializeAsTexture(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  96327. export function serializeAsColor3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  96328. export function serializeAsFresnelParameters(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  96329. export function serializeAsVector2(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  96330. export function serializeAsVector3(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  96331. export function serializeAsMeshReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  96332. export function serializeAsColorCurves(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  96333. export function serializeAsColor4(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  96334. export function serializeAsImageProcessingConfiguration(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  96335. export function serializeAsQuaternion(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  96336. export function serializeAsMatrix(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  96337. /**
  96338. * Decorator used to define property that can be serialized as reference to a camera
  96339. * @param sourceName defines the name of the property to decorate
  96340. */
  96341. export function serializeAsCameraReference(sourceName?: string): (target: any, propertyKey: string | symbol) => void;
  96342. /**
  96343. * Class used to help serialization objects
  96344. */
  96345. export class SerializationHelper {
  96346. /** @hidden */
  96347. static _ImageProcessingConfigurationParser: (sourceProperty: any) => ImageProcessingConfiguration;
  96348. /** @hidden */
  96349. static _FresnelParametersParser: (sourceProperty: any) => FresnelParameters;
  96350. /** @hidden */
  96351. static _ColorCurvesParser: (sourceProperty: any) => ColorCurves;
  96352. /** @hidden */
  96353. static _TextureParser: (sourceProperty: any, scene: Scene, rootUrl: string) => Nullable<BaseTexture>;
  96354. /**
  96355. * Appends the serialized animations from the source animations
  96356. * @param source Source containing the animations
  96357. * @param destination Target to store the animations
  96358. */
  96359. static AppendSerializedAnimations(source: IAnimatable, destination: any): void;
  96360. /**
  96361. * Static function used to serialized a specific entity
  96362. * @param entity defines the entity to serialize
  96363. * @param serializationObject defines the optional target obecjt where serialization data will be stored
  96364. * @returns a JSON compatible object representing the serialization of the entity
  96365. */
  96366. static Serialize<T>(entity: T, serializationObject?: any): any;
  96367. /**
  96368. * Creates a new entity from a serialization data object
  96369. * @param creationFunction defines a function used to instanciated the new entity
  96370. * @param source defines the source serialization data
  96371. * @param scene defines the hosting scene
  96372. * @param rootUrl defines the root url for resources
  96373. * @returns a new entity
  96374. */
  96375. static Parse<T>(creationFunction: () => T, source: any, scene: Nullable<Scene>, rootUrl?: Nullable<string>): T;
  96376. /**
  96377. * Clones an object
  96378. * @param creationFunction defines the function used to instanciate the new object
  96379. * @param source defines the source object
  96380. * @returns the cloned object
  96381. */
  96382. static Clone<T>(creationFunction: () => T, source: T): T;
  96383. /**
  96384. * Instanciates a new object based on a source one (some data will be shared between both object)
  96385. * @param creationFunction defines the function used to instanciate the new object
  96386. * @param source defines the source object
  96387. * @returns the new object
  96388. */
  96389. static Instanciate<T>(creationFunction: () => T, source: T): T;
  96390. }
  96391. }
  96392. declare module BABYLON {
  96393. /**
  96394. * Class used to manipulate GUIDs
  96395. */
  96396. export class GUID {
  96397. /**
  96398. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  96399. * Be aware Math.random() could cause collisions, but:
  96400. * "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"
  96401. * @returns a pseudo random id
  96402. */
  96403. static RandomId(): string;
  96404. }
  96405. }
  96406. declare module BABYLON {
  96407. /**
  96408. * Base class of all the textures in babylon.
  96409. * It groups all the common properties the materials, post process, lights... might need
  96410. * in order to make a correct use of the texture.
  96411. */
  96412. export class BaseTexture implements IAnimatable {
  96413. /**
  96414. * Default anisotropic filtering level for the application.
  96415. * It is set to 4 as a good tradeoff between perf and quality.
  96416. */
  96417. static DEFAULT_ANISOTROPIC_FILTERING_LEVEL: number;
  96418. /**
  96419. * Gets or sets the unique id of the texture
  96420. */
  96421. uniqueId: number;
  96422. /**
  96423. * Define the name of the texture.
  96424. */
  96425. name: string;
  96426. /**
  96427. * Gets or sets an object used to store user defined information.
  96428. */
  96429. metadata: any;
  96430. /**
  96431. * For internal use only. Please do not use.
  96432. */
  96433. reservedDataStore: any;
  96434. private _hasAlpha;
  96435. /**
  96436. * Define if the texture is having a usable alpha value (can be use for transparency or glossiness for instance).
  96437. */
  96438. hasAlpha: boolean;
  96439. /**
  96440. * Defines if the alpha value should be determined via the rgb values.
  96441. * If true the luminance of the pixel might be used to find the corresponding alpha value.
  96442. */
  96443. getAlphaFromRGB: boolean;
  96444. /**
  96445. * Intensity or strength of the texture.
  96446. * It is commonly used by materials to fine tune the intensity of the texture
  96447. */
  96448. level: number;
  96449. /**
  96450. * Define the UV chanel to use starting from 0 and defaulting to 0.
  96451. * This is part of the texture as textures usually maps to one uv set.
  96452. */
  96453. coordinatesIndex: number;
  96454. private _coordinatesMode;
  96455. /**
  96456. * How a texture is mapped.
  96457. *
  96458. * | Value | Type | Description |
  96459. * | ----- | ----------------------------------- | ----------- |
  96460. * | 0 | EXPLICIT_MODE | |
  96461. * | 1 | SPHERICAL_MODE | |
  96462. * | 2 | PLANAR_MODE | |
  96463. * | 3 | CUBIC_MODE | |
  96464. * | 4 | PROJECTION_MODE | |
  96465. * | 5 | SKYBOX_MODE | |
  96466. * | 6 | INVCUBIC_MODE | |
  96467. * | 7 | EQUIRECTANGULAR_MODE | |
  96468. * | 8 | FIXED_EQUIRECTANGULAR_MODE | |
  96469. * | 9 | FIXED_EQUIRECTANGULAR_MIRRORED_MODE | |
  96470. */
  96471. coordinatesMode: number;
  96472. /**
  96473. * | Value | Type | Description |
  96474. * | ----- | ------------------ | ----------- |
  96475. * | 0 | CLAMP_ADDRESSMODE | |
  96476. * | 1 | WRAP_ADDRESSMODE | |
  96477. * | 2 | MIRROR_ADDRESSMODE | |
  96478. */
  96479. wrapU: number;
  96480. /**
  96481. * | Value | Type | Description |
  96482. * | ----- | ------------------ | ----------- |
  96483. * | 0 | CLAMP_ADDRESSMODE | |
  96484. * | 1 | WRAP_ADDRESSMODE | |
  96485. * | 2 | MIRROR_ADDRESSMODE | |
  96486. */
  96487. wrapV: number;
  96488. /**
  96489. * | Value | Type | Description |
  96490. * | ----- | ------------------ | ----------- |
  96491. * | 0 | CLAMP_ADDRESSMODE | |
  96492. * | 1 | WRAP_ADDRESSMODE | |
  96493. * | 2 | MIRROR_ADDRESSMODE | |
  96494. */
  96495. wrapR: number;
  96496. /**
  96497. * With compliant hardware and browser (supporting anisotropic filtering)
  96498. * this defines the level of anisotropic filtering in the texture.
  96499. * The higher the better but the slower. This defaults to 4 as it seems to be the best tradeoff.
  96500. */
  96501. anisotropicFilteringLevel: number;
  96502. /**
  96503. * Define if the texture is a cube texture or if false a 2d texture.
  96504. */
  96505. isCube: boolean;
  96506. /**
  96507. * Define if the texture is a 3d texture (webgl 2) or if false a 2d texture.
  96508. */
  96509. is3D: boolean;
  96510. /**
  96511. * Define if the texture is a 2d array texture (webgl 2) or if false a 2d texture.
  96512. */
  96513. is2DArray: boolean;
  96514. /**
  96515. * Define if the texture contains data in gamma space (most of the png/jpg aside bump).
  96516. * HDR texture are usually stored in linear space.
  96517. * This only impacts the PBR and Background materials
  96518. */
  96519. gammaSpace: boolean;
  96520. /**
  96521. * Gets or sets whether or not the texture contains RGBD data.
  96522. */
  96523. isRGBD: boolean;
  96524. /**
  96525. * Is Z inverted in the texture (useful in a cube texture).
  96526. */
  96527. invertZ: boolean;
  96528. /**
  96529. * Are mip maps generated for this texture or not.
  96530. */
  96531. readonly noMipmap: boolean;
  96532. /**
  96533. * @hidden
  96534. */
  96535. lodLevelInAlpha: boolean;
  96536. /**
  96537. * With prefiltered texture, defined the offset used during the prefiltering steps.
  96538. */
  96539. lodGenerationOffset: number;
  96540. /**
  96541. * With prefiltered texture, defined the scale used during the prefiltering steps.
  96542. */
  96543. lodGenerationScale: number;
  96544. /**
  96545. * With prefiltered texture, defined if the specular generation is based on a linear ramp.
  96546. * By default we are using a log2 of the linear roughness helping to keep a better resolution for
  96547. * average roughness values.
  96548. */
  96549. linearSpecularLOD: boolean;
  96550. /**
  96551. * In case a better definition than spherical harmonics is required for the diffuse part of the environment.
  96552. * You can set the irradiance texture to rely on a texture instead of the spherical approach.
  96553. * This texture need to have the same characteristics than its parent (Cube vs 2d, coordinates mode, Gamma/Linear, RGBD).
  96554. */
  96555. irradianceTexture: Nullable<BaseTexture>;
  96556. /**
  96557. * Define if the texture is a render target.
  96558. */
  96559. isRenderTarget: boolean;
  96560. /**
  96561. * Define the unique id of the texture in the scene.
  96562. */
  96563. readonly uid: string;
  96564. /**
  96565. * Return a string representation of the texture.
  96566. * @returns the texture as a string
  96567. */
  96568. toString(): string;
  96569. /**
  96570. * Get the class name of the texture.
  96571. * @returns "BaseTexture"
  96572. */
  96573. getClassName(): string;
  96574. /**
  96575. * Define the list of animation attached to the texture.
  96576. */
  96577. animations: Animation[];
  96578. /**
  96579. * An event triggered when the texture is disposed.
  96580. */
  96581. onDisposeObservable: Observable<BaseTexture>;
  96582. private _onDisposeObserver;
  96583. /**
  96584. * Callback triggered when the texture has been disposed.
  96585. * Kept for back compatibility, you can use the onDisposeObservable instead.
  96586. */
  96587. onDispose: () => void;
  96588. /**
  96589. * Define the current state of the loading sequence when in delayed load mode.
  96590. */
  96591. delayLoadState: number;
  96592. private _scene;
  96593. /** @hidden */
  96594. _texture: Nullable<InternalTexture>;
  96595. private _uid;
  96596. /**
  96597. * Define if the texture is preventinga material to render or not.
  96598. * If not and the texture is not ready, the engine will use a default black texture instead.
  96599. */
  96600. readonly isBlocking: boolean;
  96601. /**
  96602. * Instantiates a new BaseTexture.
  96603. * Base class of all the textures in babylon.
  96604. * It groups all the common properties the materials, post process, lights... might need
  96605. * in order to make a correct use of the texture.
  96606. * @param scene Define the scene the texture blongs to
  96607. */
  96608. constructor(scene: Nullable<Scene>);
  96609. /**
  96610. * Get the scene the texture belongs to.
  96611. * @returns the scene or null if undefined
  96612. */
  96613. getScene(): Nullable<Scene>;
  96614. /**
  96615. * Get the texture transform matrix used to offset tile the texture for istance.
  96616. * @returns the transformation matrix
  96617. */
  96618. getTextureMatrix(): Matrix;
  96619. /**
  96620. * Get the texture reflection matrix used to rotate/transform the reflection.
  96621. * @returns the reflection matrix
  96622. */
  96623. getReflectionTextureMatrix(): Matrix;
  96624. /**
  96625. * Get the underlying lower level texture from Babylon.
  96626. * @returns the insternal texture
  96627. */
  96628. getInternalTexture(): Nullable<InternalTexture>;
  96629. /**
  96630. * Get if the texture is ready to be consumed (either it is ready or it is not blocking)
  96631. * @returns true if ready or not blocking
  96632. */
  96633. isReadyOrNotBlocking(): boolean;
  96634. /**
  96635. * Get if the texture is ready to be used (downloaded, converted, mip mapped...).
  96636. * @returns true if fully ready
  96637. */
  96638. isReady(): boolean;
  96639. private _cachedSize;
  96640. /**
  96641. * Get the size of the texture.
  96642. * @returns the texture size.
  96643. */
  96644. getSize(): ISize;
  96645. /**
  96646. * Get the base size of the texture.
  96647. * It can be different from the size if the texture has been resized for POT for instance
  96648. * @returns the base size
  96649. */
  96650. getBaseSize(): ISize;
  96651. /**
  96652. * Update the sampling mode of the texture.
  96653. * Default is Trilinear mode.
  96654. *
  96655. * | Value | Type | Description |
  96656. * | ----- | ------------------ | ----------- |
  96657. * | 1 | NEAREST_SAMPLINGMODE or NEAREST_NEAREST_MIPLINEAR | Nearest is: mag = nearest, min = nearest, mip = linear |
  96658. * | 2 | BILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPNEAREST | Bilinear is: mag = linear, min = linear, mip = nearest |
  96659. * | 3 | TRILINEAR_SAMPLINGMODE or LINEAR_LINEAR_MIPLINEAR | Trilinear is: mag = linear, min = linear, mip = linear |
  96660. * | 4 | NEAREST_NEAREST_MIPNEAREST | |
  96661. * | 5 | NEAREST_LINEAR_MIPNEAREST | |
  96662. * | 6 | NEAREST_LINEAR_MIPLINEAR | |
  96663. * | 7 | NEAREST_LINEAR | |
  96664. * | 8 | NEAREST_NEAREST | |
  96665. * | 9 | LINEAR_NEAREST_MIPNEAREST | |
  96666. * | 10 | LINEAR_NEAREST_MIPLINEAR | |
  96667. * | 11 | LINEAR_LINEAR | |
  96668. * | 12 | LINEAR_NEAREST | |
  96669. *
  96670. * > _mag_: magnification filter (close to the viewer)
  96671. * > _min_: minification filter (far from the viewer)
  96672. * > _mip_: filter used between mip map levels
  96673. *@param samplingMode Define the new sampling mode of the texture
  96674. */
  96675. updateSamplingMode(samplingMode: number): void;
  96676. /**
  96677. * Scales the texture if is `canRescale()`
  96678. * @param ratio the resize factor we want to use to rescale
  96679. */
  96680. scale(ratio: number): void;
  96681. /**
  96682. * Get if the texture can rescale.
  96683. */
  96684. readonly canRescale: boolean;
  96685. /** @hidden */
  96686. _getFromCache(url: Nullable<string>, noMipmap: boolean, sampling?: number, invertY?: boolean): Nullable<InternalTexture>;
  96687. /** @hidden */
  96688. _rebuild(): void;
  96689. /**
  96690. * Triggers the load sequence in delayed load mode.
  96691. */
  96692. delayLoad(): void;
  96693. /**
  96694. * Clones the texture.
  96695. * @returns the cloned texture
  96696. */
  96697. clone(): Nullable<BaseTexture>;
  96698. /**
  96699. * Get the texture underlying type (INT, FLOAT...)
  96700. */
  96701. readonly textureType: number;
  96702. /**
  96703. * Get the texture underlying format (RGB, RGBA...)
  96704. */
  96705. readonly textureFormat: number;
  96706. /**
  96707. * Indicates that textures need to be re-calculated for all materials
  96708. */
  96709. protected _markAllSubMeshesAsTexturesDirty(): void;
  96710. /**
  96711. * Reads the pixels stored in the webgl texture and returns them as an ArrayBuffer.
  96712. * This will returns an RGBA array buffer containing either in values (0-255) or
  96713. * float values (0-1) depending of the underlying buffer type.
  96714. * @param faceIndex defines the face of the texture to read (in case of cube texture)
  96715. * @param level defines the LOD level of the texture to read (in case of Mip Maps)
  96716. * @param buffer defines a user defined buffer to fill with data (can be null)
  96717. * @returns The Array buffer containing the pixels data.
  96718. */
  96719. readPixels(faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): Nullable<ArrayBufferView>;
  96720. /**
  96721. * Release and destroy the underlying lower level texture aka internalTexture.
  96722. */
  96723. releaseInternalTexture(): void;
  96724. /** @hidden */
  96725. readonly _lodTextureHigh: Nullable<BaseTexture>;
  96726. /** @hidden */
  96727. readonly _lodTextureMid: Nullable<BaseTexture>;
  96728. /** @hidden */
  96729. readonly _lodTextureLow: Nullable<BaseTexture>;
  96730. /**
  96731. * Dispose the texture and release its associated resources.
  96732. */
  96733. dispose(): void;
  96734. /**
  96735. * Serialize the texture into a JSON representation that can be parsed later on.
  96736. * @returns the JSON representation of the texture
  96737. */
  96738. serialize(): any;
  96739. /**
  96740. * Helper function to be called back once a list of texture contains only ready textures.
  96741. * @param textures Define the list of textures to wait for
  96742. * @param callback Define the callback triggered once the entire list will be ready
  96743. */
  96744. static WhenAllReady(textures: BaseTexture[], callback: () => void): void;
  96745. }
  96746. }
  96747. declare module BABYLON {
  96748. /**
  96749. * Options to be used when creating an effect.
  96750. */
  96751. export interface IEffectCreationOptions {
  96752. /**
  96753. * Atrributes that will be used in the shader.
  96754. */
  96755. attributes: string[];
  96756. /**
  96757. * Uniform varible names that will be set in the shader.
  96758. */
  96759. uniformsNames: string[];
  96760. /**
  96761. * Uniform buffer variable names that will be set in the shader.
  96762. */
  96763. uniformBuffersNames: string[];
  96764. /**
  96765. * Sampler texture variable names that will be set in the shader.
  96766. */
  96767. samplers: string[];
  96768. /**
  96769. * Define statements that will be set in the shader.
  96770. */
  96771. defines: any;
  96772. /**
  96773. * Possible fallbacks for this effect to improve performance when needed.
  96774. */
  96775. fallbacks: Nullable<IEffectFallbacks>;
  96776. /**
  96777. * Callback that will be called when the shader is compiled.
  96778. */
  96779. onCompiled: Nullable<(effect: Effect) => void>;
  96780. /**
  96781. * Callback that will be called if an error occurs during shader compilation.
  96782. */
  96783. onError: Nullable<(effect: Effect, errors: string) => void>;
  96784. /**
  96785. * Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  96786. */
  96787. indexParameters?: any;
  96788. /**
  96789. * Max number of lights that can be used in the shader.
  96790. */
  96791. maxSimultaneousLights?: number;
  96792. /**
  96793. * See https://developer.mozilla.org/en-US/docs/Web/API/WebGL2RenderingContext/transformFeedbackVaryings
  96794. */
  96795. transformFeedbackVaryings?: Nullable<string[]>;
  96796. }
  96797. /**
  96798. * Effect containing vertex and fragment shader that can be executed on an object.
  96799. */
  96800. export class Effect implements IDisposable {
  96801. /**
  96802. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  96803. */
  96804. static ShadersRepository: string;
  96805. /**
  96806. * Name of the effect.
  96807. */
  96808. name: any;
  96809. /**
  96810. * String container all the define statements that should be set on the shader.
  96811. */
  96812. defines: string;
  96813. /**
  96814. * Callback that will be called when the shader is compiled.
  96815. */
  96816. onCompiled: Nullable<(effect: Effect) => void>;
  96817. /**
  96818. * Callback that will be called if an error occurs during shader compilation.
  96819. */
  96820. onError: Nullable<(effect: Effect, errors: string) => void>;
  96821. /**
  96822. * Callback that will be called when effect is bound.
  96823. */
  96824. onBind: Nullable<(effect: Effect) => void>;
  96825. /**
  96826. * Unique ID of the effect.
  96827. */
  96828. uniqueId: number;
  96829. /**
  96830. * Observable that will be called when the shader is compiled.
  96831. * It is recommended to use executeWhenCompile() or to make sure that scene.isReady() is called to get this observable raised.
  96832. */
  96833. onCompileObservable: Observable<Effect>;
  96834. /**
  96835. * Observable that will be called if an error occurs during shader compilation.
  96836. */
  96837. onErrorObservable: Observable<Effect>;
  96838. /** @hidden */
  96839. _onBindObservable: Nullable<Observable<Effect>>;
  96840. /**
  96841. * Observable that will be called when effect is bound.
  96842. */
  96843. readonly onBindObservable: Observable<Effect>;
  96844. /** @hidden */
  96845. _bonesComputationForcedToCPU: boolean;
  96846. private static _uniqueIdSeed;
  96847. private _engine;
  96848. private _uniformBuffersNames;
  96849. private _uniformsNames;
  96850. private _samplerList;
  96851. private _samplers;
  96852. private _isReady;
  96853. private _compilationError;
  96854. private _allFallbacksProcessed;
  96855. private _attributesNames;
  96856. private _attributes;
  96857. private _uniforms;
  96858. /**
  96859. * Key for the effect.
  96860. * @hidden
  96861. */
  96862. _key: string;
  96863. private _indexParameters;
  96864. private _fallbacks;
  96865. private _vertexSourceCode;
  96866. private _fragmentSourceCode;
  96867. private _vertexSourceCodeOverride;
  96868. private _fragmentSourceCodeOverride;
  96869. private _transformFeedbackVaryings;
  96870. /**
  96871. * Compiled shader to webGL program.
  96872. * @hidden
  96873. */
  96874. _pipelineContext: Nullable<IPipelineContext>;
  96875. private _valueCache;
  96876. private static _baseCache;
  96877. /**
  96878. * Instantiates an effect.
  96879. * An effect can be used to create/manage/execute vertex and fragment shaders.
  96880. * @param baseName Name of the effect.
  96881. * @param attributesNamesOrOptions List of attribute names that will be passed to the shader or set of all options to create the effect.
  96882. * @param uniformsNamesOrEngine List of uniform variable names that will be passed to the shader or the engine that will be used to render effect.
  96883. * @param samplers List of sampler variables that will be passed to the shader.
  96884. * @param engine Engine to be used to render the effect
  96885. * @param defines Define statements to be added to the shader.
  96886. * @param fallbacks Possible fallbacks for this effect to improve performance when needed.
  96887. * @param onCompiled Callback that will be called when the shader is compiled.
  96888. * @param onError Callback that will be called if an error occurs during shader compilation.
  96889. * @param indexParameters Parameters to be used with Babylons include syntax to iterate over an array (eg. {lights: 10})
  96890. */
  96891. 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);
  96892. private _useFinalCode;
  96893. /**
  96894. * Unique key for this effect
  96895. */
  96896. readonly key: string;
  96897. /**
  96898. * If the effect has been compiled and prepared.
  96899. * @returns if the effect is compiled and prepared.
  96900. */
  96901. isReady(): boolean;
  96902. private _isReadyInternal;
  96903. /**
  96904. * The engine the effect was initialized with.
  96905. * @returns the engine.
  96906. */
  96907. getEngine(): Engine;
  96908. /**
  96909. * The pipeline context for this effect
  96910. * @returns the associated pipeline context
  96911. */
  96912. getPipelineContext(): Nullable<IPipelineContext>;
  96913. /**
  96914. * The set of names of attribute variables for the shader.
  96915. * @returns An array of attribute names.
  96916. */
  96917. getAttributesNames(): string[];
  96918. /**
  96919. * Returns the attribute at the given index.
  96920. * @param index The index of the attribute.
  96921. * @returns The location of the attribute.
  96922. */
  96923. getAttributeLocation(index: number): number;
  96924. /**
  96925. * Returns the attribute based on the name of the variable.
  96926. * @param name of the attribute to look up.
  96927. * @returns the attribute location.
  96928. */
  96929. getAttributeLocationByName(name: string): number;
  96930. /**
  96931. * The number of attributes.
  96932. * @returns the numnber of attributes.
  96933. */
  96934. getAttributesCount(): number;
  96935. /**
  96936. * Gets the index of a uniform variable.
  96937. * @param uniformName of the uniform to look up.
  96938. * @returns the index.
  96939. */
  96940. getUniformIndex(uniformName: string): number;
  96941. /**
  96942. * Returns the attribute based on the name of the variable.
  96943. * @param uniformName of the uniform to look up.
  96944. * @returns the location of the uniform.
  96945. */
  96946. getUniform(uniformName: string): Nullable<WebGLUniformLocation>;
  96947. /**
  96948. * Returns an array of sampler variable names
  96949. * @returns The array of sampler variable neames.
  96950. */
  96951. getSamplers(): string[];
  96952. /**
  96953. * The error from the last compilation.
  96954. * @returns the error string.
  96955. */
  96956. getCompilationError(): string;
  96957. /**
  96958. * Gets a boolean indicating that all fallbacks were used during compilation
  96959. * @returns true if all fallbacks were used
  96960. */
  96961. allFallbacksProcessed(): boolean;
  96962. /**
  96963. * Adds a callback to the onCompiled observable and call the callback imediatly if already ready.
  96964. * @param func The callback to be used.
  96965. */
  96966. executeWhenCompiled(func: (effect: Effect) => void): void;
  96967. private _checkIsReady;
  96968. private _loadShader;
  96969. /**
  96970. * Recompiles the webGL program
  96971. * @param vertexSourceCode The source code for the vertex shader.
  96972. * @param fragmentSourceCode The source code for the fragment shader.
  96973. * @param onCompiled Callback called when completed.
  96974. * @param onError Callback called on error.
  96975. * @hidden
  96976. */
  96977. _rebuildProgram(vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (pipelineContext: IPipelineContext) => void, onError: (message: string) => void): void;
  96978. /**
  96979. * Prepares the effect
  96980. * @hidden
  96981. */
  96982. _prepareEffect(): void;
  96983. private _processCompilationErrors;
  96984. /**
  96985. * Checks if the effect is supported. (Must be called after compilation)
  96986. */
  96987. readonly isSupported: boolean;
  96988. /**
  96989. * Binds a texture to the engine to be used as output of the shader.
  96990. * @param channel Name of the output variable.
  96991. * @param texture Texture to bind.
  96992. * @hidden
  96993. */
  96994. _bindTexture(channel: string, texture: InternalTexture): void;
  96995. /**
  96996. * Sets a texture on the engine to be used in the shader.
  96997. * @param channel Name of the sampler variable.
  96998. * @param texture Texture to set.
  96999. */
  97000. setTexture(channel: string, texture: Nullable<BaseTexture>): void;
  97001. /**
  97002. * Sets a depth stencil texture from a render target on the engine to be used in the shader.
  97003. * @param channel Name of the sampler variable.
  97004. * @param texture Texture to set.
  97005. */
  97006. setDepthStencilTexture(channel: string, texture: Nullable<RenderTargetTexture>): void;
  97007. /**
  97008. * Sets an array of textures on the engine to be used in the shader.
  97009. * @param channel Name of the variable.
  97010. * @param textures Textures to set.
  97011. */
  97012. setTextureArray(channel: string, textures: BaseTexture[]): void;
  97013. /**
  97014. * 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)
  97015. * @param channel Name of the sampler variable.
  97016. * @param postProcess Post process to get the input texture from.
  97017. */
  97018. setTextureFromPostProcess(channel: string, postProcess: Nullable<PostProcess>): void;
  97019. /**
  97020. * (Warning! setTextureFromPostProcessOutput may be desired instead)
  97021. * 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)
  97022. * @param channel Name of the sampler variable.
  97023. * @param postProcess Post process to get the output texture from.
  97024. */
  97025. setTextureFromPostProcessOutput(channel: string, postProcess: Nullable<PostProcess>): void;
  97026. /** @hidden */
  97027. _cacheMatrix(uniformName: string, matrix: IMatrixLike): boolean;
  97028. /** @hidden */
  97029. _cacheFloat2(uniformName: string, x: number, y: number): boolean;
  97030. /** @hidden */
  97031. _cacheFloat3(uniformName: string, x: number, y: number, z: number): boolean;
  97032. /** @hidden */
  97033. _cacheFloat4(uniformName: string, x: number, y: number, z: number, w: number): boolean;
  97034. /**
  97035. * Binds a buffer to a uniform.
  97036. * @param buffer Buffer to bind.
  97037. * @param name Name of the uniform variable to bind to.
  97038. */
  97039. bindUniformBuffer(buffer: DataBuffer, name: string): void;
  97040. /**
  97041. * Binds block to a uniform.
  97042. * @param blockName Name of the block to bind.
  97043. * @param index Index to bind.
  97044. */
  97045. bindUniformBlock(blockName: string, index: number): void;
  97046. /**
  97047. * Sets an interger value on a uniform variable.
  97048. * @param uniformName Name of the variable.
  97049. * @param value Value to be set.
  97050. * @returns this effect.
  97051. */
  97052. setInt(uniformName: string, value: number): Effect;
  97053. /**
  97054. * Sets an int array on a uniform variable.
  97055. * @param uniformName Name of the variable.
  97056. * @param array array to be set.
  97057. * @returns this effect.
  97058. */
  97059. setIntArray(uniformName: string, array: Int32Array): Effect;
  97060. /**
  97061. * 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)
  97062. * @param uniformName Name of the variable.
  97063. * @param array array to be set.
  97064. * @returns this effect.
  97065. */
  97066. setIntArray2(uniformName: string, array: Int32Array): Effect;
  97067. /**
  97068. * 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)
  97069. * @param uniformName Name of the variable.
  97070. * @param array array to be set.
  97071. * @returns this effect.
  97072. */
  97073. setIntArray3(uniformName: string, array: Int32Array): Effect;
  97074. /**
  97075. * 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)
  97076. * @param uniformName Name of the variable.
  97077. * @param array array to be set.
  97078. * @returns this effect.
  97079. */
  97080. setIntArray4(uniformName: string, array: Int32Array): Effect;
  97081. /**
  97082. * Sets an float array on a uniform variable.
  97083. * @param uniformName Name of the variable.
  97084. * @param array array to be set.
  97085. * @returns this effect.
  97086. */
  97087. setFloatArray(uniformName: string, array: Float32Array): Effect;
  97088. /**
  97089. * 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)
  97090. * @param uniformName Name of the variable.
  97091. * @param array array to be set.
  97092. * @returns this effect.
  97093. */
  97094. setFloatArray2(uniformName: string, array: Float32Array): Effect;
  97095. /**
  97096. * 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)
  97097. * @param uniformName Name of the variable.
  97098. * @param array array to be set.
  97099. * @returns this effect.
  97100. */
  97101. setFloatArray3(uniformName: string, array: Float32Array): Effect;
  97102. /**
  97103. * 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)
  97104. * @param uniformName Name of the variable.
  97105. * @param array array to be set.
  97106. * @returns this effect.
  97107. */
  97108. setFloatArray4(uniformName: string, array: Float32Array): Effect;
  97109. /**
  97110. * Sets an array on a uniform variable.
  97111. * @param uniformName Name of the variable.
  97112. * @param array array to be set.
  97113. * @returns this effect.
  97114. */
  97115. setArray(uniformName: string, array: number[]): Effect;
  97116. /**
  97117. * 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)
  97118. * @param uniformName Name of the variable.
  97119. * @param array array to be set.
  97120. * @returns this effect.
  97121. */
  97122. setArray2(uniformName: string, array: number[]): Effect;
  97123. /**
  97124. * 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)
  97125. * @param uniformName Name of the variable.
  97126. * @param array array to be set.
  97127. * @returns this effect.
  97128. */
  97129. setArray3(uniformName: string, array: number[]): Effect;
  97130. /**
  97131. * 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)
  97132. * @param uniformName Name of the variable.
  97133. * @param array array to be set.
  97134. * @returns this effect.
  97135. */
  97136. setArray4(uniformName: string, array: number[]): Effect;
  97137. /**
  97138. * Sets matrices on a uniform variable.
  97139. * @param uniformName Name of the variable.
  97140. * @param matrices matrices to be set.
  97141. * @returns this effect.
  97142. */
  97143. setMatrices(uniformName: string, matrices: Float32Array): Effect;
  97144. /**
  97145. * Sets matrix on a uniform variable.
  97146. * @param uniformName Name of the variable.
  97147. * @param matrix matrix to be set.
  97148. * @returns this effect.
  97149. */
  97150. setMatrix(uniformName: string, matrix: IMatrixLike): Effect;
  97151. /**
  97152. * 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)
  97153. * @param uniformName Name of the variable.
  97154. * @param matrix matrix to be set.
  97155. * @returns this effect.
  97156. */
  97157. setMatrix3x3(uniformName: string, matrix: Float32Array): Effect;
  97158. /**
  97159. * Sets a 2x2 matrix on a uniform variable. (Speicified as [1,2,3,4] will result in [1,2][3,4] matrix)
  97160. * @param uniformName Name of the variable.
  97161. * @param matrix matrix to be set.
  97162. * @returns this effect.
  97163. */
  97164. setMatrix2x2(uniformName: string, matrix: Float32Array): Effect;
  97165. /**
  97166. * Sets a float on a uniform variable.
  97167. * @param uniformName Name of the variable.
  97168. * @param value value to be set.
  97169. * @returns this effect.
  97170. */
  97171. setFloat(uniformName: string, value: number): Effect;
  97172. /**
  97173. * Sets a boolean on a uniform variable.
  97174. * @param uniformName Name of the variable.
  97175. * @param bool value to be set.
  97176. * @returns this effect.
  97177. */
  97178. setBool(uniformName: string, bool: boolean): Effect;
  97179. /**
  97180. * Sets a Vector2 on a uniform variable.
  97181. * @param uniformName Name of the variable.
  97182. * @param vector2 vector2 to be set.
  97183. * @returns this effect.
  97184. */
  97185. setVector2(uniformName: string, vector2: IVector2Like): Effect;
  97186. /**
  97187. * Sets a float2 on a uniform variable.
  97188. * @param uniformName Name of the variable.
  97189. * @param x First float in float2.
  97190. * @param y Second float in float2.
  97191. * @returns this effect.
  97192. */
  97193. setFloat2(uniformName: string, x: number, y: number): Effect;
  97194. /**
  97195. * Sets a Vector3 on a uniform variable.
  97196. * @param uniformName Name of the variable.
  97197. * @param vector3 Value to be set.
  97198. * @returns this effect.
  97199. */
  97200. setVector3(uniformName: string, vector3: IVector3Like): Effect;
  97201. /**
  97202. * Sets a float3 on a uniform variable.
  97203. * @param uniformName Name of the variable.
  97204. * @param x First float in float3.
  97205. * @param y Second float in float3.
  97206. * @param z Third float in float3.
  97207. * @returns this effect.
  97208. */
  97209. setFloat3(uniformName: string, x: number, y: number, z: number): Effect;
  97210. /**
  97211. * Sets a Vector4 on a uniform variable.
  97212. * @param uniformName Name of the variable.
  97213. * @param vector4 Value to be set.
  97214. * @returns this effect.
  97215. */
  97216. setVector4(uniformName: string, vector4: IVector4Like): Effect;
  97217. /**
  97218. * Sets a float4 on a uniform variable.
  97219. * @param uniformName Name of the variable.
  97220. * @param x First float in float4.
  97221. * @param y Second float in float4.
  97222. * @param z Third float in float4.
  97223. * @param w Fourth float in float4.
  97224. * @returns this effect.
  97225. */
  97226. setFloat4(uniformName: string, x: number, y: number, z: number, w: number): Effect;
  97227. /**
  97228. * Sets a Color3 on a uniform variable.
  97229. * @param uniformName Name of the variable.
  97230. * @param color3 Value to be set.
  97231. * @returns this effect.
  97232. */
  97233. setColor3(uniformName: string, color3: IColor3Like): Effect;
  97234. /**
  97235. * Sets a Color4 on a uniform variable.
  97236. * @param uniformName Name of the variable.
  97237. * @param color3 Value to be set.
  97238. * @param alpha Alpha value to be set.
  97239. * @returns this effect.
  97240. */
  97241. setColor4(uniformName: string, color3: IColor3Like, alpha: number): Effect;
  97242. /**
  97243. * Sets a Color4 on a uniform variable
  97244. * @param uniformName defines the name of the variable
  97245. * @param color4 defines the value to be set
  97246. * @returns this effect.
  97247. */
  97248. setDirectColor4(uniformName: string, color4: IColor4Like): Effect;
  97249. /** Release all associated resources */
  97250. dispose(): void;
  97251. /**
  97252. * This function will add a new shader to the shader store
  97253. * @param name the name of the shader
  97254. * @param pixelShader optional pixel shader content
  97255. * @param vertexShader optional vertex shader content
  97256. */
  97257. static RegisterShader(name: string, pixelShader?: string, vertexShader?: string): void;
  97258. /**
  97259. * Store of each shader (The can be looked up using effect.key)
  97260. */
  97261. static ShadersStore: {
  97262. [key: string]: string;
  97263. };
  97264. /**
  97265. * Store of each included file for a shader (The can be looked up using effect.key)
  97266. */
  97267. static IncludesShadersStore: {
  97268. [key: string]: string;
  97269. };
  97270. /**
  97271. * Resets the cache of effects.
  97272. */
  97273. static ResetCache(): void;
  97274. }
  97275. }
  97276. declare module BABYLON {
  97277. /**
  97278. * Interface used to describe the capabilities of the engine relatively to the current browser
  97279. */
  97280. export interface EngineCapabilities {
  97281. /** Maximum textures units per fragment shader */
  97282. maxTexturesImageUnits: number;
  97283. /** Maximum texture units per vertex shader */
  97284. maxVertexTextureImageUnits: number;
  97285. /** Maximum textures units in the entire pipeline */
  97286. maxCombinedTexturesImageUnits: number;
  97287. /** Maximum texture size */
  97288. maxTextureSize: number;
  97289. /** Maximum texture samples */
  97290. maxSamples?: number;
  97291. /** Maximum cube texture size */
  97292. maxCubemapTextureSize: number;
  97293. /** Maximum render texture size */
  97294. maxRenderTextureSize: number;
  97295. /** Maximum number of vertex attributes */
  97296. maxVertexAttribs: number;
  97297. /** Maximum number of varyings */
  97298. maxVaryingVectors: number;
  97299. /** Maximum number of uniforms per vertex shader */
  97300. maxVertexUniformVectors: number;
  97301. /** Maximum number of uniforms per fragment shader */
  97302. maxFragmentUniformVectors: number;
  97303. /** Defines if standard derivates (dx/dy) are supported */
  97304. standardDerivatives: boolean;
  97305. /** Defines if s3tc texture compression is supported */
  97306. s3tc?: WEBGL_compressed_texture_s3tc;
  97307. /** Defines if pvrtc texture compression is supported */
  97308. pvrtc: any;
  97309. /** Defines if etc1 texture compression is supported */
  97310. etc1: any;
  97311. /** Defines if etc2 texture compression is supported */
  97312. etc2: any;
  97313. /** Defines if astc texture compression is supported */
  97314. astc: any;
  97315. /** Defines if float textures are supported */
  97316. textureFloat: boolean;
  97317. /** Defines if vertex array objects are supported */
  97318. vertexArrayObject: boolean;
  97319. /** Gets the webgl extension for anisotropic filtering (null if not supported) */
  97320. textureAnisotropicFilterExtension?: EXT_texture_filter_anisotropic;
  97321. /** Gets the maximum level of anisotropy supported */
  97322. maxAnisotropy: number;
  97323. /** Defines if instancing is supported */
  97324. instancedArrays: boolean;
  97325. /** Defines if 32 bits indices are supported */
  97326. uintIndices: boolean;
  97327. /** Defines if high precision shaders are supported */
  97328. highPrecisionShaderSupported: boolean;
  97329. /** Defines if depth reading in the fragment shader is supported */
  97330. fragmentDepthSupported: boolean;
  97331. /** Defines if float texture linear filtering is supported*/
  97332. textureFloatLinearFiltering: boolean;
  97333. /** Defines if rendering to float textures is supported */
  97334. textureFloatRender: boolean;
  97335. /** Defines if half float textures are supported*/
  97336. textureHalfFloat: boolean;
  97337. /** Defines if half float texture linear filtering is supported*/
  97338. textureHalfFloatLinearFiltering: boolean;
  97339. /** Defines if rendering to half float textures is supported */
  97340. textureHalfFloatRender: boolean;
  97341. /** Defines if textureLOD shader command is supported */
  97342. textureLOD: boolean;
  97343. /** Defines if draw buffers extension is supported */
  97344. drawBuffersExtension: boolean;
  97345. /** Defines if depth textures are supported */
  97346. depthTextureExtension: boolean;
  97347. /** Defines if float color buffer are supported */
  97348. colorBufferFloat: boolean;
  97349. /** Gets disjoint timer query extension (null if not supported) */
  97350. timerQuery?: EXT_disjoint_timer_query;
  97351. /** Defines if timestamp can be used with timer query */
  97352. canUseTimestampForTimerQuery: boolean;
  97353. /** Defines if multiview is supported (https://www.khronos.org/registry/webgl/extensions/WEBGL_multiview/) */
  97354. multiview?: any;
  97355. /** Defines if oculus multiview is supported (https://developer.oculus.com/documentation/oculus-browser/latest/concepts/browser-multiview/) */
  97356. oculusMultiview?: any;
  97357. /** Function used to let the system compiles shaders in background */
  97358. parallelShaderCompile?: {
  97359. COMPLETION_STATUS_KHR: number;
  97360. };
  97361. /** Max number of texture samples for MSAA */
  97362. maxMSAASamples: number;
  97363. /** Defines if the blend min max extension is supported */
  97364. blendMinMax: boolean;
  97365. }
  97366. }
  97367. declare module BABYLON {
  97368. /**
  97369. * @hidden
  97370. **/
  97371. export class DepthCullingState {
  97372. private _isDepthTestDirty;
  97373. private _isDepthMaskDirty;
  97374. private _isDepthFuncDirty;
  97375. private _isCullFaceDirty;
  97376. private _isCullDirty;
  97377. private _isZOffsetDirty;
  97378. private _isFrontFaceDirty;
  97379. private _depthTest;
  97380. private _depthMask;
  97381. private _depthFunc;
  97382. private _cull;
  97383. private _cullFace;
  97384. private _zOffset;
  97385. private _frontFace;
  97386. /**
  97387. * Initializes the state.
  97388. */
  97389. constructor();
  97390. readonly isDirty: boolean;
  97391. zOffset: number;
  97392. cullFace: Nullable<number>;
  97393. cull: Nullable<boolean>;
  97394. depthFunc: Nullable<number>;
  97395. depthMask: boolean;
  97396. depthTest: boolean;
  97397. frontFace: Nullable<number>;
  97398. reset(): void;
  97399. apply(gl: WebGLRenderingContext): void;
  97400. }
  97401. }
  97402. declare module BABYLON {
  97403. /**
  97404. * @hidden
  97405. **/
  97406. export class StencilState {
  97407. /** 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 */
  97408. static readonly ALWAYS: number;
  97409. /** Passed to stencilOperation to specify that stencil value must be kept */
  97410. static readonly KEEP: number;
  97411. /** Passed to stencilOperation to specify that stencil value must be replaced */
  97412. static readonly REPLACE: number;
  97413. private _isStencilTestDirty;
  97414. private _isStencilMaskDirty;
  97415. private _isStencilFuncDirty;
  97416. private _isStencilOpDirty;
  97417. private _stencilTest;
  97418. private _stencilMask;
  97419. private _stencilFunc;
  97420. private _stencilFuncRef;
  97421. private _stencilFuncMask;
  97422. private _stencilOpStencilFail;
  97423. private _stencilOpDepthFail;
  97424. private _stencilOpStencilDepthPass;
  97425. readonly isDirty: boolean;
  97426. stencilFunc: number;
  97427. stencilFuncRef: number;
  97428. stencilFuncMask: number;
  97429. stencilOpStencilFail: number;
  97430. stencilOpDepthFail: number;
  97431. stencilOpStencilDepthPass: number;
  97432. stencilMask: number;
  97433. stencilTest: boolean;
  97434. constructor();
  97435. reset(): void;
  97436. apply(gl: WebGLRenderingContext): void;
  97437. }
  97438. }
  97439. declare module BABYLON {
  97440. /**
  97441. * @hidden
  97442. **/
  97443. export class AlphaState {
  97444. private _isAlphaBlendDirty;
  97445. private _isBlendFunctionParametersDirty;
  97446. private _isBlendEquationParametersDirty;
  97447. private _isBlendConstantsDirty;
  97448. private _alphaBlend;
  97449. private _blendFunctionParameters;
  97450. private _blendEquationParameters;
  97451. private _blendConstants;
  97452. /**
  97453. * Initializes the state.
  97454. */
  97455. constructor();
  97456. readonly isDirty: boolean;
  97457. alphaBlend: boolean;
  97458. setAlphaBlendConstants(r: number, g: number, b: number, a: number): void;
  97459. setAlphaBlendFunctionParameters(value0: number, value1: number, value2: number, value3: number): void;
  97460. setAlphaEquationParameters(rgb: number, alpha: number): void;
  97461. reset(): void;
  97462. apply(gl: WebGLRenderingContext): void;
  97463. }
  97464. }
  97465. declare module BABYLON {
  97466. /** @hidden */
  97467. export class WebGL2ShaderProcessor implements IShaderProcessor {
  97468. attributeProcessor(attribute: string): string;
  97469. varyingProcessor(varying: string, isFragment: boolean): string;
  97470. postProcessor(code: string, defines: string[], isFragment: boolean): string;
  97471. }
  97472. }
  97473. declare module BABYLON {
  97474. /**
  97475. * Interface for attribute information associated with buffer instanciation
  97476. */
  97477. export interface InstancingAttributeInfo {
  97478. /**
  97479. * Index/offset of the attribute in the vertex shader
  97480. */
  97481. index: number;
  97482. /**
  97483. * size of the attribute, 1, 2, 3 or 4
  97484. */
  97485. attributeSize: number;
  97486. /**
  97487. * type of the attribute, gl.BYTE, gl.UNSIGNED_BYTE, gl.SHORT, gl.UNSIGNED_SHORT, gl.FIXED, gl.FLOAT.
  97488. * default is FLOAT
  97489. */
  97490. attributeType: number;
  97491. /**
  97492. * normalization of fixed-point data. behavior unclear, use FALSE, default is FALSE
  97493. */
  97494. normalized: boolean;
  97495. /**
  97496. * Offset of the data in the Vertex Buffer acting as the instancing buffer
  97497. */
  97498. offset: number;
  97499. /**
  97500. * Name of the GLSL attribute, for debugging purpose only
  97501. */
  97502. attributeName: string;
  97503. }
  97504. }
  97505. declare module BABYLON {
  97506. interface ThinEngine {
  97507. /**
  97508. * Update a video texture
  97509. * @param texture defines the texture to update
  97510. * @param video defines the video element to use
  97511. * @param invertY defines if data must be stored with Y axis inverted
  97512. */
  97513. updateVideoTexture(texture: Nullable<InternalTexture>, video: HTMLVideoElement, invertY: boolean): void;
  97514. }
  97515. }
  97516. declare module BABYLON {
  97517. /**
  97518. * Settings for finer control over video usage
  97519. */
  97520. export interface VideoTextureSettings {
  97521. /**
  97522. * Applies `autoplay` to video, if specified
  97523. */
  97524. autoPlay?: boolean;
  97525. /**
  97526. * Applies `loop` to video, if specified
  97527. */
  97528. loop?: boolean;
  97529. /**
  97530. * Automatically updates internal texture from video at every frame in the render loop
  97531. */
  97532. autoUpdateTexture: boolean;
  97533. /**
  97534. * Image src displayed during the video loading or until the user interacts with the video.
  97535. */
  97536. poster?: string;
  97537. }
  97538. /**
  97539. * If you want to display a video in your scene, this is the special texture for that.
  97540. * This special texture works similar to other textures, with the exception of a few parameters.
  97541. * @see https://doc.babylonjs.com/how_to/video_texture
  97542. */
  97543. export class VideoTexture extends Texture {
  97544. /**
  97545. * Tells whether textures will be updated automatically or user is required to call `updateTexture` manually
  97546. */
  97547. readonly autoUpdateTexture: boolean;
  97548. /**
  97549. * The video instance used by the texture internally
  97550. */
  97551. readonly video: HTMLVideoElement;
  97552. private _onUserActionRequestedObservable;
  97553. /**
  97554. * Event triggerd when a dom action is required by the user to play the video.
  97555. * This happens due to recent changes in browser policies preventing video to auto start.
  97556. */
  97557. readonly onUserActionRequestedObservable: Observable<Texture>;
  97558. private _generateMipMaps;
  97559. private _engine;
  97560. private _stillImageCaptured;
  97561. private _displayingPosterTexture;
  97562. private _settings;
  97563. private _createInternalTextureOnEvent;
  97564. private _frameId;
  97565. /**
  97566. * Creates a video texture.
  97567. * If you want to display a video in your scene, this is the special texture for that.
  97568. * This special texture works similar to other textures, with the exception of a few parameters.
  97569. * @see https://doc.babylonjs.com/how_to/video_texture
  97570. * @param name optional name, will detect from video source, if not defined
  97571. * @param src can be used to provide an url, array of urls or an already setup HTML video element.
  97572. * @param scene is obviously the current scene.
  97573. * @param generateMipMaps can be used to turn on mipmaps (Can be expensive for videoTextures because they are often updated).
  97574. * @param invertY is false by default but can be used to invert video on Y axis
  97575. * @param samplingMode controls the sampling method and is set to TRILINEAR_SAMPLINGMODE by default
  97576. * @param settings allows finer control over video usage
  97577. */
  97578. constructor(name: Nullable<string>, src: string | string[] | HTMLVideoElement, scene: Nullable<Scene>, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, settings?: VideoTextureSettings);
  97579. private _getName;
  97580. private _getVideo;
  97581. private _createInternalTexture;
  97582. private reset;
  97583. /**
  97584. * @hidden Internal method to initiate `update`.
  97585. */
  97586. _rebuild(): void;
  97587. /**
  97588. * Update Texture in the `auto` mode. Does not do anything if `settings.autoUpdateTexture` is false.
  97589. */
  97590. update(): void;
  97591. /**
  97592. * Update Texture in `manual` mode. Does not do anything if not visible or paused.
  97593. * @param isVisible Visibility state, detected by user using `scene.getActiveMeshes()` or othervise.
  97594. */
  97595. updateTexture(isVisible: boolean): void;
  97596. protected _updateInternalTexture: () => void;
  97597. /**
  97598. * Change video content. Changing video instance or setting multiple urls (as in constructor) is not supported.
  97599. * @param url New url.
  97600. */
  97601. updateURL(url: string): void;
  97602. /**
  97603. * Dispose the texture and release its associated resources.
  97604. */
  97605. dispose(): void;
  97606. /**
  97607. * Creates a video texture straight from a stream.
  97608. * @param scene Define the scene the texture should be created in
  97609. * @param stream Define the stream the texture should be created from
  97610. * @returns The created video texture as a promise
  97611. */
  97612. static CreateFromStreamAsync(scene: Scene, stream: MediaStream): Promise<VideoTexture>;
  97613. /**
  97614. * Creates a video texture straight from your WebCam video feed.
  97615. * @param scene Define the scene the texture should be created in
  97616. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  97617. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  97618. * @returns The created video texture as a promise
  97619. */
  97620. static CreateFromWebCamAsync(scene: Scene, constraints: {
  97621. minWidth: number;
  97622. maxWidth: number;
  97623. minHeight: number;
  97624. maxHeight: number;
  97625. deviceId: string;
  97626. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): Promise<VideoTexture>;
  97627. /**
  97628. * Creates a video texture straight from your WebCam video feed.
  97629. * @param scene Define the scene the texture should be created in
  97630. * @param onReady Define a callback to triggered once the texture will be ready
  97631. * @param constraints Define the constraints to use to create the web cam feed from WebRTC
  97632. * @param audioConstaints Define the audio constraints to use to create the web cam feed from WebRTC
  97633. */
  97634. static CreateFromWebCam(scene: Scene, onReady: (videoTexture: VideoTexture) => void, constraints: {
  97635. minWidth: number;
  97636. maxWidth: number;
  97637. minHeight: number;
  97638. maxHeight: number;
  97639. deviceId: string;
  97640. } & MediaTrackConstraints, audioConstaints?: boolean | MediaTrackConstraints): void;
  97641. }
  97642. }
  97643. declare module BABYLON {
  97644. /**
  97645. * Defines the interface used by objects working like Scene
  97646. * @hidden
  97647. */
  97648. interface ISceneLike {
  97649. _addPendingData(data: any): void;
  97650. _removePendingData(data: any): void;
  97651. offlineProvider: IOfflineProvider;
  97652. }
  97653. /** Interface defining initialization parameters for Engine class */
  97654. export interface EngineOptions extends WebGLContextAttributes {
  97655. /**
  97656. * Defines if the engine should no exceed a specified device ratio
  97657. * @see https://developer.mozilla.org/en-US/docs/Web/API/Window/devicePixelRatio
  97658. */
  97659. limitDeviceRatio?: number;
  97660. /**
  97661. * Defines if webvr should be enabled automatically
  97662. * @see http://doc.babylonjs.com/how_to/webvr_camera
  97663. */
  97664. autoEnableWebVR?: boolean;
  97665. /**
  97666. * Defines if webgl2 should be turned off even if supported
  97667. * @see http://doc.babylonjs.com/features/webgl2
  97668. */
  97669. disableWebGL2Support?: boolean;
  97670. /**
  97671. * Defines if webaudio should be initialized as well
  97672. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  97673. */
  97674. audioEngine?: boolean;
  97675. /**
  97676. * Defines if animations should run using a deterministic lock step
  97677. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  97678. */
  97679. deterministicLockstep?: boolean;
  97680. /** Defines the maximum steps to use with deterministic lock step mode */
  97681. lockstepMaxSteps?: number;
  97682. /**
  97683. * Defines that engine should ignore context lost events
  97684. * If this event happens when this parameter is true, you will have to reload the page to restore rendering
  97685. */
  97686. doNotHandleContextLost?: boolean;
  97687. /**
  97688. * Defines that engine should ignore modifying touch action attribute and style
  97689. * If not handle, you might need to set it up on your side for expected touch devices behavior.
  97690. */
  97691. doNotHandleTouchAction?: boolean;
  97692. /**
  97693. * Defines that engine should compile shaders with high precision floats (if supported). True by default
  97694. */
  97695. useHighPrecisionFloats?: boolean;
  97696. }
  97697. /**
  97698. * The base engine class (root of all engines)
  97699. */
  97700. export class ThinEngine {
  97701. /** Use this array to turn off some WebGL2 features on known buggy browsers version */
  97702. static ExceptionList: ({
  97703. key: string;
  97704. capture: string;
  97705. captureConstraint: number;
  97706. targets: string[];
  97707. } | {
  97708. key: string;
  97709. capture: null;
  97710. captureConstraint: null;
  97711. targets: string[];
  97712. })[];
  97713. /** @hidden */
  97714. static _TextureLoaders: IInternalTextureLoader[];
  97715. /**
  97716. * Returns the current npm package of the sdk
  97717. */
  97718. static readonly NpmPackage: string;
  97719. /**
  97720. * Returns the current version of the framework
  97721. */
  97722. static readonly Version: string;
  97723. /**
  97724. * Returns a string describing the current engine
  97725. */
  97726. readonly description: string;
  97727. /**
  97728. * Gets or sets the epsilon value used by collision engine
  97729. */
  97730. static CollisionsEpsilon: number;
  97731. /**
  97732. * Gets or sets the relative url used to load shaders if using the engine in non-minified mode
  97733. */
  97734. static ShadersRepository: string;
  97735. /** @hidden */
  97736. _shaderProcessor: IShaderProcessor;
  97737. /**
  97738. * Gets or sets a boolean that indicates if textures must be forced to power of 2 size even if not required
  97739. */
  97740. forcePOTTextures: boolean;
  97741. /**
  97742. * Gets a boolean indicating if the engine is currently rendering in fullscreen mode
  97743. */
  97744. isFullscreen: boolean;
  97745. /**
  97746. * Gets or sets a boolean indicating if back faces must be culled (true by default)
  97747. */
  97748. cullBackFaces: boolean;
  97749. /**
  97750. * Gets or sets a boolean indicating if the engine must keep rendering even if the window is not in foregroun
  97751. */
  97752. renderEvenInBackground: boolean;
  97753. /**
  97754. * Gets or sets a boolean indicating that cache can be kept between frames
  97755. */
  97756. preventCacheWipeBetweenFrames: boolean;
  97757. /** Gets or sets a boolean indicating if the engine should validate programs after compilation */
  97758. validateShaderPrograms: boolean;
  97759. /**
  97760. * Gets or sets a boolean indicating that uniform buffers must be disabled even if they are supported
  97761. */
  97762. disableUniformBuffers: boolean;
  97763. /** @hidden */
  97764. _uniformBuffers: UniformBuffer[];
  97765. /**
  97766. * Gets a boolean indicating that the engine supports uniform buffers
  97767. * @see http://doc.babylonjs.com/features/webgl2#uniform-buffer-objets
  97768. */
  97769. readonly supportsUniformBuffers: boolean;
  97770. /** @hidden */
  97771. _gl: WebGLRenderingContext;
  97772. protected _renderingCanvas: Nullable<HTMLCanvasElement>;
  97773. protected _windowIsBackground: boolean;
  97774. protected _webGLVersion: number;
  97775. protected _creationOptions: EngineOptions;
  97776. protected _highPrecisionShadersAllowed: boolean;
  97777. /** @hidden */
  97778. readonly _shouldUseHighPrecisionShader: boolean;
  97779. /**
  97780. * Gets a boolean indicating that only power of 2 textures are supported
  97781. * Please note that you can still use non power of 2 textures but in this case the engine will forcefully convert them
  97782. */
  97783. readonly needPOTTextures: boolean;
  97784. /** @hidden */
  97785. _badOS: boolean;
  97786. /** @hidden */
  97787. _badDesktopOS: boolean;
  97788. private _hardwareScalingLevel;
  97789. /** @hidden */
  97790. _caps: EngineCapabilities;
  97791. private _isStencilEnable;
  97792. protected _colorWrite: boolean;
  97793. private _glVersion;
  97794. private _glRenderer;
  97795. private _glVendor;
  97796. /** @hidden */
  97797. _videoTextureSupported: boolean;
  97798. protected _renderingQueueLaunched: boolean;
  97799. protected _activeRenderLoops: (() => void)[];
  97800. /**
  97801. * Observable signaled when a context lost event is raised
  97802. */
  97803. onContextLostObservable: Observable<ThinEngine>;
  97804. /**
  97805. * Observable signaled when a context restored event is raised
  97806. */
  97807. onContextRestoredObservable: Observable<ThinEngine>;
  97808. private _onContextLost;
  97809. private _onContextRestored;
  97810. protected _contextWasLost: boolean;
  97811. /** @hidden */
  97812. _doNotHandleContextLost: boolean;
  97813. /**
  97814. * Gets or sets a boolean indicating if resources should be retained to be able to handle context lost events
  97815. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#handling-webgl-context-lost
  97816. */
  97817. doNotHandleContextLost: boolean;
  97818. /**
  97819. * Gets or sets a boolean indicating that vertex array object must be disabled even if they are supported
  97820. */
  97821. disableVertexArrayObjects: boolean;
  97822. /** @hidden */
  97823. protected _depthCullingState: DepthCullingState;
  97824. /** @hidden */
  97825. protected _stencilState: StencilState;
  97826. /** @hidden */
  97827. protected _alphaState: AlphaState;
  97828. /** @hidden */
  97829. _internalTexturesCache: InternalTexture[];
  97830. /** @hidden */
  97831. protected _activeChannel: number;
  97832. private _currentTextureChannel;
  97833. /** @hidden */
  97834. protected _boundTexturesCache: {
  97835. [key: string]: Nullable<InternalTexture>;
  97836. };
  97837. /** @hidden */
  97838. protected _currentEffect: Nullable<Effect>;
  97839. /** @hidden */
  97840. protected _currentProgram: Nullable<WebGLProgram>;
  97841. private _compiledEffects;
  97842. private _vertexAttribArraysEnabled;
  97843. /** @hidden */
  97844. protected _cachedViewport: Nullable<IViewportLike>;
  97845. private _cachedVertexArrayObject;
  97846. /** @hidden */
  97847. protected _cachedVertexBuffers: any;
  97848. /** @hidden */
  97849. protected _cachedIndexBuffer: Nullable<DataBuffer>;
  97850. /** @hidden */
  97851. protected _cachedEffectForVertexBuffers: Nullable<Effect>;
  97852. /** @hidden */
  97853. _currentRenderTarget: Nullable<InternalTexture>;
  97854. private _uintIndicesCurrentlySet;
  97855. protected _currentBoundBuffer: Nullable<WebGLBuffer>[];
  97856. /** @hidden */
  97857. protected _currentFramebuffer: Nullable<WebGLFramebuffer>;
  97858. private _currentBufferPointers;
  97859. private _currentInstanceLocations;
  97860. private _currentInstanceBuffers;
  97861. private _textureUnits;
  97862. /** @hidden */
  97863. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  97864. /** @hidden */
  97865. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  97866. /** @hidden */
  97867. _boundRenderFunction: any;
  97868. private _vaoRecordInProgress;
  97869. private _mustWipeVertexAttributes;
  97870. private _emptyTexture;
  97871. private _emptyCubeTexture;
  97872. private _emptyTexture3D;
  97873. private _emptyTexture2DArray;
  97874. /** @hidden */
  97875. _frameHandler: number;
  97876. private _nextFreeTextureSlots;
  97877. private _maxSimultaneousTextures;
  97878. private _activeRequests;
  97879. protected _texturesSupported: string[];
  97880. /** @hidden */
  97881. _textureFormatInUse: Nullable<string>;
  97882. protected readonly _supportsHardwareTextureRescaling: boolean;
  97883. /**
  97884. * Gets the list of texture formats supported
  97885. */
  97886. readonly texturesSupported: Array<string>;
  97887. /**
  97888. * Gets the list of texture formats in use
  97889. */
  97890. readonly textureFormatInUse: Nullable<string>;
  97891. /**
  97892. * Gets the current viewport
  97893. */
  97894. readonly currentViewport: Nullable<IViewportLike>;
  97895. /**
  97896. * Gets the default empty texture
  97897. */
  97898. readonly emptyTexture: InternalTexture;
  97899. /**
  97900. * Gets the default empty 3D texture
  97901. */
  97902. readonly emptyTexture3D: InternalTexture;
  97903. /**
  97904. * Gets the default empty 2D array texture
  97905. */
  97906. readonly emptyTexture2DArray: InternalTexture;
  97907. /**
  97908. * Gets the default empty cube texture
  97909. */
  97910. readonly emptyCubeTexture: InternalTexture;
  97911. /**
  97912. * Defines whether the engine has been created with the premultipliedAlpha option on or not.
  97913. */
  97914. readonly premultipliedAlpha: boolean;
  97915. /**
  97916. * Observable event triggered before each texture is initialized
  97917. */
  97918. onBeforeTextureInitObservable: Observable<Texture>;
  97919. /**
  97920. * Creates a new engine
  97921. * @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
  97922. * @param antialias defines enable antialiasing (default: false)
  97923. * @param options defines further options to be sent to the getContext() function
  97924. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  97925. */
  97926. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  97927. private _rebuildInternalTextures;
  97928. private _rebuildEffects;
  97929. /**
  97930. * Gets a boolean indicating if all created effects are ready
  97931. * @returns true if all effects are ready
  97932. */
  97933. areAllEffectsReady(): boolean;
  97934. protected _rebuildBuffers(): void;
  97935. private _initGLContext;
  97936. /**
  97937. * Gets version of the current webGL context
  97938. */
  97939. readonly webGLVersion: number;
  97940. /**
  97941. * Gets a string idenfifying the name of the class
  97942. * @returns "Engine" string
  97943. */
  97944. getClassName(): string;
  97945. /**
  97946. * Returns true if the stencil buffer has been enabled through the creation option of the context.
  97947. */
  97948. readonly isStencilEnable: boolean;
  97949. /** @hidden */
  97950. _prepareWorkingCanvas(): void;
  97951. /**
  97952. * Reset the texture cache to empty state
  97953. */
  97954. resetTextureCache(): void;
  97955. /**
  97956. * Gets an object containing information about the current webGL context
  97957. * @returns an object containing the vender, the renderer and the version of the current webGL context
  97958. */
  97959. getGlInfo(): {
  97960. vendor: string;
  97961. renderer: string;
  97962. version: string;
  97963. };
  97964. /**
  97965. * Defines the hardware scaling level.
  97966. * By default the hardware scaling level is computed from the window device ratio.
  97967. * 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.
  97968. * @param level defines the level to use
  97969. */
  97970. setHardwareScalingLevel(level: number): void;
  97971. /**
  97972. * Gets the current hardware scaling level.
  97973. * By default the hardware scaling level is computed from the window device ratio.
  97974. * 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.
  97975. * @returns a number indicating the current hardware scaling level
  97976. */
  97977. getHardwareScalingLevel(): number;
  97978. /**
  97979. * Gets the list of loaded textures
  97980. * @returns an array containing all loaded textures
  97981. */
  97982. getLoadedTexturesCache(): InternalTexture[];
  97983. /**
  97984. * Gets the object containing all engine capabilities
  97985. * @returns the EngineCapabilities object
  97986. */
  97987. getCaps(): EngineCapabilities;
  97988. /**
  97989. * stop executing a render loop function and remove it from the execution array
  97990. * @param renderFunction defines the function to be removed. If not provided all functions will be removed.
  97991. */
  97992. stopRenderLoop(renderFunction?: () => void): void;
  97993. /** @hidden */
  97994. _renderLoop(): void;
  97995. /**
  97996. * Gets the HTML canvas attached with the current webGL context
  97997. * @returns a HTML canvas
  97998. */
  97999. getRenderingCanvas(): Nullable<HTMLCanvasElement>;
  98000. /**
  98001. * Gets host window
  98002. * @returns the host window object
  98003. */
  98004. getHostWindow(): Nullable<Window>;
  98005. /**
  98006. * Gets the current render width
  98007. * @param useScreen defines if screen size must be used (or the current render target if any)
  98008. * @returns a number defining the current render width
  98009. */
  98010. getRenderWidth(useScreen?: boolean): number;
  98011. /**
  98012. * Gets the current render height
  98013. * @param useScreen defines if screen size must be used (or the current render target if any)
  98014. * @returns a number defining the current render height
  98015. */
  98016. getRenderHeight(useScreen?: boolean): number;
  98017. /**
  98018. * Can be used to override the current requestAnimationFrame requester.
  98019. * @hidden
  98020. */
  98021. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  98022. /**
  98023. * Register and execute a render loop. The engine can have more than one render function
  98024. * @param renderFunction defines the function to continuously execute
  98025. */
  98026. runRenderLoop(renderFunction: () => void): void;
  98027. /**
  98028. * Clear the current render buffer or the current render target (if any is set up)
  98029. * @param color defines the color to use
  98030. * @param backBuffer defines if the back buffer must be cleared
  98031. * @param depth defines if the depth buffer must be cleared
  98032. * @param stencil defines if the stencil buffer must be cleared
  98033. */
  98034. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  98035. private _viewportCached;
  98036. /** @hidden */
  98037. _viewport(x: number, y: number, width: number, height: number): void;
  98038. /**
  98039. * Set the WebGL's viewport
  98040. * @param viewport defines the viewport element to be used
  98041. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  98042. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  98043. */
  98044. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  98045. /**
  98046. * Begin a new frame
  98047. */
  98048. beginFrame(): void;
  98049. /**
  98050. * Enf the current frame
  98051. */
  98052. endFrame(): void;
  98053. /**
  98054. * Resize the view according to the canvas' size
  98055. */
  98056. resize(): void;
  98057. /**
  98058. * Force a specific size of the canvas
  98059. * @param width defines the new canvas' width
  98060. * @param height defines the new canvas' height
  98061. */
  98062. setSize(width: number, height: number): void;
  98063. /**
  98064. * Binds the frame buffer to the specified texture.
  98065. * @param texture The texture to render to or null for the default canvas
  98066. * @param faceIndex The face of the texture to render to in case of cube texture
  98067. * @param requiredWidth The width of the target to render to
  98068. * @param requiredHeight The height of the target to render to
  98069. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  98070. * @param depthStencilTexture The depth stencil texture to use to render
  98071. * @param lodLevel defines le lod level to bind to the frame buffer
  98072. */
  98073. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean, depthStencilTexture?: InternalTexture, lodLevel?: number): void;
  98074. /** @hidden */
  98075. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  98076. /**
  98077. * Unbind the current render target texture from the webGL context
  98078. * @param texture defines the render target texture to unbind
  98079. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  98080. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  98081. */
  98082. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  98083. /**
  98084. * Force a webGL flush (ie. a flush of all waiting webGL commands)
  98085. */
  98086. flushFramebuffer(): void;
  98087. /**
  98088. * Unbind the current render target and bind the default framebuffer
  98089. */
  98090. restoreDefaultFramebuffer(): void;
  98091. /** @hidden */
  98092. protected _resetVertexBufferBinding(): void;
  98093. /**
  98094. * Creates a vertex buffer
  98095. * @param data the data for the vertex buffer
  98096. * @returns the new WebGL static buffer
  98097. */
  98098. createVertexBuffer(data: DataArray): DataBuffer;
  98099. private _createVertexBuffer;
  98100. /**
  98101. * Creates a dynamic vertex buffer
  98102. * @param data the data for the dynamic vertex buffer
  98103. * @returns the new WebGL dynamic buffer
  98104. */
  98105. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  98106. protected _resetIndexBufferBinding(): void;
  98107. /**
  98108. * Creates a new index buffer
  98109. * @param indices defines the content of the index buffer
  98110. * @param updatable defines if the index buffer must be updatable
  98111. * @returns a new webGL buffer
  98112. */
  98113. createIndexBuffer(indices: IndicesArray, updatable?: boolean): DataBuffer;
  98114. protected _normalizeIndexData(indices: IndicesArray): Uint16Array | Uint32Array;
  98115. /**
  98116. * Bind a webGL buffer to the webGL context
  98117. * @param buffer defines the buffer to bind
  98118. */
  98119. bindArrayBuffer(buffer: Nullable<DataBuffer>): void;
  98120. protected bindIndexBuffer(buffer: Nullable<DataBuffer>): void;
  98121. private bindBuffer;
  98122. /**
  98123. * update the bound buffer with the given data
  98124. * @param data defines the data to update
  98125. */
  98126. updateArrayBuffer(data: Float32Array): void;
  98127. private _vertexAttribPointer;
  98128. private _bindIndexBufferWithCache;
  98129. private _bindVertexBuffersAttributes;
  98130. /**
  98131. * Records a vertex array object
  98132. * @see http://doc.babylonjs.com/features/webgl2#vertex-array-objects
  98133. * @param vertexBuffers defines the list of vertex buffers to store
  98134. * @param indexBuffer defines the index buffer to store
  98135. * @param effect defines the effect to store
  98136. * @returns the new vertex array object
  98137. */
  98138. recordVertexArrayObject(vertexBuffers: {
  98139. [key: string]: VertexBuffer;
  98140. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): WebGLVertexArrayObject;
  98141. /**
  98142. * Bind a specific vertex array object
  98143. * @see http://doc.babylonjs.com/features/webgl2#vertex-array-objects
  98144. * @param vertexArrayObject defines the vertex array object to bind
  98145. * @param indexBuffer defines the index buffer to bind
  98146. */
  98147. bindVertexArrayObject(vertexArrayObject: WebGLVertexArrayObject, indexBuffer: Nullable<DataBuffer>): void;
  98148. /**
  98149. * Bind webGl buffers directly to the webGL context
  98150. * @param vertexBuffer defines the vertex buffer to bind
  98151. * @param indexBuffer defines the index buffer to bind
  98152. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  98153. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  98154. * @param effect defines the effect associated with the vertex buffer
  98155. */
  98156. bindBuffersDirectly(vertexBuffer: DataBuffer, indexBuffer: DataBuffer, vertexDeclaration: number[], vertexStrideSize: number, effect: Effect): void;
  98157. private _unbindVertexArrayObject;
  98158. /**
  98159. * Bind a list of vertex buffers to the webGL context
  98160. * @param vertexBuffers defines the list of vertex buffers to bind
  98161. * @param indexBuffer defines the index buffer to bind
  98162. * @param effect defines the effect associated with the vertex buffers
  98163. */
  98164. bindBuffers(vertexBuffers: {
  98165. [key: string]: Nullable<VertexBuffer>;
  98166. }, indexBuffer: Nullable<DataBuffer>, effect: Effect): void;
  98167. /**
  98168. * Unbind all instance attributes
  98169. */
  98170. unbindInstanceAttributes(): void;
  98171. /**
  98172. * Release and free the memory of a vertex array object
  98173. * @param vao defines the vertex array object to delete
  98174. */
  98175. releaseVertexArrayObject(vao: WebGLVertexArrayObject): void;
  98176. /** @hidden */
  98177. _releaseBuffer(buffer: DataBuffer): boolean;
  98178. protected _deleteBuffer(buffer: DataBuffer): void;
  98179. /**
  98180. * Update the content of a webGL buffer used with instanciation and bind it to the webGL context
  98181. * @param instancesBuffer defines the webGL buffer to update and bind
  98182. * @param data defines the data to store in the buffer
  98183. * @param offsetLocations defines the offsets or attributes information used to determine where data must be stored in the buffer
  98184. */
  98185. updateAndBindInstancesBuffer(instancesBuffer: DataBuffer, data: Float32Array, offsetLocations: number[] | InstancingAttributeInfo[]): void;
  98186. /**
  98187. * Apply all cached states (depth, culling, stencil and alpha)
  98188. */
  98189. applyStates(): void;
  98190. /**
  98191. * Send a draw order
  98192. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  98193. * @param indexStart defines the starting index
  98194. * @param indexCount defines the number of index to draw
  98195. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  98196. */
  98197. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  98198. /**
  98199. * Draw a list of points
  98200. * @param verticesStart defines the index of first vertex to draw
  98201. * @param verticesCount defines the count of vertices to draw
  98202. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  98203. */
  98204. drawPointClouds(verticesStart: number, verticesCount: number, instancesCount?: number): void;
  98205. /**
  98206. * Draw a list of unindexed primitives
  98207. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  98208. * @param verticesStart defines the index of first vertex to draw
  98209. * @param verticesCount defines the count of vertices to draw
  98210. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  98211. */
  98212. drawUnIndexed(useTriangles: boolean, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  98213. /**
  98214. * Draw a list of indexed primitives
  98215. * @param fillMode defines the primitive to use
  98216. * @param indexStart defines the starting index
  98217. * @param indexCount defines the number of index to draw
  98218. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  98219. */
  98220. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  98221. /**
  98222. * Draw a list of unindexed primitives
  98223. * @param fillMode defines the primitive to use
  98224. * @param verticesStart defines the index of first vertex to draw
  98225. * @param verticesCount defines the count of vertices to draw
  98226. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  98227. */
  98228. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  98229. private _drawMode;
  98230. /** @hidden */
  98231. protected _reportDrawCall(): void;
  98232. /** @hidden */
  98233. _releaseEffect(effect: Effect): void;
  98234. /** @hidden */
  98235. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  98236. /**
  98237. * Create a new effect (used to store vertex/fragment shaders)
  98238. * @param baseName defines the base name of the effect (The name of file without .fragment.fx or .vertex.fx)
  98239. * @param attributesNamesOrOptions defines either a list of attribute names or an IEffectCreationOptions object
  98240. * @param uniformsNamesOrEngine defines either a list of uniform names or the engine to use
  98241. * @param samplers defines an array of string used to represent textures
  98242. * @param defines defines the string containing the defines to use to compile the shaders
  98243. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  98244. * @param onCompiled defines a function to call when the effect creation is successful
  98245. * @param onError defines a function to call when the effect creation has failed
  98246. * @param indexParameters defines an object containing the index values to use to compile shaders (like the maximum number of simultaneous lights)
  98247. * @returns the new Effect
  98248. */
  98249. 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;
  98250. protected static _ConcatenateShader(source: string, defines: Nullable<string>, shaderVersion?: string): string;
  98251. private _compileShader;
  98252. private _compileRawShader;
  98253. /**
  98254. * Directly creates a webGL program
  98255. * @param pipelineContext defines the pipeline context to attach to
  98256. * @param vertexCode defines the vertex shader code to use
  98257. * @param fragmentCode defines the fragment shader code to use
  98258. * @param context defines the webGL context to use (if not set, the current one will be used)
  98259. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  98260. * @returns the new webGL program
  98261. */
  98262. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  98263. /**
  98264. * Creates a webGL program
  98265. * @param pipelineContext defines the pipeline context to attach to
  98266. * @param vertexCode defines the vertex shader code to use
  98267. * @param fragmentCode defines the fragment shader code to use
  98268. * @param defines defines the string containing the defines to use to compile the shaders
  98269. * @param context defines the webGL context to use (if not set, the current one will be used)
  98270. * @param transformFeedbackVaryings defines the list of transform feedback varyings to use
  98271. * @returns the new webGL program
  98272. */
  98273. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  98274. /**
  98275. * Creates a new pipeline context
  98276. * @returns the new pipeline
  98277. */
  98278. createPipelineContext(): IPipelineContext;
  98279. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  98280. protected _finalizePipelineContext(pipelineContext: WebGLPipelineContext): void;
  98281. /** @hidden */
  98282. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  98283. /** @hidden */
  98284. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  98285. /** @hidden */
  98286. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  98287. /**
  98288. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  98289. * @param pipelineContext defines the pipeline context to use
  98290. * @param uniformsNames defines the list of uniform names
  98291. * @returns an array of webGL uniform locations
  98292. */
  98293. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  98294. /**
  98295. * Gets the lsit of active attributes for a given webGL program
  98296. * @param pipelineContext defines the pipeline context to use
  98297. * @param attributesNames defines the list of attribute names to get
  98298. * @returns an array of indices indicating the offset of each attribute
  98299. */
  98300. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  98301. /**
  98302. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  98303. * @param effect defines the effect to activate
  98304. */
  98305. enableEffect(effect: Nullable<Effect>): void;
  98306. /**
  98307. * Set the value of an uniform to a number (int)
  98308. * @param uniform defines the webGL uniform location where to store the value
  98309. * @param value defines the int number to store
  98310. */
  98311. setInt(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  98312. /**
  98313. * Set the value of an uniform to an array of int32
  98314. * @param uniform defines the webGL uniform location where to store the value
  98315. * @param array defines the array of int32 to store
  98316. */
  98317. setIntArray(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  98318. /**
  98319. * Set the value of an uniform to an array of int32 (stored as vec2)
  98320. * @param uniform defines the webGL uniform location where to store the value
  98321. * @param array defines the array of int32 to store
  98322. */
  98323. setIntArray2(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  98324. /**
  98325. * Set the value of an uniform to an array of int32 (stored as vec3)
  98326. * @param uniform defines the webGL uniform location where to store the value
  98327. * @param array defines the array of int32 to store
  98328. */
  98329. setIntArray3(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  98330. /**
  98331. * Set the value of an uniform to an array of int32 (stored as vec4)
  98332. * @param uniform defines the webGL uniform location where to store the value
  98333. * @param array defines the array of int32 to store
  98334. */
  98335. setIntArray4(uniform: Nullable<WebGLUniformLocation>, array: Int32Array): void;
  98336. /**
  98337. * Set the value of an uniform to an array of number
  98338. * @param uniform defines the webGL uniform location where to store the value
  98339. * @param array defines the array of number to store
  98340. */
  98341. setArray(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  98342. /**
  98343. * Set the value of an uniform to an array of number (stored as vec2)
  98344. * @param uniform defines the webGL uniform location where to store the value
  98345. * @param array defines the array of number to store
  98346. */
  98347. setArray2(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  98348. /**
  98349. * Set the value of an uniform to an array of number (stored as vec3)
  98350. * @param uniform defines the webGL uniform location where to store the value
  98351. * @param array defines the array of number to store
  98352. */
  98353. setArray3(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  98354. /**
  98355. * Set the value of an uniform to an array of number (stored as vec4)
  98356. * @param uniform defines the webGL uniform location where to store the value
  98357. * @param array defines the array of number to store
  98358. */
  98359. setArray4(uniform: Nullable<WebGLUniformLocation>, array: number[] | Float32Array): void;
  98360. /**
  98361. * Set the value of an uniform to an array of float32 (stored as matrices)
  98362. * @param uniform defines the webGL uniform location where to store the value
  98363. * @param matrices defines the array of float32 to store
  98364. */
  98365. setMatrices(uniform: Nullable<WebGLUniformLocation>, matrices: Float32Array): void;
  98366. /**
  98367. * Set the value of an uniform to a matrix (3x3)
  98368. * @param uniform defines the webGL uniform location where to store the value
  98369. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  98370. */
  98371. setMatrix3x3(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  98372. /**
  98373. * Set the value of an uniform to a matrix (2x2)
  98374. * @param uniform defines the webGL uniform location where to store the value
  98375. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  98376. */
  98377. setMatrix2x2(uniform: Nullable<WebGLUniformLocation>, matrix: Float32Array): void;
  98378. /**
  98379. * Set the value of an uniform to a number (float)
  98380. * @param uniform defines the webGL uniform location where to store the value
  98381. * @param value defines the float number to store
  98382. */
  98383. setFloat(uniform: Nullable<WebGLUniformLocation>, value: number): void;
  98384. /**
  98385. * Set the value of an uniform to a vec2
  98386. * @param uniform defines the webGL uniform location where to store the value
  98387. * @param x defines the 1st component of the value
  98388. * @param y defines the 2nd component of the value
  98389. */
  98390. setFloat2(uniform: Nullable<WebGLUniformLocation>, x: number, y: number): void;
  98391. /**
  98392. * Set the value of an uniform to a vec3
  98393. * @param uniform defines the webGL uniform location where to store the value
  98394. * @param x defines the 1st component of the value
  98395. * @param y defines the 2nd component of the value
  98396. * @param z defines the 3rd component of the value
  98397. */
  98398. setFloat3(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number): void;
  98399. /**
  98400. * Set the value of an uniform to a vec4
  98401. * @param uniform defines the webGL uniform location where to store the value
  98402. * @param x defines the 1st component of the value
  98403. * @param y defines the 2nd component of the value
  98404. * @param z defines the 3rd component of the value
  98405. * @param w defines the 4th component of the value
  98406. */
  98407. setFloat4(uniform: Nullable<WebGLUniformLocation>, x: number, y: number, z: number, w: number): void;
  98408. /**
  98409. * Gets the depth culling state manager
  98410. */
  98411. readonly depthCullingState: DepthCullingState;
  98412. /**
  98413. * Gets the alpha state manager
  98414. */
  98415. readonly alphaState: AlphaState;
  98416. /**
  98417. * Gets the stencil state manager
  98418. */
  98419. readonly stencilState: StencilState;
  98420. /**
  98421. * Clears the list of texture accessible through engine.
  98422. * This can help preventing texture load conflict due to name collision.
  98423. */
  98424. clearInternalTexturesCache(): void;
  98425. /**
  98426. * Force the entire cache to be cleared
  98427. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  98428. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  98429. */
  98430. wipeCaches(bruteForce?: boolean): void;
  98431. /** @hidden */
  98432. _getSamplingParameters(samplingMode: number, generateMipMaps: boolean): {
  98433. min: number;
  98434. mag: number;
  98435. };
  98436. /** @hidden */
  98437. _createTexture(): WebGLTexture;
  98438. /**
  98439. * Usually called from Texture.ts.
  98440. * Passed information to create a WebGLTexture
  98441. * @param urlArg defines a value which contains one of the following:
  98442. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  98443. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  98444. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  98445. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  98446. * @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)
  98447. * @param scene needed for loading to the correct scene
  98448. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  98449. * @param onLoad optional callback to be called upon successful completion
  98450. * @param onError optional callback to be called upon failure
  98451. * @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
  98452. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  98453. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  98454. * @param forcedExtension defines the extension to use to pick the right loader
  98455. * @param excludeLoaders array of texture loaders that should be excluded when picking a loader for the texture (default: empty array)
  98456. * @param mimeType defines an optional mime type
  98457. * @returns a InternalTexture for assignment back into BABYLON.Texture
  98458. */
  98459. 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;
  98460. /**
  98461. * @hidden
  98462. */
  98463. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  98464. /**
  98465. * Creates a raw texture
  98466. * @param data defines the data to store in the texture
  98467. * @param width defines the width of the texture
  98468. * @param height defines the height of the texture
  98469. * @param format defines the format of the data
  98470. * @param generateMipMaps defines if the engine should generate the mip levels
  98471. * @param invertY defines if data must be stored with Y axis inverted
  98472. * @param samplingMode defines the required sampling mode (Texture.NEAREST_SAMPLINGMODE by default)
  98473. * @param compression defines the compression used (null by default)
  98474. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  98475. * @returns the raw texture inside an InternalTexture
  98476. */
  98477. createRawTexture(data: Nullable<ArrayBufferView>, width: number, height: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression?: Nullable<string>, type?: number): InternalTexture;
  98478. /**
  98479. * Creates a new raw cube texture
  98480. * @param data defines the array of data to use to create each face
  98481. * @param size defines the size of the textures
  98482. * @param format defines the format of the data
  98483. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  98484. * @param generateMipMaps defines if the engine should generate the mip levels
  98485. * @param invertY defines if data must be stored with Y axis inverted
  98486. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  98487. * @param compression defines the compression used (null by default)
  98488. * @returns the cube texture as an InternalTexture
  98489. */
  98490. createRawCubeTexture(data: Nullable<ArrayBufferView[]>, size: number, format: number, type: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression?: Nullable<string>): InternalTexture;
  98491. /**
  98492. * Creates a new raw 3D texture
  98493. * @param data defines the data used to create the texture
  98494. * @param width defines the width of the texture
  98495. * @param height defines the height of the texture
  98496. * @param depth defines the depth of the texture
  98497. * @param format defines the format of the texture
  98498. * @param generateMipMaps defines if the engine must generate mip levels
  98499. * @param invertY defines if data must be stored with Y axis inverted
  98500. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  98501. * @param compression defines the compressed used (can be null)
  98502. * @param textureType defines the compressed used (can be null)
  98503. * @returns a new raw 3D texture (stored in an InternalTexture)
  98504. */
  98505. createRawTexture3D(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression?: Nullable<string>, textureType?: number): InternalTexture;
  98506. /**
  98507. * Creates a new raw 2D array texture
  98508. * @param data defines the data used to create the texture
  98509. * @param width defines the width of the texture
  98510. * @param height defines the height of the texture
  98511. * @param depth defines the number of layers of the texture
  98512. * @param format defines the format of the texture
  98513. * @param generateMipMaps defines if the engine must generate mip levels
  98514. * @param invertY defines if data must be stored with Y axis inverted
  98515. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  98516. * @param compression defines the compressed used (can be null)
  98517. * @param textureType defines the compressed used (can be null)
  98518. * @returns a new raw 2D array texture (stored in an InternalTexture)
  98519. */
  98520. createRawTexture2DArray(data: Nullable<ArrayBufferView>, width: number, height: number, depth: number, format: number, generateMipMaps: boolean, invertY: boolean, samplingMode: number, compression?: Nullable<string>, textureType?: number): InternalTexture;
  98521. private _unpackFlipYCached;
  98522. /**
  98523. * In case you are sharing the context with other applications, it might
  98524. * be interested to not cache the unpack flip y state to ensure a consistent
  98525. * value would be set.
  98526. */
  98527. enableUnpackFlipYCached: boolean;
  98528. /** @hidden */
  98529. _unpackFlipY(value: boolean): void;
  98530. /** @hidden */
  98531. _getUnpackAlignement(): number;
  98532. /**
  98533. * Update the sampling mode of a given texture
  98534. * @param samplingMode defines the required sampling mode
  98535. * @param texture defines the texture to update
  98536. */
  98537. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  98538. /** @hidden */
  98539. _setupDepthStencilTexture(internalTexture: InternalTexture, size: number | {
  98540. width: number;
  98541. height: number;
  98542. }, generateStencil: boolean, bilinearFiltering: boolean, comparisonFunction: number): void;
  98543. /** @hidden */
  98544. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  98545. /** @hidden */
  98546. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number, babylonInternalFormat?: number, useTextureWidthAndHeight?: boolean): void;
  98547. /** @hidden */
  98548. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  98549. protected _prepareWebGLTextureContinuation(texture: InternalTexture, scene: Nullable<ISceneLike>, noMipmap: boolean, isCompressed: boolean, samplingMode: number): void;
  98550. private _prepareWebGLTexture;
  98551. /** @hidden */
  98552. _setupFramebufferDepthAttachments(generateStencilBuffer: boolean, generateDepthBuffer: boolean, width: number, height: number, samples?: number): Nullable<WebGLRenderbuffer>;
  98553. /** @hidden */
  98554. _releaseFramebufferObjects(texture: InternalTexture): void;
  98555. /** @hidden */
  98556. _releaseTexture(texture: InternalTexture): void;
  98557. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  98558. protected _setProgram(program: WebGLProgram): void;
  98559. protected _boundUniforms: {
  98560. [key: number]: WebGLUniformLocation;
  98561. };
  98562. /**
  98563. * Binds an effect to the webGL context
  98564. * @param effect defines the effect to bind
  98565. */
  98566. bindSamplers(effect: Effect): void;
  98567. private _activateCurrentTexture;
  98568. /** @hidden */
  98569. _bindTextureDirectly(target: number, texture: Nullable<InternalTexture>, forTextureDataUpdate?: boolean, force?: boolean): boolean;
  98570. /** @hidden */
  98571. _bindTexture(channel: number, texture: Nullable<InternalTexture>): void;
  98572. /**
  98573. * Unbind all textures from the webGL context
  98574. */
  98575. unbindAllTextures(): void;
  98576. /**
  98577. * Sets a texture to the according uniform.
  98578. * @param channel The texture channel
  98579. * @param uniform The uniform to set
  98580. * @param texture The texture to apply
  98581. */
  98582. setTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<BaseTexture>): void;
  98583. private _bindSamplerUniformToChannel;
  98584. private _getTextureWrapMode;
  98585. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  98586. /**
  98587. * Sets an array of texture to the webGL context
  98588. * @param channel defines the channel where the texture array must be set
  98589. * @param uniform defines the associated uniform location
  98590. * @param textures defines the array of textures to bind
  98591. */
  98592. setTextureArray(channel: number, uniform: Nullable<WebGLUniformLocation>, textures: BaseTexture[]): void;
  98593. /** @hidden */
  98594. _setAnisotropicLevel(target: number, texture: BaseTexture): void;
  98595. private _setTextureParameterFloat;
  98596. private _setTextureParameterInteger;
  98597. /**
  98598. * Unbind all vertex attributes from the webGL context
  98599. */
  98600. unbindAllAttributes(): void;
  98601. /**
  98602. * 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
  98603. */
  98604. releaseEffects(): void;
  98605. /**
  98606. * Dispose and release all associated resources
  98607. */
  98608. dispose(): void;
  98609. /**
  98610. * Attach a new callback raised when context lost event is fired
  98611. * @param callback defines the callback to call
  98612. */
  98613. attachContextLostEvent(callback: ((event: WebGLContextEvent) => void)): void;
  98614. /**
  98615. * Attach a new callback raised when context restored event is fired
  98616. * @param callback defines the callback to call
  98617. */
  98618. attachContextRestoredEvent(callback: ((event: WebGLContextEvent) => void)): void;
  98619. /**
  98620. * Get the current error code of the webGL context
  98621. * @returns the error code
  98622. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  98623. */
  98624. getError(): number;
  98625. private _canRenderToFloatFramebuffer;
  98626. private _canRenderToHalfFloatFramebuffer;
  98627. private _canRenderToFramebuffer;
  98628. /** @hidden */
  98629. _getWebGLTextureType(type: number): number;
  98630. /** @hidden */
  98631. _getInternalFormat(format: number): number;
  98632. /** @hidden */
  98633. _getRGBABufferInternalSizedFormat(type: number, format?: number): number;
  98634. /** @hidden */
  98635. _getRGBAMultiSampleBufferFormat(type: number): number;
  98636. /** @hidden */
  98637. _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;
  98638. /**
  98639. * Gets a boolean indicating if the engine can be instanciated (ie. if a webGL context can be found)
  98640. * @returns true if the engine can be created
  98641. * @ignorenaming
  98642. */
  98643. static isSupported(): boolean;
  98644. /**
  98645. * Find the next highest power of two.
  98646. * @param x Number to start search from.
  98647. * @return Next highest power of two.
  98648. */
  98649. static CeilingPOT(x: number): number;
  98650. /**
  98651. * Find the next lowest power of two.
  98652. * @param x Number to start search from.
  98653. * @return Next lowest power of two.
  98654. */
  98655. static FloorPOT(x: number): number;
  98656. /**
  98657. * Find the nearest power of two.
  98658. * @param x Number to start search from.
  98659. * @return Next nearest power of two.
  98660. */
  98661. static NearestPOT(x: number): number;
  98662. /**
  98663. * Get the closest exponent of two
  98664. * @param value defines the value to approximate
  98665. * @param max defines the maximum value to return
  98666. * @param mode defines how to define the closest value
  98667. * @returns closest exponent of two of the given value
  98668. */
  98669. static GetExponentOfTwo(value: number, max: number, mode?: number): number;
  98670. /**
  98671. * Queue a new function into the requested animation frame pool (ie. this function will be executed byt the browser for the next frame)
  98672. * @param func - the function to be called
  98673. * @param requester - the object that will request the next frame. Falls back to window.
  98674. * @returns frame number
  98675. */
  98676. static QueueNewFrame(func: () => void, requester?: any): number;
  98677. }
  98678. }
  98679. declare module BABYLON {
  98680. /**
  98681. * Class representing spherical harmonics coefficients to the 3rd degree
  98682. */
  98683. export class SphericalHarmonics {
  98684. /**
  98685. * Defines whether or not the harmonics have been prescaled for rendering.
  98686. */
  98687. preScaled: boolean;
  98688. /**
  98689. * The l0,0 coefficients of the spherical harmonics
  98690. */
  98691. l00: Vector3;
  98692. /**
  98693. * The l1,-1 coefficients of the spherical harmonics
  98694. */
  98695. l1_1: Vector3;
  98696. /**
  98697. * The l1,0 coefficients of the spherical harmonics
  98698. */
  98699. l10: Vector3;
  98700. /**
  98701. * The l1,1 coefficients of the spherical harmonics
  98702. */
  98703. l11: Vector3;
  98704. /**
  98705. * The l2,-2 coefficients of the spherical harmonics
  98706. */
  98707. l2_2: Vector3;
  98708. /**
  98709. * The l2,-1 coefficients of the spherical harmonics
  98710. */
  98711. l2_1: Vector3;
  98712. /**
  98713. * The l2,0 coefficients of the spherical harmonics
  98714. */
  98715. l20: Vector3;
  98716. /**
  98717. * The l2,1 coefficients of the spherical harmonics
  98718. */
  98719. l21: Vector3;
  98720. /**
  98721. * The l2,2 coefficients of the spherical harmonics
  98722. */
  98723. l22: Vector3;
  98724. /**
  98725. * Adds a light to the spherical harmonics
  98726. * @param direction the direction of the light
  98727. * @param color the color of the light
  98728. * @param deltaSolidAngle the delta solid angle of the light
  98729. */
  98730. addLight(direction: Vector3, color: Color3, deltaSolidAngle: number): void;
  98731. /**
  98732. * Scales the spherical harmonics by the given amount
  98733. * @param scale the amount to scale
  98734. */
  98735. scaleInPlace(scale: number): void;
  98736. /**
  98737. * Convert from incident radiance (Li) to irradiance (E) by applying convolution with the cosine-weighted hemisphere.
  98738. *
  98739. * ```
  98740. * E_lm = A_l * L_lm
  98741. * ```
  98742. *
  98743. * In spherical harmonics this convolution amounts to scaling factors for each frequency band.
  98744. * This corresponds to equation 5 in "An Efficient Representation for Irradiance Environment Maps", where
  98745. * the scaling factors are given in equation 9.
  98746. */
  98747. convertIncidentRadianceToIrradiance(): void;
  98748. /**
  98749. * Convert from irradiance to outgoing radiance for Lambertian BDRF, suitable for efficient shader evaluation.
  98750. *
  98751. * ```
  98752. * L = (1/pi) * E * rho
  98753. * ```
  98754. *
  98755. * This is done by an additional scale by 1/pi, so is a fairly trivial operation but important conceptually.
  98756. */
  98757. convertIrradianceToLambertianRadiance(): void;
  98758. /**
  98759. * Integrates the reconstruction coefficients directly in to the SH preventing further
  98760. * required operations at run time.
  98761. *
  98762. * This is simply done by scaling back the SH with Ylm constants parameter.
  98763. * The trigonometric part being applied by the shader at run time.
  98764. */
  98765. preScaleForRendering(): void;
  98766. /**
  98767. * Constructs a spherical harmonics from an array.
  98768. * @param data defines the 9x3 coefficients (l00, l1-1, l10, l11, l2-2, l2-1, l20, l21, l22)
  98769. * @returns the spherical harmonics
  98770. */
  98771. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalHarmonics;
  98772. /**
  98773. * Gets the spherical harmonics from polynomial
  98774. * @param polynomial the spherical polynomial
  98775. * @returns the spherical harmonics
  98776. */
  98777. static FromPolynomial(polynomial: SphericalPolynomial): SphericalHarmonics;
  98778. }
  98779. /**
  98780. * Class representing spherical polynomial coefficients to the 3rd degree
  98781. */
  98782. export class SphericalPolynomial {
  98783. private _harmonics;
  98784. /**
  98785. * The spherical harmonics used to create the polynomials.
  98786. */
  98787. readonly preScaledHarmonics: SphericalHarmonics;
  98788. /**
  98789. * The x coefficients of the spherical polynomial
  98790. */
  98791. x: Vector3;
  98792. /**
  98793. * The y coefficients of the spherical polynomial
  98794. */
  98795. y: Vector3;
  98796. /**
  98797. * The z coefficients of the spherical polynomial
  98798. */
  98799. z: Vector3;
  98800. /**
  98801. * The xx coefficients of the spherical polynomial
  98802. */
  98803. xx: Vector3;
  98804. /**
  98805. * The yy coefficients of the spherical polynomial
  98806. */
  98807. yy: Vector3;
  98808. /**
  98809. * The zz coefficients of the spherical polynomial
  98810. */
  98811. zz: Vector3;
  98812. /**
  98813. * The xy coefficients of the spherical polynomial
  98814. */
  98815. xy: Vector3;
  98816. /**
  98817. * The yz coefficients of the spherical polynomial
  98818. */
  98819. yz: Vector3;
  98820. /**
  98821. * The zx coefficients of the spherical polynomial
  98822. */
  98823. zx: Vector3;
  98824. /**
  98825. * Adds an ambient color to the spherical polynomial
  98826. * @param color the color to add
  98827. */
  98828. addAmbient(color: Color3): void;
  98829. /**
  98830. * Scales the spherical polynomial by the given amount
  98831. * @param scale the amount to scale
  98832. */
  98833. scaleInPlace(scale: number): void;
  98834. /**
  98835. * Gets the spherical polynomial from harmonics
  98836. * @param harmonics the spherical harmonics
  98837. * @returns the spherical polynomial
  98838. */
  98839. static FromHarmonics(harmonics: SphericalHarmonics): SphericalPolynomial;
  98840. /**
  98841. * Constructs a spherical polynomial from an array.
  98842. * @param data defines the 9x3 coefficients (x, y, z, xx, yy, zz, yz, zx, xy)
  98843. * @returns the spherical polynomial
  98844. */
  98845. static FromArray(data: ArrayLike<ArrayLike<number>>): SphericalPolynomial;
  98846. }
  98847. }
  98848. declare module BABYLON {
  98849. /**
  98850. * Defines the source of the internal texture
  98851. */
  98852. export enum InternalTextureSource {
  98853. /**
  98854. * The source of the texture data is unknown
  98855. */
  98856. Unknown = 0,
  98857. /**
  98858. * Texture data comes from an URL
  98859. */
  98860. Url = 1,
  98861. /**
  98862. * Texture data is only used for temporary storage
  98863. */
  98864. Temp = 2,
  98865. /**
  98866. * Texture data comes from raw data (ArrayBuffer)
  98867. */
  98868. Raw = 3,
  98869. /**
  98870. * Texture content is dynamic (video or dynamic texture)
  98871. */
  98872. Dynamic = 4,
  98873. /**
  98874. * Texture content is generated by rendering to it
  98875. */
  98876. RenderTarget = 5,
  98877. /**
  98878. * Texture content is part of a multi render target process
  98879. */
  98880. MultiRenderTarget = 6,
  98881. /**
  98882. * Texture data comes from a cube data file
  98883. */
  98884. Cube = 7,
  98885. /**
  98886. * Texture data comes from a raw cube data
  98887. */
  98888. CubeRaw = 8,
  98889. /**
  98890. * Texture data come from a prefiltered cube data file
  98891. */
  98892. CubePrefiltered = 9,
  98893. /**
  98894. * Texture content is raw 3D data
  98895. */
  98896. Raw3D = 10,
  98897. /**
  98898. * Texture content is raw 2D array data
  98899. */
  98900. Raw2DArray = 11,
  98901. /**
  98902. * Texture content is a depth texture
  98903. */
  98904. Depth = 12,
  98905. /**
  98906. * Texture data comes from a raw cube data encoded with RGBD
  98907. */
  98908. CubeRawRGBD = 13
  98909. }
  98910. /**
  98911. * Class used to store data associated with WebGL texture data for the engine
  98912. * This class should not be used directly
  98913. */
  98914. export class InternalTexture {
  98915. /** @hidden */
  98916. static _UpdateRGBDAsync: (internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number) => Promise<void>;
  98917. /**
  98918. * Defines if the texture is ready
  98919. */
  98920. isReady: boolean;
  98921. /**
  98922. * Defines if the texture is a cube texture
  98923. */
  98924. isCube: boolean;
  98925. /**
  98926. * Defines if the texture contains 3D data
  98927. */
  98928. is3D: boolean;
  98929. /**
  98930. * Defines if the texture contains 2D array data
  98931. */
  98932. is2DArray: boolean;
  98933. /**
  98934. * Defines if the texture contains multiview data
  98935. */
  98936. isMultiview: boolean;
  98937. /**
  98938. * Gets the URL used to load this texture
  98939. */
  98940. url: string;
  98941. /**
  98942. * Gets the sampling mode of the texture
  98943. */
  98944. samplingMode: number;
  98945. /**
  98946. * Gets a boolean indicating if the texture needs mipmaps generation
  98947. */
  98948. generateMipMaps: boolean;
  98949. /**
  98950. * Gets the number of samples used by the texture (WebGL2+ only)
  98951. */
  98952. samples: number;
  98953. /**
  98954. * Gets the type of the texture (int, float...)
  98955. */
  98956. type: number;
  98957. /**
  98958. * Gets the format of the texture (RGB, RGBA...)
  98959. */
  98960. format: number;
  98961. /**
  98962. * Observable called when the texture is loaded
  98963. */
  98964. onLoadedObservable: Observable<InternalTexture>;
  98965. /**
  98966. * Gets the width of the texture
  98967. */
  98968. width: number;
  98969. /**
  98970. * Gets the height of the texture
  98971. */
  98972. height: number;
  98973. /**
  98974. * Gets the depth of the texture
  98975. */
  98976. depth: number;
  98977. /**
  98978. * Gets the initial width of the texture (It could be rescaled if the current system does not support non power of two textures)
  98979. */
  98980. baseWidth: number;
  98981. /**
  98982. * Gets the initial height of the texture (It could be rescaled if the current system does not support non power of two textures)
  98983. */
  98984. baseHeight: number;
  98985. /**
  98986. * Gets the initial depth of the texture (It could be rescaled if the current system does not support non power of two textures)
  98987. */
  98988. baseDepth: number;
  98989. /**
  98990. * Gets a boolean indicating if the texture is inverted on Y axis
  98991. */
  98992. invertY: boolean;
  98993. /** @hidden */
  98994. _invertVScale: boolean;
  98995. /** @hidden */
  98996. _associatedChannel: number;
  98997. /** @hidden */
  98998. _source: InternalTextureSource;
  98999. /** @hidden */
  99000. _buffer: Nullable<string | ArrayBuffer | ArrayBufferView | HTMLImageElement | Blob | ImageBitmap>;
  99001. /** @hidden */
  99002. _bufferView: Nullable<ArrayBufferView>;
  99003. /** @hidden */
  99004. _bufferViewArray: Nullable<ArrayBufferView[]>;
  99005. /** @hidden */
  99006. _bufferViewArrayArray: Nullable<ArrayBufferView[][]>;
  99007. /** @hidden */
  99008. _size: number;
  99009. /** @hidden */
  99010. _extension: string;
  99011. /** @hidden */
  99012. _files: Nullable<string[]>;
  99013. /** @hidden */
  99014. _workingCanvas: Nullable<HTMLCanvasElement | OffscreenCanvas>;
  99015. /** @hidden */
  99016. _workingContext: Nullable<CanvasRenderingContext2D | OffscreenCanvasRenderingContext2D>;
  99017. /** @hidden */
  99018. _framebuffer: Nullable<WebGLFramebuffer>;
  99019. /** @hidden */
  99020. _depthStencilBuffer: Nullable<WebGLRenderbuffer>;
  99021. /** @hidden */
  99022. _MSAAFramebuffer: Nullable<WebGLFramebuffer>;
  99023. /** @hidden */
  99024. _MSAARenderBuffer: Nullable<WebGLRenderbuffer>;
  99025. /** @hidden */
  99026. _attachments: Nullable<number[]>;
  99027. /** @hidden */
  99028. _cachedCoordinatesMode: Nullable<number>;
  99029. /** @hidden */
  99030. _cachedWrapU: Nullable<number>;
  99031. /** @hidden */
  99032. _cachedWrapV: Nullable<number>;
  99033. /** @hidden */
  99034. _cachedWrapR: Nullable<number>;
  99035. /** @hidden */
  99036. _cachedAnisotropicFilteringLevel: Nullable<number>;
  99037. /** @hidden */
  99038. _isDisabled: boolean;
  99039. /** @hidden */
  99040. _compression: Nullable<string>;
  99041. /** @hidden */
  99042. _generateStencilBuffer: boolean;
  99043. /** @hidden */
  99044. _generateDepthBuffer: boolean;
  99045. /** @hidden */
  99046. _comparisonFunction: number;
  99047. /** @hidden */
  99048. _sphericalPolynomial: Nullable<SphericalPolynomial>;
  99049. /** @hidden */
  99050. _lodGenerationScale: number;
  99051. /** @hidden */
  99052. _lodGenerationOffset: number;
  99053. /** @hidden */
  99054. _colorTextureArray: Nullable<WebGLTexture>;
  99055. /** @hidden */
  99056. _depthStencilTextureArray: Nullable<WebGLTexture>;
  99057. /** @hidden */
  99058. _lodTextureHigh: Nullable<BaseTexture>;
  99059. /** @hidden */
  99060. _lodTextureMid: Nullable<BaseTexture>;
  99061. /** @hidden */
  99062. _lodTextureLow: Nullable<BaseTexture>;
  99063. /** @hidden */
  99064. _isRGBD: boolean;
  99065. /** @hidden */
  99066. _linearSpecularLOD: boolean;
  99067. /** @hidden */
  99068. _irradianceTexture: Nullable<BaseTexture>;
  99069. /** @hidden */
  99070. _webGLTexture: Nullable<WebGLTexture>;
  99071. /** @hidden */
  99072. _references: number;
  99073. private _engine;
  99074. /**
  99075. * Gets the Engine the texture belongs to.
  99076. * @returns The babylon engine
  99077. */
  99078. getEngine(): ThinEngine;
  99079. /**
  99080. * Gets the data source type of the texture
  99081. */
  99082. readonly source: InternalTextureSource;
  99083. /**
  99084. * Creates a new InternalTexture
  99085. * @param engine defines the engine to use
  99086. * @param source defines the type of data that will be used
  99087. * @param delayAllocation if the texture allocation should be delayed (default: false)
  99088. */
  99089. constructor(engine: ThinEngine, source: InternalTextureSource, delayAllocation?: boolean);
  99090. /**
  99091. * Increments the number of references (ie. the number of Texture that point to it)
  99092. */
  99093. incrementReferences(): void;
  99094. /**
  99095. * Change the size of the texture (not the size of the content)
  99096. * @param width defines the new width
  99097. * @param height defines the new height
  99098. * @param depth defines the new depth (1 by default)
  99099. */
  99100. updateSize(width: int, height: int, depth?: int): void;
  99101. /** @hidden */
  99102. _rebuild(): void;
  99103. /** @hidden */
  99104. _swapAndDie(target: InternalTexture): void;
  99105. /**
  99106. * Dispose the current allocated resources
  99107. */
  99108. dispose(): void;
  99109. }
  99110. }
  99111. declare module BABYLON {
  99112. /**
  99113. * Class used to work with sound analyzer using fast fourier transform (FFT)
  99114. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  99115. */
  99116. export class Analyser {
  99117. /**
  99118. * Gets or sets the smoothing
  99119. * @ignorenaming
  99120. */
  99121. SMOOTHING: number;
  99122. /**
  99123. * Gets or sets the FFT table size
  99124. * @ignorenaming
  99125. */
  99126. FFT_SIZE: number;
  99127. /**
  99128. * Gets or sets the bar graph amplitude
  99129. * @ignorenaming
  99130. */
  99131. BARGRAPHAMPLITUDE: number;
  99132. /**
  99133. * Gets or sets the position of the debug canvas
  99134. * @ignorenaming
  99135. */
  99136. DEBUGCANVASPOS: {
  99137. x: number;
  99138. y: number;
  99139. };
  99140. /**
  99141. * Gets or sets the debug canvas size
  99142. * @ignorenaming
  99143. */
  99144. DEBUGCANVASSIZE: {
  99145. width: number;
  99146. height: number;
  99147. };
  99148. private _byteFreqs;
  99149. private _byteTime;
  99150. private _floatFreqs;
  99151. private _webAudioAnalyser;
  99152. private _debugCanvas;
  99153. private _debugCanvasContext;
  99154. private _scene;
  99155. private _registerFunc;
  99156. private _audioEngine;
  99157. /**
  99158. * Creates a new analyser
  99159. * @param scene defines hosting scene
  99160. */
  99161. constructor(scene: Scene);
  99162. /**
  99163. * Get the number of data values you will have to play with for the visualization
  99164. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/frequencyBinCount
  99165. * @returns a number
  99166. */
  99167. getFrequencyBinCount(): number;
  99168. /**
  99169. * Gets the current frequency data as a byte array
  99170. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  99171. * @returns a Uint8Array
  99172. */
  99173. getByteFrequencyData(): Uint8Array;
  99174. /**
  99175. * Gets the current waveform as a byte array
  99176. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteTimeDomainData
  99177. * @returns a Uint8Array
  99178. */
  99179. getByteTimeDomainData(): Uint8Array;
  99180. /**
  99181. * Gets the current frequency data as a float array
  99182. * @see https://developer.mozilla.org/en-US/docs/Web/API/AnalyserNode/getByteFrequencyData
  99183. * @returns a Float32Array
  99184. */
  99185. getFloatFrequencyData(): Float32Array;
  99186. /**
  99187. * Renders the debug canvas
  99188. */
  99189. drawDebugCanvas(): void;
  99190. /**
  99191. * Stops rendering the debug canvas and removes it
  99192. */
  99193. stopDebugCanvas(): void;
  99194. /**
  99195. * Connects two audio nodes
  99196. * @param inputAudioNode defines first node to connect
  99197. * @param outputAudioNode defines second node to connect
  99198. */
  99199. connectAudioNodes(inputAudioNode: AudioNode, outputAudioNode: AudioNode): void;
  99200. /**
  99201. * Releases all associated resources
  99202. */
  99203. dispose(): void;
  99204. }
  99205. }
  99206. declare module BABYLON {
  99207. /**
  99208. * This represents an audio engine and it is responsible
  99209. * to play, synchronize and analyse sounds throughout the application.
  99210. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  99211. */
  99212. export interface IAudioEngine extends IDisposable {
  99213. /**
  99214. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  99215. */
  99216. readonly canUseWebAudio: boolean;
  99217. /**
  99218. * Gets the current AudioContext if available.
  99219. */
  99220. readonly audioContext: Nullable<AudioContext>;
  99221. /**
  99222. * The master gain node defines the global audio volume of your audio engine.
  99223. */
  99224. readonly masterGain: GainNode;
  99225. /**
  99226. * Gets whether or not mp3 are supported by your browser.
  99227. */
  99228. readonly isMP3supported: boolean;
  99229. /**
  99230. * Gets whether or not ogg are supported by your browser.
  99231. */
  99232. readonly isOGGsupported: boolean;
  99233. /**
  99234. * Defines if Babylon should emit a warning if WebAudio is not supported.
  99235. * @ignoreNaming
  99236. */
  99237. WarnedWebAudioUnsupported: boolean;
  99238. /**
  99239. * Defines if the audio engine relies on a custom unlocked button.
  99240. * In this case, the embedded button will not be displayed.
  99241. */
  99242. useCustomUnlockedButton: boolean;
  99243. /**
  99244. * Gets whether or not the audio engine is unlocked (require first a user gesture on some browser).
  99245. */
  99246. readonly unlocked: boolean;
  99247. /**
  99248. * Event raised when audio has been unlocked on the browser.
  99249. */
  99250. onAudioUnlockedObservable: Observable<AudioEngine>;
  99251. /**
  99252. * Event raised when audio has been locked on the browser.
  99253. */
  99254. onAudioLockedObservable: Observable<AudioEngine>;
  99255. /**
  99256. * Flags the audio engine in Locked state.
  99257. * This happens due to new browser policies preventing audio to autoplay.
  99258. */
  99259. lock(): void;
  99260. /**
  99261. * Unlocks the audio engine once a user action has been done on the dom.
  99262. * This is helpful to resume play once browser policies have been satisfied.
  99263. */
  99264. unlock(): void;
  99265. }
  99266. /**
  99267. * This represents the default audio engine used in babylon.
  99268. * It is responsible to play, synchronize and analyse sounds throughout the application.
  99269. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  99270. */
  99271. export class AudioEngine implements IAudioEngine {
  99272. private _audioContext;
  99273. private _audioContextInitialized;
  99274. private _muteButton;
  99275. private _hostElement;
  99276. /**
  99277. * Gets whether the current host supports Web Audio and thus could create AudioContexts.
  99278. */
  99279. canUseWebAudio: boolean;
  99280. /**
  99281. * The master gain node defines the global audio volume of your audio engine.
  99282. */
  99283. masterGain: GainNode;
  99284. /**
  99285. * Defines if Babylon should emit a warning if WebAudio is not supported.
  99286. * @ignoreNaming
  99287. */
  99288. WarnedWebAudioUnsupported: boolean;
  99289. /**
  99290. * Gets whether or not mp3 are supported by your browser.
  99291. */
  99292. isMP3supported: boolean;
  99293. /**
  99294. * Gets whether or not ogg are supported by your browser.
  99295. */
  99296. isOGGsupported: boolean;
  99297. /**
  99298. * Gets whether audio has been unlocked on the device.
  99299. * Some Browsers have strong restrictions about Audio and won t autoplay unless
  99300. * a user interaction has happened.
  99301. */
  99302. unlocked: boolean;
  99303. /**
  99304. * Defines if the audio engine relies on a custom unlocked button.
  99305. * In this case, the embedded button will not be displayed.
  99306. */
  99307. useCustomUnlockedButton: boolean;
  99308. /**
  99309. * Event raised when audio has been unlocked on the browser.
  99310. */
  99311. onAudioUnlockedObservable: Observable<AudioEngine>;
  99312. /**
  99313. * Event raised when audio has been locked on the browser.
  99314. */
  99315. onAudioLockedObservable: Observable<AudioEngine>;
  99316. /**
  99317. * Gets the current AudioContext if available.
  99318. */
  99319. readonly audioContext: Nullable<AudioContext>;
  99320. private _connectedAnalyser;
  99321. /**
  99322. * Instantiates a new audio engine.
  99323. *
  99324. * There should be only one per page as some browsers restrict the number
  99325. * of audio contexts you can create.
  99326. * @param hostElement defines the host element where to display the mute icon if necessary
  99327. */
  99328. constructor(hostElement?: Nullable<HTMLElement>);
  99329. /**
  99330. * Flags the audio engine in Locked state.
  99331. * This happens due to new browser policies preventing audio to autoplay.
  99332. */
  99333. lock(): void;
  99334. /**
  99335. * Unlocks the audio engine once a user action has been done on the dom.
  99336. * This is helpful to resume play once browser policies have been satisfied.
  99337. */
  99338. unlock(): void;
  99339. private _resumeAudioContext;
  99340. private _initializeAudioContext;
  99341. private _tryToRun;
  99342. private _triggerRunningState;
  99343. private _triggerSuspendedState;
  99344. private _displayMuteButton;
  99345. private _moveButtonToTopLeft;
  99346. private _onResize;
  99347. private _hideMuteButton;
  99348. /**
  99349. * Destroy and release the resources associated with the audio ccontext.
  99350. */
  99351. dispose(): void;
  99352. /**
  99353. * Gets the global volume sets on the master gain.
  99354. * @returns the global volume if set or -1 otherwise
  99355. */
  99356. getGlobalVolume(): number;
  99357. /**
  99358. * Sets the global volume of your experience (sets on the master gain).
  99359. * @param newVolume Defines the new global volume of the application
  99360. */
  99361. setGlobalVolume(newVolume: number): void;
  99362. /**
  99363. * Connect the audio engine to an audio analyser allowing some amazing
  99364. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  99365. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  99366. * @param analyser The analyser to connect to the engine
  99367. */
  99368. connectToAnalyser(analyser: Analyser): void;
  99369. }
  99370. }
  99371. declare module BABYLON {
  99372. /**
  99373. * Interface used to present a loading screen while loading a scene
  99374. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  99375. */
  99376. export interface ILoadingScreen {
  99377. /**
  99378. * Function called to display the loading screen
  99379. */
  99380. displayLoadingUI: () => void;
  99381. /**
  99382. * Function called to hide the loading screen
  99383. */
  99384. hideLoadingUI: () => void;
  99385. /**
  99386. * Gets or sets the color to use for the background
  99387. */
  99388. loadingUIBackgroundColor: string;
  99389. /**
  99390. * Gets or sets the text to display while loading
  99391. */
  99392. loadingUIText: string;
  99393. }
  99394. /**
  99395. * Class used for the default loading screen
  99396. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  99397. */
  99398. export class DefaultLoadingScreen implements ILoadingScreen {
  99399. private _renderingCanvas;
  99400. private _loadingText;
  99401. private _loadingDivBackgroundColor;
  99402. private _loadingDiv;
  99403. private _loadingTextDiv;
  99404. /** Gets or sets the logo url to use for the default loading screen */
  99405. static DefaultLogoUrl: string;
  99406. /** Gets or sets the spinner url to use for the default loading screen */
  99407. static DefaultSpinnerUrl: string;
  99408. /**
  99409. * Creates a new default loading screen
  99410. * @param _renderingCanvas defines the canvas used to render the scene
  99411. * @param _loadingText defines the default text to display
  99412. * @param _loadingDivBackgroundColor defines the default background color
  99413. */
  99414. constructor(_renderingCanvas: HTMLCanvasElement, _loadingText?: string, _loadingDivBackgroundColor?: string);
  99415. /**
  99416. * Function called to display the loading screen
  99417. */
  99418. displayLoadingUI(): void;
  99419. /**
  99420. * Function called to hide the loading screen
  99421. */
  99422. hideLoadingUI(): void;
  99423. /**
  99424. * Gets or sets the text to display while loading
  99425. */
  99426. loadingUIText: string;
  99427. /**
  99428. * Gets or sets the color to use for the background
  99429. */
  99430. loadingUIBackgroundColor: string;
  99431. private _resizeLoadingUI;
  99432. }
  99433. }
  99434. declare module BABYLON {
  99435. /**
  99436. * Interface for any object that can request an animation frame
  99437. */
  99438. export interface ICustomAnimationFrameRequester {
  99439. /**
  99440. * This function will be called when the render loop is ready. If this is not populated, the engine's renderloop function will be called
  99441. */
  99442. renderFunction?: Function;
  99443. /**
  99444. * Called to request the next frame to render to
  99445. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame
  99446. */
  99447. requestAnimationFrame: Function;
  99448. /**
  99449. * You can pass this value to cancelAnimationFrame() to cancel the refresh callback request
  99450. * @see https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame#Return_value
  99451. */
  99452. requestID?: number;
  99453. }
  99454. }
  99455. declare module BABYLON {
  99456. /**
  99457. * Performance monitor tracks rolling average frame-time and frame-time variance over a user defined sliding-window
  99458. */
  99459. export class PerformanceMonitor {
  99460. private _enabled;
  99461. private _rollingFrameTime;
  99462. private _lastFrameTimeMs;
  99463. /**
  99464. * constructor
  99465. * @param frameSampleSize The number of samples required to saturate the sliding window
  99466. */
  99467. constructor(frameSampleSize?: number);
  99468. /**
  99469. * Samples current frame
  99470. * @param timeMs A timestamp in milliseconds of the current frame to compare with other frames
  99471. */
  99472. sampleFrame(timeMs?: number): void;
  99473. /**
  99474. * Returns the average frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  99475. */
  99476. readonly averageFrameTime: number;
  99477. /**
  99478. * Returns the variance frame time in milliseconds over the sliding window (or the subset of frames sampled so far)
  99479. */
  99480. readonly averageFrameTimeVariance: number;
  99481. /**
  99482. * Returns the frame time of the most recent frame
  99483. */
  99484. readonly instantaneousFrameTime: number;
  99485. /**
  99486. * Returns the average framerate in frames per second over the sliding window (or the subset of frames sampled so far)
  99487. */
  99488. readonly averageFPS: number;
  99489. /**
  99490. * Returns the average framerate in frames per second using the most recent frame time
  99491. */
  99492. readonly instantaneousFPS: number;
  99493. /**
  99494. * Returns true if enough samples have been taken to completely fill the sliding window
  99495. */
  99496. readonly isSaturated: boolean;
  99497. /**
  99498. * Enables contributions to the sliding window sample set
  99499. */
  99500. enable(): void;
  99501. /**
  99502. * Disables contributions to the sliding window sample set
  99503. * Samples will not be interpolated over the disabled period
  99504. */
  99505. disable(): void;
  99506. /**
  99507. * Returns true if sampling is enabled
  99508. */
  99509. readonly isEnabled: boolean;
  99510. /**
  99511. * Resets performance monitor
  99512. */
  99513. reset(): void;
  99514. }
  99515. /**
  99516. * RollingAverage
  99517. *
  99518. * Utility to efficiently compute the rolling average and variance over a sliding window of samples
  99519. */
  99520. export class RollingAverage {
  99521. /**
  99522. * Current average
  99523. */
  99524. average: number;
  99525. /**
  99526. * Current variance
  99527. */
  99528. variance: number;
  99529. protected _samples: Array<number>;
  99530. protected _sampleCount: number;
  99531. protected _pos: number;
  99532. protected _m2: number;
  99533. /**
  99534. * constructor
  99535. * @param length The number of samples required to saturate the sliding window
  99536. */
  99537. constructor(length: number);
  99538. /**
  99539. * Adds a sample to the sample set
  99540. * @param v The sample value
  99541. */
  99542. add(v: number): void;
  99543. /**
  99544. * Returns previously added values or null if outside of history or outside the sliding window domain
  99545. * @param i Index in history. For example, pass 0 for the most recent value and 1 for the value before that
  99546. * @return Value previously recorded with add() or null if outside of range
  99547. */
  99548. history(i: number): number;
  99549. /**
  99550. * Returns true if enough samples have been taken to completely fill the sliding window
  99551. * @return true if sample-set saturated
  99552. */
  99553. isSaturated(): boolean;
  99554. /**
  99555. * Resets the rolling average (equivalent to 0 samples taken so far)
  99556. */
  99557. reset(): void;
  99558. /**
  99559. * Wraps a value around the sample range boundaries
  99560. * @param i Position in sample range, for example if the sample length is 5, and i is -3, then 2 will be returned.
  99561. * @return Wrapped position in sample range
  99562. */
  99563. protected _wrapPosition(i: number): number;
  99564. }
  99565. }
  99566. declare module BABYLON {
  99567. /**
  99568. * This class is used to track a performance counter which is number based.
  99569. * The user has access to many properties which give statistics of different nature.
  99570. *
  99571. * The implementer can track two kinds of Performance Counter: time and count.
  99572. * 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.
  99573. * 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.
  99574. */
  99575. export class PerfCounter {
  99576. /**
  99577. * Gets or sets a global boolean to turn on and off all the counters
  99578. */
  99579. static Enabled: boolean;
  99580. /**
  99581. * Returns the smallest value ever
  99582. */
  99583. readonly min: number;
  99584. /**
  99585. * Returns the biggest value ever
  99586. */
  99587. readonly max: number;
  99588. /**
  99589. * Returns the average value since the performance counter is running
  99590. */
  99591. readonly average: number;
  99592. /**
  99593. * Returns the average value of the last second the counter was monitored
  99594. */
  99595. readonly lastSecAverage: number;
  99596. /**
  99597. * Returns the current value
  99598. */
  99599. readonly current: number;
  99600. /**
  99601. * Gets the accumulated total
  99602. */
  99603. readonly total: number;
  99604. /**
  99605. * Gets the total value count
  99606. */
  99607. readonly count: number;
  99608. /**
  99609. * Creates a new counter
  99610. */
  99611. constructor();
  99612. /**
  99613. * Call this method to start monitoring a new frame.
  99614. * 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.
  99615. */
  99616. fetchNewFrame(): void;
  99617. /**
  99618. * Call this method to monitor a count of something (e.g. mesh drawn in viewport count)
  99619. * @param newCount the count value to add to the monitored count
  99620. * @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.
  99621. */
  99622. addCount(newCount: number, fetchResult: boolean): void;
  99623. /**
  99624. * Start monitoring this performance counter
  99625. */
  99626. beginMonitoring(): void;
  99627. /**
  99628. * Compute the time lapsed since the previous beginMonitoring() call.
  99629. * @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
  99630. */
  99631. endMonitoring(newFrame?: boolean): void;
  99632. private _fetchResult;
  99633. private _startMonitoringTime;
  99634. private _min;
  99635. private _max;
  99636. private _average;
  99637. private _current;
  99638. private _totalValueCount;
  99639. private _totalAccumulated;
  99640. private _lastSecAverage;
  99641. private _lastSecAccumulated;
  99642. private _lastSecTime;
  99643. private _lastSecValueCount;
  99644. }
  99645. }
  99646. declare module BABYLON {
  99647. /**
  99648. * Defines the interface used by display changed events
  99649. */
  99650. export interface IDisplayChangedEventArgs {
  99651. /** Gets the vrDisplay object (if any) */
  99652. vrDisplay: Nullable<any>;
  99653. /** Gets a boolean indicating if webVR is supported */
  99654. vrSupported: boolean;
  99655. }
  99656. /**
  99657. * Defines the interface used by objects containing a viewport (like a camera)
  99658. */
  99659. interface IViewportOwnerLike {
  99660. /**
  99661. * Gets or sets the viewport
  99662. */
  99663. viewport: IViewportLike;
  99664. }
  99665. /**
  99666. * The engine class is responsible for interfacing with all lower-level APIs such as WebGL and Audio
  99667. */
  99668. export class Engine extends ThinEngine {
  99669. /** Defines that alpha blending is disabled */
  99670. static readonly ALPHA_DISABLE: number;
  99671. /** Defines that alpha blending to SRC ALPHA * SRC + DEST */
  99672. static readonly ALPHA_ADD: number;
  99673. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC ALPHA) * DEST */
  99674. static readonly ALPHA_COMBINE: number;
  99675. /** Defines that alpha blending to DEST - SRC * DEST */
  99676. static readonly ALPHA_SUBTRACT: number;
  99677. /** Defines that alpha blending to SRC * DEST */
  99678. static readonly ALPHA_MULTIPLY: number;
  99679. /** Defines that alpha blending to SRC ALPHA * SRC + (1 - SRC) * DEST */
  99680. static readonly ALPHA_MAXIMIZED: number;
  99681. /** Defines that alpha blending to SRC + DEST */
  99682. static readonly ALPHA_ONEONE: number;
  99683. /** Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST */
  99684. static readonly ALPHA_PREMULTIPLIED: number;
  99685. /**
  99686. * Defines that alpha blending to SRC + (1 - SRC ALPHA) * DEST
  99687. * Alpha will be set to (1 - SRC ALPHA) * DEST ALPHA
  99688. */
  99689. static readonly ALPHA_PREMULTIPLIED_PORTERDUFF: number;
  99690. /** Defines that alpha blending to CST * SRC + (1 - CST) * DEST */
  99691. static readonly ALPHA_INTERPOLATE: number;
  99692. /**
  99693. * Defines that alpha blending to SRC + (1 - SRC) * DEST
  99694. * Alpha will be set to SRC ALPHA + (1 - SRC ALPHA) * DEST ALPHA
  99695. */
  99696. static readonly ALPHA_SCREENMODE: number;
  99697. /** Defines that the ressource is not delayed*/
  99698. static readonly DELAYLOADSTATE_NONE: number;
  99699. /** Defines that the ressource was successfully delay loaded */
  99700. static readonly DELAYLOADSTATE_LOADED: number;
  99701. /** Defines that the ressource is currently delay loading */
  99702. static readonly DELAYLOADSTATE_LOADING: number;
  99703. /** Defines that the ressource is delayed and has not started loading */
  99704. static readonly DELAYLOADSTATE_NOTLOADED: number;
  99705. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will never pass. i.e. Nothing will be drawn */
  99706. static readonly NEVER: number;
  99707. /** 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 */
  99708. static readonly ALWAYS: number;
  99709. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is less than the stored value */
  99710. static readonly LESS: number;
  99711. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is equals to the stored value */
  99712. static readonly EQUAL: number;
  99713. /** 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 */
  99714. static readonly LEQUAL: number;
  99715. /** Passed to depthFunction or stencilFunction to specify depth or stencil tests will pass if the new depth value is greater than the stored value */
  99716. static readonly GREATER: number;
  99717. /** 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 */
  99718. static readonly GEQUAL: number;
  99719. /** 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 */
  99720. static readonly NOTEQUAL: number;
  99721. /** Passed to stencilOperation to specify that stencil value must be kept */
  99722. static readonly KEEP: number;
  99723. /** Passed to stencilOperation to specify that stencil value must be replaced */
  99724. static readonly REPLACE: number;
  99725. /** Passed to stencilOperation to specify that stencil value must be incremented */
  99726. static readonly INCR: number;
  99727. /** Passed to stencilOperation to specify that stencil value must be decremented */
  99728. static readonly DECR: number;
  99729. /** Passed to stencilOperation to specify that stencil value must be inverted */
  99730. static readonly INVERT: number;
  99731. /** Passed to stencilOperation to specify that stencil value must be incremented with wrapping */
  99732. static readonly INCR_WRAP: number;
  99733. /** Passed to stencilOperation to specify that stencil value must be decremented with wrapping */
  99734. static readonly DECR_WRAP: number;
  99735. /** Texture is not repeating outside of 0..1 UVs */
  99736. static readonly TEXTURE_CLAMP_ADDRESSMODE: number;
  99737. /** Texture is repeating outside of 0..1 UVs */
  99738. static readonly TEXTURE_WRAP_ADDRESSMODE: number;
  99739. /** Texture is repeating and mirrored */
  99740. static readonly TEXTURE_MIRROR_ADDRESSMODE: number;
  99741. /** ALPHA */
  99742. static readonly TEXTUREFORMAT_ALPHA: number;
  99743. /** LUMINANCE */
  99744. static readonly TEXTUREFORMAT_LUMINANCE: number;
  99745. /** LUMINANCE_ALPHA */
  99746. static readonly TEXTUREFORMAT_LUMINANCE_ALPHA: number;
  99747. /** RGB */
  99748. static readonly TEXTUREFORMAT_RGB: number;
  99749. /** RGBA */
  99750. static readonly TEXTUREFORMAT_RGBA: number;
  99751. /** RED */
  99752. static readonly TEXTUREFORMAT_RED: number;
  99753. /** RED (2nd reference) */
  99754. static readonly TEXTUREFORMAT_R: number;
  99755. /** RG */
  99756. static readonly TEXTUREFORMAT_RG: number;
  99757. /** RED_INTEGER */
  99758. static readonly TEXTUREFORMAT_RED_INTEGER: number;
  99759. /** RED_INTEGER (2nd reference) */
  99760. static readonly TEXTUREFORMAT_R_INTEGER: number;
  99761. /** RG_INTEGER */
  99762. static readonly TEXTUREFORMAT_RG_INTEGER: number;
  99763. /** RGB_INTEGER */
  99764. static readonly TEXTUREFORMAT_RGB_INTEGER: number;
  99765. /** RGBA_INTEGER */
  99766. static readonly TEXTUREFORMAT_RGBA_INTEGER: number;
  99767. /** UNSIGNED_BYTE */
  99768. static readonly TEXTURETYPE_UNSIGNED_BYTE: number;
  99769. /** UNSIGNED_BYTE (2nd reference) */
  99770. static readonly TEXTURETYPE_UNSIGNED_INT: number;
  99771. /** FLOAT */
  99772. static readonly TEXTURETYPE_FLOAT: number;
  99773. /** HALF_FLOAT */
  99774. static readonly TEXTURETYPE_HALF_FLOAT: number;
  99775. /** BYTE */
  99776. static readonly TEXTURETYPE_BYTE: number;
  99777. /** SHORT */
  99778. static readonly TEXTURETYPE_SHORT: number;
  99779. /** UNSIGNED_SHORT */
  99780. static readonly TEXTURETYPE_UNSIGNED_SHORT: number;
  99781. /** INT */
  99782. static readonly TEXTURETYPE_INT: number;
  99783. /** UNSIGNED_INT */
  99784. static readonly TEXTURETYPE_UNSIGNED_INTEGER: number;
  99785. /** UNSIGNED_SHORT_4_4_4_4 */
  99786. static readonly TEXTURETYPE_UNSIGNED_SHORT_4_4_4_4: number;
  99787. /** UNSIGNED_SHORT_5_5_5_1 */
  99788. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_5_5_1: number;
  99789. /** UNSIGNED_SHORT_5_6_5 */
  99790. static readonly TEXTURETYPE_UNSIGNED_SHORT_5_6_5: number;
  99791. /** UNSIGNED_INT_2_10_10_10_REV */
  99792. static readonly TEXTURETYPE_UNSIGNED_INT_2_10_10_10_REV: number;
  99793. /** UNSIGNED_INT_24_8 */
  99794. static readonly TEXTURETYPE_UNSIGNED_INT_24_8: number;
  99795. /** UNSIGNED_INT_10F_11F_11F_REV */
  99796. static readonly TEXTURETYPE_UNSIGNED_INT_10F_11F_11F_REV: number;
  99797. /** UNSIGNED_INT_5_9_9_9_REV */
  99798. static readonly TEXTURETYPE_UNSIGNED_INT_5_9_9_9_REV: number;
  99799. /** FLOAT_32_UNSIGNED_INT_24_8_REV */
  99800. static readonly TEXTURETYPE_FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  99801. /** nearest is mag = nearest and min = nearest and mip = linear */
  99802. static readonly TEXTURE_NEAREST_SAMPLINGMODE: number;
  99803. /** Bilinear is mag = linear and min = linear and mip = nearest */
  99804. static readonly TEXTURE_BILINEAR_SAMPLINGMODE: number;
  99805. /** Trilinear is mag = linear and min = linear and mip = linear */
  99806. static readonly TEXTURE_TRILINEAR_SAMPLINGMODE: number;
  99807. /** nearest is mag = nearest and min = nearest and mip = linear */
  99808. static readonly TEXTURE_NEAREST_NEAREST_MIPLINEAR: number;
  99809. /** Bilinear is mag = linear and min = linear and mip = nearest */
  99810. static readonly TEXTURE_LINEAR_LINEAR_MIPNEAREST: number;
  99811. /** Trilinear is mag = linear and min = linear and mip = linear */
  99812. static readonly TEXTURE_LINEAR_LINEAR_MIPLINEAR: number;
  99813. /** mag = nearest and min = nearest and mip = nearest */
  99814. static readonly TEXTURE_NEAREST_NEAREST_MIPNEAREST: number;
  99815. /** mag = nearest and min = linear and mip = nearest */
  99816. static readonly TEXTURE_NEAREST_LINEAR_MIPNEAREST: number;
  99817. /** mag = nearest and min = linear and mip = linear */
  99818. static readonly TEXTURE_NEAREST_LINEAR_MIPLINEAR: number;
  99819. /** mag = nearest and min = linear and mip = none */
  99820. static readonly TEXTURE_NEAREST_LINEAR: number;
  99821. /** mag = nearest and min = nearest and mip = none */
  99822. static readonly TEXTURE_NEAREST_NEAREST: number;
  99823. /** mag = linear and min = nearest and mip = nearest */
  99824. static readonly TEXTURE_LINEAR_NEAREST_MIPNEAREST: number;
  99825. /** mag = linear and min = nearest and mip = linear */
  99826. static readonly TEXTURE_LINEAR_NEAREST_MIPLINEAR: number;
  99827. /** mag = linear and min = linear and mip = none */
  99828. static readonly TEXTURE_LINEAR_LINEAR: number;
  99829. /** mag = linear and min = nearest and mip = none */
  99830. static readonly TEXTURE_LINEAR_NEAREST: number;
  99831. /** Explicit coordinates mode */
  99832. static readonly TEXTURE_EXPLICIT_MODE: number;
  99833. /** Spherical coordinates mode */
  99834. static readonly TEXTURE_SPHERICAL_MODE: number;
  99835. /** Planar coordinates mode */
  99836. static readonly TEXTURE_PLANAR_MODE: number;
  99837. /** Cubic coordinates mode */
  99838. static readonly TEXTURE_CUBIC_MODE: number;
  99839. /** Projection coordinates mode */
  99840. static readonly TEXTURE_PROJECTION_MODE: number;
  99841. /** Skybox coordinates mode */
  99842. static readonly TEXTURE_SKYBOX_MODE: number;
  99843. /** Inverse Cubic coordinates mode */
  99844. static readonly TEXTURE_INVCUBIC_MODE: number;
  99845. /** Equirectangular coordinates mode */
  99846. static readonly TEXTURE_EQUIRECTANGULAR_MODE: number;
  99847. /** Equirectangular Fixed coordinates mode */
  99848. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MODE: number;
  99849. /** Equirectangular Fixed Mirrored coordinates mode */
  99850. static readonly TEXTURE_FIXED_EQUIRECTANGULAR_MIRRORED_MODE: number;
  99851. /** Defines that texture rescaling will use a floor to find the closer power of 2 size */
  99852. static readonly SCALEMODE_FLOOR: number;
  99853. /** Defines that texture rescaling will look for the nearest power of 2 size */
  99854. static readonly SCALEMODE_NEAREST: number;
  99855. /** Defines that texture rescaling will use a ceil to find the closer power of 2 size */
  99856. static readonly SCALEMODE_CEILING: number;
  99857. /**
  99858. * Returns the current npm package of the sdk
  99859. */
  99860. static readonly NpmPackage: string;
  99861. /**
  99862. * Returns the current version of the framework
  99863. */
  99864. static readonly Version: string;
  99865. /** Gets the list of created engines */
  99866. static readonly Instances: Engine[];
  99867. /**
  99868. * Gets the latest created engine
  99869. */
  99870. static readonly LastCreatedEngine: Nullable<Engine>;
  99871. /**
  99872. * Gets the latest created scene
  99873. */
  99874. static readonly LastCreatedScene: Nullable<Scene>;
  99875. /**
  99876. * Will flag all materials in all scenes in all engines as dirty to trigger new shader compilation
  99877. * @param flag defines which part of the materials must be marked as dirty
  99878. * @param predicate defines a predicate used to filter which materials should be affected
  99879. */
  99880. static MarkAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  99881. /**
  99882. * Method called to create the default loading screen.
  99883. * This can be overriden in your own app.
  99884. * @param canvas The rendering canvas element
  99885. * @returns The loading screen
  99886. */
  99887. static DefaultLoadingScreenFactory(canvas: HTMLCanvasElement): ILoadingScreen;
  99888. /**
  99889. * Method called to create the default rescale post process on each engine.
  99890. */
  99891. static _RescalePostProcessFactory: Nullable<(engine: Engine) => PostProcess>;
  99892. /**
  99893. * Gets or sets a boolean to enable/disable IndexedDB support and avoid XHR on .manifest
  99894. **/
  99895. enableOfflineSupport: boolean;
  99896. /**
  99897. * 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)
  99898. **/
  99899. disableManifestCheck: boolean;
  99900. /**
  99901. * Gets the list of created scenes
  99902. */
  99903. scenes: Scene[];
  99904. /**
  99905. * Event raised when a new scene is created
  99906. */
  99907. onNewSceneAddedObservable: Observable<Scene>;
  99908. /**
  99909. * Gets the list of created postprocesses
  99910. */
  99911. postProcesses: PostProcess[];
  99912. /**
  99913. * Gets a boolean indicating if the pointer is currently locked
  99914. */
  99915. isPointerLock: boolean;
  99916. /**
  99917. * Observable event triggered each time the rendering canvas is resized
  99918. */
  99919. onResizeObservable: Observable<Engine>;
  99920. /**
  99921. * Observable event triggered each time the canvas loses focus
  99922. */
  99923. onCanvasBlurObservable: Observable<Engine>;
  99924. /**
  99925. * Observable event triggered each time the canvas gains focus
  99926. */
  99927. onCanvasFocusObservable: Observable<Engine>;
  99928. /**
  99929. * Observable event triggered each time the canvas receives pointerout event
  99930. */
  99931. onCanvasPointerOutObservable: Observable<PointerEvent>;
  99932. /**
  99933. * Observable raised when the engine begins a new frame
  99934. */
  99935. onBeginFrameObservable: Observable<Engine>;
  99936. /**
  99937. * If set, will be used to request the next animation frame for the render loop
  99938. */
  99939. customAnimationFrameRequester: Nullable<ICustomAnimationFrameRequester>;
  99940. /**
  99941. * Observable raised when the engine ends the current frame
  99942. */
  99943. onEndFrameObservable: Observable<Engine>;
  99944. /**
  99945. * Observable raised when the engine is about to compile a shader
  99946. */
  99947. onBeforeShaderCompilationObservable: Observable<Engine>;
  99948. /**
  99949. * Observable raised when the engine has jsut compiled a shader
  99950. */
  99951. onAfterShaderCompilationObservable: Observable<Engine>;
  99952. /**
  99953. * Gets the audio engine
  99954. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  99955. * @ignorenaming
  99956. */
  99957. static audioEngine: IAudioEngine;
  99958. /**
  99959. * Default AudioEngine factory responsible of creating the Audio Engine.
  99960. * By default, this will create a BabylonJS Audio Engine if the workload has been embedded.
  99961. */
  99962. static AudioEngineFactory: (hostElement: Nullable<HTMLElement>) => IAudioEngine;
  99963. /**
  99964. * Default offline support factory responsible of creating a tool used to store data locally.
  99965. * By default, this will create a Database object if the workload has been embedded.
  99966. */
  99967. static OfflineProviderFactory: (urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck: boolean) => IOfflineProvider;
  99968. private _loadingScreen;
  99969. private _pointerLockRequested;
  99970. private _dummyFramebuffer;
  99971. private _rescalePostProcess;
  99972. /** @hidden */
  99973. protected _alphaMode: number;
  99974. /** @hidden */
  99975. protected _alphaEquation: number;
  99976. private _deterministicLockstep;
  99977. private _lockstepMaxSteps;
  99978. protected readonly _supportsHardwareTextureRescaling: boolean;
  99979. private _fps;
  99980. private _deltaTime;
  99981. /** @hidden */
  99982. _drawCalls: PerfCounter;
  99983. /**
  99984. * Turn this value on if you want to pause FPS computation when in background
  99985. */
  99986. disablePerformanceMonitorInBackground: boolean;
  99987. private _performanceMonitor;
  99988. /**
  99989. * Gets the performance monitor attached to this engine
  99990. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  99991. */
  99992. readonly performanceMonitor: PerformanceMonitor;
  99993. private _onFocus;
  99994. private _onBlur;
  99995. private _onCanvasPointerOut;
  99996. private _onCanvasBlur;
  99997. private _onCanvasFocus;
  99998. private _onFullscreenChange;
  99999. private _onPointerLockChange;
  100000. /**
  100001. * Gets the HTML element used to attach event listeners
  100002. * @returns a HTML element
  100003. */
  100004. getInputElement(): Nullable<HTMLElement>;
  100005. /**
  100006. * Creates a new engine
  100007. * @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
  100008. * @param antialias defines enable antialiasing (default: false)
  100009. * @param options defines further options to be sent to the getContext() function
  100010. * @param adaptToDeviceRatio defines whether to adapt to the device's viewport characteristics (default: false)
  100011. */
  100012. constructor(canvasOrContext: Nullable<HTMLCanvasElement | WebGLRenderingContext>, antialias?: boolean, options?: EngineOptions, adaptToDeviceRatio?: boolean);
  100013. /**
  100014. * Gets current aspect ratio
  100015. * @param viewportOwner defines the camera to use to get the aspect ratio
  100016. * @param useScreen defines if screen size must be used (or the current render target if any)
  100017. * @returns a number defining the aspect ratio
  100018. */
  100019. getAspectRatio(viewportOwner: IViewportOwnerLike, useScreen?: boolean): number;
  100020. /**
  100021. * Gets current screen aspect ratio
  100022. * @returns a number defining the aspect ratio
  100023. */
  100024. getScreenAspectRatio(): number;
  100025. /**
  100026. * Gets host document
  100027. * @returns the host document object
  100028. */
  100029. getHostDocument(): Document;
  100030. /**
  100031. * Gets the client rect of the HTML canvas attached with the current webGL context
  100032. * @returns a client rectanglee
  100033. */
  100034. getRenderingCanvasClientRect(): Nullable<ClientRect>;
  100035. /**
  100036. * Gets the client rect of the HTML element used for events
  100037. * @returns a client rectanglee
  100038. */
  100039. getInputElementClientRect(): Nullable<ClientRect>;
  100040. /**
  100041. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  100042. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  100043. * @returns true if engine is in deterministic lock step mode
  100044. */
  100045. isDeterministicLockStep(): boolean;
  100046. /**
  100047. * Gets the max steps when engine is running in deterministic lock step
  100048. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  100049. * @returns the max steps
  100050. */
  100051. getLockstepMaxSteps(): number;
  100052. /**
  100053. * Force the mipmap generation for the given render target texture
  100054. * @param texture defines the render target texture to use
  100055. */
  100056. generateMipMapsForCubemap(texture: InternalTexture): void;
  100057. /** States */
  100058. /**
  100059. * Set various states to the webGL context
  100060. * @param culling defines backface culling state
  100061. * @param zOffset defines the value to apply to zOffset (0 by default)
  100062. * @param force defines if states must be applied even if cache is up to date
  100063. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  100064. */
  100065. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  100066. /**
  100067. * Set the z offset to apply to current rendering
  100068. * @param value defines the offset to apply
  100069. */
  100070. setZOffset(value: number): void;
  100071. /**
  100072. * Gets the current value of the zOffset
  100073. * @returns the current zOffset state
  100074. */
  100075. getZOffset(): number;
  100076. /**
  100077. * Enable or disable depth buffering
  100078. * @param enable defines the state to set
  100079. */
  100080. setDepthBuffer(enable: boolean): void;
  100081. /**
  100082. * Gets a boolean indicating if depth writing is enabled
  100083. * @returns the current depth writing state
  100084. */
  100085. getDepthWrite(): boolean;
  100086. /**
  100087. * Enable or disable depth writing
  100088. * @param enable defines the state to set
  100089. */
  100090. setDepthWrite(enable: boolean): void;
  100091. /**
  100092. * Enable or disable color writing
  100093. * @param enable defines the state to set
  100094. */
  100095. setColorWrite(enable: boolean): void;
  100096. /**
  100097. * Gets a boolean indicating if color writing is enabled
  100098. * @returns the current color writing state
  100099. */
  100100. getColorWrite(): boolean;
  100101. /**
  100102. * Sets alpha constants used by some alpha blending modes
  100103. * @param r defines the red component
  100104. * @param g defines the green component
  100105. * @param b defines the blue component
  100106. * @param a defines the alpha component
  100107. */
  100108. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  100109. /**
  100110. * Sets the current alpha mode
  100111. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  100112. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  100113. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  100114. */
  100115. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  100116. /**
  100117. * Gets the current alpha mode
  100118. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  100119. * @returns the current alpha mode
  100120. */
  100121. getAlphaMode(): number;
  100122. /**
  100123. * Sets the current alpha equation
  100124. * @param equation defines the equation to use (one of the Engine.ALPHA_EQUATION_XXX)
  100125. */
  100126. setAlphaEquation(equation: number): void;
  100127. /**
  100128. * Gets the current alpha equation.
  100129. * @returns the current alpha equation
  100130. */
  100131. getAlphaEquation(): number;
  100132. /**
  100133. * Gets a boolean indicating if stencil buffer is enabled
  100134. * @returns the current stencil buffer state
  100135. */
  100136. getStencilBuffer(): boolean;
  100137. /**
  100138. * Enable or disable the stencil buffer
  100139. * @param enable defines if the stencil buffer must be enabled or disabled
  100140. */
  100141. setStencilBuffer(enable: boolean): void;
  100142. /**
  100143. * Gets the current stencil mask
  100144. * @returns a number defining the new stencil mask to use
  100145. */
  100146. getStencilMask(): number;
  100147. /**
  100148. * Sets the current stencil mask
  100149. * @param mask defines the new stencil mask to use
  100150. */
  100151. setStencilMask(mask: number): void;
  100152. /**
  100153. * Gets the current stencil function
  100154. * @returns a number defining the stencil function to use
  100155. */
  100156. getStencilFunction(): number;
  100157. /**
  100158. * Gets the current stencil reference value
  100159. * @returns a number defining the stencil reference value to use
  100160. */
  100161. getStencilFunctionReference(): number;
  100162. /**
  100163. * Gets the current stencil mask
  100164. * @returns a number defining the stencil mask to use
  100165. */
  100166. getStencilFunctionMask(): number;
  100167. /**
  100168. * Sets the current stencil function
  100169. * @param stencilFunc defines the new stencil function to use
  100170. */
  100171. setStencilFunction(stencilFunc: number): void;
  100172. /**
  100173. * Sets the current stencil reference
  100174. * @param reference defines the new stencil reference to use
  100175. */
  100176. setStencilFunctionReference(reference: number): void;
  100177. /**
  100178. * Sets the current stencil mask
  100179. * @param mask defines the new stencil mask to use
  100180. */
  100181. setStencilFunctionMask(mask: number): void;
  100182. /**
  100183. * Gets the current stencil operation when stencil fails
  100184. * @returns a number defining stencil operation to use when stencil fails
  100185. */
  100186. getStencilOperationFail(): number;
  100187. /**
  100188. * Gets the current stencil operation when depth fails
  100189. * @returns a number defining stencil operation to use when depth fails
  100190. */
  100191. getStencilOperationDepthFail(): number;
  100192. /**
  100193. * Gets the current stencil operation when stencil passes
  100194. * @returns a number defining stencil operation to use when stencil passes
  100195. */
  100196. getStencilOperationPass(): number;
  100197. /**
  100198. * Sets the stencil operation to use when stencil fails
  100199. * @param operation defines the stencil operation to use when stencil fails
  100200. */
  100201. setStencilOperationFail(operation: number): void;
  100202. /**
  100203. * Sets the stencil operation to use when depth fails
  100204. * @param operation defines the stencil operation to use when depth fails
  100205. */
  100206. setStencilOperationDepthFail(operation: number): void;
  100207. /**
  100208. * Sets the stencil operation to use when stencil passes
  100209. * @param operation defines the stencil operation to use when stencil passes
  100210. */
  100211. setStencilOperationPass(operation: number): void;
  100212. /**
  100213. * Sets a boolean indicating if the dithering state is enabled or disabled
  100214. * @param value defines the dithering state
  100215. */
  100216. setDitheringState(value: boolean): void;
  100217. /**
  100218. * Sets a boolean indicating if the rasterizer state is enabled or disabled
  100219. * @param value defines the rasterizer state
  100220. */
  100221. setRasterizerState(value: boolean): void;
  100222. /**
  100223. * Gets the current depth function
  100224. * @returns a number defining the depth function
  100225. */
  100226. getDepthFunction(): Nullable<number>;
  100227. /**
  100228. * Sets the current depth function
  100229. * @param depthFunc defines the function to use
  100230. */
  100231. setDepthFunction(depthFunc: number): void;
  100232. /**
  100233. * Sets the current depth function to GREATER
  100234. */
  100235. setDepthFunctionToGreater(): void;
  100236. /**
  100237. * Sets the current depth function to GEQUAL
  100238. */
  100239. setDepthFunctionToGreaterOrEqual(): void;
  100240. /**
  100241. * Sets the current depth function to LESS
  100242. */
  100243. setDepthFunctionToLess(): void;
  100244. /**
  100245. * Sets the current depth function to LEQUAL
  100246. */
  100247. setDepthFunctionToLessOrEqual(): void;
  100248. private _cachedStencilBuffer;
  100249. private _cachedStencilFunction;
  100250. private _cachedStencilMask;
  100251. private _cachedStencilOperationPass;
  100252. private _cachedStencilOperationFail;
  100253. private _cachedStencilOperationDepthFail;
  100254. private _cachedStencilReference;
  100255. /**
  100256. * Caches the the state of the stencil buffer
  100257. */
  100258. cacheStencilState(): void;
  100259. /**
  100260. * Restores the state of the stencil buffer
  100261. */
  100262. restoreStencilState(): void;
  100263. /**
  100264. * Directly set the WebGL Viewport
  100265. * @param x defines the x coordinate of the viewport (in screen space)
  100266. * @param y defines the y coordinate of the viewport (in screen space)
  100267. * @param width defines the width of the viewport (in screen space)
  100268. * @param height defines the height of the viewport (in screen space)
  100269. * @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
  100270. */
  100271. setDirectViewport(x: number, y: number, width: number, height: number): Nullable<IViewportLike>;
  100272. /**
  100273. * Executes a scissor clear (ie. a clear on a specific portion of the screen)
  100274. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  100275. * @param y defines the y-coordinate of the corner of the clear rectangle
  100276. * @param width defines the width of the clear rectangle
  100277. * @param height defines the height of the clear rectangle
  100278. * @param clearColor defines the clear color
  100279. */
  100280. scissorClear(x: number, y: number, width: number, height: number, clearColor: IColor4Like): void;
  100281. /**
  100282. * Enable scissor test on a specific rectangle (ie. render will only be executed on a specific portion of the screen)
  100283. * @param x defines the x-coordinate of the top left corner of the clear rectangle
  100284. * @param y defines the y-coordinate of the corner of the clear rectangle
  100285. * @param width defines the width of the clear rectangle
  100286. * @param height defines the height of the clear rectangle
  100287. */
  100288. enableScissor(x: number, y: number, width: number, height: number): void;
  100289. /**
  100290. * Disable previously set scissor test rectangle
  100291. */
  100292. disableScissor(): void;
  100293. protected _reportDrawCall(): void;
  100294. /**
  100295. * Initializes a webVR display and starts listening to display change events
  100296. * The onVRDisplayChangedObservable will be notified upon these changes
  100297. * @returns The onVRDisplayChangedObservable
  100298. */
  100299. initWebVR(): Observable<IDisplayChangedEventArgs>;
  100300. /** @hidden */
  100301. _prepareVRComponent(): void;
  100302. /** @hidden */
  100303. _connectVREvents(canvas?: HTMLCanvasElement, document?: any): void;
  100304. /** @hidden */
  100305. _submitVRFrame(): void;
  100306. /**
  100307. * Call this function to leave webVR mode
  100308. * Will do nothing if webVR is not supported or if there is no webVR device
  100309. * @see http://doc.babylonjs.com/how_to/webvr_camera
  100310. */
  100311. disableVR(): void;
  100312. /**
  100313. * Gets a boolean indicating that the system is in VR mode and is presenting
  100314. * @returns true if VR mode is engaged
  100315. */
  100316. isVRPresenting(): boolean;
  100317. /** @hidden */
  100318. _requestVRFrame(): void;
  100319. /** @hidden */
  100320. _loadFileAsync(url: string, offlineProvider?: IOfflineProvider, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  100321. /**
  100322. * Gets the source code of the vertex shader associated with a specific webGL program
  100323. * @param program defines the program to use
  100324. * @returns a string containing the source code of the vertex shader associated with the program
  100325. */
  100326. getVertexShaderSource(program: WebGLProgram): Nullable<string>;
  100327. /**
  100328. * Gets the source code of the fragment shader associated with a specific webGL program
  100329. * @param program defines the program to use
  100330. * @returns a string containing the source code of the fragment shader associated with the program
  100331. */
  100332. getFragmentShaderSource(program: WebGLProgram): Nullable<string>;
  100333. /**
  100334. * Reads pixels from the current frame buffer. Please note that this function can be slow
  100335. * @param x defines the x coordinate of the rectangle where pixels must be read
  100336. * @param y defines the y coordinate of the rectangle where pixels must be read
  100337. * @param width defines the width of the rectangle where pixels must be read
  100338. * @param height defines the height of the rectangle where pixels must be read
  100339. * @returns a Uint8Array containing RGBA colors
  100340. */
  100341. readPixels(x: number, y: number, width: number, height: number): Uint8Array;
  100342. /**
  100343. * Sets a depth stencil texture from a render target to the according uniform.
  100344. * @param channel The texture channel
  100345. * @param uniform The uniform to set
  100346. * @param texture The render target texture containing the depth stencil texture to apply
  100347. */
  100348. setDepthStencilTexture(channel: number, uniform: Nullable<WebGLUniformLocation>, texture: Nullable<RenderTargetTexture>): void;
  100349. /**
  100350. * Sets a texture to the webGL context from a postprocess
  100351. * @param channel defines the channel to use
  100352. * @param postProcess defines the source postprocess
  100353. */
  100354. setTextureFromPostProcess(channel: number, postProcess: Nullable<PostProcess>): void;
  100355. /**
  100356. * Binds the output of the passed in post process to the texture channel specified
  100357. * @param channel The channel the texture should be bound to
  100358. * @param postProcess The post process which's output should be bound
  100359. */
  100360. setTextureFromPostProcessOutput(channel: number, postProcess: Nullable<PostProcess>): void;
  100361. /** @hidden */
  100362. _convertRGBtoRGBATextureData(rgbData: any, width: number, height: number, textureType: number): ArrayBufferView;
  100363. protected _rebuildBuffers(): void;
  100364. /** @hidden */
  100365. _renderFrame(): void;
  100366. _renderLoop(): void;
  100367. /** @hidden */
  100368. _renderViews(): boolean;
  100369. /**
  100370. * Toggle full screen mode
  100371. * @param requestPointerLock defines if a pointer lock should be requested from the user
  100372. */
  100373. switchFullscreen(requestPointerLock: boolean): void;
  100374. /**
  100375. * Enters full screen mode
  100376. * @param requestPointerLock defines if a pointer lock should be requested from the user
  100377. */
  100378. enterFullscreen(requestPointerLock: boolean): void;
  100379. /**
  100380. * Exits full screen mode
  100381. */
  100382. exitFullscreen(): void;
  100383. /**
  100384. * Enters Pointerlock mode
  100385. */
  100386. enterPointerlock(): void;
  100387. /**
  100388. * Exits Pointerlock mode
  100389. */
  100390. exitPointerlock(): void;
  100391. /**
  100392. * Begin a new frame
  100393. */
  100394. beginFrame(): void;
  100395. /**
  100396. * Enf the current frame
  100397. */
  100398. endFrame(): void;
  100399. resize(): void;
  100400. /**
  100401. * Set the compressed texture format to use, based on the formats you have, and the formats
  100402. * supported by the hardware / browser.
  100403. *
  100404. * Khronos Texture Container (.ktx) files are used to support this. This format has the
  100405. * advantage of being specifically designed for OpenGL. Header elements directly correspond
  100406. * to API arguments needed to compressed textures. This puts the burden on the container
  100407. * generator to house the arcane code for determining these for current & future formats.
  100408. *
  100409. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  100410. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  100411. *
  100412. * Note: The result of this call is not taken into account when a texture is base64.
  100413. *
  100414. * @param formatsAvailable defines the list of those format families you have created
  100415. * on your server. Syntax: '-' + format family + '.ktx'. (Case and order do not matter.)
  100416. *
  100417. * Current families are astc, dxt, pvrtc, etc2, & etc1.
  100418. * @returns The extension selected.
  100419. */
  100420. setTextureFormatToUse(formatsAvailable: Array<string>): Nullable<string>;
  100421. /**
  100422. * Force a specific size of the canvas
  100423. * @param width defines the new canvas' width
  100424. * @param height defines the new canvas' height
  100425. */
  100426. setSize(width: number, height: number): void;
  100427. /**
  100428. * Updates a dynamic vertex buffer.
  100429. * @param vertexBuffer the vertex buffer to update
  100430. * @param data the data used to update the vertex buffer
  100431. * @param byteOffset the byte offset of the data
  100432. * @param byteLength the byte length of the data
  100433. */
  100434. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  100435. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  100436. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  100437. protected _createShaderProgram(pipelineContext: WebGLPipelineContext, vertexShader: WebGLShader, fragmentShader: WebGLShader, context: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): WebGLProgram;
  100438. _releaseTexture(texture: InternalTexture): void;
  100439. /**
  100440. * @hidden
  100441. * Rescales a texture
  100442. * @param source input texutre
  100443. * @param destination destination texture
  100444. * @param scene scene to use to render the resize
  100445. * @param internalFormat format to use when resizing
  100446. * @param onComplete callback to be called when resize has completed
  100447. */
  100448. _rescaleTexture(source: InternalTexture, destination: InternalTexture, scene: Nullable<any>, internalFormat: number, onComplete: () => void): void;
  100449. /**
  100450. * Gets the current framerate
  100451. * @returns a number representing the framerate
  100452. */
  100453. getFps(): number;
  100454. /**
  100455. * Gets the time spent between current and previous frame
  100456. * @returns a number representing the delta time in ms
  100457. */
  100458. getDeltaTime(): number;
  100459. private _measureFps;
  100460. /** @hidden */
  100461. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement | ImageBitmap, faceIndex?: number, lod?: number): void;
  100462. /**
  100463. * Sets the frame buffer Depth / Stencil attachement of the render target to the defined depth stencil texture.
  100464. * @param renderTarget The render target to set the frame buffer for
  100465. */
  100466. setFrameBufferDepthStencilTexture(renderTarget: RenderTargetTexture): void;
  100467. /**
  100468. * Update a dynamic index buffer
  100469. * @param indexBuffer defines the target index buffer
  100470. * @param indices defines the data to update
  100471. * @param offset defines the offset in the target index buffer where update should start
  100472. */
  100473. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  100474. /**
  100475. * Updates the sample count of a render target texture
  100476. * @see http://doc.babylonjs.com/features/webgl2#multisample-render-targets
  100477. * @param texture defines the texture to update
  100478. * @param samples defines the sample count to set
  100479. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  100480. */
  100481. updateRenderTargetTextureSampleCount(texture: Nullable<InternalTexture>, samples: number): number;
  100482. /**
  100483. * Updates a depth texture Comparison Mode and Function.
  100484. * If the comparison Function is equal to 0, the mode will be set to none.
  100485. * Otherwise, this only works in webgl 2 and requires a shadow sampler in the shader.
  100486. * @param texture The texture to set the comparison function for
  100487. * @param comparisonFunction The comparison function to set, 0 if no comparison required
  100488. */
  100489. updateTextureComparisonFunction(texture: InternalTexture, comparisonFunction: number): void;
  100490. /**
  100491. * Creates a webGL buffer to use with instanciation
  100492. * @param capacity defines the size of the buffer
  100493. * @returns the webGL buffer
  100494. */
  100495. createInstancesBuffer(capacity: number): DataBuffer;
  100496. /**
  100497. * Delete a webGL buffer used with instanciation
  100498. * @param buffer defines the webGL buffer to delete
  100499. */
  100500. deleteInstancesBuffer(buffer: WebGLBuffer): void;
  100501. /** @hidden */
  100502. _readTexturePixels(texture: InternalTexture, width: number, height: number, faceIndex?: number, level?: number, buffer?: Nullable<ArrayBufferView>): ArrayBufferView;
  100503. dispose(): void;
  100504. private _disableTouchAction;
  100505. /**
  100506. * Display the loading screen
  100507. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  100508. */
  100509. displayLoadingUI(): void;
  100510. /**
  100511. * Hide the loading screen
  100512. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  100513. */
  100514. hideLoadingUI(): void;
  100515. /**
  100516. * Gets the current loading screen object
  100517. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  100518. */
  100519. /**
  100520. * Sets the current loading screen object
  100521. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  100522. */
  100523. loadingScreen: ILoadingScreen;
  100524. /**
  100525. * Sets the current loading screen text
  100526. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  100527. */
  100528. loadingUIText: string;
  100529. /**
  100530. * Sets the current loading screen background color
  100531. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  100532. */
  100533. loadingUIBackgroundColor: string;
  100534. /** Pointerlock and fullscreen */
  100535. /**
  100536. * Ask the browser to promote the current element to pointerlock mode
  100537. * @param element defines the DOM element to promote
  100538. */
  100539. static _RequestPointerlock(element: HTMLElement): void;
  100540. /**
  100541. * Asks the browser to exit pointerlock mode
  100542. */
  100543. static _ExitPointerlock(): void;
  100544. /**
  100545. * Ask the browser to promote the current element to fullscreen rendering mode
  100546. * @param element defines the DOM element to promote
  100547. */
  100548. static _RequestFullscreen(element: HTMLElement): void;
  100549. /**
  100550. * Asks the browser to exit fullscreen mode
  100551. */
  100552. static _ExitFullscreen(): void;
  100553. }
  100554. }
  100555. declare module BABYLON {
  100556. /**
  100557. * The engine store class is responsible to hold all the instances of Engine and Scene created
  100558. * during the life time of the application.
  100559. */
  100560. export class EngineStore {
  100561. /** Gets the list of created engines */
  100562. static Instances: Engine[];
  100563. /** @hidden */
  100564. static _LastCreatedScene: Nullable<Scene>;
  100565. /**
  100566. * Gets the latest created engine
  100567. */
  100568. static readonly LastCreatedEngine: Nullable<Engine>;
  100569. /**
  100570. * Gets the latest created scene
  100571. */
  100572. static readonly LastCreatedScene: Nullable<Scene>;
  100573. /**
  100574. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  100575. * @ignorenaming
  100576. */
  100577. static UseFallbackTexture: boolean;
  100578. /**
  100579. * Texture content used if a texture cannot loaded
  100580. * @ignorenaming
  100581. */
  100582. static FallbackTexture: string;
  100583. }
  100584. }
  100585. declare module BABYLON {
  100586. /**
  100587. * Helper class that provides a small promise polyfill
  100588. */
  100589. export class PromisePolyfill {
  100590. /**
  100591. * Static function used to check if the polyfill is required
  100592. * If this is the case then the function will inject the polyfill to window.Promise
  100593. * @param force defines a boolean used to force the injection (mostly for testing purposes)
  100594. */
  100595. static Apply(force?: boolean): void;
  100596. }
  100597. }
  100598. declare module BABYLON {
  100599. /**
  100600. * Interface for screenshot methods with describe argument called `size` as object with options
  100601. * @link https://doc.babylonjs.com/api/classes/babylon.screenshottools
  100602. */
  100603. export interface IScreenshotSize {
  100604. /**
  100605. * number in pixels for canvas height
  100606. */
  100607. height?: number;
  100608. /**
  100609. * multiplier allowing render at a higher or lower resolution
  100610. * If value is defined then height and width will be ignored and taken from camera
  100611. */
  100612. precision?: number;
  100613. /**
  100614. * number in pixels for canvas width
  100615. */
  100616. width?: number;
  100617. }
  100618. }
  100619. declare module BABYLON {
  100620. interface IColor4Like {
  100621. r: float;
  100622. g: float;
  100623. b: float;
  100624. a: float;
  100625. }
  100626. /**
  100627. * Class containing a set of static utilities functions
  100628. */
  100629. export class Tools {
  100630. /**
  100631. * Gets or sets the base URL to use to load assets
  100632. */
  100633. static BaseUrl: string;
  100634. /**
  100635. * Enable/Disable Custom HTTP Request Headers globally.
  100636. * default = false
  100637. * @see CustomRequestHeaders
  100638. */
  100639. static UseCustomRequestHeaders: boolean;
  100640. /**
  100641. * Custom HTTP Request Headers to be sent with XMLHttpRequests
  100642. * i.e. when loading files, where the server/service expects an Authorization header
  100643. */
  100644. static CustomRequestHeaders: {
  100645. [key: string]: string;
  100646. };
  100647. /**
  100648. * Gets or sets the retry strategy to apply when an error happens while loading an asset
  100649. */
  100650. static DefaultRetryStrategy: (url: string, request: WebRequest, retryIndex: number) => number;
  100651. /**
  100652. * Default behaviour for cors in the application.
  100653. * It can be a string if the expected behavior is identical in the entire app.
  100654. * Or a callback to be able to set it per url or on a group of them (in case of Video source for instance)
  100655. */
  100656. static CorsBehavior: string | ((url: string | string[]) => string);
  100657. /**
  100658. * Gets or sets a global variable indicating if fallback texture must be used when a texture cannot be loaded
  100659. * @ignorenaming
  100660. */
  100661. static UseFallbackTexture: boolean;
  100662. /**
  100663. * Use this object to register external classes like custom textures or material
  100664. * to allow the laoders to instantiate them
  100665. */
  100666. static RegisteredExternalClasses: {
  100667. [key: string]: Object;
  100668. };
  100669. /**
  100670. * Texture content used if a texture cannot loaded
  100671. * @ignorenaming
  100672. */
  100673. static fallbackTexture: string;
  100674. /**
  100675. * Read the content of a byte array at a specified coordinates (taking in account wrapping)
  100676. * @param u defines the coordinate on X axis
  100677. * @param v defines the coordinate on Y axis
  100678. * @param width defines the width of the source data
  100679. * @param height defines the height of the source data
  100680. * @param pixels defines the source byte array
  100681. * @param color defines the output color
  100682. */
  100683. static FetchToRef(u: number, v: number, width: number, height: number, pixels: Uint8Array, color: IColor4Like): void;
  100684. /**
  100685. * Interpolates between a and b via alpha
  100686. * @param a The lower value (returned when alpha = 0)
  100687. * @param b The upper value (returned when alpha = 1)
  100688. * @param alpha The interpolation-factor
  100689. * @return The mixed value
  100690. */
  100691. static Mix(a: number, b: number, alpha: number): number;
  100692. /**
  100693. * Tries to instantiate a new object from a given class name
  100694. * @param className defines the class name to instantiate
  100695. * @returns the new object or null if the system was not able to do the instantiation
  100696. */
  100697. static Instantiate(className: string): any;
  100698. /**
  100699. * Provides a slice function that will work even on IE
  100700. * @param data defines the array to slice
  100701. * @param start defines the start of the data (optional)
  100702. * @param end defines the end of the data (optional)
  100703. * @returns the new sliced array
  100704. */
  100705. static Slice<T>(data: T, start?: number, end?: number): T;
  100706. /**
  100707. * Polyfill for setImmediate
  100708. * @param action defines the action to execute after the current execution block
  100709. */
  100710. static SetImmediate(action: () => void): void;
  100711. /**
  100712. * Function indicating if a number is an exponent of 2
  100713. * @param value defines the value to test
  100714. * @returns true if the value is an exponent of 2
  100715. */
  100716. static IsExponentOfTwo(value: number): boolean;
  100717. private static _tmpFloatArray;
  100718. /**
  100719. * Returns the nearest 32-bit single precision float representation of a Number
  100720. * @param value A Number. If the parameter is of a different type, it will get converted
  100721. * to a number or to NaN if it cannot be converted
  100722. * @returns number
  100723. */
  100724. static FloatRound(value: number): number;
  100725. /**
  100726. * Extracts the filename from a path
  100727. * @param path defines the path to use
  100728. * @returns the filename
  100729. */
  100730. static GetFilename(path: string): string;
  100731. /**
  100732. * Extracts the "folder" part of a path (everything before the filename).
  100733. * @param uri The URI to extract the info from
  100734. * @param returnUnchangedIfNoSlash Do not touch the URI if no slashes are present
  100735. * @returns The "folder" part of the path
  100736. */
  100737. static GetFolderPath(uri: string, returnUnchangedIfNoSlash?: boolean): string;
  100738. /**
  100739. * Extracts text content from a DOM element hierarchy
  100740. * Back Compat only, please use DomManagement.GetDOMTextContent instead.
  100741. */
  100742. static GetDOMTextContent: typeof DomManagement.GetDOMTextContent;
  100743. /**
  100744. * Convert an angle in radians to degrees
  100745. * @param angle defines the angle to convert
  100746. * @returns the angle in degrees
  100747. */
  100748. static ToDegrees(angle: number): number;
  100749. /**
  100750. * Convert an angle in degrees to radians
  100751. * @param angle defines the angle to convert
  100752. * @returns the angle in radians
  100753. */
  100754. static ToRadians(angle: number): number;
  100755. /**
  100756. * Returns an array if obj is not an array
  100757. * @param obj defines the object to evaluate as an array
  100758. * @param allowsNullUndefined defines a boolean indicating if obj is allowed to be null or undefined
  100759. * @returns either obj directly if obj is an array or a new array containing obj
  100760. */
  100761. static MakeArray(obj: any, allowsNullUndefined?: boolean): Nullable<Array<any>>;
  100762. /**
  100763. * Gets the pointer prefix to use
  100764. * @returns "pointer" if touch is enabled. Else returns "mouse"
  100765. */
  100766. static GetPointerPrefix(): string;
  100767. /**
  100768. * Sets the cors behavior on a dom element. This will add the required Tools.CorsBehavior to the element.
  100769. * @param url define the url we are trying
  100770. * @param element define the dom element where to configure the cors policy
  100771. */
  100772. static SetCorsBehavior(url: string | string[], element: {
  100773. crossOrigin: string | null;
  100774. }): void;
  100775. /**
  100776. * Removes unwanted characters from an url
  100777. * @param url defines the url to clean
  100778. * @returns the cleaned url
  100779. */
  100780. static CleanUrl(url: string): string;
  100781. /**
  100782. * Gets or sets a function used to pre-process url before using them to load assets
  100783. */
  100784. static PreprocessUrl: (url: string) => string;
  100785. /**
  100786. * Loads an image as an HTMLImageElement.
  100787. * @param input url string, ArrayBuffer, or Blob to load
  100788. * @param onLoad callback called when the image successfully loads
  100789. * @param onError callback called when the image fails to load
  100790. * @param offlineProvider offline provider for caching
  100791. * @param mimeType optional mime type
  100792. * @returns the HTMLImageElement of the loaded image
  100793. */
  100794. static LoadImage(input: string | ArrayBuffer | Blob, onLoad: (img: HTMLImageElement | ImageBitmap) => void, onError: (message?: string, exception?: any) => void, offlineProvider: Nullable<IOfflineProvider>, mimeType?: string): Nullable<HTMLImageElement>;
  100795. /**
  100796. * Loads a file from a url
  100797. * @param url url string, ArrayBuffer, or Blob to load
  100798. * @param onSuccess callback called when the file successfully loads
  100799. * @param onProgress callback called while file is loading (if the server supports this mode)
  100800. * @param offlineProvider defines the offline provider for caching
  100801. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  100802. * @param onError callback called when the file fails to load
  100803. * @returns a file request object
  100804. */
  100805. 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;
  100806. /**
  100807. * Loads a file from a url
  100808. * @param url the file url to load
  100809. * @returns a promise containing an ArrayBuffer corrisponding to the loaded file
  100810. */
  100811. static LoadFileAsync(url: string): Promise<ArrayBuffer>;
  100812. /**
  100813. * Load a script (identified by an url). When the url returns, the
  100814. * content of this file is added into a new script element, attached to the DOM (body element)
  100815. * @param scriptUrl defines the url of the script to laod
  100816. * @param onSuccess defines the callback called when the script is loaded
  100817. * @param onError defines the callback to call if an error occurs
  100818. * @param scriptId defines the id of the script element
  100819. */
  100820. static LoadScript(scriptUrl: string, onSuccess: () => void, onError?: (message?: string, exception?: any) => void, scriptId?: string): void;
  100821. /**
  100822. * Load an asynchronous script (identified by an url). When the url returns, the
  100823. * content of this file is added into a new script element, attached to the DOM (body element)
  100824. * @param scriptUrl defines the url of the script to laod
  100825. * @param scriptId defines the id of the script element
  100826. * @returns a promise request object
  100827. */
  100828. static LoadScriptAsync(scriptUrl: string, scriptId?: string): Promise<boolean>;
  100829. /**
  100830. * Loads a file from a blob
  100831. * @param fileToLoad defines the blob to use
  100832. * @param callback defines the callback to call when data is loaded
  100833. * @param progressCallback defines the callback to call during loading process
  100834. * @returns a file request object
  100835. */
  100836. static ReadFileAsDataURL(fileToLoad: Blob, callback: (data: any) => void, progressCallback: (ev: ProgressEvent) => any): IFileRequest;
  100837. /**
  100838. * Reads a file from a File object
  100839. * @param file defines the file to load
  100840. * @param onSuccess defines the callback to call when data is loaded
  100841. * @param onProgress defines the callback to call during loading process
  100842. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  100843. * @param onError defines the callback to call when an error occurs
  100844. * @returns a file request object
  100845. */
  100846. static ReadFile(file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  100847. /**
  100848. * Creates a data url from a given string content
  100849. * @param content defines the content to convert
  100850. * @returns the new data url link
  100851. */
  100852. static FileAsURL(content: string): string;
  100853. /**
  100854. * Format the given number to a specific decimal format
  100855. * @param value defines the number to format
  100856. * @param decimals defines the number of decimals to use
  100857. * @returns the formatted string
  100858. */
  100859. static Format(value: number, decimals?: number): string;
  100860. /**
  100861. * Tries to copy an object by duplicating every property
  100862. * @param source defines the source object
  100863. * @param destination defines the target object
  100864. * @param doNotCopyList defines a list of properties to avoid
  100865. * @param mustCopyList defines a list of properties to copy (even if they start with _)
  100866. */
  100867. static DeepCopy(source: any, destination: any, doNotCopyList?: string[], mustCopyList?: string[]): void;
  100868. /**
  100869. * Gets a boolean indicating if the given object has no own property
  100870. * @param obj defines the object to test
  100871. * @returns true if object has no own property
  100872. */
  100873. static IsEmpty(obj: any): boolean;
  100874. /**
  100875. * Function used to register events at window level
  100876. * @param windowElement defines the Window object to use
  100877. * @param events defines the events to register
  100878. */
  100879. static RegisterTopRootEvents(windowElement: Window, events: {
  100880. name: string;
  100881. handler: Nullable<(e: FocusEvent) => any>;
  100882. }[]): void;
  100883. /**
  100884. * Function used to unregister events from window level
  100885. * @param windowElement defines the Window object to use
  100886. * @param events defines the events to unregister
  100887. */
  100888. static UnregisterTopRootEvents(windowElement: Window, events: {
  100889. name: string;
  100890. handler: Nullable<(e: FocusEvent) => any>;
  100891. }[]): void;
  100892. /**
  100893. * @ignore
  100894. */
  100895. static _ScreenshotCanvas: HTMLCanvasElement;
  100896. /**
  100897. * Dumps the current bound framebuffer
  100898. * @param width defines the rendering width
  100899. * @param height defines the rendering height
  100900. * @param engine defines the hosting engine
  100901. * @param successCallback defines the callback triggered once the data are available
  100902. * @param mimeType defines the mime type of the result
  100903. * @param fileName defines the filename to download. If present, the result will automatically be downloaded
  100904. */
  100905. static DumpFramebuffer(width: number, height: number, engine: Engine, successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  100906. /**
  100907. * Converts the canvas data to blob.
  100908. * This acts as a polyfill for browsers not supporting the to blob function.
  100909. * @param canvas Defines the canvas to extract the data from
  100910. * @param successCallback Defines the callback triggered once the data are available
  100911. * @param mimeType Defines the mime type of the result
  100912. */
  100913. static ToBlob(canvas: HTMLCanvasElement, successCallback: (blob: Nullable<Blob>) => void, mimeType?: string): void;
  100914. /**
  100915. * Encodes the canvas data to base 64 or automatically download the result if filename is defined
  100916. * @param successCallback defines the callback triggered once the data are available
  100917. * @param mimeType defines the mime type of the result
  100918. * @param fileName defines he filename to download. If present, the result will automatically be downloaded
  100919. */
  100920. static EncodeScreenshotCanvasData(successCallback?: (data: string) => void, mimeType?: string, fileName?: string): void;
  100921. /**
  100922. * Downloads a blob in the browser
  100923. * @param blob defines the blob to download
  100924. * @param fileName defines the name of the downloaded file
  100925. */
  100926. static Download(blob: Blob, fileName: string): void;
  100927. /**
  100928. * Captures a screenshot of the current rendering
  100929. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  100930. * @param engine defines the rendering engine
  100931. * @param camera defines the source camera
  100932. * @param size This parameter can be set to a single number or to an object with the
  100933. * following (optional) properties: precision, width, height. If a single number is passed,
  100934. * it will be used for both width and height. If an object is passed, the screenshot size
  100935. * will be derived from the parameters. The precision property is a multiplier allowing
  100936. * rendering at a higher or lower resolution
  100937. * @param successCallback defines the callback receives a single parameter which contains the
  100938. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  100939. * src parameter of an <img> to display it
  100940. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  100941. * Check your browser for supported MIME types
  100942. */
  100943. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  100944. /**
  100945. * Captures a screenshot of the current rendering
  100946. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  100947. * @param engine defines the rendering engine
  100948. * @param camera defines the source camera
  100949. * @param size This parameter can be set to a single number or to an object with the
  100950. * following (optional) properties: precision, width, height. If a single number is passed,
  100951. * it will be used for both width and height. If an object is passed, the screenshot size
  100952. * will be derived from the parameters. The precision property is a multiplier allowing
  100953. * rendering at a higher or lower resolution
  100954. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  100955. * Check your browser for supported MIME types
  100956. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  100957. * to the src parameter of an <img> to display it
  100958. */
  100959. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string): Promise<string>;
  100960. /**
  100961. * Generates an image screenshot from the specified camera.
  100962. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  100963. * @param engine The engine to use for rendering
  100964. * @param camera The camera to use for rendering
  100965. * @param size This parameter can be set to a single number or to an object with the
  100966. * following (optional) properties: precision, width, height. If a single number is passed,
  100967. * it will be used for both width and height. If an object is passed, the screenshot size
  100968. * will be derived from the parameters. The precision property is a multiplier allowing
  100969. * rendering at a higher or lower resolution
  100970. * @param successCallback The callback receives a single parameter which contains the
  100971. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  100972. * src parameter of an <img> to display it
  100973. * @param mimeType The MIME type of the screenshot image (default: image/png).
  100974. * Check your browser for supported MIME types
  100975. * @param samples Texture samples (default: 1)
  100976. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  100977. * @param fileName A name for for the downloaded file.
  100978. */
  100979. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): void;
  100980. /**
  100981. * Generates an image screenshot from the specified camera.
  100982. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  100983. * @param engine The engine to use for rendering
  100984. * @param camera The camera to use for rendering
  100985. * @param size This parameter can be set to a single number or to an object with the
  100986. * following (optional) properties: precision, width, height. If a single number is passed,
  100987. * it will be used for both width and height. If an object is passed, the screenshot size
  100988. * will be derived from the parameters. The precision property is a multiplier allowing
  100989. * rendering at a higher or lower resolution
  100990. * @param mimeType The MIME type of the screenshot image (default: image/png).
  100991. * Check your browser for supported MIME types
  100992. * @param samples Texture samples (default: 1)
  100993. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  100994. * @param fileName A name for for the downloaded file.
  100995. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  100996. * to the src parameter of an <img> to display it
  100997. */
  100998. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: IScreenshotSize | number, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): Promise<string>;
  100999. /**
  101000. * Implementation from http://stackoverflow.com/questions/105034/how-to-create-a-guid-uuid-in-javascript/2117523#answer-2117523
  101001. * Be aware Math.random() could cause collisions, but:
  101002. * "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"
  101003. * @returns a pseudo random id
  101004. */
  101005. static RandomId(): string;
  101006. /**
  101007. * Test if the given uri is a base64 string
  101008. * @param uri The uri to test
  101009. * @return True if the uri is a base64 string or false otherwise
  101010. */
  101011. static IsBase64(uri: string): boolean;
  101012. /**
  101013. * Decode the given base64 uri.
  101014. * @param uri The uri to decode
  101015. * @return The decoded base64 data.
  101016. */
  101017. static DecodeBase64(uri: string): ArrayBuffer;
  101018. /**
  101019. * Gets the absolute url.
  101020. * @param url the input url
  101021. * @return the absolute url
  101022. */
  101023. static GetAbsoluteUrl(url: string): string;
  101024. /**
  101025. * No log
  101026. */
  101027. static readonly NoneLogLevel: number;
  101028. /**
  101029. * Only message logs
  101030. */
  101031. static readonly MessageLogLevel: number;
  101032. /**
  101033. * Only warning logs
  101034. */
  101035. static readonly WarningLogLevel: number;
  101036. /**
  101037. * Only error logs
  101038. */
  101039. static readonly ErrorLogLevel: number;
  101040. /**
  101041. * All logs
  101042. */
  101043. static readonly AllLogLevel: number;
  101044. /**
  101045. * Gets a value indicating the number of loading errors
  101046. * @ignorenaming
  101047. */
  101048. static readonly errorsCount: number;
  101049. /**
  101050. * Callback called when a new log is added
  101051. */
  101052. static OnNewCacheEntry: (entry: string) => void;
  101053. /**
  101054. * Log a message to the console
  101055. * @param message defines the message to log
  101056. */
  101057. static Log(message: string): void;
  101058. /**
  101059. * Write a warning message to the console
  101060. * @param message defines the message to log
  101061. */
  101062. static Warn(message: string): void;
  101063. /**
  101064. * Write an error message to the console
  101065. * @param message defines the message to log
  101066. */
  101067. static Error(message: string): void;
  101068. /**
  101069. * Gets current log cache (list of logs)
  101070. */
  101071. static readonly LogCache: string;
  101072. /**
  101073. * Clears the log cache
  101074. */
  101075. static ClearLogCache(): void;
  101076. /**
  101077. * Sets the current log level (MessageLogLevel / WarningLogLevel / ErrorLogLevel)
  101078. */
  101079. static LogLevels: number;
  101080. /**
  101081. * Checks if the window object exists
  101082. * Back Compat only, please use DomManagement.IsWindowObjectExist instead.
  101083. */
  101084. static IsWindowObjectExist: typeof DomManagement.IsWindowObjectExist;
  101085. /**
  101086. * No performance log
  101087. */
  101088. static readonly PerformanceNoneLogLevel: number;
  101089. /**
  101090. * Use user marks to log performance
  101091. */
  101092. static readonly PerformanceUserMarkLogLevel: number;
  101093. /**
  101094. * Log performance to the console
  101095. */
  101096. static readonly PerformanceConsoleLogLevel: number;
  101097. private static _performance;
  101098. /**
  101099. * Sets the current performance log level
  101100. */
  101101. static PerformanceLogLevel: number;
  101102. private static _StartPerformanceCounterDisabled;
  101103. private static _EndPerformanceCounterDisabled;
  101104. private static _StartUserMark;
  101105. private static _EndUserMark;
  101106. private static _StartPerformanceConsole;
  101107. private static _EndPerformanceConsole;
  101108. /**
  101109. * Starts a performance counter
  101110. */
  101111. static StartPerformanceCounter: (counterName: string, condition?: boolean) => void;
  101112. /**
  101113. * Ends a specific performance coutner
  101114. */
  101115. static EndPerformanceCounter: (counterName: string, condition?: boolean) => void;
  101116. /**
  101117. * Gets either window.performance.now() if supported or Date.now() else
  101118. */
  101119. static readonly Now: number;
  101120. /**
  101121. * This method will return the name of the class used to create the instance of the given object.
  101122. * It will works only on Javascript basic data types (number, string, ...) and instance of class declared with the @className decorator.
  101123. * @param object the object to get the class name from
  101124. * @param isType defines if the object is actually a type
  101125. * @returns the name of the class, will be "object" for a custom data type not using the @className decorator
  101126. */
  101127. static GetClassName(object: any, isType?: boolean): string;
  101128. /**
  101129. * Gets the first element of an array satisfying a given predicate
  101130. * @param array defines the array to browse
  101131. * @param predicate defines the predicate to use
  101132. * @returns null if not found or the element
  101133. */
  101134. static First<T>(array: Array<T>, predicate: (item: T) => boolean): Nullable<T>;
  101135. /**
  101136. * This method will return the name of the full name of the class, including its owning module (if any).
  101137. * 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).
  101138. * @param object the object to get the class name from
  101139. * @param isType defines if the object is actually a type
  101140. * @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.
  101141. * @ignorenaming
  101142. */
  101143. static getFullClassName(object: any, isType?: boolean): Nullable<string>;
  101144. /**
  101145. * Returns a promise that resolves after the given amount of time.
  101146. * @param delay Number of milliseconds to delay
  101147. * @returns Promise that resolves after the given amount of time
  101148. */
  101149. static DelayAsync(delay: number): Promise<void>;
  101150. }
  101151. /**
  101152. * Use this className as a decorator on a given class definition to add it a name and optionally its module.
  101153. * You can then use the Tools.getClassName(obj) on an instance to retrieve its class name.
  101154. * This method is the only way to get it done in all cases, even if the .js file declaring the class is minified
  101155. * @param name The name of the class, case should be preserved
  101156. * @param module The name of the Module hosting the class, optional, but strongly recommended to specify if possible. Case should be preserved.
  101157. */
  101158. export function className(name: string, module?: string): (target: Object) => void;
  101159. /**
  101160. * An implementation of a loop for asynchronous functions.
  101161. */
  101162. export class AsyncLoop {
  101163. /**
  101164. * Defines the number of iterations for the loop
  101165. */
  101166. iterations: number;
  101167. /**
  101168. * Defines the current index of the loop.
  101169. */
  101170. index: number;
  101171. private _done;
  101172. private _fn;
  101173. private _successCallback;
  101174. /**
  101175. * Constructor.
  101176. * @param iterations the number of iterations.
  101177. * @param func the function to run each iteration
  101178. * @param successCallback the callback that will be called upon succesful execution
  101179. * @param offset starting offset.
  101180. */
  101181. constructor(
  101182. /**
  101183. * Defines the number of iterations for the loop
  101184. */
  101185. iterations: number, func: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number);
  101186. /**
  101187. * Execute the next iteration. Must be called after the last iteration was finished.
  101188. */
  101189. executeNext(): void;
  101190. /**
  101191. * Break the loop and run the success callback.
  101192. */
  101193. breakLoop(): void;
  101194. /**
  101195. * Create and run an async loop.
  101196. * @param iterations the number of iterations.
  101197. * @param fn the function to run each iteration
  101198. * @param successCallback the callback that will be called upon succesful execution
  101199. * @param offset starting offset.
  101200. * @returns the created async loop object
  101201. */
  101202. static Run(iterations: number, fn: (asyncLoop: AsyncLoop) => void, successCallback: () => void, offset?: number): AsyncLoop;
  101203. /**
  101204. * A for-loop that will run a given number of iterations synchronous and the rest async.
  101205. * @param iterations total number of iterations
  101206. * @param syncedIterations number of synchronous iterations in each async iteration.
  101207. * @param fn the function to call each iteration.
  101208. * @param callback a success call back that will be called when iterating stops.
  101209. * @param breakFunction a break condition (optional)
  101210. * @param timeout timeout settings for the setTimeout function. default - 0.
  101211. * @returns the created async loop object
  101212. */
  101213. static SyncAsyncForLoop(iterations: number, syncedIterations: number, fn: (iteration: number) => void, callback: () => void, breakFunction?: () => boolean, timeout?: number): AsyncLoop;
  101214. }
  101215. }
  101216. declare module BABYLON {
  101217. /**
  101218. * This class implement a typical dictionary using a string as key and the generic type T as value.
  101219. * The underlying implementation relies on an associative array to ensure the best performances.
  101220. * The value can be anything including 'null' but except 'undefined'
  101221. */
  101222. export class StringDictionary<T> {
  101223. /**
  101224. * This will clear this dictionary and copy the content from the 'source' one.
  101225. * If the T value is a custom object, it won't be copied/cloned, the same object will be used
  101226. * @param source the dictionary to take the content from and copy to this dictionary
  101227. */
  101228. copyFrom(source: StringDictionary<T>): void;
  101229. /**
  101230. * Get a value based from its key
  101231. * @param key the given key to get the matching value from
  101232. * @return the value if found, otherwise undefined is returned
  101233. */
  101234. get(key: string): T | undefined;
  101235. /**
  101236. * Get a value from its key or add it if it doesn't exist.
  101237. * This method will ensure you that a given key/data will be present in the dictionary.
  101238. * @param key the given key to get the matching value from
  101239. * @param factory the factory that will create the value if the key is not present in the dictionary.
  101240. * The factory will only be invoked if there's no data for the given key.
  101241. * @return the value corresponding to the key.
  101242. */
  101243. getOrAddWithFactory(key: string, factory: (key: string) => T): T;
  101244. /**
  101245. * Get a value from its key if present in the dictionary otherwise add it
  101246. * @param key the key to get the value from
  101247. * @param val if there's no such key/value pair in the dictionary add it with this value
  101248. * @return the value corresponding to the key
  101249. */
  101250. getOrAdd(key: string, val: T): T;
  101251. /**
  101252. * Check if there's a given key in the dictionary
  101253. * @param key the key to check for
  101254. * @return true if the key is present, false otherwise
  101255. */
  101256. contains(key: string): boolean;
  101257. /**
  101258. * Add a new key and its corresponding value
  101259. * @param key the key to add
  101260. * @param value the value corresponding to the key
  101261. * @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
  101262. */
  101263. add(key: string, value: T): boolean;
  101264. /**
  101265. * Update a specific value associated to a key
  101266. * @param key defines the key to use
  101267. * @param value defines the value to store
  101268. * @returns true if the value was updated (or false if the key was not found)
  101269. */
  101270. set(key: string, value: T): boolean;
  101271. /**
  101272. * Get the element of the given key and remove it from the dictionary
  101273. * @param key defines the key to search
  101274. * @returns the value associated with the key or null if not found
  101275. */
  101276. getAndRemove(key: string): Nullable<T>;
  101277. /**
  101278. * Remove a key/value from the dictionary.
  101279. * @param key the key to remove
  101280. * @return true if the item was successfully deleted, false if no item with such key exist in the dictionary
  101281. */
  101282. remove(key: string): boolean;
  101283. /**
  101284. * Clear the whole content of the dictionary
  101285. */
  101286. clear(): void;
  101287. /**
  101288. * Gets the current count
  101289. */
  101290. readonly count: number;
  101291. /**
  101292. * Execute a callback on each key/val of the dictionary.
  101293. * Note that you can remove any element in this dictionary in the callback implementation
  101294. * @param callback the callback to execute on a given key/value pair
  101295. */
  101296. forEach(callback: (key: string, val: T) => void): void;
  101297. /**
  101298. * Execute a callback on every occurrence of the dictionary until it returns a valid TRes object.
  101299. * If the callback returns null or undefined the method will iterate to the next key/value pair
  101300. * Note that you can remove any element in this dictionary in the callback implementation
  101301. * @param callback the callback to execute, if it return a valid T instanced object the enumeration will stop and the object will be returned
  101302. * @returns the first item
  101303. */
  101304. first<TRes>(callback: (key: string, val: T) => TRes): TRes | null;
  101305. private _count;
  101306. private _data;
  101307. }
  101308. }
  101309. declare module BABYLON {
  101310. /** @hidden */
  101311. export interface ICollisionCoordinator {
  101312. createCollider(): Collider;
  101313. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: Nullable<AbstractMesh>, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  101314. init(scene: Scene): void;
  101315. }
  101316. /** @hidden */
  101317. export class DefaultCollisionCoordinator implements ICollisionCoordinator {
  101318. private _scene;
  101319. private _scaledPosition;
  101320. private _scaledVelocity;
  101321. private _finalPosition;
  101322. getNewPosition(position: Vector3, displacement: Vector3, collider: Collider, maximumRetry: number, excludedMesh: AbstractMesh, onNewPosition: (collisionIndex: number, newPosition: Vector3, collidedMesh: Nullable<AbstractMesh>) => void, collisionIndex: number): void;
  101323. createCollider(): Collider;
  101324. init(scene: Scene): void;
  101325. private _collideWithWorld;
  101326. }
  101327. }
  101328. declare module BABYLON {
  101329. /**
  101330. * Class used to manage all inputs for the scene.
  101331. */
  101332. export class InputManager {
  101333. /** The distance in pixel that you have to move to prevent some events */
  101334. static DragMovementThreshold: number;
  101335. /** Time in milliseconds to wait to raise long press events if button is still pressed */
  101336. static LongPressDelay: number;
  101337. /** Time in milliseconds with two consecutive clicks will be considered as a double click */
  101338. static DoubleClickDelay: number;
  101339. /** If you need to check double click without raising a single click at first click, enable this flag */
  101340. static ExclusiveDoubleClickMode: boolean;
  101341. private _wheelEventName;
  101342. private _onPointerMove;
  101343. private _onPointerDown;
  101344. private _onPointerUp;
  101345. private _initClickEvent;
  101346. private _initActionManager;
  101347. private _delayedSimpleClick;
  101348. private _delayedSimpleClickTimeout;
  101349. private _previousDelayedSimpleClickTimeout;
  101350. private _meshPickProceed;
  101351. private _previousButtonPressed;
  101352. private _currentPickResult;
  101353. private _previousPickResult;
  101354. private _totalPointersPressed;
  101355. private _doubleClickOccured;
  101356. private _pointerOverMesh;
  101357. private _pickedDownMesh;
  101358. private _pickedUpMesh;
  101359. private _pointerX;
  101360. private _pointerY;
  101361. private _unTranslatedPointerX;
  101362. private _unTranslatedPointerY;
  101363. private _startingPointerPosition;
  101364. private _previousStartingPointerPosition;
  101365. private _startingPointerTime;
  101366. private _previousStartingPointerTime;
  101367. private _pointerCaptures;
  101368. private _onKeyDown;
  101369. private _onKeyUp;
  101370. private _onCanvasFocusObserver;
  101371. private _onCanvasBlurObserver;
  101372. private _scene;
  101373. /**
  101374. * Creates a new InputManager
  101375. * @param scene defines the hosting scene
  101376. */
  101377. constructor(scene: Scene);
  101378. /**
  101379. * Gets the mesh that is currently under the pointer
  101380. */
  101381. readonly meshUnderPointer: Nullable<AbstractMesh>;
  101382. /**
  101383. * Gets the pointer coordinates in 2D without any translation (ie. straight out of the pointer event)
  101384. */
  101385. readonly unTranslatedPointer: Vector2;
  101386. /**
  101387. * Gets or sets the current on-screen X position of the pointer
  101388. */
  101389. pointerX: number;
  101390. /**
  101391. * Gets or sets the current on-screen Y position of the pointer
  101392. */
  101393. pointerY: number;
  101394. private _updatePointerPosition;
  101395. private _processPointerMove;
  101396. private _setRayOnPointerInfo;
  101397. private _checkPrePointerObservable;
  101398. /**
  101399. * Use this method to simulate a pointer move on a mesh
  101400. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  101401. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  101402. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  101403. */
  101404. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  101405. /**
  101406. * Use this method to simulate a pointer down on a mesh
  101407. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  101408. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  101409. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  101410. */
  101411. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): void;
  101412. private _processPointerDown;
  101413. /** @hidden */
  101414. _isPointerSwiping(): boolean;
  101415. /**
  101416. * Use this method to simulate a pointer up on a mesh
  101417. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  101418. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  101419. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  101420. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  101421. */
  101422. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): void;
  101423. private _processPointerUp;
  101424. /**
  101425. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  101426. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  101427. * @returns true if the pointer was captured
  101428. */
  101429. isPointerCaptured(pointerId?: number): boolean;
  101430. /**
  101431. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  101432. * @param attachUp defines if you want to attach events to pointerup
  101433. * @param attachDown defines if you want to attach events to pointerdown
  101434. * @param attachMove defines if you want to attach events to pointermove
  101435. */
  101436. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean): void;
  101437. /**
  101438. * Detaches all event handlers
  101439. */
  101440. detachControl(): void;
  101441. /**
  101442. * Force the value of meshUnderPointer
  101443. * @param mesh defines the mesh to use
  101444. */
  101445. setPointerOverMesh(mesh: Nullable<AbstractMesh>): void;
  101446. /**
  101447. * Gets the mesh under the pointer
  101448. * @returns a Mesh or null if no mesh is under the pointer
  101449. */
  101450. getPointerOverMesh(): Nullable<AbstractMesh>;
  101451. }
  101452. }
  101453. declare module BABYLON {
  101454. /**
  101455. * Helper class used to generate session unique ID
  101456. */
  101457. export class UniqueIdGenerator {
  101458. private static _UniqueIdCounter;
  101459. /**
  101460. * Gets an unique (relatively to the current scene) Id
  101461. */
  101462. static readonly UniqueId: number;
  101463. }
  101464. }
  101465. declare module BABYLON {
  101466. /**
  101467. * This class defines the direct association between an animation and a target
  101468. */
  101469. export class TargetedAnimation {
  101470. /**
  101471. * Animation to perform
  101472. */
  101473. animation: Animation;
  101474. /**
  101475. * Target to animate
  101476. */
  101477. target: any;
  101478. /**
  101479. * Serialize the object
  101480. * @returns the JSON object representing the current entity
  101481. */
  101482. serialize(): any;
  101483. }
  101484. /**
  101485. * Use this class to create coordinated animations on multiple targets
  101486. */
  101487. export class AnimationGroup implements IDisposable {
  101488. /** The name of the animation group */
  101489. name: string;
  101490. private _scene;
  101491. private _targetedAnimations;
  101492. private _animatables;
  101493. private _from;
  101494. private _to;
  101495. private _isStarted;
  101496. private _isPaused;
  101497. private _speedRatio;
  101498. private _loopAnimation;
  101499. /**
  101500. * Gets or sets the unique id of the node
  101501. */
  101502. uniqueId: number;
  101503. /**
  101504. * This observable will notify when one animation have ended
  101505. */
  101506. onAnimationEndObservable: Observable<TargetedAnimation>;
  101507. /**
  101508. * Observer raised when one animation loops
  101509. */
  101510. onAnimationLoopObservable: Observable<TargetedAnimation>;
  101511. /**
  101512. * Observer raised when all animations have looped
  101513. */
  101514. onAnimationGroupLoopObservable: Observable<AnimationGroup>;
  101515. /**
  101516. * This observable will notify when all animations have ended.
  101517. */
  101518. onAnimationGroupEndObservable: Observable<AnimationGroup>;
  101519. /**
  101520. * This observable will notify when all animations have paused.
  101521. */
  101522. onAnimationGroupPauseObservable: Observable<AnimationGroup>;
  101523. /**
  101524. * This observable will notify when all animations are playing.
  101525. */
  101526. onAnimationGroupPlayObservable: Observable<AnimationGroup>;
  101527. /**
  101528. * Gets the first frame
  101529. */
  101530. readonly from: number;
  101531. /**
  101532. * Gets the last frame
  101533. */
  101534. readonly to: number;
  101535. /**
  101536. * Define if the animations are started
  101537. */
  101538. readonly isStarted: boolean;
  101539. /**
  101540. * Gets a value indicating that the current group is playing
  101541. */
  101542. readonly isPlaying: boolean;
  101543. /**
  101544. * Gets or sets the speed ratio to use for all animations
  101545. */
  101546. /**
  101547. * Gets or sets the speed ratio to use for all animations
  101548. */
  101549. speedRatio: number;
  101550. /**
  101551. * Gets or sets if all animations should loop or not
  101552. */
  101553. loopAnimation: boolean;
  101554. /**
  101555. * Gets the targeted animations for this animation group
  101556. */
  101557. readonly targetedAnimations: Array<TargetedAnimation>;
  101558. /**
  101559. * returning the list of animatables controlled by this animation group.
  101560. */
  101561. readonly animatables: Array<Animatable>;
  101562. /**
  101563. * Instantiates a new Animation Group.
  101564. * This helps managing several animations at once.
  101565. * @see http://doc.babylonjs.com/how_to/group
  101566. * @param name Defines the name of the group
  101567. * @param scene Defines the scene the group belongs to
  101568. */
  101569. constructor(
  101570. /** The name of the animation group */
  101571. name: string, scene?: Nullable<Scene>);
  101572. /**
  101573. * Add an animation (with its target) in the group
  101574. * @param animation defines the animation we want to add
  101575. * @param target defines the target of the animation
  101576. * @returns the TargetedAnimation object
  101577. */
  101578. addTargetedAnimation(animation: Animation, target: any): TargetedAnimation;
  101579. /**
  101580. * This function will normalize every animation in the group to make sure they all go from beginFrame to endFrame
  101581. * It can add constant keys at begin or end
  101582. * @param beginFrame defines the new begin frame for all animations or the smallest begin frame of all animations if null (defaults to null)
  101583. * @param endFrame defines the new end frame for all animations or the largest end frame of all animations if null (defaults to null)
  101584. * @returns the animation group
  101585. */
  101586. normalize(beginFrame?: Nullable<number>, endFrame?: Nullable<number>): AnimationGroup;
  101587. private _animationLoopCount;
  101588. private _animationLoopFlags;
  101589. private _processLoop;
  101590. /**
  101591. * Start all animations on given targets
  101592. * @param loop defines if animations must loop
  101593. * @param speedRatio defines the ratio to apply to animation speed (1 by default)
  101594. * @param from defines the from key (optional)
  101595. * @param to defines the to key (optional)
  101596. * @returns the current animation group
  101597. */
  101598. start(loop?: boolean, speedRatio?: number, from?: number, to?: number): AnimationGroup;
  101599. /**
  101600. * Pause all animations
  101601. * @returns the animation group
  101602. */
  101603. pause(): AnimationGroup;
  101604. /**
  101605. * Play all animations to initial state
  101606. * This function will start() the animations if they were not started or will restart() them if they were paused
  101607. * @param loop defines if animations must loop
  101608. * @returns the animation group
  101609. */
  101610. play(loop?: boolean): AnimationGroup;
  101611. /**
  101612. * Reset all animations to initial state
  101613. * @returns the animation group
  101614. */
  101615. reset(): AnimationGroup;
  101616. /**
  101617. * Restart animations from key 0
  101618. * @returns the animation group
  101619. */
  101620. restart(): AnimationGroup;
  101621. /**
  101622. * Stop all animations
  101623. * @returns the animation group
  101624. */
  101625. stop(): AnimationGroup;
  101626. /**
  101627. * Set animation weight for all animatables
  101628. * @param weight defines the weight to use
  101629. * @return the animationGroup
  101630. * @see http://doc.babylonjs.com/babylon101/animations#animation-weights
  101631. */
  101632. setWeightForAllAnimatables(weight: number): AnimationGroup;
  101633. /**
  101634. * Synchronize and normalize all animatables with a source animatable
  101635. * @param root defines the root animatable to synchronize with
  101636. * @return the animationGroup
  101637. * @see http://doc.babylonjs.com/babylon101/animations#animation-weights
  101638. */
  101639. syncAllAnimationsWith(root: Animatable): AnimationGroup;
  101640. /**
  101641. * Goes to a specific frame in this animation group
  101642. * @param frame the frame number to go to
  101643. * @return the animationGroup
  101644. */
  101645. goToFrame(frame: number): AnimationGroup;
  101646. /**
  101647. * Dispose all associated resources
  101648. */
  101649. dispose(): void;
  101650. private _checkAnimationGroupEnded;
  101651. /**
  101652. * Clone the current animation group and returns a copy
  101653. * @param newName defines the name of the new group
  101654. * @param targetConverter defines an optional function used to convert current animation targets to new ones
  101655. * @returns the new aniamtion group
  101656. */
  101657. clone(newName: string, targetConverter?: (oldTarget: any) => any): AnimationGroup;
  101658. /**
  101659. * Serializes the animationGroup to an object
  101660. * @returns Serialized object
  101661. */
  101662. serialize(): any;
  101663. /**
  101664. * Returns a new AnimationGroup object parsed from the source provided.
  101665. * @param parsedAnimationGroup defines the source
  101666. * @param scene defines the scene that will receive the animationGroup
  101667. * @returns a new AnimationGroup
  101668. */
  101669. static Parse(parsedAnimationGroup: any, scene: Scene): AnimationGroup;
  101670. /**
  101671. * Returns the string "AnimationGroup"
  101672. * @returns "AnimationGroup"
  101673. */
  101674. getClassName(): string;
  101675. /**
  101676. * Creates a detailled string about the object
  101677. * @param fullDetails defines if the output string will support multiple levels of logging within scene loading
  101678. * @returns a string representing the object
  101679. */
  101680. toString(fullDetails?: boolean): string;
  101681. }
  101682. }
  101683. declare module BABYLON {
  101684. /**
  101685. * Define an interface for all classes that will hold resources
  101686. */
  101687. export interface IDisposable {
  101688. /**
  101689. * Releases all held resources
  101690. */
  101691. dispose(): void;
  101692. }
  101693. /** Interface defining initialization parameters for Scene class */
  101694. export interface SceneOptions {
  101695. /**
  101696. * Defines that scene should keep up-to-date a map of geometry to enable fast look-up by uniqueId
  101697. * It will improve performance when the number of geometries becomes important.
  101698. */
  101699. useGeometryUniqueIdsMap?: boolean;
  101700. /**
  101701. * Defines that each material of the scene should keep up-to-date a map of referencing meshes for fast diposing
  101702. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  101703. */
  101704. useMaterialMeshMap?: boolean;
  101705. /**
  101706. * Defines that each mesh of the scene should keep up-to-date a map of referencing cloned meshes for fast diposing
  101707. * It will improve performance when the number of mesh becomes important, but might consume a bit more memory
  101708. */
  101709. useClonedMeshhMap?: boolean;
  101710. /** Defines if the creation of the scene should impact the engine (Eg. UtilityLayer's scene) */
  101711. virtual?: boolean;
  101712. }
  101713. /**
  101714. * Represents a scene to be rendered by the engine.
  101715. * @see http://doc.babylonjs.com/features/scene
  101716. */
  101717. export class Scene extends AbstractScene implements IAnimatable {
  101718. /** The fog is deactivated */
  101719. static readonly FOGMODE_NONE: number;
  101720. /** The fog density is following an exponential function */
  101721. static readonly FOGMODE_EXP: number;
  101722. /** The fog density is following an exponential function faster than FOGMODE_EXP */
  101723. static readonly FOGMODE_EXP2: number;
  101724. /** The fog density is following a linear function. */
  101725. static readonly FOGMODE_LINEAR: number;
  101726. /**
  101727. * Gets or sets the minimum deltatime when deterministic lock step is enabled
  101728. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  101729. */
  101730. static MinDeltaTime: number;
  101731. /**
  101732. * Gets or sets the maximum deltatime when deterministic lock step is enabled
  101733. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  101734. */
  101735. static MaxDeltaTime: number;
  101736. /**
  101737. * Factory used to create the default material.
  101738. * @param name The name of the material to create
  101739. * @param scene The scene to create the material for
  101740. * @returns The default material
  101741. */
  101742. static DefaultMaterialFactory(scene: Scene): Material;
  101743. /**
  101744. * Factory used to create the a collision coordinator.
  101745. * @returns The collision coordinator
  101746. */
  101747. static CollisionCoordinatorFactory(): ICollisionCoordinator;
  101748. /** @hidden */
  101749. _inputManager: InputManager;
  101750. /** Define this parameter if you are using multiple cameras and you want to specify which one should be used for pointer position */
  101751. cameraToUseForPointers: Nullable<Camera>;
  101752. /** @hidden */
  101753. readonly _isScene: boolean;
  101754. /**
  101755. * Gets or sets a boolean that indicates if the scene must clear the render buffer before rendering a frame
  101756. */
  101757. autoClear: boolean;
  101758. /**
  101759. * Gets or sets a boolean that indicates if the scene must clear the depth and stencil buffers before rendering a frame
  101760. */
  101761. autoClearDepthAndStencil: boolean;
  101762. /**
  101763. * Defines the color used to clear the render buffer (Default is (0.2, 0.2, 0.3, 1.0))
  101764. */
  101765. clearColor: Color4;
  101766. /**
  101767. * Defines the color used to simulate the ambient color (Default is (0, 0, 0))
  101768. */
  101769. ambientColor: Color3;
  101770. /**
  101771. * This is use to store the default BRDF lookup for PBR materials in your scene.
  101772. * It should only be one of the following (if not the default embedded one):
  101773. * * For uncorrelated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = false) : https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  101774. * * For correlated BRDF (pbr.brdf.useEnergyConservation = false and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedBRDF.dds
  101775. * * For correlated multi scattering BRDF (pbr.brdf.useEnergyConservation = true and pbr.brdf.useSmithVisibilityHeightCorrelated = true) : https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  101776. * The material properties need to be setup according to the type of texture in use.
  101777. */
  101778. environmentBRDFTexture: BaseTexture;
  101779. /** @hidden */
  101780. protected _environmentTexture: Nullable<BaseTexture>;
  101781. /**
  101782. * Texture used in all pbr material as the reflection texture.
  101783. * As in the majority of the scene they are the same (exception for multi room and so on),
  101784. * this is easier to reference from here than from all the materials.
  101785. */
  101786. /**
  101787. * Texture used in all pbr material as the reflection texture.
  101788. * As in the majority of the scene they are the same (exception for multi room and so on),
  101789. * this is easier to set here than in all the materials.
  101790. */
  101791. environmentTexture: Nullable<BaseTexture>;
  101792. /** @hidden */
  101793. protected _environmentIntensity: number;
  101794. /**
  101795. * Intensity of the environment in all pbr material.
  101796. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  101797. * As in the majority of the scene they are the same (exception for multi room and so on),
  101798. * this is easier to reference from here than from all the materials.
  101799. */
  101800. /**
  101801. * Intensity of the environment in all pbr material.
  101802. * This dims or reinforces the IBL lighting overall (reflection and diffuse).
  101803. * As in the majority of the scene they are the same (exception for multi room and so on),
  101804. * this is easier to set here than in all the materials.
  101805. */
  101806. environmentIntensity: number;
  101807. /** @hidden */
  101808. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  101809. /**
  101810. * Default image processing configuration used either in the rendering
  101811. * Forward main pass or through the imageProcessingPostProcess if present.
  101812. * As in the majority of the scene they are the same (exception for multi camera),
  101813. * this is easier to reference from here than from all the materials and post process.
  101814. *
  101815. * No setter as we it is a shared configuration, you can set the values instead.
  101816. */
  101817. readonly imageProcessingConfiguration: ImageProcessingConfiguration;
  101818. private _forceWireframe;
  101819. /**
  101820. * Gets or sets a boolean indicating if all rendering must be done in wireframe
  101821. */
  101822. forceWireframe: boolean;
  101823. private _forcePointsCloud;
  101824. /**
  101825. * Gets or sets a boolean indicating if all rendering must be done in point cloud
  101826. */
  101827. forcePointsCloud: boolean;
  101828. /**
  101829. * Gets or sets the active clipplane 1
  101830. */
  101831. clipPlane: Nullable<Plane>;
  101832. /**
  101833. * Gets or sets the active clipplane 2
  101834. */
  101835. clipPlane2: Nullable<Plane>;
  101836. /**
  101837. * Gets or sets the active clipplane 3
  101838. */
  101839. clipPlane3: Nullable<Plane>;
  101840. /**
  101841. * Gets or sets the active clipplane 4
  101842. */
  101843. clipPlane4: Nullable<Plane>;
  101844. /**
  101845. * Gets or sets a boolean indicating if animations are enabled
  101846. */
  101847. animationsEnabled: boolean;
  101848. private _animationPropertiesOverride;
  101849. /**
  101850. * Gets or sets the animation properties override
  101851. */
  101852. animationPropertiesOverride: Nullable<AnimationPropertiesOverride>;
  101853. /**
  101854. * Gets or sets a boolean indicating if a constant deltatime has to be used
  101855. * This is mostly useful for testing purposes when you do not want the animations to scale with the framerate
  101856. */
  101857. useConstantAnimationDeltaTime: boolean;
  101858. /**
  101859. * Gets or sets a boolean indicating if the scene must keep the meshUnderPointer property updated
  101860. * Please note that it requires to run a ray cast through the scene on every frame
  101861. */
  101862. constantlyUpdateMeshUnderPointer: boolean;
  101863. /**
  101864. * Defines the HTML cursor to use when hovering over interactive elements
  101865. */
  101866. hoverCursor: string;
  101867. /**
  101868. * Defines the HTML default cursor to use (empty by default)
  101869. */
  101870. defaultCursor: string;
  101871. /**
  101872. * Defines wether cursors are handled by the scene.
  101873. */
  101874. doNotHandleCursors: boolean;
  101875. /**
  101876. * This is used to call preventDefault() on pointer down
  101877. * in order to block unwanted artifacts like system double clicks
  101878. */
  101879. preventDefaultOnPointerDown: boolean;
  101880. /**
  101881. * This is used to call preventDefault() on pointer up
  101882. * in order to block unwanted artifacts like system double clicks
  101883. */
  101884. preventDefaultOnPointerUp: boolean;
  101885. /**
  101886. * Gets or sets user defined metadata
  101887. */
  101888. metadata: any;
  101889. /**
  101890. * For internal use only. Please do not use.
  101891. */
  101892. reservedDataStore: any;
  101893. /**
  101894. * Gets the name of the plugin used to load this scene (null by default)
  101895. */
  101896. loadingPluginName: string;
  101897. /**
  101898. * Use this array to add regular expressions used to disable offline support for specific urls
  101899. */
  101900. disableOfflineSupportExceptionRules: RegExp[];
  101901. /**
  101902. * An event triggered when the scene is disposed.
  101903. */
  101904. onDisposeObservable: Observable<Scene>;
  101905. private _onDisposeObserver;
  101906. /** Sets a function to be executed when this scene is disposed. */
  101907. onDispose: () => void;
  101908. /**
  101909. * An event triggered before rendering the scene (right after animations and physics)
  101910. */
  101911. onBeforeRenderObservable: Observable<Scene>;
  101912. private _onBeforeRenderObserver;
  101913. /** Sets a function to be executed before rendering this scene */
  101914. beforeRender: Nullable<() => void>;
  101915. /**
  101916. * An event triggered after rendering the scene
  101917. */
  101918. onAfterRenderObservable: Observable<Scene>;
  101919. /**
  101920. * An event triggered after rendering the scene for an active camera (When scene.render is called this will be called after each camera)
  101921. */
  101922. onAfterRenderCameraObservable: Observable<Camera>;
  101923. private _onAfterRenderObserver;
  101924. /** Sets a function to be executed after rendering this scene */
  101925. afterRender: Nullable<() => void>;
  101926. /**
  101927. * An event triggered before animating the scene
  101928. */
  101929. onBeforeAnimationsObservable: Observable<Scene>;
  101930. /**
  101931. * An event triggered after animations processing
  101932. */
  101933. onAfterAnimationsObservable: Observable<Scene>;
  101934. /**
  101935. * An event triggered before draw calls are ready to be sent
  101936. */
  101937. onBeforeDrawPhaseObservable: Observable<Scene>;
  101938. /**
  101939. * An event triggered after draw calls have been sent
  101940. */
  101941. onAfterDrawPhaseObservable: Observable<Scene>;
  101942. /**
  101943. * An event triggered when the scene is ready
  101944. */
  101945. onReadyObservable: Observable<Scene>;
  101946. /**
  101947. * An event triggered before rendering a camera
  101948. */
  101949. onBeforeCameraRenderObservable: Observable<Camera>;
  101950. private _onBeforeCameraRenderObserver;
  101951. /** Sets a function to be executed before rendering a camera*/
  101952. beforeCameraRender: () => void;
  101953. /**
  101954. * An event triggered after rendering a camera
  101955. */
  101956. onAfterCameraRenderObservable: Observable<Camera>;
  101957. private _onAfterCameraRenderObserver;
  101958. /** Sets a function to be executed after rendering a camera*/
  101959. afterCameraRender: () => void;
  101960. /**
  101961. * An event triggered when active meshes evaluation is about to start
  101962. */
  101963. onBeforeActiveMeshesEvaluationObservable: Observable<Scene>;
  101964. /**
  101965. * An event triggered when active meshes evaluation is done
  101966. */
  101967. onAfterActiveMeshesEvaluationObservable: Observable<Scene>;
  101968. /**
  101969. * An event triggered when particles rendering is about to start
  101970. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  101971. */
  101972. onBeforeParticlesRenderingObservable: Observable<Scene>;
  101973. /**
  101974. * An event triggered when particles rendering is done
  101975. * Note: This event can be trigger more than once per frame (because particles can be rendered by render target textures as well)
  101976. */
  101977. onAfterParticlesRenderingObservable: Observable<Scene>;
  101978. /**
  101979. * An event triggered when SceneLoader.Append or SceneLoader.Load or SceneLoader.ImportMesh were successfully executed
  101980. */
  101981. onDataLoadedObservable: Observable<Scene>;
  101982. /**
  101983. * An event triggered when a camera is created
  101984. */
  101985. onNewCameraAddedObservable: Observable<Camera>;
  101986. /**
  101987. * An event triggered when a camera is removed
  101988. */
  101989. onCameraRemovedObservable: Observable<Camera>;
  101990. /**
  101991. * An event triggered when a light is created
  101992. */
  101993. onNewLightAddedObservable: Observable<Light>;
  101994. /**
  101995. * An event triggered when a light is removed
  101996. */
  101997. onLightRemovedObservable: Observable<Light>;
  101998. /**
  101999. * An event triggered when a geometry is created
  102000. */
  102001. onNewGeometryAddedObservable: Observable<Geometry>;
  102002. /**
  102003. * An event triggered when a geometry is removed
  102004. */
  102005. onGeometryRemovedObservable: Observable<Geometry>;
  102006. /**
  102007. * An event triggered when a transform node is created
  102008. */
  102009. onNewTransformNodeAddedObservable: Observable<TransformNode>;
  102010. /**
  102011. * An event triggered when a transform node is removed
  102012. */
  102013. onTransformNodeRemovedObservable: Observable<TransformNode>;
  102014. /**
  102015. * An event triggered when a mesh is created
  102016. */
  102017. onNewMeshAddedObservable: Observable<AbstractMesh>;
  102018. /**
  102019. * An event triggered when a mesh is removed
  102020. */
  102021. onMeshRemovedObservable: Observable<AbstractMesh>;
  102022. /**
  102023. * An event triggered when a skeleton is created
  102024. */
  102025. onNewSkeletonAddedObservable: Observable<Skeleton>;
  102026. /**
  102027. * An event triggered when a skeleton is removed
  102028. */
  102029. onSkeletonRemovedObservable: Observable<Skeleton>;
  102030. /**
  102031. * An event triggered when a material is created
  102032. */
  102033. onNewMaterialAddedObservable: Observable<Material>;
  102034. /**
  102035. * An event triggered when a material is removed
  102036. */
  102037. onMaterialRemovedObservable: Observable<Material>;
  102038. /**
  102039. * An event triggered when a texture is created
  102040. */
  102041. onNewTextureAddedObservable: Observable<BaseTexture>;
  102042. /**
  102043. * An event triggered when a texture is removed
  102044. */
  102045. onTextureRemovedObservable: Observable<BaseTexture>;
  102046. /**
  102047. * An event triggered when render targets are about to be rendered
  102048. * Can happen multiple times per frame.
  102049. */
  102050. onBeforeRenderTargetsRenderObservable: Observable<Scene>;
  102051. /**
  102052. * An event triggered when render targets were rendered.
  102053. * Can happen multiple times per frame.
  102054. */
  102055. onAfterRenderTargetsRenderObservable: Observable<Scene>;
  102056. /**
  102057. * An event triggered before calculating deterministic simulation step
  102058. */
  102059. onBeforeStepObservable: Observable<Scene>;
  102060. /**
  102061. * An event triggered after calculating deterministic simulation step
  102062. */
  102063. onAfterStepObservable: Observable<Scene>;
  102064. /**
  102065. * An event triggered when the activeCamera property is updated
  102066. */
  102067. onActiveCameraChanged: Observable<Scene>;
  102068. /**
  102069. * This Observable will be triggered before rendering each renderingGroup of each rendered camera.
  102070. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  102071. * 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)
  102072. */
  102073. onBeforeRenderingGroupObservable: Observable<RenderingGroupInfo>;
  102074. /**
  102075. * This Observable will be triggered after rendering each renderingGroup of each rendered camera.
  102076. * The RenderinGroupInfo class contains all the information about the context in which the observable is called
  102077. * 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)
  102078. */
  102079. onAfterRenderingGroupObservable: Observable<RenderingGroupInfo>;
  102080. /**
  102081. * This Observable will when a mesh has been imported into the scene.
  102082. */
  102083. onMeshImportedObservable: Observable<AbstractMesh>;
  102084. /**
  102085. * Gets or sets a user defined funtion to select LOD from a mesh and a camera.
  102086. * By default this function is undefined and Babylon.js will select LOD based on distance to camera
  102087. */
  102088. customLODSelector: (mesh: AbstractMesh, camera: Camera) => Nullable<AbstractMesh>;
  102089. /** @hidden */
  102090. _registeredForLateAnimationBindings: SmartArrayNoDuplicate<any>;
  102091. /**
  102092. * Gets or sets a predicate used to select candidate meshes for a pointer down event
  102093. */
  102094. pointerDownPredicate: (Mesh: AbstractMesh) => boolean;
  102095. /**
  102096. * Gets or sets a predicate used to select candidate meshes for a pointer up event
  102097. */
  102098. pointerUpPredicate: (Mesh: AbstractMesh) => boolean;
  102099. /**
  102100. * Gets or sets a predicate used to select candidate meshes for a pointer move event
  102101. */
  102102. pointerMovePredicate: (Mesh: AbstractMesh) => boolean;
  102103. /** Callback called when a pointer move is detected */
  102104. onPointerMove: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  102105. /** Callback called when a pointer down is detected */
  102106. onPointerDown: (evt: PointerEvent, pickInfo: PickingInfo, type: PointerEventTypes) => void;
  102107. /** Callback called when a pointer up is detected */
  102108. onPointerUp: (evt: PointerEvent, pickInfo: Nullable<PickingInfo>, type: PointerEventTypes) => void;
  102109. /** Callback called when a pointer pick is detected */
  102110. onPointerPick: (evt: PointerEvent, pickInfo: PickingInfo) => void;
  102111. /**
  102112. * 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).
  102113. * You have the possibility to skip the process and the call to onPointerObservable by setting PointerInfoPre.skipOnPointerObservable to true
  102114. */
  102115. onPrePointerObservable: Observable<PointerInfoPre>;
  102116. /**
  102117. * Observable event triggered each time an input event is received from the rendering canvas
  102118. */
  102119. onPointerObservable: Observable<PointerInfo>;
  102120. /**
  102121. * Gets the pointer coordinates without any translation (ie. straight out of the pointer event)
  102122. */
  102123. readonly unTranslatedPointer: Vector2;
  102124. /**
  102125. * Gets or sets the distance in pixel that you have to move to prevent some events. Default is 10 pixels
  102126. */
  102127. static DragMovementThreshold: number;
  102128. /**
  102129. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 500 ms
  102130. */
  102131. static LongPressDelay: number;
  102132. /**
  102133. * Time in milliseconds to wait to raise long press events if button is still pressed. Default is 300 ms
  102134. */
  102135. static DoubleClickDelay: number;
  102136. /** If you need to check double click without raising a single click at first click, enable this flag */
  102137. static ExclusiveDoubleClickMode: boolean;
  102138. /** @hidden */
  102139. _mirroredCameraPosition: Nullable<Vector3>;
  102140. /**
  102141. * This observable event is triggered when any keyboard event si raised and registered during Scene.attachControl()
  102142. * You have the possibility to skip the process and the call to onKeyboardObservable by setting KeyboardInfoPre.skipOnPointerObservable to true
  102143. */
  102144. onPreKeyboardObservable: Observable<KeyboardInfoPre>;
  102145. /**
  102146. * Observable event triggered each time an keyboard event is received from the hosting window
  102147. */
  102148. onKeyboardObservable: Observable<KeyboardInfo>;
  102149. private _useRightHandedSystem;
  102150. /**
  102151. * Gets or sets a boolean indicating if the scene must use right-handed coordinates system
  102152. */
  102153. useRightHandedSystem: boolean;
  102154. private _timeAccumulator;
  102155. private _currentStepId;
  102156. private _currentInternalStep;
  102157. /**
  102158. * Sets the step Id used by deterministic lock step
  102159. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  102160. * @param newStepId defines the step Id
  102161. */
  102162. setStepId(newStepId: number): void;
  102163. /**
  102164. * Gets the step Id used by deterministic lock step
  102165. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  102166. * @returns the step Id
  102167. */
  102168. getStepId(): number;
  102169. /**
  102170. * Gets the internal step used by deterministic lock step
  102171. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  102172. * @returns the internal step
  102173. */
  102174. getInternalStep(): number;
  102175. private _fogEnabled;
  102176. /**
  102177. * Gets or sets a boolean indicating if fog is enabled on this scene
  102178. * @see http://doc.babylonjs.com/babylon101/environment#fog
  102179. * (Default is true)
  102180. */
  102181. fogEnabled: boolean;
  102182. private _fogMode;
  102183. /**
  102184. * Gets or sets the fog mode to use
  102185. * @see http://doc.babylonjs.com/babylon101/environment#fog
  102186. * | mode | value |
  102187. * | --- | --- |
  102188. * | FOGMODE_NONE | 0 |
  102189. * | FOGMODE_EXP | 1 |
  102190. * | FOGMODE_EXP2 | 2 |
  102191. * | FOGMODE_LINEAR | 3 |
  102192. */
  102193. fogMode: number;
  102194. /**
  102195. * Gets or sets the fog color to use
  102196. * @see http://doc.babylonjs.com/babylon101/environment#fog
  102197. * (Default is Color3(0.2, 0.2, 0.3))
  102198. */
  102199. fogColor: Color3;
  102200. /**
  102201. * Gets or sets the fog density to use
  102202. * @see http://doc.babylonjs.com/babylon101/environment#fog
  102203. * (Default is 0.1)
  102204. */
  102205. fogDensity: number;
  102206. /**
  102207. * Gets or sets the fog start distance to use
  102208. * @see http://doc.babylonjs.com/babylon101/environment#fog
  102209. * (Default is 0)
  102210. */
  102211. fogStart: number;
  102212. /**
  102213. * Gets or sets the fog end distance to use
  102214. * @see http://doc.babylonjs.com/babylon101/environment#fog
  102215. * (Default is 1000)
  102216. */
  102217. fogEnd: number;
  102218. private _shadowsEnabled;
  102219. /**
  102220. * Gets or sets a boolean indicating if shadows are enabled on this scene
  102221. */
  102222. shadowsEnabled: boolean;
  102223. private _lightsEnabled;
  102224. /**
  102225. * Gets or sets a boolean indicating if lights are enabled on this scene
  102226. */
  102227. lightsEnabled: boolean;
  102228. /** All of the active cameras added to this scene. */
  102229. activeCameras: Camera[];
  102230. /** @hidden */
  102231. _activeCamera: Nullable<Camera>;
  102232. /** Gets or sets the current active camera */
  102233. activeCamera: Nullable<Camera>;
  102234. private _defaultMaterial;
  102235. /** The default material used on meshes when no material is affected */
  102236. /** The default material used on meshes when no material is affected */
  102237. defaultMaterial: Material;
  102238. private _texturesEnabled;
  102239. /**
  102240. * Gets or sets a boolean indicating if textures are enabled on this scene
  102241. */
  102242. texturesEnabled: boolean;
  102243. /**
  102244. * Gets or sets a boolean indicating if particles are enabled on this scene
  102245. */
  102246. particlesEnabled: boolean;
  102247. /**
  102248. * Gets or sets a boolean indicating if sprites are enabled on this scene
  102249. */
  102250. spritesEnabled: boolean;
  102251. private _skeletonsEnabled;
  102252. /**
  102253. * Gets or sets a boolean indicating if skeletons are enabled on this scene
  102254. */
  102255. skeletonsEnabled: boolean;
  102256. /**
  102257. * Gets or sets a boolean indicating if lens flares are enabled on this scene
  102258. */
  102259. lensFlaresEnabled: boolean;
  102260. /**
  102261. * Gets or sets a boolean indicating if collisions are enabled on this scene
  102262. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  102263. */
  102264. collisionsEnabled: boolean;
  102265. private _collisionCoordinator;
  102266. /** @hidden */
  102267. readonly collisionCoordinator: ICollisionCoordinator;
  102268. /**
  102269. * Defines the gravity applied to this scene (used only for collisions)
  102270. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity
  102271. */
  102272. gravity: Vector3;
  102273. /**
  102274. * Gets or sets a boolean indicating if postprocesses are enabled on this scene
  102275. */
  102276. postProcessesEnabled: boolean;
  102277. /**
  102278. * The list of postprocesses added to the scene
  102279. */
  102280. postProcesses: PostProcess[];
  102281. /**
  102282. * Gets the current postprocess manager
  102283. */
  102284. postProcessManager: PostProcessManager;
  102285. /**
  102286. * Gets or sets a boolean indicating if render targets are enabled on this scene
  102287. */
  102288. renderTargetsEnabled: boolean;
  102289. /**
  102290. * Gets or sets a boolean indicating if next render targets must be dumped as image for debugging purposes
  102291. * We recommend not using it and instead rely on Spector.js: http://spector.babylonjs.com
  102292. */
  102293. dumpNextRenderTargets: boolean;
  102294. /**
  102295. * The list of user defined render targets added to the scene
  102296. */
  102297. customRenderTargets: RenderTargetTexture[];
  102298. /**
  102299. * Defines if texture loading must be delayed
  102300. * If true, textures will only be loaded when they need to be rendered
  102301. */
  102302. useDelayedTextureLoading: boolean;
  102303. /**
  102304. * Gets the list of meshes imported to the scene through SceneLoader
  102305. */
  102306. importedMeshesFiles: String[];
  102307. /**
  102308. * Gets or sets a boolean indicating if probes are enabled on this scene
  102309. */
  102310. probesEnabled: boolean;
  102311. /**
  102312. * Gets or sets the current offline provider to use to store scene data
  102313. * @see http://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  102314. */
  102315. offlineProvider: IOfflineProvider;
  102316. /**
  102317. * Gets or sets the action manager associated with the scene
  102318. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  102319. */
  102320. actionManager: AbstractActionManager;
  102321. private _meshesForIntersections;
  102322. /**
  102323. * Gets or sets a boolean indicating if procedural textures are enabled on this scene
  102324. */
  102325. proceduralTexturesEnabled: boolean;
  102326. private _engine;
  102327. private _totalVertices;
  102328. /** @hidden */
  102329. _activeIndices: PerfCounter;
  102330. /** @hidden */
  102331. _activeParticles: PerfCounter;
  102332. /** @hidden */
  102333. _activeBones: PerfCounter;
  102334. private _animationRatio;
  102335. /** @hidden */
  102336. _animationTimeLast: number;
  102337. /** @hidden */
  102338. _animationTime: number;
  102339. /**
  102340. * Gets or sets a general scale for animation speed
  102341. * @see https://www.babylonjs-playground.com/#IBU2W7#3
  102342. */
  102343. animationTimeScale: number;
  102344. /** @hidden */
  102345. _cachedMaterial: Nullable<Material>;
  102346. /** @hidden */
  102347. _cachedEffect: Nullable<Effect>;
  102348. /** @hidden */
  102349. _cachedVisibility: Nullable<number>;
  102350. private _renderId;
  102351. private _frameId;
  102352. private _executeWhenReadyTimeoutId;
  102353. private _intermediateRendering;
  102354. private _viewUpdateFlag;
  102355. private _projectionUpdateFlag;
  102356. /** @hidden */
  102357. _toBeDisposed: Nullable<IDisposable>[];
  102358. private _activeRequests;
  102359. /** @hidden */
  102360. _pendingData: any[];
  102361. private _isDisposed;
  102362. /**
  102363. * Gets or sets a boolean indicating that all submeshes of active meshes must be rendered
  102364. * Use this boolean to avoid computing frustum clipping on submeshes (This could help when you are CPU bound)
  102365. */
  102366. dispatchAllSubMeshesOfActiveMeshes: boolean;
  102367. private _activeMeshes;
  102368. private _processedMaterials;
  102369. private _renderTargets;
  102370. /** @hidden */
  102371. _activeParticleSystems: SmartArray<IParticleSystem>;
  102372. private _activeSkeletons;
  102373. private _softwareSkinnedMeshes;
  102374. private _renderingManager;
  102375. /** @hidden */
  102376. _activeAnimatables: Animatable[];
  102377. private _transformMatrix;
  102378. private _sceneUbo;
  102379. /** @hidden */
  102380. _viewMatrix: Matrix;
  102381. private _projectionMatrix;
  102382. /** @hidden */
  102383. _forcedViewPosition: Nullable<Vector3>;
  102384. /** @hidden */
  102385. _frustumPlanes: Plane[];
  102386. /**
  102387. * Gets the list of frustum planes (built from the active camera)
  102388. */
  102389. readonly frustumPlanes: Plane[];
  102390. /**
  102391. * Gets or sets a boolean indicating if lights must be sorted by priority (off by default)
  102392. * This is useful if there are more lights that the maximum simulteanous authorized
  102393. */
  102394. requireLightSorting: boolean;
  102395. /** @hidden */
  102396. readonly useMaterialMeshMap: boolean;
  102397. /** @hidden */
  102398. readonly useClonedMeshhMap: boolean;
  102399. private _externalData;
  102400. private _uid;
  102401. /**
  102402. * @hidden
  102403. * Backing store of defined scene components.
  102404. */
  102405. _components: ISceneComponent[];
  102406. /**
  102407. * @hidden
  102408. * Backing store of defined scene components.
  102409. */
  102410. _serializableComponents: ISceneSerializableComponent[];
  102411. /**
  102412. * List of components to register on the next registration step.
  102413. */
  102414. private _transientComponents;
  102415. /**
  102416. * Registers the transient components if needed.
  102417. */
  102418. private _registerTransientComponents;
  102419. /**
  102420. * @hidden
  102421. * Add a component to the scene.
  102422. * Note that the ccomponent could be registered on th next frame if this is called after
  102423. * the register component stage.
  102424. * @param component Defines the component to add to the scene
  102425. */
  102426. _addComponent(component: ISceneComponent): void;
  102427. /**
  102428. * @hidden
  102429. * Gets a component from the scene.
  102430. * @param name defines the name of the component to retrieve
  102431. * @returns the component or null if not present
  102432. */
  102433. _getComponent(name: string): Nullable<ISceneComponent>;
  102434. /**
  102435. * @hidden
  102436. * Defines the actions happening before camera updates.
  102437. */
  102438. _beforeCameraUpdateStage: Stage<SimpleStageAction>;
  102439. /**
  102440. * @hidden
  102441. * Defines the actions happening before clear the canvas.
  102442. */
  102443. _beforeClearStage: Stage<SimpleStageAction>;
  102444. /**
  102445. * @hidden
  102446. * Defines the actions when collecting render targets for the frame.
  102447. */
  102448. _gatherRenderTargetsStage: Stage<RenderTargetsStageAction>;
  102449. /**
  102450. * @hidden
  102451. * Defines the actions happening for one camera in the frame.
  102452. */
  102453. _gatherActiveCameraRenderTargetsStage: Stage<RenderTargetsStageAction>;
  102454. /**
  102455. * @hidden
  102456. * Defines the actions happening during the per mesh ready checks.
  102457. */
  102458. _isReadyForMeshStage: Stage<MeshStageAction>;
  102459. /**
  102460. * @hidden
  102461. * Defines the actions happening before evaluate active mesh checks.
  102462. */
  102463. _beforeEvaluateActiveMeshStage: Stage<SimpleStageAction>;
  102464. /**
  102465. * @hidden
  102466. * Defines the actions happening during the evaluate sub mesh checks.
  102467. */
  102468. _evaluateSubMeshStage: Stage<EvaluateSubMeshStageAction>;
  102469. /**
  102470. * @hidden
  102471. * Defines the actions happening during the active mesh stage.
  102472. */
  102473. _activeMeshStage: Stage<ActiveMeshStageAction>;
  102474. /**
  102475. * @hidden
  102476. * Defines the actions happening during the per camera render target step.
  102477. */
  102478. _cameraDrawRenderTargetStage: Stage<CameraStageFrameBufferAction>;
  102479. /**
  102480. * @hidden
  102481. * Defines the actions happening just before the active camera is drawing.
  102482. */
  102483. _beforeCameraDrawStage: Stage<CameraStageAction>;
  102484. /**
  102485. * @hidden
  102486. * Defines the actions happening just before a render target is drawing.
  102487. */
  102488. _beforeRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  102489. /**
  102490. * @hidden
  102491. * Defines the actions happening just before a rendering group is drawing.
  102492. */
  102493. _beforeRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  102494. /**
  102495. * @hidden
  102496. * Defines the actions happening just before a mesh is drawing.
  102497. */
  102498. _beforeRenderingMeshStage: Stage<RenderingMeshStageAction>;
  102499. /**
  102500. * @hidden
  102501. * Defines the actions happening just after a mesh has been drawn.
  102502. */
  102503. _afterRenderingMeshStage: Stage<RenderingMeshStageAction>;
  102504. /**
  102505. * @hidden
  102506. * Defines the actions happening just after a rendering group has been drawn.
  102507. */
  102508. _afterRenderingGroupDrawStage: Stage<RenderingGroupStageAction>;
  102509. /**
  102510. * @hidden
  102511. * Defines the actions happening just after the active camera has been drawn.
  102512. */
  102513. _afterCameraDrawStage: Stage<CameraStageAction>;
  102514. /**
  102515. * @hidden
  102516. * Defines the actions happening just after a render target has been drawn.
  102517. */
  102518. _afterRenderTargetDrawStage: Stage<RenderTargetStageAction>;
  102519. /**
  102520. * @hidden
  102521. * Defines the actions happening just after rendering all cameras and computing intersections.
  102522. */
  102523. _afterRenderStage: Stage<SimpleStageAction>;
  102524. /**
  102525. * @hidden
  102526. * Defines the actions happening when a pointer move event happens.
  102527. */
  102528. _pointerMoveStage: Stage<PointerMoveStageAction>;
  102529. /**
  102530. * @hidden
  102531. * Defines the actions happening when a pointer down event happens.
  102532. */
  102533. _pointerDownStage: Stage<PointerUpDownStageAction>;
  102534. /**
  102535. * @hidden
  102536. * Defines the actions happening when a pointer up event happens.
  102537. */
  102538. _pointerUpStage: Stage<PointerUpDownStageAction>;
  102539. /**
  102540. * an optional map from Geometry Id to Geometry index in the 'geometries' array
  102541. */
  102542. private geometriesByUniqueId;
  102543. /**
  102544. * Creates a new Scene
  102545. * @param engine defines the engine to use to render this scene
  102546. * @param options defines the scene options
  102547. */
  102548. constructor(engine: Engine, options?: SceneOptions);
  102549. /**
  102550. * Gets a string idenfifying the name of the class
  102551. * @returns "Scene" string
  102552. */
  102553. getClassName(): string;
  102554. private _defaultMeshCandidates;
  102555. /**
  102556. * @hidden
  102557. */
  102558. _getDefaultMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  102559. private _defaultSubMeshCandidates;
  102560. /**
  102561. * @hidden
  102562. */
  102563. _getDefaultSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  102564. /**
  102565. * Sets the default candidate providers for the scene.
  102566. * This sets the getActiveMeshCandidates, getActiveSubMeshCandidates, getIntersectingSubMeshCandidates
  102567. * and getCollidingSubMeshCandidates to their default function
  102568. */
  102569. setDefaultCandidateProviders(): void;
  102570. /**
  102571. * Gets the mesh that is currently under the pointer
  102572. */
  102573. readonly meshUnderPointer: Nullable<AbstractMesh>;
  102574. /**
  102575. * Gets or sets the current on-screen X position of the pointer
  102576. */
  102577. pointerX: number;
  102578. /**
  102579. * Gets or sets the current on-screen Y position of the pointer
  102580. */
  102581. pointerY: number;
  102582. /**
  102583. * Gets the cached material (ie. the latest rendered one)
  102584. * @returns the cached material
  102585. */
  102586. getCachedMaterial(): Nullable<Material>;
  102587. /**
  102588. * Gets the cached effect (ie. the latest rendered one)
  102589. * @returns the cached effect
  102590. */
  102591. getCachedEffect(): Nullable<Effect>;
  102592. /**
  102593. * Gets the cached visibility state (ie. the latest rendered one)
  102594. * @returns the cached visibility state
  102595. */
  102596. getCachedVisibility(): Nullable<number>;
  102597. /**
  102598. * Gets a boolean indicating if the current material / effect / visibility must be bind again
  102599. * @param material defines the current material
  102600. * @param effect defines the current effect
  102601. * @param visibility defines the current visibility state
  102602. * @returns true if one parameter is not cached
  102603. */
  102604. isCachedMaterialInvalid(material: Material, effect: Effect, visibility?: number): boolean;
  102605. /**
  102606. * Gets the engine associated with the scene
  102607. * @returns an Engine
  102608. */
  102609. getEngine(): Engine;
  102610. /**
  102611. * Gets the total number of vertices rendered per frame
  102612. * @returns the total number of vertices rendered per frame
  102613. */
  102614. getTotalVertices(): number;
  102615. /**
  102616. * Gets the performance counter for total vertices
  102617. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  102618. */
  102619. readonly totalVerticesPerfCounter: PerfCounter;
  102620. /**
  102621. * Gets the total number of active indices rendered per frame (You can deduce the number of rendered triangles by dividing this number by 3)
  102622. * @returns the total number of active indices rendered per frame
  102623. */
  102624. getActiveIndices(): number;
  102625. /**
  102626. * Gets the performance counter for active indices
  102627. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  102628. */
  102629. readonly totalActiveIndicesPerfCounter: PerfCounter;
  102630. /**
  102631. * Gets the total number of active particles rendered per frame
  102632. * @returns the total number of active particles rendered per frame
  102633. */
  102634. getActiveParticles(): number;
  102635. /**
  102636. * Gets the performance counter for active particles
  102637. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  102638. */
  102639. readonly activeParticlesPerfCounter: PerfCounter;
  102640. /**
  102641. * Gets the total number of active bones rendered per frame
  102642. * @returns the total number of active bones rendered per frame
  102643. */
  102644. getActiveBones(): number;
  102645. /**
  102646. * Gets the performance counter for active bones
  102647. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#instrumentation
  102648. */
  102649. readonly activeBonesPerfCounter: PerfCounter;
  102650. /**
  102651. * Gets the array of active meshes
  102652. * @returns an array of AbstractMesh
  102653. */
  102654. getActiveMeshes(): SmartArray<AbstractMesh>;
  102655. /**
  102656. * Gets the animation ratio (which is 1.0 is the scene renders at 60fps and 2 if the scene renders at 30fps, etc.)
  102657. * @returns a number
  102658. */
  102659. getAnimationRatio(): number;
  102660. /**
  102661. * Gets an unique Id for the current render phase
  102662. * @returns a number
  102663. */
  102664. getRenderId(): number;
  102665. /**
  102666. * Gets an unique Id for the current frame
  102667. * @returns a number
  102668. */
  102669. getFrameId(): number;
  102670. /** Call this function if you want to manually increment the render Id*/
  102671. incrementRenderId(): void;
  102672. private _createUbo;
  102673. /**
  102674. * Use this method to simulate a pointer move on a mesh
  102675. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  102676. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  102677. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  102678. * @returns the current scene
  102679. */
  102680. simulatePointerMove(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  102681. /**
  102682. * Use this method to simulate a pointer down on a mesh
  102683. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  102684. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  102685. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  102686. * @returns the current scene
  102687. */
  102688. simulatePointerDown(pickResult: PickingInfo, pointerEventInit?: PointerEventInit): Scene;
  102689. /**
  102690. * Use this method to simulate a pointer up on a mesh
  102691. * The pickResult parameter can be obtained from a scene.pick or scene.pickWithRay
  102692. * @param pickResult pickingInfo of the object wished to simulate pointer event on
  102693. * @param pointerEventInit pointer event state to be used when simulating the pointer event (eg. pointer id for multitouch)
  102694. * @param doubleTap indicates that the pointer up event should be considered as part of a double click (false by default)
  102695. * @returns the current scene
  102696. */
  102697. simulatePointerUp(pickResult: PickingInfo, pointerEventInit?: PointerEventInit, doubleTap?: boolean): Scene;
  102698. /**
  102699. * Gets a boolean indicating if the current pointer event is captured (meaning that the scene has already handled the pointer down)
  102700. * @param pointerId defines the pointer id to use in a multi-touch scenario (0 by default)
  102701. * @returns true if the pointer was captured
  102702. */
  102703. isPointerCaptured(pointerId?: number): boolean;
  102704. /**
  102705. * Attach events to the canvas (To handle actionManagers triggers and raise onPointerMove, onPointerDown and onPointerUp
  102706. * @param attachUp defines if you want to attach events to pointerup
  102707. * @param attachDown defines if you want to attach events to pointerdown
  102708. * @param attachMove defines if you want to attach events to pointermove
  102709. */
  102710. attachControl(attachUp?: boolean, attachDown?: boolean, attachMove?: boolean): void;
  102711. /** Detaches all event handlers*/
  102712. detachControl(): void;
  102713. /**
  102714. * This function will check if the scene can be rendered (textures are loaded, shaders are compiled)
  102715. * Delay loaded resources are not taking in account
  102716. * @return true if all required resources are ready
  102717. */
  102718. isReady(): boolean;
  102719. /** Resets all cached information relative to material (including effect and visibility) */
  102720. resetCachedMaterial(): void;
  102721. /**
  102722. * Registers a function to be called before every frame render
  102723. * @param func defines the function to register
  102724. */
  102725. registerBeforeRender(func: () => void): void;
  102726. /**
  102727. * Unregisters a function called before every frame render
  102728. * @param func defines the function to unregister
  102729. */
  102730. unregisterBeforeRender(func: () => void): void;
  102731. /**
  102732. * Registers a function to be called after every frame render
  102733. * @param func defines the function to register
  102734. */
  102735. registerAfterRender(func: () => void): void;
  102736. /**
  102737. * Unregisters a function called after every frame render
  102738. * @param func defines the function to unregister
  102739. */
  102740. unregisterAfterRender(func: () => void): void;
  102741. private _executeOnceBeforeRender;
  102742. /**
  102743. * The provided function will run before render once and will be disposed afterwards.
  102744. * A timeout delay can be provided so that the function will be executed in N ms.
  102745. * The timeout is using the browser's native setTimeout so time percision cannot be guaranteed.
  102746. * @param func The function to be executed.
  102747. * @param timeout optional delay in ms
  102748. */
  102749. executeOnceBeforeRender(func: () => void, timeout?: number): void;
  102750. /** @hidden */
  102751. _addPendingData(data: any): void;
  102752. /** @hidden */
  102753. _removePendingData(data: any): void;
  102754. /**
  102755. * Returns the number of items waiting to be loaded
  102756. * @returns the number of items waiting to be loaded
  102757. */
  102758. getWaitingItemsCount(): number;
  102759. /**
  102760. * Returns a boolean indicating if the scene is still loading data
  102761. */
  102762. readonly isLoading: boolean;
  102763. /**
  102764. * Registers a function to be executed when the scene is ready
  102765. * @param {Function} func - the function to be executed
  102766. */
  102767. executeWhenReady(func: () => void): void;
  102768. /**
  102769. * Returns a promise that resolves when the scene is ready
  102770. * @returns A promise that resolves when the scene is ready
  102771. */
  102772. whenReadyAsync(): Promise<void>;
  102773. /** @hidden */
  102774. _checkIsReady(): void;
  102775. /**
  102776. * Gets all animatable attached to the scene
  102777. */
  102778. readonly animatables: Animatable[];
  102779. /**
  102780. * Resets the last animation time frame.
  102781. * Useful to override when animations start running when loading a scene for the first time.
  102782. */
  102783. resetLastAnimationTimeFrame(): void;
  102784. /**
  102785. * Gets the current view matrix
  102786. * @returns a Matrix
  102787. */
  102788. getViewMatrix(): Matrix;
  102789. /**
  102790. * Gets the current projection matrix
  102791. * @returns a Matrix
  102792. */
  102793. getProjectionMatrix(): Matrix;
  102794. /**
  102795. * Gets the current transform matrix
  102796. * @returns a Matrix made of View * Projection
  102797. */
  102798. getTransformMatrix(): Matrix;
  102799. /**
  102800. * Sets the current transform matrix
  102801. * @param viewL defines the View matrix to use
  102802. * @param projectionL defines the Projection matrix to use
  102803. * @param viewR defines the right View matrix to use (if provided)
  102804. * @param projectionR defines the right Projection matrix to use (if provided)
  102805. */
  102806. setTransformMatrix(viewL: Matrix, projectionL: Matrix, viewR?: Matrix, projectionR?: Matrix): void;
  102807. /**
  102808. * Gets the uniform buffer used to store scene data
  102809. * @returns a UniformBuffer
  102810. */
  102811. getSceneUniformBuffer(): UniformBuffer;
  102812. /**
  102813. * Gets an unique (relatively to the current scene) Id
  102814. * @returns an unique number for the scene
  102815. */
  102816. getUniqueId(): number;
  102817. /**
  102818. * Add a mesh to the list of scene's meshes
  102819. * @param newMesh defines the mesh to add
  102820. * @param recursive if all child meshes should also be added to the scene
  102821. */
  102822. addMesh(newMesh: AbstractMesh, recursive?: boolean): void;
  102823. /**
  102824. * Remove a mesh for the list of scene's meshes
  102825. * @param toRemove defines the mesh to remove
  102826. * @param recursive if all child meshes should also be removed from the scene
  102827. * @returns the index where the mesh was in the mesh list
  102828. */
  102829. removeMesh(toRemove: AbstractMesh, recursive?: boolean): number;
  102830. /**
  102831. * Add a transform node to the list of scene's transform nodes
  102832. * @param newTransformNode defines the transform node to add
  102833. */
  102834. addTransformNode(newTransformNode: TransformNode): void;
  102835. /**
  102836. * Remove a transform node for the list of scene's transform nodes
  102837. * @param toRemove defines the transform node to remove
  102838. * @returns the index where the transform node was in the transform node list
  102839. */
  102840. removeTransformNode(toRemove: TransformNode): number;
  102841. /**
  102842. * Remove a skeleton for the list of scene's skeletons
  102843. * @param toRemove defines the skeleton to remove
  102844. * @returns the index where the skeleton was in the skeleton list
  102845. */
  102846. removeSkeleton(toRemove: Skeleton): number;
  102847. /**
  102848. * Remove a morph target for the list of scene's morph targets
  102849. * @param toRemove defines the morph target to remove
  102850. * @returns the index where the morph target was in the morph target list
  102851. */
  102852. removeMorphTargetManager(toRemove: MorphTargetManager): number;
  102853. /**
  102854. * Remove a light for the list of scene's lights
  102855. * @param toRemove defines the light to remove
  102856. * @returns the index where the light was in the light list
  102857. */
  102858. removeLight(toRemove: Light): number;
  102859. /**
  102860. * Remove a camera for the list of scene's cameras
  102861. * @param toRemove defines the camera to remove
  102862. * @returns the index where the camera was in the camera list
  102863. */
  102864. removeCamera(toRemove: Camera): number;
  102865. /**
  102866. * Remove a particle system for the list of scene's particle systems
  102867. * @param toRemove defines the particle system to remove
  102868. * @returns the index where the particle system was in the particle system list
  102869. */
  102870. removeParticleSystem(toRemove: IParticleSystem): number;
  102871. /**
  102872. * Remove a animation for the list of scene's animations
  102873. * @param toRemove defines the animation to remove
  102874. * @returns the index where the animation was in the animation list
  102875. */
  102876. removeAnimation(toRemove: Animation): number;
  102877. /**
  102878. * Will stop the animation of the given target
  102879. * @param target - the target
  102880. * @param animationName - the name of the animation to stop (all animations will be stopped if both this and targetMask are empty)
  102881. * @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)
  102882. */
  102883. stopAnimation(target: any, animationName?: string, targetMask?: (target: any) => boolean): void;
  102884. /**
  102885. * Removes the given animation group from this scene.
  102886. * @param toRemove The animation group to remove
  102887. * @returns The index of the removed animation group
  102888. */
  102889. removeAnimationGroup(toRemove: AnimationGroup): number;
  102890. /**
  102891. * Removes the given multi-material from this scene.
  102892. * @param toRemove The multi-material to remove
  102893. * @returns The index of the removed multi-material
  102894. */
  102895. removeMultiMaterial(toRemove: MultiMaterial): number;
  102896. /**
  102897. * Removes the given material from this scene.
  102898. * @param toRemove The material to remove
  102899. * @returns The index of the removed material
  102900. */
  102901. removeMaterial(toRemove: Material): number;
  102902. /**
  102903. * Removes the given action manager from this scene.
  102904. * @param toRemove The action manager to remove
  102905. * @returns The index of the removed action manager
  102906. */
  102907. removeActionManager(toRemove: AbstractActionManager): number;
  102908. /**
  102909. * Removes the given texture from this scene.
  102910. * @param toRemove The texture to remove
  102911. * @returns The index of the removed texture
  102912. */
  102913. removeTexture(toRemove: BaseTexture): number;
  102914. /**
  102915. * Adds the given light to this scene
  102916. * @param newLight The light to add
  102917. */
  102918. addLight(newLight: Light): void;
  102919. /**
  102920. * Sorts the list list based on light priorities
  102921. */
  102922. sortLightsByPriority(): void;
  102923. /**
  102924. * Adds the given camera to this scene
  102925. * @param newCamera The camera to add
  102926. */
  102927. addCamera(newCamera: Camera): void;
  102928. /**
  102929. * Adds the given skeleton to this scene
  102930. * @param newSkeleton The skeleton to add
  102931. */
  102932. addSkeleton(newSkeleton: Skeleton): void;
  102933. /**
  102934. * Adds the given particle system to this scene
  102935. * @param newParticleSystem The particle system to add
  102936. */
  102937. addParticleSystem(newParticleSystem: IParticleSystem): void;
  102938. /**
  102939. * Adds the given animation to this scene
  102940. * @param newAnimation The animation to add
  102941. */
  102942. addAnimation(newAnimation: Animation): void;
  102943. /**
  102944. * Adds the given animation group to this scene.
  102945. * @param newAnimationGroup The animation group to add
  102946. */
  102947. addAnimationGroup(newAnimationGroup: AnimationGroup): void;
  102948. /**
  102949. * Adds the given multi-material to this scene
  102950. * @param newMultiMaterial The multi-material to add
  102951. */
  102952. addMultiMaterial(newMultiMaterial: MultiMaterial): void;
  102953. /**
  102954. * Adds the given material to this scene
  102955. * @param newMaterial The material to add
  102956. */
  102957. addMaterial(newMaterial: Material): void;
  102958. /**
  102959. * Adds the given morph target to this scene
  102960. * @param newMorphTargetManager The morph target to add
  102961. */
  102962. addMorphTargetManager(newMorphTargetManager: MorphTargetManager): void;
  102963. /**
  102964. * Adds the given geometry to this scene
  102965. * @param newGeometry The geometry to add
  102966. */
  102967. addGeometry(newGeometry: Geometry): void;
  102968. /**
  102969. * Adds the given action manager to this scene
  102970. * @param newActionManager The action manager to add
  102971. */
  102972. addActionManager(newActionManager: AbstractActionManager): void;
  102973. /**
  102974. * Adds the given texture to this scene.
  102975. * @param newTexture The texture to add
  102976. */
  102977. addTexture(newTexture: BaseTexture): void;
  102978. /**
  102979. * Switch active camera
  102980. * @param newCamera defines the new active camera
  102981. * @param attachControl defines if attachControl must be called for the new active camera (default: true)
  102982. */
  102983. switchActiveCamera(newCamera: Camera, attachControl?: boolean): void;
  102984. /**
  102985. * sets the active camera of the scene using its ID
  102986. * @param id defines the camera's ID
  102987. * @return the new active camera or null if none found.
  102988. */
  102989. setActiveCameraByID(id: string): Nullable<Camera>;
  102990. /**
  102991. * sets the active camera of the scene using its name
  102992. * @param name defines the camera's name
  102993. * @returns the new active camera or null if none found.
  102994. */
  102995. setActiveCameraByName(name: string): Nullable<Camera>;
  102996. /**
  102997. * get an animation group using its name
  102998. * @param name defines the material's name
  102999. * @return the animation group or null if none found.
  103000. */
  103001. getAnimationGroupByName(name: string): Nullable<AnimationGroup>;
  103002. /**
  103003. * Get a material using its unique id
  103004. * @param uniqueId defines the material's unique id
  103005. * @return the material or null if none found.
  103006. */
  103007. getMaterialByUniqueID(uniqueId: number): Nullable<Material>;
  103008. /**
  103009. * get a material using its id
  103010. * @param id defines the material's ID
  103011. * @return the material or null if none found.
  103012. */
  103013. getMaterialByID(id: string): Nullable<Material>;
  103014. /**
  103015. * Gets a the last added material using a given id
  103016. * @param id defines the material's ID
  103017. * @return the last material with the given id or null if none found.
  103018. */
  103019. getLastMaterialByID(id: string): Nullable<Material>;
  103020. /**
  103021. * Gets a material using its name
  103022. * @param name defines the material's name
  103023. * @return the material or null if none found.
  103024. */
  103025. getMaterialByName(name: string): Nullable<Material>;
  103026. /**
  103027. * Get a texture using its unique id
  103028. * @param uniqueId defines the texture's unique id
  103029. * @return the texture or null if none found.
  103030. */
  103031. getTextureByUniqueID(uniqueId: number): Nullable<BaseTexture>;
  103032. /**
  103033. * Gets a camera using its id
  103034. * @param id defines the id to look for
  103035. * @returns the camera or null if not found
  103036. */
  103037. getCameraByID(id: string): Nullable<Camera>;
  103038. /**
  103039. * Gets a camera using its unique id
  103040. * @param uniqueId defines the unique id to look for
  103041. * @returns the camera or null if not found
  103042. */
  103043. getCameraByUniqueID(uniqueId: number): Nullable<Camera>;
  103044. /**
  103045. * Gets a camera using its name
  103046. * @param name defines the camera's name
  103047. * @return the camera or null if none found.
  103048. */
  103049. getCameraByName(name: string): Nullable<Camera>;
  103050. /**
  103051. * Gets a bone using its id
  103052. * @param id defines the bone's id
  103053. * @return the bone or null if not found
  103054. */
  103055. getBoneByID(id: string): Nullable<Bone>;
  103056. /**
  103057. * Gets a bone using its id
  103058. * @param name defines the bone's name
  103059. * @return the bone or null if not found
  103060. */
  103061. getBoneByName(name: string): Nullable<Bone>;
  103062. /**
  103063. * Gets a light node using its name
  103064. * @param name defines the the light's name
  103065. * @return the light or null if none found.
  103066. */
  103067. getLightByName(name: string): Nullable<Light>;
  103068. /**
  103069. * Gets a light node using its id
  103070. * @param id defines the light's id
  103071. * @return the light or null if none found.
  103072. */
  103073. getLightByID(id: string): Nullable<Light>;
  103074. /**
  103075. * Gets a light node using its scene-generated unique ID
  103076. * @param uniqueId defines the light's unique id
  103077. * @return the light or null if none found.
  103078. */
  103079. getLightByUniqueID(uniqueId: number): Nullable<Light>;
  103080. /**
  103081. * Gets a particle system by id
  103082. * @param id defines the particle system id
  103083. * @return the corresponding system or null if none found
  103084. */
  103085. getParticleSystemByID(id: string): Nullable<IParticleSystem>;
  103086. /**
  103087. * Gets a geometry using its ID
  103088. * @param id defines the geometry's id
  103089. * @return the geometry or null if none found.
  103090. */
  103091. getGeometryByID(id: string): Nullable<Geometry>;
  103092. private _getGeometryByUniqueID;
  103093. /**
  103094. * Add a new geometry to this scene
  103095. * @param geometry defines the geometry to be added to the scene.
  103096. * @param force defines if the geometry must be pushed even if a geometry with this id already exists
  103097. * @return a boolean defining if the geometry was added or not
  103098. */
  103099. pushGeometry(geometry: Geometry, force?: boolean): boolean;
  103100. /**
  103101. * Removes an existing geometry
  103102. * @param geometry defines the geometry to be removed from the scene
  103103. * @return a boolean defining if the geometry was removed or not
  103104. */
  103105. removeGeometry(geometry: Geometry): boolean;
  103106. /**
  103107. * Gets the list of geometries attached to the scene
  103108. * @returns an array of Geometry
  103109. */
  103110. getGeometries(): Geometry[];
  103111. /**
  103112. * Gets the first added mesh found of a given ID
  103113. * @param id defines the id to search for
  103114. * @return the mesh found or null if not found at all
  103115. */
  103116. getMeshByID(id: string): Nullable<AbstractMesh>;
  103117. /**
  103118. * Gets a list of meshes using their id
  103119. * @param id defines the id to search for
  103120. * @returns a list of meshes
  103121. */
  103122. getMeshesByID(id: string): Array<AbstractMesh>;
  103123. /**
  103124. * Gets the first added transform node found of a given ID
  103125. * @param id defines the id to search for
  103126. * @return the found transform node or null if not found at all.
  103127. */
  103128. getTransformNodeByID(id: string): Nullable<TransformNode>;
  103129. /**
  103130. * Gets a transform node with its auto-generated unique id
  103131. * @param uniqueId efines the unique id to search for
  103132. * @return the found transform node or null if not found at all.
  103133. */
  103134. getTransformNodeByUniqueID(uniqueId: number): Nullable<TransformNode>;
  103135. /**
  103136. * Gets a list of transform nodes using their id
  103137. * @param id defines the id to search for
  103138. * @returns a list of transform nodes
  103139. */
  103140. getTransformNodesByID(id: string): Array<TransformNode>;
  103141. /**
  103142. * Gets a mesh with its auto-generated unique id
  103143. * @param uniqueId defines the unique id to search for
  103144. * @return the found mesh or null if not found at all.
  103145. */
  103146. getMeshByUniqueID(uniqueId: number): Nullable<AbstractMesh>;
  103147. /**
  103148. * Gets a the last added mesh using a given id
  103149. * @param id defines the id to search for
  103150. * @return the found mesh or null if not found at all.
  103151. */
  103152. getLastMeshByID(id: string): Nullable<AbstractMesh>;
  103153. /**
  103154. * Gets a the last added node (Mesh, Camera, Light) using a given id
  103155. * @param id defines the id to search for
  103156. * @return the found node or null if not found at all
  103157. */
  103158. getLastEntryByID(id: string): Nullable<Node>;
  103159. /**
  103160. * Gets a node (Mesh, Camera, Light) using a given id
  103161. * @param id defines the id to search for
  103162. * @return the found node or null if not found at all
  103163. */
  103164. getNodeByID(id: string): Nullable<Node>;
  103165. /**
  103166. * Gets a node (Mesh, Camera, Light) using a given name
  103167. * @param name defines the name to search for
  103168. * @return the found node or null if not found at all.
  103169. */
  103170. getNodeByName(name: string): Nullable<Node>;
  103171. /**
  103172. * Gets a mesh using a given name
  103173. * @param name defines the name to search for
  103174. * @return the found mesh or null if not found at all.
  103175. */
  103176. getMeshByName(name: string): Nullable<AbstractMesh>;
  103177. /**
  103178. * Gets a transform node using a given name
  103179. * @param name defines the name to search for
  103180. * @return the found transform node or null if not found at all.
  103181. */
  103182. getTransformNodeByName(name: string): Nullable<TransformNode>;
  103183. /**
  103184. * Gets a skeleton using a given id (if many are found, this function will pick the last one)
  103185. * @param id defines the id to search for
  103186. * @return the found skeleton or null if not found at all.
  103187. */
  103188. getLastSkeletonByID(id: string): Nullable<Skeleton>;
  103189. /**
  103190. * Gets a skeleton using a given auto generated unique id
  103191. * @param uniqueId defines the unique id to search for
  103192. * @return the found skeleton or null if not found at all.
  103193. */
  103194. getSkeletonByUniqueId(uniqueId: number): Nullable<Skeleton>;
  103195. /**
  103196. * Gets a skeleton using a given id (if many are found, this function will pick the first one)
  103197. * @param id defines the id to search for
  103198. * @return the found skeleton or null if not found at all.
  103199. */
  103200. getSkeletonById(id: string): Nullable<Skeleton>;
  103201. /**
  103202. * Gets a skeleton using a given name
  103203. * @param name defines the name to search for
  103204. * @return the found skeleton or null if not found at all.
  103205. */
  103206. getSkeletonByName(name: string): Nullable<Skeleton>;
  103207. /**
  103208. * Gets a morph target manager using a given id (if many are found, this function will pick the last one)
  103209. * @param id defines the id to search for
  103210. * @return the found morph target manager or null if not found at all.
  103211. */
  103212. getMorphTargetManagerById(id: number): Nullable<MorphTargetManager>;
  103213. /**
  103214. * Gets a morph target using a given id (if many are found, this function will pick the first one)
  103215. * @param id defines the id to search for
  103216. * @return the found morph target or null if not found at all.
  103217. */
  103218. getMorphTargetById(id: string): Nullable<MorphTarget>;
  103219. /**
  103220. * Gets a boolean indicating if the given mesh is active
  103221. * @param mesh defines the mesh to look for
  103222. * @returns true if the mesh is in the active list
  103223. */
  103224. isActiveMesh(mesh: AbstractMesh): boolean;
  103225. /**
  103226. * Return a unique id as a string which can serve as an identifier for the scene
  103227. */
  103228. readonly uid: string;
  103229. /**
  103230. * Add an externaly attached data from its key.
  103231. * This method call will fail and return false, if such key already exists.
  103232. * If you don't care and just want to get the data no matter what, use the more convenient getOrAddExternalDataWithFactory() method.
  103233. * @param key the unique key that identifies the data
  103234. * @param data the data object to associate to the key for this Engine instance
  103235. * @return true if no such key were already present and the data was added successfully, false otherwise
  103236. */
  103237. addExternalData<T>(key: string, data: T): boolean;
  103238. /**
  103239. * Get an externaly attached data from its key
  103240. * @param key the unique key that identifies the data
  103241. * @return the associated data, if present (can be null), or undefined if not present
  103242. */
  103243. getExternalData<T>(key: string): Nullable<T>;
  103244. /**
  103245. * Get an externaly attached data from its key, create it using a factory if it's not already present
  103246. * @param key the unique key that identifies the data
  103247. * @param factory the factory that will be called to create the instance if and only if it doesn't exists
  103248. * @return the associated data, can be null if the factory returned null.
  103249. */
  103250. getOrAddExternalDataWithFactory<T>(key: string, factory: (k: string) => T): T;
  103251. /**
  103252. * Remove an externaly attached data from the Engine instance
  103253. * @param key the unique key that identifies the data
  103254. * @return true if the data was successfully removed, false if it doesn't exist
  103255. */
  103256. removeExternalData(key: string): boolean;
  103257. private _evaluateSubMesh;
  103258. /**
  103259. * Clear the processed materials smart array preventing retention point in material dispose.
  103260. */
  103261. freeProcessedMaterials(): void;
  103262. private _preventFreeActiveMeshesAndRenderingGroups;
  103263. /** Gets or sets a boolean blocking all the calls to freeActiveMeshes and freeRenderingGroups
  103264. * It can be used in order to prevent going through methods freeRenderingGroups and freeActiveMeshes several times to improve performance
  103265. * when disposing several meshes in a row or a hierarchy of meshes.
  103266. * When used, it is the responsability of the user to blockfreeActiveMeshesAndRenderingGroups back to false.
  103267. */
  103268. blockfreeActiveMeshesAndRenderingGroups: boolean;
  103269. /**
  103270. * Clear the active meshes smart array preventing retention point in mesh dispose.
  103271. */
  103272. freeActiveMeshes(): void;
  103273. /**
  103274. * Clear the info related to rendering groups preventing retention points during dispose.
  103275. */
  103276. freeRenderingGroups(): void;
  103277. /** @hidden */
  103278. _isInIntermediateRendering(): boolean;
  103279. /**
  103280. * Lambda returning the list of potentially active meshes.
  103281. */
  103282. getActiveMeshCandidates: () => ISmartArrayLike<AbstractMesh>;
  103283. /**
  103284. * Lambda returning the list of potentially active sub meshes.
  103285. */
  103286. getActiveSubMeshCandidates: (mesh: AbstractMesh) => ISmartArrayLike<SubMesh>;
  103287. /**
  103288. * Lambda returning the list of potentially intersecting sub meshes.
  103289. */
  103290. getIntersectingSubMeshCandidates: (mesh: AbstractMesh, localRay: Ray) => ISmartArrayLike<SubMesh>;
  103291. /**
  103292. * Lambda returning the list of potentially colliding sub meshes.
  103293. */
  103294. getCollidingSubMeshCandidates: (mesh: AbstractMesh, collider: Collider) => ISmartArrayLike<SubMesh>;
  103295. private _activeMeshesFrozen;
  103296. private _skipEvaluateActiveMeshesCompletely;
  103297. /**
  103298. * Use this function to stop evaluating active meshes. The current list will be keep alive between frames
  103299. * @param skipEvaluateActiveMeshes defines an optional boolean indicating that the evaluate active meshes step must be completely skipped
  103300. * @returns the current scene
  103301. */
  103302. freezeActiveMeshes(skipEvaluateActiveMeshes?: boolean): Scene;
  103303. /**
  103304. * Use this function to restart evaluating active meshes on every frame
  103305. * @returns the current scene
  103306. */
  103307. unfreezeActiveMeshes(): Scene;
  103308. private _evaluateActiveMeshes;
  103309. private _activeMesh;
  103310. /**
  103311. * Update the transform matrix to update from the current active camera
  103312. * @param force defines a boolean used to force the update even if cache is up to date
  103313. */
  103314. updateTransformMatrix(force?: boolean): void;
  103315. private _bindFrameBuffer;
  103316. /** @hidden */
  103317. _allowPostProcessClearColor: boolean;
  103318. /** @hidden */
  103319. _renderForCamera(camera: Camera, rigParent?: Camera): void;
  103320. private _processSubCameras;
  103321. private _checkIntersections;
  103322. /** @hidden */
  103323. _advancePhysicsEngineStep(step: number): void;
  103324. /**
  103325. * User updatable function that will return a deterministic frame time when engine is in deterministic lock step mode
  103326. */
  103327. getDeterministicFrameTime: () => number;
  103328. /** @hidden */
  103329. _animate(): void;
  103330. /** Execute all animations (for a frame) */
  103331. animate(): void;
  103332. /**
  103333. * Render the scene
  103334. * @param updateCameras defines a boolean indicating if cameras must update according to their inputs (true by default)
  103335. * @param ignoreAnimations defines a boolean indicating if animations should not be executed (false by default)
  103336. */
  103337. render(updateCameras?: boolean, ignoreAnimations?: boolean): void;
  103338. /**
  103339. * Freeze all materials
  103340. * A frozen material will not be updatable but should be faster to render
  103341. */
  103342. freezeMaterials(): void;
  103343. /**
  103344. * Unfreeze all materials
  103345. * A frozen material will not be updatable but should be faster to render
  103346. */
  103347. unfreezeMaterials(): void;
  103348. /**
  103349. * Releases all held ressources
  103350. */
  103351. dispose(): void;
  103352. /**
  103353. * Gets if the scene is already disposed
  103354. */
  103355. readonly isDisposed: boolean;
  103356. /**
  103357. * Call this function to reduce memory footprint of the scene.
  103358. * Vertex buffers will not store CPU data anymore (this will prevent picking, collisions or physics to work correctly)
  103359. */
  103360. clearCachedVertexData(): void;
  103361. /**
  103362. * This function will remove the local cached buffer data from texture.
  103363. * It will save memory but will prevent the texture from being rebuilt
  103364. */
  103365. cleanCachedTextureBuffer(): void;
  103366. /**
  103367. * Get the world extend vectors with an optional filter
  103368. *
  103369. * @param filterPredicate the predicate - which meshes should be included when calculating the world size
  103370. * @returns {{ min: Vector3; max: Vector3 }} min and max vectors
  103371. */
  103372. getWorldExtends(filterPredicate?: (mesh: AbstractMesh) => boolean): {
  103373. min: Vector3;
  103374. max: Vector3;
  103375. };
  103376. /**
  103377. * Creates a ray that can be used to pick in the scene
  103378. * @param x defines the x coordinate of the origin (on-screen)
  103379. * @param y defines the y coordinate of the origin (on-screen)
  103380. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  103381. * @param camera defines the camera to use for the picking
  103382. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  103383. * @returns a Ray
  103384. */
  103385. createPickingRay(x: number, y: number, world: Matrix, camera: Nullable<Camera>, cameraViewSpace?: boolean): Ray;
  103386. /**
  103387. * Creates a ray that can be used to pick in the scene
  103388. * @param x defines the x coordinate of the origin (on-screen)
  103389. * @param y defines the y coordinate of the origin (on-screen)
  103390. * @param world defines the world matrix to use if you want to pick in object space (instead of world space)
  103391. * @param result defines the ray where to store the picking ray
  103392. * @param camera defines the camera to use for the picking
  103393. * @param cameraViewSpace defines if picking will be done in view space (false by default)
  103394. * @returns the current scene
  103395. */
  103396. createPickingRayToRef(x: number, y: number, world: Matrix, result: Ray, camera: Nullable<Camera>, cameraViewSpace?: boolean): Scene;
  103397. /**
  103398. * Creates a ray that can be used to pick in the scene
  103399. * @param x defines the x coordinate of the origin (on-screen)
  103400. * @param y defines the y coordinate of the origin (on-screen)
  103401. * @param camera defines the camera to use for the picking
  103402. * @returns a Ray
  103403. */
  103404. createPickingRayInCameraSpace(x: number, y: number, camera?: Camera): Ray;
  103405. /**
  103406. * Creates a ray that can be used to pick in the scene
  103407. * @param x defines the x coordinate of the origin (on-screen)
  103408. * @param y defines the y coordinate of the origin (on-screen)
  103409. * @param result defines the ray where to store the picking ray
  103410. * @param camera defines the camera to use for the picking
  103411. * @returns the current scene
  103412. */
  103413. createPickingRayInCameraSpaceToRef(x: number, y: number, result: Ray, camera?: Camera): Scene;
  103414. /** Launch a ray to try to pick a mesh in the scene
  103415. * @param x position on screen
  103416. * @param y position on screen
  103417. * @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
  103418. * @param fastCheck Launch a fast check only using the bounding boxes. Can be set to null.
  103419. * @param camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  103420. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  103421. * @returns a PickingInfo
  103422. */
  103423. pick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, camera?: Nullable<Camera>, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  103424. /** Use the given ray to pick a mesh in the scene
  103425. * @param ray The ray to use to pick meshes
  103426. * @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
  103427. * @param fastCheck Launch a fast check only using the bounding boxes. Can be set to null
  103428. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  103429. * @returns a PickingInfo
  103430. */
  103431. pickWithRay(ray: Ray, predicate?: (mesh: AbstractMesh) => boolean, fastCheck?: boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo>;
  103432. /**
  103433. * Launch a ray to try to pick a mesh in the scene
  103434. * @param x X position on screen
  103435. * @param y Y position on screen
  103436. * @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
  103437. * @param camera camera to use for computing the picking ray. Can be set to null. In this case, the scene.activeCamera will be used
  103438. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  103439. * @returns an array of PickingInfo
  103440. */
  103441. multiPick(x: number, y: number, predicate?: (mesh: AbstractMesh) => boolean, camera?: Camera, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  103442. /**
  103443. * Launch a ray to try to pick a mesh in the scene
  103444. * @param ray Ray to use
  103445. * @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
  103446. * @param trianglePredicate defines an optional predicate used to select faces when a mesh intersection is detected
  103447. * @returns an array of PickingInfo
  103448. */
  103449. multiPickWithRay(ray: Ray, predicate: (mesh: AbstractMesh) => boolean, trianglePredicate?: TrianglePickingPredicate): Nullable<PickingInfo[]>;
  103450. /**
  103451. * Force the value of meshUnderPointer
  103452. * @param mesh defines the mesh to use
  103453. */
  103454. setPointerOverMesh(mesh: Nullable<AbstractMesh>): void;
  103455. /**
  103456. * Gets the mesh under the pointer
  103457. * @returns a Mesh or null if no mesh is under the pointer
  103458. */
  103459. getPointerOverMesh(): Nullable<AbstractMesh>;
  103460. /** @hidden */
  103461. _rebuildGeometries(): void;
  103462. /** @hidden */
  103463. _rebuildTextures(): void;
  103464. private _getByTags;
  103465. /**
  103466. * Get a list of meshes by tags
  103467. * @param tagsQuery defines the tags query to use
  103468. * @param forEach defines a predicate used to filter results
  103469. * @returns an array of Mesh
  103470. */
  103471. getMeshesByTags(tagsQuery: string, forEach?: (mesh: AbstractMesh) => void): Mesh[];
  103472. /**
  103473. * Get a list of cameras by tags
  103474. * @param tagsQuery defines the tags query to use
  103475. * @param forEach defines a predicate used to filter results
  103476. * @returns an array of Camera
  103477. */
  103478. getCamerasByTags(tagsQuery: string, forEach?: (camera: Camera) => void): Camera[];
  103479. /**
  103480. * Get a list of lights by tags
  103481. * @param tagsQuery defines the tags query to use
  103482. * @param forEach defines a predicate used to filter results
  103483. * @returns an array of Light
  103484. */
  103485. getLightsByTags(tagsQuery: string, forEach?: (light: Light) => void): Light[];
  103486. /**
  103487. * Get a list of materials by tags
  103488. * @param tagsQuery defines the tags query to use
  103489. * @param forEach defines a predicate used to filter results
  103490. * @returns an array of Material
  103491. */
  103492. getMaterialByTags(tagsQuery: string, forEach?: (material: Material) => void): Material[];
  103493. /**
  103494. * Overrides the default sort function applied in the renderging group to prepare the meshes.
  103495. * This allowed control for front to back rendering or reversly depending of the special needs.
  103496. *
  103497. * @param renderingGroupId The rendering group id corresponding to its index
  103498. * @param opaqueSortCompareFn The opaque queue comparison function use to sort.
  103499. * @param alphaTestSortCompareFn The alpha test queue comparison function use to sort.
  103500. * @param transparentSortCompareFn The transparent queue comparison function use to sort.
  103501. */
  103502. 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;
  103503. /**
  103504. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups.
  103505. *
  103506. * @param renderingGroupId The rendering group id corresponding to its index
  103507. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  103508. * @param depth Automatically clears depth between groups if true and autoClear is true.
  103509. * @param stencil Automatically clears stencil between groups if true and autoClear is true.
  103510. */
  103511. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean, depth?: boolean, stencil?: boolean): void;
  103512. /**
  103513. * Gets the current auto clear configuration for one rendering group of the rendering
  103514. * manager.
  103515. * @param index the rendering group index to get the information for
  103516. * @returns The auto clear setup for the requested rendering group
  103517. */
  103518. getAutoClearDepthStencilSetup(index: number): IRenderingManagerAutoClearSetup;
  103519. private _blockMaterialDirtyMechanism;
  103520. /** Gets or sets a boolean blocking all the calls to markAllMaterialsAsDirty (ie. the materials won't be updated if they are out of sync) */
  103521. blockMaterialDirtyMechanism: boolean;
  103522. /**
  103523. * Will flag all materials as dirty to trigger new shader compilation
  103524. * @param flag defines the flag used to specify which material part must be marked as dirty
  103525. * @param predicate If not null, it will be used to specifiy if a material has to be marked as dirty
  103526. */
  103527. markAllMaterialsAsDirty(flag: number, predicate?: (mat: Material) => boolean): void;
  103528. /** @hidden */
  103529. _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;
  103530. /** @hidden */
  103531. _loadFileAsync(url: string, onProgress?: (data: any) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  103532. /** @hidden */
  103533. _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;
  103534. /** @hidden */
  103535. _requestFileAsync(url: string, onProgress?: (ev: ProgressEvent) => void, useOfflineSupport?: boolean, useArrayBuffer?: boolean, onOpened?: (request: WebRequest) => void): Promise<string | ArrayBuffer>;
  103536. /** @hidden */
  103537. _readFile(file: File, onSuccess: (data: string | ArrayBuffer) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: ReadFileError) => void): IFileRequest;
  103538. /** @hidden */
  103539. _readFileAsync(file: File, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean): Promise<string | ArrayBuffer>;
  103540. }
  103541. }
  103542. declare module BABYLON {
  103543. /**
  103544. * Set of assets to keep when moving a scene into an asset container.
  103545. */
  103546. export class KeepAssets extends AbstractScene {
  103547. }
  103548. /**
  103549. * Class used to store the output of the AssetContainer.instantiateAllMeshesToScene function
  103550. */
  103551. export class InstantiatedEntries {
  103552. /**
  103553. * List of new root nodes (eg. nodes with no parent)
  103554. */
  103555. rootNodes: TransformNode[];
  103556. /**
  103557. * List of new skeletons
  103558. */
  103559. skeletons: Skeleton[];
  103560. /**
  103561. * List of new animation groups
  103562. */
  103563. animationGroups: AnimationGroup[];
  103564. }
  103565. /**
  103566. * Container with a set of assets that can be added or removed from a scene.
  103567. */
  103568. export class AssetContainer extends AbstractScene {
  103569. /**
  103570. * The scene the AssetContainer belongs to.
  103571. */
  103572. scene: Scene;
  103573. /**
  103574. * Instantiates an AssetContainer.
  103575. * @param scene The scene the AssetContainer belongs to.
  103576. */
  103577. constructor(scene: Scene);
  103578. /**
  103579. * Instantiate or clone all meshes and add the new ones to the scene.
  103580. * Skeletons and animation groups will all be cloned
  103581. * @param nameFunction defines an optional function used to get new names for clones
  103582. * @param cloneMaterials defines an optional boolean that defines if materials must be cloned as well (false by default)
  103583. * @returns a list of rootNodes, skeletons and aniamtion groups that were duplicated
  103584. */
  103585. instantiateModelsToScene(nameFunction?: (sourceName: string) => string, cloneMaterials?: boolean): InstantiatedEntries;
  103586. /**
  103587. * Adds all the assets from the container to the scene.
  103588. */
  103589. addAllToScene(): void;
  103590. /**
  103591. * Removes all the assets in the container from the scene
  103592. */
  103593. removeAllFromScene(): void;
  103594. /**
  103595. * Disposes all the assets in the container
  103596. */
  103597. dispose(): void;
  103598. private _moveAssets;
  103599. /**
  103600. * Removes all the assets contained in the scene and adds them to the container.
  103601. * @param keepAssets Set of assets to keep in the scene. (default: empty)
  103602. */
  103603. moveAllFromScene(keepAssets?: KeepAssets): void;
  103604. /**
  103605. * 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.
  103606. * @returns the root mesh
  103607. */
  103608. createRootMesh(): Mesh;
  103609. }
  103610. }
  103611. declare module BABYLON {
  103612. /**
  103613. * Defines how the parser contract is defined.
  103614. * These parsers are used to parse a list of specific assets (like particle systems, etc..)
  103615. */
  103616. export type BabylonFileParser = (parsedData: any, scene: Scene, container: AssetContainer, rootUrl: string) => void;
  103617. /**
  103618. * Defines how the individual parser contract is defined.
  103619. * These parser can parse an individual asset
  103620. */
  103621. export type IndividualBabylonFileParser = (parsedData: any, scene: Scene, rootUrl: string) => any;
  103622. /**
  103623. * Base class of the scene acting as a container for the different elements composing a scene.
  103624. * This class is dynamically extended by the different components of the scene increasing
  103625. * flexibility and reducing coupling
  103626. */
  103627. export abstract class AbstractScene {
  103628. /**
  103629. * Stores the list of available parsers in the application.
  103630. */
  103631. private static _BabylonFileParsers;
  103632. /**
  103633. * Stores the list of available individual parsers in the application.
  103634. */
  103635. private static _IndividualBabylonFileParsers;
  103636. /**
  103637. * Adds a parser in the list of available ones
  103638. * @param name Defines the name of the parser
  103639. * @param parser Defines the parser to add
  103640. */
  103641. static AddParser(name: string, parser: BabylonFileParser): void;
  103642. /**
  103643. * Gets a general parser from the list of avaialble ones
  103644. * @param name Defines the name of the parser
  103645. * @returns the requested parser or null
  103646. */
  103647. static GetParser(name: string): Nullable<BabylonFileParser>;
  103648. /**
  103649. * Adds n individual parser in the list of available ones
  103650. * @param name Defines the name of the parser
  103651. * @param parser Defines the parser to add
  103652. */
  103653. static AddIndividualParser(name: string, parser: IndividualBabylonFileParser): void;
  103654. /**
  103655. * Gets an individual parser from the list of avaialble ones
  103656. * @param name Defines the name of the parser
  103657. * @returns the requested parser or null
  103658. */
  103659. static GetIndividualParser(name: string): Nullable<IndividualBabylonFileParser>;
  103660. /**
  103661. * Parser json data and populate both a scene and its associated container object
  103662. * @param jsonData Defines the data to parse
  103663. * @param scene Defines the scene to parse the data for
  103664. * @param container Defines the container attached to the parsing sequence
  103665. * @param rootUrl Defines the root url of the data
  103666. */
  103667. static Parse(jsonData: any, scene: Scene, container: AssetContainer, rootUrl: string): void;
  103668. /**
  103669. * Gets the list of root nodes (ie. nodes with no parent)
  103670. */
  103671. rootNodes: Node[];
  103672. /** All of the cameras added to this scene
  103673. * @see http://doc.babylonjs.com/babylon101/cameras
  103674. */
  103675. cameras: Camera[];
  103676. /**
  103677. * All of the lights added to this scene
  103678. * @see http://doc.babylonjs.com/babylon101/lights
  103679. */
  103680. lights: Light[];
  103681. /**
  103682. * All of the (abstract) meshes added to this scene
  103683. */
  103684. meshes: AbstractMesh[];
  103685. /**
  103686. * The list of skeletons added to the scene
  103687. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons
  103688. */
  103689. skeletons: Skeleton[];
  103690. /**
  103691. * All of the particle systems added to this scene
  103692. * @see http://doc.babylonjs.com/babylon101/particles
  103693. */
  103694. particleSystems: IParticleSystem[];
  103695. /**
  103696. * Gets a list of Animations associated with the scene
  103697. */
  103698. animations: Animation[];
  103699. /**
  103700. * All of the animation groups added to this scene
  103701. * @see http://doc.babylonjs.com/how_to/group
  103702. */
  103703. animationGroups: AnimationGroup[];
  103704. /**
  103705. * All of the multi-materials added to this scene
  103706. * @see http://doc.babylonjs.com/how_to/multi_materials
  103707. */
  103708. multiMaterials: MultiMaterial[];
  103709. /**
  103710. * All of the materials added to this scene
  103711. * In the context of a Scene, it is not supposed to be modified manually.
  103712. * Any addition or removal should be done using the addMaterial and removeMaterial Scene methods.
  103713. * Note also that the order of the Material within the array is not significant and might change.
  103714. * @see http://doc.babylonjs.com/babylon101/materials
  103715. */
  103716. materials: Material[];
  103717. /**
  103718. * The list of morph target managers added to the scene
  103719. * @see http://doc.babylonjs.com/how_to/how_to_dynamically_morph_a_mesh
  103720. */
  103721. morphTargetManagers: MorphTargetManager[];
  103722. /**
  103723. * The list of geometries used in the scene.
  103724. */
  103725. geometries: Geometry[];
  103726. /**
  103727. * All of the tranform nodes added to this scene
  103728. * In the context of a Scene, it is not supposed to be modified manually.
  103729. * Any addition or removal should be done using the addTransformNode and removeTransformNode Scene methods.
  103730. * Note also that the order of the TransformNode wihin the array is not significant and might change.
  103731. * @see http://doc.babylonjs.com/how_to/transformnode
  103732. */
  103733. transformNodes: TransformNode[];
  103734. /**
  103735. * ActionManagers available on the scene.
  103736. */
  103737. actionManagers: AbstractActionManager[];
  103738. /**
  103739. * Textures to keep.
  103740. */
  103741. textures: BaseTexture[];
  103742. /**
  103743. * Environment texture for the scene
  103744. */
  103745. environmentTexture: Nullable<BaseTexture>;
  103746. }
  103747. }
  103748. declare module BABYLON {
  103749. /**
  103750. * Interface used to define options for Sound class
  103751. */
  103752. export interface ISoundOptions {
  103753. /**
  103754. * Does the sound autoplay once loaded.
  103755. */
  103756. autoplay?: boolean;
  103757. /**
  103758. * Does the sound loop after it finishes playing once.
  103759. */
  103760. loop?: boolean;
  103761. /**
  103762. * Sound's volume
  103763. */
  103764. volume?: number;
  103765. /**
  103766. * Is it a spatial sound?
  103767. */
  103768. spatialSound?: boolean;
  103769. /**
  103770. * Maximum distance to hear that sound
  103771. */
  103772. maxDistance?: number;
  103773. /**
  103774. * Uses user defined attenuation function
  103775. */
  103776. useCustomAttenuation?: boolean;
  103777. /**
  103778. * Define the roll off factor of spatial sounds.
  103779. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  103780. */
  103781. rolloffFactor?: number;
  103782. /**
  103783. * Define the reference distance the sound should be heard perfectly.
  103784. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  103785. */
  103786. refDistance?: number;
  103787. /**
  103788. * Define the distance attenuation model the sound will follow.
  103789. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  103790. */
  103791. distanceModel?: string;
  103792. /**
  103793. * Defines the playback speed (1 by default)
  103794. */
  103795. playbackRate?: number;
  103796. /**
  103797. * Defines if the sound is from a streaming source
  103798. */
  103799. streaming?: boolean;
  103800. /**
  103801. * Defines an optional length (in seconds) inside the sound file
  103802. */
  103803. length?: number;
  103804. /**
  103805. * Defines an optional offset (in seconds) inside the sound file
  103806. */
  103807. offset?: number;
  103808. /**
  103809. * If true, URLs will not be required to state the audio file codec to use.
  103810. */
  103811. skipCodecCheck?: boolean;
  103812. }
  103813. /**
  103814. * Defines a sound that can be played in the application.
  103815. * The sound can either be an ambient track or a simple sound played in reaction to a user action.
  103816. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  103817. */
  103818. export class Sound {
  103819. /**
  103820. * The name of the sound in the scene.
  103821. */
  103822. name: string;
  103823. /**
  103824. * Does the sound autoplay once loaded.
  103825. */
  103826. autoplay: boolean;
  103827. /**
  103828. * Does the sound loop after it finishes playing once.
  103829. */
  103830. loop: boolean;
  103831. /**
  103832. * Does the sound use a custom attenuation curve to simulate the falloff
  103833. * happening when the source gets further away from the camera.
  103834. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  103835. */
  103836. useCustomAttenuation: boolean;
  103837. /**
  103838. * The sound track id this sound belongs to.
  103839. */
  103840. soundTrackId: number;
  103841. /**
  103842. * Is this sound currently played.
  103843. */
  103844. isPlaying: boolean;
  103845. /**
  103846. * Is this sound currently paused.
  103847. */
  103848. isPaused: boolean;
  103849. /**
  103850. * Does this sound enables spatial sound.
  103851. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  103852. */
  103853. spatialSound: boolean;
  103854. /**
  103855. * Define the reference distance the sound should be heard perfectly.
  103856. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  103857. */
  103858. refDistance: number;
  103859. /**
  103860. * Define the roll off factor of spatial sounds.
  103861. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  103862. */
  103863. rolloffFactor: number;
  103864. /**
  103865. * Define the max distance the sound should be heard (intensity just became 0 at this point).
  103866. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  103867. */
  103868. maxDistance: number;
  103869. /**
  103870. * Define the distance attenuation model the sound will follow.
  103871. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  103872. */
  103873. distanceModel: string;
  103874. /**
  103875. * @hidden
  103876. * Back Compat
  103877. **/
  103878. onended: () => any;
  103879. /**
  103880. * Observable event when the current playing sound finishes.
  103881. */
  103882. onEndedObservable: Observable<Sound>;
  103883. private _panningModel;
  103884. private _playbackRate;
  103885. private _streaming;
  103886. private _startTime;
  103887. private _startOffset;
  103888. private _position;
  103889. /** @hidden */
  103890. _positionInEmitterSpace: boolean;
  103891. private _localDirection;
  103892. private _volume;
  103893. private _isReadyToPlay;
  103894. private _isDirectional;
  103895. private _readyToPlayCallback;
  103896. private _audioBuffer;
  103897. private _soundSource;
  103898. private _streamingSource;
  103899. private _soundPanner;
  103900. private _soundGain;
  103901. private _inputAudioNode;
  103902. private _outputAudioNode;
  103903. private _coneInnerAngle;
  103904. private _coneOuterAngle;
  103905. private _coneOuterGain;
  103906. private _scene;
  103907. private _connectedTransformNode;
  103908. private _customAttenuationFunction;
  103909. private _registerFunc;
  103910. private _isOutputConnected;
  103911. private _htmlAudioElement;
  103912. private _urlType;
  103913. private _length?;
  103914. private _offset?;
  103915. /** @hidden */
  103916. static _SceneComponentInitialization: (scene: Scene) => void;
  103917. /**
  103918. * Create a sound and attach it to a scene
  103919. * @param name Name of your sound
  103920. * @param urlOrArrayBuffer Url to the sound to load async or ArrayBuffer, it also works with MediaStreams
  103921. * @param scene defines the scene the sound belongs to
  103922. * @param readyToPlayCallback Provide a callback function if you'd like to load your code once the sound is ready to be played
  103923. * @param options Objects to provide with the current available options: autoplay, loop, volume, spatialSound, maxDistance, rolloffFactor, refDistance, distanceModel, panningModel, streaming
  103924. */
  103925. constructor(name: string, urlOrArrayBuffer: any, scene: Scene, readyToPlayCallback?: Nullable<() => void>, options?: ISoundOptions);
  103926. /**
  103927. * Release the sound and its associated resources
  103928. */
  103929. dispose(): void;
  103930. /**
  103931. * Gets if the sounds is ready to be played or not.
  103932. * @returns true if ready, otherwise false
  103933. */
  103934. isReady(): boolean;
  103935. private _soundLoaded;
  103936. /**
  103937. * Sets the data of the sound from an audiobuffer
  103938. * @param audioBuffer The audioBuffer containing the data
  103939. */
  103940. setAudioBuffer(audioBuffer: AudioBuffer): void;
  103941. /**
  103942. * Updates the current sounds options such as maxdistance, loop...
  103943. * @param options A JSON object containing values named as the object properties
  103944. */
  103945. updateOptions(options: ISoundOptions): void;
  103946. private _createSpatialParameters;
  103947. private _updateSpatialParameters;
  103948. /**
  103949. * Switch the panning model to HRTF:
  103950. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  103951. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  103952. */
  103953. switchPanningModelToHRTF(): void;
  103954. /**
  103955. * Switch the panning model to Equal Power:
  103956. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  103957. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  103958. */
  103959. switchPanningModelToEqualPower(): void;
  103960. private _switchPanningModel;
  103961. /**
  103962. * Connect this sound to a sound track audio node like gain...
  103963. * @param soundTrackAudioNode the sound track audio node to connect to
  103964. */
  103965. connectToSoundTrackAudioNode(soundTrackAudioNode: AudioNode): void;
  103966. /**
  103967. * Transform this sound into a directional source
  103968. * @param coneInnerAngle Size of the inner cone in degree
  103969. * @param coneOuterAngle Size of the outer cone in degree
  103970. * @param coneOuterGain Volume of the sound outside the outer cone (between 0.0 and 1.0)
  103971. */
  103972. setDirectionalCone(coneInnerAngle: number, coneOuterAngle: number, coneOuterGain: number): void;
  103973. /**
  103974. * Gets or sets the inner angle for the directional cone.
  103975. */
  103976. /**
  103977. * Gets or sets the inner angle for the directional cone.
  103978. */
  103979. directionalConeInnerAngle: number;
  103980. /**
  103981. * Gets or sets the outer angle for the directional cone.
  103982. */
  103983. /**
  103984. * Gets or sets the outer angle for the directional cone.
  103985. */
  103986. directionalConeOuterAngle: number;
  103987. /**
  103988. * Sets the position of the emitter if spatial sound is enabled
  103989. * @param newPosition Defines the new posisiton
  103990. */
  103991. setPosition(newPosition: Vector3): void;
  103992. /**
  103993. * Sets the local direction of the emitter if spatial sound is enabled
  103994. * @param newLocalDirection Defines the new local direction
  103995. */
  103996. setLocalDirectionToMesh(newLocalDirection: Vector3): void;
  103997. private _updateDirection;
  103998. /** @hidden */
  103999. updateDistanceFromListener(): void;
  104000. /**
  104001. * Sets a new custom attenuation function for the sound.
  104002. * @param callback Defines the function used for the attenuation
  104003. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-your-own-custom-attenuation-function
  104004. */
  104005. setAttenuationFunction(callback: (currentVolume: number, currentDistance: number, maxDistance: number, refDistance: number, rolloffFactor: number) => number): void;
  104006. /**
  104007. * Play the sound
  104008. * @param time (optional) Start the sound after X seconds. Start immediately (0) by default.
  104009. * @param offset (optional) Start the sound at a specific time in seconds
  104010. * @param length (optional) Sound duration (in seconds)
  104011. */
  104012. play(time?: number, offset?: number, length?: number): void;
  104013. private _onended;
  104014. /**
  104015. * Stop the sound
  104016. * @param time (optional) Stop the sound after X seconds. Stop immediately (0) by default.
  104017. */
  104018. stop(time?: number): void;
  104019. /**
  104020. * Put the sound in pause
  104021. */
  104022. pause(): void;
  104023. /**
  104024. * Sets a dedicated volume for this sounds
  104025. * @param newVolume Define the new volume of the sound
  104026. * @param time Define time for gradual change to new volume
  104027. */
  104028. setVolume(newVolume: number, time?: number): void;
  104029. /**
  104030. * Set the sound play back rate
  104031. * @param newPlaybackRate Define the playback rate the sound should be played at
  104032. */
  104033. setPlaybackRate(newPlaybackRate: number): void;
  104034. /**
  104035. * Gets the volume of the sound.
  104036. * @returns the volume of the sound
  104037. */
  104038. getVolume(): number;
  104039. /**
  104040. * Attach the sound to a dedicated mesh
  104041. * @param transformNode The transform node to connect the sound with
  104042. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  104043. */
  104044. attachToMesh(transformNode: TransformNode): void;
  104045. /**
  104046. * Detach the sound from the previously attached mesh
  104047. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#attaching-a-sound-to-a-mesh
  104048. */
  104049. detachFromMesh(): void;
  104050. private _onRegisterAfterWorldMatrixUpdate;
  104051. /**
  104052. * Clone the current sound in the scene.
  104053. * @returns the new sound clone
  104054. */
  104055. clone(): Nullable<Sound>;
  104056. /**
  104057. * Gets the current underlying audio buffer containing the data
  104058. * @returns the audio buffer
  104059. */
  104060. getAudioBuffer(): Nullable<AudioBuffer>;
  104061. /**
  104062. * Serializes the Sound in a JSON representation
  104063. * @returns the JSON representation of the sound
  104064. */
  104065. serialize(): any;
  104066. /**
  104067. * Parse a JSON representation of a sound to innstantiate in a given scene
  104068. * @param parsedSound Define the JSON representation of the sound (usually coming from the serialize method)
  104069. * @param scene Define the scene the new parsed sound should be created in
  104070. * @param rootUrl Define the rooturl of the load in case we need to fetch relative dependencies
  104071. * @param sourceSound Define a cound place holder if do not need to instantiate a new one
  104072. * @returns the newly parsed sound
  104073. */
  104074. static Parse(parsedSound: any, scene: Scene, rootUrl: string, sourceSound?: Sound): Sound;
  104075. }
  104076. }
  104077. declare module BABYLON {
  104078. /**
  104079. * This defines an action helpful to play a defined sound on a triggered action.
  104080. */
  104081. export class PlaySoundAction extends Action {
  104082. private _sound;
  104083. /**
  104084. * Instantiate the action
  104085. * @param triggerOptions defines the trigger options
  104086. * @param sound defines the sound to play
  104087. * @param condition defines the trigger related conditions
  104088. */
  104089. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  104090. /** @hidden */
  104091. _prepare(): void;
  104092. /**
  104093. * Execute the action and play the sound.
  104094. */
  104095. execute(): void;
  104096. /**
  104097. * Serializes the actions and its related information.
  104098. * @param parent defines the object to serialize in
  104099. * @returns the serialized object
  104100. */
  104101. serialize(parent: any): any;
  104102. }
  104103. /**
  104104. * This defines an action helpful to stop a defined sound on a triggered action.
  104105. */
  104106. export class StopSoundAction extends Action {
  104107. private _sound;
  104108. /**
  104109. * Instantiate the action
  104110. * @param triggerOptions defines the trigger options
  104111. * @param sound defines the sound to stop
  104112. * @param condition defines the trigger related conditions
  104113. */
  104114. constructor(triggerOptions: any, sound: Sound, condition?: Condition);
  104115. /** @hidden */
  104116. _prepare(): void;
  104117. /**
  104118. * Execute the action and stop the sound.
  104119. */
  104120. execute(): void;
  104121. /**
  104122. * Serializes the actions and its related information.
  104123. * @param parent defines the object to serialize in
  104124. * @returns the serialized object
  104125. */
  104126. serialize(parent: any): any;
  104127. }
  104128. }
  104129. declare module BABYLON {
  104130. /**
  104131. * This defines an action responsible to change the value of a property
  104132. * by interpolating between its current value and the newly set one once triggered.
  104133. * @see http://doc.babylonjs.com/how_to/how_to_use_actions
  104134. */
  104135. export class InterpolateValueAction extends Action {
  104136. /**
  104137. * Defines the path of the property where the value should be interpolated
  104138. */
  104139. propertyPath: string;
  104140. /**
  104141. * Defines the target value at the end of the interpolation.
  104142. */
  104143. value: any;
  104144. /**
  104145. * Defines the time it will take for the property to interpolate to the value.
  104146. */
  104147. duration: number;
  104148. /**
  104149. * Defines if the other scene animations should be stopped when the action has been triggered
  104150. */
  104151. stopOtherAnimations?: boolean;
  104152. /**
  104153. * Defines a callback raised once the interpolation animation has been done.
  104154. */
  104155. onInterpolationDone?: () => void;
  104156. /**
  104157. * Observable triggered once the interpolation animation has been done.
  104158. */
  104159. onInterpolationDoneObservable: Observable<InterpolateValueAction>;
  104160. private _target;
  104161. private _effectiveTarget;
  104162. private _property;
  104163. /**
  104164. * Instantiate the action
  104165. * @param triggerOptions defines the trigger options
  104166. * @param target defines the object containing the value to interpolate
  104167. * @param propertyPath defines the path to the property in the target object
  104168. * @param value defines the target value at the end of the interpolation
  104169. * @param duration deines the time it will take for the property to interpolate to the value.
  104170. * @param condition defines the trigger related conditions
  104171. * @param stopOtherAnimations defines if the other scene animations should be stopped when the action has been triggered
  104172. * @param onInterpolationDone defines a callback raised once the interpolation animation has been done
  104173. */
  104174. constructor(triggerOptions: any, target: any, propertyPath: string, value: any, duration?: number, condition?: Condition, stopOtherAnimations?: boolean, onInterpolationDone?: () => void);
  104175. /** @hidden */
  104176. _prepare(): void;
  104177. /**
  104178. * Execute the action starts the value interpolation.
  104179. */
  104180. execute(): void;
  104181. /**
  104182. * Serializes the actions and its related information.
  104183. * @param parent defines the object to serialize in
  104184. * @returns the serialized object
  104185. */
  104186. serialize(parent: any): any;
  104187. }
  104188. }
  104189. declare module BABYLON {
  104190. /**
  104191. * Options allowed during the creation of a sound track.
  104192. */
  104193. export interface ISoundTrackOptions {
  104194. /**
  104195. * The volume the sound track should take during creation
  104196. */
  104197. volume?: number;
  104198. /**
  104199. * Define if the sound track is the main sound track of the scene
  104200. */
  104201. mainTrack?: boolean;
  104202. }
  104203. /**
  104204. * It could be useful to isolate your music & sounds on several tracks to better manage volume on a grouped instance of sounds.
  104205. * It will be also used in a future release to apply effects on a specific track.
  104206. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  104207. */
  104208. export class SoundTrack {
  104209. /**
  104210. * The unique identifier of the sound track in the scene.
  104211. */
  104212. id: number;
  104213. /**
  104214. * The list of sounds included in the sound track.
  104215. */
  104216. soundCollection: Array<Sound>;
  104217. private _outputAudioNode;
  104218. private _scene;
  104219. private _connectedAnalyser;
  104220. private _options;
  104221. private _isInitialized;
  104222. /**
  104223. * Creates a new sound track.
  104224. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-sound-tracks
  104225. * @param scene Define the scene the sound track belongs to
  104226. * @param options
  104227. */
  104228. constructor(scene: Scene, options?: ISoundTrackOptions);
  104229. private _initializeSoundTrackAudioGraph;
  104230. /**
  104231. * Release the sound track and its associated resources
  104232. */
  104233. dispose(): void;
  104234. /**
  104235. * Adds a sound to this sound track
  104236. * @param sound define the cound to add
  104237. * @ignoreNaming
  104238. */
  104239. AddSound(sound: Sound): void;
  104240. /**
  104241. * Removes a sound to this sound track
  104242. * @param sound define the cound to remove
  104243. * @ignoreNaming
  104244. */
  104245. RemoveSound(sound: Sound): void;
  104246. /**
  104247. * Set a global volume for the full sound track.
  104248. * @param newVolume Define the new volume of the sound track
  104249. */
  104250. setVolume(newVolume: number): void;
  104251. /**
  104252. * Switch the panning model to HRTF:
  104253. * Renders a stereo output of higher quality than equalpower — it uses a convolution with measured impulse responses from human subjects.
  104254. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  104255. */
  104256. switchPanningModelToHRTF(): void;
  104257. /**
  104258. * Switch the panning model to Equal Power:
  104259. * Represents the equal-power panning algorithm, generally regarded as simple and efficient. equalpower is the default value.
  104260. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#creating-a-spatial-3d-sound
  104261. */
  104262. switchPanningModelToEqualPower(): void;
  104263. /**
  104264. * Connect the sound track to an audio analyser allowing some amazing
  104265. * synchornization between the sounds/music and your visualization (VuMeter for instance).
  104266. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music#using-the-analyser
  104267. * @param analyser The analyser to connect to the engine
  104268. */
  104269. connectToAnalyser(analyser: Analyser): void;
  104270. }
  104271. }
  104272. declare module BABYLON {
  104273. interface AbstractScene {
  104274. /**
  104275. * The list of sounds used in the scene.
  104276. */
  104277. sounds: Nullable<Array<Sound>>;
  104278. }
  104279. interface Scene {
  104280. /**
  104281. * @hidden
  104282. * Backing field
  104283. */
  104284. _mainSoundTrack: SoundTrack;
  104285. /**
  104286. * The main sound track played by the scene.
  104287. * It cotains your primary collection of sounds.
  104288. */
  104289. mainSoundTrack: SoundTrack;
  104290. /**
  104291. * The list of sound tracks added to the scene
  104292. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  104293. */
  104294. soundTracks: Nullable<Array<SoundTrack>>;
  104295. /**
  104296. * Gets a sound using a given name
  104297. * @param name defines the name to search for
  104298. * @return the found sound or null if not found at all.
  104299. */
  104300. getSoundByName(name: string): Nullable<Sound>;
  104301. /**
  104302. * Gets or sets if audio support is enabled
  104303. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  104304. */
  104305. audioEnabled: boolean;
  104306. /**
  104307. * Gets or sets if audio will be output to headphones
  104308. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  104309. */
  104310. headphone: boolean;
  104311. /**
  104312. * Gets or sets custom audio listener position provider
  104313. * @see http://doc.babylonjs.com/how_to/playing_sounds_and_music
  104314. */
  104315. audioListenerPositionProvider: Nullable<() => Vector3>;
  104316. /**
  104317. * Gets or sets a refresh rate when using 3D audio positioning
  104318. */
  104319. audioPositioningRefreshRate: number;
  104320. }
  104321. /**
  104322. * Defines the sound scene component responsible to manage any sounds
  104323. * in a given scene.
  104324. */
  104325. export class AudioSceneComponent implements ISceneSerializableComponent {
  104326. /**
  104327. * The component name helpfull to identify the component in the list of scene components.
  104328. */
  104329. readonly name: string;
  104330. /**
  104331. * The scene the component belongs to.
  104332. */
  104333. scene: Scene;
  104334. private _audioEnabled;
  104335. /**
  104336. * Gets whether audio is enabled or not.
  104337. * Please use related enable/disable method to switch state.
  104338. */
  104339. readonly audioEnabled: boolean;
  104340. private _headphone;
  104341. /**
  104342. * Gets whether audio is outputing to headphone or not.
  104343. * Please use the according Switch methods to change output.
  104344. */
  104345. readonly headphone: boolean;
  104346. /**
  104347. * Gets or sets a refresh rate when using 3D audio positioning
  104348. */
  104349. audioPositioningRefreshRate: number;
  104350. private _audioListenerPositionProvider;
  104351. /**
  104352. * Gets the current audio listener position provider
  104353. */
  104354. /**
  104355. * Sets a custom listener position for all sounds in the scene
  104356. * By default, this is the position of the first active camera
  104357. */
  104358. audioListenerPositionProvider: Nullable<() => Vector3>;
  104359. /**
  104360. * Creates a new instance of the component for the given scene
  104361. * @param scene Defines the scene to register the component in
  104362. */
  104363. constructor(scene: Scene);
  104364. /**
  104365. * Registers the component in a given scene
  104366. */
  104367. register(): void;
  104368. /**
  104369. * Rebuilds the elements related to this component in case of
  104370. * context lost for instance.
  104371. */
  104372. rebuild(): void;
  104373. /**
  104374. * Serializes the component data to the specified json object
  104375. * @param serializationObject The object to serialize to
  104376. */
  104377. serialize(serializationObject: any): void;
  104378. /**
  104379. * Adds all the elements from the container to the scene
  104380. * @param container the container holding the elements
  104381. */
  104382. addFromContainer(container: AbstractScene): void;
  104383. /**
  104384. * Removes all the elements in the container from the scene
  104385. * @param container contains the elements to remove
  104386. * @param dispose if the removed element should be disposed (default: false)
  104387. */
  104388. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  104389. /**
  104390. * Disposes the component and the associated ressources.
  104391. */
  104392. dispose(): void;
  104393. /**
  104394. * Disables audio in the associated scene.
  104395. */
  104396. disableAudio(): void;
  104397. /**
  104398. * Enables audio in the associated scene.
  104399. */
  104400. enableAudio(): void;
  104401. /**
  104402. * Switch audio to headphone output.
  104403. */
  104404. switchAudioModeForHeadphones(): void;
  104405. /**
  104406. * Switch audio to normal speakers.
  104407. */
  104408. switchAudioModeForNormalSpeakers(): void;
  104409. private _cachedCameraDirection;
  104410. private _cachedCameraPosition;
  104411. private _lastCheck;
  104412. private _afterRender;
  104413. }
  104414. }
  104415. declare module BABYLON {
  104416. /**
  104417. * Wraps one or more Sound objects and selects one with random weight for playback.
  104418. */
  104419. export class WeightedSound {
  104420. /** When true a Sound will be selected and played when the current playing Sound completes. */
  104421. loop: boolean;
  104422. private _coneInnerAngle;
  104423. private _coneOuterAngle;
  104424. private _volume;
  104425. /** A Sound is currently playing. */
  104426. isPlaying: boolean;
  104427. /** A Sound is currently paused. */
  104428. isPaused: boolean;
  104429. private _sounds;
  104430. private _weights;
  104431. private _currentIndex?;
  104432. /**
  104433. * Creates a new WeightedSound from the list of sounds given.
  104434. * @param loop When true a Sound will be selected and played when the current playing Sound completes.
  104435. * @param sounds Array of Sounds that will be selected from.
  104436. * @param weights Array of number values for selection weights; length must equal sounds, values will be normalized to 1
  104437. */
  104438. constructor(loop: boolean, sounds: Sound[], weights: number[]);
  104439. /**
  104440. * The size of cone in degrees for a directional sound in which there will be no attenuation.
  104441. */
  104442. /**
  104443. * The size of cone in degress for a directional sound in which there will be no attenuation.
  104444. */
  104445. directionalConeInnerAngle: number;
  104446. /**
  104447. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  104448. * Listener angles between innerAngle and outerAngle will falloff linearly.
  104449. */
  104450. /**
  104451. * Size of cone in degrees for a directional sound outside of which there will be no sound.
  104452. * Listener angles between innerAngle and outerAngle will falloff linearly.
  104453. */
  104454. directionalConeOuterAngle: number;
  104455. /**
  104456. * Playback volume.
  104457. */
  104458. /**
  104459. * Playback volume.
  104460. */
  104461. volume: number;
  104462. private _onended;
  104463. /**
  104464. * Suspend playback
  104465. */
  104466. pause(): void;
  104467. /**
  104468. * Stop playback
  104469. */
  104470. stop(): void;
  104471. /**
  104472. * Start playback.
  104473. * @param startOffset Position the clip head at a specific time in seconds.
  104474. */
  104475. play(startOffset?: number): void;
  104476. }
  104477. }
  104478. declare module BABYLON {
  104479. /**
  104480. * Add a bouncing effect to an ArcRotateCamera when reaching a specified minimum and maximum radius
  104481. * @see http://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  104482. */
  104483. export class BouncingBehavior implements Behavior<ArcRotateCamera> {
  104484. /**
  104485. * Gets the name of the behavior.
  104486. */
  104487. readonly name: string;
  104488. /**
  104489. * The easing function used by animations
  104490. */
  104491. static EasingFunction: BackEase;
  104492. /**
  104493. * The easing mode used by animations
  104494. */
  104495. static EasingMode: number;
  104496. /**
  104497. * The duration of the animation, in milliseconds
  104498. */
  104499. transitionDuration: number;
  104500. /**
  104501. * Length of the distance animated by the transition when lower radius is reached
  104502. */
  104503. lowerRadiusTransitionRange: number;
  104504. /**
  104505. * Length of the distance animated by the transition when upper radius is reached
  104506. */
  104507. upperRadiusTransitionRange: number;
  104508. private _autoTransitionRange;
  104509. /**
  104510. * Gets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  104511. */
  104512. /**
  104513. * Sets a value indicating if the lowerRadiusTransitionRange and upperRadiusTransitionRange are defined automatically
  104514. * Transition ranges will be set to 5% of the bounding box diagonal in world space
  104515. */
  104516. autoTransitionRange: boolean;
  104517. private _attachedCamera;
  104518. private _onAfterCheckInputsObserver;
  104519. private _onMeshTargetChangedObserver;
  104520. /**
  104521. * Initializes the behavior.
  104522. */
  104523. init(): void;
  104524. /**
  104525. * Attaches the behavior to its arc rotate camera.
  104526. * @param camera Defines the camera to attach the behavior to
  104527. */
  104528. attach(camera: ArcRotateCamera): void;
  104529. /**
  104530. * Detaches the behavior from its current arc rotate camera.
  104531. */
  104532. detach(): void;
  104533. private _radiusIsAnimating;
  104534. private _radiusBounceTransition;
  104535. private _animatables;
  104536. private _cachedWheelPrecision;
  104537. /**
  104538. * Checks if the camera radius is at the specified limit. Takes into account animation locks.
  104539. * @param radiusLimit The limit to check against.
  104540. * @return Bool to indicate if at limit.
  104541. */
  104542. private _isRadiusAtLimit;
  104543. /**
  104544. * Applies an animation to the radius of the camera, extending by the radiusDelta.
  104545. * @param radiusDelta The delta by which to animate to. Can be negative.
  104546. */
  104547. private _applyBoundRadiusAnimation;
  104548. /**
  104549. * Removes all animation locks. Allows new animations to be added to any of the camera properties.
  104550. */
  104551. protected _clearAnimationLocks(): void;
  104552. /**
  104553. * Stops and removes all animations that have been applied to the camera
  104554. */
  104555. stopAllAnimations(): void;
  104556. }
  104557. }
  104558. declare module BABYLON {
  104559. /**
  104560. * 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.
  104561. * @see http://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  104562. */
  104563. export class FramingBehavior implements Behavior<ArcRotateCamera> {
  104564. /**
  104565. * Gets the name of the behavior.
  104566. */
  104567. readonly name: string;
  104568. private _mode;
  104569. private _radiusScale;
  104570. private _positionScale;
  104571. private _defaultElevation;
  104572. private _elevationReturnTime;
  104573. private _elevationReturnWaitTime;
  104574. private _zoomStopsAnimation;
  104575. private _framingTime;
  104576. /**
  104577. * The easing function used by animations
  104578. */
  104579. static EasingFunction: ExponentialEase;
  104580. /**
  104581. * The easing mode used by animations
  104582. */
  104583. static EasingMode: number;
  104584. /**
  104585. * Sets the current mode used by the behavior
  104586. */
  104587. /**
  104588. * Gets current mode used by the behavior.
  104589. */
  104590. mode: number;
  104591. /**
  104592. * Sets the scale applied to the radius (1 by default)
  104593. */
  104594. /**
  104595. * Gets the scale applied to the radius
  104596. */
  104597. radiusScale: number;
  104598. /**
  104599. * Sets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  104600. */
  104601. /**
  104602. * Gets the scale to apply on Y axis to position camera focus. 0.5 by default which means the center of the bounding box.
  104603. */
  104604. positionScale: number;
  104605. /**
  104606. * Sets the angle above/below the horizontal plane to return to when the return to default elevation idle
  104607. * behaviour is triggered, in radians.
  104608. */
  104609. /**
  104610. * Gets the angle above/below the horizontal plane to return to when the return to default elevation idle
  104611. * behaviour is triggered, in radians.
  104612. */
  104613. defaultElevation: number;
  104614. /**
  104615. * Sets the time (in milliseconds) taken to return to the default beta position.
  104616. * Negative value indicates camera should not return to default.
  104617. */
  104618. /**
  104619. * Gets the time (in milliseconds) taken to return to the default beta position.
  104620. * Negative value indicates camera should not return to default.
  104621. */
  104622. elevationReturnTime: number;
  104623. /**
  104624. * Sets the delay (in milliseconds) taken before the camera returns to the default beta position.
  104625. */
  104626. /**
  104627. * Gets the delay (in milliseconds) taken before the camera returns to the default beta position.
  104628. */
  104629. elevationReturnWaitTime: number;
  104630. /**
  104631. * Sets the flag that indicates if user zooming should stop animation.
  104632. */
  104633. /**
  104634. * Gets the flag that indicates if user zooming should stop animation.
  104635. */
  104636. zoomStopsAnimation: boolean;
  104637. /**
  104638. * Sets the transition time when framing the mesh, in milliseconds
  104639. */
  104640. /**
  104641. * Gets the transition time when framing the mesh, in milliseconds
  104642. */
  104643. framingTime: number;
  104644. /**
  104645. * Define if the behavior should automatically change the configured
  104646. * camera limits and sensibilities.
  104647. */
  104648. autoCorrectCameraLimitsAndSensibility: boolean;
  104649. private _onPrePointerObservableObserver;
  104650. private _onAfterCheckInputsObserver;
  104651. private _onMeshTargetChangedObserver;
  104652. private _attachedCamera;
  104653. private _isPointerDown;
  104654. private _lastInteractionTime;
  104655. /**
  104656. * Initializes the behavior.
  104657. */
  104658. init(): void;
  104659. /**
  104660. * Attaches the behavior to its arc rotate camera.
  104661. * @param camera Defines the camera to attach the behavior to
  104662. */
  104663. attach(camera: ArcRotateCamera): void;
  104664. /**
  104665. * Detaches the behavior from its current arc rotate camera.
  104666. */
  104667. detach(): void;
  104668. private _animatables;
  104669. private _betaIsAnimating;
  104670. private _betaTransition;
  104671. private _radiusTransition;
  104672. private _vectorTransition;
  104673. /**
  104674. * Targets the given mesh and updates zoom level accordingly.
  104675. * @param mesh The mesh to target.
  104676. * @param radius Optional. If a cached radius position already exists, overrides default.
  104677. * @param framingPositionY Position on mesh to center camera focus where 0 corresponds bottom of its bounding box and 1, the top
  104678. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  104679. * @param onAnimationEnd Callback triggered at the end of the framing animation
  104680. */
  104681. zoomOnMesh(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  104682. /**
  104683. * Targets the given mesh with its children and updates zoom level accordingly.
  104684. * @param mesh The mesh to target.
  104685. * @param radius Optional. If a cached radius position already exists, overrides default.
  104686. * @param framingPositionY Position on mesh to center camera focus where 0 corresponds bottom of its bounding box and 1, the top
  104687. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  104688. * @param onAnimationEnd Callback triggered at the end of the framing animation
  104689. */
  104690. zoomOnMeshHierarchy(mesh: AbstractMesh, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  104691. /**
  104692. * Targets the given meshes with their children and updates zoom level accordingly.
  104693. * @param meshes The mesh to target.
  104694. * @param radius Optional. If a cached radius position already exists, overrides default.
  104695. * @param framingPositionY Position on mesh to center camera focus where 0 corresponds bottom of its bounding box and 1, the top
  104696. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  104697. * @param onAnimationEnd Callback triggered at the end of the framing animation
  104698. */
  104699. zoomOnMeshesHierarchy(meshes: AbstractMesh[], focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  104700. /**
  104701. * Targets the bounding box info defined by its extends and updates zoom level accordingly.
  104702. * @param minimumWorld Determines the smaller position of the bounding box extend
  104703. * @param maximumWorld Determines the bigger position of the bounding box extend
  104704. * @param focusOnOriginXZ Determines if the camera should focus on 0 in the X and Z axis instead of the mesh
  104705. * @param onAnimationEnd Callback triggered at the end of the framing animation
  104706. */
  104707. zoomOnBoundingInfo(minimumWorld: Vector3, maximumWorld: Vector3, focusOnOriginXZ?: boolean, onAnimationEnd?: Nullable<() => void>): void;
  104708. /**
  104709. * Calculates the lowest radius for the camera based on the bounding box of the mesh.
  104710. * @param mesh The mesh on which to base the calculation. mesh boundingInfo used to estimate necessary
  104711. * frustum width.
  104712. * @return The minimum distance from the primary mesh's center point at which the camera must be kept in order
  104713. * to fully enclose the mesh in the viewing frustum.
  104714. */
  104715. protected _calculateLowerRadiusFromModelBoundingSphere(minimumWorld: Vector3, maximumWorld: Vector3): number;
  104716. /**
  104717. * Keeps the camera above the ground plane. If the user pulls the camera below the ground plane, the camera
  104718. * is automatically returned to its default position (expected to be above ground plane).
  104719. */
  104720. private _maintainCameraAboveGround;
  104721. /**
  104722. * Returns the frustum slope based on the canvas ratio and camera FOV
  104723. * @returns The frustum slope represented as a Vector2 with X and Y slopes
  104724. */
  104725. private _getFrustumSlope;
  104726. /**
  104727. * Removes all animation locks. Allows new animations to be added to any of the arcCamera properties.
  104728. */
  104729. private _clearAnimationLocks;
  104730. /**
  104731. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  104732. */
  104733. private _applyUserInteraction;
  104734. /**
  104735. * Stops and removes all animations that have been applied to the camera
  104736. */
  104737. stopAllAnimations(): void;
  104738. /**
  104739. * Gets a value indicating if the user is moving the camera
  104740. */
  104741. readonly isUserIsMoving: boolean;
  104742. /**
  104743. * The camera can move all the way towards the mesh.
  104744. */
  104745. static IgnoreBoundsSizeMode: number;
  104746. /**
  104747. * The camera is not allowed to zoom closer to the mesh than the point at which the adjusted bounding sphere touches the frustum sides
  104748. */
  104749. static FitFrustumSidesMode: number;
  104750. }
  104751. }
  104752. declare module BABYLON {
  104753. /**
  104754. * Base class for Camera Pointer Inputs.
  104755. * See FollowCameraPointersInput in src/Cameras/Inputs/followCameraPointersInput.ts
  104756. * for example usage.
  104757. */
  104758. export abstract class BaseCameraPointersInput implements ICameraInput<Camera> {
  104759. /**
  104760. * Defines the camera the input is attached to.
  104761. */
  104762. abstract camera: Camera;
  104763. /**
  104764. * Whether keyboard modifier keys are pressed at time of last mouse event.
  104765. */
  104766. protected _altKey: boolean;
  104767. protected _ctrlKey: boolean;
  104768. protected _metaKey: boolean;
  104769. protected _shiftKey: boolean;
  104770. /**
  104771. * Which mouse buttons were pressed at time of last mouse event.
  104772. * https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent/buttons
  104773. */
  104774. protected _buttonsPressed: number;
  104775. /**
  104776. * Defines the buttons associated with the input to handle camera move.
  104777. */
  104778. buttons: number[];
  104779. /**
  104780. * Attach the input controls to a specific dom element to get the input from.
  104781. * @param element Defines the element the controls should be listened from
  104782. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  104783. */
  104784. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  104785. /**
  104786. * Detach the current controls from the specified dom element.
  104787. * @param element Defines the element to stop listening the inputs from
  104788. */
  104789. detachControl(element: Nullable<HTMLElement>): void;
  104790. /**
  104791. * Gets the class name of the current input.
  104792. * @returns the class name
  104793. */
  104794. getClassName(): string;
  104795. /**
  104796. * Get the friendly name associated with the input class.
  104797. * @returns the input friendly name
  104798. */
  104799. getSimpleName(): string;
  104800. /**
  104801. * Called on pointer POINTERDOUBLETAP event.
  104802. * Override this method to provide functionality on POINTERDOUBLETAP event.
  104803. */
  104804. protected onDoubleTap(type: string): void;
  104805. /**
  104806. * Called on pointer POINTERMOVE event if only a single touch is active.
  104807. * Override this method to provide functionality.
  104808. */
  104809. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  104810. /**
  104811. * Called on pointer POINTERMOVE event if multiple touches are active.
  104812. * Override this method to provide functionality.
  104813. */
  104814. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  104815. /**
  104816. * Called on JS contextmenu event.
  104817. * Override this method to provide functionality.
  104818. */
  104819. protected onContextMenu(evt: PointerEvent): void;
  104820. /**
  104821. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  104822. * press.
  104823. * Override this method to provide functionality.
  104824. */
  104825. protected onButtonDown(evt: PointerEvent): void;
  104826. /**
  104827. * Called each time a new POINTERUP event occurs. Ie, for each button
  104828. * release.
  104829. * Override this method to provide functionality.
  104830. */
  104831. protected onButtonUp(evt: PointerEvent): void;
  104832. /**
  104833. * Called when window becomes inactive.
  104834. * Override this method to provide functionality.
  104835. */
  104836. protected onLostFocus(): void;
  104837. private _pointerInput;
  104838. private _observer;
  104839. private _onLostFocus;
  104840. private pointA;
  104841. private pointB;
  104842. }
  104843. }
  104844. declare module BABYLON {
  104845. /**
  104846. * Manage the pointers inputs to control an arc rotate camera.
  104847. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  104848. */
  104849. export class ArcRotateCameraPointersInput extends BaseCameraPointersInput {
  104850. /**
  104851. * Defines the camera the input is attached to.
  104852. */
  104853. camera: ArcRotateCamera;
  104854. /**
  104855. * Gets the class name of the current input.
  104856. * @returns the class name
  104857. */
  104858. getClassName(): string;
  104859. /**
  104860. * Defines the buttons associated with the input to handle camera move.
  104861. */
  104862. buttons: number[];
  104863. /**
  104864. * Defines the pointer angular sensibility along the X axis or how fast is
  104865. * the camera rotating.
  104866. */
  104867. angularSensibilityX: number;
  104868. /**
  104869. * Defines the pointer angular sensibility along the Y axis or how fast is
  104870. * the camera rotating.
  104871. */
  104872. angularSensibilityY: number;
  104873. /**
  104874. * Defines the pointer pinch precision or how fast is the camera zooming.
  104875. */
  104876. pinchPrecision: number;
  104877. /**
  104878. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  104879. * from 0.
  104880. * It defines the percentage of current camera.radius to use as delta when
  104881. * pinch zoom is used.
  104882. */
  104883. pinchDeltaPercentage: number;
  104884. /**
  104885. * Defines the pointer panning sensibility or how fast is the camera moving.
  104886. */
  104887. panningSensibility: number;
  104888. /**
  104889. * Defines whether panning (2 fingers swipe) is enabled through multitouch.
  104890. */
  104891. multiTouchPanning: boolean;
  104892. /**
  104893. * Defines whether panning is enabled for both pan (2 fingers swipe) and
  104894. * zoom (pinch) through multitouch.
  104895. */
  104896. multiTouchPanAndZoom: boolean;
  104897. /**
  104898. * Revers pinch action direction.
  104899. */
  104900. pinchInwards: boolean;
  104901. private _isPanClick;
  104902. private _twoFingerActivityCount;
  104903. private _isPinching;
  104904. /**
  104905. * Called on pointer POINTERMOVE event if only a single touch is active.
  104906. */
  104907. protected onTouch(point: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  104908. /**
  104909. * Called on pointer POINTERDOUBLETAP event.
  104910. */
  104911. protected onDoubleTap(type: string): void;
  104912. /**
  104913. * Called on pointer POINTERMOVE event if multiple touches are active.
  104914. */
  104915. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  104916. /**
  104917. * Called each time a new POINTERDOWN event occurs. Ie, for each button
  104918. * press.
  104919. */
  104920. protected onButtonDown(evt: PointerEvent): void;
  104921. /**
  104922. * Called each time a new POINTERUP event occurs. Ie, for each button
  104923. * release.
  104924. */
  104925. protected onButtonUp(evt: PointerEvent): void;
  104926. /**
  104927. * Called when window becomes inactive.
  104928. */
  104929. protected onLostFocus(): void;
  104930. }
  104931. }
  104932. declare module BABYLON {
  104933. /**
  104934. * Manage the keyboard inputs to control the movement of an arc rotate camera.
  104935. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  104936. */
  104937. export class ArcRotateCameraKeyboardMoveInput implements ICameraInput<ArcRotateCamera> {
  104938. /**
  104939. * Defines the camera the input is attached to.
  104940. */
  104941. camera: ArcRotateCamera;
  104942. /**
  104943. * Defines the list of key codes associated with the up action (increase alpha)
  104944. */
  104945. keysUp: number[];
  104946. /**
  104947. * Defines the list of key codes associated with the down action (decrease alpha)
  104948. */
  104949. keysDown: number[];
  104950. /**
  104951. * Defines the list of key codes associated with the left action (increase beta)
  104952. */
  104953. keysLeft: number[];
  104954. /**
  104955. * Defines the list of key codes associated with the right action (decrease beta)
  104956. */
  104957. keysRight: number[];
  104958. /**
  104959. * Defines the list of key codes associated with the reset action.
  104960. * Those keys reset the camera to its last stored state (with the method camera.storeState())
  104961. */
  104962. keysReset: number[];
  104963. /**
  104964. * Defines the panning sensibility of the inputs.
  104965. * (How fast is the camera paning)
  104966. */
  104967. panningSensibility: number;
  104968. /**
  104969. * Defines the zooming sensibility of the inputs.
  104970. * (How fast is the camera zooming)
  104971. */
  104972. zoomingSensibility: number;
  104973. /**
  104974. * Defines wether maintaining the alt key down switch the movement mode from
  104975. * orientation to zoom.
  104976. */
  104977. useAltToZoom: boolean;
  104978. /**
  104979. * Rotation speed of the camera
  104980. */
  104981. angularSpeed: number;
  104982. private _keys;
  104983. private _ctrlPressed;
  104984. private _altPressed;
  104985. private _onCanvasBlurObserver;
  104986. private _onKeyboardObserver;
  104987. private _engine;
  104988. private _scene;
  104989. /**
  104990. * Attach the input controls to a specific dom element to get the input from.
  104991. * @param element Defines the element the controls should be listened from
  104992. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  104993. */
  104994. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  104995. /**
  104996. * Detach the current controls from the specified dom element.
  104997. * @param element Defines the element to stop listening the inputs from
  104998. */
  104999. detachControl(element: Nullable<HTMLElement>): void;
  105000. /**
  105001. * Update the current camera state depending on the inputs that have been used this frame.
  105002. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  105003. */
  105004. checkInputs(): void;
  105005. /**
  105006. * Gets the class name of the current intput.
  105007. * @returns the class name
  105008. */
  105009. getClassName(): string;
  105010. /**
  105011. * Get the friendly name associated with the input class.
  105012. * @returns the input friendly name
  105013. */
  105014. getSimpleName(): string;
  105015. }
  105016. }
  105017. declare module BABYLON {
  105018. /**
  105019. * Manage the mouse wheel inputs to control an arc rotate camera.
  105020. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  105021. */
  105022. export class ArcRotateCameraMouseWheelInput implements ICameraInput<ArcRotateCamera> {
  105023. /**
  105024. * Defines the camera the input is attached to.
  105025. */
  105026. camera: ArcRotateCamera;
  105027. /**
  105028. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  105029. */
  105030. wheelPrecision: number;
  105031. /**
  105032. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  105033. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  105034. */
  105035. wheelDeltaPercentage: number;
  105036. private _wheel;
  105037. private _observer;
  105038. private computeDeltaFromMouseWheelLegacyEvent;
  105039. /**
  105040. * Attach the input controls to a specific dom element to get the input from.
  105041. * @param element Defines the element the controls should be listened from
  105042. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  105043. */
  105044. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  105045. /**
  105046. * Detach the current controls from the specified dom element.
  105047. * @param element Defines the element to stop listening the inputs from
  105048. */
  105049. detachControl(element: Nullable<HTMLElement>): void;
  105050. /**
  105051. * Gets the class name of the current intput.
  105052. * @returns the class name
  105053. */
  105054. getClassName(): string;
  105055. /**
  105056. * Get the friendly name associated with the input class.
  105057. * @returns the input friendly name
  105058. */
  105059. getSimpleName(): string;
  105060. }
  105061. }
  105062. declare module BABYLON {
  105063. /**
  105064. * Default Inputs manager for the ArcRotateCamera.
  105065. * It groups all the default supported inputs for ease of use.
  105066. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  105067. */
  105068. export class ArcRotateCameraInputsManager extends CameraInputsManager<ArcRotateCamera> {
  105069. /**
  105070. * Instantiates a new ArcRotateCameraInputsManager.
  105071. * @param camera Defines the camera the inputs belong to
  105072. */
  105073. constructor(camera: ArcRotateCamera);
  105074. /**
  105075. * Add mouse wheel input support to the input manager.
  105076. * @returns the current input manager
  105077. */
  105078. addMouseWheel(): ArcRotateCameraInputsManager;
  105079. /**
  105080. * Add pointers input support to the input manager.
  105081. * @returns the current input manager
  105082. */
  105083. addPointers(): ArcRotateCameraInputsManager;
  105084. /**
  105085. * Add keyboard input support to the input manager.
  105086. * @returns the current input manager
  105087. */
  105088. addKeyboard(): ArcRotateCameraInputsManager;
  105089. }
  105090. }
  105091. declare module BABYLON {
  105092. /**
  105093. * This represents an orbital type of camera.
  105094. *
  105095. * 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.
  105096. * 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.
  105097. * @see http://doc.babylonjs.com/babylon101/cameras#arc-rotate-camera
  105098. */
  105099. export class ArcRotateCamera extends TargetCamera {
  105100. /**
  105101. * Defines the rotation angle of the camera along the longitudinal axis.
  105102. */
  105103. alpha: number;
  105104. /**
  105105. * Defines the rotation angle of the camera along the latitudinal axis.
  105106. */
  105107. beta: number;
  105108. /**
  105109. * Defines the radius of the camera from it s target point.
  105110. */
  105111. radius: number;
  105112. protected _target: Vector3;
  105113. protected _targetHost: Nullable<AbstractMesh>;
  105114. /**
  105115. * Defines the target point of the camera.
  105116. * The camera looks towards it form the radius distance.
  105117. */
  105118. target: Vector3;
  105119. /**
  105120. * Define the current local position of the camera in the scene
  105121. */
  105122. position: Vector3;
  105123. protected _upVector: Vector3;
  105124. protected _upToYMatrix: Matrix;
  105125. protected _YToUpMatrix: Matrix;
  105126. /**
  105127. * The vector the camera should consider as up. (default is Vector3(0, 1, 0) as returned by Vector3.Up())
  105128. * Setting this will copy the given vector to the camera's upVector, and set rotation matrices to and from Y up.
  105129. * DO NOT set the up vector using copyFrom or copyFromFloats, as this bypasses setting the above matrices.
  105130. */
  105131. upVector: Vector3;
  105132. /**
  105133. * Sets the Y-up to camera up-vector rotation matrix, and the up-vector to Y-up rotation matrix.
  105134. */
  105135. setMatUp(): void;
  105136. /**
  105137. * Current inertia value on the longitudinal axis.
  105138. * The bigger this number the longer it will take for the camera to stop.
  105139. */
  105140. inertialAlphaOffset: number;
  105141. /**
  105142. * Current inertia value on the latitudinal axis.
  105143. * The bigger this number the longer it will take for the camera to stop.
  105144. */
  105145. inertialBetaOffset: number;
  105146. /**
  105147. * Current inertia value on the radius axis.
  105148. * The bigger this number the longer it will take for the camera to stop.
  105149. */
  105150. inertialRadiusOffset: number;
  105151. /**
  105152. * Minimum allowed angle on the longitudinal axis.
  105153. * This can help limiting how the Camera is able to move in the scene.
  105154. */
  105155. lowerAlphaLimit: Nullable<number>;
  105156. /**
  105157. * Maximum allowed angle on the longitudinal axis.
  105158. * This can help limiting how the Camera is able to move in the scene.
  105159. */
  105160. upperAlphaLimit: Nullable<number>;
  105161. /**
  105162. * Minimum allowed angle on the latitudinal axis.
  105163. * This can help limiting how the Camera is able to move in the scene.
  105164. */
  105165. lowerBetaLimit: number;
  105166. /**
  105167. * Maximum allowed angle on the latitudinal axis.
  105168. * This can help limiting how the Camera is able to move in the scene.
  105169. */
  105170. upperBetaLimit: number;
  105171. /**
  105172. * Minimum allowed distance of the camera to the target (The camera can not get closer).
  105173. * This can help limiting how the Camera is able to move in the scene.
  105174. */
  105175. lowerRadiusLimit: Nullable<number>;
  105176. /**
  105177. * Maximum allowed distance of the camera to the target (The camera can not get further).
  105178. * This can help limiting how the Camera is able to move in the scene.
  105179. */
  105180. upperRadiusLimit: Nullable<number>;
  105181. /**
  105182. * Defines the current inertia value used during panning of the camera along the X axis.
  105183. */
  105184. inertialPanningX: number;
  105185. /**
  105186. * Defines the current inertia value used during panning of the camera along the Y axis.
  105187. */
  105188. inertialPanningY: number;
  105189. /**
  105190. * Defines the distance used to consider the camera in pan mode vs pinch/zoom.
  105191. * Basically if your fingers moves away from more than this distance you will be considered
  105192. * in pinch mode.
  105193. */
  105194. pinchToPanMaxDistance: number;
  105195. /**
  105196. * Defines the maximum distance the camera can pan.
  105197. * This could help keeping the cammera always in your scene.
  105198. */
  105199. panningDistanceLimit: Nullable<number>;
  105200. /**
  105201. * Defines the target of the camera before paning.
  105202. */
  105203. panningOriginTarget: Vector3;
  105204. /**
  105205. * Defines the value of the inertia used during panning.
  105206. * 0 would mean stop inertia and one would mean no decelleration at all.
  105207. */
  105208. panningInertia: number;
  105209. /**
  105210. * Gets or Set the pointer angular sensibility along the X axis or how fast is the camera rotating.
  105211. */
  105212. angularSensibilityX: number;
  105213. /**
  105214. * Gets or Set the pointer angular sensibility along the Y axis or how fast is the camera rotating.
  105215. */
  105216. angularSensibilityY: number;
  105217. /**
  105218. * Gets or Set the pointer pinch precision or how fast is the camera zooming.
  105219. */
  105220. pinchPrecision: number;
  105221. /**
  105222. * Gets or Set the pointer pinch delta percentage or how fast is the camera zooming.
  105223. * It will be used instead of pinchDeltaPrecision if different from 0.
  105224. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  105225. */
  105226. pinchDeltaPercentage: number;
  105227. /**
  105228. * Gets or Set the pointer panning sensibility or how fast is the camera moving.
  105229. */
  105230. panningSensibility: number;
  105231. /**
  105232. * Gets or Set the list of keyboard keys used to control beta angle in a positive direction.
  105233. */
  105234. keysUp: number[];
  105235. /**
  105236. * Gets or Set the list of keyboard keys used to control beta angle in a negative direction.
  105237. */
  105238. keysDown: number[];
  105239. /**
  105240. * Gets or Set the list of keyboard keys used to control alpha angle in a negative direction.
  105241. */
  105242. keysLeft: number[];
  105243. /**
  105244. * Gets or Set the list of keyboard keys used to control alpha angle in a positive direction.
  105245. */
  105246. keysRight: number[];
  105247. /**
  105248. * Gets or Set the mouse wheel precision or how fast is the camera zooming.
  105249. */
  105250. wheelPrecision: number;
  105251. /**
  105252. * Gets or Set the mouse wheel delta percentage or how fast is the camera zooming.
  105253. * It will be used instead of pinchDeltaPrecision if different from 0.
  105254. * It defines the percentage of current camera.radius to use as delta when pinch zoom is used.
  105255. */
  105256. wheelDeltaPercentage: number;
  105257. /**
  105258. * Defines how much the radius should be scaled while zomming on a particular mesh (through the zoomOn function)
  105259. */
  105260. zoomOnFactor: number;
  105261. /**
  105262. * Defines a screen offset for the camera position.
  105263. */
  105264. targetScreenOffset: Vector2;
  105265. /**
  105266. * Allows the camera to be completely reversed.
  105267. * If false the camera can not arrive upside down.
  105268. */
  105269. allowUpsideDown: boolean;
  105270. /**
  105271. * Define if double tap/click is used to restore the previously saved state of the camera.
  105272. */
  105273. useInputToRestoreState: boolean;
  105274. /** @hidden */
  105275. _viewMatrix: Matrix;
  105276. /** @hidden */
  105277. _useCtrlForPanning: boolean;
  105278. /** @hidden */
  105279. _panningMouseButton: number;
  105280. /**
  105281. * Defines the input associated to the camera.
  105282. */
  105283. inputs: ArcRotateCameraInputsManager;
  105284. /** @hidden */
  105285. _reset: () => void;
  105286. /**
  105287. * Defines the allowed panning axis.
  105288. */
  105289. panningAxis: Vector3;
  105290. protected _localDirection: Vector3;
  105291. protected _transformedDirection: Vector3;
  105292. private _bouncingBehavior;
  105293. /**
  105294. * Gets the bouncing behavior of the camera if it has been enabled.
  105295. * @see http://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  105296. */
  105297. readonly bouncingBehavior: Nullable<BouncingBehavior>;
  105298. /**
  105299. * Defines if the bouncing behavior of the camera is enabled on the camera.
  105300. * @see http://doc.babylonjs.com/how_to/camera_behaviors#bouncing-behavior
  105301. */
  105302. useBouncingBehavior: boolean;
  105303. private _framingBehavior;
  105304. /**
  105305. * Gets the framing behavior of the camera if it has been enabled.
  105306. * @see http://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  105307. */
  105308. readonly framingBehavior: Nullable<FramingBehavior>;
  105309. /**
  105310. * Defines if the framing behavior of the camera is enabled on the camera.
  105311. * @see http://doc.babylonjs.com/how_to/camera_behaviors#framing-behavior
  105312. */
  105313. useFramingBehavior: boolean;
  105314. private _autoRotationBehavior;
  105315. /**
  105316. * Gets the auto rotation behavior of the camera if it has been enabled.
  105317. * @see http://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  105318. */
  105319. readonly autoRotationBehavior: Nullable<AutoRotationBehavior>;
  105320. /**
  105321. * Defines if the auto rotation behavior of the camera is enabled on the camera.
  105322. * @see http://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  105323. */
  105324. useAutoRotationBehavior: boolean;
  105325. /**
  105326. * Observable triggered when the mesh target has been changed on the camera.
  105327. */
  105328. onMeshTargetChangedObservable: Observable<Nullable<AbstractMesh>>;
  105329. /**
  105330. * Event raised when the camera is colliding with a mesh.
  105331. */
  105332. onCollide: (collidedMesh: AbstractMesh) => void;
  105333. /**
  105334. * Defines whether the camera should check collision with the objects oh the scene.
  105335. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#how-can-i-do-this
  105336. */
  105337. checkCollisions: boolean;
  105338. /**
  105339. * Defines the collision radius of the camera.
  105340. * This simulates a sphere around the camera.
  105341. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  105342. */
  105343. collisionRadius: Vector3;
  105344. protected _collider: Collider;
  105345. protected _previousPosition: Vector3;
  105346. protected _collisionVelocity: Vector3;
  105347. protected _newPosition: Vector3;
  105348. protected _previousAlpha: number;
  105349. protected _previousBeta: number;
  105350. protected _previousRadius: number;
  105351. protected _collisionTriggered: boolean;
  105352. protected _targetBoundingCenter: Nullable<Vector3>;
  105353. private _computationVector;
  105354. /**
  105355. * Instantiates a new ArcRotateCamera in a given scene
  105356. * @param name Defines the name of the camera
  105357. * @param alpha Defines the camera rotation along the logitudinal axis
  105358. * @param beta Defines the camera rotation along the latitudinal axis
  105359. * @param radius Defines the camera distance from its target
  105360. * @param target Defines the camera target
  105361. * @param scene Defines the scene the camera belongs to
  105362. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active if not other active cameras have been defined
  105363. */
  105364. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  105365. /** @hidden */
  105366. _initCache(): void;
  105367. /** @hidden */
  105368. _updateCache(ignoreParentClass?: boolean): void;
  105369. protected _getTargetPosition(): Vector3;
  105370. private _storedAlpha;
  105371. private _storedBeta;
  105372. private _storedRadius;
  105373. private _storedTarget;
  105374. private _storedTargetScreenOffset;
  105375. /**
  105376. * Stores the current state of the camera (alpha, beta, radius and target)
  105377. * @returns the camera itself
  105378. */
  105379. storeState(): Camera;
  105380. /**
  105381. * @hidden
  105382. * Restored camera state. You must call storeState() first
  105383. */
  105384. _restoreStateValues(): boolean;
  105385. /** @hidden */
  105386. _isSynchronizedViewMatrix(): boolean;
  105387. /**
  105388. * Attached controls to the current camera.
  105389. * @param element Defines the element the controls should be listened from
  105390. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  105391. * @param useCtrlForPanning Defines whether ctrl is used for paning within the controls
  105392. * @param panningMouseButton Defines whether panning is allowed through mouse click button
  105393. */
  105394. attachControl(element: HTMLElement, noPreventDefault?: boolean, useCtrlForPanning?: boolean, panningMouseButton?: number): void;
  105395. /**
  105396. * Detach the current controls from the camera.
  105397. * The camera will stop reacting to inputs.
  105398. * @param element Defines the element to stop listening the inputs from
  105399. */
  105400. detachControl(element: HTMLElement): void;
  105401. /** @hidden */
  105402. _checkInputs(): void;
  105403. protected _checkLimits(): void;
  105404. /**
  105405. * Rebuilds angles (alpha, beta) and radius from the give position and target
  105406. */
  105407. rebuildAnglesAndRadius(): void;
  105408. /**
  105409. * Use a position to define the current camera related information like alpha, beta and radius
  105410. * @param position Defines the position to set the camera at
  105411. */
  105412. setPosition(position: Vector3): void;
  105413. /**
  105414. * Defines the target the camera should look at.
  105415. * This will automatically adapt alpha beta and radius to fit within the new target.
  105416. * @param target Defines the new target as a Vector or a mesh
  105417. * @param toBoundingCenter In case of a mesh target, defines wether to target the mesh position or its bounding information center
  105418. * @param allowSamePosition If false, prevents reapplying the new computed position if it is identical to the current one (optim)
  105419. */
  105420. setTarget(target: AbstractMesh | Vector3, toBoundingCenter?: boolean, allowSamePosition?: boolean): void;
  105421. /** @hidden */
  105422. _getViewMatrix(): Matrix;
  105423. protected _onCollisionPositionChange: (collisionId: number, newPosition: Vector3, collidedMesh?: Nullable<AbstractMesh>) => void;
  105424. /**
  105425. * Zooms on a mesh to be at the min distance where we could see it fully in the current viewport.
  105426. * @param meshes Defines the mesh to zoom on
  105427. * @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)
  105428. */
  105429. zoomOn(meshes?: AbstractMesh[], doNotUpdateMaxZ?: boolean): void;
  105430. /**
  105431. * Focus on a mesh or a bounding box. This adapts the target and maxRadius if necessary but does not update the current radius.
  105432. * The target will be changed but the radius
  105433. * @param meshesOrMinMaxVectorAndDistance Defines the mesh or bounding info to focus on
  105434. * @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)
  105435. */
  105436. focusOn(meshesOrMinMaxVectorAndDistance: AbstractMesh[] | {
  105437. min: Vector3;
  105438. max: Vector3;
  105439. distance: number;
  105440. }, doNotUpdateMaxZ?: boolean): void;
  105441. /**
  105442. * @override
  105443. * Override Camera.createRigCamera
  105444. */
  105445. createRigCamera(name: string, cameraIndex: number): Camera;
  105446. /**
  105447. * @hidden
  105448. * @override
  105449. * Override Camera._updateRigCameras
  105450. */
  105451. _updateRigCameras(): void;
  105452. /**
  105453. * Destroy the camera and release the current resources hold by it.
  105454. */
  105455. dispose(): void;
  105456. /**
  105457. * Gets the current object class name.
  105458. * @return the class name
  105459. */
  105460. getClassName(): string;
  105461. }
  105462. }
  105463. declare module BABYLON {
  105464. /**
  105465. * The autoRotation behavior (AutoRotationBehavior) is designed to create a smooth rotation of an ArcRotateCamera when there is no user interaction.
  105466. * @see http://doc.babylonjs.com/how_to/camera_behaviors#autorotation-behavior
  105467. */
  105468. export class AutoRotationBehavior implements Behavior<ArcRotateCamera> {
  105469. /**
  105470. * Gets the name of the behavior.
  105471. */
  105472. readonly name: string;
  105473. private _zoomStopsAnimation;
  105474. private _idleRotationSpeed;
  105475. private _idleRotationWaitTime;
  105476. private _idleRotationSpinupTime;
  105477. /**
  105478. * Sets the flag that indicates if user zooming should stop animation.
  105479. */
  105480. /**
  105481. * Gets the flag that indicates if user zooming should stop animation.
  105482. */
  105483. zoomStopsAnimation: boolean;
  105484. /**
  105485. * Sets the default speed at which the camera rotates around the model.
  105486. */
  105487. /**
  105488. * Gets the default speed at which the camera rotates around the model.
  105489. */
  105490. idleRotationSpeed: number;
  105491. /**
  105492. * Sets the time (in milliseconds) to wait after user interaction before the camera starts rotating.
  105493. */
  105494. /**
  105495. * Gets the time (milliseconds) to wait after user interaction before the camera starts rotating.
  105496. */
  105497. idleRotationWaitTime: number;
  105498. /**
  105499. * Sets the time (milliseconds) to take to spin up to the full idle rotation speed.
  105500. */
  105501. /**
  105502. * Gets the time (milliseconds) to take to spin up to the full idle rotation speed.
  105503. */
  105504. idleRotationSpinupTime: number;
  105505. /**
  105506. * Gets a value indicating if the camera is currently rotating because of this behavior
  105507. */
  105508. readonly rotationInProgress: boolean;
  105509. private _onPrePointerObservableObserver;
  105510. private _onAfterCheckInputsObserver;
  105511. private _attachedCamera;
  105512. private _isPointerDown;
  105513. private _lastFrameTime;
  105514. private _lastInteractionTime;
  105515. private _cameraRotationSpeed;
  105516. /**
  105517. * Initializes the behavior.
  105518. */
  105519. init(): void;
  105520. /**
  105521. * Attaches the behavior to its arc rotate camera.
  105522. * @param camera Defines the camera to attach the behavior to
  105523. */
  105524. attach(camera: ArcRotateCamera): void;
  105525. /**
  105526. * Detaches the behavior from its current arc rotate camera.
  105527. */
  105528. detach(): void;
  105529. /**
  105530. * Returns true if user is scrolling.
  105531. * @return true if user is scrolling.
  105532. */
  105533. private _userIsZooming;
  105534. private _lastFrameRadius;
  105535. private _shouldAnimationStopForInteraction;
  105536. /**
  105537. * Applies any current user interaction to the camera. Takes into account maximum alpha rotation.
  105538. */
  105539. private _applyUserInteraction;
  105540. private _userIsMoving;
  105541. }
  105542. }
  105543. declare module BABYLON {
  105544. /**
  105545. * A behavior that when attached to a mesh will will place a specified node on the meshes face pointing towards the camera
  105546. */
  105547. export class AttachToBoxBehavior implements Behavior<Mesh> {
  105548. private ui;
  105549. /**
  105550. * The name of the behavior
  105551. */
  105552. name: string;
  105553. /**
  105554. * The distance away from the face of the mesh that the UI should be attached to (default: 0.15)
  105555. */
  105556. distanceAwayFromFace: number;
  105557. /**
  105558. * The distance from the bottom of the face that the UI should be attached to (default: 0.15)
  105559. */
  105560. distanceAwayFromBottomOfFace: number;
  105561. private _faceVectors;
  105562. private _target;
  105563. private _scene;
  105564. private _onRenderObserver;
  105565. private _tmpMatrix;
  105566. private _tmpVector;
  105567. /**
  105568. * Creates the AttachToBoxBehavior, used to attach UI to the closest face of the box to a camera
  105569. * @param ui The transform node that should be attched to the mesh
  105570. */
  105571. constructor(ui: TransformNode);
  105572. /**
  105573. * Initializes the behavior
  105574. */
  105575. init(): void;
  105576. private _closestFace;
  105577. private _zeroVector;
  105578. private _lookAtTmpMatrix;
  105579. private _lookAtToRef;
  105580. /**
  105581. * Attaches the AttachToBoxBehavior to the passed in mesh
  105582. * @param target The mesh that the specified node will be attached to
  105583. */
  105584. attach(target: Mesh): void;
  105585. /**
  105586. * Detaches the behavior from the mesh
  105587. */
  105588. detach(): void;
  105589. }
  105590. }
  105591. declare module BABYLON {
  105592. /**
  105593. * A behavior that when attached to a mesh will allow the mesh to fade in and out
  105594. */
  105595. export class FadeInOutBehavior implements Behavior<Mesh> {
  105596. /**
  105597. * Time in milliseconds to delay before fading in (Default: 0)
  105598. */
  105599. delay: number;
  105600. /**
  105601. * Time in milliseconds for the mesh to fade in (Default: 300)
  105602. */
  105603. fadeInTime: number;
  105604. private _millisecondsPerFrame;
  105605. private _hovered;
  105606. private _hoverValue;
  105607. private _ownerNode;
  105608. /**
  105609. * Instatiates the FadeInOutBehavior
  105610. */
  105611. constructor();
  105612. /**
  105613. * The name of the behavior
  105614. */
  105615. readonly name: string;
  105616. /**
  105617. * Initializes the behavior
  105618. */
  105619. init(): void;
  105620. /**
  105621. * Attaches the fade behavior on the passed in mesh
  105622. * @param ownerNode The mesh that will be faded in/out once attached
  105623. */
  105624. attach(ownerNode: Mesh): void;
  105625. /**
  105626. * Detaches the behavior from the mesh
  105627. */
  105628. detach(): void;
  105629. /**
  105630. * Triggers the mesh to begin fading in or out
  105631. * @param value if the object should fade in or out (true to fade in)
  105632. */
  105633. fadeIn(value: boolean): void;
  105634. private _update;
  105635. private _setAllVisibility;
  105636. }
  105637. }
  105638. declare module BABYLON {
  105639. /**
  105640. * Class containing a set of static utilities functions for managing Pivots
  105641. * @hidden
  105642. */
  105643. export class PivotTools {
  105644. private static _PivotCached;
  105645. private static _OldPivotPoint;
  105646. private static _PivotTranslation;
  105647. private static _PivotTmpVector;
  105648. /** @hidden */
  105649. static _RemoveAndStorePivotPoint(mesh: AbstractMesh): void;
  105650. /** @hidden */
  105651. static _RestorePivotPoint(mesh: AbstractMesh): void;
  105652. }
  105653. }
  105654. declare module BABYLON {
  105655. /**
  105656. * Class containing static functions to help procedurally build meshes
  105657. */
  105658. export class PlaneBuilder {
  105659. /**
  105660. * Creates a plane mesh
  105661. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  105662. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  105663. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  105664. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  105665. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  105666. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  105667. * @param name defines the name of the mesh
  105668. * @param options defines the options used to create the mesh
  105669. * @param scene defines the hosting scene
  105670. * @returns the plane mesh
  105671. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  105672. */
  105673. static CreatePlane(name: string, options: {
  105674. size?: number;
  105675. width?: number;
  105676. height?: number;
  105677. sideOrientation?: number;
  105678. frontUVs?: Vector4;
  105679. backUVs?: Vector4;
  105680. updatable?: boolean;
  105681. sourcePlane?: Plane;
  105682. }, scene?: Nullable<Scene>): Mesh;
  105683. }
  105684. }
  105685. declare module BABYLON {
  105686. /**
  105687. * A behavior that when attached to a mesh will allow the mesh to be dragged around the screen based on pointer events
  105688. */
  105689. export class PointerDragBehavior implements Behavior<AbstractMesh> {
  105690. private static _AnyMouseID;
  105691. /**
  105692. * Abstract mesh the behavior is set on
  105693. */
  105694. attachedNode: AbstractMesh;
  105695. private _dragPlane;
  105696. private _scene;
  105697. private _pointerObserver;
  105698. private _beforeRenderObserver;
  105699. private static _planeScene;
  105700. private _useAlternatePickedPointAboveMaxDragAngleDragSpeed;
  105701. /**
  105702. * 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)
  105703. */
  105704. maxDragAngle: number;
  105705. /**
  105706. * @hidden
  105707. */
  105708. _useAlternatePickedPointAboveMaxDragAngle: boolean;
  105709. /**
  105710. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  105711. */
  105712. currentDraggingPointerID: number;
  105713. /**
  105714. * The last position where the pointer hit the drag plane in world space
  105715. */
  105716. lastDragPosition: Vector3;
  105717. /**
  105718. * If the behavior is currently in a dragging state
  105719. */
  105720. dragging: boolean;
  105721. /**
  105722. * 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)
  105723. */
  105724. dragDeltaRatio: number;
  105725. /**
  105726. * If the drag plane orientation should be updated during the dragging (Default: true)
  105727. */
  105728. updateDragPlane: boolean;
  105729. private _debugMode;
  105730. private _moving;
  105731. /**
  105732. * Fires each time the attached mesh is dragged with the pointer
  105733. * * delta between last drag position and current drag position in world space
  105734. * * dragDistance along the drag axis
  105735. * * dragPlaneNormal normal of the current drag plane used during the drag
  105736. * * dragPlanePoint in world space where the drag intersects the drag plane
  105737. */
  105738. onDragObservable: Observable<{
  105739. delta: Vector3;
  105740. dragPlanePoint: Vector3;
  105741. dragPlaneNormal: Vector3;
  105742. dragDistance: number;
  105743. pointerId: number;
  105744. }>;
  105745. /**
  105746. * Fires each time a drag begins (eg. mouse down on mesh)
  105747. */
  105748. onDragStartObservable: Observable<{
  105749. dragPlanePoint: Vector3;
  105750. pointerId: number;
  105751. }>;
  105752. /**
  105753. * Fires each time a drag ends (eg. mouse release after drag)
  105754. */
  105755. onDragEndObservable: Observable<{
  105756. dragPlanePoint: Vector3;
  105757. pointerId: number;
  105758. }>;
  105759. /**
  105760. * If the attached mesh should be moved when dragged
  105761. */
  105762. moveAttached: boolean;
  105763. /**
  105764. * If the drag behavior will react to drag events (Default: true)
  105765. */
  105766. enabled: boolean;
  105767. /**
  105768. * If pointer events should start and release the drag (Default: true)
  105769. */
  105770. startAndReleaseDragOnPointerEvents: boolean;
  105771. /**
  105772. * If camera controls should be detached during the drag
  105773. */
  105774. detachCameraControls: boolean;
  105775. /**
  105776. * If set, the drag plane/axis will be rotated based on the attached mesh's world rotation (Default: true)
  105777. */
  105778. useObjectOrienationForDragging: boolean;
  105779. private _options;
  105780. /**
  105781. * Creates a pointer drag behavior that can be attached to a mesh
  105782. * @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)
  105783. */
  105784. constructor(options?: {
  105785. dragAxis?: Vector3;
  105786. dragPlaneNormal?: Vector3;
  105787. });
  105788. /**
  105789. * Predicate to determine if it is valid to move the object to a new position when it is moved
  105790. */
  105791. validateDrag: (targetPosition: Vector3) => boolean;
  105792. /**
  105793. * The name of the behavior
  105794. */
  105795. readonly name: string;
  105796. /**
  105797. * Initializes the behavior
  105798. */
  105799. init(): void;
  105800. private _tmpVector;
  105801. private _alternatePickedPoint;
  105802. private _worldDragAxis;
  105803. private _targetPosition;
  105804. private _attachedElement;
  105805. /**
  105806. * Attaches the drag behavior the passed in mesh
  105807. * @param ownerNode The mesh that will be dragged around once attached
  105808. * @param predicate Predicate to use for pick filtering
  105809. */
  105810. attach(ownerNode: AbstractMesh, predicate?: (m: AbstractMesh) => boolean): void;
  105811. /**
  105812. * Force relase the drag action by code.
  105813. */
  105814. releaseDrag(): void;
  105815. private _startDragRay;
  105816. private _lastPointerRay;
  105817. /**
  105818. * Simulates the start of a pointer drag event on the behavior
  105819. * @param pointerId pointerID of the pointer that should be simulated (Default: Any mouse pointer ID)
  105820. * @param fromRay initial ray of the pointer to be simulated (Default: Ray from camera to attached mesh)
  105821. * @param startPickedPoint picked point of the pointer to be simulated (Default: attached mesh position)
  105822. */
  105823. startDrag(pointerId?: number, fromRay?: Ray, startPickedPoint?: Vector3): void;
  105824. private _startDrag;
  105825. private _dragDelta;
  105826. private _moveDrag;
  105827. private _pickWithRayOnDragPlane;
  105828. private _pointA;
  105829. private _pointB;
  105830. private _pointC;
  105831. private _lineA;
  105832. private _lineB;
  105833. private _localAxis;
  105834. private _lookAt;
  105835. private _updateDragPlanePosition;
  105836. /**
  105837. * Detaches the behavior from the mesh
  105838. */
  105839. detach(): void;
  105840. }
  105841. }
  105842. declare module BABYLON {
  105843. /**
  105844. * A behavior that when attached to a mesh will allow the mesh to be scaled
  105845. */
  105846. export class MultiPointerScaleBehavior implements Behavior<Mesh> {
  105847. private _dragBehaviorA;
  105848. private _dragBehaviorB;
  105849. private _startDistance;
  105850. private _initialScale;
  105851. private _targetScale;
  105852. private _ownerNode;
  105853. private _sceneRenderObserver;
  105854. /**
  105855. * Instantiate a new behavior that when attached to a mesh will allow the mesh to be scaled
  105856. */
  105857. constructor();
  105858. /**
  105859. * The name of the behavior
  105860. */
  105861. readonly name: string;
  105862. /**
  105863. * Initializes the behavior
  105864. */
  105865. init(): void;
  105866. private _getCurrentDistance;
  105867. /**
  105868. * Attaches the scale behavior the passed in mesh
  105869. * @param ownerNode The mesh that will be scaled around once attached
  105870. */
  105871. attach(ownerNode: Mesh): void;
  105872. /**
  105873. * Detaches the behavior from the mesh
  105874. */
  105875. detach(): void;
  105876. }
  105877. }
  105878. declare module BABYLON {
  105879. /**
  105880. * 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
  105881. */
  105882. export class SixDofDragBehavior implements Behavior<Mesh> {
  105883. private static _virtualScene;
  105884. private _ownerNode;
  105885. private _sceneRenderObserver;
  105886. private _scene;
  105887. private _targetPosition;
  105888. private _virtualOriginMesh;
  105889. private _virtualDragMesh;
  105890. private _pointerObserver;
  105891. private _moving;
  105892. private _startingOrientation;
  105893. /**
  105894. * 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)
  105895. */
  105896. private zDragFactor;
  105897. /**
  105898. * If the object should rotate to face the drag origin
  105899. */
  105900. rotateDraggedObject: boolean;
  105901. /**
  105902. * If the behavior is currently in a dragging state
  105903. */
  105904. dragging: boolean;
  105905. /**
  105906. * 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)
  105907. */
  105908. dragDeltaRatio: number;
  105909. /**
  105910. * The id of the pointer that is currently interacting with the behavior (-1 when no pointer is active)
  105911. */
  105912. currentDraggingPointerID: number;
  105913. /**
  105914. * If camera controls should be detached during the drag
  105915. */
  105916. detachCameraControls: boolean;
  105917. /**
  105918. * Fires each time a drag starts
  105919. */
  105920. onDragStartObservable: Observable<{}>;
  105921. /**
  105922. * Fires each time a drag ends (eg. mouse release after drag)
  105923. */
  105924. onDragEndObservable: Observable<{}>;
  105925. /**
  105926. * 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
  105927. */
  105928. constructor();
  105929. /**
  105930. * The name of the behavior
  105931. */
  105932. readonly name: string;
  105933. /**
  105934. * Initializes the behavior
  105935. */
  105936. init(): void;
  105937. /**
  105938. * In the case of multiplea active cameras, the cameraToUseForPointers should be used if set instead of active camera
  105939. */
  105940. private readonly _pointerCamera;
  105941. /**
  105942. * Attaches the scale behavior the passed in mesh
  105943. * @param ownerNode The mesh that will be scaled around once attached
  105944. */
  105945. attach(ownerNode: Mesh): void;
  105946. /**
  105947. * Detaches the behavior from the mesh
  105948. */
  105949. detach(): void;
  105950. }
  105951. }
  105952. declare module BABYLON {
  105953. /**
  105954. * Class used to apply inverse kinematics to bones
  105955. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#boneikcontroller
  105956. */
  105957. export class BoneIKController {
  105958. private static _tmpVecs;
  105959. private static _tmpQuat;
  105960. private static _tmpMats;
  105961. /**
  105962. * Gets or sets the target mesh
  105963. */
  105964. targetMesh: AbstractMesh;
  105965. /** Gets or sets the mesh used as pole */
  105966. poleTargetMesh: AbstractMesh;
  105967. /**
  105968. * Gets or sets the bone used as pole
  105969. */
  105970. poleTargetBone: Nullable<Bone>;
  105971. /**
  105972. * Gets or sets the target position
  105973. */
  105974. targetPosition: Vector3;
  105975. /**
  105976. * Gets or sets the pole target position
  105977. */
  105978. poleTargetPosition: Vector3;
  105979. /**
  105980. * Gets or sets the pole target local offset
  105981. */
  105982. poleTargetLocalOffset: Vector3;
  105983. /**
  105984. * Gets or sets the pole angle
  105985. */
  105986. poleAngle: number;
  105987. /**
  105988. * Gets or sets the mesh associated with the controller
  105989. */
  105990. mesh: AbstractMesh;
  105991. /**
  105992. * 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)
  105993. */
  105994. slerpAmount: number;
  105995. private _bone1Quat;
  105996. private _bone1Mat;
  105997. private _bone2Ang;
  105998. private _bone1;
  105999. private _bone2;
  106000. private _bone1Length;
  106001. private _bone2Length;
  106002. private _maxAngle;
  106003. private _maxReach;
  106004. private _rightHandedSystem;
  106005. private _bendAxis;
  106006. private _slerping;
  106007. private _adjustRoll;
  106008. /**
  106009. * Gets or sets maximum allowed angle
  106010. */
  106011. maxAngle: number;
  106012. /**
  106013. * Creates a new BoneIKController
  106014. * @param mesh defines the mesh to control
  106015. * @param bone defines the bone to control
  106016. * @param options defines options to set up the controller
  106017. */
  106018. constructor(mesh: AbstractMesh, bone: Bone, options?: {
  106019. targetMesh?: AbstractMesh;
  106020. poleTargetMesh?: AbstractMesh;
  106021. poleTargetBone?: Bone;
  106022. poleTargetLocalOffset?: Vector3;
  106023. poleAngle?: number;
  106024. bendAxis?: Vector3;
  106025. maxAngle?: number;
  106026. slerpAmount?: number;
  106027. });
  106028. private _setMaxAngle;
  106029. /**
  106030. * Force the controller to update the bones
  106031. */
  106032. update(): void;
  106033. }
  106034. }
  106035. declare module BABYLON {
  106036. /**
  106037. * Class used to make a bone look toward a point in space
  106038. * @see http://doc.babylonjs.com/how_to/how_to_use_bones_and_skeletons#bonelookcontroller
  106039. */
  106040. export class BoneLookController {
  106041. private static _tmpVecs;
  106042. private static _tmpQuat;
  106043. private static _tmpMats;
  106044. /**
  106045. * The target Vector3 that the bone will look at
  106046. */
  106047. target: Vector3;
  106048. /**
  106049. * The mesh that the bone is attached to
  106050. */
  106051. mesh: AbstractMesh;
  106052. /**
  106053. * The bone that will be looking to the target
  106054. */
  106055. bone: Bone;
  106056. /**
  106057. * The up axis of the coordinate system that is used when the bone is rotated
  106058. */
  106059. upAxis: Vector3;
  106060. /**
  106061. * The space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD
  106062. */
  106063. upAxisSpace: Space;
  106064. /**
  106065. * Used to make an adjustment to the yaw of the bone
  106066. */
  106067. adjustYaw: number;
  106068. /**
  106069. * Used to make an adjustment to the pitch of the bone
  106070. */
  106071. adjustPitch: number;
  106072. /**
  106073. * Used to make an adjustment to the roll of the bone
  106074. */
  106075. adjustRoll: number;
  106076. /**
  106077. * 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)
  106078. */
  106079. slerpAmount: number;
  106080. private _minYaw;
  106081. private _maxYaw;
  106082. private _minPitch;
  106083. private _maxPitch;
  106084. private _minYawSin;
  106085. private _minYawCos;
  106086. private _maxYawSin;
  106087. private _maxYawCos;
  106088. private _midYawConstraint;
  106089. private _minPitchTan;
  106090. private _maxPitchTan;
  106091. private _boneQuat;
  106092. private _slerping;
  106093. private _transformYawPitch;
  106094. private _transformYawPitchInv;
  106095. private _firstFrameSkipped;
  106096. private _yawRange;
  106097. private _fowardAxis;
  106098. /**
  106099. * Gets or sets the minimum yaw angle that the bone can look to
  106100. */
  106101. minYaw: number;
  106102. /**
  106103. * Gets or sets the maximum yaw angle that the bone can look to
  106104. */
  106105. maxYaw: number;
  106106. /**
  106107. * Gets or sets the minimum pitch angle that the bone can look to
  106108. */
  106109. minPitch: number;
  106110. /**
  106111. * Gets or sets the maximum pitch angle that the bone can look to
  106112. */
  106113. maxPitch: number;
  106114. /**
  106115. * Create a BoneLookController
  106116. * @param mesh the mesh that the bone belongs to
  106117. * @param bone the bone that will be looking to the target
  106118. * @param target the target Vector3 to look at
  106119. * @param options optional settings:
  106120. * * maxYaw: the maximum angle the bone will yaw to
  106121. * * minYaw: the minimum angle the bone will yaw to
  106122. * * maxPitch: the maximum angle the bone will pitch to
  106123. * * minPitch: the minimum angle the bone will yaw to
  106124. * * slerpAmount: set the between 0 and 1 to make the bone slerp to the target.
  106125. * * upAxis: the up axis of the coordinate system
  106126. * * upAxisSpace: the space that the up axis is in - Space.BONE, Space.LOCAL (default), or Space.WORLD.
  106127. * * yawAxis: set yawAxis if the bone does not yaw on the y axis
  106128. * * pitchAxis: set pitchAxis if the bone does not pitch on the x axis
  106129. * * adjustYaw: used to make an adjustment to the yaw of the bone
  106130. * * adjustPitch: used to make an adjustment to the pitch of the bone
  106131. * * adjustRoll: used to make an adjustment to the roll of the bone
  106132. **/
  106133. constructor(mesh: AbstractMesh, bone: Bone, target: Vector3, options?: {
  106134. maxYaw?: number;
  106135. minYaw?: number;
  106136. maxPitch?: number;
  106137. minPitch?: number;
  106138. slerpAmount?: number;
  106139. upAxis?: Vector3;
  106140. upAxisSpace?: Space;
  106141. yawAxis?: Vector3;
  106142. pitchAxis?: Vector3;
  106143. adjustYaw?: number;
  106144. adjustPitch?: number;
  106145. adjustRoll?: number;
  106146. });
  106147. /**
  106148. * Update the bone to look at the target. This should be called before the scene is rendered (use scene.registerBeforeRender())
  106149. */
  106150. update(): void;
  106151. private _getAngleDiff;
  106152. private _getAngleBetween;
  106153. private _isAngleBetween;
  106154. }
  106155. }
  106156. declare module BABYLON {
  106157. /**
  106158. * Manage the gamepad inputs to control an arc rotate camera.
  106159. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  106160. */
  106161. export class ArcRotateCameraGamepadInput implements ICameraInput<ArcRotateCamera> {
  106162. /**
  106163. * Defines the camera the input is attached to.
  106164. */
  106165. camera: ArcRotateCamera;
  106166. /**
  106167. * Defines the gamepad the input is gathering event from.
  106168. */
  106169. gamepad: Nullable<Gamepad>;
  106170. /**
  106171. * Defines the gamepad rotation sensiblity.
  106172. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  106173. */
  106174. gamepadRotationSensibility: number;
  106175. /**
  106176. * Defines the gamepad move sensiblity.
  106177. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  106178. */
  106179. gamepadMoveSensibility: number;
  106180. private _yAxisScale;
  106181. /**
  106182. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  106183. */
  106184. invertYAxis: boolean;
  106185. private _onGamepadConnectedObserver;
  106186. private _onGamepadDisconnectedObserver;
  106187. /**
  106188. * Attach the input controls to a specific dom element to get the input from.
  106189. * @param element Defines the element the controls should be listened from
  106190. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  106191. */
  106192. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  106193. /**
  106194. * Detach the current controls from the specified dom element.
  106195. * @param element Defines the element to stop listening the inputs from
  106196. */
  106197. detachControl(element: Nullable<HTMLElement>): void;
  106198. /**
  106199. * Update the current camera state depending on the inputs that have been used this frame.
  106200. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  106201. */
  106202. checkInputs(): void;
  106203. /**
  106204. * Gets the class name of the current intput.
  106205. * @returns the class name
  106206. */
  106207. getClassName(): string;
  106208. /**
  106209. * Get the friendly name associated with the input class.
  106210. * @returns the input friendly name
  106211. */
  106212. getSimpleName(): string;
  106213. }
  106214. }
  106215. declare module BABYLON {
  106216. interface ArcRotateCameraInputsManager {
  106217. /**
  106218. * Add orientation input support to the input manager.
  106219. * @returns the current input manager
  106220. */
  106221. addVRDeviceOrientation(): ArcRotateCameraInputsManager;
  106222. }
  106223. /**
  106224. * Manage the device orientation inputs (gyroscope) to control an arc rotate camera.
  106225. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  106226. */
  106227. export class ArcRotateCameraVRDeviceOrientationInput implements ICameraInput<ArcRotateCamera> {
  106228. /**
  106229. * Defines the camera the input is attached to.
  106230. */
  106231. camera: ArcRotateCamera;
  106232. /**
  106233. * Defines a correction factor applied on the alpha value retrieved from the orientation events.
  106234. */
  106235. alphaCorrection: number;
  106236. /**
  106237. * Defines a correction factor applied on the gamma value retrieved from the orientation events.
  106238. */
  106239. gammaCorrection: number;
  106240. private _alpha;
  106241. private _gamma;
  106242. private _dirty;
  106243. private _deviceOrientationHandler;
  106244. /**
  106245. * Instantiate a new ArcRotateCameraVRDeviceOrientationInput.
  106246. */
  106247. constructor();
  106248. /**
  106249. * Attach the input controls to a specific dom element to get the input from.
  106250. * @param element Defines the element the controls should be listened from
  106251. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  106252. */
  106253. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  106254. /** @hidden */
  106255. _onOrientationEvent(evt: DeviceOrientationEvent): void;
  106256. /**
  106257. * Update the current camera state depending on the inputs that have been used this frame.
  106258. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  106259. */
  106260. checkInputs(): void;
  106261. /**
  106262. * Detach the current controls from the specified dom element.
  106263. * @param element Defines the element to stop listening the inputs from
  106264. */
  106265. detachControl(element: Nullable<HTMLElement>): void;
  106266. /**
  106267. * Gets the class name of the current intput.
  106268. * @returns the class name
  106269. */
  106270. getClassName(): string;
  106271. /**
  106272. * Get the friendly name associated with the input class.
  106273. * @returns the input friendly name
  106274. */
  106275. getSimpleName(): string;
  106276. }
  106277. }
  106278. declare module BABYLON {
  106279. /**
  106280. * Listen to mouse events to control the camera.
  106281. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  106282. */
  106283. export class FlyCameraMouseInput implements ICameraInput<FlyCamera> {
  106284. /**
  106285. * Defines the camera the input is attached to.
  106286. */
  106287. camera: FlyCamera;
  106288. /**
  106289. * Defines if touch is enabled. (Default is true.)
  106290. */
  106291. touchEnabled: boolean;
  106292. /**
  106293. * Defines the buttons associated with the input to handle camera rotation.
  106294. */
  106295. buttons: number[];
  106296. /**
  106297. * Assign buttons for Yaw control.
  106298. */
  106299. buttonsYaw: number[];
  106300. /**
  106301. * Assign buttons for Pitch control.
  106302. */
  106303. buttonsPitch: number[];
  106304. /**
  106305. * Assign buttons for Roll control.
  106306. */
  106307. buttonsRoll: number[];
  106308. /**
  106309. * Detect if any button is being pressed while mouse is moved.
  106310. * -1 = Mouse locked.
  106311. * 0 = Left button.
  106312. * 1 = Middle Button.
  106313. * 2 = Right Button.
  106314. */
  106315. activeButton: number;
  106316. /**
  106317. * Defines the pointer's angular sensibility, to control the camera rotation speed.
  106318. * Higher values reduce its sensitivity.
  106319. */
  106320. angularSensibility: number;
  106321. private _mousemoveCallback;
  106322. private _observer;
  106323. private _rollObserver;
  106324. private previousPosition;
  106325. private noPreventDefault;
  106326. private element;
  106327. /**
  106328. * Listen to mouse events to control the camera.
  106329. * @param touchEnabled Define if touch is enabled. (Default is true.)
  106330. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  106331. */
  106332. constructor(touchEnabled?: boolean);
  106333. /**
  106334. * Attach the mouse control to the HTML DOM element.
  106335. * @param element Defines the element that listens to the input events.
  106336. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault().
  106337. */
  106338. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  106339. /**
  106340. * Detach the current controls from the specified dom element.
  106341. * @param element Defines the element to stop listening the inputs from
  106342. */
  106343. detachControl(element: Nullable<HTMLElement>): void;
  106344. /**
  106345. * Gets the class name of the current input.
  106346. * @returns the class name.
  106347. */
  106348. getClassName(): string;
  106349. /**
  106350. * Get the friendly name associated with the input class.
  106351. * @returns the input's friendly name.
  106352. */
  106353. getSimpleName(): string;
  106354. private _pointerInput;
  106355. private _onMouseMove;
  106356. /**
  106357. * Rotate camera by mouse offset.
  106358. */
  106359. private rotateCamera;
  106360. }
  106361. }
  106362. declare module BABYLON {
  106363. /**
  106364. * Default Inputs manager for the FlyCamera.
  106365. * It groups all the default supported inputs for ease of use.
  106366. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  106367. */
  106368. export class FlyCameraInputsManager extends CameraInputsManager<FlyCamera> {
  106369. /**
  106370. * Instantiates a new FlyCameraInputsManager.
  106371. * @param camera Defines the camera the inputs belong to.
  106372. */
  106373. constructor(camera: FlyCamera);
  106374. /**
  106375. * Add keyboard input support to the input manager.
  106376. * @returns the new FlyCameraKeyboardMoveInput().
  106377. */
  106378. addKeyboard(): FlyCameraInputsManager;
  106379. /**
  106380. * Add mouse input support to the input manager.
  106381. * @param touchEnabled Enable touch screen support.
  106382. * @returns the new FlyCameraMouseInput().
  106383. */
  106384. addMouse(touchEnabled?: boolean): FlyCameraInputsManager;
  106385. }
  106386. }
  106387. declare module BABYLON {
  106388. /**
  106389. * This is a flying camera, designed for 3D movement and rotation in all directions,
  106390. * such as in a 3D Space Shooter or a Flight Simulator.
  106391. */
  106392. export class FlyCamera extends TargetCamera {
  106393. /**
  106394. * Define the collision ellipsoid of the camera.
  106395. * This is helpful for simulating a camera body, like a player's body.
  106396. * @see http://doc.babylonjs.com/babylon101/cameras,_mesh_collisions_and_gravity#arcrotatecamera
  106397. */
  106398. ellipsoid: Vector3;
  106399. /**
  106400. * Define an offset for the position of the ellipsoid around the camera.
  106401. * This can be helpful if the camera is attached away from the player's body center,
  106402. * such as at its head.
  106403. */
  106404. ellipsoidOffset: Vector3;
  106405. /**
  106406. * Enable or disable collisions of the camera with the rest of the scene objects.
  106407. */
  106408. checkCollisions: boolean;
  106409. /**
  106410. * Enable or disable gravity on the camera.
  106411. */
  106412. applyGravity: boolean;
  106413. /**
  106414. * Define the current direction the camera is moving to.
  106415. */
  106416. cameraDirection: Vector3;
  106417. /**
  106418. * Define the current local rotation of the camera as a quaternion to prevent Gimbal lock.
  106419. * This overrides and empties cameraRotation.
  106420. */
  106421. rotationQuaternion: Quaternion;
  106422. /**
  106423. * Track Roll to maintain the wanted Rolling when looking around.
  106424. */
  106425. _trackRoll: number;
  106426. /**
  106427. * Slowly correct the Roll to its original value after a Pitch+Yaw rotation.
  106428. */
  106429. rollCorrect: number;
  106430. /**
  106431. * Mimic a banked turn, Rolling the camera when Yawing.
  106432. * It's recommended to use rollCorrect = 10 for faster banking correction.
  106433. */
  106434. bankedTurn: boolean;
  106435. /**
  106436. * Limit in radians for how much Roll banking will add. (Default: 90°)
  106437. */
  106438. bankedTurnLimit: number;
  106439. /**
  106440. * Value of 0 disables the banked Roll.
  106441. * Value of 1 is equal to the Yaw angle in radians.
  106442. */
  106443. bankedTurnMultiplier: number;
  106444. /**
  106445. * The inputs manager loads all the input sources, such as keyboard and mouse.
  106446. */
  106447. inputs: FlyCameraInputsManager;
  106448. /**
  106449. * Gets the input sensibility for mouse input.
  106450. * Higher values reduce sensitivity.
  106451. */
  106452. /**
  106453. * Sets the input sensibility for a mouse input.
  106454. * Higher values reduce sensitivity.
  106455. */
  106456. angularSensibility: number;
  106457. /**
  106458. * Get the keys for camera movement forward.
  106459. */
  106460. /**
  106461. * Set the keys for camera movement forward.
  106462. */
  106463. keysForward: number[];
  106464. /**
  106465. * Get the keys for camera movement backward.
  106466. */
  106467. keysBackward: number[];
  106468. /**
  106469. * Get the keys for camera movement up.
  106470. */
  106471. /**
  106472. * Set the keys for camera movement up.
  106473. */
  106474. keysUp: number[];
  106475. /**
  106476. * Get the keys for camera movement down.
  106477. */
  106478. /**
  106479. * Set the keys for camera movement down.
  106480. */
  106481. keysDown: number[];
  106482. /**
  106483. * Get the keys for camera movement left.
  106484. */
  106485. /**
  106486. * Set the keys for camera movement left.
  106487. */
  106488. keysLeft: number[];
  106489. /**
  106490. * Set the keys for camera movement right.
  106491. */
  106492. /**
  106493. * Set the keys for camera movement right.
  106494. */
  106495. keysRight: number[];
  106496. /**
  106497. * Event raised when the camera collides with a mesh in the scene.
  106498. */
  106499. onCollide: (collidedMesh: AbstractMesh) => void;
  106500. private _collider;
  106501. private _needMoveForGravity;
  106502. private _oldPosition;
  106503. private _diffPosition;
  106504. private _newPosition;
  106505. /** @hidden */
  106506. _localDirection: Vector3;
  106507. /** @hidden */
  106508. _transformedDirection: Vector3;
  106509. /**
  106510. * Instantiates a FlyCamera.
  106511. * This is a flying camera, designed for 3D movement and rotation in all directions,
  106512. * such as in a 3D Space Shooter or a Flight Simulator.
  106513. * @param name Define the name of the camera in the scene.
  106514. * @param position Define the starting position of the camera in the scene.
  106515. * @param scene Define the scene the camera belongs to.
  106516. * @param setActiveOnSceneIfNoneActive Defines wheter the camera should be marked as active, if no other camera has been defined as active.
  106517. */
  106518. constructor(name: string, position: Vector3, scene: Scene, setActiveOnSceneIfNoneActive?: boolean);
  106519. /**
  106520. * Attach a control to the HTML DOM element.
  106521. * @param element Defines the element that listens to the input events.
  106522. * @param noPreventDefault Defines whether events caught by the controls should call preventdefault(). https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault
  106523. */
  106524. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  106525. /**
  106526. * Detach a control from the HTML DOM element.
  106527. * The camera will stop reacting to that input.
  106528. * @param element Defines the element that listens to the input events.
  106529. */
  106530. detachControl(element: HTMLElement): void;
  106531. private _collisionMask;
  106532. /**
  106533. * Get the mask that the camera ignores in collision events.
  106534. */
  106535. /**
  106536. * Set the mask that the camera ignores in collision events.
  106537. */
  106538. collisionMask: number;
  106539. /** @hidden */
  106540. _collideWithWorld(displacement: Vector3): void;
  106541. /** @hidden */
  106542. private _onCollisionPositionChange;
  106543. /** @hidden */
  106544. _checkInputs(): void;
  106545. /** @hidden */
  106546. _decideIfNeedsToMove(): boolean;
  106547. /** @hidden */
  106548. _updatePosition(): void;
  106549. /**
  106550. * Restore the Roll to its target value at the rate specified.
  106551. * @param rate - Higher means slower restoring.
  106552. * @hidden
  106553. */
  106554. restoreRoll(rate: number): void;
  106555. /**
  106556. * Destroy the camera and release the current resources held by it.
  106557. */
  106558. dispose(): void;
  106559. /**
  106560. * Get the current object class name.
  106561. * @returns the class name.
  106562. */
  106563. getClassName(): string;
  106564. }
  106565. }
  106566. declare module BABYLON {
  106567. /**
  106568. * Listen to keyboard events to control the camera.
  106569. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  106570. */
  106571. export class FlyCameraKeyboardInput implements ICameraInput<FlyCamera> {
  106572. /**
  106573. * Defines the camera the input is attached to.
  106574. */
  106575. camera: FlyCamera;
  106576. /**
  106577. * The list of keyboard keys used to control the forward move of the camera.
  106578. */
  106579. keysForward: number[];
  106580. /**
  106581. * The list of keyboard keys used to control the backward move of the camera.
  106582. */
  106583. keysBackward: number[];
  106584. /**
  106585. * The list of keyboard keys used to control the forward move of the camera.
  106586. */
  106587. keysUp: number[];
  106588. /**
  106589. * The list of keyboard keys used to control the backward move of the camera.
  106590. */
  106591. keysDown: number[];
  106592. /**
  106593. * The list of keyboard keys used to control the right strafe move of the camera.
  106594. */
  106595. keysRight: number[];
  106596. /**
  106597. * The list of keyboard keys used to control the left strafe move of the camera.
  106598. */
  106599. keysLeft: number[];
  106600. private _keys;
  106601. private _onCanvasBlurObserver;
  106602. private _onKeyboardObserver;
  106603. private _engine;
  106604. private _scene;
  106605. /**
  106606. * Attach the input controls to a specific dom element to get the input from.
  106607. * @param element Defines the element the controls should be listened from
  106608. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  106609. */
  106610. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  106611. /**
  106612. * Detach the current controls from the specified dom element.
  106613. * @param element Defines the element to stop listening the inputs from
  106614. */
  106615. detachControl(element: Nullable<HTMLElement>): void;
  106616. /**
  106617. * Gets the class name of the current intput.
  106618. * @returns the class name
  106619. */
  106620. getClassName(): string;
  106621. /** @hidden */
  106622. _onLostFocus(e: FocusEvent): void;
  106623. /**
  106624. * Get the friendly name associated with the input class.
  106625. * @returns the input friendly name
  106626. */
  106627. getSimpleName(): string;
  106628. /**
  106629. * Update the current camera state depending on the inputs that have been used this frame.
  106630. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  106631. */
  106632. checkInputs(): void;
  106633. }
  106634. }
  106635. declare module BABYLON {
  106636. /**
  106637. * Manage the mouse wheel inputs to control a follow camera.
  106638. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  106639. */
  106640. export class FollowCameraMouseWheelInput implements ICameraInput<FollowCamera> {
  106641. /**
  106642. * Defines the camera the input is attached to.
  106643. */
  106644. camera: FollowCamera;
  106645. /**
  106646. * Moue wheel controls zoom. (Mouse wheel modifies camera.radius value.)
  106647. */
  106648. axisControlRadius: boolean;
  106649. /**
  106650. * Moue wheel controls height. (Mouse wheel modifies camera.heightOffset value.)
  106651. */
  106652. axisControlHeight: boolean;
  106653. /**
  106654. * Moue wheel controls angle. (Mouse wheel modifies camera.rotationOffset value.)
  106655. */
  106656. axisControlRotation: boolean;
  106657. /**
  106658. * Gets or Set the mouse wheel precision or how fast is the camera moves in
  106659. * relation to mouseWheel events.
  106660. */
  106661. wheelPrecision: number;
  106662. /**
  106663. * wheelDeltaPercentage will be used instead of wheelPrecision if different from 0.
  106664. * It defines the percentage of current camera.radius to use as delta when wheel is used.
  106665. */
  106666. wheelDeltaPercentage: number;
  106667. private _wheel;
  106668. private _observer;
  106669. /**
  106670. * Attach the input controls to a specific dom element to get the input from.
  106671. * @param element Defines the element the controls should be listened from
  106672. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  106673. */
  106674. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  106675. /**
  106676. * Detach the current controls from the specified dom element.
  106677. * @param element Defines the element to stop listening the inputs from
  106678. */
  106679. detachControl(element: Nullable<HTMLElement>): void;
  106680. /**
  106681. * Gets the class name of the current intput.
  106682. * @returns the class name
  106683. */
  106684. getClassName(): string;
  106685. /**
  106686. * Get the friendly name associated with the input class.
  106687. * @returns the input friendly name
  106688. */
  106689. getSimpleName(): string;
  106690. }
  106691. }
  106692. declare module BABYLON {
  106693. /**
  106694. * Manage the pointers inputs to control an follow camera.
  106695. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  106696. */
  106697. export class FollowCameraPointersInput extends BaseCameraPointersInput {
  106698. /**
  106699. * Defines the camera the input is attached to.
  106700. */
  106701. camera: FollowCamera;
  106702. /**
  106703. * Gets the class name of the current input.
  106704. * @returns the class name
  106705. */
  106706. getClassName(): string;
  106707. /**
  106708. * Defines the pointer angular sensibility along the X axis or how fast is
  106709. * the camera rotating.
  106710. * A negative number will reverse the axis direction.
  106711. */
  106712. angularSensibilityX: number;
  106713. /**
  106714. * Defines the pointer angular sensibility along the Y axis or how fast is
  106715. * the camera rotating.
  106716. * A negative number will reverse the axis direction.
  106717. */
  106718. angularSensibilityY: number;
  106719. /**
  106720. * Defines the pointer pinch precision or how fast is the camera zooming.
  106721. * A negative number will reverse the axis direction.
  106722. */
  106723. pinchPrecision: number;
  106724. /**
  106725. * pinchDeltaPercentage will be used instead of pinchPrecision if different
  106726. * from 0.
  106727. * It defines the percentage of current camera.radius to use as delta when
  106728. * pinch zoom is used.
  106729. */
  106730. pinchDeltaPercentage: number;
  106731. /**
  106732. * Pointer X axis controls zoom. (X axis modifies camera.radius value.)
  106733. */
  106734. axisXControlRadius: boolean;
  106735. /**
  106736. * Pointer X axis controls height. (X axis modifies camera.heightOffset value.)
  106737. */
  106738. axisXControlHeight: boolean;
  106739. /**
  106740. * Pointer X axis controls angle. (X axis modifies camera.rotationOffset value.)
  106741. */
  106742. axisXControlRotation: boolean;
  106743. /**
  106744. * Pointer Y axis controls zoom. (Y axis modifies camera.radius value.)
  106745. */
  106746. axisYControlRadius: boolean;
  106747. /**
  106748. * Pointer Y axis controls height. (Y axis modifies camera.heightOffset value.)
  106749. */
  106750. axisYControlHeight: boolean;
  106751. /**
  106752. * Pointer Y axis controls angle. (Y axis modifies camera.rotationOffset value.)
  106753. */
  106754. axisYControlRotation: boolean;
  106755. /**
  106756. * Pinch controls zoom. (Pinch modifies camera.radius value.)
  106757. */
  106758. axisPinchControlRadius: boolean;
  106759. /**
  106760. * Pinch controls height. (Pinch modifies camera.heightOffset value.)
  106761. */
  106762. axisPinchControlHeight: boolean;
  106763. /**
  106764. * Pinch controls angle. (Pinch modifies camera.rotationOffset value.)
  106765. */
  106766. axisPinchControlRotation: boolean;
  106767. /**
  106768. * Log error messages if basic misconfiguration has occurred.
  106769. */
  106770. warningEnable: boolean;
  106771. protected onTouch(pointA: Nullable<PointerTouch>, offsetX: number, offsetY: number): void;
  106772. protected onMultiTouch(pointA: Nullable<PointerTouch>, pointB: Nullable<PointerTouch>, previousPinchSquaredDistance: number, pinchSquaredDistance: number, previousMultiTouchPanPosition: Nullable<PointerTouch>, multiTouchPanPosition: Nullable<PointerTouch>): void;
  106773. private _warningCounter;
  106774. private _warning;
  106775. }
  106776. }
  106777. declare module BABYLON {
  106778. /**
  106779. * Default Inputs manager for the FollowCamera.
  106780. * It groups all the default supported inputs for ease of use.
  106781. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  106782. */
  106783. export class FollowCameraInputsManager extends CameraInputsManager<FollowCamera> {
  106784. /**
  106785. * Instantiates a new FollowCameraInputsManager.
  106786. * @param camera Defines the camera the inputs belong to
  106787. */
  106788. constructor(camera: FollowCamera);
  106789. /**
  106790. * Add keyboard input support to the input manager.
  106791. * @returns the current input manager
  106792. */
  106793. addKeyboard(): FollowCameraInputsManager;
  106794. /**
  106795. * Add mouse wheel input support to the input manager.
  106796. * @returns the current input manager
  106797. */
  106798. addMouseWheel(): FollowCameraInputsManager;
  106799. /**
  106800. * Add pointers input support to the input manager.
  106801. * @returns the current input manager
  106802. */
  106803. addPointers(): FollowCameraInputsManager;
  106804. /**
  106805. * Add orientation input support to the input manager.
  106806. * @returns the current input manager
  106807. */
  106808. addVRDeviceOrientation(): FollowCameraInputsManager;
  106809. }
  106810. }
  106811. declare module BABYLON {
  106812. /**
  106813. * A follow camera takes a mesh as a target and follows it as it moves. Both a free camera version followCamera and
  106814. * an arc rotate version arcFollowCamera are available.
  106815. * @see http://doc.babylonjs.com/features/cameras#follow-camera
  106816. */
  106817. export class FollowCamera extends TargetCamera {
  106818. /**
  106819. * Distance the follow camera should follow an object at
  106820. */
  106821. radius: number;
  106822. /**
  106823. * Minimum allowed distance of the camera to the axis of rotation
  106824. * (The camera can not get closer).
  106825. * This can help limiting how the Camera is able to move in the scene.
  106826. */
  106827. lowerRadiusLimit: Nullable<number>;
  106828. /**
  106829. * Maximum allowed distance of the camera to the axis of rotation
  106830. * (The camera can not get further).
  106831. * This can help limiting how the Camera is able to move in the scene.
  106832. */
  106833. upperRadiusLimit: Nullable<number>;
  106834. /**
  106835. * Define a rotation offset between the camera and the object it follows
  106836. */
  106837. rotationOffset: number;
  106838. /**
  106839. * Minimum allowed angle to camera position relative to target object.
  106840. * This can help limiting how the Camera is able to move in the scene.
  106841. */
  106842. lowerRotationOffsetLimit: Nullable<number>;
  106843. /**
  106844. * Maximum allowed angle to camera position relative to target object.
  106845. * This can help limiting how the Camera is able to move in the scene.
  106846. */
  106847. upperRotationOffsetLimit: Nullable<number>;
  106848. /**
  106849. * Define a height offset between the camera and the object it follows.
  106850. * It can help following an object from the top (like a car chaing a plane)
  106851. */
  106852. heightOffset: number;
  106853. /**
  106854. * Minimum allowed height of camera position relative to target object.
  106855. * This can help limiting how the Camera is able to move in the scene.
  106856. */
  106857. lowerHeightOffsetLimit: Nullable<number>;
  106858. /**
  106859. * Maximum allowed height of camera position relative to target object.
  106860. * This can help limiting how the Camera is able to move in the scene.
  106861. */
  106862. upperHeightOffsetLimit: Nullable<number>;
  106863. /**
  106864. * Define how fast the camera can accelerate to follow it s target.
  106865. */
  106866. cameraAcceleration: number;
  106867. /**
  106868. * Define the speed limit of the camera following an object.
  106869. */
  106870. maxCameraSpeed: number;
  106871. /**
  106872. * Define the target of the camera.
  106873. */
  106874. lockedTarget: Nullable<AbstractMesh>;
  106875. /**
  106876. * Defines the input associated with the camera.
  106877. */
  106878. inputs: FollowCameraInputsManager;
  106879. /**
  106880. * Instantiates the follow camera.
  106881. * @see http://doc.babylonjs.com/features/cameras#follow-camera
  106882. * @param name Define the name of the camera in the scene
  106883. * @param position Define the position of the camera
  106884. * @param scene Define the scene the camera belong to
  106885. * @param lockedTarget Define the target of the camera
  106886. */
  106887. constructor(name: string, position: Vector3, scene: Scene, lockedTarget?: Nullable<AbstractMesh>);
  106888. private _follow;
  106889. /**
  106890. * Attached controls to the current camera.
  106891. * @param element Defines the element the controls should be listened from
  106892. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  106893. */
  106894. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  106895. /**
  106896. * Detach the current controls from the camera.
  106897. * The camera will stop reacting to inputs.
  106898. * @param element Defines the element to stop listening the inputs from
  106899. */
  106900. detachControl(element: HTMLElement): void;
  106901. /** @hidden */
  106902. _checkInputs(): void;
  106903. private _checkLimits;
  106904. /**
  106905. * Gets the camera class name.
  106906. * @returns the class name
  106907. */
  106908. getClassName(): string;
  106909. }
  106910. /**
  106911. * Arc Rotate version of the follow camera.
  106912. * It still follows a Defined mesh but in an Arc Rotate Camera fashion.
  106913. * @see http://doc.babylonjs.com/features/cameras#follow-camera
  106914. */
  106915. export class ArcFollowCamera extends TargetCamera {
  106916. /** The longitudinal angle of the camera */
  106917. alpha: number;
  106918. /** The latitudinal angle of the camera */
  106919. beta: number;
  106920. /** The radius of the camera from its target */
  106921. radius: number;
  106922. /** Define the camera target (the messh it should follow) */
  106923. target: Nullable<AbstractMesh>;
  106924. private _cartesianCoordinates;
  106925. /**
  106926. * Instantiates a new ArcFollowCamera
  106927. * @see http://doc.babylonjs.com/features/cameras#follow-camera
  106928. * @param name Define the name of the camera
  106929. * @param alpha Define the rotation angle of the camera around the logitudinal axis
  106930. * @param beta Define the rotation angle of the camera around the elevation axis
  106931. * @param radius Define the radius of the camera from its target point
  106932. * @param target Define the target of the camera
  106933. * @param scene Define the scene the camera belongs to
  106934. */
  106935. constructor(name: string,
  106936. /** The longitudinal angle of the camera */
  106937. alpha: number,
  106938. /** The latitudinal angle of the camera */
  106939. beta: number,
  106940. /** The radius of the camera from its target */
  106941. radius: number,
  106942. /** Define the camera target (the messh it should follow) */
  106943. target: Nullable<AbstractMesh>, scene: Scene);
  106944. private _follow;
  106945. /** @hidden */
  106946. _checkInputs(): void;
  106947. /**
  106948. * Returns the class name of the object.
  106949. * It is mostly used internally for serialization purposes.
  106950. */
  106951. getClassName(): string;
  106952. }
  106953. }
  106954. declare module BABYLON {
  106955. /**
  106956. * Manage the keyboard inputs to control the movement of a follow camera.
  106957. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  106958. */
  106959. export class FollowCameraKeyboardMoveInput implements ICameraInput<FollowCamera> {
  106960. /**
  106961. * Defines the camera the input is attached to.
  106962. */
  106963. camera: FollowCamera;
  106964. /**
  106965. * Defines the list of key codes associated with the up action (increase heightOffset)
  106966. */
  106967. keysHeightOffsetIncr: number[];
  106968. /**
  106969. * Defines the list of key codes associated with the down action (decrease heightOffset)
  106970. */
  106971. keysHeightOffsetDecr: number[];
  106972. /**
  106973. * Defines whether the Alt modifier key is required to move up/down (alter heightOffset)
  106974. */
  106975. keysHeightOffsetModifierAlt: boolean;
  106976. /**
  106977. * Defines whether the Ctrl modifier key is required to move up/down (alter heightOffset)
  106978. */
  106979. keysHeightOffsetModifierCtrl: boolean;
  106980. /**
  106981. * Defines whether the Shift modifier key is required to move up/down (alter heightOffset)
  106982. */
  106983. keysHeightOffsetModifierShift: boolean;
  106984. /**
  106985. * Defines the list of key codes associated with the left action (increase rotationOffset)
  106986. */
  106987. keysRotationOffsetIncr: number[];
  106988. /**
  106989. * Defines the list of key codes associated with the right action (decrease rotationOffset)
  106990. */
  106991. keysRotationOffsetDecr: number[];
  106992. /**
  106993. * Defines whether the Alt modifier key is required to move left/right (alter rotationOffset)
  106994. */
  106995. keysRotationOffsetModifierAlt: boolean;
  106996. /**
  106997. * Defines whether the Ctrl modifier key is required to move left/right (alter rotationOffset)
  106998. */
  106999. keysRotationOffsetModifierCtrl: boolean;
  107000. /**
  107001. * Defines whether the Shift modifier key is required to move left/right (alter rotationOffset)
  107002. */
  107003. keysRotationOffsetModifierShift: boolean;
  107004. /**
  107005. * Defines the list of key codes associated with the zoom-in action (decrease radius)
  107006. */
  107007. keysRadiusIncr: number[];
  107008. /**
  107009. * Defines the list of key codes associated with the zoom-out action (increase radius)
  107010. */
  107011. keysRadiusDecr: number[];
  107012. /**
  107013. * Defines whether the Alt modifier key is required to zoom in/out (alter radius value)
  107014. */
  107015. keysRadiusModifierAlt: boolean;
  107016. /**
  107017. * Defines whether the Ctrl modifier key is required to zoom in/out (alter radius value)
  107018. */
  107019. keysRadiusModifierCtrl: boolean;
  107020. /**
  107021. * Defines whether the Shift modifier key is required to zoom in/out (alter radius value)
  107022. */
  107023. keysRadiusModifierShift: boolean;
  107024. /**
  107025. * Defines the rate of change of heightOffset.
  107026. */
  107027. heightSensibility: number;
  107028. /**
  107029. * Defines the rate of change of rotationOffset.
  107030. */
  107031. rotationSensibility: number;
  107032. /**
  107033. * Defines the rate of change of radius.
  107034. */
  107035. radiusSensibility: number;
  107036. private _keys;
  107037. private _ctrlPressed;
  107038. private _altPressed;
  107039. private _shiftPressed;
  107040. private _onCanvasBlurObserver;
  107041. private _onKeyboardObserver;
  107042. private _engine;
  107043. private _scene;
  107044. /**
  107045. * Attach the input controls to a specific dom element to get the input from.
  107046. * @param element Defines the element the controls should be listened from
  107047. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  107048. */
  107049. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  107050. /**
  107051. * Detach the current controls from the specified dom element.
  107052. * @param element Defines the element to stop listening the inputs from
  107053. */
  107054. detachControl(element: Nullable<HTMLElement>): void;
  107055. /**
  107056. * Update the current camera state depending on the inputs that have been used this frame.
  107057. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  107058. */
  107059. checkInputs(): void;
  107060. /**
  107061. * Gets the class name of the current input.
  107062. * @returns the class name
  107063. */
  107064. getClassName(): string;
  107065. /**
  107066. * Get the friendly name associated with the input class.
  107067. * @returns the input friendly name
  107068. */
  107069. getSimpleName(): string;
  107070. /**
  107071. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  107072. * allow modification of the heightOffset value.
  107073. */
  107074. private _modifierHeightOffset;
  107075. /**
  107076. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  107077. * allow modification of the rotationOffset value.
  107078. */
  107079. private _modifierRotationOffset;
  107080. /**
  107081. * Check if the pressed modifier keys (Alt/Ctrl/Shift) match those configured to
  107082. * allow modification of the radius value.
  107083. */
  107084. private _modifierRadius;
  107085. }
  107086. }
  107087. declare module BABYLON {
  107088. interface FreeCameraInputsManager {
  107089. /**
  107090. * @hidden
  107091. */
  107092. _deviceOrientationInput: Nullable<FreeCameraDeviceOrientationInput>;
  107093. /**
  107094. * Add orientation input support to the input manager.
  107095. * @returns the current input manager
  107096. */
  107097. addDeviceOrientation(): FreeCameraInputsManager;
  107098. }
  107099. /**
  107100. * Takes information about the orientation of the device as reported by the deviceorientation event to orient the camera.
  107101. * Screen rotation is taken into account.
  107102. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  107103. */
  107104. export class FreeCameraDeviceOrientationInput implements ICameraInput<FreeCamera> {
  107105. private _camera;
  107106. private _screenOrientationAngle;
  107107. private _constantTranform;
  107108. private _screenQuaternion;
  107109. private _alpha;
  107110. private _beta;
  107111. private _gamma;
  107112. /**
  107113. * Can be used to detect if a device orientation sensor is availible on a device
  107114. * @param timeout amount of time in milliseconds to wait for a response from the sensor (default: infinite)
  107115. * @returns a promise that will resolve on orientation change
  107116. */
  107117. static WaitForOrientationChangeAsync(timeout?: number): Promise<unknown>;
  107118. /**
  107119. * @hidden
  107120. */
  107121. _onDeviceOrientationChangedObservable: Observable<void>;
  107122. /**
  107123. * Instantiates a new input
  107124. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  107125. */
  107126. constructor();
  107127. /**
  107128. * Define the camera controlled by the input.
  107129. */
  107130. camera: FreeCamera;
  107131. /**
  107132. * Attach the input controls to a specific dom element to get the input from.
  107133. * @param element Defines the element the controls should be listened from
  107134. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  107135. */
  107136. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  107137. private _orientationChanged;
  107138. private _deviceOrientation;
  107139. /**
  107140. * Detach the current controls from the specified dom element.
  107141. * @param element Defines the element to stop listening the inputs from
  107142. */
  107143. detachControl(element: Nullable<HTMLElement>): void;
  107144. /**
  107145. * Update the current camera state depending on the inputs that have been used this frame.
  107146. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  107147. */
  107148. checkInputs(): void;
  107149. /**
  107150. * Gets the class name of the current intput.
  107151. * @returns the class name
  107152. */
  107153. getClassName(): string;
  107154. /**
  107155. * Get the friendly name associated with the input class.
  107156. * @returns the input friendly name
  107157. */
  107158. getSimpleName(): string;
  107159. }
  107160. }
  107161. declare module BABYLON {
  107162. /**
  107163. * Manage the gamepad inputs to control a free camera.
  107164. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  107165. */
  107166. export class FreeCameraGamepadInput implements ICameraInput<FreeCamera> {
  107167. /**
  107168. * Define the camera the input is attached to.
  107169. */
  107170. camera: FreeCamera;
  107171. /**
  107172. * Define the Gamepad controlling the input
  107173. */
  107174. gamepad: Nullable<Gamepad>;
  107175. /**
  107176. * Defines the gamepad rotation sensiblity.
  107177. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  107178. */
  107179. gamepadAngularSensibility: number;
  107180. /**
  107181. * Defines the gamepad move sensiblity.
  107182. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  107183. */
  107184. gamepadMoveSensibility: number;
  107185. private _yAxisScale;
  107186. /**
  107187. * Gets or sets a boolean indicating that Yaxis (for right stick) should be inverted
  107188. */
  107189. invertYAxis: boolean;
  107190. private _onGamepadConnectedObserver;
  107191. private _onGamepadDisconnectedObserver;
  107192. private _cameraTransform;
  107193. private _deltaTransform;
  107194. private _vector3;
  107195. private _vector2;
  107196. /**
  107197. * Attach the input controls to a specific dom element to get the input from.
  107198. * @param element Defines the element the controls should be listened from
  107199. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  107200. */
  107201. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  107202. /**
  107203. * Detach the current controls from the specified dom element.
  107204. * @param element Defines the element to stop listening the inputs from
  107205. */
  107206. detachControl(element: Nullable<HTMLElement>): void;
  107207. /**
  107208. * Update the current camera state depending on the inputs that have been used this frame.
  107209. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  107210. */
  107211. checkInputs(): void;
  107212. /**
  107213. * Gets the class name of the current intput.
  107214. * @returns the class name
  107215. */
  107216. getClassName(): string;
  107217. /**
  107218. * Get the friendly name associated with the input class.
  107219. * @returns the input friendly name
  107220. */
  107221. getSimpleName(): string;
  107222. }
  107223. }
  107224. declare module BABYLON {
  107225. /**
  107226. * Defines the potential axis of a Joystick
  107227. */
  107228. export enum JoystickAxis {
  107229. /** X axis */
  107230. X = 0,
  107231. /** Y axis */
  107232. Y = 1,
  107233. /** Z axis */
  107234. Z = 2
  107235. }
  107236. /**
  107237. * Class used to define virtual joystick (used in touch mode)
  107238. */
  107239. export class VirtualJoystick {
  107240. /**
  107241. * Gets or sets a boolean indicating that left and right values must be inverted
  107242. */
  107243. reverseLeftRight: boolean;
  107244. /**
  107245. * Gets or sets a boolean indicating that up and down values must be inverted
  107246. */
  107247. reverseUpDown: boolean;
  107248. /**
  107249. * Gets the offset value for the position (ie. the change of the position value)
  107250. */
  107251. deltaPosition: Vector3;
  107252. /**
  107253. * Gets a boolean indicating if the virtual joystick was pressed
  107254. */
  107255. pressed: boolean;
  107256. /**
  107257. * Canvas the virtual joystick will render onto, default z-index of this is 5
  107258. */
  107259. static Canvas: Nullable<HTMLCanvasElement>;
  107260. private static _globalJoystickIndex;
  107261. private static vjCanvasContext;
  107262. private static vjCanvasWidth;
  107263. private static vjCanvasHeight;
  107264. private static halfWidth;
  107265. private _action;
  107266. private _axisTargetedByLeftAndRight;
  107267. private _axisTargetedByUpAndDown;
  107268. private _joystickSensibility;
  107269. private _inversedSensibility;
  107270. private _joystickPointerID;
  107271. private _joystickColor;
  107272. private _joystickPointerPos;
  107273. private _joystickPreviousPointerPos;
  107274. private _joystickPointerStartPos;
  107275. private _deltaJoystickVector;
  107276. private _leftJoystick;
  107277. private _touches;
  107278. private _onPointerDownHandlerRef;
  107279. private _onPointerMoveHandlerRef;
  107280. private _onPointerUpHandlerRef;
  107281. private _onResize;
  107282. /**
  107283. * Creates a new virtual joystick
  107284. * @param leftJoystick defines that the joystick is for left hand (false by default)
  107285. */
  107286. constructor(leftJoystick?: boolean);
  107287. /**
  107288. * Defines joystick sensibility (ie. the ratio beteen a physical move and virtual joystick position change)
  107289. * @param newJoystickSensibility defines the new sensibility
  107290. */
  107291. setJoystickSensibility(newJoystickSensibility: number): void;
  107292. private _onPointerDown;
  107293. private _onPointerMove;
  107294. private _onPointerUp;
  107295. /**
  107296. * Change the color of the virtual joystick
  107297. * @param newColor a string that must be a CSS color value (like "red") or the hexa value (like "#FF0000")
  107298. */
  107299. setJoystickColor(newColor: string): void;
  107300. /**
  107301. * Defines a callback to call when the joystick is touched
  107302. * @param action defines the callback
  107303. */
  107304. setActionOnTouch(action: () => any): void;
  107305. /**
  107306. * Defines which axis you'd like to control for left & right
  107307. * @param axis defines the axis to use
  107308. */
  107309. setAxisForLeftRight(axis: JoystickAxis): void;
  107310. /**
  107311. * Defines which axis you'd like to control for up & down
  107312. * @param axis defines the axis to use
  107313. */
  107314. setAxisForUpDown(axis: JoystickAxis): void;
  107315. private _drawVirtualJoystick;
  107316. /**
  107317. * Release internal HTML canvas
  107318. */
  107319. releaseCanvas(): void;
  107320. }
  107321. }
  107322. declare module BABYLON {
  107323. interface FreeCameraInputsManager {
  107324. /**
  107325. * Add virtual joystick input support to the input manager.
  107326. * @returns the current input manager
  107327. */
  107328. addVirtualJoystick(): FreeCameraInputsManager;
  107329. }
  107330. /**
  107331. * Manage the Virtual Joystick inputs to control the movement of a free camera.
  107332. * @see http://doc.babylonjs.com/how_to/customizing_camera_inputs
  107333. */
  107334. export class FreeCameraVirtualJoystickInput implements ICameraInput<FreeCamera> {
  107335. /**
  107336. * Defines the camera the input is attached to.
  107337. */
  107338. camera: FreeCamera;
  107339. private _leftjoystick;
  107340. private _rightjoystick;
  107341. /**
  107342. * Gets the left stick of the virtual joystick.
  107343. * @returns The virtual Joystick
  107344. */
  107345. getLeftJoystick(): VirtualJoystick;
  107346. /**
  107347. * Gets the right stick of the virtual joystick.
  107348. * @returns The virtual Joystick
  107349. */
  107350. getRightJoystick(): VirtualJoystick;
  107351. /**
  107352. * Update the current camera state depending on the inputs that have been used this frame.
  107353. * This is a dynamically created lambda to avoid the performance penalty of looping for inputs in the render loop.
  107354. */
  107355. checkInputs(): void;
  107356. /**
  107357. * Attach the input controls to a specific dom element to get the input from.
  107358. * @param element Defines the element the controls should be listened from
  107359. * @param noPreventDefault Defines whether event caught by the controls should call preventdefault() (https://developer.mozilla.org/en-US/docs/Web/API/Event/preventDefault)
  107360. */
  107361. attachControl(element: HTMLElement, noPreventDefault?: boolean): void;
  107362. /**
  107363. * Detach the current controls from the specified dom element.
  107364. * @param element Defines the element to stop listening the inputs from
  107365. */
  107366. detachControl(element: Nullable<HTMLElement>): void;
  107367. /**
  107368. * Gets the class name of the current intput.
  107369. * @returns the class name
  107370. */
  107371. getClassName(): string;
  107372. /**
  107373. * Get the friendly name associated with the input class.
  107374. * @returns the input friendly name
  107375. */
  107376. getSimpleName(): string;
  107377. }
  107378. }
  107379. declare module BABYLON {
  107380. /**
  107381. * This represents a FPS type of camera controlled by touch.
  107382. * This is like a universal camera minus the Gamepad controls.
  107383. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  107384. */
  107385. export class TouchCamera extends FreeCamera {
  107386. /**
  107387. * Defines the touch sensibility for rotation.
  107388. * The higher the faster.
  107389. */
  107390. touchAngularSensibility: number;
  107391. /**
  107392. * Defines the touch sensibility for move.
  107393. * The higher the faster.
  107394. */
  107395. touchMoveSensibility: number;
  107396. /**
  107397. * Instantiates a new touch camera.
  107398. * This represents a FPS type of camera controlled by touch.
  107399. * This is like a universal camera minus the Gamepad controls.
  107400. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  107401. * @param name Define the name of the camera in the scene
  107402. * @param position Define the start position of the camera in the scene
  107403. * @param scene Define the scene the camera belongs to
  107404. */
  107405. constructor(name: string, position: Vector3, scene: Scene);
  107406. /**
  107407. * Gets the current object class name.
  107408. * @return the class name
  107409. */
  107410. getClassName(): string;
  107411. /** @hidden */
  107412. _setupInputs(): void;
  107413. }
  107414. }
  107415. declare module BABYLON {
  107416. /**
  107417. * This is a camera specifically designed to react to device orientation events such as a modern mobile device
  107418. * being tilted forward or back and left or right.
  107419. */
  107420. export class DeviceOrientationCamera extends FreeCamera {
  107421. private _initialQuaternion;
  107422. private _quaternionCache;
  107423. private _tmpDragQuaternion;
  107424. private _disablePointerInputWhenUsingDeviceOrientation;
  107425. /**
  107426. * Creates a new device orientation camera
  107427. * @param name The name of the camera
  107428. * @param position The start position camera
  107429. * @param scene The scene the camera belongs to
  107430. */
  107431. constructor(name: string, position: Vector3, scene: Scene);
  107432. /**
  107433. * Gets or sets a boolean indicating that pointer input must be disabled on first orientation sensor update (Default: true)
  107434. */
  107435. disablePointerInputWhenUsingDeviceOrientation: boolean;
  107436. private _dragFactor;
  107437. /**
  107438. * Enabled turning on the y axis when the orientation sensor is active
  107439. * @param dragFactor the factor that controls the turn speed (default: 1/300)
  107440. */
  107441. enableHorizontalDragging(dragFactor?: number): void;
  107442. /**
  107443. * Gets the current instance class name ("DeviceOrientationCamera").
  107444. * This helps avoiding instanceof at run time.
  107445. * @returns the class name
  107446. */
  107447. getClassName(): string;
  107448. /**
  107449. * @hidden
  107450. * Checks and applies the current values of the inputs to the camera. (Internal use only)
  107451. */
  107452. _checkInputs(): void;
  107453. /**
  107454. * Reset the camera to its default orientation on the specified axis only.
  107455. * @param axis The axis to reset
  107456. */
  107457. resetToCurrentRotation(axis?: Axis): void;
  107458. }
  107459. }
  107460. declare module BABYLON {
  107461. /**
  107462. * Defines supported buttons for XBox360 compatible gamepads
  107463. */
  107464. export enum Xbox360Button {
  107465. /** A */
  107466. A = 0,
  107467. /** B */
  107468. B = 1,
  107469. /** X */
  107470. X = 2,
  107471. /** Y */
  107472. Y = 3,
  107473. /** Start */
  107474. Start = 4,
  107475. /** Back */
  107476. Back = 5,
  107477. /** Left button */
  107478. LB = 6,
  107479. /** Right button */
  107480. RB = 7,
  107481. /** Left stick */
  107482. LeftStick = 8,
  107483. /** Right stick */
  107484. RightStick = 9
  107485. }
  107486. /** Defines values for XBox360 DPad */
  107487. export enum Xbox360Dpad {
  107488. /** Up */
  107489. Up = 0,
  107490. /** Down */
  107491. Down = 1,
  107492. /** Left */
  107493. Left = 2,
  107494. /** Right */
  107495. Right = 3
  107496. }
  107497. /**
  107498. * Defines a XBox360 gamepad
  107499. */
  107500. export class Xbox360Pad extends Gamepad {
  107501. private _leftTrigger;
  107502. private _rightTrigger;
  107503. private _onlefttriggerchanged;
  107504. private _onrighttriggerchanged;
  107505. private _onbuttondown;
  107506. private _onbuttonup;
  107507. private _ondpaddown;
  107508. private _ondpadup;
  107509. /** Observable raised when a button is pressed */
  107510. onButtonDownObservable: Observable<Xbox360Button>;
  107511. /** Observable raised when a button is released */
  107512. onButtonUpObservable: Observable<Xbox360Button>;
  107513. /** Observable raised when a pad is pressed */
  107514. onPadDownObservable: Observable<Xbox360Dpad>;
  107515. /** Observable raised when a pad is released */
  107516. onPadUpObservable: Observable<Xbox360Dpad>;
  107517. private _buttonA;
  107518. private _buttonB;
  107519. private _buttonX;
  107520. private _buttonY;
  107521. private _buttonBack;
  107522. private _buttonStart;
  107523. private _buttonLB;
  107524. private _buttonRB;
  107525. private _buttonLeftStick;
  107526. private _buttonRightStick;
  107527. private _dPadUp;
  107528. private _dPadDown;
  107529. private _dPadLeft;
  107530. private _dPadRight;
  107531. private _isXboxOnePad;
  107532. /**
  107533. * Creates a new XBox360 gamepad object
  107534. * @param id defines the id of this gamepad
  107535. * @param index defines its index
  107536. * @param gamepad defines the internal HTML gamepad object
  107537. * @param xboxOne defines if it is a XBox One gamepad
  107538. */
  107539. constructor(id: string, index: number, gamepad: any, xboxOne?: boolean);
  107540. /**
  107541. * Defines the callback to call when left trigger is pressed
  107542. * @param callback defines the callback to use
  107543. */
  107544. onlefttriggerchanged(callback: (value: number) => void): void;
  107545. /**
  107546. * Defines the callback to call when right trigger is pressed
  107547. * @param callback defines the callback to use
  107548. */
  107549. onrighttriggerchanged(callback: (value: number) => void): void;
  107550. /**
  107551. * Gets the left trigger value
  107552. */
  107553. /**
  107554. * Sets the left trigger value
  107555. */
  107556. leftTrigger: number;
  107557. /**
  107558. * Gets the right trigger value
  107559. */
  107560. /**
  107561. * Sets the right trigger value
  107562. */
  107563. rightTrigger: number;
  107564. /**
  107565. * Defines the callback to call when a button is pressed
  107566. * @param callback defines the callback to use
  107567. */
  107568. onbuttondown(callback: (buttonPressed: Xbox360Button) => void): void;
  107569. /**
  107570. * Defines the callback to call when a button is released
  107571. * @param callback defines the callback to use
  107572. */
  107573. onbuttonup(callback: (buttonReleased: Xbox360Button) => void): void;
  107574. /**
  107575. * Defines the callback to call when a pad is pressed
  107576. * @param callback defines the callback to use
  107577. */
  107578. ondpaddown(callback: (dPadPressed: Xbox360Dpad) => void): void;
  107579. /**
  107580. * Defines the callback to call when a pad is released
  107581. * @param callback defines the callback to use
  107582. */
  107583. ondpadup(callback: (dPadReleased: Xbox360Dpad) => void): void;
  107584. private _setButtonValue;
  107585. private _setDPadValue;
  107586. /**
  107587. * Gets the value of the `A` button
  107588. */
  107589. /**
  107590. * Sets the value of the `A` button
  107591. */
  107592. buttonA: number;
  107593. /**
  107594. * Gets the value of the `B` button
  107595. */
  107596. /**
  107597. * Sets the value of the `B` button
  107598. */
  107599. buttonB: number;
  107600. /**
  107601. * Gets the value of the `X` button
  107602. */
  107603. /**
  107604. * Sets the value of the `X` button
  107605. */
  107606. buttonX: number;
  107607. /**
  107608. * Gets the value of the `Y` button
  107609. */
  107610. /**
  107611. * Sets the value of the `Y` button
  107612. */
  107613. buttonY: number;
  107614. /**
  107615. * Gets the value of the `Start` button
  107616. */
  107617. /**
  107618. * Sets the value of the `Start` button
  107619. */
  107620. buttonStart: number;
  107621. /**
  107622. * Gets the value of the `Back` button
  107623. */
  107624. /**
  107625. * Sets the value of the `Back` button
  107626. */
  107627. buttonBack: number;
  107628. /**
  107629. * Gets the value of the `Left` button
  107630. */
  107631. /**
  107632. * Sets the value of the `Left` button
  107633. */
  107634. buttonLB: number;
  107635. /**
  107636. * Gets the value of the `Right` button
  107637. */
  107638. /**
  107639. * Sets the value of the `Right` button
  107640. */
  107641. buttonRB: number;
  107642. /**
  107643. * Gets the value of the Left joystick
  107644. */
  107645. /**
  107646. * Sets the value of the Left joystick
  107647. */
  107648. buttonLeftStick: number;
  107649. /**
  107650. * Gets the value of the Right joystick
  107651. */
  107652. /**
  107653. * Sets the value of the Right joystick
  107654. */
  107655. buttonRightStick: number;
  107656. /**
  107657. * Gets the value of D-pad up
  107658. */
  107659. /**
  107660. * Sets the value of D-pad up
  107661. */
  107662. dPadUp: number;
  107663. /**
  107664. * Gets the value of D-pad down
  107665. */
  107666. /**
  107667. * Sets the value of D-pad down
  107668. */
  107669. dPadDown: number;
  107670. /**
  107671. * Gets the value of D-pad left
  107672. */
  107673. /**
  107674. * Sets the value of D-pad left
  107675. */
  107676. dPadLeft: number;
  107677. /**
  107678. * Gets the value of D-pad right
  107679. */
  107680. /**
  107681. * Sets the value of D-pad right
  107682. */
  107683. dPadRight: number;
  107684. /**
  107685. * Force the gamepad to synchronize with device values
  107686. */
  107687. update(): void;
  107688. /**
  107689. * Disposes the gamepad
  107690. */
  107691. dispose(): void;
  107692. }
  107693. }
  107694. declare module BABYLON {
  107695. /**
  107696. * Defines supported buttons for DualShock compatible gamepads
  107697. */
  107698. export enum DualShockButton {
  107699. /** Cross */
  107700. Cross = 0,
  107701. /** Circle */
  107702. Circle = 1,
  107703. /** Square */
  107704. Square = 2,
  107705. /** Triangle */
  107706. Triangle = 3,
  107707. /** Options */
  107708. Options = 4,
  107709. /** Share */
  107710. Share = 5,
  107711. /** L1 */
  107712. L1 = 6,
  107713. /** R1 */
  107714. R1 = 7,
  107715. /** Left stick */
  107716. LeftStick = 8,
  107717. /** Right stick */
  107718. RightStick = 9
  107719. }
  107720. /** Defines values for DualShock DPad */
  107721. export enum DualShockDpad {
  107722. /** Up */
  107723. Up = 0,
  107724. /** Down */
  107725. Down = 1,
  107726. /** Left */
  107727. Left = 2,
  107728. /** Right */
  107729. Right = 3
  107730. }
  107731. /**
  107732. * Defines a DualShock gamepad
  107733. */
  107734. export class DualShockPad extends Gamepad {
  107735. private _leftTrigger;
  107736. private _rightTrigger;
  107737. private _onlefttriggerchanged;
  107738. private _onrighttriggerchanged;
  107739. private _onbuttondown;
  107740. private _onbuttonup;
  107741. private _ondpaddown;
  107742. private _ondpadup;
  107743. /** Observable raised when a button is pressed */
  107744. onButtonDownObservable: Observable<DualShockButton>;
  107745. /** Observable raised when a button is released */
  107746. onButtonUpObservable: Observable<DualShockButton>;
  107747. /** Observable raised when a pad is pressed */
  107748. onPadDownObservable: Observable<DualShockDpad>;
  107749. /** Observable raised when a pad is released */
  107750. onPadUpObservable: Observable<DualShockDpad>;
  107751. private _buttonCross;
  107752. private _buttonCircle;
  107753. private _buttonSquare;
  107754. private _buttonTriangle;
  107755. private _buttonShare;
  107756. private _buttonOptions;
  107757. private _buttonL1;
  107758. private _buttonR1;
  107759. private _buttonLeftStick;
  107760. private _buttonRightStick;
  107761. private _dPadUp;
  107762. private _dPadDown;
  107763. private _dPadLeft;
  107764. private _dPadRight;
  107765. /**
  107766. * Creates a new DualShock gamepad object
  107767. * @param id defines the id of this gamepad
  107768. * @param index defines its index
  107769. * @param gamepad defines the internal HTML gamepad object
  107770. */
  107771. constructor(id: string, index: number, gamepad: any);
  107772. /**
  107773. * Defines the callback to call when left trigger is pressed
  107774. * @param callback defines the callback to use
  107775. */
  107776. onlefttriggerchanged(callback: (value: number) => void): void;
  107777. /**
  107778. * Defines the callback to call when right trigger is pressed
  107779. * @param callback defines the callback to use
  107780. */
  107781. onrighttriggerchanged(callback: (value: number) => void): void;
  107782. /**
  107783. * Gets the left trigger value
  107784. */
  107785. /**
  107786. * Sets the left trigger value
  107787. */
  107788. leftTrigger: number;
  107789. /**
  107790. * Gets the right trigger value
  107791. */
  107792. /**
  107793. * Sets the right trigger value
  107794. */
  107795. rightTrigger: number;
  107796. /**
  107797. * Defines the callback to call when a button is pressed
  107798. * @param callback defines the callback to use
  107799. */
  107800. onbuttondown(callback: (buttonPressed: DualShockButton) => void): void;
  107801. /**
  107802. * Defines the callback to call when a button is released
  107803. * @param callback defines the callback to use
  107804. */
  107805. onbuttonup(callback: (buttonReleased: DualShockButton) => void): void;
  107806. /**
  107807. * Defines the callback to call when a pad is pressed
  107808. * @param callback defines the callback to use
  107809. */
  107810. ondpaddown(callback: (dPadPressed: DualShockDpad) => void): void;
  107811. /**
  107812. * Defines the callback to call when a pad is released
  107813. * @param callback defines the callback to use
  107814. */
  107815. ondpadup(callback: (dPadReleased: DualShockDpad) => void): void;
  107816. private _setButtonValue;
  107817. private _setDPadValue;
  107818. /**
  107819. * Gets the value of the `Cross` button
  107820. */
  107821. /**
  107822. * Sets the value of the `Cross` button
  107823. */
  107824. buttonCross: number;
  107825. /**
  107826. * Gets the value of the `Circle` button
  107827. */
  107828. /**
  107829. * Sets the value of the `Circle` button
  107830. */
  107831. buttonCircle: number;
  107832. /**
  107833. * Gets the value of the `Square` button
  107834. */
  107835. /**
  107836. * Sets the value of the `Square` button
  107837. */
  107838. buttonSquare: number;
  107839. /**
  107840. * Gets the value of the `Triangle` button
  107841. */
  107842. /**
  107843. * Sets the value of the `Triangle` button
  107844. */
  107845. buttonTriangle: number;
  107846. /**
  107847. * Gets the value of the `Options` button
  107848. */
  107849. /**
  107850. * Sets the value of the `Options` button
  107851. */
  107852. buttonOptions: number;
  107853. /**
  107854. * Gets the value of the `Share` button
  107855. */
  107856. /**
  107857. * Sets the value of the `Share` button
  107858. */
  107859. buttonShare: number;
  107860. /**
  107861. * Gets the value of the `L1` button
  107862. */
  107863. /**
  107864. * Sets the value of the `L1` button
  107865. */
  107866. buttonL1: number;
  107867. /**
  107868. * Gets the value of the `R1` button
  107869. */
  107870. /**
  107871. * Sets the value of the `R1` button
  107872. */
  107873. buttonR1: number;
  107874. /**
  107875. * Gets the value of the Left joystick
  107876. */
  107877. /**
  107878. * Sets the value of the Left joystick
  107879. */
  107880. buttonLeftStick: number;
  107881. /**
  107882. * Gets the value of the Right joystick
  107883. */
  107884. /**
  107885. * Sets the value of the Right joystick
  107886. */
  107887. buttonRightStick: number;
  107888. /**
  107889. * Gets the value of D-pad up
  107890. */
  107891. /**
  107892. * Sets the value of D-pad up
  107893. */
  107894. dPadUp: number;
  107895. /**
  107896. * Gets the value of D-pad down
  107897. */
  107898. /**
  107899. * Sets the value of D-pad down
  107900. */
  107901. dPadDown: number;
  107902. /**
  107903. * Gets the value of D-pad left
  107904. */
  107905. /**
  107906. * Sets the value of D-pad left
  107907. */
  107908. dPadLeft: number;
  107909. /**
  107910. * Gets the value of D-pad right
  107911. */
  107912. /**
  107913. * Sets the value of D-pad right
  107914. */
  107915. dPadRight: number;
  107916. /**
  107917. * Force the gamepad to synchronize with device values
  107918. */
  107919. update(): void;
  107920. /**
  107921. * Disposes the gamepad
  107922. */
  107923. dispose(): void;
  107924. }
  107925. }
  107926. declare module BABYLON {
  107927. /**
  107928. * Manager for handling gamepads
  107929. */
  107930. export class GamepadManager {
  107931. private _scene?;
  107932. private _babylonGamepads;
  107933. private _oneGamepadConnected;
  107934. /** @hidden */
  107935. _isMonitoring: boolean;
  107936. private _gamepadEventSupported;
  107937. private _gamepadSupport;
  107938. /**
  107939. * observable to be triggered when the gamepad controller has been connected
  107940. */
  107941. onGamepadConnectedObservable: Observable<Gamepad>;
  107942. /**
  107943. * observable to be triggered when the gamepad controller has been disconnected
  107944. */
  107945. onGamepadDisconnectedObservable: Observable<Gamepad>;
  107946. private _onGamepadConnectedEvent;
  107947. private _onGamepadDisconnectedEvent;
  107948. /**
  107949. * Initializes the gamepad manager
  107950. * @param _scene BabylonJS scene
  107951. */
  107952. constructor(_scene?: Scene | undefined);
  107953. /**
  107954. * The gamepads in the game pad manager
  107955. */
  107956. readonly gamepads: Gamepad[];
  107957. /**
  107958. * Get the gamepad controllers based on type
  107959. * @param type The type of gamepad controller
  107960. * @returns Nullable gamepad
  107961. */
  107962. getGamepadByType(type?: number): Nullable<Gamepad>;
  107963. /**
  107964. * Disposes the gamepad manager
  107965. */
  107966. dispose(): void;
  107967. private _addNewGamepad;
  107968. private _startMonitoringGamepads;
  107969. private _stopMonitoringGamepads;
  107970. /** @hidden */
  107971. _checkGamepadsStatus(): void;
  107972. private _updateGamepadObjects;
  107973. }
  107974. }
  107975. declare module BABYLON {
  107976. interface Scene {
  107977. /** @hidden */
  107978. _gamepadManager: Nullable<GamepadManager>;
  107979. /**
  107980. * Gets the gamepad manager associated with the scene
  107981. * @see http://doc.babylonjs.com/how_to/how_to_use_gamepads
  107982. */
  107983. gamepadManager: GamepadManager;
  107984. }
  107985. /**
  107986. * Interface representing a free camera inputs manager
  107987. */
  107988. interface FreeCameraInputsManager {
  107989. /**
  107990. * Adds gamepad input support to the FreeCameraInputsManager.
  107991. * @returns the FreeCameraInputsManager
  107992. */
  107993. addGamepad(): FreeCameraInputsManager;
  107994. }
  107995. /**
  107996. * Interface representing an arc rotate camera inputs manager
  107997. */
  107998. interface ArcRotateCameraInputsManager {
  107999. /**
  108000. * Adds gamepad input support to the ArcRotateCamera InputManager.
  108001. * @returns the camera inputs manager
  108002. */
  108003. addGamepad(): ArcRotateCameraInputsManager;
  108004. }
  108005. /**
  108006. * Defines the gamepad scene component responsible to manage gamepads in a given scene
  108007. */
  108008. export class GamepadSystemSceneComponent implements ISceneComponent {
  108009. /**
  108010. * The component name helpfull to identify the component in the list of scene components.
  108011. */
  108012. readonly name: string;
  108013. /**
  108014. * The scene the component belongs to.
  108015. */
  108016. scene: Scene;
  108017. /**
  108018. * Creates a new instance of the component for the given scene
  108019. * @param scene Defines the scene to register the component in
  108020. */
  108021. constructor(scene: Scene);
  108022. /**
  108023. * Registers the component in a given scene
  108024. */
  108025. register(): void;
  108026. /**
  108027. * Rebuilds the elements related to this component in case of
  108028. * context lost for instance.
  108029. */
  108030. rebuild(): void;
  108031. /**
  108032. * Disposes the component and the associated ressources
  108033. */
  108034. dispose(): void;
  108035. private _beforeCameraUpdate;
  108036. }
  108037. }
  108038. declare module BABYLON {
  108039. /**
  108040. * 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,
  108041. * which still works and will still be found in many Playgrounds.
  108042. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  108043. */
  108044. export class UniversalCamera extends TouchCamera {
  108045. /**
  108046. * Defines the gamepad rotation sensiblity.
  108047. * This is the threshold from when rotation starts to be accounted for to prevent jittering.
  108048. */
  108049. gamepadAngularSensibility: number;
  108050. /**
  108051. * Defines the gamepad move sensiblity.
  108052. * This is the threshold from when moving starts to be accounted for for to prevent jittering.
  108053. */
  108054. gamepadMoveSensibility: number;
  108055. /**
  108056. * 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,
  108057. * which still works and will still be found in many Playgrounds.
  108058. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  108059. * @param name Define the name of the camera in the scene
  108060. * @param position Define the start position of the camera in the scene
  108061. * @param scene Define the scene the camera belongs to
  108062. */
  108063. constructor(name: string, position: Vector3, scene: Scene);
  108064. /**
  108065. * Gets the current object class name.
  108066. * @return the class name
  108067. */
  108068. getClassName(): string;
  108069. }
  108070. }
  108071. declare module BABYLON {
  108072. /**
  108073. * This represents a FPS type of camera. This is only here for back compat purpose.
  108074. * Please use the UniversalCamera instead as both are identical.
  108075. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  108076. */
  108077. export class GamepadCamera extends UniversalCamera {
  108078. /**
  108079. * Instantiates a new Gamepad Camera
  108080. * This represents a FPS type of camera. This is only here for back compat purpose.
  108081. * Please use the UniversalCamera instead as both are identical.
  108082. * @see http://doc.babylonjs.com/features/cameras#universal-camera
  108083. * @param name Define the name of the camera in the scene
  108084. * @param position Define the start position of the camera in the scene
  108085. * @param scene Define the scene the camera belongs to
  108086. */
  108087. constructor(name: string, position: Vector3, scene: Scene);
  108088. /**
  108089. * Gets the current object class name.
  108090. * @return the class name
  108091. */
  108092. getClassName(): string;
  108093. }
  108094. }
  108095. declare module BABYLON {
  108096. /** @hidden */
  108097. export var passPixelShader: {
  108098. name: string;
  108099. shader: string;
  108100. };
  108101. }
  108102. declare module BABYLON {
  108103. /** @hidden */
  108104. export var passCubePixelShader: {
  108105. name: string;
  108106. shader: string;
  108107. };
  108108. }
  108109. declare module BABYLON {
  108110. /**
  108111. * PassPostProcess which produces an output the same as it's input
  108112. */
  108113. export class PassPostProcess extends PostProcess {
  108114. /**
  108115. * Creates the PassPostProcess
  108116. * @param name The name of the effect.
  108117. * @param options The required width/height ratio to downsize to before computing the render pass.
  108118. * @param camera The camera to apply the render pass to.
  108119. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  108120. * @param engine The engine which the post process will be applied. (default: current engine)
  108121. * @param reusable If the post process can be reused on the same frame. (default: false)
  108122. * @param textureType The type of texture to be used when performing the post processing.
  108123. * @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)
  108124. */
  108125. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  108126. }
  108127. /**
  108128. * PassCubePostProcess which produces an output the same as it's input (which must be a cube texture)
  108129. */
  108130. export class PassCubePostProcess extends PostProcess {
  108131. private _face;
  108132. /**
  108133. * Gets or sets the cube face to display.
  108134. * * 0 is +X
  108135. * * 1 is -X
  108136. * * 2 is +Y
  108137. * * 3 is -Y
  108138. * * 4 is +Z
  108139. * * 5 is -Z
  108140. */
  108141. face: number;
  108142. /**
  108143. * Creates the PassCubePostProcess
  108144. * @param name The name of the effect.
  108145. * @param options The required width/height ratio to downsize to before computing the render pass.
  108146. * @param camera The camera to apply the render pass to.
  108147. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  108148. * @param engine The engine which the post process will be applied. (default: current engine)
  108149. * @param reusable If the post process can be reused on the same frame. (default: false)
  108150. * @param textureType The type of texture to be used when performing the post processing.
  108151. * @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)
  108152. */
  108153. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  108154. }
  108155. }
  108156. declare module BABYLON {
  108157. /** @hidden */
  108158. export var anaglyphPixelShader: {
  108159. name: string;
  108160. shader: string;
  108161. };
  108162. }
  108163. declare module BABYLON {
  108164. /**
  108165. * Postprocess used to generate anaglyphic rendering
  108166. */
  108167. export class AnaglyphPostProcess extends PostProcess {
  108168. private _passedProcess;
  108169. /**
  108170. * Creates a new AnaglyphPostProcess
  108171. * @param name defines postprocess name
  108172. * @param options defines creation options or target ratio scale
  108173. * @param rigCameras defines cameras using this postprocess
  108174. * @param samplingMode defines required sampling mode (BABYLON.Texture.NEAREST_SAMPLINGMODE by default)
  108175. * @param engine defines hosting engine
  108176. * @param reusable defines if the postprocess will be reused multiple times per frame
  108177. */
  108178. constructor(name: string, options: number | PostProcessOptions, rigCameras: Camera[], samplingMode?: number, engine?: Engine, reusable?: boolean);
  108179. }
  108180. }
  108181. declare module BABYLON {
  108182. /**
  108183. * Camera used to simulate anaglyphic rendering (based on ArcRotateCamera)
  108184. * @see http://doc.babylonjs.com/features/cameras#anaglyph-cameras
  108185. */
  108186. export class AnaglyphArcRotateCamera extends ArcRotateCamera {
  108187. /**
  108188. * Creates a new AnaglyphArcRotateCamera
  108189. * @param name defines camera name
  108190. * @param alpha defines alpha angle (in radians)
  108191. * @param beta defines beta angle (in radians)
  108192. * @param radius defines radius
  108193. * @param target defines camera target
  108194. * @param interaxialDistance defines distance between each color axis
  108195. * @param scene defines the hosting scene
  108196. */
  108197. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, scene: Scene);
  108198. /**
  108199. * Gets camera class name
  108200. * @returns AnaglyphArcRotateCamera
  108201. */
  108202. getClassName(): string;
  108203. }
  108204. }
  108205. declare module BABYLON {
  108206. /**
  108207. * Camera used to simulate anaglyphic rendering (based on FreeCamera)
  108208. * @see http://doc.babylonjs.com/features/cameras#anaglyph-cameras
  108209. */
  108210. export class AnaglyphFreeCamera extends FreeCamera {
  108211. /**
  108212. * Creates a new AnaglyphFreeCamera
  108213. * @param name defines camera name
  108214. * @param position defines initial position
  108215. * @param interaxialDistance defines distance between each color axis
  108216. * @param scene defines the hosting scene
  108217. */
  108218. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  108219. /**
  108220. * Gets camera class name
  108221. * @returns AnaglyphFreeCamera
  108222. */
  108223. getClassName(): string;
  108224. }
  108225. }
  108226. declare module BABYLON {
  108227. /**
  108228. * Camera used to simulate anaglyphic rendering (based on GamepadCamera)
  108229. * @see http://doc.babylonjs.com/features/cameras#anaglyph-cameras
  108230. */
  108231. export class AnaglyphGamepadCamera extends GamepadCamera {
  108232. /**
  108233. * Creates a new AnaglyphGamepadCamera
  108234. * @param name defines camera name
  108235. * @param position defines initial position
  108236. * @param interaxialDistance defines distance between each color axis
  108237. * @param scene defines the hosting scene
  108238. */
  108239. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  108240. /**
  108241. * Gets camera class name
  108242. * @returns AnaglyphGamepadCamera
  108243. */
  108244. getClassName(): string;
  108245. }
  108246. }
  108247. declare module BABYLON {
  108248. /**
  108249. * Camera used to simulate anaglyphic rendering (based on UniversalCamera)
  108250. * @see http://doc.babylonjs.com/features/cameras#anaglyph-cameras
  108251. */
  108252. export class AnaglyphUniversalCamera extends UniversalCamera {
  108253. /**
  108254. * Creates a new AnaglyphUniversalCamera
  108255. * @param name defines camera name
  108256. * @param position defines initial position
  108257. * @param interaxialDistance defines distance between each color axis
  108258. * @param scene defines the hosting scene
  108259. */
  108260. constructor(name: string, position: Vector3, interaxialDistance: number, scene: Scene);
  108261. /**
  108262. * Gets camera class name
  108263. * @returns AnaglyphUniversalCamera
  108264. */
  108265. getClassName(): string;
  108266. }
  108267. }
  108268. declare module BABYLON {
  108269. /** @hidden */
  108270. export var stereoscopicInterlacePixelShader: {
  108271. name: string;
  108272. shader: string;
  108273. };
  108274. }
  108275. declare module BABYLON {
  108276. /**
  108277. * StereoscopicInterlacePostProcess used to render stereo views from a rigged camera
  108278. */
  108279. export class StereoscopicInterlacePostProcess extends PostProcess {
  108280. private _stepSize;
  108281. private _passedProcess;
  108282. /**
  108283. * Initializes a StereoscopicInterlacePostProcess
  108284. * @param name The name of the effect.
  108285. * @param rigCameras The rig cameras to be appled to the post process
  108286. * @param isStereoscopicHoriz If the rendered results are horizontal or verticle
  108287. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  108288. * @param engine The engine which the post process will be applied. (default: current engine)
  108289. * @param reusable If the post process can be reused on the same frame. (default: false)
  108290. */
  108291. constructor(name: string, rigCameras: Camera[], isStereoscopicHoriz: boolean, samplingMode?: number, engine?: Engine, reusable?: boolean);
  108292. }
  108293. }
  108294. declare module BABYLON {
  108295. /**
  108296. * Camera used to simulate stereoscopic rendering (based on ArcRotateCamera)
  108297. * @see http://doc.babylonjs.com/features/cameras
  108298. */
  108299. export class StereoscopicArcRotateCamera extends ArcRotateCamera {
  108300. /**
  108301. * Creates a new StereoscopicArcRotateCamera
  108302. * @param name defines camera name
  108303. * @param alpha defines alpha angle (in radians)
  108304. * @param beta defines beta angle (in radians)
  108305. * @param radius defines radius
  108306. * @param target defines camera target
  108307. * @param interaxialDistance defines distance between each color axis
  108308. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  108309. * @param scene defines the hosting scene
  108310. */
  108311. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  108312. /**
  108313. * Gets camera class name
  108314. * @returns StereoscopicArcRotateCamera
  108315. */
  108316. getClassName(): string;
  108317. }
  108318. }
  108319. declare module BABYLON {
  108320. /**
  108321. * Camera used to simulate stereoscopic rendering (based on FreeCamera)
  108322. * @see http://doc.babylonjs.com/features/cameras
  108323. */
  108324. export class StereoscopicFreeCamera extends FreeCamera {
  108325. /**
  108326. * Creates a new StereoscopicFreeCamera
  108327. * @param name defines camera name
  108328. * @param position defines initial position
  108329. * @param interaxialDistance defines distance between each color axis
  108330. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  108331. * @param scene defines the hosting scene
  108332. */
  108333. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  108334. /**
  108335. * Gets camera class name
  108336. * @returns StereoscopicFreeCamera
  108337. */
  108338. getClassName(): string;
  108339. }
  108340. }
  108341. declare module BABYLON {
  108342. /**
  108343. * Camera used to simulate stereoscopic rendering (based on GamepadCamera)
  108344. * @see http://doc.babylonjs.com/features/cameras
  108345. */
  108346. export class StereoscopicGamepadCamera extends GamepadCamera {
  108347. /**
  108348. * Creates a new StereoscopicGamepadCamera
  108349. * @param name defines camera name
  108350. * @param position defines initial position
  108351. * @param interaxialDistance defines distance between each color axis
  108352. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  108353. * @param scene defines the hosting scene
  108354. */
  108355. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  108356. /**
  108357. * Gets camera class name
  108358. * @returns StereoscopicGamepadCamera
  108359. */
  108360. getClassName(): string;
  108361. }
  108362. }
  108363. declare module BABYLON {
  108364. /**
  108365. * Camera used to simulate stereoscopic rendering (based on UniversalCamera)
  108366. * @see http://doc.babylonjs.com/features/cameras
  108367. */
  108368. export class StereoscopicUniversalCamera extends UniversalCamera {
  108369. /**
  108370. * Creates a new StereoscopicUniversalCamera
  108371. * @param name defines camera name
  108372. * @param position defines initial position
  108373. * @param interaxialDistance defines distance between each color axis
  108374. * @param isStereoscopicSideBySide defines is stereoscopic is done side by side or over under
  108375. * @param scene defines the hosting scene
  108376. */
  108377. constructor(name: string, position: Vector3, interaxialDistance: number, isStereoscopicSideBySide: boolean, scene: Scene);
  108378. /**
  108379. * Gets camera class name
  108380. * @returns StereoscopicUniversalCamera
  108381. */
  108382. getClassName(): string;
  108383. }
  108384. }
  108385. declare module BABYLON {
  108386. /**
  108387. * This represents a free type of camera. It can be useful in First Person Shooter game for instance.
  108388. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  108389. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  108390. * @see http://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  108391. */
  108392. export class VirtualJoysticksCamera extends FreeCamera {
  108393. /**
  108394. * Intantiates a VirtualJoysticksCamera. It can be useful in First Person Shooter game for instance.
  108395. * It is identical to the Free Camera and simply adds by default a virtual joystick.
  108396. * Virtual Joysticks are on-screen 2D graphics that are used to control the camera or other scene items.
  108397. * @see http://doc.babylonjs.com/features/cameras#virtual-joysticks-camera
  108398. * @param name Define the name of the camera in the scene
  108399. * @param position Define the start position of the camera in the scene
  108400. * @param scene Define the scene the camera belongs to
  108401. */
  108402. constructor(name: string, position: Vector3, scene: Scene);
  108403. /**
  108404. * Gets the current object class name.
  108405. * @return the class name
  108406. */
  108407. getClassName(): string;
  108408. }
  108409. }
  108410. declare module BABYLON {
  108411. /**
  108412. * This represents all the required metrics to create a VR camera.
  108413. * @see http://doc.babylonjs.com/babylon101/cameras#device-orientation-camera
  108414. */
  108415. export class VRCameraMetrics {
  108416. /**
  108417. * Define the horizontal resolution off the screen.
  108418. */
  108419. hResolution: number;
  108420. /**
  108421. * Define the vertical resolution off the screen.
  108422. */
  108423. vResolution: number;
  108424. /**
  108425. * Define the horizontal screen size.
  108426. */
  108427. hScreenSize: number;
  108428. /**
  108429. * Define the vertical screen size.
  108430. */
  108431. vScreenSize: number;
  108432. /**
  108433. * Define the vertical screen center position.
  108434. */
  108435. vScreenCenter: number;
  108436. /**
  108437. * Define the distance of the eyes to the screen.
  108438. */
  108439. eyeToScreenDistance: number;
  108440. /**
  108441. * Define the distance between both lenses
  108442. */
  108443. lensSeparationDistance: number;
  108444. /**
  108445. * Define the distance between both viewer's eyes.
  108446. */
  108447. interpupillaryDistance: number;
  108448. /**
  108449. * Define the distortion factor of the VR postprocess.
  108450. * Please, touch with care.
  108451. */
  108452. distortionK: number[];
  108453. /**
  108454. * Define the chromatic aberration correction factors for the VR post process.
  108455. */
  108456. chromaAbCorrection: number[];
  108457. /**
  108458. * Define the scale factor of the post process.
  108459. * The smaller the better but the slower.
  108460. */
  108461. postProcessScaleFactor: number;
  108462. /**
  108463. * Define an offset for the lens center.
  108464. */
  108465. lensCenterOffset: number;
  108466. /**
  108467. * Define if the current vr camera should compensate the distortion of the lense or not.
  108468. */
  108469. compensateDistortion: boolean;
  108470. /**
  108471. * Defines if multiview should be enabled when rendering (Default: false)
  108472. */
  108473. multiviewEnabled: boolean;
  108474. /**
  108475. * Gets the rendering aspect ratio based on the provided resolutions.
  108476. */
  108477. readonly aspectRatio: number;
  108478. /**
  108479. * Gets the aspect ratio based on the FOV, scale factors, and real screen sizes.
  108480. */
  108481. readonly aspectRatioFov: number;
  108482. /**
  108483. * @hidden
  108484. */
  108485. readonly leftHMatrix: Matrix;
  108486. /**
  108487. * @hidden
  108488. */
  108489. readonly rightHMatrix: Matrix;
  108490. /**
  108491. * @hidden
  108492. */
  108493. readonly leftPreViewMatrix: Matrix;
  108494. /**
  108495. * @hidden
  108496. */
  108497. readonly rightPreViewMatrix: Matrix;
  108498. /**
  108499. * Get the default VRMetrics based on the most generic setup.
  108500. * @returns the default vr metrics
  108501. */
  108502. static GetDefault(): VRCameraMetrics;
  108503. }
  108504. }
  108505. declare module BABYLON {
  108506. /** @hidden */
  108507. export var vrDistortionCorrectionPixelShader: {
  108508. name: string;
  108509. shader: string;
  108510. };
  108511. }
  108512. declare module BABYLON {
  108513. /**
  108514. * VRDistortionCorrectionPostProcess used for mobile VR
  108515. */
  108516. export class VRDistortionCorrectionPostProcess extends PostProcess {
  108517. private _isRightEye;
  108518. private _distortionFactors;
  108519. private _postProcessScaleFactor;
  108520. private _lensCenterOffset;
  108521. private _scaleIn;
  108522. private _scaleFactor;
  108523. private _lensCenter;
  108524. /**
  108525. * Initializes the VRDistortionCorrectionPostProcess
  108526. * @param name The name of the effect.
  108527. * @param camera The camera to apply the render pass to.
  108528. * @param isRightEye If this is for the right eye distortion
  108529. * @param vrMetrics All the required metrics for the VR camera
  108530. */
  108531. constructor(name: string, camera: Camera, isRightEye: boolean, vrMetrics: VRCameraMetrics);
  108532. }
  108533. }
  108534. declare module BABYLON {
  108535. /**
  108536. * Camera used to simulate VR rendering (based on ArcRotateCamera)
  108537. * @see http://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  108538. */
  108539. export class VRDeviceOrientationArcRotateCamera extends ArcRotateCamera {
  108540. /**
  108541. * Creates a new VRDeviceOrientationArcRotateCamera
  108542. * @param name defines camera name
  108543. * @param alpha defines the camera rotation along the logitudinal axis
  108544. * @param beta defines the camera rotation along the latitudinal axis
  108545. * @param radius defines the camera distance from its target
  108546. * @param target defines the camera target
  108547. * @param scene defines the scene the camera belongs to
  108548. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  108549. * @param vrCameraMetrics defines the vr metrics associated to the camera
  108550. */
  108551. constructor(name: string, alpha: number, beta: number, radius: number, target: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  108552. /**
  108553. * Gets camera class name
  108554. * @returns VRDeviceOrientationArcRotateCamera
  108555. */
  108556. getClassName(): string;
  108557. }
  108558. }
  108559. declare module BABYLON {
  108560. /**
  108561. * Camera used to simulate VR rendering (based on FreeCamera)
  108562. * @see http://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  108563. */
  108564. export class VRDeviceOrientationFreeCamera extends DeviceOrientationCamera {
  108565. /**
  108566. * Creates a new VRDeviceOrientationFreeCamera
  108567. * @param name defines camera name
  108568. * @param position defines the start position of the camera
  108569. * @param scene defines the scene the camera belongs to
  108570. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  108571. * @param vrCameraMetrics defines the vr metrics associated to the camera
  108572. */
  108573. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  108574. /**
  108575. * Gets camera class name
  108576. * @returns VRDeviceOrientationFreeCamera
  108577. */
  108578. getClassName(): string;
  108579. }
  108580. }
  108581. declare module BABYLON {
  108582. /**
  108583. * Camera used to simulate VR rendering (based on VRDeviceOrientationFreeCamera)
  108584. * @see http://doc.babylonjs.com/babylon101/cameras#vr-device-orientation-cameras
  108585. */
  108586. export class VRDeviceOrientationGamepadCamera extends VRDeviceOrientationFreeCamera {
  108587. /**
  108588. * Creates a new VRDeviceOrientationGamepadCamera
  108589. * @param name defines camera name
  108590. * @param position defines the start position of the camera
  108591. * @param scene defines the scene the camera belongs to
  108592. * @param compensateDistortion defines if the camera needs to compensate the lens distorsion
  108593. * @param vrCameraMetrics defines the vr metrics associated to the camera
  108594. */
  108595. constructor(name: string, position: Vector3, scene: Scene, compensateDistortion?: boolean, vrCameraMetrics?: VRCameraMetrics);
  108596. /**
  108597. * Gets camera class name
  108598. * @returns VRDeviceOrientationGamepadCamera
  108599. */
  108600. getClassName(): string;
  108601. }
  108602. }
  108603. declare module BABYLON {
  108604. /**
  108605. * Base class of materials working in push mode in babylon JS
  108606. * @hidden
  108607. */
  108608. export class PushMaterial extends Material {
  108609. protected _activeEffect: Effect;
  108610. protected _normalMatrix: Matrix;
  108611. /**
  108612. * Gets or sets a boolean indicating that the material is allowed to do shader hot swapping.
  108613. * This means that the material can keep using a previous shader while a new one is being compiled.
  108614. * This is mostly used when shader parallel compilation is supported (true by default)
  108615. */
  108616. allowShaderHotSwapping: boolean;
  108617. constructor(name: string, scene: Scene);
  108618. getEffect(): Effect;
  108619. isReady(mesh?: AbstractMesh, useInstances?: boolean): boolean;
  108620. /**
  108621. * Binds the given world matrix to the active effect
  108622. *
  108623. * @param world the matrix to bind
  108624. */
  108625. bindOnlyWorldMatrix(world: Matrix): void;
  108626. /**
  108627. * Binds the given normal matrix to the active effect
  108628. *
  108629. * @param normalMatrix the matrix to bind
  108630. */
  108631. bindOnlyNormalMatrix(normalMatrix: Matrix): void;
  108632. bind(world: Matrix, mesh?: Mesh): void;
  108633. protected _afterBind(mesh: Mesh, effect?: Nullable<Effect>): void;
  108634. protected _mustRebind(scene: Scene, effect: Effect, visibility?: number): boolean;
  108635. }
  108636. }
  108637. declare module BABYLON {
  108638. /**
  108639. * This groups all the flags used to control the materials channel.
  108640. */
  108641. export class MaterialFlags {
  108642. private static _DiffuseTextureEnabled;
  108643. /**
  108644. * Are diffuse textures enabled in the application.
  108645. */
  108646. static DiffuseTextureEnabled: boolean;
  108647. private static _AmbientTextureEnabled;
  108648. /**
  108649. * Are ambient textures enabled in the application.
  108650. */
  108651. static AmbientTextureEnabled: boolean;
  108652. private static _OpacityTextureEnabled;
  108653. /**
  108654. * Are opacity textures enabled in the application.
  108655. */
  108656. static OpacityTextureEnabled: boolean;
  108657. private static _ReflectionTextureEnabled;
  108658. /**
  108659. * Are reflection textures enabled in the application.
  108660. */
  108661. static ReflectionTextureEnabled: boolean;
  108662. private static _EmissiveTextureEnabled;
  108663. /**
  108664. * Are emissive textures enabled in the application.
  108665. */
  108666. static EmissiveTextureEnabled: boolean;
  108667. private static _SpecularTextureEnabled;
  108668. /**
  108669. * Are specular textures enabled in the application.
  108670. */
  108671. static SpecularTextureEnabled: boolean;
  108672. private static _BumpTextureEnabled;
  108673. /**
  108674. * Are bump textures enabled in the application.
  108675. */
  108676. static BumpTextureEnabled: boolean;
  108677. private static _LightmapTextureEnabled;
  108678. /**
  108679. * Are lightmap textures enabled in the application.
  108680. */
  108681. static LightmapTextureEnabled: boolean;
  108682. private static _RefractionTextureEnabled;
  108683. /**
  108684. * Are refraction textures enabled in the application.
  108685. */
  108686. static RefractionTextureEnabled: boolean;
  108687. private static _ColorGradingTextureEnabled;
  108688. /**
  108689. * Are color grading textures enabled in the application.
  108690. */
  108691. static ColorGradingTextureEnabled: boolean;
  108692. private static _FresnelEnabled;
  108693. /**
  108694. * Are fresnels enabled in the application.
  108695. */
  108696. static FresnelEnabled: boolean;
  108697. private static _ClearCoatTextureEnabled;
  108698. /**
  108699. * Are clear coat textures enabled in the application.
  108700. */
  108701. static ClearCoatTextureEnabled: boolean;
  108702. private static _ClearCoatBumpTextureEnabled;
  108703. /**
  108704. * Are clear coat bump textures enabled in the application.
  108705. */
  108706. static ClearCoatBumpTextureEnabled: boolean;
  108707. private static _ClearCoatTintTextureEnabled;
  108708. /**
  108709. * Are clear coat tint textures enabled in the application.
  108710. */
  108711. static ClearCoatTintTextureEnabled: boolean;
  108712. private static _SheenTextureEnabled;
  108713. /**
  108714. * Are sheen textures enabled in the application.
  108715. */
  108716. static SheenTextureEnabled: boolean;
  108717. private static _AnisotropicTextureEnabled;
  108718. /**
  108719. * Are anisotropic textures enabled in the application.
  108720. */
  108721. static AnisotropicTextureEnabled: boolean;
  108722. private static _ThicknessTextureEnabled;
  108723. /**
  108724. * Are thickness textures enabled in the application.
  108725. */
  108726. static ThicknessTextureEnabled: boolean;
  108727. }
  108728. }
  108729. declare module BABYLON {
  108730. /** @hidden */
  108731. export var defaultFragmentDeclaration: {
  108732. name: string;
  108733. shader: string;
  108734. };
  108735. }
  108736. declare module BABYLON {
  108737. /** @hidden */
  108738. export var defaultUboDeclaration: {
  108739. name: string;
  108740. shader: string;
  108741. };
  108742. }
  108743. declare module BABYLON {
  108744. /** @hidden */
  108745. export var lightFragmentDeclaration: {
  108746. name: string;
  108747. shader: string;
  108748. };
  108749. }
  108750. declare module BABYLON {
  108751. /** @hidden */
  108752. export var lightUboDeclaration: {
  108753. name: string;
  108754. shader: string;
  108755. };
  108756. }
  108757. declare module BABYLON {
  108758. /** @hidden */
  108759. export var lightsFragmentFunctions: {
  108760. name: string;
  108761. shader: string;
  108762. };
  108763. }
  108764. declare module BABYLON {
  108765. /** @hidden */
  108766. export var shadowsFragmentFunctions: {
  108767. name: string;
  108768. shader: string;
  108769. };
  108770. }
  108771. declare module BABYLON {
  108772. /** @hidden */
  108773. export var fresnelFunction: {
  108774. name: string;
  108775. shader: string;
  108776. };
  108777. }
  108778. declare module BABYLON {
  108779. /** @hidden */
  108780. export var reflectionFunction: {
  108781. name: string;
  108782. shader: string;
  108783. };
  108784. }
  108785. declare module BABYLON {
  108786. /** @hidden */
  108787. export var bumpFragmentFunctions: {
  108788. name: string;
  108789. shader: string;
  108790. };
  108791. }
  108792. declare module BABYLON {
  108793. /** @hidden */
  108794. export var logDepthDeclaration: {
  108795. name: string;
  108796. shader: string;
  108797. };
  108798. }
  108799. declare module BABYLON {
  108800. /** @hidden */
  108801. export var bumpFragment: {
  108802. name: string;
  108803. shader: string;
  108804. };
  108805. }
  108806. declare module BABYLON {
  108807. /** @hidden */
  108808. export var depthPrePass: {
  108809. name: string;
  108810. shader: string;
  108811. };
  108812. }
  108813. declare module BABYLON {
  108814. /** @hidden */
  108815. export var lightFragment: {
  108816. name: string;
  108817. shader: string;
  108818. };
  108819. }
  108820. declare module BABYLON {
  108821. /** @hidden */
  108822. export var logDepthFragment: {
  108823. name: string;
  108824. shader: string;
  108825. };
  108826. }
  108827. declare module BABYLON {
  108828. /** @hidden */
  108829. export var defaultPixelShader: {
  108830. name: string;
  108831. shader: string;
  108832. };
  108833. }
  108834. declare module BABYLON {
  108835. /** @hidden */
  108836. export var defaultVertexDeclaration: {
  108837. name: string;
  108838. shader: string;
  108839. };
  108840. }
  108841. declare module BABYLON {
  108842. /** @hidden */
  108843. export var bumpVertexDeclaration: {
  108844. name: string;
  108845. shader: string;
  108846. };
  108847. }
  108848. declare module BABYLON {
  108849. /** @hidden */
  108850. export var bumpVertex: {
  108851. name: string;
  108852. shader: string;
  108853. };
  108854. }
  108855. declare module BABYLON {
  108856. /** @hidden */
  108857. export var fogVertex: {
  108858. name: string;
  108859. shader: string;
  108860. };
  108861. }
  108862. declare module BABYLON {
  108863. /** @hidden */
  108864. export var shadowsVertex: {
  108865. name: string;
  108866. shader: string;
  108867. };
  108868. }
  108869. declare module BABYLON {
  108870. /** @hidden */
  108871. export var pointCloudVertex: {
  108872. name: string;
  108873. shader: string;
  108874. };
  108875. }
  108876. declare module BABYLON {
  108877. /** @hidden */
  108878. export var logDepthVertex: {
  108879. name: string;
  108880. shader: string;
  108881. };
  108882. }
  108883. declare module BABYLON {
  108884. /** @hidden */
  108885. export var defaultVertexShader: {
  108886. name: string;
  108887. shader: string;
  108888. };
  108889. }
  108890. declare module BABYLON {
  108891. /** @hidden */
  108892. export class StandardMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  108893. MAINUV1: boolean;
  108894. MAINUV2: boolean;
  108895. DIFFUSE: boolean;
  108896. DIFFUSEDIRECTUV: number;
  108897. AMBIENT: boolean;
  108898. AMBIENTDIRECTUV: number;
  108899. OPACITY: boolean;
  108900. OPACITYDIRECTUV: number;
  108901. OPACITYRGB: boolean;
  108902. REFLECTION: boolean;
  108903. EMISSIVE: boolean;
  108904. EMISSIVEDIRECTUV: number;
  108905. SPECULAR: boolean;
  108906. SPECULARDIRECTUV: number;
  108907. BUMP: boolean;
  108908. BUMPDIRECTUV: number;
  108909. PARALLAX: boolean;
  108910. PARALLAXOCCLUSION: boolean;
  108911. SPECULAROVERALPHA: boolean;
  108912. CLIPPLANE: boolean;
  108913. CLIPPLANE2: boolean;
  108914. CLIPPLANE3: boolean;
  108915. CLIPPLANE4: boolean;
  108916. ALPHATEST: boolean;
  108917. DEPTHPREPASS: boolean;
  108918. ALPHAFROMDIFFUSE: boolean;
  108919. POINTSIZE: boolean;
  108920. FOG: boolean;
  108921. SPECULARTERM: boolean;
  108922. DIFFUSEFRESNEL: boolean;
  108923. OPACITYFRESNEL: boolean;
  108924. REFLECTIONFRESNEL: boolean;
  108925. REFRACTIONFRESNEL: boolean;
  108926. EMISSIVEFRESNEL: boolean;
  108927. FRESNEL: boolean;
  108928. NORMAL: boolean;
  108929. UV1: boolean;
  108930. UV2: boolean;
  108931. VERTEXCOLOR: boolean;
  108932. VERTEXALPHA: boolean;
  108933. NUM_BONE_INFLUENCERS: number;
  108934. BonesPerMesh: number;
  108935. BONETEXTURE: boolean;
  108936. INSTANCES: boolean;
  108937. GLOSSINESS: boolean;
  108938. ROUGHNESS: boolean;
  108939. EMISSIVEASILLUMINATION: boolean;
  108940. LINKEMISSIVEWITHDIFFUSE: boolean;
  108941. REFLECTIONFRESNELFROMSPECULAR: boolean;
  108942. LIGHTMAP: boolean;
  108943. LIGHTMAPDIRECTUV: number;
  108944. OBJECTSPACE_NORMALMAP: boolean;
  108945. USELIGHTMAPASSHADOWMAP: boolean;
  108946. REFLECTIONMAP_3D: boolean;
  108947. REFLECTIONMAP_SPHERICAL: boolean;
  108948. REFLECTIONMAP_PLANAR: boolean;
  108949. REFLECTIONMAP_CUBIC: boolean;
  108950. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  108951. REFLECTIONMAP_PROJECTION: boolean;
  108952. REFLECTIONMAP_SKYBOX: boolean;
  108953. REFLECTIONMAP_SKYBOX_TRANSFORMED: boolean;
  108954. REFLECTIONMAP_EXPLICIT: boolean;
  108955. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  108956. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  108957. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  108958. INVERTCUBICMAP: boolean;
  108959. LOGARITHMICDEPTH: boolean;
  108960. REFRACTION: boolean;
  108961. REFRACTIONMAP_3D: boolean;
  108962. REFLECTIONOVERALPHA: boolean;
  108963. TWOSIDEDLIGHTING: boolean;
  108964. SHADOWFLOAT: boolean;
  108965. MORPHTARGETS: boolean;
  108966. MORPHTARGETS_NORMAL: boolean;
  108967. MORPHTARGETS_TANGENT: boolean;
  108968. MORPHTARGETS_UV: boolean;
  108969. NUM_MORPH_INFLUENCERS: number;
  108970. NONUNIFORMSCALING: boolean;
  108971. PREMULTIPLYALPHA: boolean;
  108972. IMAGEPROCESSING: boolean;
  108973. VIGNETTE: boolean;
  108974. VIGNETTEBLENDMODEMULTIPLY: boolean;
  108975. VIGNETTEBLENDMODEOPAQUE: boolean;
  108976. TONEMAPPING: boolean;
  108977. TONEMAPPING_ACES: boolean;
  108978. CONTRAST: boolean;
  108979. COLORCURVES: boolean;
  108980. COLORGRADING: boolean;
  108981. COLORGRADING3D: boolean;
  108982. SAMPLER3DGREENDEPTH: boolean;
  108983. SAMPLER3DBGRMAP: boolean;
  108984. IMAGEPROCESSINGPOSTPROCESS: boolean;
  108985. MULTIVIEW: boolean;
  108986. /**
  108987. * If the reflection texture on this material is in linear color space
  108988. * @hidden
  108989. */
  108990. IS_REFLECTION_LINEAR: boolean;
  108991. /**
  108992. * If the refraction texture on this material is in linear color space
  108993. * @hidden
  108994. */
  108995. IS_REFRACTION_LINEAR: boolean;
  108996. EXPOSURE: boolean;
  108997. constructor();
  108998. setReflectionMode(modeToEnable: string): void;
  108999. }
  109000. /**
  109001. * This is the default material used in Babylon. It is the best trade off between quality
  109002. * and performances.
  109003. * @see http://doc.babylonjs.com/babylon101/materials
  109004. */
  109005. export class StandardMaterial extends PushMaterial {
  109006. private _diffuseTexture;
  109007. /**
  109008. * The basic texture of the material as viewed under a light.
  109009. */
  109010. diffuseTexture: Nullable<BaseTexture>;
  109011. private _ambientTexture;
  109012. /**
  109013. * AKA Occlusion Texture in other nomenclature, it helps adding baked shadows into your material.
  109014. */
  109015. ambientTexture: Nullable<BaseTexture>;
  109016. private _opacityTexture;
  109017. /**
  109018. * Define the transparency of the material from a texture.
  109019. * The final alpha value can be read either from the red channel (if texture.getAlphaFromRGB is false)
  109020. * or from the luminance or the current texel (if texture.getAlphaFromRGB is true)
  109021. */
  109022. opacityTexture: Nullable<BaseTexture>;
  109023. private _reflectionTexture;
  109024. /**
  109025. * Define the texture used to display the reflection.
  109026. * @see http://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  109027. */
  109028. reflectionTexture: Nullable<BaseTexture>;
  109029. private _emissiveTexture;
  109030. /**
  109031. * Define texture of the material as if self lit.
  109032. * This will be mixed in the final result even in the absence of light.
  109033. */
  109034. emissiveTexture: Nullable<BaseTexture>;
  109035. private _specularTexture;
  109036. /**
  109037. * Define how the color and intensity of the highlight given by the light in the material.
  109038. */
  109039. specularTexture: Nullable<BaseTexture>;
  109040. private _bumpTexture;
  109041. /**
  109042. * Bump mapping is a technique to simulate bump and dents on a rendered surface.
  109043. * 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.
  109044. * @see http://doc.babylonjs.com/how_to/more_materials#bump-map
  109045. */
  109046. bumpTexture: Nullable<BaseTexture>;
  109047. private _lightmapTexture;
  109048. /**
  109049. * Complex lighting can be computationally expensive to compute at runtime.
  109050. * To save on computation, lightmaps may be used to store calculated lighting in a texture which will be applied to a given mesh.
  109051. * @see http://doc.babylonjs.com/babylon101/lights#lightmaps
  109052. */
  109053. lightmapTexture: Nullable<BaseTexture>;
  109054. private _refractionTexture;
  109055. /**
  109056. * Define the texture used to display the refraction.
  109057. * @see http://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  109058. */
  109059. refractionTexture: Nullable<BaseTexture>;
  109060. /**
  109061. * The color of the material lit by the environmental background lighting.
  109062. * @see http://doc.babylonjs.com/babylon101/materials#ambient-color-example
  109063. */
  109064. ambientColor: Color3;
  109065. /**
  109066. * The basic color of the material as viewed under a light.
  109067. */
  109068. diffuseColor: Color3;
  109069. /**
  109070. * Define how the color and intensity of the highlight given by the light in the material.
  109071. */
  109072. specularColor: Color3;
  109073. /**
  109074. * Define the color of the material as if self lit.
  109075. * This will be mixed in the final result even in the absence of light.
  109076. */
  109077. emissiveColor: Color3;
  109078. /**
  109079. * Defines how sharp are the highlights in the material.
  109080. * The bigger the value the sharper giving a more glossy feeling to the result.
  109081. * Reversely, the smaller the value the blurrier giving a more rough feeling to the result.
  109082. */
  109083. specularPower: number;
  109084. private _useAlphaFromDiffuseTexture;
  109085. /**
  109086. * Does the transparency come from the diffuse texture alpha channel.
  109087. */
  109088. useAlphaFromDiffuseTexture: boolean;
  109089. private _useEmissiveAsIllumination;
  109090. /**
  109091. * If true, the emissive value is added into the end result, otherwise it is multiplied in.
  109092. */
  109093. useEmissiveAsIllumination: boolean;
  109094. private _linkEmissiveWithDiffuse;
  109095. /**
  109096. * If true, some kind of energy conservation will prevent the end result to be more than 1 by reducing
  109097. * the emissive level when the final color is close to one.
  109098. */
  109099. linkEmissiveWithDiffuse: boolean;
  109100. private _useSpecularOverAlpha;
  109101. /**
  109102. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  109103. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  109104. */
  109105. useSpecularOverAlpha: boolean;
  109106. private _useReflectionOverAlpha;
  109107. /**
  109108. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  109109. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  109110. */
  109111. useReflectionOverAlpha: boolean;
  109112. private _disableLighting;
  109113. /**
  109114. * Does lights from the scene impacts this material.
  109115. * It can be a nice trick for performance to disable lighting on a fully emissive material.
  109116. */
  109117. disableLighting: boolean;
  109118. private _useObjectSpaceNormalMap;
  109119. /**
  109120. * Allows using an object space normal map (instead of tangent space).
  109121. */
  109122. useObjectSpaceNormalMap: boolean;
  109123. private _useParallax;
  109124. /**
  109125. * Is parallax enabled or not.
  109126. * @see http://doc.babylonjs.com/how_to/using_parallax_mapping
  109127. */
  109128. useParallax: boolean;
  109129. private _useParallaxOcclusion;
  109130. /**
  109131. * Is parallax occlusion enabled or not.
  109132. * If true, the outcome is way more realistic than traditional Parallax but you can expect a performance hit that worthes consideration.
  109133. * @see http://doc.babylonjs.com/how_to/using_parallax_mapping
  109134. */
  109135. useParallaxOcclusion: boolean;
  109136. /**
  109137. * 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.
  109138. */
  109139. parallaxScaleBias: number;
  109140. private _roughness;
  109141. /**
  109142. * Helps to define how blurry the reflections should appears in the material.
  109143. */
  109144. roughness: number;
  109145. /**
  109146. * In case of refraction, define the value of the index of refraction.
  109147. * @see http://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  109148. */
  109149. indexOfRefraction: number;
  109150. /**
  109151. * Invert the refraction texture alongside the y axis.
  109152. * It can be useful with procedural textures or probe for instance.
  109153. * @see http://doc.babylonjs.com/how_to/reflect#how-to-obtain-reflections-and-refractions
  109154. */
  109155. invertRefractionY: boolean;
  109156. /**
  109157. * Defines the alpha limits in alpha test mode.
  109158. */
  109159. alphaCutOff: number;
  109160. private _useLightmapAsShadowmap;
  109161. /**
  109162. * In case of light mapping, define whether the map contains light or shadow informations.
  109163. */
  109164. useLightmapAsShadowmap: boolean;
  109165. private _diffuseFresnelParameters;
  109166. /**
  109167. * Define the diffuse fresnel parameters of the material.
  109168. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  109169. */
  109170. diffuseFresnelParameters: FresnelParameters;
  109171. private _opacityFresnelParameters;
  109172. /**
  109173. * Define the opacity fresnel parameters of the material.
  109174. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  109175. */
  109176. opacityFresnelParameters: FresnelParameters;
  109177. private _reflectionFresnelParameters;
  109178. /**
  109179. * Define the reflection fresnel parameters of the material.
  109180. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  109181. */
  109182. reflectionFresnelParameters: FresnelParameters;
  109183. private _refractionFresnelParameters;
  109184. /**
  109185. * Define the refraction fresnel parameters of the material.
  109186. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  109187. */
  109188. refractionFresnelParameters: FresnelParameters;
  109189. private _emissiveFresnelParameters;
  109190. /**
  109191. * Define the emissive fresnel parameters of the material.
  109192. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  109193. */
  109194. emissiveFresnelParameters: FresnelParameters;
  109195. private _useReflectionFresnelFromSpecular;
  109196. /**
  109197. * If true automatically deducts the fresnels values from the material specularity.
  109198. * @see http://doc.babylonjs.com/how_to/how_to_use_fresnelparameters
  109199. */
  109200. useReflectionFresnelFromSpecular: boolean;
  109201. private _useGlossinessFromSpecularMapAlpha;
  109202. /**
  109203. * Defines if the glossiness/roughness of the material should be read from the specular map alpha channel
  109204. */
  109205. useGlossinessFromSpecularMapAlpha: boolean;
  109206. private _maxSimultaneousLights;
  109207. /**
  109208. * Defines the maximum number of lights that can be used in the material
  109209. */
  109210. maxSimultaneousLights: number;
  109211. private _invertNormalMapX;
  109212. /**
  109213. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  109214. */
  109215. invertNormalMapX: boolean;
  109216. private _invertNormalMapY;
  109217. /**
  109218. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  109219. */
  109220. invertNormalMapY: boolean;
  109221. private _twoSidedLighting;
  109222. /**
  109223. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  109224. */
  109225. twoSidedLighting: boolean;
  109226. /**
  109227. * Default configuration related to image processing available in the standard Material.
  109228. */
  109229. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  109230. /**
  109231. * Gets the image processing configuration used either in this material.
  109232. */
  109233. /**
  109234. * Sets the Default image processing configuration used either in the this material.
  109235. *
  109236. * If sets to null, the scene one is in use.
  109237. */
  109238. imageProcessingConfiguration: ImageProcessingConfiguration;
  109239. /**
  109240. * Keep track of the image processing observer to allow dispose and replace.
  109241. */
  109242. private _imageProcessingObserver;
  109243. /**
  109244. * Attaches a new image processing configuration to the Standard Material.
  109245. * @param configuration
  109246. */
  109247. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  109248. /**
  109249. * Gets wether the color curves effect is enabled.
  109250. */
  109251. /**
  109252. * Sets wether the color curves effect is enabled.
  109253. */
  109254. cameraColorCurvesEnabled: boolean;
  109255. /**
  109256. * Gets wether the color grading effect is enabled.
  109257. */
  109258. /**
  109259. * Gets wether the color grading effect is enabled.
  109260. */
  109261. cameraColorGradingEnabled: boolean;
  109262. /**
  109263. * Gets wether tonemapping is enabled or not.
  109264. */
  109265. /**
  109266. * Sets wether tonemapping is enabled or not
  109267. */
  109268. cameraToneMappingEnabled: boolean;
  109269. /**
  109270. * The camera exposure used on this material.
  109271. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  109272. * This corresponds to a photographic exposure.
  109273. */
  109274. /**
  109275. * The camera exposure used on this material.
  109276. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  109277. * This corresponds to a photographic exposure.
  109278. */
  109279. cameraExposure: number;
  109280. /**
  109281. * Gets The camera contrast used on this material.
  109282. */
  109283. /**
  109284. * Sets The camera contrast used on this material.
  109285. */
  109286. cameraContrast: number;
  109287. /**
  109288. * Gets the Color Grading 2D Lookup Texture.
  109289. */
  109290. /**
  109291. * Sets the Color Grading 2D Lookup Texture.
  109292. */
  109293. cameraColorGradingTexture: Nullable<BaseTexture>;
  109294. /**
  109295. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  109296. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  109297. * 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;
  109298. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  109299. */
  109300. /**
  109301. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  109302. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  109303. * 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;
  109304. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  109305. */
  109306. cameraColorCurves: Nullable<ColorCurves>;
  109307. /**
  109308. * Custom callback helping to override the default shader used in the material.
  109309. */
  109310. customShaderNameResolve: (shaderName: string, uniforms: string[], uniformBuffers: string[], samplers: string[], defines: StandardMaterialDefines) => string;
  109311. protected _renderTargets: SmartArray<RenderTargetTexture>;
  109312. protected _worldViewProjectionMatrix: Matrix;
  109313. protected _globalAmbientColor: Color3;
  109314. protected _useLogarithmicDepth: boolean;
  109315. protected _rebuildInParallel: boolean;
  109316. /**
  109317. * Instantiates a new standard material.
  109318. * This is the default material used in Babylon. It is the best trade off between quality
  109319. * and performances.
  109320. * @see http://doc.babylonjs.com/babylon101/materials
  109321. * @param name Define the name of the material in the scene
  109322. * @param scene Define the scene the material belong to
  109323. */
  109324. constructor(name: string, scene: Scene);
  109325. /**
  109326. * Gets a boolean indicating that current material needs to register RTT
  109327. */
  109328. readonly hasRenderTargetTextures: boolean;
  109329. /**
  109330. * Gets the current class name of the material e.g. "StandardMaterial"
  109331. * Mainly use in serialization.
  109332. * @returns the class name
  109333. */
  109334. getClassName(): string;
  109335. /**
  109336. * In case the depth buffer does not allow enough depth precision for your scene (might be the case in large scenes)
  109337. * You can try switching to logarithmic depth.
  109338. * @see http://doc.babylonjs.com/how_to/using_logarithmic_depth_buffer
  109339. */
  109340. useLogarithmicDepth: boolean;
  109341. /**
  109342. * Specifies if the material will require alpha blending
  109343. * @returns a boolean specifying if alpha blending is needed
  109344. */
  109345. needAlphaBlending(): boolean;
  109346. /**
  109347. * Specifies if this material should be rendered in alpha test mode
  109348. * @returns a boolean specifying if an alpha test is needed.
  109349. */
  109350. needAlphaTesting(): boolean;
  109351. protected _shouldUseAlphaFromDiffuseTexture(): boolean;
  109352. /**
  109353. * Get the texture used for alpha test purpose.
  109354. * @returns the diffuse texture in case of the standard material.
  109355. */
  109356. getAlphaTestTexture(): Nullable<BaseTexture>;
  109357. /**
  109358. * Get if the submesh is ready to be used and all its information available.
  109359. * Child classes can use it to update shaders
  109360. * @param mesh defines the mesh to check
  109361. * @param subMesh defines which submesh to check
  109362. * @param useInstances specifies that instances should be used
  109363. * @returns a boolean indicating that the submesh is ready or not
  109364. */
  109365. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  109366. /**
  109367. * Builds the material UBO layouts.
  109368. * Used internally during the effect preparation.
  109369. */
  109370. buildUniformLayout(): void;
  109371. /**
  109372. * Unbinds the material from the mesh
  109373. */
  109374. unbind(): void;
  109375. /**
  109376. * Binds the submesh to this material by preparing the effect and shader to draw
  109377. * @param world defines the world transformation matrix
  109378. * @param mesh defines the mesh containing the submesh
  109379. * @param subMesh defines the submesh to bind the material to
  109380. */
  109381. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  109382. /**
  109383. * Get the list of animatables in the material.
  109384. * @returns the list of animatables object used in the material
  109385. */
  109386. getAnimatables(): IAnimatable[];
  109387. /**
  109388. * Gets the active textures from the material
  109389. * @returns an array of textures
  109390. */
  109391. getActiveTextures(): BaseTexture[];
  109392. /**
  109393. * Specifies if the material uses a texture
  109394. * @param texture defines the texture to check against the material
  109395. * @returns a boolean specifying if the material uses the texture
  109396. */
  109397. hasTexture(texture: BaseTexture): boolean;
  109398. /**
  109399. * Disposes the material
  109400. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  109401. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  109402. */
  109403. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  109404. /**
  109405. * Makes a duplicate of the material, and gives it a new name
  109406. * @param name defines the new name for the duplicated material
  109407. * @returns the cloned material
  109408. */
  109409. clone(name: string): StandardMaterial;
  109410. /**
  109411. * Serializes this material in a JSON representation
  109412. * @returns the serialized material object
  109413. */
  109414. serialize(): any;
  109415. /**
  109416. * Creates a standard material from parsed material data
  109417. * @param source defines the JSON representation of the material
  109418. * @param scene defines the hosting scene
  109419. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  109420. * @returns a new standard material
  109421. */
  109422. static Parse(source: any, scene: Scene, rootUrl: string): StandardMaterial;
  109423. /**
  109424. * Are diffuse textures enabled in the application.
  109425. */
  109426. static DiffuseTextureEnabled: boolean;
  109427. /**
  109428. * Are ambient textures enabled in the application.
  109429. */
  109430. static AmbientTextureEnabled: boolean;
  109431. /**
  109432. * Are opacity textures enabled in the application.
  109433. */
  109434. static OpacityTextureEnabled: boolean;
  109435. /**
  109436. * Are reflection textures enabled in the application.
  109437. */
  109438. static ReflectionTextureEnabled: boolean;
  109439. /**
  109440. * Are emissive textures enabled in the application.
  109441. */
  109442. static EmissiveTextureEnabled: boolean;
  109443. /**
  109444. * Are specular textures enabled in the application.
  109445. */
  109446. static SpecularTextureEnabled: boolean;
  109447. /**
  109448. * Are bump textures enabled in the application.
  109449. */
  109450. static BumpTextureEnabled: boolean;
  109451. /**
  109452. * Are lightmap textures enabled in the application.
  109453. */
  109454. static LightmapTextureEnabled: boolean;
  109455. /**
  109456. * Are refraction textures enabled in the application.
  109457. */
  109458. static RefractionTextureEnabled: boolean;
  109459. /**
  109460. * Are color grading textures enabled in the application.
  109461. */
  109462. static ColorGradingTextureEnabled: boolean;
  109463. /**
  109464. * Are fresnels enabled in the application.
  109465. */
  109466. static FresnelEnabled: boolean;
  109467. }
  109468. }
  109469. declare module BABYLON {
  109470. /** @hidden */
  109471. export var imageProcessingPixelShader: {
  109472. name: string;
  109473. shader: string;
  109474. };
  109475. }
  109476. declare module BABYLON {
  109477. /**
  109478. * ImageProcessingPostProcess
  109479. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#imageprocessing
  109480. */
  109481. export class ImageProcessingPostProcess extends PostProcess {
  109482. /**
  109483. * Default configuration related to image processing available in the PBR Material.
  109484. */
  109485. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  109486. /**
  109487. * Gets the image processing configuration used either in this material.
  109488. */
  109489. /**
  109490. * Sets the Default image processing configuration used either in the this material.
  109491. *
  109492. * If sets to null, the scene one is in use.
  109493. */
  109494. imageProcessingConfiguration: ImageProcessingConfiguration;
  109495. /**
  109496. * Keep track of the image processing observer to allow dispose and replace.
  109497. */
  109498. private _imageProcessingObserver;
  109499. /**
  109500. * Attaches a new image processing configuration to the PBR Material.
  109501. * @param configuration
  109502. */
  109503. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>, doNotBuild?: boolean): void;
  109504. /**
  109505. * Gets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  109506. */
  109507. /**
  109508. * Sets Color curves setup used in the effect if colorCurvesEnabled is set to true .
  109509. */
  109510. colorCurves: Nullable<ColorCurves>;
  109511. /**
  109512. * Gets wether the color curves effect is enabled.
  109513. */
  109514. /**
  109515. * Sets wether the color curves effect is enabled.
  109516. */
  109517. colorCurvesEnabled: boolean;
  109518. /**
  109519. * Gets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  109520. */
  109521. /**
  109522. * Sets Color grading LUT texture used in the effect if colorGradingEnabled is set to true.
  109523. */
  109524. colorGradingTexture: Nullable<BaseTexture>;
  109525. /**
  109526. * Gets wether the color grading effect is enabled.
  109527. */
  109528. /**
  109529. * Gets wether the color grading effect is enabled.
  109530. */
  109531. colorGradingEnabled: boolean;
  109532. /**
  109533. * Gets exposure used in the effect.
  109534. */
  109535. /**
  109536. * Sets exposure used in the effect.
  109537. */
  109538. exposure: number;
  109539. /**
  109540. * Gets wether tonemapping is enabled or not.
  109541. */
  109542. /**
  109543. * Sets wether tonemapping is enabled or not
  109544. */
  109545. toneMappingEnabled: boolean;
  109546. /**
  109547. * Gets the type of tone mapping effect.
  109548. */
  109549. /**
  109550. * Sets the type of tone mapping effect.
  109551. */
  109552. toneMappingType: number;
  109553. /**
  109554. * Gets contrast used in the effect.
  109555. */
  109556. /**
  109557. * Sets contrast used in the effect.
  109558. */
  109559. contrast: number;
  109560. /**
  109561. * Gets Vignette stretch size.
  109562. */
  109563. /**
  109564. * Sets Vignette stretch size.
  109565. */
  109566. vignetteStretch: number;
  109567. /**
  109568. * Gets Vignette centre X Offset.
  109569. */
  109570. /**
  109571. * Sets Vignette centre X Offset.
  109572. */
  109573. vignetteCentreX: number;
  109574. /**
  109575. * Gets Vignette centre Y Offset.
  109576. */
  109577. /**
  109578. * Sets Vignette centre Y Offset.
  109579. */
  109580. vignetteCentreY: number;
  109581. /**
  109582. * Gets Vignette weight or intensity of the vignette effect.
  109583. */
  109584. /**
  109585. * Sets Vignette weight or intensity of the vignette effect.
  109586. */
  109587. vignetteWeight: number;
  109588. /**
  109589. * Gets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  109590. * if vignetteEnabled is set to true.
  109591. */
  109592. /**
  109593. * Sets Color of the vignette applied on the screen through the chosen blend mode (vignetteBlendMode)
  109594. * if vignetteEnabled is set to true.
  109595. */
  109596. vignetteColor: Color4;
  109597. /**
  109598. * Gets Camera field of view used by the Vignette effect.
  109599. */
  109600. /**
  109601. * Sets Camera field of view used by the Vignette effect.
  109602. */
  109603. vignetteCameraFov: number;
  109604. /**
  109605. * Gets the vignette blend mode allowing different kind of effect.
  109606. */
  109607. /**
  109608. * Sets the vignette blend mode allowing different kind of effect.
  109609. */
  109610. vignetteBlendMode: number;
  109611. /**
  109612. * Gets wether the vignette effect is enabled.
  109613. */
  109614. /**
  109615. * Sets wether the vignette effect is enabled.
  109616. */
  109617. vignetteEnabled: boolean;
  109618. private _fromLinearSpace;
  109619. /**
  109620. * Gets wether the input of the processing is in Gamma or Linear Space.
  109621. */
  109622. /**
  109623. * Sets wether the input of the processing is in Gamma or Linear Space.
  109624. */
  109625. fromLinearSpace: boolean;
  109626. /**
  109627. * Defines cache preventing GC.
  109628. */
  109629. private _defines;
  109630. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, imageProcessingConfiguration?: ImageProcessingConfiguration);
  109631. /**
  109632. * "ImageProcessingPostProcess"
  109633. * @returns "ImageProcessingPostProcess"
  109634. */
  109635. getClassName(): string;
  109636. protected _updateParameters(): void;
  109637. dispose(camera?: Camera): void;
  109638. }
  109639. }
  109640. declare module BABYLON {
  109641. /**
  109642. * Class containing static functions to help procedurally build meshes
  109643. */
  109644. export class GroundBuilder {
  109645. /**
  109646. * Creates a ground mesh
  109647. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  109648. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  109649. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  109650. * @param name defines the name of the mesh
  109651. * @param options defines the options used to create the mesh
  109652. * @param scene defines the hosting scene
  109653. * @returns the ground mesh
  109654. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  109655. */
  109656. static CreateGround(name: string, options: {
  109657. width?: number;
  109658. height?: number;
  109659. subdivisions?: number;
  109660. subdivisionsX?: number;
  109661. subdivisionsY?: number;
  109662. updatable?: boolean;
  109663. }, scene: any): Mesh;
  109664. /**
  109665. * Creates a tiled ground mesh
  109666. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  109667. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  109668. * * 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
  109669. * * 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
  109670. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  109671. * @param name defines the name of the mesh
  109672. * @param options defines the options used to create the mesh
  109673. * @param scene defines the hosting scene
  109674. * @returns the tiled ground mesh
  109675. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  109676. */
  109677. static CreateTiledGround(name: string, options: {
  109678. xmin: number;
  109679. zmin: number;
  109680. xmax: number;
  109681. zmax: number;
  109682. subdivisions?: {
  109683. w: number;
  109684. h: number;
  109685. };
  109686. precision?: {
  109687. w: number;
  109688. h: number;
  109689. };
  109690. updatable?: boolean;
  109691. }, scene?: Nullable<Scene>): Mesh;
  109692. /**
  109693. * Creates a ground mesh from a height map
  109694. * * The parameter `url` sets the URL of the height map image resource.
  109695. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  109696. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  109697. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  109698. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  109699. * * 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.
  109700. * * 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).
  109701. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  109702. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  109703. * @param name defines the name of the mesh
  109704. * @param url defines the url to the height map
  109705. * @param options defines the options used to create the mesh
  109706. * @param scene defines the hosting scene
  109707. * @returns the ground mesh
  109708. * @see https://doc.babylonjs.com/babylon101/height_map
  109709. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  109710. */
  109711. static CreateGroundFromHeightMap(name: string, url: string, options: {
  109712. width?: number;
  109713. height?: number;
  109714. subdivisions?: number;
  109715. minHeight?: number;
  109716. maxHeight?: number;
  109717. colorFilter?: Color3;
  109718. alphaFilter?: number;
  109719. updatable?: boolean;
  109720. onReady?: (mesh: GroundMesh) => void;
  109721. }, scene?: Nullable<Scene>): GroundMesh;
  109722. }
  109723. }
  109724. declare module BABYLON {
  109725. /**
  109726. * Class containing static functions to help procedurally build meshes
  109727. */
  109728. export class TorusBuilder {
  109729. /**
  109730. * Creates a torus mesh
  109731. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  109732. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  109733. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  109734. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  109735. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  109736. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  109737. * @param name defines the name of the mesh
  109738. * @param options defines the options used to create the mesh
  109739. * @param scene defines the hosting scene
  109740. * @returns the torus mesh
  109741. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  109742. */
  109743. static CreateTorus(name: string, options: {
  109744. diameter?: number;
  109745. thickness?: number;
  109746. tessellation?: number;
  109747. updatable?: boolean;
  109748. sideOrientation?: number;
  109749. frontUVs?: Vector4;
  109750. backUVs?: Vector4;
  109751. }, scene: any): Mesh;
  109752. }
  109753. }
  109754. declare module BABYLON {
  109755. /**
  109756. * Class containing static functions to help procedurally build meshes
  109757. */
  109758. export class CylinderBuilder {
  109759. /**
  109760. * Creates a cylinder or a cone mesh
  109761. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  109762. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  109763. * * 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.
  109764. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  109765. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  109766. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  109767. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  109768. * * 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).
  109769. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  109770. * * 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).
  109771. * * 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
  109772. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  109773. * * 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
  109774. * * 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.
  109775. * * If `enclose` is false, a ring surface is one element.
  109776. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  109777. * * 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
  109778. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  109779. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  109780. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  109781. * @param name defines the name of the mesh
  109782. * @param options defines the options used to create the mesh
  109783. * @param scene defines the hosting scene
  109784. * @returns the cylinder mesh
  109785. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  109786. */
  109787. static CreateCylinder(name: string, options: {
  109788. height?: number;
  109789. diameterTop?: number;
  109790. diameterBottom?: number;
  109791. diameter?: number;
  109792. tessellation?: number;
  109793. subdivisions?: number;
  109794. arc?: number;
  109795. faceColors?: Color4[];
  109796. faceUV?: Vector4[];
  109797. updatable?: boolean;
  109798. hasRings?: boolean;
  109799. enclose?: boolean;
  109800. cap?: number;
  109801. sideOrientation?: number;
  109802. frontUVs?: Vector4;
  109803. backUVs?: Vector4;
  109804. }, scene: any): Mesh;
  109805. }
  109806. }
  109807. declare module BABYLON {
  109808. /**
  109809. * Options to modify the vr teleportation behavior.
  109810. */
  109811. export interface VRTeleportationOptions {
  109812. /**
  109813. * The name of the mesh which should be used as the teleportation floor. (default: null)
  109814. */
  109815. floorMeshName?: string;
  109816. /**
  109817. * A list of meshes to be used as the teleportation floor. (default: empty)
  109818. */
  109819. floorMeshes?: Mesh[];
  109820. }
  109821. /**
  109822. * Options to modify the vr experience helper's behavior.
  109823. */
  109824. export interface VRExperienceHelperOptions extends WebVROptions {
  109825. /**
  109826. * Create a DeviceOrientationCamera to be used as your out of vr camera. (default: true)
  109827. */
  109828. createDeviceOrientationCamera?: boolean;
  109829. /**
  109830. * Create a VRDeviceOrientationFreeCamera to be used for VR when no external HMD is found. (default: true)
  109831. */
  109832. createFallbackVRDeviceOrientationFreeCamera?: boolean;
  109833. /**
  109834. * Uses the main button on the controller to toggle the laser casted. (default: true)
  109835. */
  109836. laserToggle?: boolean;
  109837. /**
  109838. * A list of meshes to be used as the teleportation floor. If specified, teleportation will be enabled (default: undefined)
  109839. */
  109840. floorMeshes?: Mesh[];
  109841. /**
  109842. * Distortion metrics for the fallback vrDeviceOrientationCamera (default: VRCameraMetrics.Default)
  109843. */
  109844. vrDeviceOrientationCameraMetrics?: VRCameraMetrics;
  109845. }
  109846. /**
  109847. * Event containing information after VR has been entered
  109848. */
  109849. export class OnAfterEnteringVRObservableEvent {
  109850. /**
  109851. * If entering vr was successful
  109852. */
  109853. success: boolean;
  109854. }
  109855. /**
  109856. * Helps to quickly add VR support to an existing scene.
  109857. * See http://doc.babylonjs.com/how_to/webvr_helper
  109858. */
  109859. export class VRExperienceHelper {
  109860. /** Options to modify the vr experience helper's behavior. */
  109861. webVROptions: VRExperienceHelperOptions;
  109862. private _scene;
  109863. private _position;
  109864. private _btnVR;
  109865. private _btnVRDisplayed;
  109866. private _webVRsupported;
  109867. private _webVRready;
  109868. private _webVRrequesting;
  109869. private _webVRpresenting;
  109870. private _hasEnteredVR;
  109871. private _fullscreenVRpresenting;
  109872. private _inputElement;
  109873. private _webVRCamera;
  109874. private _vrDeviceOrientationCamera;
  109875. private _deviceOrientationCamera;
  109876. private _existingCamera;
  109877. private _onKeyDown;
  109878. private _onVrDisplayPresentChange;
  109879. private _onVRDisplayChanged;
  109880. private _onVRRequestPresentStart;
  109881. private _onVRRequestPresentComplete;
  109882. /**
  109883. * 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)
  109884. */
  109885. enableGazeEvenWhenNoPointerLock: boolean;
  109886. /**
  109887. * Gets or sets a boolean indicating that the VREXperienceHelper will exit VR if double tap is detected
  109888. */
  109889. exitVROnDoubleTap: boolean;
  109890. /**
  109891. * Observable raised right before entering VR.
  109892. */
  109893. onEnteringVRObservable: Observable<VRExperienceHelper>;
  109894. /**
  109895. * Observable raised when entering VR has completed.
  109896. */
  109897. onAfterEnteringVRObservable: Observable<OnAfterEnteringVRObservableEvent>;
  109898. /**
  109899. * Observable raised when exiting VR.
  109900. */
  109901. onExitingVRObservable: Observable<VRExperienceHelper>;
  109902. /**
  109903. * Observable raised when controller mesh is loaded.
  109904. */
  109905. onControllerMeshLoadedObservable: Observable<WebVRController>;
  109906. /** Return this.onEnteringVRObservable
  109907. * Note: This one is for backward compatibility. Please use onEnteringVRObservable directly
  109908. */
  109909. readonly onEnteringVR: Observable<VRExperienceHelper>;
  109910. /** Return this.onExitingVRObservable
  109911. * Note: This one is for backward compatibility. Please use onExitingVRObservable directly
  109912. */
  109913. readonly onExitingVR: Observable<VRExperienceHelper>;
  109914. /** Return this.onControllerMeshLoadedObservable
  109915. * Note: This one is for backward compatibility. Please use onControllerMeshLoadedObservable directly
  109916. */
  109917. readonly onControllerMeshLoaded: Observable<WebVRController>;
  109918. private _rayLength;
  109919. private _useCustomVRButton;
  109920. private _teleportationRequested;
  109921. private _teleportActive;
  109922. private _floorMeshName;
  109923. private _floorMeshesCollection;
  109924. private _rotationAllowed;
  109925. private _teleportBackwardsVector;
  109926. private _teleportationTarget;
  109927. private _isDefaultTeleportationTarget;
  109928. private _postProcessMove;
  109929. private _teleportationFillColor;
  109930. private _teleportationBorderColor;
  109931. private _rotationAngle;
  109932. private _haloCenter;
  109933. private _cameraGazer;
  109934. private _padSensibilityUp;
  109935. private _padSensibilityDown;
  109936. private _leftController;
  109937. private _rightController;
  109938. /**
  109939. * Observable raised when a new mesh is selected based on meshSelectionPredicate
  109940. */
  109941. onNewMeshSelected: Observable<AbstractMesh>;
  109942. /**
  109943. * Observable raised when a new mesh is selected based on meshSelectionPredicate.
  109944. * This observable will provide the mesh and the controller used to select the mesh
  109945. */
  109946. onMeshSelectedWithController: Observable<{
  109947. mesh: AbstractMesh;
  109948. controller: WebVRController;
  109949. }>;
  109950. /**
  109951. * Observable raised when a new mesh is picked based on meshSelectionPredicate
  109952. */
  109953. onNewMeshPicked: Observable<PickingInfo>;
  109954. private _circleEase;
  109955. /**
  109956. * Observable raised before camera teleportation
  109957. */
  109958. onBeforeCameraTeleport: Observable<Vector3>;
  109959. /**
  109960. * Observable raised after camera teleportation
  109961. */
  109962. onAfterCameraTeleport: Observable<Vector3>;
  109963. /**
  109964. * Observable raised when current selected mesh gets unselected
  109965. */
  109966. onSelectedMeshUnselected: Observable<AbstractMesh>;
  109967. private _raySelectionPredicate;
  109968. /**
  109969. * To be optionaly changed by user to define custom ray selection
  109970. */
  109971. raySelectionPredicate: (mesh: AbstractMesh) => boolean;
  109972. /**
  109973. * To be optionaly changed by user to define custom selection logic (after ray selection)
  109974. */
  109975. meshSelectionPredicate: (mesh: AbstractMesh) => boolean;
  109976. /**
  109977. * Set teleportation enabled. If set to false camera teleportation will be disabled but camera rotation will be kept.
  109978. */
  109979. teleportationEnabled: boolean;
  109980. private _defaultHeight;
  109981. private _teleportationInitialized;
  109982. private _interactionsEnabled;
  109983. private _interactionsRequested;
  109984. private _displayGaze;
  109985. private _displayLaserPointer;
  109986. /**
  109987. * The mesh used to display where the user is going to teleport.
  109988. */
  109989. /**
  109990. * Sets the mesh to be used to display where the user is going to teleport.
  109991. */
  109992. teleportationTarget: Mesh;
  109993. /**
  109994. * 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
  109995. * when set bakeCurrentTransformIntoVertices will be called on the mesh.
  109996. * See http://doc.babylonjs.com/resources/baking_transformations
  109997. */
  109998. gazeTrackerMesh: Mesh;
  109999. /**
  110000. * If the gaze trackers scale should be updated to be constant size when pointing at near/far meshes
  110001. */
  110002. updateGazeTrackerScale: boolean;
  110003. /**
  110004. * If the gaze trackers color should be updated when selecting meshes
  110005. */
  110006. updateGazeTrackerColor: boolean;
  110007. /**
  110008. * If the controller laser color should be updated when selecting meshes
  110009. */
  110010. updateControllerLaserColor: boolean;
  110011. /**
  110012. * The gaze tracking mesh corresponding to the left controller
  110013. */
  110014. readonly leftControllerGazeTrackerMesh: Nullable<Mesh>;
  110015. /**
  110016. * The gaze tracking mesh corresponding to the right controller
  110017. */
  110018. readonly rightControllerGazeTrackerMesh: Nullable<Mesh>;
  110019. /**
  110020. * If the ray of the gaze should be displayed.
  110021. */
  110022. /**
  110023. * Sets if the ray of the gaze should be displayed.
  110024. */
  110025. displayGaze: boolean;
  110026. /**
  110027. * If the ray of the LaserPointer should be displayed.
  110028. */
  110029. /**
  110030. * Sets if the ray of the LaserPointer should be displayed.
  110031. */
  110032. displayLaserPointer: boolean;
  110033. /**
  110034. * The deviceOrientationCamera used as the camera when not in VR.
  110035. */
  110036. readonly deviceOrientationCamera: Nullable<DeviceOrientationCamera>;
  110037. /**
  110038. * Based on the current WebVR support, returns the current VR camera used.
  110039. */
  110040. readonly currentVRCamera: Nullable<Camera>;
  110041. /**
  110042. * The webVRCamera which is used when in VR.
  110043. */
  110044. readonly webVRCamera: WebVRFreeCamera;
  110045. /**
  110046. * The deviceOrientationCamera that is used as a fallback when vr device is not connected.
  110047. */
  110048. readonly vrDeviceOrientationCamera: Nullable<VRDeviceOrientationFreeCamera>;
  110049. /**
  110050. * The html button that is used to trigger entering into VR.
  110051. */
  110052. readonly vrButton: Nullable<HTMLButtonElement>;
  110053. private readonly _teleportationRequestInitiated;
  110054. /**
  110055. * Defines wether or not Pointer lock should be requested when switching to
  110056. * full screen.
  110057. */
  110058. requestPointerLockOnFullScreen: boolean;
  110059. /**
  110060. * Instantiates a VRExperienceHelper.
  110061. * Helps to quickly add VR support to an existing scene.
  110062. * @param scene The scene the VRExperienceHelper belongs to.
  110063. * @param webVROptions Options to modify the vr experience helper's behavior.
  110064. */
  110065. constructor(scene: Scene,
  110066. /** Options to modify the vr experience helper's behavior. */
  110067. webVROptions?: VRExperienceHelperOptions);
  110068. private _onDefaultMeshLoaded;
  110069. private _onResize;
  110070. private _onFullscreenChange;
  110071. /**
  110072. * Gets a value indicating if we are currently in VR mode.
  110073. */
  110074. readonly isInVRMode: boolean;
  110075. private onVrDisplayPresentChange;
  110076. private onVRDisplayChanged;
  110077. private moveButtonToBottomRight;
  110078. private displayVRButton;
  110079. private updateButtonVisibility;
  110080. private _cachedAngularSensibility;
  110081. /**
  110082. * Attempt to enter VR. If a headset is connected and ready, will request present on that.
  110083. * Otherwise, will use the fullscreen API.
  110084. */
  110085. enterVR(): void;
  110086. /**
  110087. * Attempt to exit VR, or fullscreen.
  110088. */
  110089. exitVR(): void;
  110090. /**
  110091. * The position of the vr experience helper.
  110092. */
  110093. /**
  110094. * Sets the position of the vr experience helper.
  110095. */
  110096. position: Vector3;
  110097. /**
  110098. * Enables controllers and user interactions such as selecting and object or clicking on an object.
  110099. */
  110100. enableInteractions(): void;
  110101. private readonly _noControllerIsActive;
  110102. private beforeRender;
  110103. private _isTeleportationFloor;
  110104. /**
  110105. * Adds a floor mesh to be used for teleportation.
  110106. * @param floorMesh the mesh to be used for teleportation.
  110107. */
  110108. addFloorMesh(floorMesh: Mesh): void;
  110109. /**
  110110. * Removes a floor mesh from being used for teleportation.
  110111. * @param floorMesh the mesh to be removed.
  110112. */
  110113. removeFloorMesh(floorMesh: Mesh): void;
  110114. /**
  110115. * Enables interactions and teleportation using the VR controllers and gaze.
  110116. * @param vrTeleportationOptions options to modify teleportation behavior.
  110117. */
  110118. enableTeleportation(vrTeleportationOptions?: VRTeleportationOptions): void;
  110119. private _onNewGamepadConnected;
  110120. private _tryEnableInteractionOnController;
  110121. private _onNewGamepadDisconnected;
  110122. private _enableInteractionOnController;
  110123. private _checkTeleportWithRay;
  110124. private _checkRotate;
  110125. private _checkTeleportBackwards;
  110126. private _enableTeleportationOnController;
  110127. private _createTeleportationCircles;
  110128. private _displayTeleportationTarget;
  110129. private _hideTeleportationTarget;
  110130. private _rotateCamera;
  110131. private _moveTeleportationSelectorTo;
  110132. private _workingVector;
  110133. private _workingQuaternion;
  110134. private _workingMatrix;
  110135. /**
  110136. * Teleports the users feet to the desired location
  110137. * @param location The location where the user's feet should be placed
  110138. */
  110139. teleportCamera(location: Vector3): void;
  110140. private _convertNormalToDirectionOfRay;
  110141. private _castRayAndSelectObject;
  110142. private _notifySelectedMeshUnselected;
  110143. /**
  110144. * Sets the color of the laser ray from the vr controllers.
  110145. * @param color new color for the ray.
  110146. */
  110147. changeLaserColor(color: Color3): void;
  110148. /**
  110149. * Sets the color of the ray from the vr headsets gaze.
  110150. * @param color new color for the ray.
  110151. */
  110152. changeGazeColor(color: Color3): void;
  110153. /**
  110154. * Exits VR and disposes of the vr experience helper
  110155. */
  110156. dispose(): void;
  110157. /**
  110158. * Gets the name of the VRExperienceHelper class
  110159. * @returns "VRExperienceHelper"
  110160. */
  110161. getClassName(): string;
  110162. }
  110163. }
  110164. declare module BABYLON {
  110165. /**
  110166. * States of the webXR experience
  110167. */
  110168. export enum WebXRState {
  110169. /**
  110170. * Transitioning to being in XR mode
  110171. */
  110172. ENTERING_XR = 0,
  110173. /**
  110174. * Transitioning to non XR mode
  110175. */
  110176. EXITING_XR = 1,
  110177. /**
  110178. * In XR mode and presenting
  110179. */
  110180. IN_XR = 2,
  110181. /**
  110182. * Not entered XR mode
  110183. */
  110184. NOT_IN_XR = 3
  110185. }
  110186. /**
  110187. * Abstraction of the XR render target
  110188. */
  110189. export interface WebXRRenderTarget extends IDisposable {
  110190. /**
  110191. * xrpresent context of the canvas which can be used to display/mirror xr content
  110192. */
  110193. canvasContext: WebGLRenderingContext;
  110194. /**
  110195. * xr layer for the canvas
  110196. */
  110197. xrLayer: Nullable<XRWebGLLayer>;
  110198. /**
  110199. * Initializes the xr layer for the session
  110200. * @param xrSession xr session
  110201. * @returns a promise that will resolve once the XR Layer has been created
  110202. */
  110203. initializeXRLayerAsync(xrSession: XRSession): Promise<void>;
  110204. }
  110205. }
  110206. declare module BABYLON {
  110207. /**
  110208. * COnfiguration object for WebXR output canvas
  110209. */
  110210. export class WebXRManagedOutputCanvasOptions {
  110211. /**
  110212. * Options for this XR Layer output
  110213. */
  110214. canvasOptions: XRWebGLLayerOptions;
  110215. /**
  110216. * CSS styling for a newly created canvas (if not provided)
  110217. */
  110218. newCanvasCssStyle?: string;
  110219. /**
  110220. * Get the default values of the configuration object
  110221. * @returns default values of this configuration object
  110222. */
  110223. static GetDefaults(): WebXRManagedOutputCanvasOptions;
  110224. }
  110225. /**
  110226. * Creates a canvas that is added/removed from the webpage when entering/exiting XR
  110227. */
  110228. export class WebXRManagedOutputCanvas implements WebXRRenderTarget {
  110229. private configuration;
  110230. private _engine;
  110231. private _canvas;
  110232. /**
  110233. * xrpresent context of the canvas which can be used to display/mirror xr content
  110234. */
  110235. canvasContext: WebGLRenderingContext;
  110236. /**
  110237. * xr layer for the canvas
  110238. */
  110239. xrLayer: Nullable<XRWebGLLayer>;
  110240. /**
  110241. * Initializes the xr layer for the session
  110242. * @param xrSession xr session
  110243. * @returns a promise that will resolve once the XR Layer has been created
  110244. */
  110245. initializeXRLayerAsync(xrSession: any): any;
  110246. /**
  110247. * Initializes the canvas to be added/removed upon entering/exiting xr
  110248. * @param engine the Babylon engine
  110249. * @param canvas The canvas to be added/removed (If not specified a full screen canvas will be created)
  110250. * @param onStateChangedObservable the mechanism by which the canvas will be added/removed based on XR state
  110251. * @param configuration optional configuration for this canvas output. defaults will be used if not provided
  110252. */
  110253. constructor(engine: ThinEngine, canvas?: HTMLCanvasElement, onStateChangedObservable?: Observable<WebXRState>, configuration?: WebXRManagedOutputCanvasOptions);
  110254. /**
  110255. * Disposes of the object
  110256. */
  110257. dispose(): void;
  110258. private _setManagedOutputCanvas;
  110259. private _addCanvas;
  110260. private _removeCanvas;
  110261. }
  110262. }
  110263. declare module BABYLON {
  110264. /**
  110265. * Manages an XRSession to work with Babylon's engine
  110266. * @see https://doc.babylonjs.com/how_to/webxr
  110267. */
  110268. export class WebXRSessionManager implements IDisposable {
  110269. private scene;
  110270. /**
  110271. * Fires every time a new xrFrame arrives which can be used to update the camera
  110272. */
  110273. onXRFrameObservable: Observable<any>;
  110274. /**
  110275. * Fires when the xr session is ended either by the device or manually done
  110276. */
  110277. onXRSessionEnded: Observable<any>;
  110278. /**
  110279. * Underlying xr session
  110280. */
  110281. session: XRSession;
  110282. /**
  110283. * Type of reference space used when creating the session
  110284. */
  110285. referenceSpace: XRReferenceSpace;
  110286. /**
  110287. * Current XR frame
  110288. */
  110289. currentFrame: Nullable<XRFrame>;
  110290. private _xrNavigator;
  110291. private baseLayer;
  110292. private _rttProvider;
  110293. private _sessionEnded;
  110294. /**
  110295. * Constructs a WebXRSessionManager, this must be initialized within a user action before usage
  110296. * @param scene The scene which the session should be created for
  110297. */
  110298. constructor(scene: Scene);
  110299. /**
  110300. * Initializes the manager
  110301. * After initialization enterXR can be called to start an XR session
  110302. * @returns Promise which resolves after it is initialized
  110303. */
  110304. initializeAsync(): Promise<void>;
  110305. /**
  110306. * Initializes an xr session
  110307. * @param xrSessionMode mode to initialize
  110308. * @param optionalFeatures defines optional values to pass to the session builder
  110309. * @returns a promise which will resolve once the session has been initialized
  110310. */
  110311. initializeSessionAsync(xrSessionMode: XRSessionMode, optionalFeatures?: any): any;
  110312. /**
  110313. * Sets the reference space on the xr session
  110314. * @param referenceSpace space to set
  110315. * @returns a promise that will resolve once the reference space has been set
  110316. */
  110317. setReferenceSpaceAsync(referenceSpace: XRReferenceSpaceType): Promise<void>;
  110318. /**
  110319. * Updates the render state of the session
  110320. * @param state state to set
  110321. * @returns a promise that resolves once the render state has been updated
  110322. */
  110323. updateRenderStateAsync(state: XRRenderState): Promise<void>;
  110324. /**
  110325. * Starts rendering to the xr layer
  110326. * @returns a promise that will resolve once rendering has started
  110327. */
  110328. startRenderingToXRAsync(): Promise<void>;
  110329. /**
  110330. * Gets the correct render target texture to be rendered this frame for this eye
  110331. * @param eye the eye for which to get the render target
  110332. * @returns the render target for the specified eye
  110333. */
  110334. getRenderTargetTextureForEye(eye: XREye): RenderTargetTexture;
  110335. /**
  110336. * Stops the xrSession and restores the renderloop
  110337. * @returns Promise which resolves after it exits XR
  110338. */
  110339. exitXRAsync(): Promise<void>;
  110340. /**
  110341. * Checks if a session would be supported for the creation options specified
  110342. * @param sessionMode session mode to check if supported eg. immersive-vr
  110343. * @returns true if supported
  110344. */
  110345. supportsSessionAsync(sessionMode: XRSessionMode): any;
  110346. /**
  110347. * Creates a WebXRRenderTarget object for the XR session
  110348. * @param onStateChangedObservable optional, mechanism for enabling/disabling XR rendering canvas, used only on Web
  110349. * @param options optional options to provide when creating a new render target
  110350. * @returns a WebXR render target to which the session can render
  110351. */
  110352. getWebXRRenderTarget(onStateChangedObservable?: Observable<WebXRState>, options?: WebXRManagedOutputCanvasOptions): WebXRRenderTarget;
  110353. /**
  110354. * @hidden
  110355. * Converts the render layer of xrSession to a render target
  110356. * @param session session to create render target for
  110357. * @param scene scene the new render target should be created for
  110358. */
  110359. static _CreateRenderTargetTextureFromSession(session: XRSession, scene: Scene, baseLayer: XRWebGLLayer): RenderTargetTexture;
  110360. /**
  110361. * Disposes of the session manager
  110362. */
  110363. dispose(): void;
  110364. }
  110365. }
  110366. declare module BABYLON {
  110367. /**
  110368. * WebXR Camera which holds the views for the xrSession
  110369. * @see https://doc.babylonjs.com/how_to/webxr
  110370. */
  110371. export class WebXRCamera extends FreeCamera {
  110372. /**
  110373. * Is the camera in debug mode. Used when using an emulator
  110374. */
  110375. debugMode: boolean;
  110376. /**
  110377. * Creates a new webXRCamera, this should only be set at the camera after it has been updated by the xrSessionManager
  110378. * @param name the name of the camera
  110379. * @param scene the scene to add the camera to
  110380. */
  110381. constructor(name: string, scene: Scene);
  110382. private _updateNumberOfRigCameras;
  110383. /** @hidden */
  110384. _updateForDualEyeDebugging(): void;
  110385. /**
  110386. * Updates the cameras position from the current pose information of the XR session
  110387. * @param xrSessionManager the session containing pose information
  110388. * @returns true if the camera has been updated, false if the session did not contain pose or frame data
  110389. */
  110390. updateFromXRSessionManager(xrSessionManager: WebXRSessionManager): boolean;
  110391. }
  110392. }
  110393. declare module BABYLON {
  110394. /**
  110395. * Base set of functionality needed to create an XR experince (WebXRSessionManager, Camera, StateManagement, etc.)
  110396. * @see https://doc.babylonjs.com/how_to/webxr
  110397. */
  110398. export class WebXRExperienceHelper implements IDisposable {
  110399. private scene;
  110400. /**
  110401. * 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
  110402. */
  110403. container: AbstractMesh;
  110404. /**
  110405. * Camera used to render xr content
  110406. */
  110407. camera: WebXRCamera;
  110408. /**
  110409. * The current state of the XR experience (eg. transitioning, in XR or not in XR)
  110410. */
  110411. state: WebXRState;
  110412. private _setState;
  110413. private static _TmpVector;
  110414. /**
  110415. * Fires when the state of the experience helper has changed
  110416. */
  110417. onStateChangedObservable: Observable<WebXRState>;
  110418. /** Session manager used to keep track of xr session */
  110419. sessionManager: WebXRSessionManager;
  110420. private _nonVRCamera;
  110421. private _originalSceneAutoClear;
  110422. private _supported;
  110423. /**
  110424. * Creates the experience helper
  110425. * @param scene the scene to attach the experience helper to
  110426. * @returns a promise for the experience helper
  110427. */
  110428. static CreateAsync(scene: Scene): Promise<WebXRExperienceHelper>;
  110429. /**
  110430. * Creates a WebXRExperienceHelper
  110431. * @param scene The scene the helper should be created in
  110432. */
  110433. private constructor();
  110434. /**
  110435. * Exits XR mode and returns the scene to its original state
  110436. * @returns promise that resolves after xr mode has exited
  110437. */
  110438. exitXRAsync(): Promise<void>;
  110439. /**
  110440. * Enters XR mode (This must be done within a user interaction in most browsers eg. button click)
  110441. * @param sessionMode options for the XR session
  110442. * @param referenceSpaceType frame of reference of the XR session
  110443. * @param renderTarget the output canvas that will be used to enter XR mode
  110444. * @returns promise that resolves after xr mode has entered
  110445. */
  110446. enterXRAsync(sessionMode: XRSessionMode, referenceSpaceType: XRReferenceSpaceType, renderTarget: WebXRRenderTarget): any;
  110447. /**
  110448. * Updates the global position of the camera by moving the camera's container
  110449. * This should be used instead of modifying the camera's position as it will be overwritten by an xrSessions's update frame
  110450. * @param position The desired global position of the camera
  110451. */
  110452. setPositionOfCameraUsingContainer(position: Vector3): void;
  110453. /**
  110454. * Rotates the xr camera by rotating the camera's container around the camera's position
  110455. * This should be used instead of modifying the camera's rotation as it will be overwritten by an xrSessions's update frame
  110456. * @param rotation the desired quaternion rotation to apply to the camera
  110457. */
  110458. rotateCameraByQuaternionUsingContainer(rotation: Quaternion): void;
  110459. /**
  110460. * Disposes of the experience helper
  110461. */
  110462. dispose(): void;
  110463. }
  110464. }
  110465. declare module BABYLON {
  110466. /**
  110467. * Button which can be used to enter a different mode of XR
  110468. */
  110469. export class WebXREnterExitUIButton {
  110470. /** button element */
  110471. element: HTMLElement;
  110472. /** XR initialization options for the button */
  110473. sessionMode: XRSessionMode;
  110474. /** Reference space type */
  110475. referenceSpaceType: XRReferenceSpaceType;
  110476. /**
  110477. * Creates a WebXREnterExitUIButton
  110478. * @param element button element
  110479. * @param sessionMode XR initialization session mode
  110480. * @param referenceSpaceType the type of reference space to be used
  110481. */
  110482. constructor(
  110483. /** button element */
  110484. element: HTMLElement,
  110485. /** XR initialization options for the button */
  110486. sessionMode: XRSessionMode,
  110487. /** Reference space type */
  110488. referenceSpaceType: XRReferenceSpaceType);
  110489. /**
  110490. * Overwritable function which can be used to update the button's visuals when the state changes
  110491. * @param activeButton the current active button in the UI
  110492. */
  110493. update(activeButton: Nullable<WebXREnterExitUIButton>): void;
  110494. }
  110495. /**
  110496. * Options to create the webXR UI
  110497. */
  110498. export class WebXREnterExitUIOptions {
  110499. /**
  110500. * Context to enter xr with
  110501. */
  110502. renderTarget?: Nullable<WebXRRenderTarget>;
  110503. /**
  110504. * User provided buttons to enable/disable WebXR. The system will provide default if not set
  110505. */
  110506. customButtons?: Array<WebXREnterExitUIButton>;
  110507. }
  110508. /**
  110509. * UI to allow the user to enter/exit XR mode
  110510. */
  110511. export class WebXREnterExitUI implements IDisposable {
  110512. private scene;
  110513. private _overlay;
  110514. private _buttons;
  110515. private _activeButton;
  110516. /**
  110517. * Fired every time the active button is changed.
  110518. *
  110519. * When xr is entered via a button that launches xr that button will be the callback parameter
  110520. *
  110521. * When exiting xr the callback parameter will be null)
  110522. */
  110523. activeButtonChangedObservable: Observable<Nullable<WebXREnterExitUIButton>>;
  110524. /**
  110525. * Creates UI to allow the user to enter/exit XR mode
  110526. * @param scene the scene to add the ui to
  110527. * @param helper the xr experience helper to enter/exit xr with
  110528. * @param options options to configure the UI
  110529. * @returns the created ui
  110530. */
  110531. static CreateAsync(scene: Scene, helper: WebXRExperienceHelper, options: WebXREnterExitUIOptions): Promise<WebXREnterExitUI>;
  110532. private constructor();
  110533. private _updateButtons;
  110534. /**
  110535. * Disposes of the object
  110536. */
  110537. dispose(): void;
  110538. }
  110539. }
  110540. declare module BABYLON {
  110541. /**
  110542. * Represents an XR input
  110543. */
  110544. export class WebXRController {
  110545. private scene;
  110546. /** The underlying input source for the controller */
  110547. inputSource: XRInputSource;
  110548. private parentContainer;
  110549. /**
  110550. * 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
  110551. */
  110552. grip?: AbstractMesh;
  110553. /**
  110554. * Pointer which can be used to select objects or attach a visible laser to
  110555. */
  110556. pointer: AbstractMesh;
  110557. private _gamepadMode;
  110558. /**
  110559. * If available, this is the gamepad object related to this controller.
  110560. * Using this object it is possible to get click events and trackpad changes of the
  110561. * webxr controller that is currently being used.
  110562. */
  110563. gamepadController?: WebVRController;
  110564. /**
  110565. * Event that fires when the controller is removed/disposed
  110566. */
  110567. onDisposeObservable: Observable<{}>;
  110568. private _tmpMatrix;
  110569. private _tmpQuaternion;
  110570. private _tmpVector;
  110571. /**
  110572. * Creates the controller
  110573. * @see https://doc.babylonjs.com/how_to/webxr
  110574. * @param scene the scene which the controller should be associated to
  110575. * @param inputSource the underlying input source for the controller
  110576. * @param parentContainer parent that the controller meshes should be children of
  110577. */
  110578. constructor(scene: Scene,
  110579. /** The underlying input source for the controller */
  110580. inputSource: XRInputSource, parentContainer?: Nullable<AbstractMesh>);
  110581. /**
  110582. * Updates the controller pose based on the given XRFrame
  110583. * @param xrFrame xr frame to update the pose with
  110584. * @param referenceSpace reference space to use
  110585. */
  110586. updateFromXRFrame(xrFrame: XRFrame, referenceSpace: XRReferenceSpace): void;
  110587. /**
  110588. * Gets a world space ray coming from the controller
  110589. * @param result the resulting ray
  110590. */
  110591. getWorldPointerRayToRef(result: Ray): void;
  110592. /**
  110593. * Get the scene associated with this controller
  110594. * @returns the scene object
  110595. */
  110596. getScene(): Scene;
  110597. /**
  110598. * Disposes of the object
  110599. */
  110600. dispose(): void;
  110601. }
  110602. }
  110603. declare module BABYLON {
  110604. /**
  110605. * XR input used to track XR inputs such as controllers/rays
  110606. */
  110607. export class WebXRInput implements IDisposable {
  110608. /**
  110609. * Base experience the input listens to
  110610. */
  110611. baseExperience: WebXRExperienceHelper;
  110612. /**
  110613. * XR controllers being tracked
  110614. */
  110615. controllers: Array<WebXRController>;
  110616. private _frameObserver;
  110617. private _stateObserver;
  110618. /**
  110619. * Event when a controller has been connected/added
  110620. */
  110621. onControllerAddedObservable: Observable<WebXRController>;
  110622. /**
  110623. * Event when a controller has been removed/disconnected
  110624. */
  110625. onControllerRemovedObservable: Observable<WebXRController>;
  110626. /**
  110627. * Initializes the WebXRInput
  110628. * @param baseExperience experience helper which the input should be created for
  110629. */
  110630. constructor(
  110631. /**
  110632. * Base experience the input listens to
  110633. */
  110634. baseExperience: WebXRExperienceHelper);
  110635. private _onInputSourcesChange;
  110636. private _addAndRemoveControllers;
  110637. /**
  110638. * Disposes of the object
  110639. */
  110640. dispose(): void;
  110641. }
  110642. }
  110643. declare module BABYLON {
  110644. /**
  110645. * Enables teleportation
  110646. */
  110647. export class WebXRControllerTeleportation {
  110648. private _teleportationFillColor;
  110649. private _teleportationBorderColor;
  110650. private _tmpRay;
  110651. private _tmpVector;
  110652. /**
  110653. * Creates a WebXRControllerTeleportation
  110654. * @param input input manager to add teleportation to
  110655. * @param floorMeshes floormeshes which can be teleported to
  110656. */
  110657. constructor(input: WebXRInput, floorMeshes?: Array<AbstractMesh>);
  110658. }
  110659. }
  110660. declare module BABYLON {
  110661. /**
  110662. * Handles pointer input automatically for the pointer of XR controllers
  110663. */
  110664. export class WebXRControllerPointerSelection {
  110665. private static _idCounter;
  110666. private _tmpRay;
  110667. /**
  110668. * Creates a WebXRControllerPointerSelection
  110669. * @param input input manager to setup pointer selection
  110670. */
  110671. constructor(input: WebXRInput);
  110672. private _convertNormalToDirectionOfRay;
  110673. private _updatePointerDistance;
  110674. }
  110675. }
  110676. declare module BABYLON {
  110677. /**
  110678. * Class used to represent data loading progression
  110679. */
  110680. export class SceneLoaderProgressEvent {
  110681. /** defines if data length to load can be evaluated */
  110682. readonly lengthComputable: boolean;
  110683. /** defines the loaded data length */
  110684. readonly loaded: number;
  110685. /** defines the data length to load */
  110686. readonly total: number;
  110687. /**
  110688. * Create a new progress event
  110689. * @param lengthComputable defines if data length to load can be evaluated
  110690. * @param loaded defines the loaded data length
  110691. * @param total defines the data length to load
  110692. */
  110693. constructor(
  110694. /** defines if data length to load can be evaluated */
  110695. lengthComputable: boolean,
  110696. /** defines the loaded data length */
  110697. loaded: number,
  110698. /** defines the data length to load */
  110699. total: number);
  110700. /**
  110701. * Creates a new SceneLoaderProgressEvent from a ProgressEvent
  110702. * @param event defines the source event
  110703. * @returns a new SceneLoaderProgressEvent
  110704. */
  110705. static FromProgressEvent(event: ProgressEvent): SceneLoaderProgressEvent;
  110706. }
  110707. /**
  110708. * Interface used by SceneLoader plugins to define supported file extensions
  110709. */
  110710. export interface ISceneLoaderPluginExtensions {
  110711. /**
  110712. * Defines the list of supported extensions
  110713. */
  110714. [extension: string]: {
  110715. isBinary: boolean;
  110716. };
  110717. }
  110718. /**
  110719. * Interface used by SceneLoader plugin factory
  110720. */
  110721. export interface ISceneLoaderPluginFactory {
  110722. /**
  110723. * Defines the name of the factory
  110724. */
  110725. name: string;
  110726. /**
  110727. * Function called to create a new plugin
  110728. * @return the new plugin
  110729. */
  110730. createPlugin(): ISceneLoaderPlugin | ISceneLoaderPluginAsync;
  110731. /**
  110732. * The callback that returns true if the data can be directly loaded.
  110733. * @param data string containing the file data
  110734. * @returns if the data can be loaded directly
  110735. */
  110736. canDirectLoad?(data: string): boolean;
  110737. }
  110738. /**
  110739. * Interface used to define the base of ISceneLoaderPlugin and ISceneLoaderPluginAsync
  110740. */
  110741. export interface ISceneLoaderPluginBase {
  110742. /**
  110743. * The friendly name of this plugin.
  110744. */
  110745. name: string;
  110746. /**
  110747. * The file extensions supported by this plugin.
  110748. */
  110749. extensions: string | ISceneLoaderPluginExtensions;
  110750. /**
  110751. * The callback called when loading from a url.
  110752. * @param scene scene loading this url
  110753. * @param url url to load
  110754. * @param onSuccess callback called when the file successfully loads
  110755. * @param onProgress callback called while file is loading (if the server supports this mode)
  110756. * @param useArrayBuffer defines a boolean indicating that date must be returned as ArrayBuffer
  110757. * @param onError callback called when the file fails to load
  110758. * @returns a file request object
  110759. */
  110760. requestFile?(scene: Scene, url: string, onSuccess: (data: any, request?: WebRequest) => void, onProgress?: (ev: ProgressEvent) => void, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  110761. /**
  110762. * The callback called when loading from a file object.
  110763. * @param scene scene loading this file
  110764. * @param file defines the file to load
  110765. * @param onSuccess defines the callback to call when data is loaded
  110766. * @param onProgress defines the callback to call during loading process
  110767. * @param useArrayBuffer defines a boolean indicating that data must be returned as an ArrayBuffer
  110768. * @param onError defines the callback to call when an error occurs
  110769. * @returns a file request object
  110770. */
  110771. readFile?(scene: Scene, file: File, onSuccess: (data: any) => void, onProgress?: (ev: ProgressEvent) => any, useArrayBuffer?: boolean, onError?: (error: any) => void): IFileRequest;
  110772. /**
  110773. * The callback that returns true if the data can be directly loaded.
  110774. * @param data string containing the file data
  110775. * @returns if the data can be loaded directly
  110776. */
  110777. canDirectLoad?(data: string): boolean;
  110778. /**
  110779. * The callback that returns the data to pass to the plugin if the data can be directly loaded.
  110780. * @param scene scene loading this data
  110781. * @param data string containing the data
  110782. * @returns data to pass to the plugin
  110783. */
  110784. directLoad?(scene: Scene, data: string): any;
  110785. /**
  110786. * The callback that allows custom handling of the root url based on the response url.
  110787. * @param rootUrl the original root url
  110788. * @param responseURL the response url if available
  110789. * @returns the new root url
  110790. */
  110791. rewriteRootURL?(rootUrl: string, responseURL?: string): string;
  110792. }
  110793. /**
  110794. * Interface used to define a SceneLoader plugin
  110795. */
  110796. export interface ISceneLoaderPlugin extends ISceneLoaderPluginBase {
  110797. /**
  110798. * Import meshes into a scene.
  110799. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  110800. * @param scene The scene to import into
  110801. * @param data The data to import
  110802. * @param rootUrl The root url for scene and resources
  110803. * @param meshes The meshes array to import into
  110804. * @param particleSystems The particle systems array to import into
  110805. * @param skeletons The skeletons array to import into
  110806. * @param onError The callback when import fails
  110807. * @returns True if successful or false otherwise
  110808. */
  110809. importMesh(meshesNames: any, scene: Scene, data: any, rootUrl: string, meshes: AbstractMesh[], particleSystems: IParticleSystem[], skeletons: Skeleton[], onError?: (message: string, exception?: any) => void): boolean;
  110810. /**
  110811. * Load into a scene.
  110812. * @param scene The scene to load into
  110813. * @param data The data to import
  110814. * @param rootUrl The root url for scene and resources
  110815. * @param onError The callback when import fails
  110816. * @returns True if successful or false otherwise
  110817. */
  110818. load(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): boolean;
  110819. /**
  110820. * Load into an asset container.
  110821. * @param scene The scene to load into
  110822. * @param data The data to import
  110823. * @param rootUrl The root url for scene and resources
  110824. * @param onError The callback when import fails
  110825. * @returns The loaded asset container
  110826. */
  110827. loadAssetContainer(scene: Scene, data: any, rootUrl: string, onError?: (message: string, exception?: any) => void): AssetContainer;
  110828. }
  110829. /**
  110830. * Interface used to define an async SceneLoader plugin
  110831. */
  110832. export interface ISceneLoaderPluginAsync extends ISceneLoaderPluginBase {
  110833. /**
  110834. * Import meshes into a scene.
  110835. * @param meshesNames An array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  110836. * @param scene The scene to import into
  110837. * @param data The data to import
  110838. * @param rootUrl The root url for scene and resources
  110839. * @param onProgress The callback when the load progresses
  110840. * @param fileName Defines the name of the file to load
  110841. * @returns The loaded meshes, particle systems, skeletons, and animation groups
  110842. */
  110843. importMeshAsync(meshesNames: any, scene: Scene, data: any, rootUrl: string, onProgress?: (event: SceneLoaderProgressEvent) => void, fileName?: string): Promise<{
  110844. meshes: AbstractMesh[];
  110845. particleSystems: IParticleSystem[];
  110846. skeletons: Skeleton[];
  110847. animationGroups: AnimationGroup[];
  110848. }>;
  110849. /**
  110850. * Load into a scene.
  110851. * @param scene The scene to load into
  110852. * @param data The data to import
  110853. * @param rootUrl The root url for scene and resources
  110854. * @param onProgress The callback when the load progresses
  110855. * @param fileName Defines the name of the file to load
  110856. * @returns Nothing
  110857. */
  110858. loadAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: SceneLoaderProgressEvent) => void, fileName?: string): Promise<void>;
  110859. /**
  110860. * Load into an asset container.
  110861. * @param scene The scene to load into
  110862. * @param data The data to import
  110863. * @param rootUrl The root url for scene and resources
  110864. * @param onProgress The callback when the load progresses
  110865. * @param fileName Defines the name of the file to load
  110866. * @returns The loaded asset container
  110867. */
  110868. loadAssetContainerAsync(scene: Scene, data: any, rootUrl: string, onProgress?: (event: SceneLoaderProgressEvent) => void, fileName?: string): Promise<AssetContainer>;
  110869. }
  110870. /**
  110871. * Class used to load scene from various file formats using registered plugins
  110872. * @see http://doc.babylonjs.com/how_to/load_from_any_file_type
  110873. */
  110874. export class SceneLoader {
  110875. /**
  110876. * No logging while loading
  110877. */
  110878. static readonly NO_LOGGING: number;
  110879. /**
  110880. * Minimal logging while loading
  110881. */
  110882. static readonly MINIMAL_LOGGING: number;
  110883. /**
  110884. * Summary logging while loading
  110885. */
  110886. static readonly SUMMARY_LOGGING: number;
  110887. /**
  110888. * Detailled logging while loading
  110889. */
  110890. static readonly DETAILED_LOGGING: number;
  110891. /**
  110892. * Gets or sets a boolean indicating if entire scene must be loaded even if scene contains incremental data
  110893. */
  110894. static ForceFullSceneLoadingForIncremental: boolean;
  110895. /**
  110896. * Gets or sets a boolean indicating if loading screen must be displayed while loading a scene
  110897. */
  110898. static ShowLoadingScreen: boolean;
  110899. /**
  110900. * Defines the current logging level (while loading the scene)
  110901. * @ignorenaming
  110902. */
  110903. static loggingLevel: number;
  110904. /**
  110905. * Gets or set a boolean indicating if matrix weights must be cleaned upon loading
  110906. */
  110907. static CleanBoneMatrixWeights: boolean;
  110908. /**
  110909. * Event raised when a plugin is used to load a scene
  110910. */
  110911. static OnPluginActivatedObservable: Observable<ISceneLoaderPlugin | ISceneLoaderPluginAsync>;
  110912. private static _registeredPlugins;
  110913. private static _getDefaultPlugin;
  110914. private static _getPluginForExtension;
  110915. private static _getPluginForDirectLoad;
  110916. private static _getPluginForFilename;
  110917. private static _getDirectLoad;
  110918. private static _loadData;
  110919. private static _getFileInfo;
  110920. /**
  110921. * Gets a plugin that can load the given extension
  110922. * @param extension defines the extension to load
  110923. * @returns a plugin or null if none works
  110924. */
  110925. static GetPluginForExtension(extension: string): ISceneLoaderPlugin | ISceneLoaderPluginAsync | ISceneLoaderPluginFactory;
  110926. /**
  110927. * Gets a boolean indicating that the given extension can be loaded
  110928. * @param extension defines the extension to load
  110929. * @returns true if the extension is supported
  110930. */
  110931. static IsPluginForExtensionAvailable(extension: string): boolean;
  110932. /**
  110933. * Adds a new plugin to the list of registered plugins
  110934. * @param plugin defines the plugin to add
  110935. */
  110936. static RegisterPlugin(plugin: ISceneLoaderPlugin | ISceneLoaderPluginAsync): void;
  110937. /**
  110938. * Import meshes into a scene
  110939. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  110940. * @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)
  110941. * @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)
  110942. * @param scene the instance of BABYLON.Scene to append to
  110943. * @param onSuccess a callback with a list of imported meshes, particleSystems, and skeletons when import succeeds
  110944. * @param onProgress a callback with a progress event for each file being loaded
  110945. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  110946. * @param pluginExtension the extension used to determine the plugin
  110947. * @returns The loaded plugin
  110948. */
  110949. 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>;
  110950. /**
  110951. * Import meshes into a scene
  110952. * @param meshNames an array of mesh names, a single mesh name, or empty string for all meshes that filter what meshes are imported
  110953. * @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)
  110954. * @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)
  110955. * @param scene the instance of BABYLON.Scene to append to
  110956. * @param onProgress a callback with a progress event for each file being loaded
  110957. * @param pluginExtension the extension used to determine the plugin
  110958. * @returns The loaded list of imported meshes, particle systems, skeletons, and animation groups
  110959. */
  110960. static ImportMeshAsync(meshNames: any, rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<{
  110961. meshes: AbstractMesh[];
  110962. particleSystems: IParticleSystem[];
  110963. skeletons: Skeleton[];
  110964. animationGroups: AnimationGroup[];
  110965. }>;
  110966. /**
  110967. * Load a scene
  110968. * @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)
  110969. * @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)
  110970. * @param engine is the instance of BABYLON.Engine to use to create the scene
  110971. * @param onSuccess a callback with the scene when import succeeds
  110972. * @param onProgress a callback with a progress event for each file being loaded
  110973. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  110974. * @param pluginExtension the extension used to determine the plugin
  110975. * @returns The loaded plugin
  110976. */
  110977. 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>;
  110978. /**
  110979. * Load a scene
  110980. * @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)
  110981. * @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)
  110982. * @param engine is the instance of BABYLON.Engine to use to create the scene
  110983. * @param onProgress a callback with a progress event for each file being loaded
  110984. * @param pluginExtension the extension used to determine the plugin
  110985. * @returns The loaded scene
  110986. */
  110987. static LoadAsync(rootUrl: string, sceneFilename?: string | File, engine?: Nullable<Engine>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  110988. /**
  110989. * Append a scene
  110990. * @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)
  110991. * @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)
  110992. * @param scene is the instance of BABYLON.Scene to append to
  110993. * @param onSuccess a callback with the scene when import succeeds
  110994. * @param onProgress a callback with a progress event for each file being loaded
  110995. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  110996. * @param pluginExtension the extension used to determine the plugin
  110997. * @returns The loaded plugin
  110998. */
  110999. 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>;
  111000. /**
  111001. * Append a scene
  111002. * @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)
  111003. * @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)
  111004. * @param scene is the instance of BABYLON.Scene to append to
  111005. * @param onProgress a callback with a progress event for each file being loaded
  111006. * @param pluginExtension the extension used to determine the plugin
  111007. * @returns The given scene
  111008. */
  111009. static AppendAsync(rootUrl: string, sceneFilename?: string | File, scene?: Nullable<Scene>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<Scene>;
  111010. /**
  111011. * Load a scene into an asset container
  111012. * @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)
  111013. * @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)
  111014. * @param scene is the instance of BABYLON.Scene to append to (default: last created scene)
  111015. * @param onSuccess a callback with the scene when import succeeds
  111016. * @param onProgress a callback with a progress event for each file being loaded
  111017. * @param onError a callback with the scene, a message, and possibly an exception when import fails
  111018. * @param pluginExtension the extension used to determine the plugin
  111019. * @returns The loaded plugin
  111020. */
  111021. 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>;
  111022. /**
  111023. * Load a scene into an asset container
  111024. * @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)
  111025. * @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)
  111026. * @param scene is the instance of Scene to append to
  111027. * @param onProgress a callback with a progress event for each file being loaded
  111028. * @param pluginExtension the extension used to determine the plugin
  111029. * @returns The loaded asset container
  111030. */
  111031. static LoadAssetContainerAsync(rootUrl: string, sceneFilename?: string, scene?: Nullable<Scene>, onProgress?: Nullable<(event: SceneLoaderProgressEvent) => void>, pluginExtension?: Nullable<string>): Promise<AssetContainer>;
  111032. }
  111033. }
  111034. declare module BABYLON {
  111035. /**
  111036. * Generic Controller
  111037. */
  111038. export class GenericController extends WebVRController {
  111039. /**
  111040. * Base Url for the controller model.
  111041. */
  111042. static readonly MODEL_BASE_URL: string;
  111043. /**
  111044. * File name for the controller model.
  111045. */
  111046. static readonly MODEL_FILENAME: string;
  111047. /**
  111048. * Creates a new GenericController from a gamepad
  111049. * @param vrGamepad the gamepad that the controller should be created from
  111050. */
  111051. constructor(vrGamepad: any);
  111052. /**
  111053. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  111054. * @param scene scene in which to add meshes
  111055. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  111056. */
  111057. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  111058. /**
  111059. * Called once for each button that changed state since the last frame
  111060. * @param buttonIdx Which button index changed
  111061. * @param state New state of the button
  111062. * @param changes Which properties on the state changed since last frame
  111063. */
  111064. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  111065. }
  111066. }
  111067. declare module BABYLON {
  111068. /**
  111069. * Defines the WindowsMotionController object that the state of the windows motion controller
  111070. */
  111071. export class WindowsMotionController extends WebVRController {
  111072. /**
  111073. * The base url used to load the left and right controller models
  111074. */
  111075. static MODEL_BASE_URL: string;
  111076. /**
  111077. * The name of the left controller model file
  111078. */
  111079. static MODEL_LEFT_FILENAME: string;
  111080. /**
  111081. * The name of the right controller model file
  111082. */
  111083. static MODEL_RIGHT_FILENAME: string;
  111084. /**
  111085. * The controller name prefix for this controller type
  111086. */
  111087. static readonly GAMEPAD_ID_PREFIX: string;
  111088. /**
  111089. * The controller id pattern for this controller type
  111090. */
  111091. private static readonly GAMEPAD_ID_PATTERN;
  111092. private _loadedMeshInfo;
  111093. private readonly _mapping;
  111094. /**
  111095. * Fired when the trackpad on this controller is clicked
  111096. */
  111097. onTrackpadChangedObservable: Observable<ExtendedGamepadButton>;
  111098. /**
  111099. * Fired when the trackpad on this controller is modified
  111100. */
  111101. onTrackpadValuesChangedObservable: Observable<StickValues>;
  111102. /**
  111103. * The current x and y values of this controller's trackpad
  111104. */
  111105. trackpad: StickValues;
  111106. /**
  111107. * Creates a new WindowsMotionController from a gamepad
  111108. * @param vrGamepad the gamepad that the controller should be created from
  111109. */
  111110. constructor(vrGamepad: any);
  111111. /**
  111112. * Fired when the trigger on this controller is modified
  111113. */
  111114. readonly onTriggerButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  111115. /**
  111116. * Fired when the menu button on this controller is modified
  111117. */
  111118. readonly onMenuButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  111119. /**
  111120. * Fired when the grip button on this controller is modified
  111121. */
  111122. readonly onGripButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  111123. /**
  111124. * Fired when the thumbstick button on this controller is modified
  111125. */
  111126. readonly onThumbstickButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  111127. /**
  111128. * Fired when the touchpad button on this controller is modified
  111129. */
  111130. readonly onTouchpadButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  111131. /**
  111132. * Fired when the touchpad values on this controller are modified
  111133. */
  111134. readonly onTouchpadValuesChangedObservable: Observable<StickValues>;
  111135. private _updateTrackpad;
  111136. /**
  111137. * Called once per frame by the engine.
  111138. */
  111139. update(): void;
  111140. /**
  111141. * Called once for each button that changed state since the last frame
  111142. * @param buttonIdx Which button index changed
  111143. * @param state New state of the button
  111144. * @param changes Which properties on the state changed since last frame
  111145. */
  111146. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  111147. /**
  111148. * Moves the buttons on the controller mesh based on their current state
  111149. * @param buttonName the name of the button to move
  111150. * @param buttonValue the value of the button which determines the buttons new position
  111151. */
  111152. protected _lerpButtonTransform(buttonName: string, buttonValue: number): void;
  111153. /**
  111154. * Moves the axis on the controller mesh based on its current state
  111155. * @param axis the index of the axis
  111156. * @param axisValue the value of the axis which determines the meshes new position
  111157. * @hidden
  111158. */
  111159. protected _lerpAxisTransform(axis: number, axisValue: number): void;
  111160. /**
  111161. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  111162. * @param scene scene in which to add meshes
  111163. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  111164. */
  111165. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void, forceDefault?: boolean): void;
  111166. /**
  111167. * Takes a list of meshes (as loaded from the glTF file) and finds the root node, as well as nodes that
  111168. * can be transformed by button presses and axes values, based on this._mapping.
  111169. *
  111170. * @param scene scene in which the meshes exist
  111171. * @param meshes list of meshes that make up the controller model to process
  111172. * @return structured view of the given meshes, with mapping of buttons and axes to meshes that can be transformed.
  111173. */
  111174. private processModel;
  111175. private createMeshInfo;
  111176. /**
  111177. * Gets the ray of the controller in the direction the controller is pointing
  111178. * @param length the length the resulting ray should be
  111179. * @returns a ray in the direction the controller is pointing
  111180. */
  111181. getForwardRay(length?: number): Ray;
  111182. /**
  111183. * Disposes of the controller
  111184. */
  111185. dispose(): void;
  111186. }
  111187. }
  111188. declare module BABYLON {
  111189. /**
  111190. * Oculus Touch Controller
  111191. */
  111192. export class OculusTouchController extends WebVRController {
  111193. /**
  111194. * Base Url for the controller model.
  111195. */
  111196. static MODEL_BASE_URL: string;
  111197. /**
  111198. * File name for the left controller model.
  111199. */
  111200. static MODEL_LEFT_FILENAME: string;
  111201. /**
  111202. * File name for the right controller model.
  111203. */
  111204. static MODEL_RIGHT_FILENAME: string;
  111205. /**
  111206. * Base Url for the Quest controller model.
  111207. */
  111208. static QUEST_MODEL_BASE_URL: string;
  111209. /**
  111210. * @hidden
  111211. * If the controllers are running on a device that needs the updated Quest controller models
  111212. */
  111213. static _IsQuest: boolean;
  111214. /**
  111215. * Fired when the secondary trigger on this controller is modified
  111216. */
  111217. onSecondaryTriggerStateChangedObservable: Observable<ExtendedGamepadButton>;
  111218. /**
  111219. * Fired when the thumb rest on this controller is modified
  111220. */
  111221. onThumbRestChangedObservable: Observable<ExtendedGamepadButton>;
  111222. /**
  111223. * Creates a new OculusTouchController from a gamepad
  111224. * @param vrGamepad the gamepad that the controller should be created from
  111225. */
  111226. constructor(vrGamepad: any);
  111227. /**
  111228. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  111229. * @param scene scene in which to add meshes
  111230. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  111231. */
  111232. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  111233. /**
  111234. * Fired when the A button on this controller is modified
  111235. */
  111236. readonly onAButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  111237. /**
  111238. * Fired when the B button on this controller is modified
  111239. */
  111240. readonly onBButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  111241. /**
  111242. * Fired when the X button on this controller is modified
  111243. */
  111244. readonly onXButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  111245. /**
  111246. * Fired when the Y button on this controller is modified
  111247. */
  111248. readonly onYButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  111249. /**
  111250. * Called once for each button that changed state since the last frame
  111251. * 0) thumb stick (touch, press, value = pressed (0,1)). value is in this.leftStick
  111252. * 1) index trigger (touch (?), press (only when value > 0.1), value 0 to 1)
  111253. * 2) secondary trigger (same)
  111254. * 3) A (right) X (left), touch, pressed = value
  111255. * 4) B / Y
  111256. * 5) thumb rest
  111257. * @param buttonIdx Which button index changed
  111258. * @param state New state of the button
  111259. * @param changes Which properties on the state changed since last frame
  111260. */
  111261. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  111262. }
  111263. }
  111264. declare module BABYLON {
  111265. /**
  111266. * Vive Controller
  111267. */
  111268. export class ViveController extends WebVRController {
  111269. /**
  111270. * Base Url for the controller model.
  111271. */
  111272. static MODEL_BASE_URL: string;
  111273. /**
  111274. * File name for the controller model.
  111275. */
  111276. static MODEL_FILENAME: string;
  111277. /**
  111278. * Creates a new ViveController from a gamepad
  111279. * @param vrGamepad the gamepad that the controller should be created from
  111280. */
  111281. constructor(vrGamepad: any);
  111282. /**
  111283. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  111284. * @param scene scene in which to add meshes
  111285. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  111286. */
  111287. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  111288. /**
  111289. * Fired when the left button on this controller is modified
  111290. */
  111291. readonly onLeftButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  111292. /**
  111293. * Fired when the right button on this controller is modified
  111294. */
  111295. readonly onRightButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  111296. /**
  111297. * Fired when the menu button on this controller is modified
  111298. */
  111299. readonly onMenuButtonStateChangedObservable: Observable<ExtendedGamepadButton>;
  111300. /**
  111301. * Called once for each button that changed state since the last frame
  111302. * Vive mapping:
  111303. * 0: touchpad
  111304. * 1: trigger
  111305. * 2: left AND right buttons
  111306. * 3: menu button
  111307. * @param buttonIdx Which button index changed
  111308. * @param state New state of the button
  111309. * @param changes Which properties on the state changed since last frame
  111310. */
  111311. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  111312. }
  111313. }
  111314. declare module BABYLON {
  111315. /**
  111316. * Loads a controller model and adds it as a child of the WebXRControllers grip when the controller is created
  111317. */
  111318. export class WebXRControllerModelLoader {
  111319. /**
  111320. * Creates the WebXRControllerModelLoader
  111321. * @param input xr input that creates the controllers
  111322. */
  111323. constructor(input: WebXRInput);
  111324. }
  111325. }
  111326. declare module BABYLON {
  111327. /**
  111328. * Options for the default xr helper
  111329. */
  111330. export class WebXRDefaultExperienceOptions {
  111331. /**
  111332. * Floor meshes that should be used for teleporting
  111333. */
  111334. floorMeshes: Array<AbstractMesh>;
  111335. /**
  111336. * Enable or disable default UI to enter XR
  111337. */
  111338. disableDefaultUI: boolean;
  111339. /**
  111340. * optional configuration for the output canvas
  111341. */
  111342. outputCanvasOptions?: WebXRManagedOutputCanvasOptions;
  111343. }
  111344. /**
  111345. * Default experience which provides a similar setup to the previous webVRExperience
  111346. */
  111347. export class WebXRDefaultExperience {
  111348. /**
  111349. * Base experience
  111350. */
  111351. baseExperience: WebXRExperienceHelper;
  111352. /**
  111353. * Input experience extension
  111354. */
  111355. input: WebXRInput;
  111356. /**
  111357. * Loads the controller models
  111358. */
  111359. controllerModelLoader: WebXRControllerModelLoader;
  111360. /**
  111361. * Enables laser pointer and selection
  111362. */
  111363. pointerSelection: WebXRControllerPointerSelection;
  111364. /**
  111365. * Enables teleportation
  111366. */
  111367. teleportation: WebXRControllerTeleportation;
  111368. /**
  111369. * Enables ui for enetering/exiting xr
  111370. */
  111371. enterExitUI: WebXREnterExitUI;
  111372. /**
  111373. * Default target xr should render to
  111374. */
  111375. renderTarget: WebXRRenderTarget;
  111376. /**
  111377. * Creates the default xr experience
  111378. * @param scene scene
  111379. * @param options options for basic configuration
  111380. * @returns resulting WebXRDefaultExperience
  111381. */
  111382. static CreateAsync(scene: Scene, options: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  111383. private constructor();
  111384. /**
  111385. * DIsposes of the experience helper
  111386. */
  111387. dispose(): void;
  111388. }
  111389. }
  111390. declare module BABYLON {
  111391. /**
  111392. * Contains an array of blocks representing the octree
  111393. */
  111394. export interface IOctreeContainer<T> {
  111395. /**
  111396. * Blocks within the octree
  111397. */
  111398. blocks: Array<OctreeBlock<T>>;
  111399. }
  111400. /**
  111401. * Class used to store a cell in an octree
  111402. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  111403. */
  111404. export class OctreeBlock<T> {
  111405. /**
  111406. * Gets the content of the current block
  111407. */
  111408. entries: T[];
  111409. /**
  111410. * Gets the list of block children
  111411. */
  111412. blocks: Array<OctreeBlock<T>>;
  111413. private _depth;
  111414. private _maxDepth;
  111415. private _capacity;
  111416. private _minPoint;
  111417. private _maxPoint;
  111418. private _boundingVectors;
  111419. private _creationFunc;
  111420. /**
  111421. * Creates a new block
  111422. * @param minPoint defines the minimum vector (in world space) of the block's bounding box
  111423. * @param maxPoint defines the maximum vector (in world space) of the block's bounding box
  111424. * @param capacity defines the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  111425. * @param depth defines the current depth of this block in the octree
  111426. * @param maxDepth defines the maximal depth allowed (beyond this value, the capacity is ignored)
  111427. * @param creationFunc defines a callback to call when an element is added to the block
  111428. */
  111429. constructor(minPoint: Vector3, maxPoint: Vector3, capacity: number, depth: number, maxDepth: number, creationFunc: (entry: T, block: OctreeBlock<T>) => void);
  111430. /**
  111431. * Gets the maximum capacity of this block (if capacity is reached the block will be split into sub blocks)
  111432. */
  111433. readonly capacity: number;
  111434. /**
  111435. * Gets the minimum vector (in world space) of the block's bounding box
  111436. */
  111437. readonly minPoint: Vector3;
  111438. /**
  111439. * Gets the maximum vector (in world space) of the block's bounding box
  111440. */
  111441. readonly maxPoint: Vector3;
  111442. /**
  111443. * Add a new element to this block
  111444. * @param entry defines the element to add
  111445. */
  111446. addEntry(entry: T): void;
  111447. /**
  111448. * Remove an element from this block
  111449. * @param entry defines the element to remove
  111450. */
  111451. removeEntry(entry: T): void;
  111452. /**
  111453. * Add an array of elements to this block
  111454. * @param entries defines the array of elements to add
  111455. */
  111456. addEntries(entries: T[]): void;
  111457. /**
  111458. * Test if the current block intersects the furstum planes and if yes, then add its content to the selection array
  111459. * @param frustumPlanes defines the frustum planes to test
  111460. * @param selection defines the array to store current content if selection is positive
  111461. * @param allowDuplicate defines if the selection array can contains duplicated entries
  111462. */
  111463. select(frustumPlanes: Plane[], selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  111464. /**
  111465. * Test if the current block intersect with the given bounding sphere and if yes, then add its content to the selection array
  111466. * @param sphereCenter defines the bounding sphere center
  111467. * @param sphereRadius defines the bounding sphere radius
  111468. * @param selection defines the array to store current content if selection is positive
  111469. * @param allowDuplicate defines if the selection array can contains duplicated entries
  111470. */
  111471. intersects(sphereCenter: Vector3, sphereRadius: number, selection: SmartArrayNoDuplicate<T>, allowDuplicate?: boolean): void;
  111472. /**
  111473. * Test if the current block intersect with the given ray and if yes, then add its content to the selection array
  111474. * @param ray defines the ray to test with
  111475. * @param selection defines the array to store current content if selection is positive
  111476. */
  111477. intersectsRay(ray: Ray, selection: SmartArrayNoDuplicate<T>): void;
  111478. /**
  111479. * Subdivide the content into child blocks (this block will then be empty)
  111480. */
  111481. createInnerBlocks(): void;
  111482. /**
  111483. * @hidden
  111484. */
  111485. 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;
  111486. }
  111487. }
  111488. declare module BABYLON {
  111489. /**
  111490. * Octrees are a really powerful data structure that can quickly select entities based on space coordinates.
  111491. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  111492. */
  111493. export class Octree<T> {
  111494. /** 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.) */
  111495. maxDepth: number;
  111496. /**
  111497. * Blocks within the octree containing objects
  111498. */
  111499. blocks: Array<OctreeBlock<T>>;
  111500. /**
  111501. * Content stored in the octree
  111502. */
  111503. dynamicContent: T[];
  111504. private _maxBlockCapacity;
  111505. private _selectionContent;
  111506. private _creationFunc;
  111507. /**
  111508. * Creates a octree
  111509. * @see https://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  111510. * @param creationFunc function to be used to instatiate the octree
  111511. * @param maxBlockCapacity defines the maximum number of meshes you want on your octree's leaves (default: 64)
  111512. * @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.)
  111513. */
  111514. constructor(creationFunc: (entry: T, block: OctreeBlock<T>) => void, maxBlockCapacity?: number,
  111515. /** 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.) */
  111516. maxDepth?: number);
  111517. /**
  111518. * Updates the octree by adding blocks for the passed in meshes within the min and max world parameters
  111519. * @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);
  111520. * @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);
  111521. * @param entries meshes to be added to the octree blocks
  111522. */
  111523. update(worldMin: Vector3, worldMax: Vector3, entries: T[]): void;
  111524. /**
  111525. * Adds a mesh to the octree
  111526. * @param entry Mesh to add to the octree
  111527. */
  111528. addMesh(entry: T): void;
  111529. /**
  111530. * Remove an element from the octree
  111531. * @param entry defines the element to remove
  111532. */
  111533. removeMesh(entry: T): void;
  111534. /**
  111535. * Selects an array of meshes within the frustum
  111536. * @param frustumPlanes The frustum planes to use which will select all meshes within it
  111537. * @param allowDuplicate If duplicate objects are allowed in the resulting object array
  111538. * @returns array of meshes within the frustum
  111539. */
  111540. select(frustumPlanes: Plane[], allowDuplicate?: boolean): SmartArray<T>;
  111541. /**
  111542. * Test if the octree intersect with the given bounding sphere and if yes, then add its content to the selection array
  111543. * @param sphereCenter defines the bounding sphere center
  111544. * @param sphereRadius defines the bounding sphere radius
  111545. * @param allowDuplicate defines if the selection array can contains duplicated entries
  111546. * @returns an array of objects that intersect the sphere
  111547. */
  111548. intersects(sphereCenter: Vector3, sphereRadius: number, allowDuplicate?: boolean): SmartArray<T>;
  111549. /**
  111550. * Test if the octree intersect with the given ray and if yes, then add its content to resulting array
  111551. * @param ray defines the ray to test with
  111552. * @returns array of intersected objects
  111553. */
  111554. intersectsRay(ray: Ray): SmartArray<T>;
  111555. /**
  111556. * Adds a mesh into the octree block if it intersects the block
  111557. */
  111558. static CreationFuncForMeshes: (entry: AbstractMesh, block: OctreeBlock<AbstractMesh>) => void;
  111559. /**
  111560. * Adds a submesh into the octree block if it intersects the block
  111561. */
  111562. static CreationFuncForSubMeshes: (entry: SubMesh, block: OctreeBlock<SubMesh>) => void;
  111563. }
  111564. }
  111565. declare module BABYLON {
  111566. interface Scene {
  111567. /**
  111568. * @hidden
  111569. * Backing Filed
  111570. */
  111571. _selectionOctree: Octree<AbstractMesh>;
  111572. /**
  111573. * Gets the octree used to boost mesh selection (picking)
  111574. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  111575. */
  111576. selectionOctree: Octree<AbstractMesh>;
  111577. /**
  111578. * Creates or updates the octree used to boost selection (picking)
  111579. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  111580. * @param maxCapacity defines the maximum capacity per leaf
  111581. * @param maxDepth defines the maximum depth of the octree
  111582. * @returns an octree of AbstractMesh
  111583. */
  111584. createOrUpdateSelectionOctree(maxCapacity?: number, maxDepth?: number): Octree<AbstractMesh>;
  111585. }
  111586. interface AbstractMesh {
  111587. /**
  111588. * @hidden
  111589. * Backing Field
  111590. */
  111591. _submeshesOctree: Octree<SubMesh>;
  111592. /**
  111593. * This function will create an octree to help to select the right submeshes for rendering, picking and collision computations.
  111594. * Please note that you must have a decent number of submeshes to get performance improvements when using an octree
  111595. * @param maxCapacity defines the maximum size of each block (64 by default)
  111596. * @param maxDepth defines the maximum depth to use (no more than 2 levels by default)
  111597. * @returns the new octree
  111598. * @see https://www.babylonjs-playground.com/#NA4OQ#12
  111599. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene_with_octrees
  111600. */
  111601. createOrUpdateSubmeshesOctree(maxCapacity?: number, maxDepth?: number): Octree<SubMesh>;
  111602. }
  111603. /**
  111604. * Defines the octree scene component responsible to manage any octrees
  111605. * in a given scene.
  111606. */
  111607. export class OctreeSceneComponent {
  111608. /**
  111609. * The component name help to identify the component in the list of scene components.
  111610. */
  111611. readonly name: string;
  111612. /**
  111613. * The scene the component belongs to.
  111614. */
  111615. scene: Scene;
  111616. /**
  111617. * Indicates if the meshes have been checked to make sure they are isEnabled()
  111618. */
  111619. readonly checksIsEnabled: boolean;
  111620. /**
  111621. * Creates a new instance of the component for the given scene
  111622. * @param scene Defines the scene to register the component in
  111623. */
  111624. constructor(scene: Scene);
  111625. /**
  111626. * Registers the component in a given scene
  111627. */
  111628. register(): void;
  111629. /**
  111630. * Return the list of active meshes
  111631. * @returns the list of active meshes
  111632. */
  111633. getActiveMeshCandidates(): ISmartArrayLike<AbstractMesh>;
  111634. /**
  111635. * Return the list of active sub meshes
  111636. * @param mesh The mesh to get the candidates sub meshes from
  111637. * @returns the list of active sub meshes
  111638. */
  111639. getActiveSubMeshCandidates(mesh: AbstractMesh): ISmartArrayLike<SubMesh>;
  111640. private _tempRay;
  111641. /**
  111642. * Return the list of sub meshes intersecting with a given local ray
  111643. * @param mesh defines the mesh to find the submesh for
  111644. * @param localRay defines the ray in local space
  111645. * @returns the list of intersecting sub meshes
  111646. */
  111647. getIntersectingSubMeshCandidates(mesh: AbstractMesh, localRay: Ray): ISmartArrayLike<SubMesh>;
  111648. /**
  111649. * Return the list of sub meshes colliding with a collider
  111650. * @param mesh defines the mesh to find the submesh for
  111651. * @param collider defines the collider to evaluate the collision against
  111652. * @returns the list of colliding sub meshes
  111653. */
  111654. getCollidingSubMeshCandidates(mesh: AbstractMesh, collider: Collider): ISmartArrayLike<SubMesh>;
  111655. /**
  111656. * Rebuilds the elements related to this component in case of
  111657. * context lost for instance.
  111658. */
  111659. rebuild(): void;
  111660. /**
  111661. * Disposes the component and the associated ressources.
  111662. */
  111663. dispose(): void;
  111664. }
  111665. }
  111666. declare module BABYLON {
  111667. /**
  111668. * Renders a layer on top of an existing scene
  111669. */
  111670. export class UtilityLayerRenderer implements IDisposable {
  111671. /** the original scene that will be rendered on top of */
  111672. originalScene: Scene;
  111673. private _pointerCaptures;
  111674. private _lastPointerEvents;
  111675. private static _DefaultUtilityLayer;
  111676. private static _DefaultKeepDepthUtilityLayer;
  111677. private _sharedGizmoLight;
  111678. private _renderCamera;
  111679. /**
  111680. * Gets the camera that is used to render the utility layer (when not set, this will be the last active camera)
  111681. * @returns the camera that is used when rendering the utility layer
  111682. */
  111683. getRenderCamera(): Nullable<Camera>;
  111684. /**
  111685. * Sets the camera that should be used when rendering the utility layer (If set to null the last active camera will be used)
  111686. * @param cam the camera that should be used when rendering the utility layer
  111687. */
  111688. setRenderCamera(cam: Nullable<Camera>): void;
  111689. /**
  111690. * @hidden
  111691. * Light which used by gizmos to get light shading
  111692. */
  111693. _getSharedGizmoLight(): HemisphericLight;
  111694. /**
  111695. * If the picking should be done on the utility layer prior to the actual scene (Default: true)
  111696. */
  111697. pickUtilitySceneFirst: boolean;
  111698. /**
  111699. * 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)
  111700. */
  111701. static readonly DefaultUtilityLayer: UtilityLayerRenderer;
  111702. /**
  111703. * 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)
  111704. */
  111705. static readonly DefaultKeepDepthUtilityLayer: UtilityLayerRenderer;
  111706. /**
  111707. * The scene that is rendered on top of the original scene
  111708. */
  111709. utilityLayerScene: Scene;
  111710. /**
  111711. * If the utility layer should automatically be rendered on top of existing scene
  111712. */
  111713. shouldRender: boolean;
  111714. /**
  111715. * If set to true, only pointer down onPointerObservable events will be blocked when picking is occluded by original scene
  111716. */
  111717. onlyCheckPointerDownEvents: boolean;
  111718. /**
  111719. * If set to false, only pointerUp, pointerDown and pointerMove will be sent to the utilityLayerScene (false by default)
  111720. */
  111721. processAllEvents: boolean;
  111722. /**
  111723. * Observable raised when the pointer move from the utility layer scene to the main scene
  111724. */
  111725. onPointerOutObservable: Observable<number>;
  111726. /** Gets or sets a predicate that will be used to indicate utility meshes present in the main scene */
  111727. mainSceneTrackerPredicate: (mesh: Nullable<AbstractMesh>) => boolean;
  111728. private _afterRenderObserver;
  111729. private _sceneDisposeObserver;
  111730. private _originalPointerObserver;
  111731. /**
  111732. * Instantiates a UtilityLayerRenderer
  111733. * @param originalScene the original scene that will be rendered on top of
  111734. * @param handleEvents boolean indicating if the utility layer should handle events
  111735. */
  111736. constructor(
  111737. /** the original scene that will be rendered on top of */
  111738. originalScene: Scene, handleEvents?: boolean);
  111739. private _notifyObservers;
  111740. /**
  111741. * Renders the utility layers scene on top of the original scene
  111742. */
  111743. render(): void;
  111744. /**
  111745. * Disposes of the renderer
  111746. */
  111747. dispose(): void;
  111748. private _updateCamera;
  111749. }
  111750. }
  111751. declare module BABYLON {
  111752. /**
  111753. * Renders gizmos on top of an existing scene which provide controls for position, rotation, etc.
  111754. */
  111755. export class Gizmo implements IDisposable {
  111756. /** The utility layer the gizmo will be added to */
  111757. gizmoLayer: UtilityLayerRenderer;
  111758. /**
  111759. * The root mesh of the gizmo
  111760. */
  111761. _rootMesh: Mesh;
  111762. private _attachedMesh;
  111763. /**
  111764. * Ratio for the scale of the gizmo (Default: 1)
  111765. */
  111766. scaleRatio: number;
  111767. /**
  111768. * If a custom mesh has been set (Default: false)
  111769. */
  111770. protected _customMeshSet: boolean;
  111771. /**
  111772. * Mesh that the gizmo will be attached to. (eg. on a drag gizmo the mesh that will be dragged)
  111773. * * When set, interactions will be enabled
  111774. */
  111775. attachedMesh: Nullable<AbstractMesh>;
  111776. /**
  111777. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  111778. * @param mesh The mesh to replace the default mesh of the gizmo
  111779. */
  111780. setCustomMesh(mesh: Mesh): void;
  111781. /**
  111782. * If set the gizmo's rotation will be updated to match the attached mesh each frame (Default: true)
  111783. */
  111784. updateGizmoRotationToMatchAttachedMesh: boolean;
  111785. /**
  111786. * If set the gizmo's position will be updated to match the attached mesh each frame (Default: true)
  111787. */
  111788. updateGizmoPositionToMatchAttachedMesh: boolean;
  111789. /**
  111790. * When set, the gizmo will always appear the same size no matter where the camera is (default: true)
  111791. */
  111792. updateScale: boolean;
  111793. protected _interactionsEnabled: boolean;
  111794. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  111795. private _beforeRenderObserver;
  111796. private _tempVector;
  111797. /**
  111798. * Creates a gizmo
  111799. * @param gizmoLayer The utility layer the gizmo will be added to
  111800. */
  111801. constructor(
  111802. /** The utility layer the gizmo will be added to */
  111803. gizmoLayer?: UtilityLayerRenderer);
  111804. /**
  111805. * Updates the gizmo to match the attached mesh's position/rotation
  111806. */
  111807. protected _update(): void;
  111808. /**
  111809. * Disposes of the gizmo
  111810. */
  111811. dispose(): void;
  111812. }
  111813. }
  111814. declare module BABYLON {
  111815. /**
  111816. * Single plane drag gizmo
  111817. */
  111818. export class PlaneDragGizmo extends Gizmo {
  111819. /**
  111820. * Drag behavior responsible for the gizmos dragging interactions
  111821. */
  111822. dragBehavior: PointerDragBehavior;
  111823. private _pointerObserver;
  111824. /**
  111825. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  111826. */
  111827. snapDistance: number;
  111828. /**
  111829. * Event that fires each time the gizmo snaps to a new location.
  111830. * * snapDistance is the the change in distance
  111831. */
  111832. onSnapObservable: Observable<{
  111833. snapDistance: number;
  111834. }>;
  111835. private _plane;
  111836. private _coloredMaterial;
  111837. private _hoverMaterial;
  111838. private _isEnabled;
  111839. private _parent;
  111840. /** @hidden */
  111841. static _CreatePlane(scene: Scene, material: StandardMaterial): TransformNode;
  111842. /** @hidden */
  111843. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  111844. /**
  111845. * Creates a PlaneDragGizmo
  111846. * @param gizmoLayer The utility layer the gizmo will be added to
  111847. * @param dragPlaneNormal The axis normal to which the gizmo will be able to drag on
  111848. * @param color The color of the gizmo
  111849. */
  111850. constructor(dragPlaneNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>);
  111851. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  111852. /**
  111853. * If the gizmo is enabled
  111854. */
  111855. isEnabled: boolean;
  111856. /**
  111857. * Disposes of the gizmo
  111858. */
  111859. dispose(): void;
  111860. }
  111861. }
  111862. declare module BABYLON {
  111863. /**
  111864. * Gizmo that enables dragging a mesh along 3 axis
  111865. */
  111866. export class PositionGizmo extends Gizmo {
  111867. /**
  111868. * Internal gizmo used for interactions on the x axis
  111869. */
  111870. xGizmo: AxisDragGizmo;
  111871. /**
  111872. * Internal gizmo used for interactions on the y axis
  111873. */
  111874. yGizmo: AxisDragGizmo;
  111875. /**
  111876. * Internal gizmo used for interactions on the z axis
  111877. */
  111878. zGizmo: AxisDragGizmo;
  111879. /**
  111880. * Internal gizmo used for interactions on the yz plane
  111881. */
  111882. xPlaneGizmo: PlaneDragGizmo;
  111883. /**
  111884. * Internal gizmo used for interactions on the xz plane
  111885. */
  111886. yPlaneGizmo: PlaneDragGizmo;
  111887. /**
  111888. * Internal gizmo used for interactions on the xy plane
  111889. */
  111890. zPlaneGizmo: PlaneDragGizmo;
  111891. /**
  111892. * private variables
  111893. */
  111894. private _meshAttached;
  111895. private _updateGizmoRotationToMatchAttachedMesh;
  111896. private _snapDistance;
  111897. private _scaleRatio;
  111898. /** Fires an event when any of it's sub gizmos are dragged */
  111899. onDragStartObservable: Observable<unknown>;
  111900. /** Fires an event when any of it's sub gizmos are released from dragging */
  111901. onDragEndObservable: Observable<unknown>;
  111902. /**
  111903. * If set to true, planar drag is enabled
  111904. */
  111905. private _planarGizmoEnabled;
  111906. attachedMesh: Nullable<AbstractMesh>;
  111907. /**
  111908. * Creates a PositionGizmo
  111909. * @param gizmoLayer The utility layer the gizmo will be added to
  111910. */
  111911. constructor(gizmoLayer?: UtilityLayerRenderer);
  111912. /**
  111913. * If the planar drag gizmo is enabled
  111914. * setting this will enable/disable XY, XZ and YZ planes regardless of individual gizmo settings.
  111915. */
  111916. planarGizmoEnabled: boolean;
  111917. updateGizmoRotationToMatchAttachedMesh: boolean;
  111918. /**
  111919. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  111920. */
  111921. snapDistance: number;
  111922. /**
  111923. * Ratio for the scale of the gizmo (Default: 1)
  111924. */
  111925. scaleRatio: number;
  111926. /**
  111927. * Disposes of the gizmo
  111928. */
  111929. dispose(): void;
  111930. /**
  111931. * CustomMeshes are not supported by this gizmo
  111932. * @param mesh The mesh to replace the default mesh of the gizmo
  111933. */
  111934. setCustomMesh(mesh: Mesh): void;
  111935. }
  111936. }
  111937. declare module BABYLON {
  111938. /**
  111939. * Single axis drag gizmo
  111940. */
  111941. export class AxisDragGizmo extends Gizmo {
  111942. /**
  111943. * Drag behavior responsible for the gizmos dragging interactions
  111944. */
  111945. dragBehavior: PointerDragBehavior;
  111946. private _pointerObserver;
  111947. /**
  111948. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  111949. */
  111950. snapDistance: number;
  111951. /**
  111952. * Event that fires each time the gizmo snaps to a new location.
  111953. * * snapDistance is the the change in distance
  111954. */
  111955. onSnapObservable: Observable<{
  111956. snapDistance: number;
  111957. }>;
  111958. private _isEnabled;
  111959. private _parent;
  111960. private _arrow;
  111961. private _coloredMaterial;
  111962. private _hoverMaterial;
  111963. /** @hidden */
  111964. static _CreateArrow(scene: Scene, material: StandardMaterial): TransformNode;
  111965. /** @hidden */
  111966. static _CreateArrowInstance(scene: Scene, arrow: TransformNode): TransformNode;
  111967. /**
  111968. * Creates an AxisDragGizmo
  111969. * @param gizmoLayer The utility layer the gizmo will be added to
  111970. * @param dragAxis The axis which the gizmo will be able to drag on
  111971. * @param color The color of the gizmo
  111972. */
  111973. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<PositionGizmo>);
  111974. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  111975. /**
  111976. * If the gizmo is enabled
  111977. */
  111978. isEnabled: boolean;
  111979. /**
  111980. * Disposes of the gizmo
  111981. */
  111982. dispose(): void;
  111983. }
  111984. }
  111985. declare module BABYLON.Debug {
  111986. /**
  111987. * The Axes viewer will show 3 axes in a specific point in space
  111988. */
  111989. export class AxesViewer {
  111990. private _xAxis;
  111991. private _yAxis;
  111992. private _zAxis;
  111993. private _scaleLinesFactor;
  111994. private _instanced;
  111995. /**
  111996. * Gets the hosting scene
  111997. */
  111998. scene: Scene;
  111999. /**
  112000. * Gets or sets a number used to scale line length
  112001. */
  112002. scaleLines: number;
  112003. /** Gets the node hierarchy used to render x-axis */
  112004. readonly xAxis: TransformNode;
  112005. /** Gets the node hierarchy used to render y-axis */
  112006. readonly yAxis: TransformNode;
  112007. /** Gets the node hierarchy used to render z-axis */
  112008. readonly zAxis: TransformNode;
  112009. /**
  112010. * Creates a new AxesViewer
  112011. * @param scene defines the hosting scene
  112012. * @param scaleLines defines a number used to scale line length (1 by default)
  112013. * @param renderingGroupId defines a number used to set the renderingGroupId of the meshes (2 by default)
  112014. * @param xAxis defines the node hierarchy used to render the x-axis
  112015. * @param yAxis defines the node hierarchy used to render the y-axis
  112016. * @param zAxis defines the node hierarchy used to render the z-axis
  112017. */
  112018. constructor(scene: Scene, scaleLines?: number, renderingGroupId?: Nullable<number>, xAxis?: TransformNode, yAxis?: TransformNode, zAxis?: TransformNode);
  112019. /**
  112020. * Force the viewer to update
  112021. * @param position defines the position of the viewer
  112022. * @param xaxis defines the x axis of the viewer
  112023. * @param yaxis defines the y axis of the viewer
  112024. * @param zaxis defines the z axis of the viewer
  112025. */
  112026. update(position: Vector3, xaxis: Vector3, yaxis: Vector3, zaxis: Vector3): void;
  112027. /**
  112028. * Creates an instance of this axes viewer.
  112029. * @returns a new axes viewer with instanced meshes
  112030. */
  112031. createInstance(): AxesViewer;
  112032. /** Releases resources */
  112033. dispose(): void;
  112034. private static _SetRenderingGroupId;
  112035. }
  112036. }
  112037. declare module BABYLON.Debug {
  112038. /**
  112039. * The BoneAxesViewer will attach 3 axes to a specific bone of a specific mesh
  112040. * @see demo here: https://www.babylonjs-playground.com/#0DE8F4#8
  112041. */
  112042. export class BoneAxesViewer extends AxesViewer {
  112043. /**
  112044. * Gets or sets the target mesh where to display the axes viewer
  112045. */
  112046. mesh: Nullable<Mesh>;
  112047. /**
  112048. * Gets or sets the target bone where to display the axes viewer
  112049. */
  112050. bone: Nullable<Bone>;
  112051. /** Gets current position */
  112052. pos: Vector3;
  112053. /** Gets direction of X axis */
  112054. xaxis: Vector3;
  112055. /** Gets direction of Y axis */
  112056. yaxis: Vector3;
  112057. /** Gets direction of Z axis */
  112058. zaxis: Vector3;
  112059. /**
  112060. * Creates a new BoneAxesViewer
  112061. * @param scene defines the hosting scene
  112062. * @param bone defines the target bone
  112063. * @param mesh defines the target mesh
  112064. * @param scaleLines defines a scaling factor for line length (1 by default)
  112065. */
  112066. constructor(scene: Scene, bone: Bone, mesh: Mesh, scaleLines?: number);
  112067. /**
  112068. * Force the viewer to update
  112069. */
  112070. update(): void;
  112071. /** Releases resources */
  112072. dispose(): void;
  112073. }
  112074. }
  112075. declare module BABYLON {
  112076. /**
  112077. * Interface used to define scene explorer extensibility option
  112078. */
  112079. export interface IExplorerExtensibilityOption {
  112080. /**
  112081. * Define the option label
  112082. */
  112083. label: string;
  112084. /**
  112085. * Defines the action to execute on click
  112086. */
  112087. action: (entity: any) => void;
  112088. }
  112089. /**
  112090. * Defines a group of actions associated with a predicate to use when extending the Inspector scene explorer
  112091. */
  112092. export interface IExplorerExtensibilityGroup {
  112093. /**
  112094. * Defines a predicate to test if a given type mut be extended
  112095. */
  112096. predicate: (entity: any) => boolean;
  112097. /**
  112098. * Gets the list of options added to a type
  112099. */
  112100. entries: IExplorerExtensibilityOption[];
  112101. }
  112102. /**
  112103. * Interface used to define the options to use to create the Inspector
  112104. */
  112105. export interface IInspectorOptions {
  112106. /**
  112107. * Display in overlay mode (default: false)
  112108. */
  112109. overlay?: boolean;
  112110. /**
  112111. * HTML element to use as root (the parent of the rendering canvas will be used as default value)
  112112. */
  112113. globalRoot?: HTMLElement;
  112114. /**
  112115. * Display the Scene explorer
  112116. */
  112117. showExplorer?: boolean;
  112118. /**
  112119. * Display the property inspector
  112120. */
  112121. showInspector?: boolean;
  112122. /**
  112123. * Display in embed mode (both panes on the right)
  112124. */
  112125. embedMode?: boolean;
  112126. /**
  112127. * let the Inspector handles resize of the canvas when panes are resized (default to true)
  112128. */
  112129. handleResize?: boolean;
  112130. /**
  112131. * Allow the panes to popup (default: true)
  112132. */
  112133. enablePopup?: boolean;
  112134. /**
  112135. * Allow the panes to be closed by users (default: true)
  112136. */
  112137. enableClose?: boolean;
  112138. /**
  112139. * Optional list of extensibility entries
  112140. */
  112141. explorerExtensibility?: IExplorerExtensibilityGroup[];
  112142. /**
  112143. * Optional URL to get the inspector script from (by default it uses the babylonjs CDN).
  112144. */
  112145. inspectorURL?: string;
  112146. }
  112147. interface Scene {
  112148. /**
  112149. * @hidden
  112150. * Backing field
  112151. */
  112152. _debugLayer: DebugLayer;
  112153. /**
  112154. * Gets the debug layer (aka Inspector) associated with the scene
  112155. * @see http://doc.babylonjs.com/features/playground_debuglayer
  112156. */
  112157. debugLayer: DebugLayer;
  112158. }
  112159. /**
  112160. * The debug layer (aka Inspector) is the go to tool in order to better understand
  112161. * what is happening in your scene
  112162. * @see http://doc.babylonjs.com/features/playground_debuglayer
  112163. */
  112164. export class DebugLayer {
  112165. /**
  112166. * Define the url to get the inspector script from.
  112167. * By default it uses the babylonjs CDN.
  112168. * @ignoreNaming
  112169. */
  112170. static InspectorURL: string;
  112171. private _scene;
  112172. private BJSINSPECTOR;
  112173. private _onPropertyChangedObservable?;
  112174. /**
  112175. * Observable triggered when a property is changed through the inspector.
  112176. */
  112177. readonly onPropertyChangedObservable: any;
  112178. /**
  112179. * Instantiates a new debug layer.
  112180. * The debug layer (aka Inspector) is the go to tool in order to better understand
  112181. * what is happening in your scene
  112182. * @see http://doc.babylonjs.com/features/playground_debuglayer
  112183. * @param scene Defines the scene to inspect
  112184. */
  112185. constructor(scene: Scene);
  112186. /** Creates the inspector window. */
  112187. private _createInspector;
  112188. /**
  112189. * Select a specific entity in the scene explorer and highlight a specific block in that entity property grid
  112190. * @param entity defines the entity to select
  112191. * @param lineContainerTitle defines the specific block to highlight
  112192. */
  112193. select(entity: any, lineContainerTitle?: string): void;
  112194. /** Get the inspector from bundle or global */
  112195. private _getGlobalInspector;
  112196. /**
  112197. * Get if the inspector is visible or not.
  112198. * @returns true if visible otherwise, false
  112199. */
  112200. isVisible(): boolean;
  112201. /**
  112202. * Hide the inspector and close its window.
  112203. */
  112204. hide(): void;
  112205. /**
  112206. * Launch the debugLayer.
  112207. * @param config Define the configuration of the inspector
  112208. * @return a promise fulfilled when the debug layer is visible
  112209. */
  112210. show(config?: IInspectorOptions): Promise<DebugLayer>;
  112211. }
  112212. }
  112213. declare module BABYLON {
  112214. /**
  112215. * Class containing static functions to help procedurally build meshes
  112216. */
  112217. export class BoxBuilder {
  112218. /**
  112219. * Creates a box mesh
  112220. * * The parameter `size` sets the size (float) of each box side (default 1)
  112221. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  112222. * * 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)
  112223. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  112224. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  112225. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  112226. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  112227. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  112228. * @param name defines the name of the mesh
  112229. * @param options defines the options used to create the mesh
  112230. * @param scene defines the hosting scene
  112231. * @returns the box mesh
  112232. */
  112233. static CreateBox(name: string, options: {
  112234. size?: number;
  112235. width?: number;
  112236. height?: number;
  112237. depth?: number;
  112238. faceUV?: Vector4[];
  112239. faceColors?: Color4[];
  112240. sideOrientation?: number;
  112241. frontUVs?: Vector4;
  112242. backUVs?: Vector4;
  112243. wrap?: boolean;
  112244. topBaseAt?: number;
  112245. bottomBaseAt?: number;
  112246. updatable?: boolean;
  112247. }, scene?: Nullable<Scene>): Mesh;
  112248. }
  112249. }
  112250. declare module BABYLON {
  112251. /**
  112252. * Class containing static functions to help procedurally build meshes
  112253. */
  112254. export class SphereBuilder {
  112255. /**
  112256. * Creates a sphere mesh
  112257. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  112258. * * 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`)
  112259. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  112260. * * 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
  112261. * * 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)
  112262. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  112263. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  112264. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  112265. * @param name defines the name of the mesh
  112266. * @param options defines the options used to create the mesh
  112267. * @param scene defines the hosting scene
  112268. * @returns the sphere mesh
  112269. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  112270. */
  112271. static CreateSphere(name: string, options: {
  112272. segments?: number;
  112273. diameter?: number;
  112274. diameterX?: number;
  112275. diameterY?: number;
  112276. diameterZ?: number;
  112277. arc?: number;
  112278. slice?: number;
  112279. sideOrientation?: number;
  112280. frontUVs?: Vector4;
  112281. backUVs?: Vector4;
  112282. updatable?: boolean;
  112283. }, scene?: Nullable<Scene>): Mesh;
  112284. }
  112285. }
  112286. declare module BABYLON.Debug {
  112287. /**
  112288. * Used to show the physics impostor around the specific mesh
  112289. */
  112290. export class PhysicsViewer {
  112291. /** @hidden */
  112292. protected _impostors: Array<Nullable<PhysicsImpostor>>;
  112293. /** @hidden */
  112294. protected _meshes: Array<Nullable<AbstractMesh>>;
  112295. /** @hidden */
  112296. protected _scene: Nullable<Scene>;
  112297. /** @hidden */
  112298. protected _numMeshes: number;
  112299. /** @hidden */
  112300. protected _physicsEnginePlugin: Nullable<IPhysicsEnginePlugin>;
  112301. private _renderFunction;
  112302. private _utilityLayer;
  112303. private _debugBoxMesh;
  112304. private _debugSphereMesh;
  112305. private _debugCylinderMesh;
  112306. private _debugMaterial;
  112307. private _debugMeshMeshes;
  112308. /**
  112309. * Creates a new PhysicsViewer
  112310. * @param scene defines the hosting scene
  112311. */
  112312. constructor(scene: Scene);
  112313. /** @hidden */
  112314. protected _updateDebugMeshes(): void;
  112315. /**
  112316. * Renders a specified physic impostor
  112317. * @param impostor defines the impostor to render
  112318. * @param targetMesh defines the mesh represented by the impostor
  112319. * @returns the new debug mesh used to render the impostor
  112320. */
  112321. showImpostor(impostor: PhysicsImpostor, targetMesh?: Mesh): Nullable<AbstractMesh>;
  112322. /**
  112323. * Hides a specified physic impostor
  112324. * @param impostor defines the impostor to hide
  112325. */
  112326. hideImpostor(impostor: Nullable<PhysicsImpostor>): void;
  112327. private _getDebugMaterial;
  112328. private _getDebugBoxMesh;
  112329. private _getDebugSphereMesh;
  112330. private _getDebugCylinderMesh;
  112331. private _getDebugMeshMesh;
  112332. private _getDebugMesh;
  112333. /** Releases all resources */
  112334. dispose(): void;
  112335. }
  112336. }
  112337. declare module BABYLON {
  112338. /**
  112339. * Class containing static functions to help procedurally build meshes
  112340. */
  112341. export class LinesBuilder {
  112342. /**
  112343. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  112344. * * 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
  112345. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  112346. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  112347. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  112348. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  112349. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  112350. * * 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
  112351. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  112352. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  112353. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  112354. * @param name defines the name of the new line system
  112355. * @param options defines the options used to create the line system
  112356. * @param scene defines the hosting scene
  112357. * @returns a new line system mesh
  112358. */
  112359. static CreateLineSystem(name: string, options: {
  112360. lines: Vector3[][];
  112361. updatable?: boolean;
  112362. instance?: Nullable<LinesMesh>;
  112363. colors?: Nullable<Color4[][]>;
  112364. useVertexAlpha?: boolean;
  112365. }, scene: Nullable<Scene>): LinesMesh;
  112366. /**
  112367. * Creates a line mesh
  112368. * 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
  112369. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  112370. * * The parameter `points` is an array successive Vector3
  112371. * * 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
  112372. * * The optional parameter `colors` is an array of successive Color4, one per line point
  112373. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  112374. * * When updating an instance, remember that only point positions can change, not the number of points
  112375. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  112376. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  112377. * @param name defines the name of the new line system
  112378. * @param options defines the options used to create the line system
  112379. * @param scene defines the hosting scene
  112380. * @returns a new line mesh
  112381. */
  112382. static CreateLines(name: string, options: {
  112383. points: Vector3[];
  112384. updatable?: boolean;
  112385. instance?: Nullable<LinesMesh>;
  112386. colors?: Color4[];
  112387. useVertexAlpha?: boolean;
  112388. }, scene?: Nullable<Scene>): LinesMesh;
  112389. /**
  112390. * Creates a dashed line mesh
  112391. * * 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
  112392. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  112393. * * The parameter `points` is an array successive Vector3
  112394. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  112395. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  112396. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  112397. * * 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
  112398. * * When updating an instance, remember that only point positions can change, not the number of points
  112399. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  112400. * @param name defines the name of the mesh
  112401. * @param options defines the options used to create the mesh
  112402. * @param scene defines the hosting scene
  112403. * @returns the dashed line mesh
  112404. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  112405. */
  112406. static CreateDashedLines(name: string, options: {
  112407. points: Vector3[];
  112408. dashSize?: number;
  112409. gapSize?: number;
  112410. dashNb?: number;
  112411. updatable?: boolean;
  112412. instance?: LinesMesh;
  112413. }, scene?: Nullable<Scene>): LinesMesh;
  112414. }
  112415. }
  112416. declare module BABYLON {
  112417. /**
  112418. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  112419. * in order to better appreciate the issue one might have.
  112420. * @see http://doc.babylonjs.com/babylon101/raycasts#debugging
  112421. */
  112422. export class RayHelper {
  112423. /**
  112424. * Defines the ray we are currently tryin to visualize.
  112425. */
  112426. ray: Nullable<Ray>;
  112427. private _renderPoints;
  112428. private _renderLine;
  112429. private _renderFunction;
  112430. private _scene;
  112431. private _updateToMeshFunction;
  112432. private _attachedToMesh;
  112433. private _meshSpaceDirection;
  112434. private _meshSpaceOrigin;
  112435. /**
  112436. * Helper function to create a colored helper in a scene in one line.
  112437. * @param ray Defines the ray we are currently tryin to visualize
  112438. * @param scene Defines the scene the ray is used in
  112439. * @param color Defines the color we want to see the ray in
  112440. * @returns The newly created ray helper.
  112441. */
  112442. static CreateAndShow(ray: Ray, scene: Scene, color: Color3): RayHelper;
  112443. /**
  112444. * Instantiate a new ray helper.
  112445. * As raycast might be hard to debug, the RayHelper can help rendering the different rays
  112446. * in order to better appreciate the issue one might have.
  112447. * @see http://doc.babylonjs.com/babylon101/raycasts#debugging
  112448. * @param ray Defines the ray we are currently tryin to visualize
  112449. */
  112450. constructor(ray: Ray);
  112451. /**
  112452. * Shows the ray we are willing to debug.
  112453. * @param scene Defines the scene the ray needs to be rendered in
  112454. * @param color Defines the color the ray needs to be rendered in
  112455. */
  112456. show(scene: Scene, color?: Color3): void;
  112457. /**
  112458. * Hides the ray we are debugging.
  112459. */
  112460. hide(): void;
  112461. private _render;
  112462. /**
  112463. * Attach a ray helper to a mesh so that we can easily see its orientation for instance or information like its normals.
  112464. * @param mesh Defines the mesh we want the helper attached to
  112465. * @param meshSpaceDirection Defines the direction of the Ray in mesh space (local space of the mesh node)
  112466. * @param meshSpaceOrigin Defines the origin of the Ray in mesh space (local space of the mesh node)
  112467. * @param length Defines the length of the ray
  112468. */
  112469. attachToMesh(mesh: AbstractMesh, meshSpaceDirection?: Vector3, meshSpaceOrigin?: Vector3, length?: number): void;
  112470. /**
  112471. * Detach the ray helper from the mesh it has previously been attached to.
  112472. */
  112473. detachFromMesh(): void;
  112474. private _updateToMesh;
  112475. /**
  112476. * Dispose the helper and release its associated resources.
  112477. */
  112478. dispose(): void;
  112479. }
  112480. }
  112481. declare module BABYLON.Debug {
  112482. /**
  112483. * Class used to render a debug view of a given skeleton
  112484. * @see http://www.babylonjs-playground.com/#1BZJVJ#8
  112485. */
  112486. export class SkeletonViewer {
  112487. /** defines the skeleton to render */
  112488. skeleton: Skeleton;
  112489. /** defines the mesh attached to the skeleton */
  112490. mesh: AbstractMesh;
  112491. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  112492. autoUpdateBonesMatrices: boolean;
  112493. /** defines the rendering group id to use with the viewer */
  112494. renderingGroupId: number;
  112495. /** Gets or sets the color used to render the skeleton */
  112496. color: Color3;
  112497. private _scene;
  112498. private _debugLines;
  112499. private _debugMesh;
  112500. private _isEnabled;
  112501. private _renderFunction;
  112502. private _utilityLayer;
  112503. /**
  112504. * Returns the mesh used to render the bones
  112505. */
  112506. readonly debugMesh: Nullable<LinesMesh>;
  112507. /**
  112508. * Creates a new SkeletonViewer
  112509. * @param skeleton defines the skeleton to render
  112510. * @param mesh defines the mesh attached to the skeleton
  112511. * @param scene defines the hosting scene
  112512. * @param autoUpdateBonesMatrices defines a boolean indicating if bones matrices must be forced to update before rendering (true by default)
  112513. * @param renderingGroupId defines the rendering group id to use with the viewer
  112514. */
  112515. constructor(
  112516. /** defines the skeleton to render */
  112517. skeleton: Skeleton,
  112518. /** defines the mesh attached to the skeleton */
  112519. mesh: AbstractMesh, scene: Scene,
  112520. /** defines a boolean indicating if bones matrices must be forced to update before rendering (true by default) */
  112521. autoUpdateBonesMatrices?: boolean,
  112522. /** defines the rendering group id to use with the viewer */
  112523. renderingGroupId?: number);
  112524. /** Gets or sets a boolean indicating if the viewer is enabled */
  112525. isEnabled: boolean;
  112526. private _getBonePosition;
  112527. private _getLinesForBonesWithLength;
  112528. private _getLinesForBonesNoLength;
  112529. /** Update the viewer to sync with current skeleton state */
  112530. update(): void;
  112531. /** Release associated resources */
  112532. dispose(): void;
  112533. }
  112534. }
  112535. declare module BABYLON {
  112536. /**
  112537. * Options to create the null engine
  112538. */
  112539. export class NullEngineOptions {
  112540. /**
  112541. * Render width (Default: 512)
  112542. */
  112543. renderWidth: number;
  112544. /**
  112545. * Render height (Default: 256)
  112546. */
  112547. renderHeight: number;
  112548. /**
  112549. * Texture size (Default: 512)
  112550. */
  112551. textureSize: number;
  112552. /**
  112553. * If delta time between frames should be constant
  112554. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  112555. */
  112556. deterministicLockstep: boolean;
  112557. /**
  112558. * Maximum about of steps between frames (Default: 4)
  112559. * @see https://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  112560. */
  112561. lockstepMaxSteps: number;
  112562. }
  112563. /**
  112564. * The null engine class provides support for headless version of babylon.js.
  112565. * This can be used in server side scenario or for testing purposes
  112566. */
  112567. export class NullEngine extends Engine {
  112568. private _options;
  112569. /**
  112570. * Gets a boolean indicating that the engine is running in deterministic lock step mode
  112571. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  112572. * @returns true if engine is in deterministic lock step mode
  112573. */
  112574. isDeterministicLockStep(): boolean;
  112575. /**
  112576. * Gets the max steps when engine is running in deterministic lock step
  112577. * @see http://doc.babylonjs.com/babylon101/animations#deterministic-lockstep
  112578. * @returns the max steps
  112579. */
  112580. getLockstepMaxSteps(): number;
  112581. /**
  112582. * Gets the current hardware scaling level.
  112583. * By default the hardware scaling level is computed from the window device ratio.
  112584. * 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.
  112585. * @returns a number indicating the current hardware scaling level
  112586. */
  112587. getHardwareScalingLevel(): number;
  112588. constructor(options?: NullEngineOptions);
  112589. /**
  112590. * Creates a vertex buffer
  112591. * @param vertices the data for the vertex buffer
  112592. * @returns the new WebGL static buffer
  112593. */
  112594. createVertexBuffer(vertices: FloatArray): DataBuffer;
  112595. /**
  112596. * Creates a new index buffer
  112597. * @param indices defines the content of the index buffer
  112598. * @param updatable defines if the index buffer must be updatable
  112599. * @returns a new webGL buffer
  112600. */
  112601. createIndexBuffer(indices: IndicesArray): DataBuffer;
  112602. /**
  112603. * Clear the current render buffer or the current render target (if any is set up)
  112604. * @param color defines the color to use
  112605. * @param backBuffer defines if the back buffer must be cleared
  112606. * @param depth defines if the depth buffer must be cleared
  112607. * @param stencil defines if the stencil buffer must be cleared
  112608. */
  112609. clear(color: IColor4Like, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  112610. /**
  112611. * Gets the current render width
  112612. * @param useScreen defines if screen size must be used (or the current render target if any)
  112613. * @returns a number defining the current render width
  112614. */
  112615. getRenderWidth(useScreen?: boolean): number;
  112616. /**
  112617. * Gets the current render height
  112618. * @param useScreen defines if screen size must be used (or the current render target if any)
  112619. * @returns a number defining the current render height
  112620. */
  112621. getRenderHeight(useScreen?: boolean): number;
  112622. /**
  112623. * Set the WebGL's viewport
  112624. * @param viewport defines the viewport element to be used
  112625. * @param requiredWidth defines the width required for rendering. If not provided the rendering canvas' width is used
  112626. * @param requiredHeight defines the height required for rendering. If not provided the rendering canvas' height is used
  112627. */
  112628. setViewport(viewport: IViewportLike, requiredWidth?: number, requiredHeight?: number): void;
  112629. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: string, context?: WebGLRenderingContext): WebGLProgram;
  112630. /**
  112631. * Gets the list of webGL uniform locations associated with a specific program based on a list of uniform names
  112632. * @param pipelineContext defines the pipeline context to use
  112633. * @param uniformsNames defines the list of uniform names
  112634. * @returns an array of webGL uniform locations
  112635. */
  112636. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): Nullable<WebGLUniformLocation>[];
  112637. /**
  112638. * Gets the lsit of active attributes for a given webGL program
  112639. * @param pipelineContext defines the pipeline context to use
  112640. * @param attributesNames defines the list of attribute names to get
  112641. * @returns an array of indices indicating the offset of each attribute
  112642. */
  112643. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  112644. /**
  112645. * Binds an effect to the webGL context
  112646. * @param effect defines the effect to bind
  112647. */
  112648. bindSamplers(effect: Effect): void;
  112649. /**
  112650. * Activates an effect, mkaing it the current one (ie. the one used for rendering)
  112651. * @param effect defines the effect to activate
  112652. */
  112653. enableEffect(effect: Effect): void;
  112654. /**
  112655. * Set various states to the webGL context
  112656. * @param culling defines backface culling state
  112657. * @param zOffset defines the value to apply to zOffset (0 by default)
  112658. * @param force defines if states must be applied even if cache is up to date
  112659. * @param reverseSide defines if culling must be reversed (CCW instead of CW and CW instead of CCW)
  112660. */
  112661. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  112662. /**
  112663. * Set the value of an uniform to an array of int32
  112664. * @param uniform defines the webGL uniform location where to store the value
  112665. * @param array defines the array of int32 to store
  112666. */
  112667. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  112668. /**
  112669. * Set the value of an uniform to an array of int32 (stored as vec2)
  112670. * @param uniform defines the webGL uniform location where to store the value
  112671. * @param array defines the array of int32 to store
  112672. */
  112673. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  112674. /**
  112675. * Set the value of an uniform to an array of int32 (stored as vec3)
  112676. * @param uniform defines the webGL uniform location where to store the value
  112677. * @param array defines the array of int32 to store
  112678. */
  112679. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  112680. /**
  112681. * Set the value of an uniform to an array of int32 (stored as vec4)
  112682. * @param uniform defines the webGL uniform location where to store the value
  112683. * @param array defines the array of int32 to store
  112684. */
  112685. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  112686. /**
  112687. * Set the value of an uniform to an array of float32
  112688. * @param uniform defines the webGL uniform location where to store the value
  112689. * @param array defines the array of float32 to store
  112690. */
  112691. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  112692. /**
  112693. * Set the value of an uniform to an array of float32 (stored as vec2)
  112694. * @param uniform defines the webGL uniform location where to store the value
  112695. * @param array defines the array of float32 to store
  112696. */
  112697. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  112698. /**
  112699. * Set the value of an uniform to an array of float32 (stored as vec3)
  112700. * @param uniform defines the webGL uniform location where to store the value
  112701. * @param array defines the array of float32 to store
  112702. */
  112703. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  112704. /**
  112705. * Set the value of an uniform to an array of float32 (stored as vec4)
  112706. * @param uniform defines the webGL uniform location where to store the value
  112707. * @param array defines the array of float32 to store
  112708. */
  112709. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  112710. /**
  112711. * Set the value of an uniform to an array of number
  112712. * @param uniform defines the webGL uniform location where to store the value
  112713. * @param array defines the array of number to store
  112714. */
  112715. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  112716. /**
  112717. * Set the value of an uniform to an array of number (stored as vec2)
  112718. * @param uniform defines the webGL uniform location where to store the value
  112719. * @param array defines the array of number to store
  112720. */
  112721. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  112722. /**
  112723. * Set the value of an uniform to an array of number (stored as vec3)
  112724. * @param uniform defines the webGL uniform location where to store the value
  112725. * @param array defines the array of number to store
  112726. */
  112727. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  112728. /**
  112729. * Set the value of an uniform to an array of number (stored as vec4)
  112730. * @param uniform defines the webGL uniform location where to store the value
  112731. * @param array defines the array of number to store
  112732. */
  112733. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  112734. /**
  112735. * Set the value of an uniform to an array of float32 (stored as matrices)
  112736. * @param uniform defines the webGL uniform location where to store the value
  112737. * @param matrices defines the array of float32 to store
  112738. */
  112739. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  112740. /**
  112741. * Set the value of an uniform to a matrix (3x3)
  112742. * @param uniform defines the webGL uniform location where to store the value
  112743. * @param matrix defines the Float32Array representing the 3x3 matrix to store
  112744. */
  112745. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  112746. /**
  112747. * Set the value of an uniform to a matrix (2x2)
  112748. * @param uniform defines the webGL uniform location where to store the value
  112749. * @param matrix defines the Float32Array representing the 2x2 matrix to store
  112750. */
  112751. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  112752. /**
  112753. * Set the value of an uniform to a number (float)
  112754. * @param uniform defines the webGL uniform location where to store the value
  112755. * @param value defines the float number to store
  112756. */
  112757. setFloat(uniform: WebGLUniformLocation, value: number): void;
  112758. /**
  112759. * Set the value of an uniform to a vec2
  112760. * @param uniform defines the webGL uniform location where to store the value
  112761. * @param x defines the 1st component of the value
  112762. * @param y defines the 2nd component of the value
  112763. */
  112764. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  112765. /**
  112766. * Set the value of an uniform to a vec3
  112767. * @param uniform defines the webGL uniform location where to store the value
  112768. * @param x defines the 1st component of the value
  112769. * @param y defines the 2nd component of the value
  112770. * @param z defines the 3rd component of the value
  112771. */
  112772. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  112773. /**
  112774. * Set the value of an uniform to a boolean
  112775. * @param uniform defines the webGL uniform location where to store the value
  112776. * @param bool defines the boolean to store
  112777. */
  112778. setBool(uniform: WebGLUniformLocation, bool: number): void;
  112779. /**
  112780. * Set the value of an uniform to a vec4
  112781. * @param uniform defines the webGL uniform location where to store the value
  112782. * @param x defines the 1st component of the value
  112783. * @param y defines the 2nd component of the value
  112784. * @param z defines the 3rd component of the value
  112785. * @param w defines the 4th component of the value
  112786. */
  112787. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  112788. /**
  112789. * Sets the current alpha mode
  112790. * @param mode defines the mode to use (one of the Engine.ALPHA_XXX)
  112791. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  112792. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  112793. */
  112794. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  112795. /**
  112796. * Bind webGl buffers directly to the webGL context
  112797. * @param vertexBuffers defines the vertex buffer to bind
  112798. * @param indexBuffer defines the index buffer to bind
  112799. * @param vertexDeclaration defines the vertex declaration to use with the vertex buffer
  112800. * @param vertexStrideSize defines the vertex stride of the vertex buffer
  112801. * @param effect defines the effect associated with the vertex buffer
  112802. */
  112803. bindBuffers(vertexBuffers: {
  112804. [key: string]: VertexBuffer;
  112805. }, indexBuffer: DataBuffer, effect: Effect): void;
  112806. /**
  112807. * Force the entire cache to be cleared
  112808. * You should not have to use this function unless your engine needs to share the webGL context with another engine
  112809. * @param bruteForce defines a boolean to force clearing ALL caches (including stencil, detoh and alpha states)
  112810. */
  112811. wipeCaches(bruteForce?: boolean): void;
  112812. /**
  112813. * Send a draw order
  112814. * @param useTriangles defines if triangles must be used to draw (else wireframe will be used)
  112815. * @param indexStart defines the starting index
  112816. * @param indexCount defines the number of index to draw
  112817. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  112818. */
  112819. draw(useTriangles: boolean, indexStart: number, indexCount: number, instancesCount?: number): void;
  112820. /**
  112821. * Draw a list of indexed primitives
  112822. * @param fillMode defines the primitive to use
  112823. * @param indexStart defines the starting index
  112824. * @param indexCount defines the number of index to draw
  112825. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  112826. */
  112827. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  112828. /**
  112829. * Draw a list of unindexed primitives
  112830. * @param fillMode defines the primitive to use
  112831. * @param verticesStart defines the index of first vertex to draw
  112832. * @param verticesCount defines the count of vertices to draw
  112833. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  112834. */
  112835. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  112836. /** @hidden */
  112837. _createTexture(): WebGLTexture;
  112838. /** @hidden */
  112839. _releaseTexture(texture: InternalTexture): void;
  112840. /**
  112841. * Usually called from Texture.ts.
  112842. * Passed information to create a WebGLTexture
  112843. * @param urlArg defines a value which contains one of the following:
  112844. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  112845. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  112846. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  112847. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  112848. * @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)
  112849. * @param scene needed for loading to the correct scene
  112850. * @param samplingMode mode with should be used sample / access the texture (Default: Texture.TRILINEAR_SAMPLINGMODE)
  112851. * @param onLoad optional callback to be called upon successful completion
  112852. * @param onError optional callback to be called upon failure
  112853. * @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
  112854. * @param fallBack an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  112855. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  112856. * @param forcedExtension defines the extension to use to pick the right loader
  112857. * @param excludeLoaders array of texture loaders that should be excluded when picking a loader for the texture (default: empty array)
  112858. * @returns a InternalTexture for assignment back into BABYLON.Texture
  112859. */
  112860. 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;
  112861. /**
  112862. * Creates a new render target texture
  112863. * @param size defines the size of the texture
  112864. * @param options defines the options used to create the texture
  112865. * @returns a new render target texture stored in an InternalTexture
  112866. */
  112867. createRenderTargetTexture(size: any, options: boolean | RenderTargetCreationOptions): InternalTexture;
  112868. /**
  112869. * Update the sampling mode of a given texture
  112870. * @param samplingMode defines the required sampling mode
  112871. * @param texture defines the texture to update
  112872. */
  112873. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  112874. /**
  112875. * Binds the frame buffer to the specified texture.
  112876. * @param texture The texture to render to or null for the default canvas
  112877. * @param faceIndex The face of the texture to render to in case of cube texture
  112878. * @param requiredWidth The width of the target to render to
  112879. * @param requiredHeight The height of the target to render to
  112880. * @param forceFullscreenViewport Forces the viewport to be the entire texture/screen if true
  112881. * @param depthStencilTexture The depth stencil texture to use to render
  112882. * @param lodLevel defines le lod level to bind to the frame buffer
  112883. */
  112884. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  112885. /**
  112886. * Unbind the current render target texture from the webGL context
  112887. * @param texture defines the render target texture to unbind
  112888. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  112889. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  112890. */
  112891. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  112892. /**
  112893. * Creates a dynamic vertex buffer
  112894. * @param vertices the data for the dynamic vertex buffer
  112895. * @returns the new WebGL dynamic buffer
  112896. */
  112897. createDynamicVertexBuffer(vertices: FloatArray): DataBuffer;
  112898. /**
  112899. * Update the content of a dynamic texture
  112900. * @param texture defines the texture to update
  112901. * @param canvas defines the canvas containing the source
  112902. * @param invertY defines if data must be stored with Y axis inverted
  112903. * @param premulAlpha defines if alpha is stored as premultiplied
  112904. * @param format defines the format of the data
  112905. * @param forceBindTexture if the texture should be forced to be bound eg. after a graphics context loss (Default: false)
  112906. */
  112907. updateDynamicTexture(texture: Nullable<InternalTexture>, canvas: HTMLCanvasElement, invertY: boolean, premulAlpha?: boolean, format?: number): void;
  112908. /**
  112909. * Gets a boolean indicating if all created effects are ready
  112910. * @returns true if all effects are ready
  112911. */
  112912. areAllEffectsReady(): boolean;
  112913. /**
  112914. * @hidden
  112915. * Get the current error code of the webGL context
  112916. * @returns the error code
  112917. * @see https://developer.mozilla.org/en-US/docs/Web/API/WebGLRenderingContext/getError
  112918. */
  112919. getError(): number;
  112920. /** @hidden */
  112921. _getUnpackAlignement(): number;
  112922. /** @hidden */
  112923. _unpackFlipY(value: boolean): void;
  112924. /**
  112925. * Update a dynamic index buffer
  112926. * @param indexBuffer defines the target index buffer
  112927. * @param indices defines the data to update
  112928. * @param offset defines the offset in the target index buffer where update should start
  112929. */
  112930. updateDynamicIndexBuffer(indexBuffer: WebGLBuffer, indices: IndicesArray, offset?: number): void;
  112931. /**
  112932. * Updates a dynamic vertex buffer.
  112933. * @param vertexBuffer the vertex buffer to update
  112934. * @param vertices the data used to update the vertex buffer
  112935. * @param byteOffset the byte offset of the data (optional)
  112936. * @param byteLength the byte length of the data (optional)
  112937. */
  112938. updateDynamicVertexBuffer(vertexBuffer: WebGLBuffer, vertices: FloatArray, byteOffset?: number, byteLength?: number): void;
  112939. /** @hidden */
  112940. _bindTextureDirectly(target: number, texture: InternalTexture): boolean;
  112941. /** @hidden */
  112942. _bindTexture(channel: number, texture: InternalTexture): void;
  112943. protected _deleteBuffer(buffer: WebGLBuffer): void;
  112944. /**
  112945. * 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
  112946. */
  112947. releaseEffects(): void;
  112948. displayLoadingUI(): void;
  112949. hideLoadingUI(): void;
  112950. /** @hidden */
  112951. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  112952. /** @hidden */
  112953. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  112954. /** @hidden */
  112955. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  112956. /** @hidden */
  112957. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  112958. }
  112959. }
  112960. declare module BABYLON {
  112961. /** @hidden */
  112962. export class _OcclusionDataStorage {
  112963. /** @hidden */
  112964. occlusionInternalRetryCounter: number;
  112965. /** @hidden */
  112966. isOcclusionQueryInProgress: boolean;
  112967. /** @hidden */
  112968. isOccluded: boolean;
  112969. /** @hidden */
  112970. occlusionRetryCount: number;
  112971. /** @hidden */
  112972. occlusionType: number;
  112973. /** @hidden */
  112974. occlusionQueryAlgorithmType: number;
  112975. }
  112976. interface Engine {
  112977. /**
  112978. * Create a new webGL query (you must be sure that queries are supported by checking getCaps() function)
  112979. * @return the new query
  112980. */
  112981. createQuery(): WebGLQuery;
  112982. /**
  112983. * Delete and release a webGL query
  112984. * @param query defines the query to delete
  112985. * @return the current engine
  112986. */
  112987. deleteQuery(query: WebGLQuery): Engine;
  112988. /**
  112989. * Check if a given query has resolved and got its value
  112990. * @param query defines the query to check
  112991. * @returns true if the query got its value
  112992. */
  112993. isQueryResultAvailable(query: WebGLQuery): boolean;
  112994. /**
  112995. * Gets the value of a given query
  112996. * @param query defines the query to check
  112997. * @returns the value of the query
  112998. */
  112999. getQueryResult(query: WebGLQuery): number;
  113000. /**
  113001. * Initiates an occlusion query
  113002. * @param algorithmType defines the algorithm to use
  113003. * @param query defines the query to use
  113004. * @returns the current engine
  113005. * @see http://doc.babylonjs.com/features/occlusionquery
  113006. */
  113007. beginOcclusionQuery(algorithmType: number, query: WebGLQuery): Engine;
  113008. /**
  113009. * Ends an occlusion query
  113010. * @see http://doc.babylonjs.com/features/occlusionquery
  113011. * @param algorithmType defines the algorithm to use
  113012. * @returns the current engine
  113013. */
  113014. endOcclusionQuery(algorithmType: number): Engine;
  113015. /**
  113016. * Starts a time query (used to measure time spent by the GPU on a specific frame)
  113017. * Please note that only one query can be issued at a time
  113018. * @returns a time token used to track the time span
  113019. */
  113020. startTimeQuery(): Nullable<_TimeToken>;
  113021. /**
  113022. * Ends a time query
  113023. * @param token defines the token used to measure the time span
  113024. * @returns the time spent (in ns)
  113025. */
  113026. endTimeQuery(token: _TimeToken): int;
  113027. /** @hidden */
  113028. _currentNonTimestampToken: Nullable<_TimeToken>;
  113029. /** @hidden */
  113030. _createTimeQuery(): WebGLQuery;
  113031. /** @hidden */
  113032. _deleteTimeQuery(query: WebGLQuery): void;
  113033. /** @hidden */
  113034. _getGlAlgorithmType(algorithmType: number): number;
  113035. /** @hidden */
  113036. _getTimeQueryResult(query: WebGLQuery): any;
  113037. /** @hidden */
  113038. _getTimeQueryAvailability(query: WebGLQuery): any;
  113039. }
  113040. interface AbstractMesh {
  113041. /**
  113042. * Backing filed
  113043. * @hidden
  113044. */
  113045. __occlusionDataStorage: _OcclusionDataStorage;
  113046. /**
  113047. * Access property
  113048. * @hidden
  113049. */
  113050. _occlusionDataStorage: _OcclusionDataStorage;
  113051. /**
  113052. * 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.
  113053. * The default value is -1 which means don't break the query and wait till the result
  113054. * @see http://doc.babylonjs.com/features/occlusionquery
  113055. */
  113056. occlusionRetryCount: number;
  113057. /**
  113058. * 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:
  113059. * * OCCLUSION_TYPE_NONE (Default Value): this option means no occlusion query whith the Mesh.
  113060. * * OCCLUSION_TYPE_OPTIMISTIC: this option is means use occlusion query and if occlusionRetryCount is reached and the query is broken show the mesh.
  113061. * * 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.
  113062. * @see http://doc.babylonjs.com/features/occlusionquery
  113063. */
  113064. occlusionType: number;
  113065. /**
  113066. * This property determines the type of occlusion query algorithm to run in WebGl, you can use:
  113067. * * AbstractMesh.OCCLUSION_ALGORITHM_TYPE_ACCURATE which is mapped to GL_ANY_SAMPLES_PASSED.
  113068. * * 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.
  113069. * @see http://doc.babylonjs.com/features/occlusionquery
  113070. */
  113071. occlusionQueryAlgorithmType: number;
  113072. /**
  113073. * 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
  113074. * @see http://doc.babylonjs.com/features/occlusionquery
  113075. */
  113076. isOccluded: boolean;
  113077. /**
  113078. * Flag to check the progress status of the query
  113079. * @see http://doc.babylonjs.com/features/occlusionquery
  113080. */
  113081. isOcclusionQueryInProgress: boolean;
  113082. }
  113083. }
  113084. declare module BABYLON {
  113085. /** @hidden */
  113086. export var _forceTransformFeedbackToBundle: boolean;
  113087. interface Engine {
  113088. /**
  113089. * Creates a webGL transform feedback object
  113090. * Please makes sure to check webGLVersion property to check if you are running webGL 2+
  113091. * @returns the webGL transform feedback object
  113092. */
  113093. createTransformFeedback(): WebGLTransformFeedback;
  113094. /**
  113095. * Delete a webGL transform feedback object
  113096. * @param value defines the webGL transform feedback object to delete
  113097. */
  113098. deleteTransformFeedback(value: WebGLTransformFeedback): void;
  113099. /**
  113100. * Bind a webGL transform feedback object to the webgl context
  113101. * @param value defines the webGL transform feedback object to bind
  113102. */
  113103. bindTransformFeedback(value: Nullable<WebGLTransformFeedback>): void;
  113104. /**
  113105. * Begins a transform feedback operation
  113106. * @param usePoints defines if points or triangles must be used
  113107. */
  113108. beginTransformFeedback(usePoints: boolean): void;
  113109. /**
  113110. * Ends a transform feedback operation
  113111. */
  113112. endTransformFeedback(): void;
  113113. /**
  113114. * Specify the varyings to use with transform feedback
  113115. * @param program defines the associated webGL program
  113116. * @param value defines the list of strings representing the varying names
  113117. */
  113118. setTranformFeedbackVaryings(program: WebGLProgram, value: string[]): void;
  113119. /**
  113120. * Bind a webGL buffer for a transform feedback operation
  113121. * @param value defines the webGL buffer to bind
  113122. */
  113123. bindTransformFeedbackBuffer(value: Nullable<DataBuffer>): void;
  113124. }
  113125. }
  113126. declare module BABYLON {
  113127. /**
  113128. * Creation options of the multi render target texture.
  113129. */
  113130. export interface IMultiRenderTargetOptions {
  113131. /**
  113132. * Define if the texture needs to create mip maps after render.
  113133. */
  113134. generateMipMaps?: boolean;
  113135. /**
  113136. * Define the types of all the draw buffers we want to create
  113137. */
  113138. types?: number[];
  113139. /**
  113140. * Define the sampling modes of all the draw buffers we want to create
  113141. */
  113142. samplingModes?: number[];
  113143. /**
  113144. * Define if a depth buffer is required
  113145. */
  113146. generateDepthBuffer?: boolean;
  113147. /**
  113148. * Define if a stencil buffer is required
  113149. */
  113150. generateStencilBuffer?: boolean;
  113151. /**
  113152. * Define if a depth texture is required instead of a depth buffer
  113153. */
  113154. generateDepthTexture?: boolean;
  113155. /**
  113156. * Define the number of desired draw buffers
  113157. */
  113158. textureCount?: number;
  113159. /**
  113160. * Define if aspect ratio should be adapted to the texture or stay the scene one
  113161. */
  113162. doNotChangeAspectRatio?: boolean;
  113163. /**
  113164. * Define the default type of the buffers we are creating
  113165. */
  113166. defaultType?: number;
  113167. }
  113168. /**
  113169. * A multi render target, like a render target provides the ability to render to a texture.
  113170. * Unlike the render target, it can render to several draw buffers in one draw.
  113171. * This is specially interesting in deferred rendering or for any effects requiring more than
  113172. * just one color from a single pass.
  113173. */
  113174. export class MultiRenderTarget extends RenderTargetTexture {
  113175. private _internalTextures;
  113176. private _textures;
  113177. private _multiRenderTargetOptions;
  113178. /**
  113179. * Get if draw buffers are currently supported by the used hardware and browser.
  113180. */
  113181. readonly isSupported: boolean;
  113182. /**
  113183. * Get the list of textures generated by the multi render target.
  113184. */
  113185. readonly textures: Texture[];
  113186. /**
  113187. * Get the depth texture generated by the multi render target if options.generateDepthTexture has been set
  113188. */
  113189. readonly depthTexture: Texture;
  113190. /**
  113191. * Set the wrapping mode on U of all the textures we are rendering to.
  113192. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  113193. */
  113194. wrapU: number;
  113195. /**
  113196. * Set the wrapping mode on V of all the textures we are rendering to.
  113197. * Can be any of the Texture. (CLAMP_ADDRESSMODE, MIRROR_ADDRESSMODE or WRAP_ADDRESSMODE)
  113198. */
  113199. wrapV: number;
  113200. /**
  113201. * Instantiate a new multi render target texture.
  113202. * A multi render target, like a render target provides the ability to render to a texture.
  113203. * Unlike the render target, it can render to several draw buffers in one draw.
  113204. * This is specially interesting in deferred rendering or for any effects requiring more than
  113205. * just one color from a single pass.
  113206. * @param name Define the name of the texture
  113207. * @param size Define the size of the buffers to render to
  113208. * @param count Define the number of target we are rendering into
  113209. * @param scene Define the scene the texture belongs to
  113210. * @param options Define the options used to create the multi render target
  113211. */
  113212. constructor(name: string, size: any, count: number, scene: Scene, options?: IMultiRenderTargetOptions);
  113213. /** @hidden */
  113214. _rebuild(): void;
  113215. private _createInternalTextures;
  113216. private _createTextures;
  113217. /**
  113218. * Define the number of samples used if MSAA is enabled.
  113219. */
  113220. samples: number;
  113221. /**
  113222. * Resize all the textures in the multi render target.
  113223. * Be carrefull as it will recreate all the data in the new texture.
  113224. * @param size Define the new size
  113225. */
  113226. resize(size: any): void;
  113227. protected unbindFrameBuffer(engine: Engine, faceIndex: number): void;
  113228. /**
  113229. * Dispose the render targets and their associated resources
  113230. */
  113231. dispose(): void;
  113232. /**
  113233. * Release all the underlying texture used as draw buffers.
  113234. */
  113235. releaseInternalTextures(): void;
  113236. }
  113237. }
  113238. declare module BABYLON {
  113239. interface ThinEngine {
  113240. /**
  113241. * Unbind a list of render target textures from the webGL context
  113242. * This is used only when drawBuffer extension or webGL2 are active
  113243. * @param textures defines the render target textures to unbind
  113244. * @param disableGenerateMipMaps defines a boolean indicating that mipmaps must not be generated
  113245. * @param onBeforeUnbind defines a function which will be called before the effective unbind
  113246. */
  113247. unBindMultiColorAttachmentFramebuffer(textures: InternalTexture[], disableGenerateMipMaps: boolean, onBeforeUnbind?: () => void): void;
  113248. /**
  113249. * Create a multi render target texture
  113250. * @see http://doc.babylonjs.com/features/webgl2#multiple-render-target
  113251. * @param size defines the size of the texture
  113252. * @param options defines the creation options
  113253. * @returns the cube texture as an InternalTexture
  113254. */
  113255. createMultipleRenderTarget(size: any, options: IMultiRenderTargetOptions): InternalTexture[];
  113256. /**
  113257. * Update the sample count for a given multiple render target texture
  113258. * @see http://doc.babylonjs.com/features/webgl2#multisample-render-targets
  113259. * @param textures defines the textures to update
  113260. * @param samples defines the sample count to set
  113261. * @returns the effective sample count (could be 0 if multisample render targets are not supported)
  113262. */
  113263. updateMultipleRenderTargetTextureSampleCount(textures: Nullable<InternalTexture[]>, samples: number): number;
  113264. }
  113265. }
  113266. declare module BABYLON {
  113267. /**
  113268. * Class used to define an additional view for the engine
  113269. * @see https://doc.babylonjs.com/how_to/multi_canvases
  113270. */
  113271. export class EngineView {
  113272. /** Defines the canvas where to render the view */
  113273. target: HTMLCanvasElement;
  113274. /** Defines an optional camera used to render the view (will use active camera else) */
  113275. camera?: Camera;
  113276. }
  113277. interface Engine {
  113278. /**
  113279. * Gets or sets the HTML element to use for attaching events
  113280. */
  113281. inputElement: Nullable<HTMLElement>;
  113282. /**
  113283. * Gets the current engine view
  113284. * @see https://doc.babylonjs.com/how_to/multi_canvases
  113285. */
  113286. activeView: Nullable<EngineView>;
  113287. /** Gets or sets the list of views */
  113288. views: EngineView[];
  113289. /**
  113290. * Register a new child canvas
  113291. * @param canvas defines the canvas to register
  113292. * @param camera defines an optional camera to use with this canvas (it will overwrite the scene.camera for this view)
  113293. * @returns the associated view
  113294. */
  113295. registerView(canvas: HTMLCanvasElement, camera?: Camera): EngineView;
  113296. /**
  113297. * Remove a registered child canvas
  113298. * @param canvas defines the canvas to remove
  113299. * @returns the current engine
  113300. */
  113301. unRegisterView(canvas: HTMLCanvasElement): Engine;
  113302. }
  113303. }
  113304. declare module BABYLON {
  113305. /**
  113306. * CubeMap information grouping all the data for each faces as well as the cubemap size.
  113307. */
  113308. export interface CubeMapInfo {
  113309. /**
  113310. * The pixel array for the front face.
  113311. * This is stored in format, left to right, up to down format.
  113312. */
  113313. front: Nullable<ArrayBufferView>;
  113314. /**
  113315. * The pixel array for the back face.
  113316. * This is stored in format, left to right, up to down format.
  113317. */
  113318. back: Nullable<ArrayBufferView>;
  113319. /**
  113320. * The pixel array for the left face.
  113321. * This is stored in format, left to right, up to down format.
  113322. */
  113323. left: Nullable<ArrayBufferView>;
  113324. /**
  113325. * The pixel array for the right face.
  113326. * This is stored in format, left to right, up to down format.
  113327. */
  113328. right: Nullable<ArrayBufferView>;
  113329. /**
  113330. * The pixel array for the up face.
  113331. * This is stored in format, left to right, up to down format.
  113332. */
  113333. up: Nullable<ArrayBufferView>;
  113334. /**
  113335. * The pixel array for the down face.
  113336. * This is stored in format, left to right, up to down format.
  113337. */
  113338. down: Nullable<ArrayBufferView>;
  113339. /**
  113340. * The size of the cubemap stored.
  113341. *
  113342. * Each faces will be size * size pixels.
  113343. */
  113344. size: number;
  113345. /**
  113346. * The format of the texture.
  113347. *
  113348. * RGBA, RGB.
  113349. */
  113350. format: number;
  113351. /**
  113352. * The type of the texture data.
  113353. *
  113354. * UNSIGNED_INT, FLOAT.
  113355. */
  113356. type: number;
  113357. /**
  113358. * Specifies whether the texture is in gamma space.
  113359. */
  113360. gammaSpace: boolean;
  113361. }
  113362. /**
  113363. * Helper class useful to convert panorama picture to their cubemap representation in 6 faces.
  113364. */
  113365. export class PanoramaToCubeMapTools {
  113366. private static FACE_FRONT;
  113367. private static FACE_BACK;
  113368. private static FACE_RIGHT;
  113369. private static FACE_LEFT;
  113370. private static FACE_DOWN;
  113371. private static FACE_UP;
  113372. /**
  113373. * Converts a panorma stored in RGB right to left up to down format into a cubemap (6 faces).
  113374. *
  113375. * @param float32Array The source data.
  113376. * @param inputWidth The width of the input panorama.
  113377. * @param inputHeight The height of the input panorama.
  113378. * @param size The willing size of the generated cubemap (each faces will be size * size pixels)
  113379. * @return The cubemap data
  113380. */
  113381. static ConvertPanoramaToCubemap(float32Array: Float32Array, inputWidth: number, inputHeight: number, size: number): CubeMapInfo;
  113382. private static CreateCubemapTexture;
  113383. private static CalcProjectionSpherical;
  113384. }
  113385. }
  113386. declare module BABYLON {
  113387. /**
  113388. * Helper class dealing with the extraction of spherical polynomial dataArray
  113389. * from a cube map.
  113390. */
  113391. export class CubeMapToSphericalPolynomialTools {
  113392. private static FileFaces;
  113393. /**
  113394. * Converts a texture to the according Spherical Polynomial data.
  113395. * This extracts the first 3 orders only as they are the only one used in the lighting.
  113396. *
  113397. * @param texture The texture to extract the information from.
  113398. * @return The Spherical Polynomial data.
  113399. */
  113400. static ConvertCubeMapTextureToSphericalPolynomial(texture: BaseTexture): Nullable<SphericalPolynomial>;
  113401. /**
  113402. * Converts a cubemap to the according Spherical Polynomial data.
  113403. * This extracts the first 3 orders only as they are the only one used in the lighting.
  113404. *
  113405. * @param cubeInfo The Cube map to extract the information from.
  113406. * @return The Spherical Polynomial data.
  113407. */
  113408. static ConvertCubeMapToSphericalPolynomial(cubeInfo: CubeMapInfo): SphericalPolynomial;
  113409. }
  113410. }
  113411. declare module BABYLON {
  113412. interface BaseTexture {
  113413. /**
  113414. * Get the polynomial representation of the texture data.
  113415. * This is mainly use as a fast way to recover IBL Diffuse irradiance data.
  113416. * @see https://learnopengl.com/PBR/IBL/Diffuse-irradiance
  113417. */
  113418. sphericalPolynomial: Nullable<SphericalPolynomial>;
  113419. }
  113420. }
  113421. declare module BABYLON {
  113422. /** @hidden */
  113423. export var rgbdEncodePixelShader: {
  113424. name: string;
  113425. shader: string;
  113426. };
  113427. }
  113428. declare module BABYLON {
  113429. /** @hidden */
  113430. export var rgbdDecodePixelShader: {
  113431. name: string;
  113432. shader: string;
  113433. };
  113434. }
  113435. declare module BABYLON {
  113436. /**
  113437. * Raw texture data and descriptor sufficient for WebGL texture upload
  113438. */
  113439. export interface EnvironmentTextureInfo {
  113440. /**
  113441. * Version of the environment map
  113442. */
  113443. version: number;
  113444. /**
  113445. * Width of image
  113446. */
  113447. width: number;
  113448. /**
  113449. * Irradiance information stored in the file.
  113450. */
  113451. irradiance: any;
  113452. /**
  113453. * Specular information stored in the file.
  113454. */
  113455. specular: any;
  113456. }
  113457. /**
  113458. * Defines One Image in the file. It requires only the position in the file
  113459. * as well as the length.
  113460. */
  113461. interface BufferImageData {
  113462. /**
  113463. * Length of the image data.
  113464. */
  113465. length: number;
  113466. /**
  113467. * Position of the data from the null terminator delimiting the end of the JSON.
  113468. */
  113469. position: number;
  113470. }
  113471. /**
  113472. * Defines the specular data enclosed in the file.
  113473. * This corresponds to the version 1 of the data.
  113474. */
  113475. export interface EnvironmentTextureSpecularInfoV1 {
  113476. /**
  113477. * Defines where the specular Payload is located. It is a runtime value only not stored in the file.
  113478. */
  113479. specularDataPosition?: number;
  113480. /**
  113481. * This contains all the images data needed to reconstruct the cubemap.
  113482. */
  113483. mipmaps: Array<BufferImageData>;
  113484. /**
  113485. * Defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness.
  113486. */
  113487. lodGenerationScale: number;
  113488. }
  113489. /**
  113490. * Sets of helpers addressing the serialization and deserialization of environment texture
  113491. * stored in a BabylonJS env file.
  113492. * Those files are usually stored as .env files.
  113493. */
  113494. export class EnvironmentTextureTools {
  113495. /**
  113496. * Magic number identifying the env file.
  113497. */
  113498. private static _MagicBytes;
  113499. /**
  113500. * Gets the environment info from an env file.
  113501. * @param data The array buffer containing the .env bytes.
  113502. * @returns the environment file info (the json header) if successfully parsed.
  113503. */
  113504. static GetEnvInfo(data: ArrayBuffer): Nullable<EnvironmentTextureInfo>;
  113505. /**
  113506. * Creates an environment texture from a loaded cube texture.
  113507. * @param texture defines the cube texture to convert in env file
  113508. * @return a promise containing the environment data if succesfull.
  113509. */
  113510. static CreateEnvTextureAsync(texture: CubeTexture): Promise<ArrayBuffer>;
  113511. /**
  113512. * Creates a JSON representation of the spherical data.
  113513. * @param texture defines the texture containing the polynomials
  113514. * @return the JSON representation of the spherical info
  113515. */
  113516. private static _CreateEnvTextureIrradiance;
  113517. /**
  113518. * Creates the ArrayBufferViews used for initializing environment texture image data.
  113519. * @param arrayBuffer the underlying ArrayBuffer to which the views refer
  113520. * @param info parameters that determine what views will be created for accessing the underlying buffer
  113521. * @return the views described by info providing access to the underlying buffer
  113522. */
  113523. static CreateImageDataArrayBufferViews(arrayBuffer: any, info: EnvironmentTextureInfo): Array<Array<ArrayBufferView>>;
  113524. /**
  113525. * Uploads the texture info contained in the env file to the GPU.
  113526. * @param texture defines the internal texture to upload to
  113527. * @param arrayBuffer defines the buffer cotaining the data to load
  113528. * @param info defines the texture info retrieved through the GetEnvInfo method
  113529. * @returns a promise
  113530. */
  113531. static UploadEnvLevelsAsync(texture: InternalTexture, arrayBuffer: any, info: EnvironmentTextureInfo): Promise<void>;
  113532. private static _OnImageReadyAsync;
  113533. /**
  113534. * Uploads the levels of image data to the GPU.
  113535. * @param texture defines the internal texture to upload to
  113536. * @param imageData defines the array buffer views of image data [mipmap][face]
  113537. * @returns a promise
  113538. */
  113539. static UploadLevelsAsync(texture: InternalTexture, imageData: ArrayBufferView[][]): Promise<void>;
  113540. /**
  113541. * Uploads spherical polynomials information to the texture.
  113542. * @param texture defines the texture we are trying to upload the information to
  113543. * @param info defines the environment texture info retrieved through the GetEnvInfo method
  113544. */
  113545. static UploadEnvSpherical(texture: InternalTexture, info: EnvironmentTextureInfo): void;
  113546. /** @hidden */
  113547. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  113548. }
  113549. }
  113550. declare module BABYLON {
  113551. /**
  113552. * Contains position and normal vectors for a vertex
  113553. */
  113554. export class PositionNormalVertex {
  113555. /** the position of the vertex (defaut: 0,0,0) */
  113556. position: Vector3;
  113557. /** the normal of the vertex (defaut: 0,1,0) */
  113558. normal: Vector3;
  113559. /**
  113560. * Creates a PositionNormalVertex
  113561. * @param position the position of the vertex (defaut: 0,0,0)
  113562. * @param normal the normal of the vertex (defaut: 0,1,0)
  113563. */
  113564. constructor(
  113565. /** the position of the vertex (defaut: 0,0,0) */
  113566. position?: Vector3,
  113567. /** the normal of the vertex (defaut: 0,1,0) */
  113568. normal?: Vector3);
  113569. /**
  113570. * Clones the PositionNormalVertex
  113571. * @returns the cloned PositionNormalVertex
  113572. */
  113573. clone(): PositionNormalVertex;
  113574. }
  113575. /**
  113576. * Contains position, normal and uv vectors for a vertex
  113577. */
  113578. export class PositionNormalTextureVertex {
  113579. /** the position of the vertex (defaut: 0,0,0) */
  113580. position: Vector3;
  113581. /** the normal of the vertex (defaut: 0,1,0) */
  113582. normal: Vector3;
  113583. /** the uv of the vertex (default: 0,0) */
  113584. uv: Vector2;
  113585. /**
  113586. * Creates a PositionNormalTextureVertex
  113587. * @param position the position of the vertex (defaut: 0,0,0)
  113588. * @param normal the normal of the vertex (defaut: 0,1,0)
  113589. * @param uv the uv of the vertex (default: 0,0)
  113590. */
  113591. constructor(
  113592. /** the position of the vertex (defaut: 0,0,0) */
  113593. position?: Vector3,
  113594. /** the normal of the vertex (defaut: 0,1,0) */
  113595. normal?: Vector3,
  113596. /** the uv of the vertex (default: 0,0) */
  113597. uv?: Vector2);
  113598. /**
  113599. * Clones the PositionNormalTextureVertex
  113600. * @returns the cloned PositionNormalTextureVertex
  113601. */
  113602. clone(): PositionNormalTextureVertex;
  113603. }
  113604. }
  113605. declare module BABYLON {
  113606. /** @hidden */
  113607. export class NativeShaderProcessor extends WebGL2ShaderProcessor {
  113608. private _genericAttributeLocation;
  113609. private _varyingLocationCount;
  113610. private _varyingLocationMap;
  113611. private _replacements;
  113612. private _textureCount;
  113613. private _uniforms;
  113614. lineProcessor(line: string): string;
  113615. attributeProcessor(attribute: string): string;
  113616. varyingProcessor(varying: string, isFragment: boolean): string;
  113617. uniformProcessor(uniform: string): string;
  113618. preProcessor(code: string, defines: string[], isFragment: boolean): string;
  113619. postProcessor(code: string, defines: string[], isFragment: boolean): string;
  113620. }
  113621. }
  113622. declare module BABYLON {
  113623. /**
  113624. * Container for accessors for natively-stored mesh data buffers.
  113625. */
  113626. class NativeDataBuffer extends DataBuffer {
  113627. /**
  113628. * Accessor value used to identify/retrieve a natively-stored index buffer.
  113629. */
  113630. nativeIndexBuffer?: any;
  113631. /**
  113632. * Accessor value used to identify/retrieve a natively-stored vertex buffer.
  113633. */
  113634. nativeVertexBuffer?: any;
  113635. }
  113636. /** @hidden */
  113637. class NativeTexture extends InternalTexture {
  113638. getInternalTexture(): InternalTexture;
  113639. getViewCount(): number;
  113640. }
  113641. /** @hidden */
  113642. export class NativeEngine extends Engine {
  113643. private readonly _native;
  113644. /** Defines the invalid handle returned by bgfx when resource creation goes wrong */
  113645. private readonly INVALID_HANDLE;
  113646. getHardwareScalingLevel(): number;
  113647. constructor();
  113648. /**
  113649. * Can be used to override the current requestAnimationFrame requester.
  113650. * @hidden
  113651. */
  113652. protected _queueNewFrame(bindedRenderFunction: any, requester?: any): number;
  113653. /**
  113654. * Override default engine behavior.
  113655. * @param color
  113656. * @param backBuffer
  113657. * @param depth
  113658. * @param stencil
  113659. */
  113660. _bindUnboundFramebuffer(framebuffer: Nullable<WebGLFramebuffer>): void;
  113661. clear(color: Nullable<IColor4Like>, backBuffer: boolean, depth: boolean, stencil?: boolean): void;
  113662. createIndexBuffer(indices: IndicesArray): NativeDataBuffer;
  113663. createVertexBuffer(data: DataArray): NativeDataBuffer;
  113664. recordVertexArrayObject(vertexBuffers: {
  113665. [key: string]: VertexBuffer;
  113666. }, indexBuffer: Nullable<NativeDataBuffer>, effect: Effect): WebGLVertexArrayObject;
  113667. bindVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  113668. releaseVertexArrayObject(vertexArray: WebGLVertexArrayObject): void;
  113669. getAttributes(pipelineContext: IPipelineContext, attributesNames: string[]): number[];
  113670. /**
  113671. * Draw a list of indexed primitives
  113672. * @param fillMode defines the primitive to use
  113673. * @param indexStart defines the starting index
  113674. * @param indexCount defines the number of index to draw
  113675. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  113676. */
  113677. drawElementsType(fillMode: number, indexStart: number, indexCount: number, instancesCount?: number): void;
  113678. /**
  113679. * Draw a list of unindexed primitives
  113680. * @param fillMode defines the primitive to use
  113681. * @param verticesStart defines the index of first vertex to draw
  113682. * @param verticesCount defines the count of vertices to draw
  113683. * @param instancesCount defines the number of instances to draw (if instanciation is enabled)
  113684. */
  113685. drawArraysType(fillMode: number, verticesStart: number, verticesCount: number, instancesCount?: number): void;
  113686. createPipelineContext(): IPipelineContext;
  113687. _preparePipelineContext(pipelineContext: IPipelineContext, vertexSourceCode: string, fragmentSourceCode: string, createAsRaw: boolean, rebuildRebind: any, defines: Nullable<string>, transformFeedbackVaryings: Nullable<string[]>): void;
  113688. /** @hidden */
  113689. _isRenderingStateCompiled(pipelineContext: IPipelineContext): boolean;
  113690. /** @hidden */
  113691. _executeWhenRenderingStateIsCompiled(pipelineContext: IPipelineContext, action: () => void): void;
  113692. createRawShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  113693. createShaderProgram(pipelineContext: IPipelineContext, vertexCode: string, fragmentCode: string, defines: Nullable<string>, context?: WebGLRenderingContext, transformFeedbackVaryings?: Nullable<string[]>): any;
  113694. protected _setProgram(program: WebGLProgram): void;
  113695. _releaseEffect(effect: Effect): void;
  113696. _deletePipelineContext(pipelineContext: IPipelineContext): void;
  113697. getUniforms(pipelineContext: IPipelineContext, uniformsNames: string[]): WebGLUniformLocation[];
  113698. bindUniformBlock(pipelineContext: IPipelineContext, blockName: string, index: number): void;
  113699. bindSamplers(effect: Effect): void;
  113700. setMatrix(uniform: WebGLUniformLocation, matrix: Matrix): void;
  113701. getRenderWidth(useScreen?: boolean): number;
  113702. getRenderHeight(useScreen?: boolean): number;
  113703. setViewport(viewport: Viewport, requiredWidth?: number, requiredHeight?: number): void;
  113704. setState(culling: boolean, zOffset?: number, force?: boolean, reverseSide?: boolean): void;
  113705. /**
  113706. * Set the z offset to apply to current rendering
  113707. * @param value defines the offset to apply
  113708. */
  113709. setZOffset(value: number): void;
  113710. /**
  113711. * Gets the current value of the zOffset
  113712. * @returns the current zOffset state
  113713. */
  113714. getZOffset(): number;
  113715. /**
  113716. * Enable or disable depth buffering
  113717. * @param enable defines the state to set
  113718. */
  113719. setDepthBuffer(enable: boolean): void;
  113720. /**
  113721. * Gets a boolean indicating if depth writing is enabled
  113722. * @returns the current depth writing state
  113723. */
  113724. getDepthWrite(): boolean;
  113725. /**
  113726. * Enable or disable depth writing
  113727. * @param enable defines the state to set
  113728. */
  113729. setDepthWrite(enable: boolean): void;
  113730. /**
  113731. * Enable or disable color writing
  113732. * @param enable defines the state to set
  113733. */
  113734. setColorWrite(enable: boolean): void;
  113735. /**
  113736. * Gets a boolean indicating if color writing is enabled
  113737. * @returns the current color writing state
  113738. */
  113739. getColorWrite(): boolean;
  113740. /**
  113741. * Sets alpha constants used by some alpha blending modes
  113742. * @param r defines the red component
  113743. * @param g defines the green component
  113744. * @param b defines the blue component
  113745. * @param a defines the alpha component
  113746. */
  113747. setAlphaConstants(r: number, g: number, b: number, a: number): void;
  113748. /**
  113749. * Sets the current alpha mode
  113750. * @param mode defines the mode to use (one of the BABYLON.Constants.ALPHA_XXX)
  113751. * @param noDepthWriteChange defines if depth writing state should remains unchanged (false by default)
  113752. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  113753. */
  113754. setAlphaMode(mode: number, noDepthWriteChange?: boolean): void;
  113755. /**
  113756. * Gets the current alpha mode
  113757. * @see http://doc.babylonjs.com/resources/transparency_and_how_meshes_are_rendered
  113758. * @returns the current alpha mode
  113759. */
  113760. getAlphaMode(): number;
  113761. setInt(uniform: WebGLUniformLocation, int: number): void;
  113762. setIntArray(uniform: WebGLUniformLocation, array: Int32Array): void;
  113763. setIntArray2(uniform: WebGLUniformLocation, array: Int32Array): void;
  113764. setIntArray3(uniform: WebGLUniformLocation, array: Int32Array): void;
  113765. setIntArray4(uniform: WebGLUniformLocation, array: Int32Array): void;
  113766. setFloatArray(uniform: WebGLUniformLocation, array: Float32Array): void;
  113767. setFloatArray2(uniform: WebGLUniformLocation, array: Float32Array): void;
  113768. setFloatArray3(uniform: WebGLUniformLocation, array: Float32Array): void;
  113769. setFloatArray4(uniform: WebGLUniformLocation, array: Float32Array): void;
  113770. setArray(uniform: WebGLUniformLocation, array: number[]): void;
  113771. setArray2(uniform: WebGLUniformLocation, array: number[]): void;
  113772. setArray3(uniform: WebGLUniformLocation, array: number[]): void;
  113773. setArray4(uniform: WebGLUniformLocation, array: number[]): void;
  113774. setMatrices(uniform: WebGLUniformLocation, matrices: Float32Array): void;
  113775. setMatrix3x3(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  113776. setMatrix2x2(uniform: WebGLUniformLocation, matrix: Float32Array): void;
  113777. setFloat(uniform: WebGLUniformLocation, value: number): void;
  113778. setFloat2(uniform: WebGLUniformLocation, x: number, y: number): void;
  113779. setFloat3(uniform: WebGLUniformLocation, x: number, y: number, z: number): void;
  113780. setFloat4(uniform: WebGLUniformLocation, x: number, y: number, z: number, w: number): void;
  113781. setColor3(uniform: WebGLUniformLocation, color3: Color3): void;
  113782. setColor4(uniform: WebGLUniformLocation, color3: Color3, alpha: number): void;
  113783. wipeCaches(bruteForce?: boolean): void;
  113784. _createTexture(): WebGLTexture;
  113785. protected _deleteTexture(texture: Nullable<WebGLTexture>): void;
  113786. /**
  113787. * Usually called from BABYLON.Texture.ts.
  113788. * Passed information to create a WebGLTexture
  113789. * @param urlArg defines a value which contains one of the following:
  113790. * * A conventional http URL, e.g. 'http://...' or 'file://...'
  113791. * * A base64 string of in-line texture data, e.g. 'data:image/jpg;base64,/...'
  113792. * * An indicator that data being passed using the buffer parameter, e.g. 'data:mytexture.jpg'
  113793. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated. Ignored for compressed textures. They must be in the file
  113794. * @param invertY when true, image is flipped when loaded. You probably want true. Ignored for compressed textures. Must be flipped in the file
  113795. * @param scene needed for loading to the correct scene
  113796. * @param samplingMode mode with should be used sample / access the texture (Default: BABYLON.Texture.TRILINEAR_SAMPLINGMODE)
  113797. * @param onLoad optional callback to be called upon successful completion
  113798. * @param onError optional callback to be called upon failure
  113799. * @param buffer a source of a file previously fetched as either a base64 string, an ArrayBuffer (compressed or image format), or a Blob
  113800. * @param fallback an internal argument in case the function must be called again, due to etc1 not having alpha capabilities
  113801. * @param format internal format. Default: RGB when extension is '.jpg' else RGBA. Ignored for compressed textures
  113802. * @param forcedExtension defines the extension to use to pick the right loader
  113803. * @returns a InternalTexture for assignment back into BABYLON.Texture
  113804. */
  113805. 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;
  113806. /**
  113807. * Creates a cube texture
  113808. * @param rootUrl defines the url where the files to load is located
  113809. * @param scene defines the current scene
  113810. * @param files defines the list of files to load (1 per face)
  113811. * @param noMipmap defines a boolean indicating that no mipmaps shall be generated (false by default)
  113812. * @param onLoad defines an optional callback raised when the texture is loaded
  113813. * @param onError defines an optional callback raised if there is an issue to load the texture
  113814. * @param format defines the format of the data
  113815. * @param forcedExtension defines the extension to use to pick the right loader
  113816. * @param createPolynomials if a polynomial sphere should be created for the cube texture
  113817. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  113818. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  113819. * @param fallback defines texture to use while falling back when (compressed) texture file not found.
  113820. * @returns the cube texture as an InternalTexture
  113821. */
  113822. 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;
  113823. private _getSamplingFilter;
  113824. private static _GetNativeTextureFormat;
  113825. createRenderTargetTexture(size: number | {
  113826. width: number;
  113827. height: number;
  113828. }, options: boolean | RenderTargetCreationOptions): NativeTexture;
  113829. updateTextureSamplingMode(samplingMode: number, texture: InternalTexture): void;
  113830. bindFramebuffer(texture: InternalTexture, faceIndex?: number, requiredWidth?: number, requiredHeight?: number, forceFullscreenViewport?: boolean): void;
  113831. unBindFramebuffer(texture: InternalTexture, disableGenerateMipMaps?: boolean, onBeforeUnbind?: () => void): void;
  113832. createDynamicVertexBuffer(data: DataArray): DataBuffer;
  113833. updateDynamicIndexBuffer(indexBuffer: DataBuffer, indices: IndicesArray, offset?: number): void;
  113834. /**
  113835. * Updates a dynamic vertex buffer.
  113836. * @param vertexBuffer the vertex buffer to update
  113837. * @param data the data used to update the vertex buffer
  113838. * @param byteOffset the byte offset of the data (optional)
  113839. * @param byteLength the byte length of the data (optional)
  113840. */
  113841. updateDynamicVertexBuffer(vertexBuffer: DataBuffer, data: DataArray, byteOffset?: number, byteLength?: number): void;
  113842. protected _setTexture(channel: number, texture: Nullable<BaseTexture>, isPartOfTextureArray?: boolean, depthStencilTexture?: boolean): boolean;
  113843. private _updateAnisotropicLevel;
  113844. private _getAddressMode;
  113845. /** @hidden */
  113846. _bindTexture(channel: number, texture: InternalTexture): void;
  113847. protected _deleteBuffer(buffer: NativeDataBuffer): void;
  113848. releaseEffects(): void;
  113849. /** @hidden */
  113850. _uploadCompressedDataToTextureDirectly(texture: InternalTexture, internalFormat: number, width: number, height: number, data: ArrayBufferView, faceIndex?: number, lod?: number): void;
  113851. /** @hidden */
  113852. _uploadDataToTextureDirectly(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  113853. /** @hidden */
  113854. _uploadArrayBufferViewToTexture(texture: InternalTexture, imageData: ArrayBufferView, faceIndex?: number, lod?: number): void;
  113855. /** @hidden */
  113856. _uploadImageToTexture(texture: InternalTexture, image: HTMLImageElement, faceIndex?: number, lod?: number): void;
  113857. }
  113858. }
  113859. declare module BABYLON {
  113860. /**
  113861. * Gather the list of clipboard event types as constants.
  113862. */
  113863. export class ClipboardEventTypes {
  113864. /**
  113865. * The clipboard event is fired when a copy command is active (pressed).
  113866. */
  113867. static readonly COPY: number;
  113868. /**
  113869. * The clipboard event is fired when a cut command is active (pressed).
  113870. */
  113871. static readonly CUT: number;
  113872. /**
  113873. * The clipboard event is fired when a paste command is active (pressed).
  113874. */
  113875. static readonly PASTE: number;
  113876. }
  113877. /**
  113878. * This class is used to store clipboard related info for the onClipboardObservable event.
  113879. */
  113880. export class ClipboardInfo {
  113881. /**
  113882. * Defines the type of event (BABYLON.ClipboardEventTypes)
  113883. */
  113884. type: number;
  113885. /**
  113886. * Defines the related dom event
  113887. */
  113888. event: ClipboardEvent;
  113889. /**
  113890. *Creates an instance of ClipboardInfo.
  113891. * @param type Defines the type of event (BABYLON.ClipboardEventTypes)
  113892. * @param event Defines the related dom event
  113893. */
  113894. constructor(
  113895. /**
  113896. * Defines the type of event (BABYLON.ClipboardEventTypes)
  113897. */
  113898. type: number,
  113899. /**
  113900. * Defines the related dom event
  113901. */
  113902. event: ClipboardEvent);
  113903. /**
  113904. * Get the clipboard event's type from the keycode.
  113905. * @param keyCode Defines the keyCode for the current keyboard event.
  113906. * @return {number}
  113907. */
  113908. static GetTypeFromCharacter(keyCode: number): number;
  113909. }
  113910. }
  113911. declare module BABYLON {
  113912. /**
  113913. * Google Daydream controller
  113914. */
  113915. export class DaydreamController extends WebVRController {
  113916. /**
  113917. * Base Url for the controller model.
  113918. */
  113919. static MODEL_BASE_URL: string;
  113920. /**
  113921. * File name for the controller model.
  113922. */
  113923. static MODEL_FILENAME: string;
  113924. /**
  113925. * Gamepad Id prefix used to identify Daydream Controller.
  113926. */
  113927. static readonly GAMEPAD_ID_PREFIX: string;
  113928. /**
  113929. * Creates a new DaydreamController from a gamepad
  113930. * @param vrGamepad the gamepad that the controller should be created from
  113931. */
  113932. constructor(vrGamepad: any);
  113933. /**
  113934. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  113935. * @param scene scene in which to add meshes
  113936. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  113937. */
  113938. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  113939. /**
  113940. * Called once for each button that changed state since the last frame
  113941. * @param buttonIdx Which button index changed
  113942. * @param state New state of the button
  113943. * @param changes Which properties on the state changed since last frame
  113944. */
  113945. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  113946. }
  113947. }
  113948. declare module BABYLON {
  113949. /**
  113950. * Gear VR Controller
  113951. */
  113952. export class GearVRController extends WebVRController {
  113953. /**
  113954. * Base Url for the controller model.
  113955. */
  113956. static MODEL_BASE_URL: string;
  113957. /**
  113958. * File name for the controller model.
  113959. */
  113960. static MODEL_FILENAME: string;
  113961. /**
  113962. * Gamepad Id prefix used to identify this controller.
  113963. */
  113964. static readonly GAMEPAD_ID_PREFIX: string;
  113965. private readonly _buttonIndexToObservableNameMap;
  113966. /**
  113967. * Creates a new GearVRController from a gamepad
  113968. * @param vrGamepad the gamepad that the controller should be created from
  113969. */
  113970. constructor(vrGamepad: any);
  113971. /**
  113972. * Implements abstract method on WebVRController class, loading controller meshes and calling this.attachToMesh if successful.
  113973. * @param scene scene in which to add meshes
  113974. * @param meshLoaded optional callback function that will be called if the mesh loads successfully.
  113975. */
  113976. initControllerMesh(scene: Scene, meshLoaded?: (mesh: AbstractMesh) => void): void;
  113977. /**
  113978. * Called once for each button that changed state since the last frame
  113979. * @param buttonIdx Which button index changed
  113980. * @param state New state of the button
  113981. * @param changes Which properties on the state changed since last frame
  113982. */
  113983. protected _handleButtonChange(buttonIdx: number, state: ExtendedGamepadButton, changes: GamepadButtonChanges): void;
  113984. }
  113985. }
  113986. declare module BABYLON {
  113987. /**
  113988. * Class containing static functions to help procedurally build meshes
  113989. */
  113990. export class PolyhedronBuilder {
  113991. /**
  113992. * Creates a polyhedron mesh
  113993. * * 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
  113994. * * The parameter `size` (positive float, default 1) sets the polygon size
  113995. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  113996. * * 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`
  113997. * * 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
  113998. * * 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)`)
  113999. * * 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
  114000. * * 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
  114001. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  114002. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  114003. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  114004. * @param name defines the name of the mesh
  114005. * @param options defines the options used to create the mesh
  114006. * @param scene defines the hosting scene
  114007. * @returns the polyhedron mesh
  114008. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  114009. */
  114010. static CreatePolyhedron(name: string, options: {
  114011. type?: number;
  114012. size?: number;
  114013. sizeX?: number;
  114014. sizeY?: number;
  114015. sizeZ?: number;
  114016. custom?: any;
  114017. faceUV?: Vector4[];
  114018. faceColors?: Color4[];
  114019. flat?: boolean;
  114020. updatable?: boolean;
  114021. sideOrientation?: number;
  114022. frontUVs?: Vector4;
  114023. backUVs?: Vector4;
  114024. }, scene?: Nullable<Scene>): Mesh;
  114025. }
  114026. }
  114027. declare module BABYLON {
  114028. /**
  114029. * Gizmo that enables scaling a mesh along 3 axis
  114030. */
  114031. export class ScaleGizmo extends Gizmo {
  114032. /**
  114033. * Internal gizmo used for interactions on the x axis
  114034. */
  114035. xGizmo: AxisScaleGizmo;
  114036. /**
  114037. * Internal gizmo used for interactions on the y axis
  114038. */
  114039. yGizmo: AxisScaleGizmo;
  114040. /**
  114041. * Internal gizmo used for interactions on the z axis
  114042. */
  114043. zGizmo: AxisScaleGizmo;
  114044. /**
  114045. * Internal gizmo used to scale all axis equally
  114046. */
  114047. uniformScaleGizmo: AxisScaleGizmo;
  114048. private _meshAttached;
  114049. private _updateGizmoRotationToMatchAttachedMesh;
  114050. private _snapDistance;
  114051. private _scaleRatio;
  114052. private _uniformScalingMesh;
  114053. private _octahedron;
  114054. private _sensitivity;
  114055. /** Fires an event when any of it's sub gizmos are dragged */
  114056. onDragStartObservable: Observable<unknown>;
  114057. /** Fires an event when any of it's sub gizmos are released from dragging */
  114058. onDragEndObservable: Observable<unknown>;
  114059. attachedMesh: Nullable<AbstractMesh>;
  114060. /**
  114061. * Creates a ScaleGizmo
  114062. * @param gizmoLayer The utility layer the gizmo will be added to
  114063. */
  114064. constructor(gizmoLayer?: UtilityLayerRenderer);
  114065. updateGizmoRotationToMatchAttachedMesh: boolean;
  114066. /**
  114067. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  114068. */
  114069. snapDistance: number;
  114070. /**
  114071. * Ratio for the scale of the gizmo (Default: 1)
  114072. */
  114073. scaleRatio: number;
  114074. /**
  114075. * Sensitivity factor for dragging (Default: 1)
  114076. */
  114077. sensitivity: number;
  114078. /**
  114079. * Disposes of the gizmo
  114080. */
  114081. dispose(): void;
  114082. }
  114083. }
  114084. declare module BABYLON {
  114085. /**
  114086. * Single axis scale gizmo
  114087. */
  114088. export class AxisScaleGizmo extends Gizmo {
  114089. /**
  114090. * Drag behavior responsible for the gizmos dragging interactions
  114091. */
  114092. dragBehavior: PointerDragBehavior;
  114093. private _pointerObserver;
  114094. /**
  114095. * Scale distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  114096. */
  114097. snapDistance: number;
  114098. /**
  114099. * Event that fires each time the gizmo snaps to a new location.
  114100. * * snapDistance is the the change in distance
  114101. */
  114102. onSnapObservable: Observable<{
  114103. snapDistance: number;
  114104. }>;
  114105. /**
  114106. * If the scaling operation should be done on all axis (default: false)
  114107. */
  114108. uniformScaling: boolean;
  114109. /**
  114110. * Custom sensitivity value for the drag strength
  114111. */
  114112. sensitivity: number;
  114113. private _isEnabled;
  114114. private _parent;
  114115. private _arrow;
  114116. private _coloredMaterial;
  114117. private _hoverMaterial;
  114118. /**
  114119. * Creates an AxisScaleGizmo
  114120. * @param gizmoLayer The utility layer the gizmo will be added to
  114121. * @param dragAxis The axis which the gizmo will be able to scale on
  114122. * @param color The color of the gizmo
  114123. */
  114124. constructor(dragAxis: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, parent?: Nullable<ScaleGizmo>);
  114125. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  114126. /**
  114127. * If the gizmo is enabled
  114128. */
  114129. isEnabled: boolean;
  114130. /**
  114131. * Disposes of the gizmo
  114132. */
  114133. dispose(): void;
  114134. /**
  114135. * Disposes and replaces the current meshes in the gizmo with the specified mesh
  114136. * @param mesh The mesh to replace the default mesh of the gizmo
  114137. * @param useGizmoMaterial If the gizmo's default material should be used (default: false)
  114138. */
  114139. setCustomMesh(mesh: Mesh, useGizmoMaterial?: boolean): void;
  114140. }
  114141. }
  114142. declare module BABYLON {
  114143. /**
  114144. * Bounding box gizmo
  114145. */
  114146. export class BoundingBoxGizmo extends Gizmo {
  114147. private _lineBoundingBox;
  114148. private _rotateSpheresParent;
  114149. private _scaleBoxesParent;
  114150. private _boundingDimensions;
  114151. private _renderObserver;
  114152. private _pointerObserver;
  114153. private _scaleDragSpeed;
  114154. private _tmpQuaternion;
  114155. private _tmpVector;
  114156. private _tmpRotationMatrix;
  114157. /**
  114158. * 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)
  114159. */
  114160. ignoreChildren: boolean;
  114161. /**
  114162. * 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)
  114163. */
  114164. includeChildPredicate: Nullable<(abstractMesh: AbstractMesh) => boolean>;
  114165. /**
  114166. * The size of the rotation spheres attached to the bounding box (Default: 0.1)
  114167. */
  114168. rotationSphereSize: number;
  114169. /**
  114170. * The size of the scale boxes attached to the bounding box (Default: 0.1)
  114171. */
  114172. scaleBoxSize: number;
  114173. /**
  114174. * 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)
  114175. */
  114176. fixedDragMeshScreenSize: boolean;
  114177. /**
  114178. * The distance away from the object which the draggable meshes should appear world sized when fixedDragMeshScreenSize is set to true (default: 10)
  114179. */
  114180. fixedDragMeshScreenSizeDistanceFactor: number;
  114181. /**
  114182. * Fired when a rotation sphere or scale box is dragged
  114183. */
  114184. onDragStartObservable: Observable<{}>;
  114185. /**
  114186. * Fired when a scale box is dragged
  114187. */
  114188. onScaleBoxDragObservable: Observable<{}>;
  114189. /**
  114190. * Fired when a scale box drag is ended
  114191. */
  114192. onScaleBoxDragEndObservable: Observable<{}>;
  114193. /**
  114194. * Fired when a rotation sphere is dragged
  114195. */
  114196. onRotationSphereDragObservable: Observable<{}>;
  114197. /**
  114198. * Fired when a rotation sphere drag is ended
  114199. */
  114200. onRotationSphereDragEndObservable: Observable<{}>;
  114201. /**
  114202. * 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)
  114203. */
  114204. scalePivot: Nullable<Vector3>;
  114205. /**
  114206. * Mesh used as a pivot to rotate the attached mesh
  114207. */
  114208. private _anchorMesh;
  114209. private _existingMeshScale;
  114210. private _dragMesh;
  114211. private pointerDragBehavior;
  114212. private coloredMaterial;
  114213. private hoverColoredMaterial;
  114214. /**
  114215. * Sets the color of the bounding box gizmo
  114216. * @param color the color to set
  114217. */
  114218. setColor(color: Color3): void;
  114219. /**
  114220. * Creates an BoundingBoxGizmo
  114221. * @param gizmoLayer The utility layer the gizmo will be added to
  114222. * @param color The color of the gizmo
  114223. */
  114224. constructor(color?: Color3, gizmoLayer?: UtilityLayerRenderer);
  114225. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  114226. private _selectNode;
  114227. /**
  114228. * Updates the bounding box information for the Gizmo
  114229. */
  114230. updateBoundingBox(): void;
  114231. private _updateRotationSpheres;
  114232. private _updateScaleBoxes;
  114233. /**
  114234. * Enables rotation on the specified axis and disables rotation on the others
  114235. * @param axis The list of axis that should be enabled (eg. "xy" or "xyz")
  114236. */
  114237. setEnabledRotationAxis(axis: string): void;
  114238. /**
  114239. * Enables/disables scaling
  114240. * @param enable if scaling should be enabled
  114241. */
  114242. setEnabledScaling(enable: boolean): void;
  114243. private _updateDummy;
  114244. /**
  114245. * Enables a pointer drag behavior on the bounding box of the gizmo
  114246. */
  114247. enableDragBehavior(): void;
  114248. /**
  114249. * Disposes of the gizmo
  114250. */
  114251. dispose(): void;
  114252. /**
  114253. * 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)
  114254. * @param mesh the mesh to wrap in the bounding box mesh and make not pickable
  114255. * @returns the bounding box mesh with the passed in mesh as a child
  114256. */
  114257. static MakeNotPickableAndWrapInBoundingBox(mesh: Mesh): Mesh;
  114258. /**
  114259. * CustomMeshes are not supported by this gizmo
  114260. * @param mesh The mesh to replace the default mesh of the gizmo
  114261. */
  114262. setCustomMesh(mesh: Mesh): void;
  114263. }
  114264. }
  114265. declare module BABYLON {
  114266. /**
  114267. * Single plane rotation gizmo
  114268. */
  114269. export class PlaneRotationGizmo extends Gizmo {
  114270. /**
  114271. * Drag behavior responsible for the gizmos dragging interactions
  114272. */
  114273. dragBehavior: PointerDragBehavior;
  114274. private _pointerObserver;
  114275. /**
  114276. * Rotation distance in radians that the gizmo will snap to (Default: 0)
  114277. */
  114278. snapDistance: number;
  114279. /**
  114280. * Event that fires each time the gizmo snaps to a new location.
  114281. * * snapDistance is the the change in distance
  114282. */
  114283. onSnapObservable: Observable<{
  114284. snapDistance: number;
  114285. }>;
  114286. private _isEnabled;
  114287. private _parent;
  114288. /**
  114289. * Creates a PlaneRotationGizmo
  114290. * @param gizmoLayer The utility layer the gizmo will be added to
  114291. * @param planeNormal The normal of the plane which the gizmo will be able to rotate on
  114292. * @param color The color of the gizmo
  114293. * @param tessellation Amount of tessellation to be used when creating rotation circles
  114294. * @param useEulerRotation Use and update Euler angle instead of quaternion
  114295. */
  114296. constructor(planeNormal: Vector3, color?: Color3, gizmoLayer?: UtilityLayerRenderer, tessellation?: number, parent?: Nullable<RotationGizmo>, useEulerRotation?: boolean);
  114297. protected _attachedMeshChanged(value: Nullable<AbstractMesh>): void;
  114298. /**
  114299. * If the gizmo is enabled
  114300. */
  114301. isEnabled: boolean;
  114302. /**
  114303. * Disposes of the gizmo
  114304. */
  114305. dispose(): void;
  114306. }
  114307. }
  114308. declare module BABYLON {
  114309. /**
  114310. * Gizmo that enables rotating a mesh along 3 axis
  114311. */
  114312. export class RotationGizmo extends Gizmo {
  114313. /**
  114314. * Internal gizmo used for interactions on the x axis
  114315. */
  114316. xGizmo: PlaneRotationGizmo;
  114317. /**
  114318. * Internal gizmo used for interactions on the y axis
  114319. */
  114320. yGizmo: PlaneRotationGizmo;
  114321. /**
  114322. * Internal gizmo used for interactions on the z axis
  114323. */
  114324. zGizmo: PlaneRotationGizmo;
  114325. /** Fires an event when any of it's sub gizmos are dragged */
  114326. onDragStartObservable: Observable<unknown>;
  114327. /** Fires an event when any of it's sub gizmos are released from dragging */
  114328. onDragEndObservable: Observable<unknown>;
  114329. private _meshAttached;
  114330. attachedMesh: Nullable<AbstractMesh>;
  114331. /**
  114332. * Creates a RotationGizmo
  114333. * @param gizmoLayer The utility layer the gizmo will be added to
  114334. * @param tessellation Amount of tessellation to be used when creating rotation circles
  114335. * @param useEulerRotation Use and update Euler angle instead of quaternion
  114336. */
  114337. constructor(gizmoLayer?: UtilityLayerRenderer, tessellation?: number, useEulerRotation?: boolean);
  114338. updateGizmoRotationToMatchAttachedMesh: boolean;
  114339. /**
  114340. * Drag distance in babylon units that the gizmo will snap to when dragged (Default: 0)
  114341. */
  114342. snapDistance: number;
  114343. /**
  114344. * Ratio for the scale of the gizmo (Default: 1)
  114345. */
  114346. scaleRatio: number;
  114347. /**
  114348. * Disposes of the gizmo
  114349. */
  114350. dispose(): void;
  114351. /**
  114352. * CustomMeshes are not supported by this gizmo
  114353. * @param mesh The mesh to replace the default mesh of the gizmo
  114354. */
  114355. setCustomMesh(mesh: Mesh): void;
  114356. }
  114357. }
  114358. declare module BABYLON {
  114359. /**
  114360. * Helps setup gizmo's in the scene to rotate/scale/position meshes
  114361. */
  114362. export class GizmoManager implements IDisposable {
  114363. private scene;
  114364. /**
  114365. * Gizmo's created by the gizmo manager, gizmo will be null until gizmo has been enabled for the first time
  114366. */
  114367. gizmos: {
  114368. positionGizmo: Nullable<PositionGizmo>;
  114369. rotationGizmo: Nullable<RotationGizmo>;
  114370. scaleGizmo: Nullable<ScaleGizmo>;
  114371. boundingBoxGizmo: Nullable<BoundingBoxGizmo>;
  114372. };
  114373. /** When true, the gizmo will be detached from the current object when a pointer down occurs with an empty picked mesh */
  114374. clearGizmoOnEmptyPointerEvent: boolean;
  114375. /** Fires an event when the manager is attached to a mesh */
  114376. onAttachedToMeshObservable: Observable<Nullable<AbstractMesh>>;
  114377. private _gizmosEnabled;
  114378. private _pointerObserver;
  114379. private _attachedMesh;
  114380. private _boundingBoxColor;
  114381. private _defaultUtilityLayer;
  114382. private _defaultKeepDepthUtilityLayer;
  114383. /**
  114384. * When bounding box gizmo is enabled, this can be used to track drag/end events
  114385. */
  114386. boundingBoxDragBehavior: SixDofDragBehavior;
  114387. /**
  114388. * Array of meshes which will have the gizmo attached when a pointer selected them. If null, all meshes are attachable. (Default: null)
  114389. */
  114390. attachableMeshes: Nullable<Array<AbstractMesh>>;
  114391. /**
  114392. * If pointer events should perform attaching/detaching a gizmo, if false this can be done manually via attachToMesh. (Default: true)
  114393. */
  114394. usePointerToAttachGizmos: boolean;
  114395. /**
  114396. * Utility layer that the bounding box gizmo belongs to
  114397. */
  114398. readonly keepDepthUtilityLayer: UtilityLayerRenderer;
  114399. /**
  114400. * Utility layer that all gizmos besides bounding box belong to
  114401. */
  114402. readonly utilityLayer: UtilityLayerRenderer;
  114403. /**
  114404. * Instatiates a gizmo manager
  114405. * @param scene the scene to overlay the gizmos on top of
  114406. */
  114407. constructor(scene: Scene);
  114408. /**
  114409. * Attaches a set of gizmos to the specified mesh
  114410. * @param mesh The mesh the gizmo's should be attached to
  114411. */
  114412. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  114413. /**
  114414. * If the position gizmo is enabled
  114415. */
  114416. positionGizmoEnabled: boolean;
  114417. /**
  114418. * If the rotation gizmo is enabled
  114419. */
  114420. rotationGizmoEnabled: boolean;
  114421. /**
  114422. * If the scale gizmo is enabled
  114423. */
  114424. scaleGizmoEnabled: boolean;
  114425. /**
  114426. * If the boundingBox gizmo is enabled
  114427. */
  114428. boundingBoxGizmoEnabled: boolean;
  114429. /**
  114430. * Disposes of the gizmo manager
  114431. */
  114432. dispose(): void;
  114433. }
  114434. }
  114435. declare module BABYLON {
  114436. /**
  114437. * A directional light is defined by a direction (what a surprise!).
  114438. * The light is emitted from everywhere in the specified direction, and has an infinite range.
  114439. * 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.
  114440. * Documentation: https://doc.babylonjs.com/babylon101/lights
  114441. */
  114442. export class DirectionalLight extends ShadowLight {
  114443. private _shadowFrustumSize;
  114444. /**
  114445. * Fix frustum size for the shadow generation. This is disabled if the value is 0.
  114446. */
  114447. /**
  114448. * Specifies a fix frustum size for the shadow generation.
  114449. */
  114450. shadowFrustumSize: number;
  114451. private _shadowOrthoScale;
  114452. /**
  114453. * Gets the shadow projection scale against the optimal computed one.
  114454. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  114455. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  114456. */
  114457. /**
  114458. * Sets the shadow projection scale against the optimal computed one.
  114459. * 0.1 by default which means that the projection window is increase by 10% from the optimal size.
  114460. * This does not impact in fixed frustum size (shadowFrustumSize being set)
  114461. */
  114462. shadowOrthoScale: number;
  114463. /**
  114464. * Automatically compute the projection matrix to best fit (including all the casters)
  114465. * on each frame.
  114466. */
  114467. autoUpdateExtends: boolean;
  114468. private _orthoLeft;
  114469. private _orthoRight;
  114470. private _orthoTop;
  114471. private _orthoBottom;
  114472. /**
  114473. * Creates a DirectionalLight object in the scene, oriented towards the passed direction (Vector3).
  114474. * The directional light is emitted from everywhere in the given direction.
  114475. * It can cast shadows.
  114476. * Documentation : https://doc.babylonjs.com/babylon101/lights
  114477. * @param name The friendly name of the light
  114478. * @param direction The direction of the light
  114479. * @param scene The scene the light belongs to
  114480. */
  114481. constructor(name: string, direction: Vector3, scene: Scene);
  114482. /**
  114483. * Returns the string "DirectionalLight".
  114484. * @return The class name
  114485. */
  114486. getClassName(): string;
  114487. /**
  114488. * Returns the integer 1.
  114489. * @return The light Type id as a constant defines in Light.LIGHTTYPEID_x
  114490. */
  114491. getTypeID(): number;
  114492. /**
  114493. * Sets the passed matrix "matrix" as projection matrix for the shadows cast by the light according to the passed view matrix.
  114494. * Returns the DirectionalLight Shadow projection matrix.
  114495. */
  114496. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  114497. /**
  114498. * Sets the passed matrix "matrix" as fixed frustum projection matrix for the shadows cast by the light according to the passed view matrix.
  114499. * Returns the DirectionalLight Shadow projection matrix.
  114500. */
  114501. protected _setDefaultFixedFrustumShadowProjectionMatrix(matrix: Matrix): void;
  114502. /**
  114503. * Sets the passed matrix "matrix" as auto extend projection matrix for the shadows cast by the light according to the passed view matrix.
  114504. * Returns the DirectionalLight Shadow projection matrix.
  114505. */
  114506. protected _setDefaultAutoExtendShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  114507. protected _buildUniformLayout(): void;
  114508. /**
  114509. * Sets the passed Effect object with the DirectionalLight transformed position (or position if not parented) and the passed name.
  114510. * @param effect The effect to update
  114511. * @param lightIndex The index of the light in the effect to update
  114512. * @returns The directional light
  114513. */
  114514. transferToEffect(effect: Effect, lightIndex: string): DirectionalLight;
  114515. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): Light;
  114516. /**
  114517. * Gets the minZ used for shadow according to both the scene and the light.
  114518. *
  114519. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  114520. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  114521. * @param activeCamera The camera we are returning the min for
  114522. * @returns the depth min z
  114523. */
  114524. getDepthMinZ(activeCamera: Camera): number;
  114525. /**
  114526. * Gets the maxZ used for shadow according to both the scene and the light.
  114527. *
  114528. * Values are fixed on directional lights as it relies on an ortho projection hence the need to convert being
  114529. * -1 and 1 to 0 and 1 doing (depth + min) / (min + max) -> (depth + 1) / (1 + 1) -> (depth * 0.5) + 0.5.
  114530. * @param activeCamera The camera we are returning the max for
  114531. * @returns the depth max z
  114532. */
  114533. getDepthMaxZ(activeCamera: Camera): number;
  114534. /**
  114535. * Prepares the list of defines specific to the light type.
  114536. * @param defines the list of defines
  114537. * @param lightIndex defines the index of the light for the effect
  114538. */
  114539. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  114540. }
  114541. }
  114542. declare module BABYLON {
  114543. /**
  114544. * Class containing static functions to help procedurally build meshes
  114545. */
  114546. export class HemisphereBuilder {
  114547. /**
  114548. * Creates a hemisphere mesh
  114549. * @param name defines the name of the mesh
  114550. * @param options defines the options used to create the mesh
  114551. * @param scene defines the hosting scene
  114552. * @returns the hemisphere mesh
  114553. */
  114554. static CreateHemisphere(name: string, options: {
  114555. segments?: number;
  114556. diameter?: number;
  114557. sideOrientation?: number;
  114558. }, scene: any): Mesh;
  114559. }
  114560. }
  114561. declare module BABYLON {
  114562. /**
  114563. * A spot light is defined by a position, a direction, an angle, and an exponent.
  114564. * These values define a cone of light starting from the position, emitting toward the direction.
  114565. * The angle, in radians, defines the size (field of illumination) of the spotlight's conical beam,
  114566. * and the exponent defines the speed of the decay of the light with distance (reach).
  114567. * Documentation: https://doc.babylonjs.com/babylon101/lights
  114568. */
  114569. export class SpotLight extends ShadowLight {
  114570. private _angle;
  114571. private _innerAngle;
  114572. private _cosHalfAngle;
  114573. private _lightAngleScale;
  114574. private _lightAngleOffset;
  114575. /**
  114576. * Gets the cone angle of the spot light in Radians.
  114577. */
  114578. /**
  114579. * Sets the cone angle of the spot light in Radians.
  114580. */
  114581. angle: number;
  114582. /**
  114583. * Only used in gltf falloff mode, this defines the angle where
  114584. * the directional falloff will start before cutting at angle which could be seen
  114585. * as outer angle.
  114586. */
  114587. /**
  114588. * Only used in gltf falloff mode, this defines the angle where
  114589. * the directional falloff will start before cutting at angle which could be seen
  114590. * as outer angle.
  114591. */
  114592. innerAngle: number;
  114593. private _shadowAngleScale;
  114594. /**
  114595. * Allows scaling the angle of the light for shadow generation only.
  114596. */
  114597. /**
  114598. * Allows scaling the angle of the light for shadow generation only.
  114599. */
  114600. shadowAngleScale: number;
  114601. /**
  114602. * The light decay speed with the distance from the emission spot.
  114603. */
  114604. exponent: number;
  114605. private _projectionTextureMatrix;
  114606. /**
  114607. * Allows reading the projecton texture
  114608. */
  114609. readonly projectionTextureMatrix: Matrix;
  114610. protected _projectionTextureLightNear: number;
  114611. /**
  114612. * Gets the near clip of the Spotlight for texture projection.
  114613. */
  114614. /**
  114615. * Sets the near clip of the Spotlight for texture projection.
  114616. */
  114617. projectionTextureLightNear: number;
  114618. protected _projectionTextureLightFar: number;
  114619. /**
  114620. * Gets the far clip of the Spotlight for texture projection.
  114621. */
  114622. /**
  114623. * Sets the far clip of the Spotlight for texture projection.
  114624. */
  114625. projectionTextureLightFar: number;
  114626. protected _projectionTextureUpDirection: Vector3;
  114627. /**
  114628. * Gets the Up vector of the Spotlight for texture projection.
  114629. */
  114630. /**
  114631. * Sets the Up vector of the Spotlight for texture projection.
  114632. */
  114633. projectionTextureUpDirection: Vector3;
  114634. private _projectionTexture;
  114635. /**
  114636. * Gets the projection texture of the light.
  114637. */
  114638. /**
  114639. * Sets the projection texture of the light.
  114640. */
  114641. projectionTexture: Nullable<BaseTexture>;
  114642. private _projectionTextureViewLightDirty;
  114643. private _projectionTextureProjectionLightDirty;
  114644. private _projectionTextureDirty;
  114645. private _projectionTextureViewTargetVector;
  114646. private _projectionTextureViewLightMatrix;
  114647. private _projectionTextureProjectionLightMatrix;
  114648. private _projectionTextureScalingMatrix;
  114649. /**
  114650. * Creates a SpotLight object in the scene. A spot light is a simply light oriented cone.
  114651. * It can cast shadows.
  114652. * Documentation : https://doc.babylonjs.com/babylon101/lights
  114653. * @param name The light friendly name
  114654. * @param position The position of the spot light in the scene
  114655. * @param direction The direction of the light in the scene
  114656. * @param angle The cone angle of the light in Radians
  114657. * @param exponent The light decay speed with the distance from the emission spot
  114658. * @param scene The scene the lights belongs to
  114659. */
  114660. constructor(name: string, position: Vector3, direction: Vector3, angle: number, exponent: number, scene: Scene);
  114661. /**
  114662. * Returns the string "SpotLight".
  114663. * @returns the class name
  114664. */
  114665. getClassName(): string;
  114666. /**
  114667. * Returns the integer 2.
  114668. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  114669. */
  114670. getTypeID(): number;
  114671. /**
  114672. * Overrides the direction setter to recompute the projection texture view light Matrix.
  114673. */
  114674. protected _setDirection(value: Vector3): void;
  114675. /**
  114676. * Overrides the position setter to recompute the projection texture view light Matrix.
  114677. */
  114678. protected _setPosition(value: Vector3): void;
  114679. /**
  114680. * 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.
  114681. * Returns the SpotLight.
  114682. */
  114683. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  114684. protected _computeProjectionTextureViewLightMatrix(): void;
  114685. protected _computeProjectionTextureProjectionLightMatrix(): void;
  114686. /**
  114687. * Main function for light texture projection matrix computing.
  114688. */
  114689. protected _computeProjectionTextureMatrix(): void;
  114690. protected _buildUniformLayout(): void;
  114691. private _computeAngleValues;
  114692. /**
  114693. * Sets the passed Effect object with the SpotLight transfomed position (or position if not parented) and normalized direction.
  114694. * @param effect The effect to update
  114695. * @param lightIndex The index of the light in the effect to update
  114696. * @returns The spot light
  114697. */
  114698. transferToEffect(effect: Effect, lightIndex: string): SpotLight;
  114699. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  114700. /**
  114701. * Disposes the light and the associated resources.
  114702. */
  114703. dispose(): void;
  114704. /**
  114705. * Prepares the list of defines specific to the light type.
  114706. * @param defines the list of defines
  114707. * @param lightIndex defines the index of the light for the effect
  114708. */
  114709. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  114710. }
  114711. }
  114712. declare module BABYLON {
  114713. /**
  114714. * Gizmo that enables viewing a light
  114715. */
  114716. export class LightGizmo extends Gizmo {
  114717. private _lightMesh;
  114718. private _material;
  114719. private _cachedPosition;
  114720. private _cachedForward;
  114721. private _attachedMeshParent;
  114722. /**
  114723. * Creates a LightGizmo
  114724. * @param gizmoLayer The utility layer the gizmo will be added to
  114725. */
  114726. constructor(gizmoLayer?: UtilityLayerRenderer);
  114727. private _light;
  114728. /**
  114729. * The light that the gizmo is attached to
  114730. */
  114731. light: Nullable<Light>;
  114732. /**
  114733. * Gets the material used to render the light gizmo
  114734. */
  114735. readonly material: StandardMaterial;
  114736. /**
  114737. * @hidden
  114738. * Updates the gizmo to match the attached mesh's position/rotation
  114739. */
  114740. protected _update(): void;
  114741. private static _Scale;
  114742. /**
  114743. * Creates the lines for a light mesh
  114744. */
  114745. private static _CreateLightLines;
  114746. /**
  114747. * Disposes of the light gizmo
  114748. */
  114749. dispose(): void;
  114750. private static _CreateHemisphericLightMesh;
  114751. private static _CreatePointLightMesh;
  114752. private static _CreateSpotLightMesh;
  114753. private static _CreateDirectionalLightMesh;
  114754. }
  114755. }
  114756. declare module BABYLON {
  114757. /** @hidden */
  114758. export var backgroundFragmentDeclaration: {
  114759. name: string;
  114760. shader: string;
  114761. };
  114762. }
  114763. declare module BABYLON {
  114764. /** @hidden */
  114765. export var backgroundUboDeclaration: {
  114766. name: string;
  114767. shader: string;
  114768. };
  114769. }
  114770. declare module BABYLON {
  114771. /** @hidden */
  114772. export var backgroundPixelShader: {
  114773. name: string;
  114774. shader: string;
  114775. };
  114776. }
  114777. declare module BABYLON {
  114778. /** @hidden */
  114779. export var backgroundVertexDeclaration: {
  114780. name: string;
  114781. shader: string;
  114782. };
  114783. }
  114784. declare module BABYLON {
  114785. /** @hidden */
  114786. export var backgroundVertexShader: {
  114787. name: string;
  114788. shader: string;
  114789. };
  114790. }
  114791. declare module BABYLON {
  114792. /**
  114793. * Background material used to create an efficient environement around your scene.
  114794. */
  114795. export class BackgroundMaterial extends PushMaterial {
  114796. /**
  114797. * Standard reflectance value at parallel view angle.
  114798. */
  114799. static StandardReflectance0: number;
  114800. /**
  114801. * Standard reflectance value at grazing angle.
  114802. */
  114803. static StandardReflectance90: number;
  114804. protected _primaryColor: Color3;
  114805. /**
  114806. * Key light Color (multiply against the environement texture)
  114807. */
  114808. primaryColor: Color3;
  114809. protected __perceptualColor: Nullable<Color3>;
  114810. /**
  114811. * Experimental Internal Use Only.
  114812. *
  114813. * Key light Color in "perceptual value" meaning the color you would like to see on screen.
  114814. * This acts as a helper to set the primary color to a more "human friendly" value.
  114815. * Conversion to linear space as well as exposure and tone mapping correction will be applied to keep the
  114816. * output color as close as possible from the chosen value.
  114817. * (This does not account for contrast color grading and color curves as they are considered post effect and not directly
  114818. * part of lighting setup.)
  114819. */
  114820. _perceptualColor: Nullable<Color3>;
  114821. protected _primaryColorShadowLevel: float;
  114822. /**
  114823. * Defines the level of the shadows (dark area of the reflection map) in order to help scaling the colors.
  114824. * The color opposite to the primary color is used at the level chosen to define what the black area would look.
  114825. */
  114826. primaryColorShadowLevel: float;
  114827. protected _primaryColorHighlightLevel: float;
  114828. /**
  114829. * Defines the level of the highliights (highlight area of the reflection map) in order to help scaling the colors.
  114830. * The primary color is used at the level chosen to define what the white area would look.
  114831. */
  114832. primaryColorHighlightLevel: float;
  114833. protected _reflectionTexture: Nullable<BaseTexture>;
  114834. /**
  114835. * Reflection Texture used in the material.
  114836. * Should be author in a specific way for the best result (refer to the documentation).
  114837. */
  114838. reflectionTexture: Nullable<BaseTexture>;
  114839. protected _reflectionBlur: float;
  114840. /**
  114841. * Reflection Texture level of blur.
  114842. *
  114843. * Can be use to reuse an existing HDR Texture and target a specific LOD to prevent authoring the
  114844. * texture twice.
  114845. */
  114846. reflectionBlur: float;
  114847. protected _diffuseTexture: Nullable<BaseTexture>;
  114848. /**
  114849. * Diffuse Texture used in the material.
  114850. * Should be author in a specific way for the best result (refer to the documentation).
  114851. */
  114852. diffuseTexture: Nullable<BaseTexture>;
  114853. protected _shadowLights: Nullable<IShadowLight[]>;
  114854. /**
  114855. * Specify the list of lights casting shadow on the material.
  114856. * All scene shadow lights will be included if null.
  114857. */
  114858. shadowLights: Nullable<IShadowLight[]>;
  114859. protected _shadowLevel: float;
  114860. /**
  114861. * Helps adjusting the shadow to a softer level if required.
  114862. * 0 means black shadows and 1 means no shadows.
  114863. */
  114864. shadowLevel: float;
  114865. protected _sceneCenter: Vector3;
  114866. /**
  114867. * In case of opacity Fresnel or reflection falloff, this is use as a scene center.
  114868. * It is usually zero but might be interesting to modify according to your setup.
  114869. */
  114870. sceneCenter: Vector3;
  114871. protected _opacityFresnel: boolean;
  114872. /**
  114873. * This helps specifying that the material is falling off to the sky box at grazing angle.
  114874. * This helps ensuring a nice transition when the camera goes under the ground.
  114875. */
  114876. opacityFresnel: boolean;
  114877. protected _reflectionFresnel: boolean;
  114878. /**
  114879. * This helps specifying that the material is falling off from diffuse to the reflection texture at grazing angle.
  114880. * This helps adding a mirror texture on the ground.
  114881. */
  114882. reflectionFresnel: boolean;
  114883. protected _reflectionFalloffDistance: number;
  114884. /**
  114885. * This helps specifying the falloff radius off the reflection texture from the sceneCenter.
  114886. * This helps adding a nice falloff effect to the reflection if used as a mirror for instance.
  114887. */
  114888. reflectionFalloffDistance: number;
  114889. protected _reflectionAmount: number;
  114890. /**
  114891. * This specifies the weight of the reflection against the background in case of reflection Fresnel.
  114892. */
  114893. reflectionAmount: number;
  114894. protected _reflectionReflectance0: number;
  114895. /**
  114896. * This specifies the weight of the reflection at grazing angle.
  114897. */
  114898. reflectionReflectance0: number;
  114899. protected _reflectionReflectance90: number;
  114900. /**
  114901. * This specifies the weight of the reflection at a perpendicular point of view.
  114902. */
  114903. reflectionReflectance90: number;
  114904. /**
  114905. * Sets the reflection reflectance fresnel values according to the default standard
  114906. * empirically know to work well :-)
  114907. */
  114908. reflectionStandardFresnelWeight: number;
  114909. protected _useRGBColor: boolean;
  114910. /**
  114911. * Helps to directly use the maps channels instead of their level.
  114912. */
  114913. useRGBColor: boolean;
  114914. protected _enableNoise: boolean;
  114915. /**
  114916. * This helps reducing the banding effect that could occur on the background.
  114917. */
  114918. enableNoise: boolean;
  114919. /**
  114920. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  114921. * Best used when trying to implement visual zoom effects like fish-eye or binoculars while not adjusting camera fov.
  114922. * Recommended to be keep at 1.0 except for special cases.
  114923. */
  114924. fovMultiplier: number;
  114925. private _fovMultiplier;
  114926. /**
  114927. * Enable the FOV adjustment feature controlled by fovMultiplier.
  114928. */
  114929. useEquirectangularFOV: boolean;
  114930. private _maxSimultaneousLights;
  114931. /**
  114932. * Number of Simultaneous lights allowed on the material.
  114933. */
  114934. maxSimultaneousLights: int;
  114935. /**
  114936. * Default configuration related to image processing available in the Background Material.
  114937. */
  114938. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  114939. /**
  114940. * Keep track of the image processing observer to allow dispose and replace.
  114941. */
  114942. private _imageProcessingObserver;
  114943. /**
  114944. * Attaches a new image processing configuration to the PBR Material.
  114945. * @param configuration (if null the scene configuration will be use)
  114946. */
  114947. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  114948. /**
  114949. * Gets the image processing configuration used either in this material.
  114950. */
  114951. /**
  114952. * Sets the Default image processing configuration used either in the this material.
  114953. *
  114954. * If sets to null, the scene one is in use.
  114955. */
  114956. imageProcessingConfiguration: Nullable<ImageProcessingConfiguration>;
  114957. /**
  114958. * Gets wether the color curves effect is enabled.
  114959. */
  114960. /**
  114961. * Sets wether the color curves effect is enabled.
  114962. */
  114963. cameraColorCurvesEnabled: boolean;
  114964. /**
  114965. * Gets wether the color grading effect is enabled.
  114966. */
  114967. /**
  114968. * Gets wether the color grading effect is enabled.
  114969. */
  114970. cameraColorGradingEnabled: boolean;
  114971. /**
  114972. * Gets wether tonemapping is enabled or not.
  114973. */
  114974. /**
  114975. * Sets wether tonemapping is enabled or not
  114976. */
  114977. cameraToneMappingEnabled: boolean;
  114978. /**
  114979. * The camera exposure used on this material.
  114980. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  114981. * This corresponds to a photographic exposure.
  114982. */
  114983. /**
  114984. * The camera exposure used on this material.
  114985. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  114986. * This corresponds to a photographic exposure.
  114987. */
  114988. cameraExposure: float;
  114989. /**
  114990. * Gets The camera contrast used on this material.
  114991. */
  114992. /**
  114993. * Sets The camera contrast used on this material.
  114994. */
  114995. cameraContrast: float;
  114996. /**
  114997. * Gets the Color Grading 2D Lookup Texture.
  114998. */
  114999. /**
  115000. * Sets the Color Grading 2D Lookup Texture.
  115001. */
  115002. cameraColorGradingTexture: Nullable<BaseTexture>;
  115003. /**
  115004. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  115005. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  115006. * 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;
  115007. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  115008. */
  115009. /**
  115010. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  115011. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  115012. * 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;
  115013. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  115014. */
  115015. cameraColorCurves: Nullable<ColorCurves>;
  115016. /**
  115017. * Due to a bug in iOS10, video tags (which are using the background material) are in BGR and not RGB.
  115018. * Setting this flag to true (not done automatically!) will convert it back to RGB.
  115019. */
  115020. switchToBGR: boolean;
  115021. private _renderTargets;
  115022. private _reflectionControls;
  115023. private _white;
  115024. private _primaryShadowColor;
  115025. private _primaryHighlightColor;
  115026. /**
  115027. * Instantiates a Background Material in the given scene
  115028. * @param name The friendly name of the material
  115029. * @param scene The scene to add the material to
  115030. */
  115031. constructor(name: string, scene: Scene);
  115032. /**
  115033. * Gets a boolean indicating that current material needs to register RTT
  115034. */
  115035. readonly hasRenderTargetTextures: boolean;
  115036. /**
  115037. * The entire material has been created in order to prevent overdraw.
  115038. * @returns false
  115039. */
  115040. needAlphaTesting(): boolean;
  115041. /**
  115042. * The entire material has been created in order to prevent overdraw.
  115043. * @returns true if blending is enable
  115044. */
  115045. needAlphaBlending(): boolean;
  115046. /**
  115047. * Checks wether the material is ready to be rendered for a given mesh.
  115048. * @param mesh The mesh to render
  115049. * @param subMesh The submesh to check against
  115050. * @param useInstances Specify wether or not the material is used with instances
  115051. * @returns true if all the dependencies are ready (Textures, Effects...)
  115052. */
  115053. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  115054. /**
  115055. * Compute the primary color according to the chosen perceptual color.
  115056. */
  115057. private _computePrimaryColorFromPerceptualColor;
  115058. /**
  115059. * Compute the highlights and shadow colors according to their chosen levels.
  115060. */
  115061. private _computePrimaryColors;
  115062. /**
  115063. * Build the uniform buffer used in the material.
  115064. */
  115065. buildUniformLayout(): void;
  115066. /**
  115067. * Unbind the material.
  115068. */
  115069. unbind(): void;
  115070. /**
  115071. * Bind only the world matrix to the material.
  115072. * @param world The world matrix to bind.
  115073. */
  115074. bindOnlyWorldMatrix(world: Matrix): void;
  115075. /**
  115076. * Bind the material for a dedicated submeh (every used meshes will be considered opaque).
  115077. * @param world The world matrix to bind.
  115078. * @param subMesh The submesh to bind for.
  115079. */
  115080. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  115081. /**
  115082. * Checks to see if a texture is used in the material.
  115083. * @param texture - Base texture to use.
  115084. * @returns - Boolean specifying if a texture is used in the material.
  115085. */
  115086. hasTexture(texture: BaseTexture): boolean;
  115087. /**
  115088. * Dispose the material.
  115089. * @param forceDisposeEffect Force disposal of the associated effect.
  115090. * @param forceDisposeTextures Force disposal of the associated textures.
  115091. */
  115092. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  115093. /**
  115094. * Clones the material.
  115095. * @param name The cloned name.
  115096. * @returns The cloned material.
  115097. */
  115098. clone(name: string): BackgroundMaterial;
  115099. /**
  115100. * Serializes the current material to its JSON representation.
  115101. * @returns The JSON representation.
  115102. */
  115103. serialize(): any;
  115104. /**
  115105. * Gets the class name of the material
  115106. * @returns "BackgroundMaterial"
  115107. */
  115108. getClassName(): string;
  115109. /**
  115110. * Parse a JSON input to create back a background material.
  115111. * @param source The JSON data to parse
  115112. * @param scene The scene to create the parsed material in
  115113. * @param rootUrl The root url of the assets the material depends upon
  115114. * @returns the instantiated BackgroundMaterial.
  115115. */
  115116. static Parse(source: any, scene: Scene, rootUrl: string): BackgroundMaterial;
  115117. }
  115118. }
  115119. declare module BABYLON {
  115120. /**
  115121. * Represents the different options available during the creation of
  115122. * a Environment helper.
  115123. *
  115124. * This can control the default ground, skybox and image processing setup of your scene.
  115125. */
  115126. export interface IEnvironmentHelperOptions {
  115127. /**
  115128. * Specifies wether or not to create a ground.
  115129. * True by default.
  115130. */
  115131. createGround: boolean;
  115132. /**
  115133. * Specifies the ground size.
  115134. * 15 by default.
  115135. */
  115136. groundSize: number;
  115137. /**
  115138. * The texture used on the ground for the main color.
  115139. * Comes from the BabylonJS CDN by default.
  115140. *
  115141. * Remarks: Can be either a texture or a url.
  115142. */
  115143. groundTexture: string | BaseTexture;
  115144. /**
  115145. * The color mixed in the ground texture by default.
  115146. * BabylonJS clearColor by default.
  115147. */
  115148. groundColor: Color3;
  115149. /**
  115150. * Specifies the ground opacity.
  115151. * 1 by default.
  115152. */
  115153. groundOpacity: number;
  115154. /**
  115155. * Enables the ground to receive shadows.
  115156. * True by default.
  115157. */
  115158. enableGroundShadow: boolean;
  115159. /**
  115160. * Helps preventing the shadow to be fully black on the ground.
  115161. * 0.5 by default.
  115162. */
  115163. groundShadowLevel: number;
  115164. /**
  115165. * Creates a mirror texture attach to the ground.
  115166. * false by default.
  115167. */
  115168. enableGroundMirror: boolean;
  115169. /**
  115170. * Specifies the ground mirror size ratio.
  115171. * 0.3 by default as the default kernel is 64.
  115172. */
  115173. groundMirrorSizeRatio: number;
  115174. /**
  115175. * Specifies the ground mirror blur kernel size.
  115176. * 64 by default.
  115177. */
  115178. groundMirrorBlurKernel: number;
  115179. /**
  115180. * Specifies the ground mirror visibility amount.
  115181. * 1 by default
  115182. */
  115183. groundMirrorAmount: number;
  115184. /**
  115185. * Specifies the ground mirror reflectance weight.
  115186. * This uses the standard weight of the background material to setup the fresnel effect
  115187. * of the mirror.
  115188. * 1 by default.
  115189. */
  115190. groundMirrorFresnelWeight: number;
  115191. /**
  115192. * Specifies the ground mirror Falloff distance.
  115193. * This can helps reducing the size of the reflection.
  115194. * 0 by Default.
  115195. */
  115196. groundMirrorFallOffDistance: number;
  115197. /**
  115198. * Specifies the ground mirror texture type.
  115199. * Unsigned Int by Default.
  115200. */
  115201. groundMirrorTextureType: number;
  115202. /**
  115203. * Specifies a bias applied to the ground vertical position to prevent z-fighting with
  115204. * the shown objects.
  115205. */
  115206. groundYBias: number;
  115207. /**
  115208. * Specifies wether or not to create a skybox.
  115209. * True by default.
  115210. */
  115211. createSkybox: boolean;
  115212. /**
  115213. * Specifies the skybox size.
  115214. * 20 by default.
  115215. */
  115216. skyboxSize: number;
  115217. /**
  115218. * The texture used on the skybox for the main color.
  115219. * Comes from the BabylonJS CDN by default.
  115220. *
  115221. * Remarks: Can be either a texture or a url.
  115222. */
  115223. skyboxTexture: string | BaseTexture;
  115224. /**
  115225. * The color mixed in the skybox texture by default.
  115226. * BabylonJS clearColor by default.
  115227. */
  115228. skyboxColor: Color3;
  115229. /**
  115230. * The background rotation around the Y axis of the scene.
  115231. * This helps aligning the key lights of your scene with the background.
  115232. * 0 by default.
  115233. */
  115234. backgroundYRotation: number;
  115235. /**
  115236. * Compute automatically the size of the elements to best fit with the scene.
  115237. */
  115238. sizeAuto: boolean;
  115239. /**
  115240. * Default position of the rootMesh if autoSize is not true.
  115241. */
  115242. rootPosition: Vector3;
  115243. /**
  115244. * Sets up the image processing in the scene.
  115245. * true by default.
  115246. */
  115247. setupImageProcessing: boolean;
  115248. /**
  115249. * The texture used as your environment texture in the scene.
  115250. * Comes from the BabylonJS CDN by default and in use if setupImageProcessing is true.
  115251. *
  115252. * Remarks: Can be either a texture or a url.
  115253. */
  115254. environmentTexture: string | BaseTexture;
  115255. /**
  115256. * The value of the exposure to apply to the scene.
  115257. * 0.6 by default if setupImageProcessing is true.
  115258. */
  115259. cameraExposure: number;
  115260. /**
  115261. * The value of the contrast to apply to the scene.
  115262. * 1.6 by default if setupImageProcessing is true.
  115263. */
  115264. cameraContrast: number;
  115265. /**
  115266. * Specifies wether or not tonemapping should be enabled in the scene.
  115267. * true by default if setupImageProcessing is true.
  115268. */
  115269. toneMappingEnabled: boolean;
  115270. }
  115271. /**
  115272. * The Environment helper class can be used to add a fully featuread none expensive background to your scene.
  115273. * It includes by default a skybox and a ground relying on the BackgroundMaterial.
  115274. * It also helps with the default setup of your imageProcessing configuration.
  115275. */
  115276. export class EnvironmentHelper {
  115277. /**
  115278. * Default ground texture URL.
  115279. */
  115280. private static _groundTextureCDNUrl;
  115281. /**
  115282. * Default skybox texture URL.
  115283. */
  115284. private static _skyboxTextureCDNUrl;
  115285. /**
  115286. * Default environment texture URL.
  115287. */
  115288. private static _environmentTextureCDNUrl;
  115289. /**
  115290. * Creates the default options for the helper.
  115291. */
  115292. private static _getDefaultOptions;
  115293. private _rootMesh;
  115294. /**
  115295. * Gets the root mesh created by the helper.
  115296. */
  115297. readonly rootMesh: Mesh;
  115298. private _skybox;
  115299. /**
  115300. * Gets the skybox created by the helper.
  115301. */
  115302. readonly skybox: Nullable<Mesh>;
  115303. private _skyboxTexture;
  115304. /**
  115305. * Gets the skybox texture created by the helper.
  115306. */
  115307. readonly skyboxTexture: Nullable<BaseTexture>;
  115308. private _skyboxMaterial;
  115309. /**
  115310. * Gets the skybox material created by the helper.
  115311. */
  115312. readonly skyboxMaterial: Nullable<BackgroundMaterial>;
  115313. private _ground;
  115314. /**
  115315. * Gets the ground mesh created by the helper.
  115316. */
  115317. readonly ground: Nullable<Mesh>;
  115318. private _groundTexture;
  115319. /**
  115320. * Gets the ground texture created by the helper.
  115321. */
  115322. readonly groundTexture: Nullable<BaseTexture>;
  115323. private _groundMirror;
  115324. /**
  115325. * Gets the ground mirror created by the helper.
  115326. */
  115327. readonly groundMirror: Nullable<MirrorTexture>;
  115328. /**
  115329. * Gets the ground mirror render list to helps pushing the meshes
  115330. * you wish in the ground reflection.
  115331. */
  115332. readonly groundMirrorRenderList: Nullable<AbstractMesh[]>;
  115333. private _groundMaterial;
  115334. /**
  115335. * Gets the ground material created by the helper.
  115336. */
  115337. readonly groundMaterial: Nullable<BackgroundMaterial>;
  115338. /**
  115339. * Stores the creation options.
  115340. */
  115341. private readonly _scene;
  115342. private _options;
  115343. /**
  115344. * This observable will be notified with any error during the creation of the environment,
  115345. * mainly texture creation errors.
  115346. */
  115347. onErrorObservable: Observable<{
  115348. message?: string;
  115349. exception?: any;
  115350. }>;
  115351. /**
  115352. * constructor
  115353. * @param options Defines the options we want to customize the helper
  115354. * @param scene The scene to add the material to
  115355. */
  115356. constructor(options: Partial<IEnvironmentHelperOptions>, scene: Scene);
  115357. /**
  115358. * Updates the background according to the new options
  115359. * @param options
  115360. */
  115361. updateOptions(options: Partial<IEnvironmentHelperOptions>): void;
  115362. /**
  115363. * Sets the primary color of all the available elements.
  115364. * @param color the main color to affect to the ground and the background
  115365. */
  115366. setMainColor(color: Color3): void;
  115367. /**
  115368. * Setup the image processing according to the specified options.
  115369. */
  115370. private _setupImageProcessing;
  115371. /**
  115372. * Setup the environment texture according to the specified options.
  115373. */
  115374. private _setupEnvironmentTexture;
  115375. /**
  115376. * Setup the background according to the specified options.
  115377. */
  115378. private _setupBackground;
  115379. /**
  115380. * Get the scene sizes according to the setup.
  115381. */
  115382. private _getSceneSize;
  115383. /**
  115384. * Setup the ground according to the specified options.
  115385. */
  115386. private _setupGround;
  115387. /**
  115388. * Setup the ground material according to the specified options.
  115389. */
  115390. private _setupGroundMaterial;
  115391. /**
  115392. * Setup the ground diffuse texture according to the specified options.
  115393. */
  115394. private _setupGroundDiffuseTexture;
  115395. /**
  115396. * Setup the ground mirror texture according to the specified options.
  115397. */
  115398. private _setupGroundMirrorTexture;
  115399. /**
  115400. * Setup the ground to receive the mirror texture.
  115401. */
  115402. private _setupMirrorInGroundMaterial;
  115403. /**
  115404. * Setup the skybox according to the specified options.
  115405. */
  115406. private _setupSkybox;
  115407. /**
  115408. * Setup the skybox material according to the specified options.
  115409. */
  115410. private _setupSkyboxMaterial;
  115411. /**
  115412. * Setup the skybox reflection texture according to the specified options.
  115413. */
  115414. private _setupSkyboxReflectionTexture;
  115415. private _errorHandler;
  115416. /**
  115417. * Dispose all the elements created by the Helper.
  115418. */
  115419. dispose(): void;
  115420. }
  115421. }
  115422. declare module BABYLON {
  115423. /**
  115424. * Display a 360 degree photo on an approximately spherical surface, useful for VR applications or skyboxes.
  115425. * As a subclass of TransformNode, this allow parenting to the camera with different locations in the scene.
  115426. * This class achieves its effect with a Texture and a correctly configured BackgroundMaterial on an inverted sphere.
  115427. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  115428. */
  115429. export class PhotoDome extends TransformNode {
  115430. /**
  115431. * Define the image as a Monoscopic panoramic 360 image.
  115432. */
  115433. static readonly MODE_MONOSCOPIC: number;
  115434. /**
  115435. * Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  115436. */
  115437. static readonly MODE_TOPBOTTOM: number;
  115438. /**
  115439. * Define the image as a Stereoscopic Side by Side panoramic 360 image.
  115440. */
  115441. static readonly MODE_SIDEBYSIDE: number;
  115442. private _useDirectMapping;
  115443. /**
  115444. * The texture being displayed on the sphere
  115445. */
  115446. protected _photoTexture: Texture;
  115447. /**
  115448. * Gets or sets the texture being displayed on the sphere
  115449. */
  115450. photoTexture: Texture;
  115451. /**
  115452. * Observable raised when an error occured while loading the 360 image
  115453. */
  115454. onLoadErrorObservable: Observable<string>;
  115455. /**
  115456. * The skybox material
  115457. */
  115458. protected _material: BackgroundMaterial;
  115459. /**
  115460. * The surface used for the skybox
  115461. */
  115462. protected _mesh: Mesh;
  115463. /**
  115464. * Gets the mesh used for the skybox.
  115465. */
  115466. readonly mesh: Mesh;
  115467. /**
  115468. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  115469. * Also see the options.resolution property.
  115470. */
  115471. fovMultiplier: number;
  115472. private _imageMode;
  115473. /**
  115474. * Gets or set the current video mode for the video. It can be:
  115475. * * PhotoDome.MODE_MONOSCOPIC : Define the image as a Monoscopic panoramic 360 image.
  115476. * * PhotoDome.MODE_TOPBOTTOM : Define the image as a Stereoscopic TopBottom/OverUnder panoramic 360 image.
  115477. * * PhotoDome.MODE_SIDEBYSIDE : Define the image as a Stereoscopic Side by Side panoramic 360 image.
  115478. */
  115479. imageMode: number;
  115480. /**
  115481. * Create an instance of this class and pass through the parameters to the relevant classes, Texture, StandardMaterial, and Mesh.
  115482. * @param name Element's name, child elements will append suffixes for their own names.
  115483. * @param urlsOfPhoto defines the url of the photo to display
  115484. * @param options defines an object containing optional or exposed sub element properties
  115485. * @param onError defines a callback called when an error occured while loading the texture
  115486. */
  115487. constructor(name: string, urlOfPhoto: string, options: {
  115488. resolution?: number;
  115489. size?: number;
  115490. useDirectMapping?: boolean;
  115491. faceForward?: boolean;
  115492. }, scene: Scene, onError?: Nullable<(message?: string, exception?: any) => void>);
  115493. private _onBeforeCameraRenderObserver;
  115494. private _changeImageMode;
  115495. /**
  115496. * Releases resources associated with this node.
  115497. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  115498. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  115499. */
  115500. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  115501. }
  115502. }
  115503. declare module BABYLON {
  115504. /**
  115505. * Class used to host RGBD texture specific utilities
  115506. */
  115507. export class RGBDTextureTools {
  115508. /**
  115509. * Expand the RGBD Texture from RGBD to Half Float if possible.
  115510. * @param texture the texture to expand.
  115511. */
  115512. static ExpandRGBDTexture(texture: Texture): void;
  115513. }
  115514. }
  115515. declare module BABYLON {
  115516. /**
  115517. * Class used to host texture specific utilities
  115518. */
  115519. export class BRDFTextureTools {
  115520. /**
  115521. * Gets a default environment BRDF for MS-BRDF Height Correlated BRDF
  115522. * @param scene defines the hosting scene
  115523. * @returns the environment BRDF texture
  115524. */
  115525. static GetEnvironmentBRDFTexture(scene: Scene): BaseTexture;
  115526. private static _environmentBRDFBase64Texture;
  115527. }
  115528. }
  115529. declare module BABYLON {
  115530. /**
  115531. * @hidden
  115532. */
  115533. export interface IMaterialClearCoatDefines {
  115534. CLEARCOAT: boolean;
  115535. CLEARCOAT_DEFAULTIOR: boolean;
  115536. CLEARCOAT_TEXTURE: boolean;
  115537. CLEARCOAT_TEXTUREDIRECTUV: number;
  115538. CLEARCOAT_BUMP: boolean;
  115539. CLEARCOAT_BUMPDIRECTUV: number;
  115540. CLEARCOAT_TINT: boolean;
  115541. CLEARCOAT_TINT_TEXTURE: boolean;
  115542. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  115543. /** @hidden */
  115544. _areTexturesDirty: boolean;
  115545. }
  115546. /**
  115547. * Define the code related to the clear coat parameters of the pbr material.
  115548. */
  115549. export class PBRClearCoatConfiguration {
  115550. /**
  115551. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  115552. * The default fits with a polyurethane material.
  115553. */
  115554. private static readonly _DefaultIndexOfRefraction;
  115555. private _isEnabled;
  115556. /**
  115557. * Defines if the clear coat is enabled in the material.
  115558. */
  115559. isEnabled: boolean;
  115560. /**
  115561. * Defines the clear coat layer strength (between 0 and 1) it defaults to 1.
  115562. */
  115563. intensity: number;
  115564. /**
  115565. * Defines the clear coat layer roughness.
  115566. */
  115567. roughness: number;
  115568. private _indexOfRefraction;
  115569. /**
  115570. * Defines the index of refraction of the clear coat.
  115571. * This defaults to 1.5 corresponding to a 0.04 f0 or a 4% reflectance at normal incidence
  115572. * The default fits with a polyurethane material.
  115573. * Changing the default value is more performance intensive.
  115574. */
  115575. indexOfRefraction: number;
  115576. private _texture;
  115577. /**
  115578. * Stores the clear coat values in a texture.
  115579. */
  115580. texture: Nullable<BaseTexture>;
  115581. private _bumpTexture;
  115582. /**
  115583. * Define the clear coat specific bump texture.
  115584. */
  115585. bumpTexture: Nullable<BaseTexture>;
  115586. private _isTintEnabled;
  115587. /**
  115588. * Defines if the clear coat tint is enabled in the material.
  115589. */
  115590. isTintEnabled: boolean;
  115591. /**
  115592. * Defines the clear coat tint of the material.
  115593. * This is only use if tint is enabled
  115594. */
  115595. tintColor: Color3;
  115596. /**
  115597. * Defines the distance at which the tint color should be found in the
  115598. * clear coat media.
  115599. * This is only use if tint is enabled
  115600. */
  115601. tintColorAtDistance: number;
  115602. /**
  115603. * Defines the clear coat layer thickness.
  115604. * This is only use if tint is enabled
  115605. */
  115606. tintThickness: number;
  115607. private _tintTexture;
  115608. /**
  115609. * Stores the clear tint values in a texture.
  115610. * rgb is tint
  115611. * a is a thickness factor
  115612. */
  115613. tintTexture: Nullable<BaseTexture>;
  115614. /** @hidden */
  115615. private _internalMarkAllSubMeshesAsTexturesDirty;
  115616. /** @hidden */
  115617. _markAllSubMeshesAsTexturesDirty(): void;
  115618. /**
  115619. * Instantiate a new istance of clear coat configuration.
  115620. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  115621. */
  115622. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  115623. /**
  115624. * Gets wehter the submesh is ready to be used or not.
  115625. * @param defines the list of "defines" to update.
  115626. * @param scene defines the scene the material belongs to.
  115627. * @param engine defines the engine the material belongs to.
  115628. * @param disableBumpMap defines wether the material disables bump or not.
  115629. * @returns - boolean indicating that the submesh is ready or not.
  115630. */
  115631. isReadyForSubMesh(defines: IMaterialClearCoatDefines, scene: Scene, engine: Engine, disableBumpMap: boolean): boolean;
  115632. /**
  115633. * Checks to see if a texture is used in the material.
  115634. * @param defines the list of "defines" to update.
  115635. * @param scene defines the scene to the material belongs to.
  115636. */
  115637. prepareDefines(defines: IMaterialClearCoatDefines, scene: Scene): void;
  115638. /**
  115639. * Binds the material data.
  115640. * @param uniformBuffer defines the Uniform buffer to fill in.
  115641. * @param scene defines the scene the material belongs to.
  115642. * @param engine defines the engine the material belongs to.
  115643. * @param disableBumpMap defines wether the material disables bump or not.
  115644. * @param isFrozen defines wether the material is frozen or not.
  115645. * @param invertNormalMapX If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  115646. * @param invertNormalMapY If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  115647. */
  115648. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, disableBumpMap: boolean, isFrozen: boolean, invertNormalMapX: boolean, invertNormalMapY: boolean): void;
  115649. /**
  115650. * Checks to see if a texture is used in the material.
  115651. * @param texture - Base texture to use.
  115652. * @returns - Boolean specifying if a texture is used in the material.
  115653. */
  115654. hasTexture(texture: BaseTexture): boolean;
  115655. /**
  115656. * Returns an array of the actively used textures.
  115657. * @param activeTextures Array of BaseTextures
  115658. */
  115659. getActiveTextures(activeTextures: BaseTexture[]): void;
  115660. /**
  115661. * Returns the animatable textures.
  115662. * @param animatables Array of animatable textures.
  115663. */
  115664. getAnimatables(animatables: IAnimatable[]): void;
  115665. /**
  115666. * Disposes the resources of the material.
  115667. * @param forceDisposeTextures - Forces the disposal of all textures.
  115668. */
  115669. dispose(forceDisposeTextures?: boolean): void;
  115670. /**
  115671. * Get the current class name of the texture useful for serialization or dynamic coding.
  115672. * @returns "PBRClearCoatConfiguration"
  115673. */
  115674. getClassName(): string;
  115675. /**
  115676. * Add fallbacks to the effect fallbacks list.
  115677. * @param defines defines the Base texture to use.
  115678. * @param fallbacks defines the current fallback list.
  115679. * @param currentRank defines the current fallback rank.
  115680. * @returns the new fallback rank.
  115681. */
  115682. static AddFallbacks(defines: IMaterialClearCoatDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  115683. /**
  115684. * Add the required uniforms to the current list.
  115685. * @param uniforms defines the current uniform list.
  115686. */
  115687. static AddUniforms(uniforms: string[]): void;
  115688. /**
  115689. * Add the required samplers to the current list.
  115690. * @param samplers defines the current sampler list.
  115691. */
  115692. static AddSamplers(samplers: string[]): void;
  115693. /**
  115694. * Add the required uniforms to the current buffer.
  115695. * @param uniformBuffer defines the current uniform buffer.
  115696. */
  115697. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  115698. /**
  115699. * Makes a duplicate of the current configuration into another one.
  115700. * @param clearCoatConfiguration define the config where to copy the info
  115701. */
  115702. copyTo(clearCoatConfiguration: PBRClearCoatConfiguration): void;
  115703. /**
  115704. * Serializes this clear coat configuration.
  115705. * @returns - An object with the serialized config.
  115706. */
  115707. serialize(): any;
  115708. /**
  115709. * Parses a anisotropy Configuration from a serialized object.
  115710. * @param source - Serialized object.
  115711. * @param scene Defines the scene we are parsing for
  115712. * @param rootUrl Defines the rootUrl to load from
  115713. */
  115714. parse(source: any, scene: Scene, rootUrl: string): void;
  115715. }
  115716. }
  115717. declare module BABYLON {
  115718. /**
  115719. * @hidden
  115720. */
  115721. export interface IMaterialAnisotropicDefines {
  115722. ANISOTROPIC: boolean;
  115723. ANISOTROPIC_TEXTURE: boolean;
  115724. ANISOTROPIC_TEXTUREDIRECTUV: number;
  115725. MAINUV1: boolean;
  115726. _areTexturesDirty: boolean;
  115727. _needUVs: boolean;
  115728. }
  115729. /**
  115730. * Define the code related to the anisotropic parameters of the pbr material.
  115731. */
  115732. export class PBRAnisotropicConfiguration {
  115733. private _isEnabled;
  115734. /**
  115735. * Defines if the anisotropy is enabled in the material.
  115736. */
  115737. isEnabled: boolean;
  115738. /**
  115739. * Defines the anisotropy strength (between 0 and 1) it defaults to 1.
  115740. */
  115741. intensity: number;
  115742. /**
  115743. * Defines if the effect is along the tangents, bitangents or in between.
  115744. * By default, the effect is "strectching" the highlights along the tangents.
  115745. */
  115746. direction: Vector2;
  115747. private _texture;
  115748. /**
  115749. * Stores the anisotropy values in a texture.
  115750. * rg is direction (like normal from -1 to 1)
  115751. * b is a intensity
  115752. */
  115753. texture: Nullable<BaseTexture>;
  115754. /** @hidden */
  115755. private _internalMarkAllSubMeshesAsTexturesDirty;
  115756. /** @hidden */
  115757. _markAllSubMeshesAsTexturesDirty(): void;
  115758. /**
  115759. * Instantiate a new istance of anisotropy configuration.
  115760. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  115761. */
  115762. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  115763. /**
  115764. * Specifies that the submesh is ready to be used.
  115765. * @param defines the list of "defines" to update.
  115766. * @param scene defines the scene the material belongs to.
  115767. * @returns - boolean indicating that the submesh is ready or not.
  115768. */
  115769. isReadyForSubMesh(defines: IMaterialAnisotropicDefines, scene: Scene): boolean;
  115770. /**
  115771. * Checks to see if a texture is used in the material.
  115772. * @param defines the list of "defines" to update.
  115773. * @param mesh the mesh we are preparing the defines for.
  115774. * @param scene defines the scene the material belongs to.
  115775. */
  115776. prepareDefines(defines: IMaterialAnisotropicDefines, mesh: AbstractMesh, scene: Scene): void;
  115777. /**
  115778. * Binds the material data.
  115779. * @param uniformBuffer defines the Uniform buffer to fill in.
  115780. * @param scene defines the scene the material belongs to.
  115781. * @param isFrozen defines wether the material is frozen or not.
  115782. */
  115783. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  115784. /**
  115785. * Checks to see if a texture is used in the material.
  115786. * @param texture - Base texture to use.
  115787. * @returns - Boolean specifying if a texture is used in the material.
  115788. */
  115789. hasTexture(texture: BaseTexture): boolean;
  115790. /**
  115791. * Returns an array of the actively used textures.
  115792. * @param activeTextures Array of BaseTextures
  115793. */
  115794. getActiveTextures(activeTextures: BaseTexture[]): void;
  115795. /**
  115796. * Returns the animatable textures.
  115797. * @param animatables Array of animatable textures.
  115798. */
  115799. getAnimatables(animatables: IAnimatable[]): void;
  115800. /**
  115801. * Disposes the resources of the material.
  115802. * @param forceDisposeTextures - Forces the disposal of all textures.
  115803. */
  115804. dispose(forceDisposeTextures?: boolean): void;
  115805. /**
  115806. * Get the current class name of the texture useful for serialization or dynamic coding.
  115807. * @returns "PBRAnisotropicConfiguration"
  115808. */
  115809. getClassName(): string;
  115810. /**
  115811. * Add fallbacks to the effect fallbacks list.
  115812. * @param defines defines the Base texture to use.
  115813. * @param fallbacks defines the current fallback list.
  115814. * @param currentRank defines the current fallback rank.
  115815. * @returns the new fallback rank.
  115816. */
  115817. static AddFallbacks(defines: IMaterialAnisotropicDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  115818. /**
  115819. * Add the required uniforms to the current list.
  115820. * @param uniforms defines the current uniform list.
  115821. */
  115822. static AddUniforms(uniforms: string[]): void;
  115823. /**
  115824. * Add the required uniforms to the current buffer.
  115825. * @param uniformBuffer defines the current uniform buffer.
  115826. */
  115827. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  115828. /**
  115829. * Add the required samplers to the current list.
  115830. * @param samplers defines the current sampler list.
  115831. */
  115832. static AddSamplers(samplers: string[]): void;
  115833. /**
  115834. * Makes a duplicate of the current configuration into another one.
  115835. * @param anisotropicConfiguration define the config where to copy the info
  115836. */
  115837. copyTo(anisotropicConfiguration: PBRAnisotropicConfiguration): void;
  115838. /**
  115839. * Serializes this anisotropy configuration.
  115840. * @returns - An object with the serialized config.
  115841. */
  115842. serialize(): any;
  115843. /**
  115844. * Parses a anisotropy Configuration from a serialized object.
  115845. * @param source - Serialized object.
  115846. * @param scene Defines the scene we are parsing for
  115847. * @param rootUrl Defines the rootUrl to load from
  115848. */
  115849. parse(source: any, scene: Scene, rootUrl: string): void;
  115850. }
  115851. }
  115852. declare module BABYLON {
  115853. /**
  115854. * @hidden
  115855. */
  115856. export interface IMaterialBRDFDefines {
  115857. BRDF_V_HEIGHT_CORRELATED: boolean;
  115858. MS_BRDF_ENERGY_CONSERVATION: boolean;
  115859. SPHERICAL_HARMONICS: boolean;
  115860. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  115861. /** @hidden */
  115862. _areMiscDirty: boolean;
  115863. }
  115864. /**
  115865. * Define the code related to the BRDF parameters of the pbr material.
  115866. */
  115867. export class PBRBRDFConfiguration {
  115868. /**
  115869. * Default value used for the energy conservation.
  115870. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  115871. */
  115872. static DEFAULT_USE_ENERGY_CONSERVATION: boolean;
  115873. /**
  115874. * Default value used for the Smith Visibility Height Correlated mode.
  115875. * This should only be changed to adapt to the type of texture in scene.environmentBRDFTexture.
  115876. */
  115877. static DEFAULT_USE_SMITH_VISIBILITY_HEIGHT_CORRELATED: boolean;
  115878. /**
  115879. * Default value used for the IBL diffuse part.
  115880. * This can help switching back to the polynomials mode globally which is a tiny bit
  115881. * less GPU intensive at the drawback of a lower quality.
  115882. */
  115883. static DEFAULT_USE_SPHERICAL_HARMONICS: boolean;
  115884. /**
  115885. * Default value used for activating energy conservation for the specular workflow.
  115886. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  115887. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  115888. */
  115889. static DEFAULT_USE_SPECULAR_GLOSSINESS_INPUT_ENERGY_CONSERVATION: boolean;
  115890. private _useEnergyConservation;
  115891. /**
  115892. * Defines if the material uses energy conservation.
  115893. */
  115894. useEnergyConservation: boolean;
  115895. private _useSmithVisibilityHeightCorrelated;
  115896. /**
  115897. * LEGACY Mode set to false
  115898. * Defines if the material uses height smith correlated visibility term.
  115899. * If you intent to not use our default BRDF, you need to load a separate BRDF Texture for the PBR
  115900. * You can either load https://assets.babylonjs.com/environments/uncorrelatedBRDF.png
  115901. * or https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds to have more precision
  115902. * Not relying on height correlated will also disable energy conservation.
  115903. */
  115904. useSmithVisibilityHeightCorrelated: boolean;
  115905. private _useSphericalHarmonics;
  115906. /**
  115907. * LEGACY Mode set to false
  115908. * Defines if the material uses spherical harmonics vs spherical polynomials for the
  115909. * diffuse part of the IBL.
  115910. * The harmonics despite a tiny bigger cost has been proven to provide closer results
  115911. * to the ground truth.
  115912. */
  115913. useSphericalHarmonics: boolean;
  115914. private _useSpecularGlossinessInputEnergyConservation;
  115915. /**
  115916. * Defines if the material uses energy conservation, when the specular workflow is active.
  115917. * If activated, the albedo color is multiplied with (1. - maxChannel(specular color)).
  115918. * If deactivated, a material is only physically plausible, when (albedo color + specular color) < 1.
  115919. * In the deactivated case, the material author has to ensure energy conservation, for a physically plausible rendering.
  115920. */
  115921. useSpecularGlossinessInputEnergyConservation: boolean;
  115922. /** @hidden */
  115923. private _internalMarkAllSubMeshesAsMiscDirty;
  115924. /** @hidden */
  115925. _markAllSubMeshesAsMiscDirty(): void;
  115926. /**
  115927. * Instantiate a new istance of clear coat configuration.
  115928. * @param markAllSubMeshesAsMiscDirty Callback to flag the material to dirty
  115929. */
  115930. constructor(markAllSubMeshesAsMiscDirty: () => void);
  115931. /**
  115932. * Checks to see if a texture is used in the material.
  115933. * @param defines the list of "defines" to update.
  115934. */
  115935. prepareDefines(defines: IMaterialBRDFDefines): void;
  115936. /**
  115937. * Get the current class name of the texture useful for serialization or dynamic coding.
  115938. * @returns "PBRClearCoatConfiguration"
  115939. */
  115940. getClassName(): string;
  115941. /**
  115942. * Makes a duplicate of the current configuration into another one.
  115943. * @param brdfConfiguration define the config where to copy the info
  115944. */
  115945. copyTo(brdfConfiguration: PBRBRDFConfiguration): void;
  115946. /**
  115947. * Serializes this BRDF configuration.
  115948. * @returns - An object with the serialized config.
  115949. */
  115950. serialize(): any;
  115951. /**
  115952. * Parses a anisotropy Configuration from a serialized object.
  115953. * @param source - Serialized object.
  115954. * @param scene Defines the scene we are parsing for
  115955. * @param rootUrl Defines the rootUrl to load from
  115956. */
  115957. parse(source: any, scene: Scene, rootUrl: string): void;
  115958. }
  115959. }
  115960. declare module BABYLON {
  115961. /**
  115962. * @hidden
  115963. */
  115964. export interface IMaterialSheenDefines {
  115965. SHEEN: boolean;
  115966. SHEEN_TEXTURE: boolean;
  115967. SHEEN_TEXTUREDIRECTUV: number;
  115968. SHEEN_LINKWITHALBEDO: boolean;
  115969. /** @hidden */
  115970. _areTexturesDirty: boolean;
  115971. }
  115972. /**
  115973. * Define the code related to the Sheen parameters of the pbr material.
  115974. */
  115975. export class PBRSheenConfiguration {
  115976. private _isEnabled;
  115977. /**
  115978. * Defines if the material uses sheen.
  115979. */
  115980. isEnabled: boolean;
  115981. private _linkSheenWithAlbedo;
  115982. /**
  115983. * Defines if the sheen is linked to the sheen color.
  115984. */
  115985. linkSheenWithAlbedo: boolean;
  115986. /**
  115987. * Defines the sheen intensity.
  115988. */
  115989. intensity: number;
  115990. /**
  115991. * Defines the sheen color.
  115992. */
  115993. color: Color3;
  115994. private _texture;
  115995. /**
  115996. * Stores the sheen tint values in a texture.
  115997. * rgb is tint
  115998. * a is a intensity
  115999. */
  116000. texture: Nullable<BaseTexture>;
  116001. /** @hidden */
  116002. private _internalMarkAllSubMeshesAsTexturesDirty;
  116003. /** @hidden */
  116004. _markAllSubMeshesAsTexturesDirty(): void;
  116005. /**
  116006. * Instantiate a new istance of clear coat configuration.
  116007. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  116008. */
  116009. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  116010. /**
  116011. * Specifies that the submesh is ready to be used.
  116012. * @param defines the list of "defines" to update.
  116013. * @param scene defines the scene the material belongs to.
  116014. * @returns - boolean indicating that the submesh is ready or not.
  116015. */
  116016. isReadyForSubMesh(defines: IMaterialSheenDefines, scene: Scene): boolean;
  116017. /**
  116018. * Checks to see if a texture is used in the material.
  116019. * @param defines the list of "defines" to update.
  116020. * @param scene defines the scene the material belongs to.
  116021. */
  116022. prepareDefines(defines: IMaterialSheenDefines, scene: Scene): void;
  116023. /**
  116024. * Binds the material data.
  116025. * @param uniformBuffer defines the Uniform buffer to fill in.
  116026. * @param scene defines the scene the material belongs to.
  116027. * @param isFrozen defines wether the material is frozen or not.
  116028. */
  116029. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, isFrozen: boolean): void;
  116030. /**
  116031. * Checks to see if a texture is used in the material.
  116032. * @param texture - Base texture to use.
  116033. * @returns - Boolean specifying if a texture is used in the material.
  116034. */
  116035. hasTexture(texture: BaseTexture): boolean;
  116036. /**
  116037. * Returns an array of the actively used textures.
  116038. * @param activeTextures Array of BaseTextures
  116039. */
  116040. getActiveTextures(activeTextures: BaseTexture[]): void;
  116041. /**
  116042. * Returns the animatable textures.
  116043. * @param animatables Array of animatable textures.
  116044. */
  116045. getAnimatables(animatables: IAnimatable[]): void;
  116046. /**
  116047. * Disposes the resources of the material.
  116048. * @param forceDisposeTextures - Forces the disposal of all textures.
  116049. */
  116050. dispose(forceDisposeTextures?: boolean): void;
  116051. /**
  116052. * Get the current class name of the texture useful for serialization or dynamic coding.
  116053. * @returns "PBRSheenConfiguration"
  116054. */
  116055. getClassName(): string;
  116056. /**
  116057. * Add fallbacks to the effect fallbacks list.
  116058. * @param defines defines the Base texture to use.
  116059. * @param fallbacks defines the current fallback list.
  116060. * @param currentRank defines the current fallback rank.
  116061. * @returns the new fallback rank.
  116062. */
  116063. static AddFallbacks(defines: IMaterialSheenDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  116064. /**
  116065. * Add the required uniforms to the current list.
  116066. * @param uniforms defines the current uniform list.
  116067. */
  116068. static AddUniforms(uniforms: string[]): void;
  116069. /**
  116070. * Add the required uniforms to the current buffer.
  116071. * @param uniformBuffer defines the current uniform buffer.
  116072. */
  116073. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  116074. /**
  116075. * Add the required samplers to the current list.
  116076. * @param samplers defines the current sampler list.
  116077. */
  116078. static AddSamplers(samplers: string[]): void;
  116079. /**
  116080. * Makes a duplicate of the current configuration into another one.
  116081. * @param sheenConfiguration define the config where to copy the info
  116082. */
  116083. copyTo(sheenConfiguration: PBRSheenConfiguration): void;
  116084. /**
  116085. * Serializes this BRDF configuration.
  116086. * @returns - An object with the serialized config.
  116087. */
  116088. serialize(): any;
  116089. /**
  116090. * Parses a anisotropy Configuration from a serialized object.
  116091. * @param source - Serialized object.
  116092. * @param scene Defines the scene we are parsing for
  116093. * @param rootUrl Defines the rootUrl to load from
  116094. */
  116095. parse(source: any, scene: Scene, rootUrl: string): void;
  116096. }
  116097. }
  116098. declare module BABYLON {
  116099. /**
  116100. * @hidden
  116101. */
  116102. export interface IMaterialSubSurfaceDefines {
  116103. SUBSURFACE: boolean;
  116104. SS_REFRACTION: boolean;
  116105. SS_TRANSLUCENCY: boolean;
  116106. SS_SCATERRING: boolean;
  116107. SS_THICKNESSANDMASK_TEXTURE: boolean;
  116108. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  116109. SS_REFRACTIONMAP_3D: boolean;
  116110. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  116111. SS_LODINREFRACTIONALPHA: boolean;
  116112. SS_GAMMAREFRACTION: boolean;
  116113. SS_RGBDREFRACTION: boolean;
  116114. SS_LINEARSPECULARREFRACTION: boolean;
  116115. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  116116. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  116117. /** @hidden */
  116118. _areTexturesDirty: boolean;
  116119. }
  116120. /**
  116121. * Define the code related to the sub surface parameters of the pbr material.
  116122. */
  116123. export class PBRSubSurfaceConfiguration {
  116124. private _isRefractionEnabled;
  116125. /**
  116126. * Defines if the refraction is enabled in the material.
  116127. */
  116128. isRefractionEnabled: boolean;
  116129. private _isTranslucencyEnabled;
  116130. /**
  116131. * Defines if the translucency is enabled in the material.
  116132. */
  116133. isTranslucencyEnabled: boolean;
  116134. private _isScatteringEnabled;
  116135. /**
  116136. * Defines the refraction intensity of the material.
  116137. * The refraction when enabled replaces the Diffuse part of the material.
  116138. * The intensity helps transitionning between diffuse and refraction.
  116139. */
  116140. refractionIntensity: number;
  116141. /**
  116142. * Defines the translucency intensity of the material.
  116143. * When translucency has been enabled, this defines how much of the "translucency"
  116144. * is addded to the diffuse part of the material.
  116145. */
  116146. translucencyIntensity: number;
  116147. /**
  116148. * Defines the scattering intensity of the material.
  116149. * When scattering has been enabled, this defines how much of the "scattered light"
  116150. * is addded to the diffuse part of the material.
  116151. */
  116152. scatteringIntensity: number;
  116153. private _thicknessTexture;
  116154. /**
  116155. * Stores the average thickness of a mesh in a texture (The texture is holding the values linearly).
  116156. * The red channel of the texture should contain the thickness remapped between 0 and 1.
  116157. * 0 would mean minimumThickness
  116158. * 1 would mean maximumThickness
  116159. * The other channels might be use as a mask to vary the different effects intensity.
  116160. */
  116161. thicknessTexture: Nullable<BaseTexture>;
  116162. private _refractionTexture;
  116163. /**
  116164. * Defines the texture to use for refraction.
  116165. */
  116166. refractionTexture: Nullable<BaseTexture>;
  116167. private _indexOfRefraction;
  116168. /**
  116169. * Defines the index of refraction used in the material.
  116170. * https://en.wikipedia.org/wiki/List_of_refractive_indices
  116171. */
  116172. indexOfRefraction: number;
  116173. private _invertRefractionY;
  116174. /**
  116175. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  116176. */
  116177. invertRefractionY: boolean;
  116178. private _linkRefractionWithTransparency;
  116179. /**
  116180. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  116181. * Materials half opaque for instance using refraction could benefit from this control.
  116182. */
  116183. linkRefractionWithTransparency: boolean;
  116184. /**
  116185. * Defines the minimum thickness stored in the thickness map.
  116186. * If no thickness map is defined, this value will be used to simulate thickness.
  116187. */
  116188. minimumThickness: number;
  116189. /**
  116190. * Defines the maximum thickness stored in the thickness map.
  116191. */
  116192. maximumThickness: number;
  116193. /**
  116194. * Defines the volume tint of the material.
  116195. * This is used for both translucency and scattering.
  116196. */
  116197. tintColor: Color3;
  116198. /**
  116199. * Defines the distance at which the tint color should be found in the media.
  116200. * This is used for refraction only.
  116201. */
  116202. tintColorAtDistance: number;
  116203. /**
  116204. * Defines how far each channel transmit through the media.
  116205. * It is defined as a color to simplify it selection.
  116206. */
  116207. diffusionDistance: Color3;
  116208. private _useMaskFromThicknessTexture;
  116209. /**
  116210. * Stores the intensity of the different subsurface effects in the thickness texture.
  116211. * * the green channel is the translucency intensity.
  116212. * * the blue channel is the scattering intensity.
  116213. * * the alpha channel is the refraction intensity.
  116214. */
  116215. useMaskFromThicknessTexture: boolean;
  116216. /** @hidden */
  116217. private _internalMarkAllSubMeshesAsTexturesDirty;
  116218. /** @hidden */
  116219. _markAllSubMeshesAsTexturesDirty(): void;
  116220. /**
  116221. * Instantiate a new istance of sub surface configuration.
  116222. * @param markAllSubMeshesAsTexturesDirty Callback to flag the material to dirty
  116223. */
  116224. constructor(markAllSubMeshesAsTexturesDirty: () => void);
  116225. /**
  116226. * Gets wehter the submesh is ready to be used or not.
  116227. * @param defines the list of "defines" to update.
  116228. * @param scene defines the scene the material belongs to.
  116229. * @returns - boolean indicating that the submesh is ready or not.
  116230. */
  116231. isReadyForSubMesh(defines: IMaterialSubSurfaceDefines, scene: Scene): boolean;
  116232. /**
  116233. * Checks to see if a texture is used in the material.
  116234. * @param defines the list of "defines" to update.
  116235. * @param scene defines the scene to the material belongs to.
  116236. */
  116237. prepareDefines(defines: IMaterialSubSurfaceDefines, scene: Scene): void;
  116238. /**
  116239. * Binds the material data.
  116240. * @param uniformBuffer defines the Uniform buffer to fill in.
  116241. * @param scene defines the scene the material belongs to.
  116242. * @param engine defines the engine the material belongs to.
  116243. * @param isFrozen defines wether the material is frozen or not.
  116244. * @param lodBasedMicrosurface defines wether the material relies on lod based microsurface or not.
  116245. */
  116246. bindForSubMesh(uniformBuffer: UniformBuffer, scene: Scene, engine: Engine, isFrozen: boolean, lodBasedMicrosurface: boolean): void;
  116247. /**
  116248. * Unbinds the material from the mesh.
  116249. * @param activeEffect defines the effect that should be unbound from.
  116250. * @returns true if unbound, otherwise false
  116251. */
  116252. unbind(activeEffect: Effect): boolean;
  116253. /**
  116254. * Returns the texture used for refraction or null if none is used.
  116255. * @param scene defines the scene the material belongs to.
  116256. * @returns - Refraction texture if present. If no refraction texture and refraction
  116257. * is linked with transparency, returns environment texture. Otherwise, returns null.
  116258. */
  116259. private _getRefractionTexture;
  116260. /**
  116261. * Returns true if alpha blending should be disabled.
  116262. */
  116263. readonly disableAlphaBlending: boolean;
  116264. /**
  116265. * Fills the list of render target textures.
  116266. * @param renderTargets the list of render targets to update
  116267. */
  116268. fillRenderTargetTextures(renderTargets: SmartArray<RenderTargetTexture>): void;
  116269. /**
  116270. * Checks to see if a texture is used in the material.
  116271. * @param texture - Base texture to use.
  116272. * @returns - Boolean specifying if a texture is used in the material.
  116273. */
  116274. hasTexture(texture: BaseTexture): boolean;
  116275. /**
  116276. * Gets a boolean indicating that current material needs to register RTT
  116277. * @returns true if this uses a render target otherwise false.
  116278. */
  116279. hasRenderTargetTextures(): boolean;
  116280. /**
  116281. * Returns an array of the actively used textures.
  116282. * @param activeTextures Array of BaseTextures
  116283. */
  116284. getActiveTextures(activeTextures: BaseTexture[]): void;
  116285. /**
  116286. * Returns the animatable textures.
  116287. * @param animatables Array of animatable textures.
  116288. */
  116289. getAnimatables(animatables: IAnimatable[]): void;
  116290. /**
  116291. * Disposes the resources of the material.
  116292. * @param forceDisposeTextures - Forces the disposal of all textures.
  116293. */
  116294. dispose(forceDisposeTextures?: boolean): void;
  116295. /**
  116296. * Get the current class name of the texture useful for serialization or dynamic coding.
  116297. * @returns "PBRSubSurfaceConfiguration"
  116298. */
  116299. getClassName(): string;
  116300. /**
  116301. * Add fallbacks to the effect fallbacks list.
  116302. * @param defines defines the Base texture to use.
  116303. * @param fallbacks defines the current fallback list.
  116304. * @param currentRank defines the current fallback rank.
  116305. * @returns the new fallback rank.
  116306. */
  116307. static AddFallbacks(defines: IMaterialSubSurfaceDefines, fallbacks: EffectFallbacks, currentRank: number): number;
  116308. /**
  116309. * Add the required uniforms to the current list.
  116310. * @param uniforms defines the current uniform list.
  116311. */
  116312. static AddUniforms(uniforms: string[]): void;
  116313. /**
  116314. * Add the required samplers to the current list.
  116315. * @param samplers defines the current sampler list.
  116316. */
  116317. static AddSamplers(samplers: string[]): void;
  116318. /**
  116319. * Add the required uniforms to the current buffer.
  116320. * @param uniformBuffer defines the current uniform buffer.
  116321. */
  116322. static PrepareUniformBuffer(uniformBuffer: UniformBuffer): void;
  116323. /**
  116324. * Makes a duplicate of the current configuration into another one.
  116325. * @param configuration define the config where to copy the info
  116326. */
  116327. copyTo(configuration: PBRSubSurfaceConfiguration): void;
  116328. /**
  116329. * Serializes this Sub Surface configuration.
  116330. * @returns - An object with the serialized config.
  116331. */
  116332. serialize(): any;
  116333. /**
  116334. * Parses a anisotropy Configuration from a serialized object.
  116335. * @param source - Serialized object.
  116336. * @param scene Defines the scene we are parsing for
  116337. * @param rootUrl Defines the rootUrl to load from
  116338. */
  116339. parse(source: any, scene: Scene, rootUrl: string): void;
  116340. }
  116341. }
  116342. declare module BABYLON {
  116343. /** @hidden */
  116344. export var pbrFragmentDeclaration: {
  116345. name: string;
  116346. shader: string;
  116347. };
  116348. }
  116349. declare module BABYLON {
  116350. /** @hidden */
  116351. export var pbrUboDeclaration: {
  116352. name: string;
  116353. shader: string;
  116354. };
  116355. }
  116356. declare module BABYLON {
  116357. /** @hidden */
  116358. export var pbrFragmentExtraDeclaration: {
  116359. name: string;
  116360. shader: string;
  116361. };
  116362. }
  116363. declare module BABYLON {
  116364. /** @hidden */
  116365. export var pbrFragmentSamplersDeclaration: {
  116366. name: string;
  116367. shader: string;
  116368. };
  116369. }
  116370. declare module BABYLON {
  116371. /** @hidden */
  116372. export var pbrHelperFunctions: {
  116373. name: string;
  116374. shader: string;
  116375. };
  116376. }
  116377. declare module BABYLON {
  116378. /** @hidden */
  116379. export var harmonicsFunctions: {
  116380. name: string;
  116381. shader: string;
  116382. };
  116383. }
  116384. declare module BABYLON {
  116385. /** @hidden */
  116386. export var pbrDirectLightingSetupFunctions: {
  116387. name: string;
  116388. shader: string;
  116389. };
  116390. }
  116391. declare module BABYLON {
  116392. /** @hidden */
  116393. export var pbrDirectLightingFalloffFunctions: {
  116394. name: string;
  116395. shader: string;
  116396. };
  116397. }
  116398. declare module BABYLON {
  116399. /** @hidden */
  116400. export var pbrBRDFFunctions: {
  116401. name: string;
  116402. shader: string;
  116403. };
  116404. }
  116405. declare module BABYLON {
  116406. /** @hidden */
  116407. export var pbrDirectLightingFunctions: {
  116408. name: string;
  116409. shader: string;
  116410. };
  116411. }
  116412. declare module BABYLON {
  116413. /** @hidden */
  116414. export var pbrIBLFunctions: {
  116415. name: string;
  116416. shader: string;
  116417. };
  116418. }
  116419. declare module BABYLON {
  116420. /** @hidden */
  116421. export var pbrDebug: {
  116422. name: string;
  116423. shader: string;
  116424. };
  116425. }
  116426. declare module BABYLON {
  116427. /** @hidden */
  116428. export var pbrPixelShader: {
  116429. name: string;
  116430. shader: string;
  116431. };
  116432. }
  116433. declare module BABYLON {
  116434. /** @hidden */
  116435. export var pbrVertexDeclaration: {
  116436. name: string;
  116437. shader: string;
  116438. };
  116439. }
  116440. declare module BABYLON {
  116441. /** @hidden */
  116442. export var pbrVertexShader: {
  116443. name: string;
  116444. shader: string;
  116445. };
  116446. }
  116447. declare module BABYLON {
  116448. /**
  116449. * Manages the defines for the PBR Material.
  116450. * @hidden
  116451. */
  116452. export class PBRMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines, IMaterialClearCoatDefines, IMaterialAnisotropicDefines, IMaterialBRDFDefines, IMaterialSheenDefines, IMaterialSubSurfaceDefines {
  116453. PBR: boolean;
  116454. MAINUV1: boolean;
  116455. MAINUV2: boolean;
  116456. UV1: boolean;
  116457. UV2: boolean;
  116458. ALBEDO: boolean;
  116459. ALBEDODIRECTUV: number;
  116460. VERTEXCOLOR: boolean;
  116461. AMBIENT: boolean;
  116462. AMBIENTDIRECTUV: number;
  116463. AMBIENTINGRAYSCALE: boolean;
  116464. OPACITY: boolean;
  116465. VERTEXALPHA: boolean;
  116466. OPACITYDIRECTUV: number;
  116467. OPACITYRGB: boolean;
  116468. ALPHATEST: boolean;
  116469. DEPTHPREPASS: boolean;
  116470. ALPHABLEND: boolean;
  116471. ALPHAFROMALBEDO: boolean;
  116472. ALPHATESTVALUE: string;
  116473. SPECULAROVERALPHA: boolean;
  116474. RADIANCEOVERALPHA: boolean;
  116475. ALPHAFRESNEL: boolean;
  116476. LINEARALPHAFRESNEL: boolean;
  116477. PREMULTIPLYALPHA: boolean;
  116478. EMISSIVE: boolean;
  116479. EMISSIVEDIRECTUV: number;
  116480. REFLECTIVITY: boolean;
  116481. REFLECTIVITYDIRECTUV: number;
  116482. SPECULARTERM: boolean;
  116483. MICROSURFACEFROMREFLECTIVITYMAP: boolean;
  116484. MICROSURFACEAUTOMATIC: boolean;
  116485. LODBASEDMICROSFURACE: boolean;
  116486. MICROSURFACEMAP: boolean;
  116487. MICROSURFACEMAPDIRECTUV: number;
  116488. METALLICWORKFLOW: boolean;
  116489. ROUGHNESSSTOREINMETALMAPALPHA: boolean;
  116490. ROUGHNESSSTOREINMETALMAPGREEN: boolean;
  116491. METALLNESSSTOREINMETALMAPBLUE: boolean;
  116492. AOSTOREINMETALMAPRED: boolean;
  116493. METALLICF0FACTORFROMMETALLICMAP: boolean;
  116494. ENVIRONMENTBRDF: boolean;
  116495. ENVIRONMENTBRDF_RGBD: boolean;
  116496. NORMAL: boolean;
  116497. TANGENT: boolean;
  116498. BUMP: boolean;
  116499. BUMPDIRECTUV: number;
  116500. OBJECTSPACE_NORMALMAP: boolean;
  116501. PARALLAX: boolean;
  116502. PARALLAXOCCLUSION: boolean;
  116503. NORMALXYSCALE: boolean;
  116504. LIGHTMAP: boolean;
  116505. LIGHTMAPDIRECTUV: number;
  116506. USELIGHTMAPASSHADOWMAP: boolean;
  116507. GAMMALIGHTMAP: boolean;
  116508. RGBDLIGHTMAP: boolean;
  116509. REFLECTION: boolean;
  116510. REFLECTIONMAP_3D: boolean;
  116511. REFLECTIONMAP_SPHERICAL: boolean;
  116512. REFLECTIONMAP_PLANAR: boolean;
  116513. REFLECTIONMAP_CUBIC: boolean;
  116514. USE_LOCAL_REFLECTIONMAP_CUBIC: boolean;
  116515. REFLECTIONMAP_PROJECTION: boolean;
  116516. REFLECTIONMAP_SKYBOX: boolean;
  116517. REFLECTIONMAP_SKYBOX_TRANSFORMED: boolean;
  116518. REFLECTIONMAP_EXPLICIT: boolean;
  116519. REFLECTIONMAP_EQUIRECTANGULAR: boolean;
  116520. REFLECTIONMAP_EQUIRECTANGULAR_FIXED: boolean;
  116521. REFLECTIONMAP_MIRROREDEQUIRECTANGULAR_FIXED: boolean;
  116522. INVERTCUBICMAP: boolean;
  116523. USESPHERICALFROMREFLECTIONMAP: boolean;
  116524. USEIRRADIANCEMAP: boolean;
  116525. SPHERICAL_HARMONICS: boolean;
  116526. USESPHERICALINVERTEX: boolean;
  116527. REFLECTIONMAP_OPPOSITEZ: boolean;
  116528. LODINREFLECTIONALPHA: boolean;
  116529. GAMMAREFLECTION: boolean;
  116530. RGBDREFLECTION: boolean;
  116531. LINEARSPECULARREFLECTION: boolean;
  116532. RADIANCEOCCLUSION: boolean;
  116533. HORIZONOCCLUSION: boolean;
  116534. INSTANCES: boolean;
  116535. NUM_BONE_INFLUENCERS: number;
  116536. BonesPerMesh: number;
  116537. BONETEXTURE: boolean;
  116538. NONUNIFORMSCALING: boolean;
  116539. MORPHTARGETS: boolean;
  116540. MORPHTARGETS_NORMAL: boolean;
  116541. MORPHTARGETS_TANGENT: boolean;
  116542. MORPHTARGETS_UV: boolean;
  116543. NUM_MORPH_INFLUENCERS: number;
  116544. IMAGEPROCESSING: boolean;
  116545. VIGNETTE: boolean;
  116546. VIGNETTEBLENDMODEMULTIPLY: boolean;
  116547. VIGNETTEBLENDMODEOPAQUE: boolean;
  116548. TONEMAPPING: boolean;
  116549. TONEMAPPING_ACES: boolean;
  116550. CONTRAST: boolean;
  116551. COLORCURVES: boolean;
  116552. COLORGRADING: boolean;
  116553. COLORGRADING3D: boolean;
  116554. SAMPLER3DGREENDEPTH: boolean;
  116555. SAMPLER3DBGRMAP: boolean;
  116556. IMAGEPROCESSINGPOSTPROCESS: boolean;
  116557. EXPOSURE: boolean;
  116558. MULTIVIEW: boolean;
  116559. USEPHYSICALLIGHTFALLOFF: boolean;
  116560. USEGLTFLIGHTFALLOFF: boolean;
  116561. TWOSIDEDLIGHTING: boolean;
  116562. SHADOWFLOAT: boolean;
  116563. CLIPPLANE: boolean;
  116564. CLIPPLANE2: boolean;
  116565. CLIPPLANE3: boolean;
  116566. CLIPPLANE4: boolean;
  116567. POINTSIZE: boolean;
  116568. FOG: boolean;
  116569. LOGARITHMICDEPTH: boolean;
  116570. FORCENORMALFORWARD: boolean;
  116571. SPECULARAA: boolean;
  116572. CLEARCOAT: boolean;
  116573. CLEARCOAT_DEFAULTIOR: boolean;
  116574. CLEARCOAT_TEXTURE: boolean;
  116575. CLEARCOAT_TEXTUREDIRECTUV: number;
  116576. CLEARCOAT_BUMP: boolean;
  116577. CLEARCOAT_BUMPDIRECTUV: number;
  116578. CLEARCOAT_TINT: boolean;
  116579. CLEARCOAT_TINT_TEXTURE: boolean;
  116580. CLEARCOAT_TINT_TEXTUREDIRECTUV: number;
  116581. ANISOTROPIC: boolean;
  116582. ANISOTROPIC_TEXTURE: boolean;
  116583. ANISOTROPIC_TEXTUREDIRECTUV: number;
  116584. BRDF_V_HEIGHT_CORRELATED: boolean;
  116585. MS_BRDF_ENERGY_CONSERVATION: boolean;
  116586. SPECULAR_GLOSSINESS_ENERGY_CONSERVATION: boolean;
  116587. SHEEN: boolean;
  116588. SHEEN_TEXTURE: boolean;
  116589. SHEEN_TEXTUREDIRECTUV: number;
  116590. SHEEN_LINKWITHALBEDO: boolean;
  116591. SUBSURFACE: boolean;
  116592. SS_REFRACTION: boolean;
  116593. SS_TRANSLUCENCY: boolean;
  116594. SS_SCATERRING: boolean;
  116595. SS_THICKNESSANDMASK_TEXTURE: boolean;
  116596. SS_THICKNESSANDMASK_TEXTUREDIRECTUV: number;
  116597. SS_REFRACTIONMAP_3D: boolean;
  116598. SS_REFRACTIONMAP_OPPOSITEZ: boolean;
  116599. SS_LODINREFRACTIONALPHA: boolean;
  116600. SS_GAMMAREFRACTION: boolean;
  116601. SS_RGBDREFRACTION: boolean;
  116602. SS_LINEARSPECULARREFRACTION: boolean;
  116603. SS_LINKREFRACTIONTOTRANSPARENCY: boolean;
  116604. SS_MASK_FROM_THICKNESS_TEXTURE: boolean;
  116605. UNLIT: boolean;
  116606. DEBUGMODE: number;
  116607. /**
  116608. * Initializes the PBR Material defines.
  116609. */
  116610. constructor();
  116611. /**
  116612. * Resets the PBR Material defines.
  116613. */
  116614. reset(): void;
  116615. }
  116616. /**
  116617. * The Physically based material base class of BJS.
  116618. *
  116619. * This offers the main features of a standard PBR material.
  116620. * For more information, please refer to the documentation :
  116621. * https://doc.babylonjs.com/how_to/physically_based_rendering
  116622. */
  116623. export abstract class PBRBaseMaterial extends PushMaterial {
  116624. /**
  116625. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  116626. */
  116627. static readonly PBRMATERIAL_OPAQUE: number;
  116628. /**
  116629. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  116630. */
  116631. static readonly PBRMATERIAL_ALPHATEST: number;
  116632. /**
  116633. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  116634. */
  116635. static readonly PBRMATERIAL_ALPHABLEND: number;
  116636. /**
  116637. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  116638. * They are also discarded below the alpha cutoff threshold to improve performances.
  116639. */
  116640. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  116641. /**
  116642. * Defines the default value of how much AO map is occluding the analytical lights
  116643. * (point spot...).
  116644. */
  116645. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  116646. /**
  116647. * PBRMaterialLightFalloff Physical: light is falling off following the inverse squared distance law.
  116648. */
  116649. static readonly LIGHTFALLOFF_PHYSICAL: number;
  116650. /**
  116651. * PBRMaterialLightFalloff gltf: light is falling off as described in the gltf moving to PBR document
  116652. * to enhance interoperability with other engines.
  116653. */
  116654. static readonly LIGHTFALLOFF_GLTF: number;
  116655. /**
  116656. * PBRMaterialLightFalloff Standard: light is falling off like in the standard material
  116657. * to enhance interoperability with other materials.
  116658. */
  116659. static readonly LIGHTFALLOFF_STANDARD: number;
  116660. /**
  116661. * Intensity of the direct lights e.g. the four lights available in your scene.
  116662. * This impacts both the direct diffuse and specular highlights.
  116663. */
  116664. protected _directIntensity: number;
  116665. /**
  116666. * Intensity of the emissive part of the material.
  116667. * This helps controlling the emissive effect without modifying the emissive color.
  116668. */
  116669. protected _emissiveIntensity: number;
  116670. /**
  116671. * Intensity of the environment e.g. how much the environment will light the object
  116672. * either through harmonics for rough material or through the refelction for shiny ones.
  116673. */
  116674. protected _environmentIntensity: number;
  116675. /**
  116676. * This is a special control allowing the reduction of the specular highlights coming from the
  116677. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  116678. */
  116679. protected _specularIntensity: number;
  116680. /**
  116681. * This stores the direct, emissive, environment, and specular light intensities into a Vector4.
  116682. */
  116683. private _lightingInfos;
  116684. /**
  116685. * Debug Control allowing disabling the bump map on this material.
  116686. */
  116687. protected _disableBumpMap: boolean;
  116688. /**
  116689. * AKA Diffuse Texture in standard nomenclature.
  116690. */
  116691. protected _albedoTexture: Nullable<BaseTexture>;
  116692. /**
  116693. * AKA Occlusion Texture in other nomenclature.
  116694. */
  116695. protected _ambientTexture: Nullable<BaseTexture>;
  116696. /**
  116697. * AKA Occlusion Texture Intensity in other nomenclature.
  116698. */
  116699. protected _ambientTextureStrength: number;
  116700. /**
  116701. * Defines how much the AO map is occluding the analytical lights (point spot...).
  116702. * 1 means it completely occludes it
  116703. * 0 mean it has no impact
  116704. */
  116705. protected _ambientTextureImpactOnAnalyticalLights: number;
  116706. /**
  116707. * Stores the alpha values in a texture.
  116708. */
  116709. protected _opacityTexture: Nullable<BaseTexture>;
  116710. /**
  116711. * Stores the reflection values in a texture.
  116712. */
  116713. protected _reflectionTexture: Nullable<BaseTexture>;
  116714. /**
  116715. * Stores the emissive values in a texture.
  116716. */
  116717. protected _emissiveTexture: Nullable<BaseTexture>;
  116718. /**
  116719. * AKA Specular texture in other nomenclature.
  116720. */
  116721. protected _reflectivityTexture: Nullable<BaseTexture>;
  116722. /**
  116723. * Used to switch from specular/glossiness to metallic/roughness workflow.
  116724. */
  116725. protected _metallicTexture: Nullable<BaseTexture>;
  116726. /**
  116727. * Specifies the metallic scalar of the metallic/roughness workflow.
  116728. * Can also be used to scale the metalness values of the metallic texture.
  116729. */
  116730. protected _metallic: Nullable<number>;
  116731. /**
  116732. * Specifies the roughness scalar of the metallic/roughness workflow.
  116733. * Can also be used to scale the roughness values of the metallic texture.
  116734. */
  116735. protected _roughness: Nullable<number>;
  116736. /**
  116737. * Specifies the an F0 factor to help configuring the material F0.
  116738. * Instead of the default 4%, 8% * factor will be used. As the factor is defaulting
  116739. * to 0.5 the previously hard coded value stays the same.
  116740. * Can also be used to scale the F0 values of the metallic texture.
  116741. */
  116742. protected _metallicF0Factor: number;
  116743. /**
  116744. * Specifies whether the F0 factor can be fetched from the mettalic texture.
  116745. * If set to true, please adapt the metallicF0Factor to ensure it fits with
  116746. * your expectation as it multiplies with the texture data.
  116747. */
  116748. protected _useMetallicF0FactorFromMetallicTexture: boolean;
  116749. /**
  116750. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  116751. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  116752. */
  116753. protected _microSurfaceTexture: Nullable<BaseTexture>;
  116754. /**
  116755. * Stores surface normal data used to displace a mesh in a texture.
  116756. */
  116757. protected _bumpTexture: Nullable<BaseTexture>;
  116758. /**
  116759. * Stores the pre-calculated light information of a mesh in a texture.
  116760. */
  116761. protected _lightmapTexture: Nullable<BaseTexture>;
  116762. /**
  116763. * The color of a material in ambient lighting.
  116764. */
  116765. protected _ambientColor: Color3;
  116766. /**
  116767. * AKA Diffuse Color in other nomenclature.
  116768. */
  116769. protected _albedoColor: Color3;
  116770. /**
  116771. * AKA Specular Color in other nomenclature.
  116772. */
  116773. protected _reflectivityColor: Color3;
  116774. /**
  116775. * The color applied when light is reflected from a material.
  116776. */
  116777. protected _reflectionColor: Color3;
  116778. /**
  116779. * The color applied when light is emitted from a material.
  116780. */
  116781. protected _emissiveColor: Color3;
  116782. /**
  116783. * AKA Glossiness in other nomenclature.
  116784. */
  116785. protected _microSurface: number;
  116786. /**
  116787. * Specifies that the material will use the light map as a show map.
  116788. */
  116789. protected _useLightmapAsShadowmap: boolean;
  116790. /**
  116791. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  116792. * makes the reflect vector face the model (under horizon).
  116793. */
  116794. protected _useHorizonOcclusion: boolean;
  116795. /**
  116796. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  116797. * too much the area relying on ambient texture to define their ambient occlusion.
  116798. */
  116799. protected _useRadianceOcclusion: boolean;
  116800. /**
  116801. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  116802. */
  116803. protected _useAlphaFromAlbedoTexture: boolean;
  116804. /**
  116805. * Specifies that the material will keeps the specular highlights over a transparent surface (only the most limunous ones).
  116806. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  116807. */
  116808. protected _useSpecularOverAlpha: boolean;
  116809. /**
  116810. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  116811. */
  116812. protected _useMicroSurfaceFromReflectivityMapAlpha: boolean;
  116813. /**
  116814. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  116815. */
  116816. protected _useRoughnessFromMetallicTextureAlpha: boolean;
  116817. /**
  116818. * Specifies if the metallic texture contains the roughness information in its green channel.
  116819. */
  116820. protected _useRoughnessFromMetallicTextureGreen: boolean;
  116821. /**
  116822. * Specifies if the metallic texture contains the metallness information in its blue channel.
  116823. */
  116824. protected _useMetallnessFromMetallicTextureBlue: boolean;
  116825. /**
  116826. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  116827. */
  116828. protected _useAmbientOcclusionFromMetallicTextureRed: boolean;
  116829. /**
  116830. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  116831. */
  116832. protected _useAmbientInGrayScale: boolean;
  116833. /**
  116834. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  116835. * The material will try to infer what glossiness each pixel should be.
  116836. */
  116837. protected _useAutoMicroSurfaceFromReflectivityMap: boolean;
  116838. /**
  116839. * Defines the falloff type used in this material.
  116840. * It by default is Physical.
  116841. */
  116842. protected _lightFalloff: number;
  116843. /**
  116844. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  116845. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  116846. */
  116847. protected _useRadianceOverAlpha: boolean;
  116848. /**
  116849. * Allows using an object space normal map (instead of tangent space).
  116850. */
  116851. protected _useObjectSpaceNormalMap: boolean;
  116852. /**
  116853. * Allows using the bump map in parallax mode.
  116854. */
  116855. protected _useParallax: boolean;
  116856. /**
  116857. * Allows using the bump map in parallax occlusion mode.
  116858. */
  116859. protected _useParallaxOcclusion: boolean;
  116860. /**
  116861. * Controls the scale bias of the parallax mode.
  116862. */
  116863. protected _parallaxScaleBias: number;
  116864. /**
  116865. * If sets to true, disables all the lights affecting the material.
  116866. */
  116867. protected _disableLighting: boolean;
  116868. /**
  116869. * Number of Simultaneous lights allowed on the material.
  116870. */
  116871. protected _maxSimultaneousLights: number;
  116872. /**
  116873. * If sets to true, x component of normal map value will be inverted (x = 1.0 - x).
  116874. */
  116875. protected _invertNormalMapX: boolean;
  116876. /**
  116877. * If sets to true, y component of normal map value will be inverted (y = 1.0 - y).
  116878. */
  116879. protected _invertNormalMapY: boolean;
  116880. /**
  116881. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  116882. */
  116883. protected _twoSidedLighting: boolean;
  116884. /**
  116885. * Defines the alpha limits in alpha test mode.
  116886. */
  116887. protected _alphaCutOff: number;
  116888. /**
  116889. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  116890. */
  116891. protected _forceAlphaTest: boolean;
  116892. /**
  116893. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  116894. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  116895. */
  116896. protected _useAlphaFresnel: boolean;
  116897. /**
  116898. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  116899. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  116900. */
  116901. protected _useLinearAlphaFresnel: boolean;
  116902. /**
  116903. * The transparency mode of the material.
  116904. */
  116905. protected _transparencyMode: Nullable<number>;
  116906. /**
  116907. * Specifies the environment BRDF texture used to comput the scale and offset roughness values
  116908. * from cos thetav and roughness:
  116909. * http://blog.selfshadow.com/publications/s2013-shading-course/karis/s2013_pbs_epic_notes_v2.pdf
  116910. */
  116911. protected _environmentBRDFTexture: Nullable<BaseTexture>;
  116912. /**
  116913. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  116914. */
  116915. protected _forceIrradianceInFragment: boolean;
  116916. /**
  116917. * Force normal to face away from face.
  116918. */
  116919. protected _forceNormalForward: boolean;
  116920. /**
  116921. * Enables specular anti aliasing in the PBR shader.
  116922. * It will both interacts on the Geometry for analytical and IBL lighting.
  116923. * It also prefilter the roughness map based on the bump values.
  116924. */
  116925. protected _enableSpecularAntiAliasing: boolean;
  116926. /**
  116927. * Default configuration related to image processing available in the PBR Material.
  116928. */
  116929. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  116930. /**
  116931. * Keep track of the image processing observer to allow dispose and replace.
  116932. */
  116933. private _imageProcessingObserver;
  116934. /**
  116935. * Attaches a new image processing configuration to the PBR Material.
  116936. * @param configuration
  116937. */
  116938. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  116939. /**
  116940. * Stores the available render targets.
  116941. */
  116942. private _renderTargets;
  116943. /**
  116944. * Sets the global ambient color for the material used in lighting calculations.
  116945. */
  116946. private _globalAmbientColor;
  116947. /**
  116948. * Enables the use of logarithmic depth buffers, which is good for wide depth buffers.
  116949. */
  116950. private _useLogarithmicDepth;
  116951. /**
  116952. * If set to true, no lighting calculations will be applied.
  116953. */
  116954. private _unlit;
  116955. private _debugMode;
  116956. /**
  116957. * @hidden
  116958. * This is reserved for the inspector.
  116959. * Defines the material debug mode.
  116960. * It helps seeing only some components of the material while troubleshooting.
  116961. */
  116962. debugMode: number;
  116963. /**
  116964. * @hidden
  116965. * This is reserved for the inspector.
  116966. * Specify from where on screen the debug mode should start.
  116967. * The value goes from -1 (full screen) to 1 (not visible)
  116968. * It helps with side by side comparison against the final render
  116969. * This defaults to -1
  116970. */
  116971. private debugLimit;
  116972. /**
  116973. * @hidden
  116974. * This is reserved for the inspector.
  116975. * As the default viewing range might not be enough (if the ambient is really small for instance)
  116976. * You can use the factor to better multiply the final value.
  116977. */
  116978. private debugFactor;
  116979. /**
  116980. * Defines the clear coat layer parameters for the material.
  116981. */
  116982. readonly clearCoat: PBRClearCoatConfiguration;
  116983. /**
  116984. * Defines the anisotropic parameters for the material.
  116985. */
  116986. readonly anisotropy: PBRAnisotropicConfiguration;
  116987. /**
  116988. * Defines the BRDF parameters for the material.
  116989. */
  116990. readonly brdf: PBRBRDFConfiguration;
  116991. /**
  116992. * Defines the Sheen parameters for the material.
  116993. */
  116994. readonly sheen: PBRSheenConfiguration;
  116995. /**
  116996. * Defines the SubSurface parameters for the material.
  116997. */
  116998. readonly subSurface: PBRSubSurfaceConfiguration;
  116999. /**
  117000. * Custom callback helping to override the default shader used in the material.
  117001. */
  117002. customShaderNameResolve: (shaderName: string, uniforms: string[], uniformBuffers: string[], samplers: string[], defines: PBRMaterialDefines) => string;
  117003. protected _rebuildInParallel: boolean;
  117004. /**
  117005. * Instantiates a new PBRMaterial instance.
  117006. *
  117007. * @param name The material name
  117008. * @param scene The scene the material will be use in.
  117009. */
  117010. constructor(name: string, scene: Scene);
  117011. /**
  117012. * Gets a boolean indicating that current material needs to register RTT
  117013. */
  117014. readonly hasRenderTargetTextures: boolean;
  117015. /**
  117016. * Gets the name of the material class.
  117017. */
  117018. getClassName(): string;
  117019. /**
  117020. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  117021. */
  117022. /**
  117023. * Enabled the use of logarithmic depth buffers, which is good for wide depth buffers.
  117024. */
  117025. useLogarithmicDepth: boolean;
  117026. /**
  117027. * Gets the current transparency mode.
  117028. */
  117029. /**
  117030. * Sets the transparency mode of the material.
  117031. *
  117032. * | Value | Type | Description |
  117033. * | ----- | ----------------------------------- | ----------- |
  117034. * | 0 | OPAQUE | |
  117035. * | 1 | ALPHATEST | |
  117036. * | 2 | ALPHABLEND | |
  117037. * | 3 | ALPHATESTANDBLEND | |
  117038. *
  117039. */
  117040. transparencyMode: Nullable<number>;
  117041. /**
  117042. * Returns true if alpha blending should be disabled.
  117043. */
  117044. private readonly _disableAlphaBlending;
  117045. /**
  117046. * Specifies whether or not this material should be rendered in alpha blend mode.
  117047. */
  117048. needAlphaBlending(): boolean;
  117049. /**
  117050. * Specifies if the mesh will require alpha blending.
  117051. * @param mesh - BJS mesh.
  117052. */
  117053. needAlphaBlendingForMesh(mesh: AbstractMesh): boolean;
  117054. /**
  117055. * Specifies whether or not this material should be rendered in alpha test mode.
  117056. */
  117057. needAlphaTesting(): boolean;
  117058. /**
  117059. * Specifies whether or not the alpha value of the albedo texture should be used for alpha blending.
  117060. */
  117061. protected _shouldUseAlphaFromAlbedoTexture(): boolean;
  117062. /**
  117063. * Gets the texture used for the alpha test.
  117064. */
  117065. getAlphaTestTexture(): Nullable<BaseTexture>;
  117066. /**
  117067. * Specifies that the submesh is ready to be used.
  117068. * @param mesh - BJS mesh.
  117069. * @param subMesh - A submesh of the BJS mesh. Used to check if it is ready.
  117070. * @param useInstances - Specifies that instances should be used.
  117071. * @returns - boolean indicating that the submesh is ready or not.
  117072. */
  117073. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  117074. /**
  117075. * Specifies if the material uses metallic roughness workflow.
  117076. * @returns boolean specifiying if the material uses metallic roughness workflow.
  117077. */
  117078. isMetallicWorkflow(): boolean;
  117079. private _prepareEffect;
  117080. private _prepareDefines;
  117081. /**
  117082. * Force shader compilation
  117083. */
  117084. forceCompilation(mesh: AbstractMesh, onCompiled?: (material: Material) => void, options?: Partial<IMaterialCompilationOptions>): void;
  117085. /**
  117086. * Initializes the uniform buffer layout for the shader.
  117087. */
  117088. buildUniformLayout(): void;
  117089. /**
  117090. * Unbinds the material from the mesh
  117091. */
  117092. unbind(): void;
  117093. /**
  117094. * Binds the submesh data.
  117095. * @param world - The world matrix.
  117096. * @param mesh - The BJS mesh.
  117097. * @param subMesh - A submesh of the BJS mesh.
  117098. */
  117099. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  117100. /**
  117101. * Returns the animatable textures.
  117102. * @returns - Array of animatable textures.
  117103. */
  117104. getAnimatables(): IAnimatable[];
  117105. /**
  117106. * Returns the texture used for reflections.
  117107. * @returns - Reflection texture if present. Otherwise, returns the environment texture.
  117108. */
  117109. private _getReflectionTexture;
  117110. /**
  117111. * Returns an array of the actively used textures.
  117112. * @returns - Array of BaseTextures
  117113. */
  117114. getActiveTextures(): BaseTexture[];
  117115. /**
  117116. * Checks to see if a texture is used in the material.
  117117. * @param texture - Base texture to use.
  117118. * @returns - Boolean specifying if a texture is used in the material.
  117119. */
  117120. hasTexture(texture: BaseTexture): boolean;
  117121. /**
  117122. * Disposes the resources of the material.
  117123. * @param forceDisposeEffect - Forces the disposal of effects.
  117124. * @param forceDisposeTextures - Forces the disposal of all textures.
  117125. */
  117126. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean): void;
  117127. }
  117128. }
  117129. declare module BABYLON {
  117130. /**
  117131. * The Physically based material of BJS.
  117132. *
  117133. * This offers the main features of a standard PBR material.
  117134. * For more information, please refer to the documentation :
  117135. * https://doc.babylonjs.com/how_to/physically_based_rendering
  117136. */
  117137. export class PBRMaterial extends PBRBaseMaterial {
  117138. /**
  117139. * PBRMaterialTransparencyMode: No transparency mode, Alpha channel is not use.
  117140. */
  117141. static readonly PBRMATERIAL_OPAQUE: number;
  117142. /**
  117143. * PBRMaterialTransparencyMode: Alpha Test mode, pixel are discarded below a certain threshold defined by the alpha cutoff value.
  117144. */
  117145. static readonly PBRMATERIAL_ALPHATEST: number;
  117146. /**
  117147. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  117148. */
  117149. static readonly PBRMATERIAL_ALPHABLEND: number;
  117150. /**
  117151. * PBRMaterialTransparencyMode: Pixels are blended (according to the alpha mode) with the already drawn pixels in the current frame buffer.
  117152. * They are also discarded below the alpha cutoff threshold to improve performances.
  117153. */
  117154. static readonly PBRMATERIAL_ALPHATESTANDBLEND: number;
  117155. /**
  117156. * Defines the default value of how much AO map is occluding the analytical lights
  117157. * (point spot...).
  117158. */
  117159. static DEFAULT_AO_ON_ANALYTICAL_LIGHTS: number;
  117160. /**
  117161. * Intensity of the direct lights e.g. the four lights available in your scene.
  117162. * This impacts both the direct diffuse and specular highlights.
  117163. */
  117164. directIntensity: number;
  117165. /**
  117166. * Intensity of the emissive part of the material.
  117167. * This helps controlling the emissive effect without modifying the emissive color.
  117168. */
  117169. emissiveIntensity: number;
  117170. /**
  117171. * Intensity of the environment e.g. how much the environment will light the object
  117172. * either through harmonics for rough material or through the refelction for shiny ones.
  117173. */
  117174. environmentIntensity: number;
  117175. /**
  117176. * This is a special control allowing the reduction of the specular highlights coming from the
  117177. * four lights of the scene. Those highlights may not be needed in full environment lighting.
  117178. */
  117179. specularIntensity: number;
  117180. /**
  117181. * Debug Control allowing disabling the bump map on this material.
  117182. */
  117183. disableBumpMap: boolean;
  117184. /**
  117185. * AKA Diffuse Texture in standard nomenclature.
  117186. */
  117187. albedoTexture: BaseTexture;
  117188. /**
  117189. * AKA Occlusion Texture in other nomenclature.
  117190. */
  117191. ambientTexture: BaseTexture;
  117192. /**
  117193. * AKA Occlusion Texture Intensity in other nomenclature.
  117194. */
  117195. ambientTextureStrength: number;
  117196. /**
  117197. * Defines how much the AO map is occluding the analytical lights (point spot...).
  117198. * 1 means it completely occludes it
  117199. * 0 mean it has no impact
  117200. */
  117201. ambientTextureImpactOnAnalyticalLights: number;
  117202. /**
  117203. * Stores the alpha values in a texture.
  117204. */
  117205. opacityTexture: BaseTexture;
  117206. /**
  117207. * Stores the reflection values in a texture.
  117208. */
  117209. reflectionTexture: Nullable<BaseTexture>;
  117210. /**
  117211. * Stores the emissive values in a texture.
  117212. */
  117213. emissiveTexture: BaseTexture;
  117214. /**
  117215. * AKA Specular texture in other nomenclature.
  117216. */
  117217. reflectivityTexture: BaseTexture;
  117218. /**
  117219. * Used to switch from specular/glossiness to metallic/roughness workflow.
  117220. */
  117221. metallicTexture: BaseTexture;
  117222. /**
  117223. * Specifies the metallic scalar of the metallic/roughness workflow.
  117224. * Can also be used to scale the metalness values of the metallic texture.
  117225. */
  117226. metallic: Nullable<number>;
  117227. /**
  117228. * Specifies the roughness scalar of the metallic/roughness workflow.
  117229. * Can also be used to scale the roughness values of the metallic texture.
  117230. */
  117231. roughness: Nullable<number>;
  117232. /**
  117233. * Specifies the an F0 factor to help configuring the material F0.
  117234. * Instead of the default 4%, 8% * factor will be used. As the factor is defaulting
  117235. * to 0.5 the previously hard coded value stays the same.
  117236. * Can also be used to scale the F0 values of the metallic texture.
  117237. */
  117238. metallicF0Factor: number;
  117239. /**
  117240. * Specifies whether the F0 factor can be fetched from the mettalic texture.
  117241. * If set to true, please adapt the metallicF0Factor to ensure it fits with
  117242. * your expectation as it multiplies with the texture data.
  117243. */
  117244. useMetallicF0FactorFromMetallicTexture: boolean;
  117245. /**
  117246. * Used to enable roughness/glossiness fetch from a separate channel depending on the current mode.
  117247. * Gray Scale represents roughness in metallic mode and glossiness in specular mode.
  117248. */
  117249. microSurfaceTexture: BaseTexture;
  117250. /**
  117251. * Stores surface normal data used to displace a mesh in a texture.
  117252. */
  117253. bumpTexture: BaseTexture;
  117254. /**
  117255. * Stores the pre-calculated light information of a mesh in a texture.
  117256. */
  117257. lightmapTexture: BaseTexture;
  117258. /**
  117259. * Stores the refracted light information in a texture.
  117260. */
  117261. refractionTexture: Nullable<BaseTexture>;
  117262. /**
  117263. * The color of a material in ambient lighting.
  117264. */
  117265. ambientColor: Color3;
  117266. /**
  117267. * AKA Diffuse Color in other nomenclature.
  117268. */
  117269. albedoColor: Color3;
  117270. /**
  117271. * AKA Specular Color in other nomenclature.
  117272. */
  117273. reflectivityColor: Color3;
  117274. /**
  117275. * The color reflected from the material.
  117276. */
  117277. reflectionColor: Color3;
  117278. /**
  117279. * The color emitted from the material.
  117280. */
  117281. emissiveColor: Color3;
  117282. /**
  117283. * AKA Glossiness in other nomenclature.
  117284. */
  117285. microSurface: number;
  117286. /**
  117287. * source material index of refraction (IOR)' / 'destination material IOR.
  117288. */
  117289. indexOfRefraction: number;
  117290. /**
  117291. * Controls if refraction needs to be inverted on Y. This could be useful for procedural texture.
  117292. */
  117293. invertRefractionY: boolean;
  117294. /**
  117295. * This parameters will make the material used its opacity to control how much it is refracting aginst not.
  117296. * Materials half opaque for instance using refraction could benefit from this control.
  117297. */
  117298. linkRefractionWithTransparency: boolean;
  117299. /**
  117300. * If true, the light map contains occlusion information instead of lighting info.
  117301. */
  117302. useLightmapAsShadowmap: boolean;
  117303. /**
  117304. * Specifies that the alpha is coming form the albedo channel alpha channel for alpha blending.
  117305. */
  117306. useAlphaFromAlbedoTexture: boolean;
  117307. /**
  117308. * Enforces alpha test in opaque or blend mode in order to improve the performances of some situations.
  117309. */
  117310. forceAlphaTest: boolean;
  117311. /**
  117312. * Defines the alpha limits in alpha test mode.
  117313. */
  117314. alphaCutOff: number;
  117315. /**
  117316. * Specifies that the material will keep the specular highlights over a transparent surface (only the most limunous ones).
  117317. * A car glass is a good exemple of that. When sun reflects on it you can not see what is behind.
  117318. */
  117319. useSpecularOverAlpha: boolean;
  117320. /**
  117321. * Specifies if the reflectivity texture contains the glossiness information in its alpha channel.
  117322. */
  117323. useMicroSurfaceFromReflectivityMapAlpha: boolean;
  117324. /**
  117325. * Specifies if the metallic texture contains the roughness information in its alpha channel.
  117326. */
  117327. useRoughnessFromMetallicTextureAlpha: boolean;
  117328. /**
  117329. * Specifies if the metallic texture contains the roughness information in its green channel.
  117330. */
  117331. useRoughnessFromMetallicTextureGreen: boolean;
  117332. /**
  117333. * Specifies if the metallic texture contains the metallness information in its blue channel.
  117334. */
  117335. useMetallnessFromMetallicTextureBlue: boolean;
  117336. /**
  117337. * Specifies if the metallic texture contains the ambient occlusion information in its red channel.
  117338. */
  117339. useAmbientOcclusionFromMetallicTextureRed: boolean;
  117340. /**
  117341. * Specifies if the ambient texture contains the ambient occlusion information in its red channel only.
  117342. */
  117343. useAmbientInGrayScale: boolean;
  117344. /**
  117345. * In case the reflectivity map does not contain the microsurface information in its alpha channel,
  117346. * The material will try to infer what glossiness each pixel should be.
  117347. */
  117348. useAutoMicroSurfaceFromReflectivityMap: boolean;
  117349. /**
  117350. * BJS is using an harcoded light falloff based on a manually sets up range.
  117351. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  117352. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  117353. */
  117354. /**
  117355. * BJS is using an harcoded light falloff based on a manually sets up range.
  117356. * In PBR, one way to represents the fallof is to use the inverse squared root algorythm.
  117357. * This parameter can help you switch back to the BJS mode in order to create scenes using both materials.
  117358. */
  117359. usePhysicalLightFalloff: boolean;
  117360. /**
  117361. * In order to support the falloff compatibility with gltf, a special mode has been added
  117362. * to reproduce the gltf light falloff.
  117363. */
  117364. /**
  117365. * In order to support the falloff compatibility with gltf, a special mode has been added
  117366. * to reproduce the gltf light falloff.
  117367. */
  117368. useGLTFLightFalloff: boolean;
  117369. /**
  117370. * Specifies that the material will keeps the reflection highlights over a transparent surface (only the most limunous ones).
  117371. * A car glass is a good exemple of that. When the street lights reflects on it you can not see what is behind.
  117372. */
  117373. useRadianceOverAlpha: boolean;
  117374. /**
  117375. * Allows using an object space normal map (instead of tangent space).
  117376. */
  117377. useObjectSpaceNormalMap: boolean;
  117378. /**
  117379. * Allows using the bump map in parallax mode.
  117380. */
  117381. useParallax: boolean;
  117382. /**
  117383. * Allows using the bump map in parallax occlusion mode.
  117384. */
  117385. useParallaxOcclusion: boolean;
  117386. /**
  117387. * Controls the scale bias of the parallax mode.
  117388. */
  117389. parallaxScaleBias: number;
  117390. /**
  117391. * If sets to true, disables all the lights affecting the material.
  117392. */
  117393. disableLighting: boolean;
  117394. /**
  117395. * Force the shader to compute irradiance in the fragment shader in order to take bump in account.
  117396. */
  117397. forceIrradianceInFragment: boolean;
  117398. /**
  117399. * Number of Simultaneous lights allowed on the material.
  117400. */
  117401. maxSimultaneousLights: number;
  117402. /**
  117403. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  117404. */
  117405. invertNormalMapX: boolean;
  117406. /**
  117407. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  117408. */
  117409. invertNormalMapY: boolean;
  117410. /**
  117411. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  117412. */
  117413. twoSidedLighting: boolean;
  117414. /**
  117415. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  117416. * And/Or occlude the blended part. (alpha is converted to gamma to compute the fresnel)
  117417. */
  117418. useAlphaFresnel: boolean;
  117419. /**
  117420. * A fresnel is applied to the alpha of the model to ensure grazing angles edges are not alpha tested.
  117421. * And/Or occlude the blended part. (alpha stays linear to compute the fresnel)
  117422. */
  117423. useLinearAlphaFresnel: boolean;
  117424. /**
  117425. * Let user defines the brdf lookup texture used for IBL.
  117426. * A default 8bit version is embedded but you could point at :
  117427. * * Default texture: https://assets.babylonjs.com/environments/correlatedMSBRDF_RGBD.png
  117428. * * Default 16bit pixel depth texture: https://assets.babylonjs.com/environments/correlatedMSBRDF.dds
  117429. * * LEGACY Default None correlated https://assets.babylonjs.com/environments/uncorrelatedBRDF_RGBD.png
  117430. * * LEGACY Default None correlated 16bit pixel depth https://assets.babylonjs.com/environments/uncorrelatedBRDF.dds
  117431. */
  117432. environmentBRDFTexture: Nullable<BaseTexture>;
  117433. /**
  117434. * Force normal to face away from face.
  117435. */
  117436. forceNormalForward: boolean;
  117437. /**
  117438. * Enables specular anti aliasing in the PBR shader.
  117439. * It will both interacts on the Geometry for analytical and IBL lighting.
  117440. * It also prefilter the roughness map based on the bump values.
  117441. */
  117442. enableSpecularAntiAliasing: boolean;
  117443. /**
  117444. * This parameters will enable/disable Horizon occlusion to prevent normal maps to look shiny when the normal
  117445. * makes the reflect vector face the model (under horizon).
  117446. */
  117447. useHorizonOcclusion: boolean;
  117448. /**
  117449. * This parameters will enable/disable radiance occlusion by preventing the radiance to lit
  117450. * too much the area relying on ambient texture to define their ambient occlusion.
  117451. */
  117452. useRadianceOcclusion: boolean;
  117453. /**
  117454. * If set to true, no lighting calculations will be applied.
  117455. */
  117456. unlit: boolean;
  117457. /**
  117458. * Gets the image processing configuration used either in this material.
  117459. */
  117460. /**
  117461. * Sets the Default image processing configuration used either in the this material.
  117462. *
  117463. * If sets to null, the scene one is in use.
  117464. */
  117465. imageProcessingConfiguration: ImageProcessingConfiguration;
  117466. /**
  117467. * Gets wether the color curves effect is enabled.
  117468. */
  117469. /**
  117470. * Sets wether the color curves effect is enabled.
  117471. */
  117472. cameraColorCurvesEnabled: boolean;
  117473. /**
  117474. * Gets wether the color grading effect is enabled.
  117475. */
  117476. /**
  117477. * Gets wether the color grading effect is enabled.
  117478. */
  117479. cameraColorGradingEnabled: boolean;
  117480. /**
  117481. * Gets wether tonemapping is enabled or not.
  117482. */
  117483. /**
  117484. * Sets wether tonemapping is enabled or not
  117485. */
  117486. cameraToneMappingEnabled: boolean;
  117487. /**
  117488. * The camera exposure used on this material.
  117489. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  117490. * This corresponds to a photographic exposure.
  117491. */
  117492. /**
  117493. * The camera exposure used on this material.
  117494. * This property is here and not in the camera to allow controlling exposure without full screen post process.
  117495. * This corresponds to a photographic exposure.
  117496. */
  117497. cameraExposure: number;
  117498. /**
  117499. * Gets The camera contrast used on this material.
  117500. */
  117501. /**
  117502. * Sets The camera contrast used on this material.
  117503. */
  117504. cameraContrast: number;
  117505. /**
  117506. * Gets the Color Grading 2D Lookup Texture.
  117507. */
  117508. /**
  117509. * Sets the Color Grading 2D Lookup Texture.
  117510. */
  117511. cameraColorGradingTexture: Nullable<BaseTexture>;
  117512. /**
  117513. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  117514. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  117515. * 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;
  117516. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  117517. */
  117518. /**
  117519. * The color grading curves provide additional color adjustmnent that is applied after any color grading transform (3D LUT).
  117520. * They allow basic adjustment of saturation and small exposure adjustments, along with color filter tinting to provide white balance adjustment or more stylistic effects.
  117521. * 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;
  117522. * corresponding to low luminance, medium luminance, and high luminance areas respectively.
  117523. */
  117524. cameraColorCurves: Nullable<ColorCurves>;
  117525. /**
  117526. * Instantiates a new PBRMaterial instance.
  117527. *
  117528. * @param name The material name
  117529. * @param scene The scene the material will be use in.
  117530. */
  117531. constructor(name: string, scene: Scene);
  117532. /**
  117533. * Returns the name of this material class.
  117534. */
  117535. getClassName(): string;
  117536. /**
  117537. * Makes a duplicate of the current material.
  117538. * @param name - name to use for the new material.
  117539. */
  117540. clone(name: string): PBRMaterial;
  117541. /**
  117542. * Serializes this PBR Material.
  117543. * @returns - An object with the serialized material.
  117544. */
  117545. serialize(): any;
  117546. /**
  117547. * Parses a PBR Material from a serialized object.
  117548. * @param source - Serialized object.
  117549. * @param scene - BJS scene instance.
  117550. * @param rootUrl - url for the scene object
  117551. * @returns - PBRMaterial
  117552. */
  117553. static Parse(source: any, scene: Scene, rootUrl: string): PBRMaterial;
  117554. }
  117555. }
  117556. declare module BABYLON {
  117557. /**
  117558. * Direct draw surface info
  117559. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dx-graphics-dds-pguide
  117560. */
  117561. export interface DDSInfo {
  117562. /**
  117563. * Width of the texture
  117564. */
  117565. width: number;
  117566. /**
  117567. * Width of the texture
  117568. */
  117569. height: number;
  117570. /**
  117571. * Number of Mipmaps for the texture
  117572. * @see https://en.wikipedia.org/wiki/Mipmap
  117573. */
  117574. mipmapCount: number;
  117575. /**
  117576. * If the textures format is a known fourCC format
  117577. * @see https://www.fourcc.org/
  117578. */
  117579. isFourCC: boolean;
  117580. /**
  117581. * If the texture is an RGB format eg. DXGI_FORMAT_B8G8R8X8_UNORM format
  117582. */
  117583. isRGB: boolean;
  117584. /**
  117585. * If the texture is a lumincance format
  117586. */
  117587. isLuminance: boolean;
  117588. /**
  117589. * If this is a cube texture
  117590. * @see https://docs.microsoft.com/en-us/windows/desktop/direct3ddds/dds-file-layout-for-cubic-environment-maps
  117591. */
  117592. isCube: boolean;
  117593. /**
  117594. * If the texture is a compressed format eg. FOURCC_DXT1
  117595. */
  117596. isCompressed: boolean;
  117597. /**
  117598. * The dxgiFormat of the texture
  117599. * @see https://docs.microsoft.com/en-us/windows/desktop/api/dxgiformat/ne-dxgiformat-dxgi_format
  117600. */
  117601. dxgiFormat: number;
  117602. /**
  117603. * Texture type eg. Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT
  117604. */
  117605. textureType: number;
  117606. /**
  117607. * Sphericle polynomial created for the dds texture
  117608. */
  117609. sphericalPolynomial?: SphericalPolynomial;
  117610. }
  117611. /**
  117612. * Class used to provide DDS decompression tools
  117613. */
  117614. export class DDSTools {
  117615. /**
  117616. * Gets or sets a boolean indicating that LOD info is stored in alpha channel (false by default)
  117617. */
  117618. static StoreLODInAlphaChannel: boolean;
  117619. /**
  117620. * Gets DDS information from an array buffer
  117621. * @param arrayBuffer defines the array buffer to read data from
  117622. * @returns the DDS information
  117623. */
  117624. static GetDDSInfo(arrayBuffer: any): DDSInfo;
  117625. private static _FloatView;
  117626. private static _Int32View;
  117627. private static _ToHalfFloat;
  117628. private static _FromHalfFloat;
  117629. private static _GetHalfFloatAsFloatRGBAArrayBuffer;
  117630. private static _GetHalfFloatRGBAArrayBuffer;
  117631. private static _GetFloatRGBAArrayBuffer;
  117632. private static _GetFloatAsUIntRGBAArrayBuffer;
  117633. private static _GetHalfFloatAsUIntRGBAArrayBuffer;
  117634. private static _GetRGBAArrayBuffer;
  117635. private static _ExtractLongWordOrder;
  117636. private static _GetRGBArrayBuffer;
  117637. private static _GetLuminanceArrayBuffer;
  117638. /**
  117639. * Uploads DDS Levels to a Babylon Texture
  117640. * @hidden
  117641. */
  117642. static UploadDDSLevels(engine: ThinEngine, texture: InternalTexture, arrayBuffer: any, info: DDSInfo, loadMipmaps: boolean, faces: number, lodIndex?: number, currentFace?: number): void;
  117643. }
  117644. interface ThinEngine {
  117645. /**
  117646. * Create a cube texture from prefiltered data (ie. the mipmaps contain ready to use data for PBR reflection)
  117647. * @param rootUrl defines the url where the file to load is located
  117648. * @param scene defines the current scene
  117649. * @param lodScale defines scale to apply to the mip map selection
  117650. * @param lodOffset defines offset to apply to the mip map selection
  117651. * @param onLoad defines an optional callback raised when the texture is loaded
  117652. * @param onError defines an optional callback raised if there is an issue to load the texture
  117653. * @param format defines the format of the data
  117654. * @param forcedExtension defines the extension to use to pick the right loader
  117655. * @param createPolynomials defines wheter or not to create polynomails harmonics for the texture
  117656. * @returns the cube texture as an InternalTexture
  117657. */
  117658. 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;
  117659. }
  117660. }
  117661. declare module BABYLON {
  117662. /**
  117663. * Implementation of the DDS Texture Loader.
  117664. * @hidden
  117665. */
  117666. export class _DDSTextureLoader implements IInternalTextureLoader {
  117667. /**
  117668. * Defines wether the loader supports cascade loading the different faces.
  117669. */
  117670. readonly supportCascades: boolean;
  117671. /**
  117672. * This returns if the loader support the current file information.
  117673. * @param extension defines the file extension of the file being loaded
  117674. * @param textureFormatInUse defines the current compressed format in use iun the engine
  117675. * @param fallback defines the fallback internal texture if any
  117676. * @param isBase64 defines whether the texture is encoded as a base64
  117677. * @param isBuffer defines whether the texture data are stored as a buffer
  117678. * @returns true if the loader can load the specified file
  117679. */
  117680. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  117681. /**
  117682. * Transform the url before loading if required.
  117683. * @param rootUrl the url of the texture
  117684. * @param textureFormatInUse defines the current compressed format in use iun the engine
  117685. * @returns the transformed texture
  117686. */
  117687. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  117688. /**
  117689. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  117690. * @param rootUrl the url of the texture
  117691. * @param textureFormatInUse defines the current compressed format in use iun the engine
  117692. * @returns the fallback texture
  117693. */
  117694. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  117695. /**
  117696. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  117697. * @param data contains the texture data
  117698. * @param texture defines the BabylonJS internal texture
  117699. * @param createPolynomials will be true if polynomials have been requested
  117700. * @param onLoad defines the callback to trigger once the texture is ready
  117701. * @param onError defines the callback to trigger in case of error
  117702. */
  117703. loadCubeData(imgs: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  117704. /**
  117705. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  117706. * @param data contains the texture data
  117707. * @param texture defines the BabylonJS internal texture
  117708. * @param callback defines the method to call once ready to upload
  117709. */
  117710. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  117711. }
  117712. }
  117713. declare module BABYLON {
  117714. /**
  117715. * Implementation of the ENV Texture Loader.
  117716. * @hidden
  117717. */
  117718. export class _ENVTextureLoader implements IInternalTextureLoader {
  117719. /**
  117720. * Defines wether the loader supports cascade loading the different faces.
  117721. */
  117722. readonly supportCascades: boolean;
  117723. /**
  117724. * This returns if the loader support the current file information.
  117725. * @param extension defines the file extension of the file being loaded
  117726. * @param textureFormatInUse defines the current compressed format in use iun the engine
  117727. * @param fallback defines the fallback internal texture if any
  117728. * @param isBase64 defines whether the texture is encoded as a base64
  117729. * @param isBuffer defines whether the texture data are stored as a buffer
  117730. * @returns true if the loader can load the specified file
  117731. */
  117732. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  117733. /**
  117734. * Transform the url before loading if required.
  117735. * @param rootUrl the url of the texture
  117736. * @param textureFormatInUse defines the current compressed format in use iun the engine
  117737. * @returns the transformed texture
  117738. */
  117739. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  117740. /**
  117741. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  117742. * @param rootUrl the url of the texture
  117743. * @param textureFormatInUse defines the current compressed format in use iun the engine
  117744. * @returns the fallback texture
  117745. */
  117746. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  117747. /**
  117748. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  117749. * @param data contains the texture data
  117750. * @param texture defines the BabylonJS internal texture
  117751. * @param createPolynomials will be true if polynomials have been requested
  117752. * @param onLoad defines the callback to trigger once the texture is ready
  117753. * @param onError defines the callback to trigger in case of error
  117754. */
  117755. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  117756. /**
  117757. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  117758. * @param data contains the texture data
  117759. * @param texture defines the BabylonJS internal texture
  117760. * @param callback defines the method to call once ready to upload
  117761. */
  117762. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  117763. }
  117764. }
  117765. declare module BABYLON {
  117766. /**
  117767. * for description see https://www.khronos.org/opengles/sdk/tools/KTX/
  117768. * for file layout see https://www.khronos.org/opengles/sdk/tools/KTX/file_format_spec/
  117769. */
  117770. export class KhronosTextureContainer {
  117771. /** contents of the KTX container file */
  117772. arrayBuffer: any;
  117773. private static HEADER_LEN;
  117774. private static COMPRESSED_2D;
  117775. private static COMPRESSED_3D;
  117776. private static TEX_2D;
  117777. private static TEX_3D;
  117778. /**
  117779. * Gets the openGL type
  117780. */
  117781. glType: number;
  117782. /**
  117783. * Gets the openGL type size
  117784. */
  117785. glTypeSize: number;
  117786. /**
  117787. * Gets the openGL format
  117788. */
  117789. glFormat: number;
  117790. /**
  117791. * Gets the openGL internal format
  117792. */
  117793. glInternalFormat: number;
  117794. /**
  117795. * Gets the base internal format
  117796. */
  117797. glBaseInternalFormat: number;
  117798. /**
  117799. * Gets image width in pixel
  117800. */
  117801. pixelWidth: number;
  117802. /**
  117803. * Gets image height in pixel
  117804. */
  117805. pixelHeight: number;
  117806. /**
  117807. * Gets image depth in pixels
  117808. */
  117809. pixelDepth: number;
  117810. /**
  117811. * Gets the number of array elements
  117812. */
  117813. numberOfArrayElements: number;
  117814. /**
  117815. * Gets the number of faces
  117816. */
  117817. numberOfFaces: number;
  117818. /**
  117819. * Gets the number of mipmap levels
  117820. */
  117821. numberOfMipmapLevels: number;
  117822. /**
  117823. * Gets the bytes of key value data
  117824. */
  117825. bytesOfKeyValueData: number;
  117826. /**
  117827. * Gets the load type
  117828. */
  117829. loadType: number;
  117830. /**
  117831. * If the container has been made invalid (eg. constructor failed to correctly load array buffer)
  117832. */
  117833. isInvalid: boolean;
  117834. /**
  117835. * Creates a new KhronosTextureContainer
  117836. * @param arrayBuffer contents of the KTX container file
  117837. * @param facesExpected should be either 1 or 6, based whether a cube texture or or
  117838. * @param threeDExpected provision for indicating that data should be a 3D texture, not implemented
  117839. * @param textureArrayExpected provision for indicating that data should be a texture array, not implemented
  117840. */
  117841. constructor(
  117842. /** contents of the KTX container file */
  117843. arrayBuffer: any, facesExpected: number, threeDExpected?: boolean, textureArrayExpected?: boolean);
  117844. /**
  117845. * Uploads KTX content to a Babylon Texture.
  117846. * It is assumed that the texture has already been created & is currently bound
  117847. * @hidden
  117848. */
  117849. uploadLevels(texture: InternalTexture, loadMipmaps: boolean): void;
  117850. private _upload2DCompressedLevels;
  117851. }
  117852. }
  117853. declare module BABYLON {
  117854. /**
  117855. * Implementation of the KTX Texture Loader.
  117856. * @hidden
  117857. */
  117858. export class _KTXTextureLoader implements IInternalTextureLoader {
  117859. /**
  117860. * Defines wether the loader supports cascade loading the different faces.
  117861. */
  117862. readonly supportCascades: boolean;
  117863. /**
  117864. * This returns if the loader support the current file information.
  117865. * @param extension defines the file extension of the file being loaded
  117866. * @param textureFormatInUse defines the current compressed format in use iun the engine
  117867. * @param fallback defines the fallback internal texture if any
  117868. * @param isBase64 defines whether the texture is encoded as a base64
  117869. * @param isBuffer defines whether the texture data are stored as a buffer
  117870. * @returns true if the loader can load the specified file
  117871. */
  117872. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  117873. /**
  117874. * Transform the url before loading if required.
  117875. * @param rootUrl the url of the texture
  117876. * @param textureFormatInUse defines the current compressed format in use iun the engine
  117877. * @returns the transformed texture
  117878. */
  117879. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  117880. /**
  117881. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  117882. * @param rootUrl the url of the texture
  117883. * @param textureFormatInUse defines the current compressed format in use iun the engine
  117884. * @returns the fallback texture
  117885. */
  117886. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  117887. /**
  117888. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  117889. * @param data contains the texture data
  117890. * @param texture defines the BabylonJS internal texture
  117891. * @param createPolynomials will be true if polynomials have been requested
  117892. * @param onLoad defines the callback to trigger once the texture is ready
  117893. * @param onError defines the callback to trigger in case of error
  117894. */
  117895. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  117896. /**
  117897. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  117898. * @param data contains the texture data
  117899. * @param texture defines the BabylonJS internal texture
  117900. * @param callback defines the method to call once ready to upload
  117901. */
  117902. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void, loadFailed: boolean) => void): void;
  117903. }
  117904. }
  117905. declare module BABYLON {
  117906. /** @hidden */
  117907. export var _forceSceneHelpersToBundle: boolean;
  117908. interface Scene {
  117909. /**
  117910. * Creates a default light for the scene.
  117911. * @see http://doc.babylonjs.com/How_To/Fast_Build#create-default-light
  117912. * @param replace has the default false, when true replaces the existing lights in the scene with a hemispheric light
  117913. */
  117914. createDefaultLight(replace?: boolean): void;
  117915. /**
  117916. * Creates a default camera for the scene.
  117917. * @see http://doc.babylonjs.com/How_To/Fast_Build#create-default-camera
  117918. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  117919. * @param replace has default false, when true replaces the active camera in the scene
  117920. * @param attachCameraControls has default false, when true attaches camera controls to the canvas.
  117921. */
  117922. createDefaultCamera(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  117923. /**
  117924. * Creates a default camera and a default light.
  117925. * @see http://doc.babylonjs.com/how_to/Fast_Build#create-default-camera-or-light
  117926. * @param createArcRotateCamera has the default false which creates a free camera, when true creates an arc rotate camera
  117927. * @param replace has the default false, when true replaces the active camera/light in the scene
  117928. * @param attachCameraControls has the default false, when true attaches camera controls to the canvas.
  117929. */
  117930. createDefaultCameraOrLight(createArcRotateCamera?: boolean, replace?: boolean, attachCameraControls?: boolean): void;
  117931. /**
  117932. * Creates a new sky box
  117933. * @see http://doc.babylonjs.com/how_to/Fast_Build#create-default-skybox
  117934. * @param environmentTexture defines the texture to use as environment texture
  117935. * @param pbr has default false which requires the StandardMaterial to be used, when true PBRMaterial must be used
  117936. * @param scale defines the overall scale of the skybox
  117937. * @param blur is only available when pbr is true, default is 0, no blur, maximum value is 1
  117938. * @param setGlobalEnvTexture has default true indicating that scene.environmentTexture must match the current skybox texture
  117939. * @returns a new mesh holding the sky box
  117940. */
  117941. createDefaultSkybox(environmentTexture?: BaseTexture, pbr?: boolean, scale?: number, blur?: number, setGlobalEnvTexture?: boolean): Nullable<Mesh>;
  117942. /**
  117943. * Creates a new environment
  117944. * @see http://doc.babylonjs.com/How_To/Fast_Build#create-default-environment
  117945. * @param options defines the options you can use to configure the environment
  117946. * @returns the new EnvironmentHelper
  117947. */
  117948. createDefaultEnvironment(options?: Partial<IEnvironmentHelperOptions>): Nullable<EnvironmentHelper>;
  117949. /**
  117950. * Creates a new VREXperienceHelper
  117951. * @see http://doc.babylonjs.com/how_to/webvr_helper
  117952. * @param webVROptions defines the options used to create the new VREXperienceHelper
  117953. * @returns a new VREXperienceHelper
  117954. */
  117955. createDefaultVRExperience(webVROptions?: VRExperienceHelperOptions): VRExperienceHelper;
  117956. /**
  117957. * Creates a new WebXRDefaultExperience
  117958. * @see http://doc.babylonjs.com/how_to/webxr
  117959. * @param options experience options
  117960. * @returns a promise for a new WebXRDefaultExperience
  117961. */
  117962. createDefaultXRExperienceAsync(options: WebXRDefaultExperienceOptions): Promise<WebXRDefaultExperience>;
  117963. }
  117964. }
  117965. declare module BABYLON {
  117966. /**
  117967. * Display a 360/180 degree video on an approximately spherical surface, useful for VR applications or skyboxes.
  117968. * As a subclass of TransformNode, this allow parenting to the camera or multiple videos with different locations in the scene.
  117969. * This class achieves its effect with a VideoTexture and a correctly configured BackgroundMaterial on an inverted sphere.
  117970. * Potential additions to this helper include zoom and and non-infinite distance rendering effects.
  117971. */
  117972. export class VideoDome extends TransformNode {
  117973. /**
  117974. * Define the video source as a Monoscopic panoramic 360 video.
  117975. */
  117976. static readonly MODE_MONOSCOPIC: number;
  117977. /**
  117978. * Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  117979. */
  117980. static readonly MODE_TOPBOTTOM: number;
  117981. /**
  117982. * Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  117983. */
  117984. static readonly MODE_SIDEBYSIDE: number;
  117985. private _halfDome;
  117986. private _useDirectMapping;
  117987. /**
  117988. * The video texture being displayed on the sphere
  117989. */
  117990. protected _videoTexture: VideoTexture;
  117991. /**
  117992. * Gets the video texture being displayed on the sphere
  117993. */
  117994. readonly videoTexture: VideoTexture;
  117995. /**
  117996. * The skybox material
  117997. */
  117998. protected _material: BackgroundMaterial;
  117999. /**
  118000. * The surface used for the skybox
  118001. */
  118002. protected _mesh: Mesh;
  118003. /**
  118004. * A mesh that will be used to mask the back of the video dome in case it is a 180 degree movie.
  118005. */
  118006. private _halfDomeMask;
  118007. /**
  118008. * The current fov(field of view) multiplier, 0.0 - 2.0. Defaults to 1.0. Lower values "zoom in" and higher values "zoom out".
  118009. * Also see the options.resolution property.
  118010. */
  118011. fovMultiplier: number;
  118012. private _videoMode;
  118013. /**
  118014. * Gets or set the current video mode for the video. It can be:
  118015. * * VideoDome.MODE_MONOSCOPIC : Define the video source as a Monoscopic panoramic 360 video.
  118016. * * VideoDome.MODE_TOPBOTTOM : Define the video source as a Stereoscopic TopBottom/OverUnder panoramic 360 video.
  118017. * * VideoDome.MODE_SIDEBYSIDE : Define the video source as a Stereoscopic Side by Side panoramic 360 video.
  118018. */
  118019. videoMode: number;
  118020. /**
  118021. * Is the video a 180 degrees video (half dome) or 360 video (full dome)
  118022. *
  118023. */
  118024. /**
  118025. * Set the halfDome mode. If set, only the front (180 degrees) will be displayed and the back will be blacked out.
  118026. */
  118027. halfDome: boolean;
  118028. /**
  118029. * Oberserver used in Stereoscopic VR Mode.
  118030. */
  118031. private _onBeforeCameraRenderObserver;
  118032. /**
  118033. * Create an instance of this class and pass through the parameters to the relevant classes, VideoTexture, StandardMaterial, and Mesh.
  118034. * @param name Element's name, child elements will append suffixes for their own names.
  118035. * @param urlsOrVideo defines the url(s) or the video element to use
  118036. * @param options An object containing optional or exposed sub element properties
  118037. */
  118038. constructor(name: string, urlsOrVideo: string | string[] | HTMLVideoElement, options: {
  118039. resolution?: number;
  118040. clickToPlay?: boolean;
  118041. autoPlay?: boolean;
  118042. loop?: boolean;
  118043. size?: number;
  118044. poster?: string;
  118045. faceForward?: boolean;
  118046. useDirectMapping?: boolean;
  118047. halfDomeMode?: boolean;
  118048. }, scene: Scene);
  118049. private _changeVideoMode;
  118050. /**
  118051. * Releases resources associated with this node.
  118052. * @param doNotRecurse Set to true to not recurse into each children (recurse into each children by default)
  118053. * @param disposeMaterialAndTextures Set to true to also dispose referenced materials and textures (false by default)
  118054. */
  118055. dispose(doNotRecurse?: boolean, disposeMaterialAndTextures?: boolean): void;
  118056. }
  118057. }
  118058. declare module BABYLON {
  118059. /**
  118060. * This class can be used to get instrumentation data from a Babylon engine
  118061. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  118062. */
  118063. export class EngineInstrumentation implements IDisposable {
  118064. /**
  118065. * Define the instrumented engine.
  118066. */
  118067. engine: Engine;
  118068. private _captureGPUFrameTime;
  118069. private _gpuFrameTimeToken;
  118070. private _gpuFrameTime;
  118071. private _captureShaderCompilationTime;
  118072. private _shaderCompilationTime;
  118073. private _onBeginFrameObserver;
  118074. private _onEndFrameObserver;
  118075. private _onBeforeShaderCompilationObserver;
  118076. private _onAfterShaderCompilationObserver;
  118077. /**
  118078. * Gets the perf counter used for GPU frame time
  118079. */
  118080. readonly gpuFrameTimeCounter: PerfCounter;
  118081. /**
  118082. * Gets the GPU frame time capture status
  118083. */
  118084. /**
  118085. * Enable or disable the GPU frame time capture
  118086. */
  118087. captureGPUFrameTime: boolean;
  118088. /**
  118089. * Gets the perf counter used for shader compilation time
  118090. */
  118091. readonly shaderCompilationTimeCounter: PerfCounter;
  118092. /**
  118093. * Gets the shader compilation time capture status
  118094. */
  118095. /**
  118096. * Enable or disable the shader compilation time capture
  118097. */
  118098. captureShaderCompilationTime: boolean;
  118099. /**
  118100. * Instantiates a new engine instrumentation.
  118101. * This class can be used to get instrumentation data from a Babylon engine
  118102. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#engineinstrumentation
  118103. * @param engine Defines the engine to instrument
  118104. */
  118105. constructor(
  118106. /**
  118107. * Define the instrumented engine.
  118108. */
  118109. engine: Engine);
  118110. /**
  118111. * Dispose and release associated resources.
  118112. */
  118113. dispose(): void;
  118114. }
  118115. }
  118116. declare module BABYLON {
  118117. /**
  118118. * This class can be used to get instrumentation data from a Babylon engine
  118119. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  118120. */
  118121. export class SceneInstrumentation implements IDisposable {
  118122. /**
  118123. * Defines the scene to instrument
  118124. */
  118125. scene: Scene;
  118126. private _captureActiveMeshesEvaluationTime;
  118127. private _activeMeshesEvaluationTime;
  118128. private _captureRenderTargetsRenderTime;
  118129. private _renderTargetsRenderTime;
  118130. private _captureFrameTime;
  118131. private _frameTime;
  118132. private _captureRenderTime;
  118133. private _renderTime;
  118134. private _captureInterFrameTime;
  118135. private _interFrameTime;
  118136. private _captureParticlesRenderTime;
  118137. private _particlesRenderTime;
  118138. private _captureSpritesRenderTime;
  118139. private _spritesRenderTime;
  118140. private _capturePhysicsTime;
  118141. private _physicsTime;
  118142. private _captureAnimationsTime;
  118143. private _animationsTime;
  118144. private _captureCameraRenderTime;
  118145. private _cameraRenderTime;
  118146. private _onBeforeActiveMeshesEvaluationObserver;
  118147. private _onAfterActiveMeshesEvaluationObserver;
  118148. private _onBeforeRenderTargetsRenderObserver;
  118149. private _onAfterRenderTargetsRenderObserver;
  118150. private _onAfterRenderObserver;
  118151. private _onBeforeDrawPhaseObserver;
  118152. private _onAfterDrawPhaseObserver;
  118153. private _onBeforeAnimationsObserver;
  118154. private _onBeforeParticlesRenderingObserver;
  118155. private _onAfterParticlesRenderingObserver;
  118156. private _onBeforeSpritesRenderingObserver;
  118157. private _onAfterSpritesRenderingObserver;
  118158. private _onBeforePhysicsObserver;
  118159. private _onAfterPhysicsObserver;
  118160. private _onAfterAnimationsObserver;
  118161. private _onBeforeCameraRenderObserver;
  118162. private _onAfterCameraRenderObserver;
  118163. /**
  118164. * Gets the perf counter used for active meshes evaluation time
  118165. */
  118166. readonly activeMeshesEvaluationTimeCounter: PerfCounter;
  118167. /**
  118168. * Gets the active meshes evaluation time capture status
  118169. */
  118170. /**
  118171. * Enable or disable the active meshes evaluation time capture
  118172. */
  118173. captureActiveMeshesEvaluationTime: boolean;
  118174. /**
  118175. * Gets the perf counter used for render targets render time
  118176. */
  118177. readonly renderTargetsRenderTimeCounter: PerfCounter;
  118178. /**
  118179. * Gets the render targets render time capture status
  118180. */
  118181. /**
  118182. * Enable or disable the render targets render time capture
  118183. */
  118184. captureRenderTargetsRenderTime: boolean;
  118185. /**
  118186. * Gets the perf counter used for particles render time
  118187. */
  118188. readonly particlesRenderTimeCounter: PerfCounter;
  118189. /**
  118190. * Gets the particles render time capture status
  118191. */
  118192. /**
  118193. * Enable or disable the particles render time capture
  118194. */
  118195. captureParticlesRenderTime: boolean;
  118196. /**
  118197. * Gets the perf counter used for sprites render time
  118198. */
  118199. readonly spritesRenderTimeCounter: PerfCounter;
  118200. /**
  118201. * Gets the sprites render time capture status
  118202. */
  118203. /**
  118204. * Enable or disable the sprites render time capture
  118205. */
  118206. captureSpritesRenderTime: boolean;
  118207. /**
  118208. * Gets the perf counter used for physics time
  118209. */
  118210. readonly physicsTimeCounter: PerfCounter;
  118211. /**
  118212. * Gets the physics time capture status
  118213. */
  118214. /**
  118215. * Enable or disable the physics time capture
  118216. */
  118217. capturePhysicsTime: boolean;
  118218. /**
  118219. * Gets the perf counter used for animations time
  118220. */
  118221. readonly animationsTimeCounter: PerfCounter;
  118222. /**
  118223. * Gets the animations time capture status
  118224. */
  118225. /**
  118226. * Enable or disable the animations time capture
  118227. */
  118228. captureAnimationsTime: boolean;
  118229. /**
  118230. * Gets the perf counter used for frame time capture
  118231. */
  118232. readonly frameTimeCounter: PerfCounter;
  118233. /**
  118234. * Gets the frame time capture status
  118235. */
  118236. /**
  118237. * Enable or disable the frame time capture
  118238. */
  118239. captureFrameTime: boolean;
  118240. /**
  118241. * Gets the perf counter used for inter-frames time capture
  118242. */
  118243. readonly interFrameTimeCounter: PerfCounter;
  118244. /**
  118245. * Gets the inter-frames time capture status
  118246. */
  118247. /**
  118248. * Enable or disable the inter-frames time capture
  118249. */
  118250. captureInterFrameTime: boolean;
  118251. /**
  118252. * Gets the perf counter used for render time capture
  118253. */
  118254. readonly renderTimeCounter: PerfCounter;
  118255. /**
  118256. * Gets the render time capture status
  118257. */
  118258. /**
  118259. * Enable or disable the render time capture
  118260. */
  118261. captureRenderTime: boolean;
  118262. /**
  118263. * Gets the perf counter used for camera render time capture
  118264. */
  118265. readonly cameraRenderTimeCounter: PerfCounter;
  118266. /**
  118267. * Gets the camera render time capture status
  118268. */
  118269. /**
  118270. * Enable or disable the camera render time capture
  118271. */
  118272. captureCameraRenderTime: boolean;
  118273. /**
  118274. * Gets the perf counter used for draw calls
  118275. */
  118276. readonly drawCallsCounter: PerfCounter;
  118277. /**
  118278. * Instantiates a new scene instrumentation.
  118279. * This class can be used to get instrumentation data from a Babylon engine
  118280. * @see http://doc.babylonjs.com/how_to/optimizing_your_scene#sceneinstrumentation
  118281. * @param scene Defines the scene to instrument
  118282. */
  118283. constructor(
  118284. /**
  118285. * Defines the scene to instrument
  118286. */
  118287. scene: Scene);
  118288. /**
  118289. * Dispose and release associated resources.
  118290. */
  118291. dispose(): void;
  118292. }
  118293. }
  118294. declare module BABYLON {
  118295. /** @hidden */
  118296. export var glowMapGenerationPixelShader: {
  118297. name: string;
  118298. shader: string;
  118299. };
  118300. }
  118301. declare module BABYLON {
  118302. /** @hidden */
  118303. export var glowMapGenerationVertexShader: {
  118304. name: string;
  118305. shader: string;
  118306. };
  118307. }
  118308. declare module BABYLON {
  118309. /**
  118310. * Effect layer options. This helps customizing the behaviour
  118311. * of the effect layer.
  118312. */
  118313. export interface IEffectLayerOptions {
  118314. /**
  118315. * Multiplication factor apply to the canvas size to compute the render target size
  118316. * used to generated the objects (the smaller the faster).
  118317. */
  118318. mainTextureRatio: number;
  118319. /**
  118320. * Enforces a fixed size texture to ensure effect stability across devices.
  118321. */
  118322. mainTextureFixedSize?: number;
  118323. /**
  118324. * Alpha blending mode used to apply the blur. Default depends of the implementation.
  118325. */
  118326. alphaBlendingMode: number;
  118327. /**
  118328. * The camera attached to the layer.
  118329. */
  118330. camera: Nullable<Camera>;
  118331. /**
  118332. * The rendering group to draw the layer in.
  118333. */
  118334. renderingGroupId: number;
  118335. }
  118336. /**
  118337. * The effect layer Helps adding post process effect blended with the main pass.
  118338. *
  118339. * This can be for instance use to generate glow or higlight effects on the scene.
  118340. *
  118341. * The effect layer class can not be used directly and is intented to inherited from to be
  118342. * customized per effects.
  118343. */
  118344. export abstract class EffectLayer {
  118345. private _vertexBuffers;
  118346. private _indexBuffer;
  118347. private _cachedDefines;
  118348. private _effectLayerMapGenerationEffect;
  118349. private _effectLayerOptions;
  118350. private _mergeEffect;
  118351. protected _scene: Scene;
  118352. protected _engine: Engine;
  118353. protected _maxSize: number;
  118354. protected _mainTextureDesiredSize: ISize;
  118355. protected _mainTexture: RenderTargetTexture;
  118356. protected _shouldRender: boolean;
  118357. protected _postProcesses: PostProcess[];
  118358. protected _textures: BaseTexture[];
  118359. protected _emissiveTextureAndColor: {
  118360. texture: Nullable<BaseTexture>;
  118361. color: Color4;
  118362. };
  118363. /**
  118364. * The name of the layer
  118365. */
  118366. name: string;
  118367. /**
  118368. * The clear color of the texture used to generate the glow map.
  118369. */
  118370. neutralColor: Color4;
  118371. /**
  118372. * Specifies wether the highlight layer is enabled or not.
  118373. */
  118374. isEnabled: boolean;
  118375. /**
  118376. * Gets the camera attached to the layer.
  118377. */
  118378. readonly camera: Nullable<Camera>;
  118379. /**
  118380. * Gets the rendering group id the layer should render in.
  118381. */
  118382. renderingGroupId: number;
  118383. /**
  118384. * An event triggered when the effect layer has been disposed.
  118385. */
  118386. onDisposeObservable: Observable<EffectLayer>;
  118387. /**
  118388. * An event triggered when the effect layer is about rendering the main texture with the glowy parts.
  118389. */
  118390. onBeforeRenderMainTextureObservable: Observable<EffectLayer>;
  118391. /**
  118392. * An event triggered when the generated texture is being merged in the scene.
  118393. */
  118394. onBeforeComposeObservable: Observable<EffectLayer>;
  118395. /**
  118396. * An event triggered when the mesh is rendered into the effect render target.
  118397. */
  118398. onBeforeRenderMeshToEffect: Observable<AbstractMesh>;
  118399. /**
  118400. * An event triggered after the mesh has been rendered into the effect render target.
  118401. */
  118402. onAfterRenderMeshToEffect: Observable<AbstractMesh>;
  118403. /**
  118404. * An event triggered when the generated texture has been merged in the scene.
  118405. */
  118406. onAfterComposeObservable: Observable<EffectLayer>;
  118407. /**
  118408. * An event triggered when the efffect layer changes its size.
  118409. */
  118410. onSizeChangedObservable: Observable<EffectLayer>;
  118411. /** @hidden */
  118412. static _SceneComponentInitialization: (scene: Scene) => void;
  118413. /**
  118414. * Instantiates a new effect Layer and references it in the scene.
  118415. * @param name The name of the layer
  118416. * @param scene The scene to use the layer in
  118417. */
  118418. constructor(
  118419. /** The Friendly of the effect in the scene */
  118420. name: string, scene: Scene);
  118421. /**
  118422. * Get the effect name of the layer.
  118423. * @return The effect name
  118424. */
  118425. abstract getEffectName(): string;
  118426. /**
  118427. * Checks for the readiness of the element composing the layer.
  118428. * @param subMesh the mesh to check for
  118429. * @param useInstances specify wether or not to use instances to render the mesh
  118430. * @return true if ready otherwise, false
  118431. */
  118432. abstract isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  118433. /**
  118434. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  118435. * @returns true if the effect requires stencil during the main canvas render pass.
  118436. */
  118437. abstract needStencil(): boolean;
  118438. /**
  118439. * Create the merge effect. This is the shader use to blit the information back
  118440. * to the main canvas at the end of the scene rendering.
  118441. * @returns The effect containing the shader used to merge the effect on the main canvas
  118442. */
  118443. protected abstract _createMergeEffect(): Effect;
  118444. /**
  118445. * Creates the render target textures and post processes used in the effect layer.
  118446. */
  118447. protected abstract _createTextureAndPostProcesses(): void;
  118448. /**
  118449. * Implementation specific of rendering the generating effect on the main canvas.
  118450. * @param effect The effect used to render through
  118451. */
  118452. protected abstract _internalRender(effect: Effect): void;
  118453. /**
  118454. * Sets the required values for both the emissive texture and and the main color.
  118455. */
  118456. protected abstract _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  118457. /**
  118458. * Free any resources and references associated to a mesh.
  118459. * Internal use
  118460. * @param mesh The mesh to free.
  118461. */
  118462. abstract _disposeMesh(mesh: Mesh): void;
  118463. /**
  118464. * Serializes this layer (Glow or Highlight for example)
  118465. * @returns a serialized layer object
  118466. */
  118467. abstract serialize?(): any;
  118468. /**
  118469. * Initializes the effect layer with the required options.
  118470. * @param options Sets of none mandatory options to use with the layer (see IEffectLayerOptions for more information)
  118471. */
  118472. protected _init(options: Partial<IEffectLayerOptions>): void;
  118473. /**
  118474. * Generates the index buffer of the full screen quad blending to the main canvas.
  118475. */
  118476. private _generateIndexBuffer;
  118477. /**
  118478. * Generates the vertex buffer of the full screen quad blending to the main canvas.
  118479. */
  118480. private _generateVertexBuffer;
  118481. /**
  118482. * Sets the main texture desired size which is the closest power of two
  118483. * of the engine canvas size.
  118484. */
  118485. private _setMainTextureSize;
  118486. /**
  118487. * Creates the main texture for the effect layer.
  118488. */
  118489. protected _createMainTexture(): void;
  118490. /**
  118491. * Adds specific effects defines.
  118492. * @param defines The defines to add specifics to.
  118493. */
  118494. protected _addCustomEffectDefines(defines: string[]): void;
  118495. /**
  118496. * Checks for the readiness of the element composing the layer.
  118497. * @param subMesh the mesh to check for
  118498. * @param useInstances specify wether or not to use instances to render the mesh
  118499. * @param emissiveTexture the associated emissive texture used to generate the glow
  118500. * @return true if ready otherwise, false
  118501. */
  118502. protected _isReady(subMesh: SubMesh, useInstances: boolean, emissiveTexture: Nullable<BaseTexture>): boolean;
  118503. /**
  118504. * Renders the glowing part of the scene by blending the blurred glowing meshes on top of the rendered scene.
  118505. */
  118506. render(): void;
  118507. /**
  118508. * Determine if a given mesh will be used in the current effect.
  118509. * @param mesh mesh to test
  118510. * @returns true if the mesh will be used
  118511. */
  118512. hasMesh(mesh: AbstractMesh): boolean;
  118513. /**
  118514. * Returns true if the layer contains information to display, otherwise false.
  118515. * @returns true if the glow layer should be rendered
  118516. */
  118517. shouldRender(): boolean;
  118518. /**
  118519. * Returns true if the mesh should render, otherwise false.
  118520. * @param mesh The mesh to render
  118521. * @returns true if it should render otherwise false
  118522. */
  118523. protected _shouldRenderMesh(mesh: AbstractMesh): boolean;
  118524. /**
  118525. * Returns true if the mesh can be rendered, otherwise false.
  118526. * @param mesh The mesh to render
  118527. * @param material The material used on the mesh
  118528. * @returns true if it can be rendered otherwise false
  118529. */
  118530. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  118531. /**
  118532. * Returns true if the mesh should render, otherwise false.
  118533. * @param mesh The mesh to render
  118534. * @returns true if it should render otherwise false
  118535. */
  118536. protected _shouldRenderEmissiveTextureForMesh(): boolean;
  118537. /**
  118538. * Renders the submesh passed in parameter to the generation map.
  118539. */
  118540. protected _renderSubMesh(subMesh: SubMesh, enableAlphaMode?: boolean): void;
  118541. /**
  118542. * Defines wether the current material of the mesh should be use to render the effect.
  118543. * @param mesh defines the current mesh to render
  118544. */
  118545. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  118546. /**
  118547. * Rebuild the required buffers.
  118548. * @hidden Internal use only.
  118549. */
  118550. _rebuild(): void;
  118551. /**
  118552. * Dispose only the render target textures and post process.
  118553. */
  118554. private _disposeTextureAndPostProcesses;
  118555. /**
  118556. * Dispose the highlight layer and free resources.
  118557. */
  118558. dispose(): void;
  118559. /**
  118560. * Gets the class name of the effect layer
  118561. * @returns the string with the class name of the effect layer
  118562. */
  118563. getClassName(): string;
  118564. /**
  118565. * Creates an effect layer from parsed effect layer data
  118566. * @param parsedEffectLayer defines effect layer data
  118567. * @param scene defines the current scene
  118568. * @param rootUrl defines the root URL containing the effect layer information
  118569. * @returns a parsed effect Layer
  118570. */
  118571. static Parse(parsedEffectLayer: any, scene: Scene, rootUrl: string): EffectLayer;
  118572. }
  118573. }
  118574. declare module BABYLON {
  118575. interface AbstractScene {
  118576. /**
  118577. * The list of effect layers (highlights/glow) added to the scene
  118578. * @see http://doc.babylonjs.com/how_to/highlight_layer
  118579. * @see http://doc.babylonjs.com/how_to/glow_layer
  118580. */
  118581. effectLayers: Array<EffectLayer>;
  118582. /**
  118583. * Removes the given effect layer from this scene.
  118584. * @param toRemove defines the effect layer to remove
  118585. * @returns the index of the removed effect layer
  118586. */
  118587. removeEffectLayer(toRemove: EffectLayer): number;
  118588. /**
  118589. * Adds the given effect layer to this scene
  118590. * @param newEffectLayer defines the effect layer to add
  118591. */
  118592. addEffectLayer(newEffectLayer: EffectLayer): void;
  118593. }
  118594. /**
  118595. * Defines the layer scene component responsible to manage any effect layers
  118596. * in a given scene.
  118597. */
  118598. export class EffectLayerSceneComponent implements ISceneSerializableComponent {
  118599. /**
  118600. * The component name helpfull to identify the component in the list of scene components.
  118601. */
  118602. readonly name: string;
  118603. /**
  118604. * The scene the component belongs to.
  118605. */
  118606. scene: Scene;
  118607. private _engine;
  118608. private _renderEffects;
  118609. private _needStencil;
  118610. private _previousStencilState;
  118611. /**
  118612. * Creates a new instance of the component for the given scene
  118613. * @param scene Defines the scene to register the component in
  118614. */
  118615. constructor(scene: Scene);
  118616. /**
  118617. * Registers the component in a given scene
  118618. */
  118619. register(): void;
  118620. /**
  118621. * Rebuilds the elements related to this component in case of
  118622. * context lost for instance.
  118623. */
  118624. rebuild(): void;
  118625. /**
  118626. * Serializes the component data to the specified json object
  118627. * @param serializationObject The object to serialize to
  118628. */
  118629. serialize(serializationObject: any): void;
  118630. /**
  118631. * Adds all the elements from the container to the scene
  118632. * @param container the container holding the elements
  118633. */
  118634. addFromContainer(container: AbstractScene): void;
  118635. /**
  118636. * Removes all the elements in the container from the scene
  118637. * @param container contains the elements to remove
  118638. * @param dispose if the removed element should be disposed (default: false)
  118639. */
  118640. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  118641. /**
  118642. * Disposes the component and the associated ressources.
  118643. */
  118644. dispose(): void;
  118645. private _isReadyForMesh;
  118646. private _renderMainTexture;
  118647. private _setStencil;
  118648. private _setStencilBack;
  118649. private _draw;
  118650. private _drawCamera;
  118651. private _drawRenderingGroup;
  118652. }
  118653. }
  118654. declare module BABYLON {
  118655. /** @hidden */
  118656. export var glowMapMergePixelShader: {
  118657. name: string;
  118658. shader: string;
  118659. };
  118660. }
  118661. declare module BABYLON {
  118662. /** @hidden */
  118663. export var glowMapMergeVertexShader: {
  118664. name: string;
  118665. shader: string;
  118666. };
  118667. }
  118668. declare module BABYLON {
  118669. interface AbstractScene {
  118670. /**
  118671. * Return a the first highlight layer of the scene with a given name.
  118672. * @param name The name of the highlight layer to look for.
  118673. * @return The highlight layer if found otherwise null.
  118674. */
  118675. getGlowLayerByName(name: string): Nullable<GlowLayer>;
  118676. }
  118677. /**
  118678. * Glow layer options. This helps customizing the behaviour
  118679. * of the glow layer.
  118680. */
  118681. export interface IGlowLayerOptions {
  118682. /**
  118683. * Multiplication factor apply to the canvas size to compute the render target size
  118684. * used to generated the glowing objects (the smaller the faster).
  118685. */
  118686. mainTextureRatio: number;
  118687. /**
  118688. * Enforces a fixed size texture to ensure resize independant blur.
  118689. */
  118690. mainTextureFixedSize?: number;
  118691. /**
  118692. * How big is the kernel of the blur texture.
  118693. */
  118694. blurKernelSize: number;
  118695. /**
  118696. * The camera attached to the layer.
  118697. */
  118698. camera: Nullable<Camera>;
  118699. /**
  118700. * Enable MSAA by chosing the number of samples.
  118701. */
  118702. mainTextureSamples?: number;
  118703. /**
  118704. * The rendering group to draw the layer in.
  118705. */
  118706. renderingGroupId: number;
  118707. }
  118708. /**
  118709. * The glow layer Helps adding a glow effect around the emissive parts of a mesh.
  118710. *
  118711. * Once instantiated in a scene, by default, all the emissive meshes will glow.
  118712. *
  118713. * Documentation: https://doc.babylonjs.com/how_to/glow_layer
  118714. */
  118715. export class GlowLayer extends EffectLayer {
  118716. /**
  118717. * Effect Name of the layer.
  118718. */
  118719. static readonly EffectName: string;
  118720. /**
  118721. * The default blur kernel size used for the glow.
  118722. */
  118723. static DefaultBlurKernelSize: number;
  118724. /**
  118725. * The default texture size ratio used for the glow.
  118726. */
  118727. static DefaultTextureRatio: number;
  118728. /**
  118729. * Sets the kernel size of the blur.
  118730. */
  118731. /**
  118732. * Gets the kernel size of the blur.
  118733. */
  118734. blurKernelSize: number;
  118735. /**
  118736. * Sets the glow intensity.
  118737. */
  118738. /**
  118739. * Gets the glow intensity.
  118740. */
  118741. intensity: number;
  118742. private _options;
  118743. private _intensity;
  118744. private _horizontalBlurPostprocess1;
  118745. private _verticalBlurPostprocess1;
  118746. private _horizontalBlurPostprocess2;
  118747. private _verticalBlurPostprocess2;
  118748. private _blurTexture1;
  118749. private _blurTexture2;
  118750. private _postProcesses1;
  118751. private _postProcesses2;
  118752. private _includedOnlyMeshes;
  118753. private _excludedMeshes;
  118754. private _meshesUsingTheirOwnMaterials;
  118755. /**
  118756. * Callback used to let the user override the color selection on a per mesh basis
  118757. */
  118758. customEmissiveColorSelector: (mesh: Mesh, subMesh: SubMesh, material: Material, result: Color4) => void;
  118759. /**
  118760. * Callback used to let the user override the texture selection on a per mesh basis
  118761. */
  118762. customEmissiveTextureSelector: (mesh: Mesh, subMesh: SubMesh, material: Material) => Texture;
  118763. /**
  118764. * Instantiates a new glow Layer and references it to the scene.
  118765. * @param name The name of the layer
  118766. * @param scene The scene to use the layer in
  118767. * @param options Sets of none mandatory options to use with the layer (see IGlowLayerOptions for more information)
  118768. */
  118769. constructor(name: string, scene: Scene, options?: Partial<IGlowLayerOptions>);
  118770. /**
  118771. * Get the effect name of the layer.
  118772. * @return The effect name
  118773. */
  118774. getEffectName(): string;
  118775. /**
  118776. * Create the merge effect. This is the shader use to blit the information back
  118777. * to the main canvas at the end of the scene rendering.
  118778. */
  118779. protected _createMergeEffect(): Effect;
  118780. /**
  118781. * Creates the render target textures and post processes used in the glow layer.
  118782. */
  118783. protected _createTextureAndPostProcesses(): void;
  118784. /**
  118785. * Checks for the readiness of the element composing the layer.
  118786. * @param subMesh the mesh to check for
  118787. * @param useInstances specify wether or not to use instances to render the mesh
  118788. * @param emissiveTexture the associated emissive texture used to generate the glow
  118789. * @return true if ready otherwise, false
  118790. */
  118791. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  118792. /**
  118793. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  118794. */
  118795. needStencil(): boolean;
  118796. /**
  118797. * Returns true if the mesh can be rendered, otherwise false.
  118798. * @param mesh The mesh to render
  118799. * @param material The material used on the mesh
  118800. * @returns true if it can be rendered otherwise false
  118801. */
  118802. protected _canRenderMesh(mesh: AbstractMesh, material: Material): boolean;
  118803. /**
  118804. * Implementation specific of rendering the generating effect on the main canvas.
  118805. * @param effect The effect used to render through
  118806. */
  118807. protected _internalRender(effect: Effect): void;
  118808. /**
  118809. * Sets the required values for both the emissive texture and and the main color.
  118810. */
  118811. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  118812. /**
  118813. * Returns true if the mesh should render, otherwise false.
  118814. * @param mesh The mesh to render
  118815. * @returns true if it should render otherwise false
  118816. */
  118817. protected _shouldRenderMesh(mesh: Mesh): boolean;
  118818. /**
  118819. * Adds specific effects defines.
  118820. * @param defines The defines to add specifics to.
  118821. */
  118822. protected _addCustomEffectDefines(defines: string[]): void;
  118823. /**
  118824. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the glow layer.
  118825. * @param mesh The mesh to exclude from the glow layer
  118826. */
  118827. addExcludedMesh(mesh: Mesh): void;
  118828. /**
  118829. * Remove a mesh from the exclusion list to let it impact or being impacted by the glow layer.
  118830. * @param mesh The mesh to remove
  118831. */
  118832. removeExcludedMesh(mesh: Mesh): void;
  118833. /**
  118834. * Add a mesh in the inclusion list to impact or being impacted by the glow layer.
  118835. * @param mesh The mesh to include in the glow layer
  118836. */
  118837. addIncludedOnlyMesh(mesh: Mesh): void;
  118838. /**
  118839. * Remove a mesh from the Inclusion list to prevent it to impact or being impacted by the glow layer.
  118840. * @param mesh The mesh to remove
  118841. */
  118842. removeIncludedOnlyMesh(mesh: Mesh): void;
  118843. /**
  118844. * Determine if a given mesh will be used in the glow layer
  118845. * @param mesh The mesh to test
  118846. * @returns true if the mesh will be highlighted by the current glow layer
  118847. */
  118848. hasMesh(mesh: AbstractMesh): boolean;
  118849. /**
  118850. * Defines wether the current material of the mesh should be use to render the effect.
  118851. * @param mesh defines the current mesh to render
  118852. */
  118853. protected _useMeshMaterial(mesh: AbstractMesh): boolean;
  118854. /**
  118855. * Add a mesh to be rendered through its own material and not with emissive only.
  118856. * @param mesh The mesh for which we need to use its material
  118857. */
  118858. referenceMeshToUseItsOwnMaterial(mesh: AbstractMesh): void;
  118859. /**
  118860. * Remove a mesh from being rendered through its own material and not with emissive only.
  118861. * @param mesh The mesh for which we need to not use its material
  118862. */
  118863. unReferenceMeshFromUsingItsOwnMaterial(mesh: AbstractMesh): void;
  118864. /**
  118865. * Free any resources and references associated to a mesh.
  118866. * Internal use
  118867. * @param mesh The mesh to free.
  118868. * @hidden
  118869. */
  118870. _disposeMesh(mesh: Mesh): void;
  118871. /**
  118872. * Gets the class name of the effect layer
  118873. * @returns the string with the class name of the effect layer
  118874. */
  118875. getClassName(): string;
  118876. /**
  118877. * Serializes this glow layer
  118878. * @returns a serialized glow layer object
  118879. */
  118880. serialize(): any;
  118881. /**
  118882. * Creates a Glow Layer from parsed glow layer data
  118883. * @param parsedGlowLayer defines glow layer data
  118884. * @param scene defines the current scene
  118885. * @param rootUrl defines the root URL containing the glow layer information
  118886. * @returns a parsed Glow Layer
  118887. */
  118888. static Parse(parsedGlowLayer: any, scene: Scene, rootUrl: string): GlowLayer;
  118889. }
  118890. }
  118891. declare module BABYLON {
  118892. /** @hidden */
  118893. export var glowBlurPostProcessPixelShader: {
  118894. name: string;
  118895. shader: string;
  118896. };
  118897. }
  118898. declare module BABYLON {
  118899. interface AbstractScene {
  118900. /**
  118901. * Return a the first highlight layer of the scene with a given name.
  118902. * @param name The name of the highlight layer to look for.
  118903. * @return The highlight layer if found otherwise null.
  118904. */
  118905. getHighlightLayerByName(name: string): Nullable<HighlightLayer>;
  118906. }
  118907. /**
  118908. * Highlight layer options. This helps customizing the behaviour
  118909. * of the highlight layer.
  118910. */
  118911. export interface IHighlightLayerOptions {
  118912. /**
  118913. * Multiplication factor apply to the canvas size to compute the render target size
  118914. * used to generated the glowing objects (the smaller the faster).
  118915. */
  118916. mainTextureRatio: number;
  118917. /**
  118918. * Enforces a fixed size texture to ensure resize independant blur.
  118919. */
  118920. mainTextureFixedSize?: number;
  118921. /**
  118922. * Multiplication factor apply to the main texture size in the first step of the blur to reduce the size
  118923. * of the picture to blur (the smaller the faster).
  118924. */
  118925. blurTextureSizeRatio: number;
  118926. /**
  118927. * How big in texel of the blur texture is the vertical blur.
  118928. */
  118929. blurVerticalSize: number;
  118930. /**
  118931. * How big in texel of the blur texture is the horizontal blur.
  118932. */
  118933. blurHorizontalSize: number;
  118934. /**
  118935. * Alpha blending mode used to apply the blur. Default is combine.
  118936. */
  118937. alphaBlendingMode: number;
  118938. /**
  118939. * The camera attached to the layer.
  118940. */
  118941. camera: Nullable<Camera>;
  118942. /**
  118943. * Should we display highlight as a solid stroke?
  118944. */
  118945. isStroke?: boolean;
  118946. /**
  118947. * The rendering group to draw the layer in.
  118948. */
  118949. renderingGroupId: number;
  118950. }
  118951. /**
  118952. * The highlight layer Helps adding a glow effect around a mesh.
  118953. *
  118954. * Once instantiated in a scene, simply use the addMesh or removeMesh method to add or remove
  118955. * glowy meshes to your scene.
  118956. *
  118957. * !!! THIS REQUIRES AN ACTIVE STENCIL BUFFER ON THE CANVAS !!!
  118958. */
  118959. export class HighlightLayer extends EffectLayer {
  118960. name: string;
  118961. /**
  118962. * Effect Name of the highlight layer.
  118963. */
  118964. static readonly EffectName: string;
  118965. /**
  118966. * The neutral color used during the preparation of the glow effect.
  118967. * This is black by default as the blend operation is a blend operation.
  118968. */
  118969. static NeutralColor: Color4;
  118970. /**
  118971. * Stencil value used for glowing meshes.
  118972. */
  118973. static GlowingMeshStencilReference: number;
  118974. /**
  118975. * Stencil value used for the other meshes in the scene.
  118976. */
  118977. static NormalMeshStencilReference: number;
  118978. /**
  118979. * Specifies whether or not the inner glow is ACTIVE in the layer.
  118980. */
  118981. innerGlow: boolean;
  118982. /**
  118983. * Specifies whether or not the outer glow is ACTIVE in the layer.
  118984. */
  118985. outerGlow: boolean;
  118986. /**
  118987. * Specifies the horizontal size of the blur.
  118988. */
  118989. /**
  118990. * Gets the horizontal size of the blur.
  118991. */
  118992. blurHorizontalSize: number;
  118993. /**
  118994. * Specifies the vertical size of the blur.
  118995. */
  118996. /**
  118997. * Gets the vertical size of the blur.
  118998. */
  118999. blurVerticalSize: number;
  119000. /**
  119001. * An event triggered when the highlight layer is being blurred.
  119002. */
  119003. onBeforeBlurObservable: Observable<HighlightLayer>;
  119004. /**
  119005. * An event triggered when the highlight layer has been blurred.
  119006. */
  119007. onAfterBlurObservable: Observable<HighlightLayer>;
  119008. private _instanceGlowingMeshStencilReference;
  119009. private _options;
  119010. private _downSamplePostprocess;
  119011. private _horizontalBlurPostprocess;
  119012. private _verticalBlurPostprocess;
  119013. private _blurTexture;
  119014. private _meshes;
  119015. private _excludedMeshes;
  119016. /**
  119017. * Instantiates a new highlight Layer and references it to the scene..
  119018. * @param name The name of the layer
  119019. * @param scene The scene to use the layer in
  119020. * @param options Sets of none mandatory options to use with the layer (see IHighlightLayerOptions for more information)
  119021. */
  119022. constructor(name: string, scene: Scene, options?: Partial<IHighlightLayerOptions>);
  119023. /**
  119024. * Get the effect name of the layer.
  119025. * @return The effect name
  119026. */
  119027. getEffectName(): string;
  119028. /**
  119029. * Create the merge effect. This is the shader use to blit the information back
  119030. * to the main canvas at the end of the scene rendering.
  119031. */
  119032. protected _createMergeEffect(): Effect;
  119033. /**
  119034. * Creates the render target textures and post processes used in the highlight layer.
  119035. */
  119036. protected _createTextureAndPostProcesses(): void;
  119037. /**
  119038. * Returns wether or nood the layer needs stencil enabled during the mesh rendering.
  119039. */
  119040. needStencil(): boolean;
  119041. /**
  119042. * Checks for the readiness of the element composing the layer.
  119043. * @param subMesh the mesh to check for
  119044. * @param useInstances specify wether or not to use instances to render the mesh
  119045. * @param emissiveTexture the associated emissive texture used to generate the glow
  119046. * @return true if ready otherwise, false
  119047. */
  119048. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  119049. /**
  119050. * Implementation specific of rendering the generating effect on the main canvas.
  119051. * @param effect The effect used to render through
  119052. */
  119053. protected _internalRender(effect: Effect): void;
  119054. /**
  119055. * Returns true if the layer contains information to display, otherwise false.
  119056. */
  119057. shouldRender(): boolean;
  119058. /**
  119059. * Returns true if the mesh should render, otherwise false.
  119060. * @param mesh The mesh to render
  119061. * @returns true if it should render otherwise false
  119062. */
  119063. protected _shouldRenderMesh(mesh: Mesh): boolean;
  119064. /**
  119065. * Sets the required values for both the emissive texture and and the main color.
  119066. */
  119067. protected _setEmissiveTextureAndColor(mesh: Mesh, subMesh: SubMesh, material: Material): void;
  119068. /**
  119069. * Add a mesh in the exclusion list to prevent it to impact or being impacted by the highlight layer.
  119070. * @param mesh The mesh to exclude from the highlight layer
  119071. */
  119072. addExcludedMesh(mesh: Mesh): void;
  119073. /**
  119074. * Remove a mesh from the exclusion list to let it impact or being impacted by the highlight layer.
  119075. * @param mesh The mesh to highlight
  119076. */
  119077. removeExcludedMesh(mesh: Mesh): void;
  119078. /**
  119079. * Determine if a given mesh will be highlighted by the current HighlightLayer
  119080. * @param mesh mesh to test
  119081. * @returns true if the mesh will be highlighted by the current HighlightLayer
  119082. */
  119083. hasMesh(mesh: AbstractMesh): boolean;
  119084. /**
  119085. * Add a mesh in the highlight layer in order to make it glow with the chosen color.
  119086. * @param mesh The mesh to highlight
  119087. * @param color The color of the highlight
  119088. * @param glowEmissiveOnly Extract the glow from the emissive texture
  119089. */
  119090. addMesh(mesh: Mesh, color: Color3, glowEmissiveOnly?: boolean): void;
  119091. /**
  119092. * Remove a mesh from the highlight layer in order to make it stop glowing.
  119093. * @param mesh The mesh to highlight
  119094. */
  119095. removeMesh(mesh: Mesh): void;
  119096. /**
  119097. * Force the stencil to the normal expected value for none glowing parts
  119098. */
  119099. private _defaultStencilReference;
  119100. /**
  119101. * Free any resources and references associated to a mesh.
  119102. * Internal use
  119103. * @param mesh The mesh to free.
  119104. * @hidden
  119105. */
  119106. _disposeMesh(mesh: Mesh): void;
  119107. /**
  119108. * Dispose the highlight layer and free resources.
  119109. */
  119110. dispose(): void;
  119111. /**
  119112. * Gets the class name of the effect layer
  119113. * @returns the string with the class name of the effect layer
  119114. */
  119115. getClassName(): string;
  119116. /**
  119117. * Serializes this Highlight layer
  119118. * @returns a serialized Highlight layer object
  119119. */
  119120. serialize(): any;
  119121. /**
  119122. * Creates a Highlight layer from parsed Highlight layer data
  119123. * @param parsedHightlightLayer defines the Highlight layer data
  119124. * @param scene defines the current scene
  119125. * @param rootUrl defines the root URL containing the Highlight layer information
  119126. * @returns a parsed Highlight layer
  119127. */
  119128. static Parse(parsedHightlightLayer: any, scene: Scene, rootUrl: string): HighlightLayer;
  119129. }
  119130. }
  119131. declare module BABYLON {
  119132. interface AbstractScene {
  119133. /**
  119134. * The list of layers (background and foreground) of the scene
  119135. */
  119136. layers: Array<Layer>;
  119137. }
  119138. /**
  119139. * Defines the layer scene component responsible to manage any layers
  119140. * in a given scene.
  119141. */
  119142. export class LayerSceneComponent implements ISceneComponent {
  119143. /**
  119144. * The component name helpfull to identify the component in the list of scene components.
  119145. */
  119146. readonly name: string;
  119147. /**
  119148. * The scene the component belongs to.
  119149. */
  119150. scene: Scene;
  119151. private _engine;
  119152. /**
  119153. * Creates a new instance of the component for the given scene
  119154. * @param scene Defines the scene to register the component in
  119155. */
  119156. constructor(scene: Scene);
  119157. /**
  119158. * Registers the component in a given scene
  119159. */
  119160. register(): void;
  119161. /**
  119162. * Rebuilds the elements related to this component in case of
  119163. * context lost for instance.
  119164. */
  119165. rebuild(): void;
  119166. /**
  119167. * Disposes the component and the associated ressources.
  119168. */
  119169. dispose(): void;
  119170. private _draw;
  119171. private _drawCameraPredicate;
  119172. private _drawCameraBackground;
  119173. private _drawCameraForeground;
  119174. private _drawRenderTargetPredicate;
  119175. private _drawRenderTargetBackground;
  119176. private _drawRenderTargetForeground;
  119177. /**
  119178. * Adds all the elements from the container to the scene
  119179. * @param container the container holding the elements
  119180. */
  119181. addFromContainer(container: AbstractScene): void;
  119182. /**
  119183. * Removes all the elements in the container from the scene
  119184. * @param container contains the elements to remove
  119185. * @param dispose if the removed element should be disposed (default: false)
  119186. */
  119187. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  119188. }
  119189. }
  119190. declare module BABYLON {
  119191. /** @hidden */
  119192. export var layerPixelShader: {
  119193. name: string;
  119194. shader: string;
  119195. };
  119196. }
  119197. declare module BABYLON {
  119198. /** @hidden */
  119199. export var layerVertexShader: {
  119200. name: string;
  119201. shader: string;
  119202. };
  119203. }
  119204. declare module BABYLON {
  119205. /**
  119206. * This represents a full screen 2d layer.
  119207. * This can be useful to display a picture in the background of your scene for instance.
  119208. * @see https://www.babylonjs-playground.com/#08A2BS#1
  119209. */
  119210. export class Layer {
  119211. /**
  119212. * Define the name of the layer.
  119213. */
  119214. name: string;
  119215. /**
  119216. * Define the texture the layer should display.
  119217. */
  119218. texture: Nullable<Texture>;
  119219. /**
  119220. * Is the layer in background or foreground.
  119221. */
  119222. isBackground: boolean;
  119223. /**
  119224. * Define the color of the layer (instead of texture).
  119225. */
  119226. color: Color4;
  119227. /**
  119228. * Define the scale of the layer in order to zoom in out of the texture.
  119229. */
  119230. scale: Vector2;
  119231. /**
  119232. * Define an offset for the layer in order to shift the texture.
  119233. */
  119234. offset: Vector2;
  119235. /**
  119236. * Define the alpha blending mode used in the layer in case the texture or color has an alpha.
  119237. */
  119238. alphaBlendingMode: number;
  119239. /**
  119240. * Define if the layer should alpha test or alpha blend with the rest of the scene.
  119241. * Alpha test will not mix with the background color in case of transparency.
  119242. * It will either use the texture color or the background depending on the alpha value of the current pixel.
  119243. */
  119244. alphaTest: boolean;
  119245. /**
  119246. * Define a mask to restrict the layer to only some of the scene cameras.
  119247. */
  119248. layerMask: number;
  119249. /**
  119250. * Define the list of render target the layer is visible into.
  119251. */
  119252. renderTargetTextures: RenderTargetTexture[];
  119253. /**
  119254. * Define if the layer is only used in renderTarget or if it also
  119255. * renders in the main frame buffer of the canvas.
  119256. */
  119257. renderOnlyInRenderTargetTextures: boolean;
  119258. private _scene;
  119259. private _vertexBuffers;
  119260. private _indexBuffer;
  119261. private _effect;
  119262. private _alphaTestEffect;
  119263. /**
  119264. * An event triggered when the layer is disposed.
  119265. */
  119266. onDisposeObservable: Observable<Layer>;
  119267. private _onDisposeObserver;
  119268. /**
  119269. * Back compatibility with callback before the onDisposeObservable existed.
  119270. * The set callback will be triggered when the layer has been disposed.
  119271. */
  119272. onDispose: () => void;
  119273. /**
  119274. * An event triggered before rendering the scene
  119275. */
  119276. onBeforeRenderObservable: Observable<Layer>;
  119277. private _onBeforeRenderObserver;
  119278. /**
  119279. * Back compatibility with callback before the onBeforeRenderObservable existed.
  119280. * The set callback will be triggered just before rendering the layer.
  119281. */
  119282. onBeforeRender: () => void;
  119283. /**
  119284. * An event triggered after rendering the scene
  119285. */
  119286. onAfterRenderObservable: Observable<Layer>;
  119287. private _onAfterRenderObserver;
  119288. /**
  119289. * Back compatibility with callback before the onAfterRenderObservable existed.
  119290. * The set callback will be triggered just after rendering the layer.
  119291. */
  119292. onAfterRender: () => void;
  119293. /**
  119294. * Instantiates a new layer.
  119295. * This represents a full screen 2d layer.
  119296. * This can be useful to display a picture in the background of your scene for instance.
  119297. * @see https://www.babylonjs-playground.com/#08A2BS#1
  119298. * @param name Define the name of the layer in the scene
  119299. * @param imgUrl Define the url of the texture to display in the layer
  119300. * @param scene Define the scene the layer belongs to
  119301. * @param isBackground Defines whether the layer is displayed in front or behind the scene
  119302. * @param color Defines a color for the layer
  119303. */
  119304. constructor(
  119305. /**
  119306. * Define the name of the layer.
  119307. */
  119308. name: string, imgUrl: Nullable<string>, scene: Nullable<Scene>, isBackground?: boolean, color?: Color4);
  119309. private _createIndexBuffer;
  119310. /** @hidden */
  119311. _rebuild(): void;
  119312. /**
  119313. * Renders the layer in the scene.
  119314. */
  119315. render(): void;
  119316. /**
  119317. * Disposes and releases the associated ressources.
  119318. */
  119319. dispose(): void;
  119320. }
  119321. }
  119322. declare module BABYLON {
  119323. /** @hidden */
  119324. export var lensFlarePixelShader: {
  119325. name: string;
  119326. shader: string;
  119327. };
  119328. }
  119329. declare module BABYLON {
  119330. /** @hidden */
  119331. export var lensFlareVertexShader: {
  119332. name: string;
  119333. shader: string;
  119334. };
  119335. }
  119336. declare module BABYLON {
  119337. /**
  119338. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  119339. * It is usually composed of several `lensFlare`.
  119340. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  119341. */
  119342. export class LensFlareSystem {
  119343. /**
  119344. * Define the name of the lens flare system
  119345. */
  119346. name: string;
  119347. /**
  119348. * List of lens flares used in this system.
  119349. */
  119350. lensFlares: LensFlare[];
  119351. /**
  119352. * Define a limit from the border the lens flare can be visible.
  119353. */
  119354. borderLimit: number;
  119355. /**
  119356. * Define a viewport border we do not want to see the lens flare in.
  119357. */
  119358. viewportBorder: number;
  119359. /**
  119360. * Define a predicate which could limit the list of meshes able to occlude the effect.
  119361. */
  119362. meshesSelectionPredicate: (mesh: AbstractMesh) => boolean;
  119363. /**
  119364. * Restricts the rendering of the effect to only the camera rendering this layer mask.
  119365. */
  119366. layerMask: number;
  119367. /**
  119368. * Define the id of the lens flare system in the scene.
  119369. * (equal to name by default)
  119370. */
  119371. id: string;
  119372. private _scene;
  119373. private _emitter;
  119374. private _vertexBuffers;
  119375. private _indexBuffer;
  119376. private _effect;
  119377. private _positionX;
  119378. private _positionY;
  119379. private _isEnabled;
  119380. /** @hidden */
  119381. static _SceneComponentInitialization: (scene: Scene) => void;
  119382. /**
  119383. * Instantiates a lens flare system.
  119384. * This represents a Lens Flare System or the shiny effect created by the light reflection on the camera lenses.
  119385. * It is usually composed of several `lensFlare`.
  119386. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  119387. * @param name Define the name of the lens flare system in the scene
  119388. * @param emitter Define the source (the emitter) of the lens flares (it can be a camera, a light or a mesh).
  119389. * @param scene Define the scene the lens flare system belongs to
  119390. */
  119391. constructor(
  119392. /**
  119393. * Define the name of the lens flare system
  119394. */
  119395. name: string, emitter: any, scene: Scene);
  119396. /**
  119397. * Define if the lens flare system is enabled.
  119398. */
  119399. isEnabled: boolean;
  119400. /**
  119401. * Get the scene the effects belongs to.
  119402. * @returns the scene holding the lens flare system
  119403. */
  119404. getScene(): Scene;
  119405. /**
  119406. * Get the emitter of the lens flare system.
  119407. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  119408. * @returns the emitter of the lens flare system
  119409. */
  119410. getEmitter(): any;
  119411. /**
  119412. * Set the emitter of the lens flare system.
  119413. * It defines the source of the lens flares (it can be a camera, a light or a mesh).
  119414. * @param newEmitter Define the new emitter of the system
  119415. */
  119416. setEmitter(newEmitter: any): void;
  119417. /**
  119418. * Get the lens flare system emitter position.
  119419. * The emitter defines the source of the lens flares (it can be a camera, a light or a mesh).
  119420. * @returns the position
  119421. */
  119422. getEmitterPosition(): Vector3;
  119423. /**
  119424. * @hidden
  119425. */
  119426. computeEffectivePosition(globalViewport: Viewport): boolean;
  119427. /** @hidden */
  119428. _isVisible(): boolean;
  119429. /**
  119430. * @hidden
  119431. */
  119432. render(): boolean;
  119433. /**
  119434. * Dispose and release the lens flare with its associated resources.
  119435. */
  119436. dispose(): void;
  119437. /**
  119438. * Parse a lens flare system from a JSON repressentation
  119439. * @param parsedLensFlareSystem Define the JSON to parse
  119440. * @param scene Define the scene the parsed system should be instantiated in
  119441. * @param rootUrl Define the rootUrl of the load sequence to easily find a load relative dependencies such as textures
  119442. * @returns the parsed system
  119443. */
  119444. static Parse(parsedLensFlareSystem: any, scene: Scene, rootUrl: string): LensFlareSystem;
  119445. /**
  119446. * Serialize the current Lens Flare System into a JSON representation.
  119447. * @returns the serialized JSON
  119448. */
  119449. serialize(): any;
  119450. }
  119451. }
  119452. declare module BABYLON {
  119453. /**
  119454. * This represents one of the lens effect in a `lensFlareSystem`.
  119455. * It controls one of the indiviual texture used in the effect.
  119456. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  119457. */
  119458. export class LensFlare {
  119459. /**
  119460. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  119461. */
  119462. size: number;
  119463. /**
  119464. * 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.
  119465. */
  119466. position: number;
  119467. /**
  119468. * Define the lens color.
  119469. */
  119470. color: Color3;
  119471. /**
  119472. * Define the lens texture.
  119473. */
  119474. texture: Nullable<Texture>;
  119475. /**
  119476. * Define the alpha mode to render this particular lens.
  119477. */
  119478. alphaMode: number;
  119479. private _system;
  119480. /**
  119481. * Creates a new Lens Flare.
  119482. * This represents one of the lens effect in a `lensFlareSystem`.
  119483. * It controls one of the indiviual texture used in the effect.
  119484. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  119485. * @param size Define the size of the lens flare (a floating value between 0 and 1)
  119486. * @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.
  119487. * @param color Define the lens color
  119488. * @param imgUrl Define the lens texture url
  119489. * @param system Define the `lensFlareSystem` this flare is part of
  119490. * @returns The newly created Lens Flare
  119491. */
  119492. static AddFlare(size: number, position: number, color: Color3, imgUrl: string, system: LensFlareSystem): LensFlare;
  119493. /**
  119494. * Instantiates a new Lens Flare.
  119495. * This represents one of the lens effect in a `lensFlareSystem`.
  119496. * It controls one of the indiviual texture used in the effect.
  119497. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  119498. * @param size Define the size of the lens flare in the system (a floating value between 0 and 1)
  119499. * @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.
  119500. * @param color Define the lens color
  119501. * @param imgUrl Define the lens texture url
  119502. * @param system Define the `lensFlareSystem` this flare is part of
  119503. */
  119504. constructor(
  119505. /**
  119506. * Define the size of the lens flare in the system (a floating value between 0 and 1)
  119507. */
  119508. size: number,
  119509. /**
  119510. * 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.
  119511. */
  119512. position: number, color: Color3, imgUrl: string, system: LensFlareSystem);
  119513. /**
  119514. * Dispose and release the lens flare with its associated resources.
  119515. */
  119516. dispose(): void;
  119517. }
  119518. }
  119519. declare module BABYLON {
  119520. interface AbstractScene {
  119521. /**
  119522. * The list of lens flare system added to the scene
  119523. * @see http://doc.babylonjs.com/how_to/how_to_use_lens_flares
  119524. */
  119525. lensFlareSystems: Array<LensFlareSystem>;
  119526. /**
  119527. * Removes the given lens flare system from this scene.
  119528. * @param toRemove The lens flare system to remove
  119529. * @returns The index of the removed lens flare system
  119530. */
  119531. removeLensFlareSystem(toRemove: LensFlareSystem): number;
  119532. /**
  119533. * Adds the given lens flare system to this scene
  119534. * @param newLensFlareSystem The lens flare system to add
  119535. */
  119536. addLensFlareSystem(newLensFlareSystem: LensFlareSystem): void;
  119537. /**
  119538. * Gets a lens flare system using its name
  119539. * @param name defines the name to look for
  119540. * @returns the lens flare system or null if not found
  119541. */
  119542. getLensFlareSystemByName(name: string): Nullable<LensFlareSystem>;
  119543. /**
  119544. * Gets a lens flare system using its id
  119545. * @param id defines the id to look for
  119546. * @returns the lens flare system or null if not found
  119547. */
  119548. getLensFlareSystemByID(id: string): Nullable<LensFlareSystem>;
  119549. }
  119550. /**
  119551. * Defines the lens flare scene component responsible to manage any lens flares
  119552. * in a given scene.
  119553. */
  119554. export class LensFlareSystemSceneComponent implements ISceneSerializableComponent {
  119555. /**
  119556. * The component name helpfull to identify the component in the list of scene components.
  119557. */
  119558. readonly name: string;
  119559. /**
  119560. * The scene the component belongs to.
  119561. */
  119562. scene: Scene;
  119563. /**
  119564. * Creates a new instance of the component for the given scene
  119565. * @param scene Defines the scene to register the component in
  119566. */
  119567. constructor(scene: Scene);
  119568. /**
  119569. * Registers the component in a given scene
  119570. */
  119571. register(): void;
  119572. /**
  119573. * Rebuilds the elements related to this component in case of
  119574. * context lost for instance.
  119575. */
  119576. rebuild(): void;
  119577. /**
  119578. * Adds all the elements from the container to the scene
  119579. * @param container the container holding the elements
  119580. */
  119581. addFromContainer(container: AbstractScene): void;
  119582. /**
  119583. * Removes all the elements in the container from the scene
  119584. * @param container contains the elements to remove
  119585. * @param dispose if the removed element should be disposed (default: false)
  119586. */
  119587. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  119588. /**
  119589. * Serializes the component data to the specified json object
  119590. * @param serializationObject The object to serialize to
  119591. */
  119592. serialize(serializationObject: any): void;
  119593. /**
  119594. * Disposes the component and the associated ressources.
  119595. */
  119596. dispose(): void;
  119597. private _draw;
  119598. }
  119599. }
  119600. declare module BABYLON {
  119601. /**
  119602. * Defines the shadow generator component responsible to manage any shadow generators
  119603. * in a given scene.
  119604. */
  119605. export class ShadowGeneratorSceneComponent implements ISceneSerializableComponent {
  119606. /**
  119607. * The component name helpfull to identify the component in the list of scene components.
  119608. */
  119609. readonly name: string;
  119610. /**
  119611. * The scene the component belongs to.
  119612. */
  119613. scene: Scene;
  119614. /**
  119615. * Creates a new instance of the component for the given scene
  119616. * @param scene Defines the scene to register the component in
  119617. */
  119618. constructor(scene: Scene);
  119619. /**
  119620. * Registers the component in a given scene
  119621. */
  119622. register(): void;
  119623. /**
  119624. * Rebuilds the elements related to this component in case of
  119625. * context lost for instance.
  119626. */
  119627. rebuild(): void;
  119628. /**
  119629. * Serializes the component data to the specified json object
  119630. * @param serializationObject The object to serialize to
  119631. */
  119632. serialize(serializationObject: any): void;
  119633. /**
  119634. * Adds all the elements from the container to the scene
  119635. * @param container the container holding the elements
  119636. */
  119637. addFromContainer(container: AbstractScene): void;
  119638. /**
  119639. * Removes all the elements in the container from the scene
  119640. * @param container contains the elements to remove
  119641. * @param dispose if the removed element should be disposed (default: false)
  119642. */
  119643. removeFromContainer(container: AbstractScene, dispose?: boolean): void;
  119644. /**
  119645. * Rebuilds the elements related to this component in case of
  119646. * context lost for instance.
  119647. */
  119648. dispose(): void;
  119649. private _gatherRenderTargets;
  119650. }
  119651. }
  119652. declare module BABYLON {
  119653. /**
  119654. * A point light is a light defined by an unique point in world space.
  119655. * The light is emitted in every direction from this point.
  119656. * A good example of a point light is a standard light bulb.
  119657. * Documentation: https://doc.babylonjs.com/babylon101/lights
  119658. */
  119659. export class PointLight extends ShadowLight {
  119660. private _shadowAngle;
  119661. /**
  119662. * Getter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  119663. * This specifies what angle the shadow will use to be created.
  119664. *
  119665. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  119666. */
  119667. /**
  119668. * Setter: In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  119669. * This specifies what angle the shadow will use to be created.
  119670. *
  119671. * It default to 90 degrees to work nicely with the cube texture generation for point lights shadow maps.
  119672. */
  119673. shadowAngle: number;
  119674. /**
  119675. * Gets the direction if it has been set.
  119676. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  119677. */
  119678. /**
  119679. * In case of direction provided, the shadow will not use a cube texture but simulate a spot shadow as a fallback
  119680. */
  119681. direction: Vector3;
  119682. /**
  119683. * Creates a PointLight object from the passed name and position (Vector3) and adds it in the scene.
  119684. * A PointLight emits the light in every direction.
  119685. * It can cast shadows.
  119686. * If the scene camera is already defined and you want to set your PointLight at the camera position, just set it :
  119687. * ```javascript
  119688. * var pointLight = new PointLight("pl", camera.position, scene);
  119689. * ```
  119690. * Documentation : https://doc.babylonjs.com/babylon101/lights
  119691. * @param name The light friendly name
  119692. * @param position The position of the point light in the scene
  119693. * @param scene The scene the lights belongs to
  119694. */
  119695. constructor(name: string, position: Vector3, scene: Scene);
  119696. /**
  119697. * Returns the string "PointLight"
  119698. * @returns the class name
  119699. */
  119700. getClassName(): string;
  119701. /**
  119702. * Returns the integer 0.
  119703. * @returns The light Type id as a constant defines in Light.LIGHTTYPEID_x
  119704. */
  119705. getTypeID(): number;
  119706. /**
  119707. * Specifies wether or not the shadowmap should be a cube texture.
  119708. * @returns true if the shadowmap needs to be a cube texture.
  119709. */
  119710. needCube(): boolean;
  119711. /**
  119712. * Returns a new Vector3 aligned with the PointLight cube system according to the passed cube face index (integer).
  119713. * @param faceIndex The index of the face we are computed the direction to generate shadow
  119714. * @returns The set direction in 2d mode otherwise the direction to the cubemap face if needCube() is true
  119715. */
  119716. getShadowDirection(faceIndex?: number): Vector3;
  119717. /**
  119718. * Sets the passed matrix "matrix" as a left-handed perspective projection matrix with the following settings :
  119719. * - fov = PI / 2
  119720. * - aspect ratio : 1.0
  119721. * - z-near and far equal to the active camera minZ and maxZ.
  119722. * Returns the PointLight.
  119723. */
  119724. protected _setDefaultShadowProjectionMatrix(matrix: Matrix, viewMatrix: Matrix, renderList: Array<AbstractMesh>): void;
  119725. protected _buildUniformLayout(): void;
  119726. /**
  119727. * Sets the passed Effect "effect" with the PointLight transformed position (or position, if none) and passed name (string).
  119728. * @param effect The effect to update
  119729. * @param lightIndex The index of the light in the effect to update
  119730. * @returns The point light
  119731. */
  119732. transferToEffect(effect: Effect, lightIndex: string): PointLight;
  119733. transferToNodeMaterialEffect(effect: Effect, lightDataUniformName: string): this;
  119734. /**
  119735. * Prepares the list of defines specific to the light type.
  119736. * @param defines the list of defines
  119737. * @param lightIndex defines the index of the light for the effect
  119738. */
  119739. prepareLightSpecificDefines(defines: any, lightIndex: number): void;
  119740. }
  119741. }
  119742. declare module BABYLON {
  119743. /**
  119744. * Header information of HDR texture files.
  119745. */
  119746. export interface HDRInfo {
  119747. /**
  119748. * The height of the texture in pixels.
  119749. */
  119750. height: number;
  119751. /**
  119752. * The width of the texture in pixels.
  119753. */
  119754. width: number;
  119755. /**
  119756. * The index of the beginning of the data in the binary file.
  119757. */
  119758. dataPosition: number;
  119759. }
  119760. /**
  119761. * This groups tools to convert HDR texture to native colors array.
  119762. */
  119763. export class HDRTools {
  119764. private static Ldexp;
  119765. private static Rgbe2float;
  119766. private static readStringLine;
  119767. /**
  119768. * Reads header information from an RGBE texture stored in a native array.
  119769. * More information on this format are available here:
  119770. * https://en.wikipedia.org/wiki/RGBE_image_format
  119771. *
  119772. * @param uint8array The binary file stored in native array.
  119773. * @return The header information.
  119774. */
  119775. static RGBE_ReadHeader(uint8array: Uint8Array): HDRInfo;
  119776. /**
  119777. * Returns the cubemap information (each faces texture data) extracted from an RGBE texture.
  119778. * This RGBE texture needs to store the information as a panorama.
  119779. *
  119780. * More information on this format are available here:
  119781. * https://en.wikipedia.org/wiki/RGBE_image_format
  119782. *
  119783. * @param buffer The binary file stored in an array buffer.
  119784. * @param size The expected size of the extracted cubemap.
  119785. * @return The Cube Map information.
  119786. */
  119787. static GetCubeMapTextureData(buffer: ArrayBuffer, size: number): CubeMapInfo;
  119788. /**
  119789. * Returns the pixels data extracted from an RGBE texture.
  119790. * This pixels will be stored left to right up to down in the R G B order in one array.
  119791. *
  119792. * More information on this format are available here:
  119793. * https://en.wikipedia.org/wiki/RGBE_image_format
  119794. *
  119795. * @param uint8array The binary file stored in an array buffer.
  119796. * @param hdrInfo The header information of the file.
  119797. * @return The pixels data in RGB right to left up to down order.
  119798. */
  119799. static RGBE_ReadPixels(uint8array: Uint8Array, hdrInfo: HDRInfo): Float32Array;
  119800. private static RGBE_ReadPixels_RLE;
  119801. }
  119802. }
  119803. declare module BABYLON {
  119804. /**
  119805. * This represents a texture coming from an HDR input.
  119806. *
  119807. * The only supported format is currently panorama picture stored in RGBE format.
  119808. * Example of such files can be found on HDRLib: http://hdrlib.com/
  119809. */
  119810. export class HDRCubeTexture extends BaseTexture {
  119811. private static _facesMapping;
  119812. private _generateHarmonics;
  119813. private _noMipmap;
  119814. private _textureMatrix;
  119815. private _size;
  119816. private _onLoad;
  119817. private _onError;
  119818. /**
  119819. * The texture URL.
  119820. */
  119821. url: string;
  119822. /**
  119823. * The texture coordinates mode. As this texture is stored in a cube format, please modify carefully.
  119824. */
  119825. coordinatesMode: number;
  119826. protected _isBlocking: boolean;
  119827. /**
  119828. * Sets wether or not the texture is blocking during loading.
  119829. */
  119830. /**
  119831. * Gets wether or not the texture is blocking during loading.
  119832. */
  119833. isBlocking: boolean;
  119834. protected _rotationY: number;
  119835. /**
  119836. * Sets texture matrix rotation angle around Y axis in radians.
  119837. */
  119838. /**
  119839. * Gets texture matrix rotation angle around Y axis radians.
  119840. */
  119841. rotationY: number;
  119842. /**
  119843. * Gets or sets the center of the bounding box associated with the cube texture
  119844. * It must define where the camera used to render the texture was set
  119845. */
  119846. boundingBoxPosition: Vector3;
  119847. private _boundingBoxSize;
  119848. /**
  119849. * Gets or sets the size of the bounding box associated with the cube texture
  119850. * When defined, the cubemap will switch to local mode
  119851. * @see https://community.arm.com/graphics/b/blog/posts/reflections-based-on-local-cubemaps-in-unity
  119852. * @example https://www.babylonjs-playground.com/#RNASML
  119853. */
  119854. boundingBoxSize: Vector3;
  119855. /**
  119856. * Instantiates an HDRTexture from the following parameters.
  119857. *
  119858. * @param url The location of the HDR raw data (Panorama stored in RGBE format)
  119859. * @param scene The scene the texture will be used in
  119860. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  119861. * @param noMipmap Forces to not generate the mipmap if true
  119862. * @param generateHarmonics Specifies whether you want to extract the polynomial harmonics during the generation process
  119863. * @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)
  119864. * @param reserved Reserved flag for internal use.
  119865. */
  119866. 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>);
  119867. /**
  119868. * Get the current class name of the texture useful for serialization or dynamic coding.
  119869. * @returns "HDRCubeTexture"
  119870. */
  119871. getClassName(): string;
  119872. /**
  119873. * Occurs when the file is raw .hdr file.
  119874. */
  119875. private loadTexture;
  119876. clone(): HDRCubeTexture;
  119877. delayLoad(): void;
  119878. /**
  119879. * Get the texture reflection matrix used to rotate/transform the reflection.
  119880. * @returns the reflection matrix
  119881. */
  119882. getReflectionTextureMatrix(): Matrix;
  119883. /**
  119884. * Set the texture reflection matrix used to rotate/transform the reflection.
  119885. * @param value Define the reflection matrix to set
  119886. */
  119887. setReflectionTextureMatrix(value: Matrix): void;
  119888. /**
  119889. * Parses a JSON representation of an HDR Texture in order to create the texture
  119890. * @param parsedTexture Define the JSON representation
  119891. * @param scene Define the scene the texture should be created in
  119892. * @param rootUrl Define the root url in case we need to load relative dependencies
  119893. * @returns the newly created texture after parsing
  119894. */
  119895. static Parse(parsedTexture: any, scene: Scene, rootUrl: string): Nullable<HDRCubeTexture>;
  119896. serialize(): any;
  119897. }
  119898. }
  119899. declare module BABYLON {
  119900. /**
  119901. * Class used to control physics engine
  119902. * @see http://doc.babylonjs.com/how_to/using_the_physics_engine
  119903. */
  119904. export class PhysicsEngine implements IPhysicsEngine {
  119905. private _physicsPlugin;
  119906. /**
  119907. * Global value used to control the smallest number supported by the simulation
  119908. */
  119909. static Epsilon: number;
  119910. private _impostors;
  119911. private _joints;
  119912. /**
  119913. * Gets the gravity vector used by the simulation
  119914. */
  119915. gravity: Vector3;
  119916. /**
  119917. * Factory used to create the default physics plugin.
  119918. * @returns The default physics plugin
  119919. */
  119920. static DefaultPluginFactory(): IPhysicsEnginePlugin;
  119921. /**
  119922. * Creates a new Physics Engine
  119923. * @param gravity defines the gravity vector used by the simulation
  119924. * @param _physicsPlugin defines the plugin to use (CannonJS by default)
  119925. */
  119926. constructor(gravity: Nullable<Vector3>, _physicsPlugin?: IPhysicsEnginePlugin);
  119927. /**
  119928. * Sets the gravity vector used by the simulation
  119929. * @param gravity defines the gravity vector to use
  119930. */
  119931. setGravity(gravity: Vector3): void;
  119932. /**
  119933. * Set the time step of the physics engine.
  119934. * Default is 1/60.
  119935. * To slow it down, enter 1/600 for example.
  119936. * To speed it up, 1/30
  119937. * @param newTimeStep defines the new timestep to apply to this world.
  119938. */
  119939. setTimeStep(newTimeStep?: number): void;
  119940. /**
  119941. * Get the time step of the physics engine.
  119942. * @returns the current time step
  119943. */
  119944. getTimeStep(): number;
  119945. /**
  119946. * Release all resources
  119947. */
  119948. dispose(): void;
  119949. /**
  119950. * Gets the name of the current physics plugin
  119951. * @returns the name of the plugin
  119952. */
  119953. getPhysicsPluginName(): string;
  119954. /**
  119955. * Adding a new impostor for the impostor tracking.
  119956. * This will be done by the impostor itself.
  119957. * @param impostor the impostor to add
  119958. */
  119959. addImpostor(impostor: PhysicsImpostor): void;
  119960. /**
  119961. * Remove an impostor from the engine.
  119962. * This impostor and its mesh will not longer be updated by the physics engine.
  119963. * @param impostor the impostor to remove
  119964. */
  119965. removeImpostor(impostor: PhysicsImpostor): void;
  119966. /**
  119967. * Add a joint to the physics engine
  119968. * @param mainImpostor defines the main impostor to which the joint is added.
  119969. * @param connectedImpostor defines the impostor that is connected to the main impostor using this joint
  119970. * @param joint defines the joint that will connect both impostors.
  119971. */
  119972. addJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  119973. /**
  119974. * Removes a joint from the simulation
  119975. * @param mainImpostor defines the impostor used with the joint
  119976. * @param connectedImpostor defines the other impostor connected to the main one by the joint
  119977. * @param joint defines the joint to remove
  119978. */
  119979. removeJoint(mainImpostor: PhysicsImpostor, connectedImpostor: PhysicsImpostor, joint: PhysicsJoint): void;
  119980. /**
  119981. * Called by the scene. No need to call it.
  119982. * @param delta defines the timespam between frames
  119983. */
  119984. _step(delta: number): void;
  119985. /**
  119986. * Gets the current plugin used to run the simulation
  119987. * @returns current plugin
  119988. */
  119989. getPhysicsPlugin(): IPhysicsEnginePlugin;
  119990. /**
  119991. * Gets the list of physic impostors
  119992. * @returns an array of PhysicsImpostor
  119993. */
  119994. getImpostors(): Array<PhysicsImpostor>;
  119995. /**
  119996. * Gets the impostor for a physics enabled object
  119997. * @param object defines the object impersonated by the impostor
  119998. * @returns the PhysicsImpostor or null if not found
  119999. */
  120000. getImpostorForPhysicsObject(object: IPhysicsEnabledObject): Nullable<PhysicsImpostor>;
  120001. /**
  120002. * Gets the impostor for a physics body object
  120003. * @param body defines physics body used by the impostor
  120004. * @returns the PhysicsImpostor or null if not found
  120005. */
  120006. getImpostorWithPhysicsBody(body: any): Nullable<PhysicsImpostor>;
  120007. /**
  120008. * Does a raycast in the physics world
  120009. * @param from when should the ray start?
  120010. * @param to when should the ray end?
  120011. * @returns PhysicsRaycastResult
  120012. */
  120013. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  120014. }
  120015. }
  120016. declare module BABYLON {
  120017. /** @hidden */
  120018. export class CannonJSPlugin implements IPhysicsEnginePlugin {
  120019. private _useDeltaForWorldStep;
  120020. world: any;
  120021. name: string;
  120022. private _physicsMaterials;
  120023. private _fixedTimeStep;
  120024. private _cannonRaycastResult;
  120025. private _raycastResult;
  120026. private _physicsBodysToRemoveAfterStep;
  120027. BJSCANNON: any;
  120028. constructor(_useDeltaForWorldStep?: boolean, iterations?: number, cannonInjection?: any);
  120029. setGravity(gravity: Vector3): void;
  120030. setTimeStep(timeStep: number): void;
  120031. getTimeStep(): number;
  120032. executeStep(delta: number): void;
  120033. private _removeMarkedPhysicsBodiesFromWorld;
  120034. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  120035. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  120036. generatePhysicsBody(impostor: PhysicsImpostor): void;
  120037. private _processChildMeshes;
  120038. removePhysicsBody(impostor: PhysicsImpostor): void;
  120039. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  120040. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  120041. private _addMaterial;
  120042. private _checkWithEpsilon;
  120043. private _createShape;
  120044. private _createHeightmap;
  120045. private _minus90X;
  120046. private _plus90X;
  120047. private _tmpPosition;
  120048. private _tmpDeltaPosition;
  120049. private _tmpUnityRotation;
  120050. private _updatePhysicsBodyTransformation;
  120051. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  120052. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  120053. isSupported(): boolean;
  120054. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  120055. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  120056. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  120057. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  120058. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  120059. getBodyMass(impostor: PhysicsImpostor): number;
  120060. getBodyFriction(impostor: PhysicsImpostor): number;
  120061. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  120062. getBodyRestitution(impostor: PhysicsImpostor): number;
  120063. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  120064. sleepBody(impostor: PhysicsImpostor): void;
  120065. wakeUpBody(impostor: PhysicsImpostor): void;
  120066. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number): void;
  120067. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  120068. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  120069. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  120070. getRadius(impostor: PhysicsImpostor): number;
  120071. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  120072. dispose(): void;
  120073. private _extendNamespace;
  120074. /**
  120075. * Does a raycast in the physics world
  120076. * @param from when should the ray start?
  120077. * @param to when should the ray end?
  120078. * @returns PhysicsRaycastResult
  120079. */
  120080. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  120081. }
  120082. }
  120083. declare module BABYLON {
  120084. /** @hidden */
  120085. export class OimoJSPlugin implements IPhysicsEnginePlugin {
  120086. world: any;
  120087. name: string;
  120088. BJSOIMO: any;
  120089. private _raycastResult;
  120090. constructor(iterations?: number, oimoInjection?: any);
  120091. setGravity(gravity: Vector3): void;
  120092. setTimeStep(timeStep: number): void;
  120093. getTimeStep(): number;
  120094. private _tmpImpostorsArray;
  120095. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  120096. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  120097. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  120098. generatePhysicsBody(impostor: PhysicsImpostor): void;
  120099. private _tmpPositionVector;
  120100. removePhysicsBody(impostor: PhysicsImpostor): void;
  120101. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  120102. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  120103. isSupported(): boolean;
  120104. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  120105. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  120106. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  120107. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  120108. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  120109. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  120110. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  120111. getBodyMass(impostor: PhysicsImpostor): number;
  120112. getBodyFriction(impostor: PhysicsImpostor): number;
  120113. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  120114. getBodyRestitution(impostor: PhysicsImpostor): number;
  120115. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  120116. sleepBody(impostor: PhysicsImpostor): void;
  120117. wakeUpBody(impostor: PhysicsImpostor): void;
  120118. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  120119. setMotor(joint: IMotorEnabledJoint, speed: number, force?: number, motorIndex?: number): void;
  120120. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number, motorIndex?: number): void;
  120121. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  120122. getRadius(impostor: PhysicsImpostor): number;
  120123. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  120124. dispose(): void;
  120125. /**
  120126. * Does a raycast in the physics world
  120127. * @param from when should the ray start?
  120128. * @param to when should the ray end?
  120129. * @returns PhysicsRaycastResult
  120130. */
  120131. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  120132. }
  120133. }
  120134. declare module BABYLON {
  120135. /**
  120136. * Class containing static functions to help procedurally build meshes
  120137. */
  120138. export class RibbonBuilder {
  120139. /**
  120140. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  120141. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  120142. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  120143. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  120144. * * 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
  120145. * * 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
  120146. * * 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
  120147. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  120148. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  120149. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  120150. * * 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
  120151. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  120152. * * 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
  120153. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  120154. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  120155. * @param name defines the name of the mesh
  120156. * @param options defines the options used to create the mesh
  120157. * @param scene defines the hosting scene
  120158. * @returns the ribbon mesh
  120159. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  120160. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  120161. */
  120162. static CreateRibbon(name: string, options: {
  120163. pathArray: Vector3[][];
  120164. closeArray?: boolean;
  120165. closePath?: boolean;
  120166. offset?: number;
  120167. updatable?: boolean;
  120168. sideOrientation?: number;
  120169. frontUVs?: Vector4;
  120170. backUVs?: Vector4;
  120171. instance?: Mesh;
  120172. invertUV?: boolean;
  120173. uvs?: Vector2[];
  120174. colors?: Color4[];
  120175. }, scene?: Nullable<Scene>): Mesh;
  120176. }
  120177. }
  120178. declare module BABYLON {
  120179. /**
  120180. * Class containing static functions to help procedurally build meshes
  120181. */
  120182. export class ShapeBuilder {
  120183. /**
  120184. * 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.
  120185. * * 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.
  120186. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  120187. * * 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.
  120188. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  120189. * * 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
  120190. * * 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
  120191. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  120192. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  120193. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  120194. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  120195. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  120196. * @param name defines the name of the mesh
  120197. * @param options defines the options used to create the mesh
  120198. * @param scene defines the hosting scene
  120199. * @returns the extruded shape mesh
  120200. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  120201. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  120202. */
  120203. static ExtrudeShape(name: string, options: {
  120204. shape: Vector3[];
  120205. path: Vector3[];
  120206. scale?: number;
  120207. rotation?: number;
  120208. cap?: number;
  120209. updatable?: boolean;
  120210. sideOrientation?: number;
  120211. frontUVs?: Vector4;
  120212. backUVs?: Vector4;
  120213. instance?: Mesh;
  120214. invertUV?: boolean;
  120215. }, scene?: Nullable<Scene>): Mesh;
  120216. /**
  120217. * Creates an custom extruded shape mesh.
  120218. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  120219. * * 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.
  120220. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  120221. * * 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
  120222. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  120223. * * 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
  120224. * * It must returns a float value that will be the scale value applied to the shape on each path point
  120225. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  120226. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  120227. * * 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
  120228. * * 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
  120229. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  120230. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  120231. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  120232. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  120233. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  120234. * @param name defines the name of the mesh
  120235. * @param options defines the options used to create the mesh
  120236. * @param scene defines the hosting scene
  120237. * @returns the custom extruded shape mesh
  120238. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  120239. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  120240. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  120241. */
  120242. static ExtrudeShapeCustom(name: string, options: {
  120243. shape: Vector3[];
  120244. path: Vector3[];
  120245. scaleFunction?: any;
  120246. rotationFunction?: any;
  120247. ribbonCloseArray?: boolean;
  120248. ribbonClosePath?: boolean;
  120249. cap?: number;
  120250. updatable?: boolean;
  120251. sideOrientation?: number;
  120252. frontUVs?: Vector4;
  120253. backUVs?: Vector4;
  120254. instance?: Mesh;
  120255. invertUV?: boolean;
  120256. }, scene?: Nullable<Scene>): Mesh;
  120257. private static _ExtrudeShapeGeneric;
  120258. }
  120259. }
  120260. declare module BABYLON {
  120261. /**
  120262. * AmmoJS Physics plugin
  120263. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine
  120264. * @see https://github.com/kripken/ammo.js/
  120265. */
  120266. export class AmmoJSPlugin implements IPhysicsEnginePlugin {
  120267. private _useDeltaForWorldStep;
  120268. /**
  120269. * Reference to the Ammo library
  120270. */
  120271. bjsAMMO: any;
  120272. /**
  120273. * Created ammoJS world which physics bodies are added to
  120274. */
  120275. world: any;
  120276. /**
  120277. * Name of the plugin
  120278. */
  120279. name: string;
  120280. private _timeStep;
  120281. private _fixedTimeStep;
  120282. private _maxSteps;
  120283. private _tmpQuaternion;
  120284. private _tmpAmmoTransform;
  120285. private _tmpAmmoQuaternion;
  120286. private _tmpAmmoConcreteContactResultCallback;
  120287. private _collisionConfiguration;
  120288. private _dispatcher;
  120289. private _overlappingPairCache;
  120290. private _solver;
  120291. private _softBodySolver;
  120292. private _tmpAmmoVectorA;
  120293. private _tmpAmmoVectorB;
  120294. private _tmpAmmoVectorC;
  120295. private _tmpAmmoVectorD;
  120296. private _tmpContactCallbackResult;
  120297. private _tmpAmmoVectorRCA;
  120298. private _tmpAmmoVectorRCB;
  120299. private _raycastResult;
  120300. private static readonly DISABLE_COLLISION_FLAG;
  120301. private static readonly KINEMATIC_FLAG;
  120302. private static readonly DISABLE_DEACTIVATION_FLAG;
  120303. /**
  120304. * Initializes the ammoJS plugin
  120305. * @param _useDeltaForWorldStep if the time between frames should be used when calculating physics steps (Default: true)
  120306. * @param ammoInjection can be used to inject your own ammo reference
  120307. * @param overlappingPairCache can be used to specify your own overlapping pair cache
  120308. */
  120309. constructor(_useDeltaForWorldStep?: boolean, ammoInjection?: any, overlappingPairCache?: any);
  120310. /**
  120311. * Sets the gravity of the physics world (m/(s^2))
  120312. * @param gravity Gravity to set
  120313. */
  120314. setGravity(gravity: Vector3): void;
  120315. /**
  120316. * Amount of time to step forward on each frame (only used if useDeltaForWorldStep is false in the constructor)
  120317. * @param timeStep timestep to use in seconds
  120318. */
  120319. setTimeStep(timeStep: number): void;
  120320. /**
  120321. * 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)
  120322. * @param fixedTimeStep fixedTimeStep to use in seconds
  120323. */
  120324. setFixedTimeStep(fixedTimeStep: number): void;
  120325. /**
  120326. * Sets the maximum number of steps by the physics engine per frame (Default: 5)
  120327. * @param maxSteps the maximum number of steps by the physics engine per frame
  120328. */
  120329. setMaxSteps(maxSteps: number): void;
  120330. /**
  120331. * Gets the current timestep (only used if useDeltaForWorldStep is false in the constructor)
  120332. * @returns the current timestep in seconds
  120333. */
  120334. getTimeStep(): number;
  120335. private _isImpostorInContact;
  120336. private _isImpostorPairInContact;
  120337. private _stepSimulation;
  120338. /**
  120339. * Moves the physics simulation forward delta seconds and updates the given physics imposters
  120340. * Prior to the step the imposters physics location is set to the position of the babylon meshes
  120341. * After the step the babylon meshes are set to the position of the physics imposters
  120342. * @param delta amount of time to step forward
  120343. * @param impostors array of imposters to update before/after the step
  120344. */
  120345. executeStep(delta: number, impostors: Array<PhysicsImpostor>): void;
  120346. /**
  120347. * Update babylon mesh to match physics world object
  120348. * @param impostor imposter to match
  120349. */
  120350. private _afterSoftStep;
  120351. /**
  120352. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  120353. * @param impostor imposter to match
  120354. */
  120355. private _ropeStep;
  120356. /**
  120357. * Update babylon mesh vertices vertices to match physics world softbody or cloth
  120358. * @param impostor imposter to match
  120359. */
  120360. private _softbodyOrClothStep;
  120361. private _tmpVector;
  120362. private _tmpMatrix;
  120363. /**
  120364. * Applies an impulse on the imposter
  120365. * @param impostor imposter to apply impulse to
  120366. * @param force amount of force to be applied to the imposter
  120367. * @param contactPoint the location to apply the impulse on the imposter
  120368. */
  120369. applyImpulse(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  120370. /**
  120371. * Applies a force on the imposter
  120372. * @param impostor imposter to apply force
  120373. * @param force amount of force to be applied to the imposter
  120374. * @param contactPoint the location to apply the force on the imposter
  120375. */
  120376. applyForce(impostor: PhysicsImpostor, force: Vector3, contactPoint: Vector3): void;
  120377. /**
  120378. * Creates a physics body using the plugin
  120379. * @param impostor the imposter to create the physics body on
  120380. */
  120381. generatePhysicsBody(impostor: PhysicsImpostor): void;
  120382. /**
  120383. * Removes the physics body from the imposter and disposes of the body's memory
  120384. * @param impostor imposter to remove the physics body from
  120385. */
  120386. removePhysicsBody(impostor: PhysicsImpostor): void;
  120387. /**
  120388. * Generates a joint
  120389. * @param impostorJoint the imposter joint to create the joint with
  120390. */
  120391. generateJoint(impostorJoint: PhysicsImpostorJoint): void;
  120392. /**
  120393. * Removes a joint
  120394. * @param impostorJoint the imposter joint to remove the joint from
  120395. */
  120396. removeJoint(impostorJoint: PhysicsImpostorJoint): void;
  120397. private _addMeshVerts;
  120398. /**
  120399. * Initialise the soft body vertices to match its object's (mesh) vertices
  120400. * Softbody vertices (nodes) are in world space and to match this
  120401. * The object's position and rotation is set to zero and so its vertices are also then set in world space
  120402. * @param impostor to create the softbody for
  120403. */
  120404. private _softVertexData;
  120405. /**
  120406. * Create an impostor's soft body
  120407. * @param impostor to create the softbody for
  120408. */
  120409. private _createSoftbody;
  120410. /**
  120411. * Create cloth for an impostor
  120412. * @param impostor to create the softbody for
  120413. */
  120414. private _createCloth;
  120415. /**
  120416. * Create rope for an impostor
  120417. * @param impostor to create the softbody for
  120418. */
  120419. private _createRope;
  120420. private _addHullVerts;
  120421. private _createShape;
  120422. /**
  120423. * Sets the physics body position/rotation from the babylon mesh's position/rotation
  120424. * @param impostor imposter containing the physics body and babylon object
  120425. */
  120426. setTransformationFromPhysicsBody(impostor: PhysicsImpostor): void;
  120427. /**
  120428. * Sets the babylon object's position/rotation from the physics body's position/rotation
  120429. * @param impostor imposter containing the physics body and babylon object
  120430. * @param newPosition new position
  120431. * @param newRotation new rotation
  120432. */
  120433. setPhysicsBodyTransformation(impostor: PhysicsImpostor, newPosition: Vector3, newRotation: Quaternion): void;
  120434. /**
  120435. * If this plugin is supported
  120436. * @returns true if its supported
  120437. */
  120438. isSupported(): boolean;
  120439. /**
  120440. * Sets the linear velocity of the physics body
  120441. * @param impostor imposter to set the velocity on
  120442. * @param velocity velocity to set
  120443. */
  120444. setLinearVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  120445. /**
  120446. * Sets the angular velocity of the physics body
  120447. * @param impostor imposter to set the velocity on
  120448. * @param velocity velocity to set
  120449. */
  120450. setAngularVelocity(impostor: PhysicsImpostor, velocity: Vector3): void;
  120451. /**
  120452. * gets the linear velocity
  120453. * @param impostor imposter to get linear velocity from
  120454. * @returns linear velocity
  120455. */
  120456. getLinearVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  120457. /**
  120458. * gets the angular velocity
  120459. * @param impostor imposter to get angular velocity from
  120460. * @returns angular velocity
  120461. */
  120462. getAngularVelocity(impostor: PhysicsImpostor): Nullable<Vector3>;
  120463. /**
  120464. * Sets the mass of physics body
  120465. * @param impostor imposter to set the mass on
  120466. * @param mass mass to set
  120467. */
  120468. setBodyMass(impostor: PhysicsImpostor, mass: number): void;
  120469. /**
  120470. * Gets the mass of the physics body
  120471. * @param impostor imposter to get the mass from
  120472. * @returns mass
  120473. */
  120474. getBodyMass(impostor: PhysicsImpostor): number;
  120475. /**
  120476. * Gets friction of the impostor
  120477. * @param impostor impostor to get friction from
  120478. * @returns friction value
  120479. */
  120480. getBodyFriction(impostor: PhysicsImpostor): number;
  120481. /**
  120482. * Sets friction of the impostor
  120483. * @param impostor impostor to set friction on
  120484. * @param friction friction value
  120485. */
  120486. setBodyFriction(impostor: PhysicsImpostor, friction: number): void;
  120487. /**
  120488. * Gets restitution of the impostor
  120489. * @param impostor impostor to get restitution from
  120490. * @returns restitution value
  120491. */
  120492. getBodyRestitution(impostor: PhysicsImpostor): number;
  120493. /**
  120494. * Sets resitution of the impostor
  120495. * @param impostor impostor to set resitution on
  120496. * @param restitution resitution value
  120497. */
  120498. setBodyRestitution(impostor: PhysicsImpostor, restitution: number): void;
  120499. /**
  120500. * Gets pressure inside the impostor
  120501. * @param impostor impostor to get pressure from
  120502. * @returns pressure value
  120503. */
  120504. getBodyPressure(impostor: PhysicsImpostor): number;
  120505. /**
  120506. * Sets pressure inside a soft body impostor
  120507. * Cloth and rope must remain 0 pressure
  120508. * @param impostor impostor to set pressure on
  120509. * @param pressure pressure value
  120510. */
  120511. setBodyPressure(impostor: PhysicsImpostor, pressure: number): void;
  120512. /**
  120513. * Gets stiffness of the impostor
  120514. * @param impostor impostor to get stiffness from
  120515. * @returns pressure value
  120516. */
  120517. getBodyStiffness(impostor: PhysicsImpostor): number;
  120518. /**
  120519. * Sets stiffness of the impostor
  120520. * @param impostor impostor to set stiffness on
  120521. * @param stiffness stiffness value from 0 to 1
  120522. */
  120523. setBodyStiffness(impostor: PhysicsImpostor, stiffness: number): void;
  120524. /**
  120525. * Gets velocityIterations of the impostor
  120526. * @param impostor impostor to get velocity iterations from
  120527. * @returns velocityIterations value
  120528. */
  120529. getBodyVelocityIterations(impostor: PhysicsImpostor): number;
  120530. /**
  120531. * Sets velocityIterations of the impostor
  120532. * @param impostor impostor to set velocity iterations on
  120533. * @param velocityIterations velocityIterations value
  120534. */
  120535. setBodyVelocityIterations(impostor: PhysicsImpostor, velocityIterations: number): void;
  120536. /**
  120537. * Gets positionIterations of the impostor
  120538. * @param impostor impostor to get position iterations from
  120539. * @returns positionIterations value
  120540. */
  120541. getBodyPositionIterations(impostor: PhysicsImpostor): number;
  120542. /**
  120543. * Sets positionIterations of the impostor
  120544. * @param impostor impostor to set position on
  120545. * @param positionIterations positionIterations value
  120546. */
  120547. setBodyPositionIterations(impostor: PhysicsImpostor, positionIterations: number): void;
  120548. /**
  120549. * Append an anchor to a cloth object
  120550. * @param impostor is the cloth impostor to add anchor to
  120551. * @param otherImpostor is the rigid impostor to anchor to
  120552. * @param width ratio across width from 0 to 1
  120553. * @param height ratio up height from 0 to 1
  120554. * @param influence the elasticity between cloth impostor and anchor from 0, very stretchy to 1, little strech
  120555. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  120556. */
  120557. appendAnchor(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, width: number, height: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  120558. /**
  120559. * Append an hook to a rope object
  120560. * @param impostor is the rope impostor to add hook to
  120561. * @param otherImpostor is the rigid impostor to hook to
  120562. * @param length ratio along the rope from 0 to 1
  120563. * @param influence the elasticity between soft impostor and anchor from 0, very stretchy to 1, little strech
  120564. * @param noCollisionBetweenLinkedBodies when true collisions between soft impostor and anchor are ignored; default false
  120565. */
  120566. appendHook(impostor: PhysicsImpostor, otherImpostor: PhysicsImpostor, length: number, influence?: number, noCollisionBetweenLinkedBodies?: boolean): void;
  120567. /**
  120568. * Sleeps the physics body and stops it from being active
  120569. * @param impostor impostor to sleep
  120570. */
  120571. sleepBody(impostor: PhysicsImpostor): void;
  120572. /**
  120573. * Activates the physics body
  120574. * @param impostor impostor to activate
  120575. */
  120576. wakeUpBody(impostor: PhysicsImpostor): void;
  120577. /**
  120578. * Updates the distance parameters of the joint
  120579. * @param joint joint to update
  120580. * @param maxDistance maximum distance of the joint
  120581. * @param minDistance minimum distance of the joint
  120582. */
  120583. updateDistanceJoint(joint: PhysicsJoint, maxDistance: number, minDistance?: number): void;
  120584. /**
  120585. * Sets a motor on the joint
  120586. * @param joint joint to set motor on
  120587. * @param speed speed of the motor
  120588. * @param maxForce maximum force of the motor
  120589. * @param motorIndex index of the motor
  120590. */
  120591. setMotor(joint: IMotorEnabledJoint, speed?: number, maxForce?: number, motorIndex?: number): void;
  120592. /**
  120593. * Sets the motors limit
  120594. * @param joint joint to set limit on
  120595. * @param upperLimit upper limit
  120596. * @param lowerLimit lower limit
  120597. */
  120598. setLimit(joint: IMotorEnabledJoint, upperLimit: number, lowerLimit?: number): void;
  120599. /**
  120600. * Syncs the position and rotation of a mesh with the impostor
  120601. * @param mesh mesh to sync
  120602. * @param impostor impostor to update the mesh with
  120603. */
  120604. syncMeshWithImpostor(mesh: AbstractMesh, impostor: PhysicsImpostor): void;
  120605. /**
  120606. * Gets the radius of the impostor
  120607. * @param impostor impostor to get radius from
  120608. * @returns the radius
  120609. */
  120610. getRadius(impostor: PhysicsImpostor): number;
  120611. /**
  120612. * Gets the box size of the impostor
  120613. * @param impostor impostor to get box size from
  120614. * @param result the resulting box size
  120615. */
  120616. getBoxSizeToRef(impostor: PhysicsImpostor, result: Vector3): void;
  120617. /**
  120618. * Disposes of the impostor
  120619. */
  120620. dispose(): void;
  120621. /**
  120622. * Does a raycast in the physics world
  120623. * @param from when should the ray start?
  120624. * @param to when should the ray end?
  120625. * @returns PhysicsRaycastResult
  120626. */
  120627. raycast(from: Vector3, to: Vector3): PhysicsRaycastResult;
  120628. }
  120629. }
  120630. declare module BABYLON {
  120631. interface AbstractScene {
  120632. /**
  120633. * The list of reflection probes added to the scene
  120634. * @see http://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  120635. */
  120636. reflectionProbes: Array<ReflectionProbe>;
  120637. /**
  120638. * Removes the given reflection probe from this scene.
  120639. * @param toRemove The reflection probe to remove
  120640. * @returns The index of the removed reflection probe
  120641. */
  120642. removeReflectionProbe(toRemove: ReflectionProbe): number;
  120643. /**
  120644. * Adds the given reflection probe to this scene.
  120645. * @param newReflectionProbe The reflection probe to add
  120646. */
  120647. addReflectionProbe(newReflectionProbe: ReflectionProbe): void;
  120648. }
  120649. /**
  120650. * Class used to generate realtime reflection / refraction cube textures
  120651. * @see http://doc.babylonjs.com/how_to/how_to_use_reflection_probes
  120652. */
  120653. export class ReflectionProbe {
  120654. /** defines the name of the probe */
  120655. name: string;
  120656. private _scene;
  120657. private _renderTargetTexture;
  120658. private _projectionMatrix;
  120659. private _viewMatrix;
  120660. private _target;
  120661. private _add;
  120662. private _attachedMesh;
  120663. private _invertYAxis;
  120664. /** Gets or sets probe position (center of the cube map) */
  120665. position: Vector3;
  120666. /**
  120667. * Creates a new reflection probe
  120668. * @param name defines the name of the probe
  120669. * @param size defines the texture resolution (for each face)
  120670. * @param scene defines the hosting scene
  120671. * @param generateMipMaps defines if mip maps should be generated automatically (true by default)
  120672. * @param useFloat defines if HDR data (flaot data) should be used to store colors (false by default)
  120673. */
  120674. constructor(
  120675. /** defines the name of the probe */
  120676. name: string, size: number, scene: Scene, generateMipMaps?: boolean, useFloat?: boolean);
  120677. /** Gets or sets the number of samples to use for multi-sampling (0 by default). Required WebGL2 */
  120678. samples: number;
  120679. /** Gets or sets the refresh rate to use (on every frame by default) */
  120680. refreshRate: number;
  120681. /**
  120682. * Gets the hosting scene
  120683. * @returns a Scene
  120684. */
  120685. getScene(): Scene;
  120686. /** Gets the internal CubeTexture used to render to */
  120687. readonly cubeTexture: RenderTargetTexture;
  120688. /** Gets the list of meshes to render */
  120689. readonly renderList: Nullable<AbstractMesh[]>;
  120690. /**
  120691. * Attach the probe to a specific mesh (Rendering will be done from attached mesh's position)
  120692. * @param mesh defines the mesh to attach to
  120693. */
  120694. attachToMesh(mesh: Nullable<AbstractMesh>): void;
  120695. /**
  120696. * Specifies whether or not the stencil and depth buffer are cleared between two rendering groups
  120697. * @param renderingGroupId The rendering group id corresponding to its index
  120698. * @param autoClearDepthStencil Automatically clears depth and stencil between groups if true.
  120699. */
  120700. setRenderingAutoClearDepthStencil(renderingGroupId: number, autoClearDepthStencil: boolean): void;
  120701. /**
  120702. * Clean all associated resources
  120703. */
  120704. dispose(): void;
  120705. /**
  120706. * Converts the reflection probe information to a readable string for debug purpose.
  120707. * @param fullDetails Supports for multiple levels of logging within scene loading
  120708. * @returns the human readable reflection probe info
  120709. */
  120710. toString(fullDetails?: boolean): string;
  120711. /**
  120712. * Get the class name of the relfection probe.
  120713. * @returns "ReflectionProbe"
  120714. */
  120715. getClassName(): string;
  120716. /**
  120717. * Serialize the reflection probe to a JSON representation we can easily use in the resepective Parse function.
  120718. * @returns The JSON representation of the texture
  120719. */
  120720. serialize(): any;
  120721. /**
  120722. * Parse the JSON representation of a reflection probe in order to recreate the reflection probe in the given scene.
  120723. * @param parsedReflectionProbe Define the JSON representation of the reflection probe
  120724. * @param scene Define the scene the parsed reflection probe should be instantiated in
  120725. * @param rootUrl Define the root url of the parsing sequence in the case of relative dependencies
  120726. * @returns The parsed reflection probe if successful
  120727. */
  120728. static Parse(parsedReflectionProbe: any, scene: Scene, rootUrl: string): Nullable<ReflectionProbe>;
  120729. }
  120730. }
  120731. declare module BABYLON {
  120732. /** @hidden */
  120733. export var _BabylonLoaderRegistered: boolean;
  120734. /**
  120735. * Helps setting up some configuration for the babylon file loader.
  120736. */
  120737. export class BabylonFileLoaderConfiguration {
  120738. /**
  120739. * The loader does not allow injecting custom physix engine into the plugins.
  120740. * Unfortunately in ES6, we need to manually inject them into the plugin.
  120741. * So you could set this variable to your engine import to make it work.
  120742. */
  120743. static LoaderInjectedPhysicsEngine: any;
  120744. }
  120745. }
  120746. declare module BABYLON {
  120747. /**
  120748. * The Physically based simple base material of BJS.
  120749. *
  120750. * This enables better naming and convention enforcements on top of the pbrMaterial.
  120751. * It is used as the base class for both the specGloss and metalRough conventions.
  120752. */
  120753. export abstract class PBRBaseSimpleMaterial extends PBRBaseMaterial {
  120754. /**
  120755. * Number of Simultaneous lights allowed on the material.
  120756. */
  120757. maxSimultaneousLights: number;
  120758. /**
  120759. * If sets to true, disables all the lights affecting the material.
  120760. */
  120761. disableLighting: boolean;
  120762. /**
  120763. * Environment Texture used in the material (this is use for both reflection and environment lighting).
  120764. */
  120765. environmentTexture: BaseTexture;
  120766. /**
  120767. * If sets to true, x component of normal map value will invert (x = 1.0 - x).
  120768. */
  120769. invertNormalMapX: boolean;
  120770. /**
  120771. * If sets to true, y component of normal map value will invert (y = 1.0 - y).
  120772. */
  120773. invertNormalMapY: boolean;
  120774. /**
  120775. * Normal map used in the model.
  120776. */
  120777. normalTexture: BaseTexture;
  120778. /**
  120779. * Emissivie color used to self-illuminate the model.
  120780. */
  120781. emissiveColor: Color3;
  120782. /**
  120783. * Emissivie texture used to self-illuminate the model.
  120784. */
  120785. emissiveTexture: BaseTexture;
  120786. /**
  120787. * Occlusion Channel Strenght.
  120788. */
  120789. occlusionStrength: number;
  120790. /**
  120791. * Occlusion Texture of the material (adding extra occlusion effects).
  120792. */
  120793. occlusionTexture: BaseTexture;
  120794. /**
  120795. * Defines the alpha limits in alpha test mode.
  120796. */
  120797. alphaCutOff: number;
  120798. /**
  120799. * Gets the current double sided mode.
  120800. */
  120801. /**
  120802. * If sets to true and backfaceCulling is false, normals will be flipped on the backside.
  120803. */
  120804. doubleSided: boolean;
  120805. /**
  120806. * Stores the pre-calculated light information of a mesh in a texture.
  120807. */
  120808. lightmapTexture: BaseTexture;
  120809. /**
  120810. * If true, the light map contains occlusion information instead of lighting info.
  120811. */
  120812. useLightmapAsShadowmap: boolean;
  120813. /**
  120814. * Instantiates a new PBRMaterial instance.
  120815. *
  120816. * @param name The material name
  120817. * @param scene The scene the material will be use in.
  120818. */
  120819. constructor(name: string, scene: Scene);
  120820. getClassName(): string;
  120821. }
  120822. }
  120823. declare module BABYLON {
  120824. /**
  120825. * The PBR material of BJS following the metal roughness convention.
  120826. *
  120827. * This fits to the PBR convention in the GLTF definition:
  120828. * https://github.com/KhronosGroup/glTF/tree/2.0/specification/2.0
  120829. */
  120830. export class PBRMetallicRoughnessMaterial extends PBRBaseSimpleMaterial {
  120831. /**
  120832. * The base color has two different interpretations depending on the value of metalness.
  120833. * When the material is a metal, the base color is the specific measured reflectance value
  120834. * at normal incidence (F0). For a non-metal the base color represents the reflected diffuse color
  120835. * of the material.
  120836. */
  120837. baseColor: Color3;
  120838. /**
  120839. * Base texture of the metallic workflow. It contains both the baseColor information in RGB as
  120840. * well as opacity information in the alpha channel.
  120841. */
  120842. baseTexture: BaseTexture;
  120843. /**
  120844. * Specifies the metallic scalar value of the material.
  120845. * Can also be used to scale the metalness values of the metallic texture.
  120846. */
  120847. metallic: number;
  120848. /**
  120849. * Specifies the roughness scalar value of the material.
  120850. * Can also be used to scale the roughness values of the metallic texture.
  120851. */
  120852. roughness: number;
  120853. /**
  120854. * Texture containing both the metallic value in the B channel and the
  120855. * roughness value in the G channel to keep better precision.
  120856. */
  120857. metallicRoughnessTexture: BaseTexture;
  120858. /**
  120859. * Instantiates a new PBRMetalRoughnessMaterial instance.
  120860. *
  120861. * @param name The material name
  120862. * @param scene The scene the material will be use in.
  120863. */
  120864. constructor(name: string, scene: Scene);
  120865. /**
  120866. * Return the currrent class name of the material.
  120867. */
  120868. getClassName(): string;
  120869. /**
  120870. * Makes a duplicate of the current material.
  120871. * @param name - name to use for the new material.
  120872. */
  120873. clone(name: string): PBRMetallicRoughnessMaterial;
  120874. /**
  120875. * Serialize the material to a parsable JSON object.
  120876. */
  120877. serialize(): any;
  120878. /**
  120879. * Parses a JSON object correponding to the serialize function.
  120880. */
  120881. static Parse(source: any, scene: Scene, rootUrl: string): PBRMetallicRoughnessMaterial;
  120882. }
  120883. }
  120884. declare module BABYLON {
  120885. /**
  120886. * The PBR material of BJS following the specular glossiness convention.
  120887. *
  120888. * This fits to the PBR convention in the GLTF definition:
  120889. * https://github.com/KhronosGroup/glTF/tree/2.0/extensions/Khronos/KHR_materials_pbrSpecularGlossiness
  120890. */
  120891. export class PBRSpecularGlossinessMaterial extends PBRBaseSimpleMaterial {
  120892. /**
  120893. * Specifies the diffuse color of the material.
  120894. */
  120895. diffuseColor: Color3;
  120896. /**
  120897. * Specifies the diffuse texture of the material. This can also contains the opcity value in its alpha
  120898. * channel.
  120899. */
  120900. diffuseTexture: BaseTexture;
  120901. /**
  120902. * Specifies the specular color of the material. This indicates how reflective is the material (none to mirror).
  120903. */
  120904. specularColor: Color3;
  120905. /**
  120906. * Specifies the glossiness of the material. This indicates "how sharp is the reflection".
  120907. */
  120908. glossiness: number;
  120909. /**
  120910. * Specifies both the specular color RGB and the glossiness A of the material per pixels.
  120911. */
  120912. specularGlossinessTexture: BaseTexture;
  120913. /**
  120914. * Instantiates a new PBRSpecularGlossinessMaterial instance.
  120915. *
  120916. * @param name The material name
  120917. * @param scene The scene the material will be use in.
  120918. */
  120919. constructor(name: string, scene: Scene);
  120920. /**
  120921. * Return the currrent class name of the material.
  120922. */
  120923. getClassName(): string;
  120924. /**
  120925. * Makes a duplicate of the current material.
  120926. * @param name - name to use for the new material.
  120927. */
  120928. clone(name: string): PBRSpecularGlossinessMaterial;
  120929. /**
  120930. * Serialize the material to a parsable JSON object.
  120931. */
  120932. serialize(): any;
  120933. /**
  120934. * Parses a JSON object correponding to the serialize function.
  120935. */
  120936. static Parse(source: any, scene: Scene, rootUrl: string): PBRSpecularGlossinessMaterial;
  120937. }
  120938. }
  120939. declare module BABYLON {
  120940. /**
  120941. * This represents a color grading texture. This acts as a lookup table LUT, useful during post process
  120942. * It can help converting any input color in a desired output one. This can then be used to create effects
  120943. * from sepia, black and white to sixties or futuristic rendering...
  120944. *
  120945. * The only supported format is currently 3dl.
  120946. * More information on LUT: https://en.wikipedia.org/wiki/3D_lookup_table
  120947. */
  120948. export class ColorGradingTexture extends BaseTexture {
  120949. /**
  120950. * The current texture matrix. (will always be identity in color grading texture)
  120951. */
  120952. private _textureMatrix;
  120953. /**
  120954. * The texture URL.
  120955. */
  120956. url: string;
  120957. /**
  120958. * Empty line regex stored for GC.
  120959. */
  120960. private static _noneEmptyLineRegex;
  120961. private _engine;
  120962. /**
  120963. * Instantiates a ColorGradingTexture from the following parameters.
  120964. *
  120965. * @param url The location of the color gradind data (currently only supporting 3dl)
  120966. * @param scene The scene the texture will be used in
  120967. */
  120968. constructor(url: string, scene: Scene);
  120969. /**
  120970. * Returns the texture matrix used in most of the material.
  120971. * This is not used in color grading but keep for troubleshooting purpose (easily swap diffuse by colorgrading to look in).
  120972. */
  120973. getTextureMatrix(): Matrix;
  120974. /**
  120975. * Occurs when the file being loaded is a .3dl LUT file.
  120976. */
  120977. private load3dlTexture;
  120978. /**
  120979. * Starts the loading process of the texture.
  120980. */
  120981. private loadTexture;
  120982. /**
  120983. * Clones the color gradind texture.
  120984. */
  120985. clone(): ColorGradingTexture;
  120986. /**
  120987. * Called during delayed load for textures.
  120988. */
  120989. delayLoad(): void;
  120990. /**
  120991. * Parses a color grading texture serialized by Babylon.
  120992. * @param parsedTexture The texture information being parsedTexture
  120993. * @param scene The scene to load the texture in
  120994. * @param rootUrl The root url of the data assets to load
  120995. * @return A color gradind texture
  120996. */
  120997. static Parse(parsedTexture: any, scene: Scene): Nullable<ColorGradingTexture>;
  120998. /**
  120999. * Serializes the LUT texture to json format.
  121000. */
  121001. serialize(): any;
  121002. }
  121003. }
  121004. declare module BABYLON {
  121005. /**
  121006. * This represents a texture coming from an equirectangular image supported by the web browser canvas.
  121007. */
  121008. export class EquiRectangularCubeTexture extends BaseTexture {
  121009. /** The six faces of the cube. */
  121010. private static _FacesMapping;
  121011. private _noMipmap;
  121012. private _onLoad;
  121013. private _onError;
  121014. /** The size of the cubemap. */
  121015. private _size;
  121016. /** The buffer of the image. */
  121017. private _buffer;
  121018. /** The width of the input image. */
  121019. private _width;
  121020. /** The height of the input image. */
  121021. private _height;
  121022. /** The URL to the image. */
  121023. url: string;
  121024. /** The texture coordinates mode. As this texture is stored in a cube format, please modify carefully. */
  121025. coordinatesMode: number;
  121026. /**
  121027. * Instantiates an EquiRectangularCubeTexture from the following parameters.
  121028. * @param url The location of the image
  121029. * @param scene The scene the texture will be used in
  121030. * @param size The cubemap desired size (the more it increases the longer the generation will be)
  121031. * @param noMipmap Forces to not generate the mipmap if true
  121032. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  121033. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  121034. * @param onLoad — defines a callback called when texture is loaded
  121035. * @param onError — defines a callback called if there is an error
  121036. */
  121037. constructor(url: string, scene: Scene, size: number, noMipmap?: boolean, gammaSpace?: boolean, onLoad?: Nullable<() => void>, onError?: Nullable<(message?: string, exception?: any) => void>);
  121038. /**
  121039. * Load the image data, by putting the image on a canvas and extracting its buffer.
  121040. */
  121041. private loadImage;
  121042. /**
  121043. * Convert the image buffer into a cubemap and create a CubeTexture.
  121044. */
  121045. private loadTexture;
  121046. /**
  121047. * Convert the ArrayBuffer into a Float32Array and drop the transparency channel.
  121048. * @param buffer The ArrayBuffer that should be converted.
  121049. * @returns The buffer as Float32Array.
  121050. */
  121051. private getFloat32ArrayFromArrayBuffer;
  121052. /**
  121053. * Get the current class name of the texture useful for serialization or dynamic coding.
  121054. * @returns "EquiRectangularCubeTexture"
  121055. */
  121056. getClassName(): string;
  121057. /**
  121058. * Create a clone of the current EquiRectangularCubeTexture and return it.
  121059. * @returns A clone of the current EquiRectangularCubeTexture.
  121060. */
  121061. clone(): EquiRectangularCubeTexture;
  121062. }
  121063. }
  121064. declare module BABYLON {
  121065. /**
  121066. * Based on jsTGALoader - Javascript loader for TGA file
  121067. * By Vincent Thibault
  121068. * @see http://blog.robrowser.com/javascript-tga-loader.html
  121069. */
  121070. export class TGATools {
  121071. private static _TYPE_INDEXED;
  121072. private static _TYPE_RGB;
  121073. private static _TYPE_GREY;
  121074. private static _TYPE_RLE_INDEXED;
  121075. private static _TYPE_RLE_RGB;
  121076. private static _TYPE_RLE_GREY;
  121077. private static _ORIGIN_MASK;
  121078. private static _ORIGIN_SHIFT;
  121079. private static _ORIGIN_BL;
  121080. private static _ORIGIN_BR;
  121081. private static _ORIGIN_UL;
  121082. private static _ORIGIN_UR;
  121083. /**
  121084. * Gets the header of a TGA file
  121085. * @param data defines the TGA data
  121086. * @returns the header
  121087. */
  121088. static GetTGAHeader(data: Uint8Array): any;
  121089. /**
  121090. * Uploads TGA content to a Babylon Texture
  121091. * @hidden
  121092. */
  121093. static UploadContent(texture: InternalTexture, data: Uint8Array): void;
  121094. /** @hidden */
  121095. 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;
  121096. /** @hidden */
  121097. 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;
  121098. /** @hidden */
  121099. 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;
  121100. /** @hidden */
  121101. 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;
  121102. /** @hidden */
  121103. 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;
  121104. /** @hidden */
  121105. 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;
  121106. }
  121107. }
  121108. declare module BABYLON {
  121109. /**
  121110. * Implementation of the TGA Texture Loader.
  121111. * @hidden
  121112. */
  121113. export class _TGATextureLoader implements IInternalTextureLoader {
  121114. /**
  121115. * Defines wether the loader supports cascade loading the different faces.
  121116. */
  121117. readonly supportCascades: boolean;
  121118. /**
  121119. * This returns if the loader support the current file information.
  121120. * @param extension defines the file extension of the file being loaded
  121121. * @param textureFormatInUse defines the current compressed format in use iun the engine
  121122. * @param fallback defines the fallback internal texture if any
  121123. * @param isBase64 defines whether the texture is encoded as a base64
  121124. * @param isBuffer defines whether the texture data are stored as a buffer
  121125. * @returns true if the loader can load the specified file
  121126. */
  121127. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  121128. /**
  121129. * Transform the url before loading if required.
  121130. * @param rootUrl the url of the texture
  121131. * @param textureFormatInUse defines the current compressed format in use iun the engine
  121132. * @returns the transformed texture
  121133. */
  121134. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  121135. /**
  121136. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  121137. * @param rootUrl the url of the texture
  121138. * @param textureFormatInUse defines the current compressed format in use iun the engine
  121139. * @returns the fallback texture
  121140. */
  121141. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  121142. /**
  121143. * Uploads the cube texture data to the WebGl Texture. It has alreday been bound.
  121144. * @param data contains the texture data
  121145. * @param texture defines the BabylonJS internal texture
  121146. * @param createPolynomials will be true if polynomials have been requested
  121147. * @param onLoad defines the callback to trigger once the texture is ready
  121148. * @param onError defines the callback to trigger in case of error
  121149. */
  121150. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  121151. /**
  121152. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  121153. * @param data contains the texture data
  121154. * @param texture defines the BabylonJS internal texture
  121155. * @param callback defines the method to call once ready to upload
  121156. */
  121157. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  121158. }
  121159. }
  121160. declare module BABYLON {
  121161. /**
  121162. * Info about the .basis files
  121163. */
  121164. class BasisFileInfo {
  121165. /**
  121166. * If the file has alpha
  121167. */
  121168. hasAlpha: boolean;
  121169. /**
  121170. * Info about each image of the basis file
  121171. */
  121172. images: Array<{
  121173. levels: Array<{
  121174. width: number;
  121175. height: number;
  121176. transcodedPixels: ArrayBufferView;
  121177. }>;
  121178. }>;
  121179. }
  121180. /**
  121181. * Result of transcoding a basis file
  121182. */
  121183. class TranscodeResult {
  121184. /**
  121185. * Info about the .basis file
  121186. */
  121187. fileInfo: BasisFileInfo;
  121188. /**
  121189. * Format to use when loading the file
  121190. */
  121191. format: number;
  121192. }
  121193. /**
  121194. * Configuration options for the Basis transcoder
  121195. */
  121196. export class BasisTranscodeConfiguration {
  121197. /**
  121198. * Supported compression formats used to determine the supported output format of the transcoder
  121199. */
  121200. supportedCompressionFormats?: {
  121201. /**
  121202. * etc1 compression format
  121203. */
  121204. etc1?: boolean;
  121205. /**
  121206. * s3tc compression format
  121207. */
  121208. s3tc?: boolean;
  121209. /**
  121210. * pvrtc compression format
  121211. */
  121212. pvrtc?: boolean;
  121213. /**
  121214. * etc2 compression format
  121215. */
  121216. etc2?: boolean;
  121217. };
  121218. /**
  121219. * If mipmap levels should be loaded for transcoded images (Default: true)
  121220. */
  121221. loadMipmapLevels?: boolean;
  121222. /**
  121223. * Index of a single image to load (Default: all images)
  121224. */
  121225. loadSingleImage?: number;
  121226. }
  121227. /**
  121228. * Used to load .Basis files
  121229. * See https://github.com/BinomialLLC/basis_universal/tree/master/webgl
  121230. */
  121231. export class BasisTools {
  121232. private static _IgnoreSupportedFormats;
  121233. /**
  121234. * URL to use when loading the basis transcoder
  121235. */
  121236. static JSModuleURL: string;
  121237. /**
  121238. * URL to use when loading the wasm module for the transcoder
  121239. */
  121240. static WasmModuleURL: string;
  121241. /**
  121242. * Get the internal format to be passed to texImage2D corresponding to the .basis format value
  121243. * @param basisFormat format chosen from GetSupportedTranscodeFormat
  121244. * @returns internal format corresponding to the Basis format
  121245. */
  121246. static GetInternalFormatFromBasisFormat(basisFormat: number): number;
  121247. private static _WorkerPromise;
  121248. private static _Worker;
  121249. private static _actionId;
  121250. private static _CreateWorkerAsync;
  121251. /**
  121252. * Transcodes a loaded image file to compressed pixel data
  121253. * @param imageData image data to transcode
  121254. * @param config configuration options for the transcoding
  121255. * @returns a promise resulting in the transcoded image
  121256. */
  121257. static TranscodeAsync(imageData: ArrayBuffer, config: BasisTranscodeConfiguration): Promise<TranscodeResult>;
  121258. /**
  121259. * Loads a texture from the transcode result
  121260. * @param texture texture load to
  121261. * @param transcodeResult the result of transcoding the basis file to load from
  121262. */
  121263. static LoadTextureFromTranscodeResult(texture: InternalTexture, transcodeResult: TranscodeResult): void;
  121264. }
  121265. }
  121266. declare module BABYLON {
  121267. /**
  121268. * Loader for .basis file format
  121269. */
  121270. export class _BasisTextureLoader implements IInternalTextureLoader {
  121271. /**
  121272. * Defines whether the loader supports cascade loading the different faces.
  121273. */
  121274. readonly supportCascades: boolean;
  121275. /**
  121276. * This returns if the loader support the current file information.
  121277. * @param extension defines the file extension of the file being loaded
  121278. * @param textureFormatInUse defines the current compressed format in use iun the engine
  121279. * @param fallback defines the fallback internal texture if any
  121280. * @param isBase64 defines whether the texture is encoded as a base64
  121281. * @param isBuffer defines whether the texture data are stored as a buffer
  121282. * @returns true if the loader can load the specified file
  121283. */
  121284. canLoad(extension: string, textureFormatInUse: Nullable<string>, fallback: Nullable<InternalTexture>, isBase64: boolean, isBuffer: boolean): boolean;
  121285. /**
  121286. * Transform the url before loading if required.
  121287. * @param rootUrl the url of the texture
  121288. * @param textureFormatInUse defines the current compressed format in use iun the engine
  121289. * @returns the transformed texture
  121290. */
  121291. transformUrl(rootUrl: string, textureFormatInUse: Nullable<string>): string;
  121292. /**
  121293. * Gets the fallback url in case the load fail. This can return null to allow the default fallback mecanism to work
  121294. * @param rootUrl the url of the texture
  121295. * @param textureFormatInUse defines the current compressed format in use iun the engine
  121296. * @returns the fallback texture
  121297. */
  121298. getFallbackTextureUrl(rootUrl: string, textureFormatInUse: Nullable<string>): Nullable<string>;
  121299. /**
  121300. * Uploads the cube texture data to the WebGl Texture. It has already been bound.
  121301. * @param data contains the texture data
  121302. * @param texture defines the BabylonJS internal texture
  121303. * @param createPolynomials will be true if polynomials have been requested
  121304. * @param onLoad defines the callback to trigger once the texture is ready
  121305. * @param onError defines the callback to trigger in case of error
  121306. */
  121307. loadCubeData(data: string | ArrayBuffer | (string | ArrayBuffer)[], texture: InternalTexture, createPolynomials: boolean, onLoad: Nullable<(data?: any) => void>, onError: Nullable<(message?: string, exception?: any) => void>): void;
  121308. /**
  121309. * Uploads the 2D texture data to the WebGl Texture. It has alreday been bound once in the callback.
  121310. * @param data contains the texture data
  121311. * @param texture defines the BabylonJS internal texture
  121312. * @param callback defines the method to call once ready to upload
  121313. */
  121314. loadData(data: ArrayBuffer, texture: InternalTexture, callback: (width: number, height: number, loadMipmap: boolean, isCompressed: boolean, done: () => void) => void): void;
  121315. }
  121316. }
  121317. declare module BABYLON {
  121318. /**
  121319. * 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.
  121320. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  121321. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  121322. */
  121323. export class CustomProceduralTexture extends ProceduralTexture {
  121324. private _animate;
  121325. private _time;
  121326. private _config;
  121327. private _texturePath;
  121328. /**
  121329. * Instantiates a new Custom Procedural Texture.
  121330. * 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.
  121331. * Custom Procedural textures are the easiest way to create your own procedural in your application.
  121332. * @see http://doc.babylonjs.com/how_to/how_to_use_procedural_textures#creating-custom-procedural-textures
  121333. * @param name Define the name of the texture
  121334. * @param texturePath Define the folder path containing all the cutom texture related files (config, shaders...)
  121335. * @param size Define the size of the texture to create
  121336. * @param scene Define the scene the texture belongs to
  121337. * @param fallbackTexture Define a fallback texture in case there were issues to create the custom texture
  121338. * @param generateMipMaps Define if the texture should creates mip maps or not
  121339. */
  121340. constructor(name: string, texturePath: string, size: number, scene: Scene, fallbackTexture?: Texture, generateMipMaps?: boolean);
  121341. private _loadJson;
  121342. /**
  121343. * Is the texture ready to be used ? (rendered at least once)
  121344. * @returns true if ready, otherwise, false.
  121345. */
  121346. isReady(): boolean;
  121347. /**
  121348. * Render the texture to its associated render target.
  121349. * @param useCameraPostProcess Define if camera post process should be applied to the texture
  121350. */
  121351. render(useCameraPostProcess?: boolean): void;
  121352. /**
  121353. * Update the list of dependant textures samplers in the shader.
  121354. */
  121355. updateTextures(): void;
  121356. /**
  121357. * Update the uniform values of the procedural texture in the shader.
  121358. */
  121359. updateShaderUniforms(): void;
  121360. /**
  121361. * Define if the texture animates or not.
  121362. */
  121363. animate: boolean;
  121364. }
  121365. }
  121366. declare module BABYLON {
  121367. /** @hidden */
  121368. export var noisePixelShader: {
  121369. name: string;
  121370. shader: string;
  121371. };
  121372. }
  121373. declare module BABYLON {
  121374. /**
  121375. * Class used to generate noise procedural textures
  121376. */
  121377. export class NoiseProceduralTexture extends ProceduralTexture {
  121378. private _time;
  121379. /** Gets or sets a value between 0 and 1 indicating the overall brightness of the texture (default is 0.2) */
  121380. brightness: number;
  121381. /** Defines the number of octaves to process */
  121382. octaves: number;
  121383. /** Defines the level of persistence (0.8 by default) */
  121384. persistence: number;
  121385. /** Gets or sets animation speed factor (default is 1) */
  121386. animationSpeedFactor: number;
  121387. /**
  121388. * Creates a new NoiseProceduralTexture
  121389. * @param name defines the name fo the texture
  121390. * @param size defines the size of the texture (default is 256)
  121391. * @param scene defines the hosting scene
  121392. * @param fallbackTexture defines the texture to use if the NoiseProceduralTexture can't be created
  121393. * @param generateMipMaps defines if mipmaps must be generated (true by default)
  121394. */
  121395. constructor(name: string, size?: number, scene?: Nullable<Scene>, fallbackTexture?: Texture, generateMipMaps?: boolean);
  121396. private _updateShaderUniforms;
  121397. protected _getDefines(): string;
  121398. /** Generate the current state of the procedural texture */
  121399. render(useCameraPostProcess?: boolean): void;
  121400. /**
  121401. * Serializes this noise procedural texture
  121402. * @returns a serialized noise procedural texture object
  121403. */
  121404. serialize(): any;
  121405. /**
  121406. * Creates a NoiseProceduralTexture from parsed noise procedural texture data
  121407. * @param parsedTexture defines parsed texture data
  121408. * @param scene defines the current scene
  121409. * @param rootUrl defines the root URL containing noise procedural texture information
  121410. * @returns a parsed NoiseProceduralTexture
  121411. */
  121412. static Parse(parsedTexture: any, scene: Scene): NoiseProceduralTexture;
  121413. }
  121414. }
  121415. declare module BABYLON {
  121416. /**
  121417. * Raw cube texture where the raw buffers are passed in
  121418. */
  121419. export class RawCubeTexture extends CubeTexture {
  121420. /**
  121421. * Creates a cube texture where the raw buffers are passed in.
  121422. * @param scene defines the scene the texture is attached to
  121423. * @param data defines the array of data to use to create each face
  121424. * @param size defines the size of the textures
  121425. * @param format defines the format of the data
  121426. * @param type defines the type of the data (like Engine.TEXTURETYPE_UNSIGNED_INT)
  121427. * @param generateMipMaps defines if the engine should generate the mip levels
  121428. * @param invertY defines if data must be stored with Y axis inverted
  121429. * @param samplingMode defines the required sampling mode (like Texture.NEAREST_SAMPLINGMODE)
  121430. * @param compression defines the compression used (null by default)
  121431. */
  121432. constructor(scene: Scene, data: Nullable<ArrayBufferView[]>, size: number, format?: number, type?: number, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, compression?: Nullable<string>);
  121433. /**
  121434. * Updates the raw cube texture.
  121435. * @param data defines the data to store
  121436. * @param format defines the data format
  121437. * @param type defines the type fo the data (Engine.TEXTURETYPE_UNSIGNED_INT by default)
  121438. * @param invertY defines if data must be stored with Y axis inverted
  121439. * @param compression defines the compression used (null by default)
  121440. * @param level defines which level of the texture to update
  121441. */
  121442. update(data: ArrayBufferView[], format: number, type: number, invertY: boolean, compression?: Nullable<string>): void;
  121443. /**
  121444. * Updates a raw cube texture with RGBD encoded data.
  121445. * @param data defines the array of data [mipmap][face] to use to create each face
  121446. * @param sphericalPolynomial defines the spherical polynomial for irradiance
  121447. * @param lodScale defines the scale applied to environment texture. This manages the range of LOD level used for IBL according to the roughness
  121448. * @param lodOffset defines the offset applied to environment texture. This manages first LOD level used for IBL according to the roughness
  121449. * @returns a promsie that resolves when the operation is complete
  121450. */
  121451. updateRGBDAsync(data: ArrayBufferView[][], sphericalPolynomial?: Nullable<SphericalPolynomial>, lodScale?: number, lodOffset?: number): Promise<void>;
  121452. /**
  121453. * Clones the raw cube texture.
  121454. * @return a new cube texture
  121455. */
  121456. clone(): CubeTexture;
  121457. /** @hidden */
  121458. static _UpdateRGBDAsync(internalTexture: InternalTexture, data: ArrayBufferView[][], sphericalPolynomial: Nullable<SphericalPolynomial>, lodScale: number, lodOffset: number): Promise<void>;
  121459. }
  121460. }
  121461. declare module BABYLON {
  121462. /**
  121463. * Class used to store 3D textures containing user data
  121464. */
  121465. export class RawTexture3D extends Texture {
  121466. /** Gets or sets the texture format to use */
  121467. format: number;
  121468. private _engine;
  121469. /**
  121470. * Create a new RawTexture3D
  121471. * @param data defines the data of the texture
  121472. * @param width defines the width of the texture
  121473. * @param height defines the height of the texture
  121474. * @param depth defines the depth of the texture
  121475. * @param format defines the texture format to use
  121476. * @param scene defines the hosting scene
  121477. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  121478. * @param invertY defines if texture must be stored with Y axis inverted
  121479. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  121480. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  121481. */
  121482. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  121483. /** Gets or sets the texture format to use */
  121484. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  121485. /**
  121486. * Update the texture with new data
  121487. * @param data defines the data to store in the texture
  121488. */
  121489. update(data: ArrayBufferView): void;
  121490. }
  121491. }
  121492. declare module BABYLON {
  121493. /**
  121494. * Class used to store 2D array textures containing user data
  121495. */
  121496. export class RawTexture2DArray extends Texture {
  121497. /** Gets or sets the texture format to use */
  121498. format: number;
  121499. private _engine;
  121500. /**
  121501. * Create a new RawTexture2DArray
  121502. * @param data defines the data of the texture
  121503. * @param width defines the width of the texture
  121504. * @param height defines the height of the texture
  121505. * @param depth defines the number of layers of the texture
  121506. * @param format defines the texture format to use
  121507. * @param scene defines the hosting scene
  121508. * @param generateMipMaps defines a boolean indicating if mip levels should be generated (true by default)
  121509. * @param invertY defines if texture must be stored with Y axis inverted
  121510. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  121511. * @param textureType defines the texture Type (Engine.TEXTURETYPE_UNSIGNED_INT, Engine.TEXTURETYPE_FLOAT...)
  121512. */
  121513. constructor(data: ArrayBufferView, width: number, height: number, depth: number,
  121514. /** Gets or sets the texture format to use */
  121515. format: number, scene: Scene, generateMipMaps?: boolean, invertY?: boolean, samplingMode?: number, textureType?: number);
  121516. /**
  121517. * Update the texture with new data
  121518. * @param data defines the data to store in the texture
  121519. */
  121520. update(data: ArrayBufferView): void;
  121521. }
  121522. }
  121523. declare module BABYLON {
  121524. /**
  121525. * Creates a refraction texture used by refraction channel of the standard material.
  121526. * It is like a mirror but to see through a material.
  121527. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  121528. */
  121529. export class RefractionTexture extends RenderTargetTexture {
  121530. /**
  121531. * Define the reflection plane we want to use. The refractionPlane is usually set to the constructed refractor.
  121532. * 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.
  121533. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  121534. */
  121535. refractionPlane: Plane;
  121536. /**
  121537. * Define how deep under the surface we should see.
  121538. */
  121539. depth: number;
  121540. /**
  121541. * Creates a refraction texture used by refraction channel of the standard material.
  121542. * It is like a mirror but to see through a material.
  121543. * @see https://doc.babylonjs.com/how_to/reflect#refraction
  121544. * @param name Define the texture name
  121545. * @param size Define the size of the underlying texture
  121546. * @param scene Define the scene the refraction belongs to
  121547. * @param generateMipMaps Define if we need to generate mips level for the refraction
  121548. */
  121549. constructor(name: string, size: number, scene: Scene, generateMipMaps?: boolean);
  121550. /**
  121551. * Clone the refraction texture.
  121552. * @returns the cloned texture
  121553. */
  121554. clone(): RefractionTexture;
  121555. /**
  121556. * Serialize the texture to a JSON representation you could use in Parse later on
  121557. * @returns the serialized JSON representation
  121558. */
  121559. serialize(): any;
  121560. }
  121561. }
  121562. declare module BABYLON {
  121563. /**
  121564. * Defines the options related to the creation of an HtmlElementTexture
  121565. */
  121566. export interface IHtmlElementTextureOptions {
  121567. /**
  121568. * Defines wether mip maps should be created or not.
  121569. */
  121570. generateMipMaps?: boolean;
  121571. /**
  121572. * Defines the sampling mode of the texture.
  121573. */
  121574. samplingMode?: number;
  121575. /**
  121576. * Defines the engine instance to use the texture with. It is not mandatory if you define a scene.
  121577. */
  121578. engine: Nullable<ThinEngine>;
  121579. /**
  121580. * Defines the scene the texture belongs to. It is not mandatory if you define an engine.
  121581. */
  121582. scene: Nullable<Scene>;
  121583. }
  121584. /**
  121585. * This represents the smallest workload to use an already existing element (Canvas or Video) as a texture.
  121586. * To be as efficient as possible depending on your constraints nothing aside the first upload
  121587. * is automatically managed.
  121588. * It is a cheap VideoTexture or DynamicTexture if you prefer to keep full control of the elements
  121589. * in your application.
  121590. *
  121591. * As the update is not automatic, you need to call them manually.
  121592. */
  121593. export class HtmlElementTexture extends BaseTexture {
  121594. /**
  121595. * The texture URL.
  121596. */
  121597. element: HTMLVideoElement | HTMLCanvasElement;
  121598. private static readonly DefaultOptions;
  121599. private _textureMatrix;
  121600. private _engine;
  121601. private _isVideo;
  121602. private _generateMipMaps;
  121603. private _samplingMode;
  121604. /**
  121605. * Instantiates a HtmlElementTexture from the following parameters.
  121606. *
  121607. * @param name Defines the name of the texture
  121608. * @param element Defines the video or canvas the texture is filled with
  121609. * @param options Defines the other none mandatory texture creation options
  121610. */
  121611. constructor(name: string, element: HTMLVideoElement | HTMLCanvasElement, options: IHtmlElementTextureOptions);
  121612. private _createInternalTexture;
  121613. /**
  121614. * Returns the texture matrix used in most of the material.
  121615. */
  121616. getTextureMatrix(): Matrix;
  121617. /**
  121618. * Updates the content of the texture.
  121619. * @param invertY Defines wether the texture should be inverted on Y (false by default on video and true on canvas)
  121620. */
  121621. update(invertY?: Nullable<boolean>): void;
  121622. }
  121623. }
  121624. declare module BABYLON {
  121625. /**
  121626. * Enum used to define the target of a block
  121627. */
  121628. export enum NodeMaterialBlockTargets {
  121629. /** Vertex shader */
  121630. Vertex = 1,
  121631. /** Fragment shader */
  121632. Fragment = 2,
  121633. /** Neutral */
  121634. Neutral = 4,
  121635. /** Vertex and Fragment */
  121636. VertexAndFragment = 3
  121637. }
  121638. }
  121639. declare module BABYLON {
  121640. /**
  121641. * Defines the kind of connection point for node based material
  121642. */
  121643. export enum NodeMaterialBlockConnectionPointTypes {
  121644. /** Float */
  121645. Float = 1,
  121646. /** Int */
  121647. Int = 2,
  121648. /** Vector2 */
  121649. Vector2 = 4,
  121650. /** Vector3 */
  121651. Vector3 = 8,
  121652. /** Vector4 */
  121653. Vector4 = 16,
  121654. /** Color3 */
  121655. Color3 = 32,
  121656. /** Color4 */
  121657. Color4 = 64,
  121658. /** Matrix */
  121659. Matrix = 128,
  121660. /** Detect type based on connection */
  121661. AutoDetect = 1024,
  121662. /** Output type that will be defined by input type */
  121663. BasedOnInput = 2048
  121664. }
  121665. }
  121666. declare module BABYLON {
  121667. /**
  121668. * Enum defining the mode of a NodeMaterialBlockConnectionPoint
  121669. */
  121670. export enum NodeMaterialBlockConnectionPointMode {
  121671. /** Value is an uniform */
  121672. Uniform = 0,
  121673. /** Value is a mesh attribute */
  121674. Attribute = 1,
  121675. /** Value is a varying between vertex and fragment shaders */
  121676. Varying = 2,
  121677. /** Mode is undefined */
  121678. Undefined = 3
  121679. }
  121680. }
  121681. declare module BABYLON {
  121682. /**
  121683. * Enum used to define system values e.g. values automatically provided by the system
  121684. */
  121685. export enum NodeMaterialSystemValues {
  121686. /** World */
  121687. World = 1,
  121688. /** View */
  121689. View = 2,
  121690. /** Projection */
  121691. Projection = 3,
  121692. /** ViewProjection */
  121693. ViewProjection = 4,
  121694. /** WorldView */
  121695. WorldView = 5,
  121696. /** WorldViewProjection */
  121697. WorldViewProjection = 6,
  121698. /** CameraPosition */
  121699. CameraPosition = 7,
  121700. /** Fog Color */
  121701. FogColor = 8,
  121702. /** Delta time */
  121703. DeltaTime = 9
  121704. }
  121705. }
  121706. declare module BABYLON {
  121707. /**
  121708. * Root class for all node material optimizers
  121709. */
  121710. export class NodeMaterialOptimizer {
  121711. /**
  121712. * Function used to optimize a NodeMaterial graph
  121713. * @param vertexOutputNodes defines the list of output nodes for the vertex shader
  121714. * @param fragmentOutputNodes defines the list of output nodes for the fragment shader
  121715. */
  121716. optimize(vertexOutputNodes: NodeMaterialBlock[], fragmentOutputNodes: NodeMaterialBlock[]): void;
  121717. }
  121718. }
  121719. declare module BABYLON {
  121720. /**
  121721. * Block used to transform a vector (2, 3 or 4) with a matrix. It will generate a Vector4
  121722. */
  121723. export class TransformBlock extends NodeMaterialBlock {
  121724. /**
  121725. * Defines the value to use to complement W value to transform it to a Vector4
  121726. */
  121727. complementW: number;
  121728. /**
  121729. * Defines the value to use to complement z value to transform it to a Vector4
  121730. */
  121731. complementZ: number;
  121732. /**
  121733. * Creates a new TransformBlock
  121734. * @param name defines the block name
  121735. */
  121736. constructor(name: string);
  121737. /**
  121738. * Gets the current class name
  121739. * @returns the class name
  121740. */
  121741. getClassName(): string;
  121742. /**
  121743. * Gets the vector input
  121744. */
  121745. readonly vector: NodeMaterialConnectionPoint;
  121746. /**
  121747. * Gets the output component
  121748. */
  121749. readonly output: NodeMaterialConnectionPoint;
  121750. /**
  121751. * Gets the matrix transform input
  121752. */
  121753. readonly transform: NodeMaterialConnectionPoint;
  121754. protected _buildBlock(state: NodeMaterialBuildState): this;
  121755. serialize(): any;
  121756. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  121757. protected _dumpPropertiesCode(): string;
  121758. }
  121759. }
  121760. declare module BABYLON {
  121761. /**
  121762. * Block used to output the vertex position
  121763. */
  121764. export class VertexOutputBlock extends NodeMaterialBlock {
  121765. /**
  121766. * Creates a new VertexOutputBlock
  121767. * @param name defines the block name
  121768. */
  121769. constructor(name: string);
  121770. /**
  121771. * Gets the current class name
  121772. * @returns the class name
  121773. */
  121774. getClassName(): string;
  121775. /**
  121776. * Gets the vector input component
  121777. */
  121778. readonly vector: NodeMaterialConnectionPoint;
  121779. protected _buildBlock(state: NodeMaterialBuildState): this;
  121780. }
  121781. }
  121782. declare module BABYLON {
  121783. /**
  121784. * Block used to output the final color
  121785. */
  121786. export class FragmentOutputBlock extends NodeMaterialBlock {
  121787. /**
  121788. * Create a new FragmentOutputBlock
  121789. * @param name defines the block name
  121790. */
  121791. constructor(name: string);
  121792. /**
  121793. * Gets the current class name
  121794. * @returns the class name
  121795. */
  121796. getClassName(): string;
  121797. /**
  121798. * Gets the rgba input component
  121799. */
  121800. readonly rgba: NodeMaterialConnectionPoint;
  121801. /**
  121802. * Gets the rgb input component
  121803. */
  121804. readonly rgb: NodeMaterialConnectionPoint;
  121805. /**
  121806. * Gets the a input component
  121807. */
  121808. readonly a: NodeMaterialConnectionPoint;
  121809. protected _buildBlock(state: NodeMaterialBuildState): this;
  121810. }
  121811. }
  121812. declare module BABYLON {
  121813. /**
  121814. * Block used to read a reflection texture from a sampler
  121815. */
  121816. export class ReflectionTextureBlock extends NodeMaterialBlock {
  121817. private _define3DName;
  121818. private _defineCubicName;
  121819. private _defineExplicitName;
  121820. private _defineProjectionName;
  121821. private _defineLocalCubicName;
  121822. private _defineSphericalName;
  121823. private _definePlanarName;
  121824. private _defineEquirectangularName;
  121825. private _defineMirroredEquirectangularFixedName;
  121826. private _defineEquirectangularFixedName;
  121827. private _defineSkyboxName;
  121828. private _cubeSamplerName;
  121829. private _2DSamplerName;
  121830. private _positionUVWName;
  121831. private _directionWName;
  121832. private _reflectionCoordsName;
  121833. private _reflection2DCoordsName;
  121834. private _reflectionColorName;
  121835. private _reflectionMatrixName;
  121836. /**
  121837. * Gets or sets the texture associated with the node
  121838. */
  121839. texture: Nullable<BaseTexture>;
  121840. /**
  121841. * Create a new TextureBlock
  121842. * @param name defines the block name
  121843. */
  121844. constructor(name: string);
  121845. /**
  121846. * Gets the current class name
  121847. * @returns the class name
  121848. */
  121849. getClassName(): string;
  121850. /**
  121851. * Gets the world position input component
  121852. */
  121853. readonly position: NodeMaterialConnectionPoint;
  121854. /**
  121855. * Gets the world position input component
  121856. */
  121857. readonly worldPosition: NodeMaterialConnectionPoint;
  121858. /**
  121859. * Gets the world normal input component
  121860. */
  121861. readonly worldNormal: NodeMaterialConnectionPoint;
  121862. /**
  121863. * Gets the world input component
  121864. */
  121865. readonly world: NodeMaterialConnectionPoint;
  121866. /**
  121867. * Gets the camera (or eye) position component
  121868. */
  121869. readonly cameraPosition: NodeMaterialConnectionPoint;
  121870. /**
  121871. * Gets the view input component
  121872. */
  121873. readonly view: NodeMaterialConnectionPoint;
  121874. /**
  121875. * Gets the rgb output component
  121876. */
  121877. readonly rgb: NodeMaterialConnectionPoint;
  121878. /**
  121879. * Gets the r output component
  121880. */
  121881. readonly r: NodeMaterialConnectionPoint;
  121882. /**
  121883. * Gets the g output component
  121884. */
  121885. readonly g: NodeMaterialConnectionPoint;
  121886. /**
  121887. * Gets the b output component
  121888. */
  121889. readonly b: NodeMaterialConnectionPoint;
  121890. autoConfigure(material: NodeMaterial): void;
  121891. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  121892. isReady(): boolean;
  121893. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  121894. private _injectVertexCode;
  121895. private _writeOutput;
  121896. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  121897. protected _dumpPropertiesCode(): string;
  121898. serialize(): any;
  121899. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  121900. }
  121901. }
  121902. declare module BABYLON {
  121903. /**
  121904. * Interface used to configure the node material editor
  121905. */
  121906. export interface INodeMaterialEditorOptions {
  121907. /** Define the URl to load node editor script */
  121908. editorURL?: string;
  121909. }
  121910. /** @hidden */
  121911. export class NodeMaterialDefines extends MaterialDefines implements IImageProcessingConfigurationDefines {
  121912. /** BONES */
  121913. NUM_BONE_INFLUENCERS: number;
  121914. BonesPerMesh: number;
  121915. BONETEXTURE: boolean;
  121916. /** MORPH TARGETS */
  121917. MORPHTARGETS: boolean;
  121918. MORPHTARGETS_NORMAL: boolean;
  121919. MORPHTARGETS_TANGENT: boolean;
  121920. MORPHTARGETS_UV: boolean;
  121921. NUM_MORPH_INFLUENCERS: number;
  121922. /** IMAGE PROCESSING */
  121923. IMAGEPROCESSING: boolean;
  121924. VIGNETTE: boolean;
  121925. VIGNETTEBLENDMODEMULTIPLY: boolean;
  121926. VIGNETTEBLENDMODEOPAQUE: boolean;
  121927. TONEMAPPING: boolean;
  121928. TONEMAPPING_ACES: boolean;
  121929. CONTRAST: boolean;
  121930. EXPOSURE: boolean;
  121931. COLORCURVES: boolean;
  121932. COLORGRADING: boolean;
  121933. COLORGRADING3D: boolean;
  121934. SAMPLER3DGREENDEPTH: boolean;
  121935. SAMPLER3DBGRMAP: boolean;
  121936. IMAGEPROCESSINGPOSTPROCESS: boolean;
  121937. /** MISC. */
  121938. BUMPDIRECTUV: number;
  121939. constructor();
  121940. setValue(name: string, value: boolean): void;
  121941. }
  121942. /**
  121943. * Class used to configure NodeMaterial
  121944. */
  121945. export interface INodeMaterialOptions {
  121946. /**
  121947. * Defines if blocks should emit comments
  121948. */
  121949. emitComments: boolean;
  121950. }
  121951. /**
  121952. * Class used to create a node based material built by assembling shader blocks
  121953. */
  121954. export class NodeMaterial extends PushMaterial {
  121955. private static _BuildIdGenerator;
  121956. private _options;
  121957. private _vertexCompilationState;
  121958. private _fragmentCompilationState;
  121959. private _sharedData;
  121960. private _buildId;
  121961. private _buildWasSuccessful;
  121962. private _cachedWorldViewMatrix;
  121963. private _cachedWorldViewProjectionMatrix;
  121964. private _optimizers;
  121965. private _animationFrame;
  121966. /** Define the URl to load node editor script */
  121967. static EditorURL: string;
  121968. private BJSNODEMATERIALEDITOR;
  121969. /** Get the inspector from bundle or global */
  121970. private _getGlobalNodeMaterialEditor;
  121971. /**
  121972. * Gets or sets data used by visual editor
  121973. * @see https://nme.babylonjs.com
  121974. */
  121975. editorData: any;
  121976. /**
  121977. * 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)
  121978. */
  121979. ignoreAlpha: boolean;
  121980. /**
  121981. * Defines the maximum number of lights that can be used in the material
  121982. */
  121983. maxSimultaneousLights: number;
  121984. /**
  121985. * Observable raised when the material is built
  121986. */
  121987. onBuildObservable: Observable<NodeMaterial>;
  121988. /**
  121989. * Gets or sets the root nodes of the material vertex shader
  121990. */
  121991. _vertexOutputNodes: NodeMaterialBlock[];
  121992. /**
  121993. * Gets or sets the root nodes of the material fragment (pixel) shader
  121994. */
  121995. _fragmentOutputNodes: NodeMaterialBlock[];
  121996. /** Gets or sets options to control the node material overall behavior */
  121997. options: INodeMaterialOptions;
  121998. /**
  121999. * Default configuration related to image processing available in the standard Material.
  122000. */
  122001. protected _imageProcessingConfiguration: ImageProcessingConfiguration;
  122002. /**
  122003. * Gets the image processing configuration used either in this material.
  122004. */
  122005. /**
  122006. * Sets the Default image processing configuration used either in the this material.
  122007. *
  122008. * If sets to null, the scene one is in use.
  122009. */
  122010. imageProcessingConfiguration: ImageProcessingConfiguration;
  122011. /**
  122012. * Gets an array of blocks that needs to be serialized even if they are not yet connected
  122013. */
  122014. attachedBlocks: NodeMaterialBlock[];
  122015. /**
  122016. * Create a new node based material
  122017. * @param name defines the material name
  122018. * @param scene defines the hosting scene
  122019. * @param options defines creation option
  122020. */
  122021. constructor(name: string, scene?: Scene, options?: Partial<INodeMaterialOptions>);
  122022. /**
  122023. * Gets the current class name of the material e.g. "NodeMaterial"
  122024. * @returns the class name
  122025. */
  122026. getClassName(): string;
  122027. /**
  122028. * Keep track of the image processing observer to allow dispose and replace.
  122029. */
  122030. private _imageProcessingObserver;
  122031. /**
  122032. * Attaches a new image processing configuration to the Standard Material.
  122033. * @param configuration
  122034. */
  122035. protected _attachImageProcessingConfiguration(configuration: Nullable<ImageProcessingConfiguration>): void;
  122036. /**
  122037. * Get a block by its name
  122038. * @param name defines the name of the block to retrieve
  122039. * @returns the required block or null if not found
  122040. */
  122041. getBlockByName(name: string): Nullable<NodeMaterialBlock>;
  122042. /**
  122043. * Get a block by its name
  122044. * @param predicate defines the predicate used to find the good candidate
  122045. * @returns the required block or null if not found
  122046. */
  122047. getBlockByPredicate(predicate: (block: NodeMaterialBlock) => boolean): Nullable<NodeMaterialBlock>;
  122048. /**
  122049. * Get an input block by its name
  122050. * @param predicate defines the predicate used to find the good candidate
  122051. * @returns the required input block or null if not found
  122052. */
  122053. getInputBlockByPredicate(predicate: (block: InputBlock) => boolean): Nullable<InputBlock>;
  122054. /**
  122055. * Gets the list of input blocks attached to this material
  122056. * @returns an array of InputBlocks
  122057. */
  122058. getInputBlocks(): InputBlock[];
  122059. /**
  122060. * Adds a new optimizer to the list of optimizers
  122061. * @param optimizer defines the optimizers to add
  122062. * @returns the current material
  122063. */
  122064. registerOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  122065. /**
  122066. * Remove an optimizer from the list of optimizers
  122067. * @param optimizer defines the optimizers to remove
  122068. * @returns the current material
  122069. */
  122070. unregisterOptimizer(optimizer: NodeMaterialOptimizer): this | undefined;
  122071. /**
  122072. * Add a new block to the list of output nodes
  122073. * @param node defines the node to add
  122074. * @returns the current material
  122075. */
  122076. addOutputNode(node: NodeMaterialBlock): this;
  122077. /**
  122078. * Remove a block from the list of root nodes
  122079. * @param node defines the node to remove
  122080. * @returns the current material
  122081. */
  122082. removeOutputNode(node: NodeMaterialBlock): this;
  122083. private _addVertexOutputNode;
  122084. private _removeVertexOutputNode;
  122085. private _addFragmentOutputNode;
  122086. private _removeFragmentOutputNode;
  122087. /**
  122088. * Specifies if the material will require alpha blending
  122089. * @returns a boolean specifying if alpha blending is needed
  122090. */
  122091. needAlphaBlending(): boolean;
  122092. /**
  122093. * Specifies if this material should be rendered in alpha test mode
  122094. * @returns a boolean specifying if an alpha test is needed.
  122095. */
  122096. needAlphaTesting(): boolean;
  122097. private _initializeBlock;
  122098. private _resetDualBlocks;
  122099. /**
  122100. * Build the material and generates the inner effect
  122101. * @param verbose defines if the build should log activity
  122102. */
  122103. build(verbose?: boolean): void;
  122104. /**
  122105. * Runs an otpimization phase to try to improve the shader code
  122106. */
  122107. optimize(): void;
  122108. private _prepareDefinesForAttributes;
  122109. /**
  122110. * Get if the submesh is ready to be used and all its information available.
  122111. * Child classes can use it to update shaders
  122112. * @param mesh defines the mesh to check
  122113. * @param subMesh defines which submesh to check
  122114. * @param useInstances specifies that instances should be used
  122115. * @returns a boolean indicating that the submesh is ready or not
  122116. */
  122117. isReadyForSubMesh(mesh: AbstractMesh, subMesh: SubMesh, useInstances?: boolean): boolean;
  122118. /**
  122119. * Get a string representing the shaders built by the current node graph
  122120. */
  122121. readonly compiledShaders: string;
  122122. /**
  122123. * Binds the world matrix to the material
  122124. * @param world defines the world transformation matrix
  122125. */
  122126. bindOnlyWorldMatrix(world: Matrix): void;
  122127. /**
  122128. * Binds the submesh to this material by preparing the effect and shader to draw
  122129. * @param world defines the world transformation matrix
  122130. * @param mesh defines the mesh containing the submesh
  122131. * @param subMesh defines the submesh to bind the material to
  122132. */
  122133. bindForSubMesh(world: Matrix, mesh: Mesh, subMesh: SubMesh): void;
  122134. /**
  122135. * Gets the active textures from the material
  122136. * @returns an array of textures
  122137. */
  122138. getActiveTextures(): BaseTexture[];
  122139. /**
  122140. * Gets the list of texture blocks
  122141. * @returns an array of texture blocks
  122142. */
  122143. getTextureBlocks(): (TextureBlock | ReflectionTextureBlock)[];
  122144. /**
  122145. * Specifies if the material uses a texture
  122146. * @param texture defines the texture to check against the material
  122147. * @returns a boolean specifying if the material uses the texture
  122148. */
  122149. hasTexture(texture: BaseTexture): boolean;
  122150. /**
  122151. * Disposes the material
  122152. * @param forceDisposeEffect specifies if effects should be forcefully disposed
  122153. * @param forceDisposeTextures specifies if textures should be forcefully disposed
  122154. * @param notBoundToMesh specifies if the material that is being disposed is known to be not bound to any mesh
  122155. */
  122156. dispose(forceDisposeEffect?: boolean, forceDisposeTextures?: boolean, notBoundToMesh?: boolean): void;
  122157. /** Creates the node editor window. */
  122158. private _createNodeEditor;
  122159. /**
  122160. * Launch the node material editor
  122161. * @param config Define the configuration of the editor
  122162. * @return a promise fulfilled when the node editor is visible
  122163. */
  122164. edit(config?: INodeMaterialEditorOptions): Promise<void>;
  122165. /**
  122166. * Clear the current material
  122167. */
  122168. clear(): void;
  122169. /**
  122170. * Clear the current material and set it to a default state
  122171. */
  122172. setToDefault(): void;
  122173. /**
  122174. * Loads the current Node Material from a url pointing to a file save by the Node Material Editor
  122175. * @param url defines the url to load from
  122176. * @returns a promise that will fullfil when the material is fully loaded
  122177. */
  122178. loadAsync(url: string): Promise<void>;
  122179. private _gatherBlocks;
  122180. /**
  122181. * Generate a string containing the code declaration required to create an equivalent of this material
  122182. * @returns a string
  122183. */
  122184. generateCode(): string;
  122185. /**
  122186. * Serializes this material in a JSON representation
  122187. * @returns the serialized material object
  122188. */
  122189. serialize(): any;
  122190. private _restoreConnections;
  122191. /**
  122192. * Clear the current graph and load a new one from a serialization object
  122193. * @param source defines the JSON representation of the material
  122194. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  122195. */
  122196. loadFromSerialization(source: any, rootUrl?: string): void;
  122197. /**
  122198. * Creates a node material from parsed material data
  122199. * @param source defines the JSON representation of the material
  122200. * @param scene defines the hosting scene
  122201. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  122202. * @returns a new node material
  122203. */
  122204. static Parse(source: any, scene: Scene, rootUrl?: string): NodeMaterial;
  122205. /**
  122206. * Creates a new node material set to default basic configuration
  122207. * @param name defines the name of the material
  122208. * @param scene defines the hosting scene
  122209. * @returns a new NodeMaterial
  122210. */
  122211. static CreateDefault(name: string, scene?: Scene): NodeMaterial;
  122212. }
  122213. }
  122214. declare module BABYLON {
  122215. /**
  122216. * Block used to read a texture from a sampler
  122217. */
  122218. export class TextureBlock extends NodeMaterialBlock {
  122219. private _defineName;
  122220. private _linearDefineName;
  122221. private _tempTextureRead;
  122222. private _samplerName;
  122223. private _transformedUVName;
  122224. private _textureTransformName;
  122225. private _textureInfoName;
  122226. private _mainUVName;
  122227. private _mainUVDefineName;
  122228. /**
  122229. * Gets or sets the texture associated with the node
  122230. */
  122231. texture: Nullable<Texture>;
  122232. /**
  122233. * Create a new TextureBlock
  122234. * @param name defines the block name
  122235. */
  122236. constructor(name: string);
  122237. /**
  122238. * Gets the current class name
  122239. * @returns the class name
  122240. */
  122241. getClassName(): string;
  122242. /**
  122243. * Gets the uv input component
  122244. */
  122245. readonly uv: NodeMaterialConnectionPoint;
  122246. /**
  122247. * Gets the rgba output component
  122248. */
  122249. readonly rgba: NodeMaterialConnectionPoint;
  122250. /**
  122251. * Gets the rgb output component
  122252. */
  122253. readonly rgb: NodeMaterialConnectionPoint;
  122254. /**
  122255. * Gets the r output component
  122256. */
  122257. readonly r: NodeMaterialConnectionPoint;
  122258. /**
  122259. * Gets the g output component
  122260. */
  122261. readonly g: NodeMaterialConnectionPoint;
  122262. /**
  122263. * Gets the b output component
  122264. */
  122265. readonly b: NodeMaterialConnectionPoint;
  122266. /**
  122267. * Gets the a output component
  122268. */
  122269. readonly a: NodeMaterialConnectionPoint;
  122270. readonly target: NodeMaterialBlockTargets;
  122271. autoConfigure(material: NodeMaterial): void;
  122272. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  122273. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  122274. isReady(): boolean;
  122275. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  122276. private readonly _isMixed;
  122277. private _injectVertexCode;
  122278. private _writeTextureRead;
  122279. private _writeOutput;
  122280. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  122281. protected _dumpPropertiesCode(): string;
  122282. serialize(): any;
  122283. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  122284. }
  122285. }
  122286. declare module BABYLON {
  122287. /**
  122288. * Class used to store shared data between 2 NodeMaterialBuildState
  122289. */
  122290. export class NodeMaterialBuildStateSharedData {
  122291. /**
  122292. * Gets the list of emitted varyings
  122293. */
  122294. temps: string[];
  122295. /**
  122296. * Gets the list of emitted varyings
  122297. */
  122298. varyings: string[];
  122299. /**
  122300. * Gets the varying declaration string
  122301. */
  122302. varyingDeclaration: string;
  122303. /**
  122304. * Input blocks
  122305. */
  122306. inputBlocks: InputBlock[];
  122307. /**
  122308. * Input blocks
  122309. */
  122310. textureBlocks: (ReflectionTextureBlock | TextureBlock)[];
  122311. /**
  122312. * Bindable blocks (Blocks that need to set data to the effect)
  122313. */
  122314. bindableBlocks: NodeMaterialBlock[];
  122315. /**
  122316. * List of blocks that can provide a compilation fallback
  122317. */
  122318. blocksWithFallbacks: NodeMaterialBlock[];
  122319. /**
  122320. * List of blocks that can provide a define update
  122321. */
  122322. blocksWithDefines: NodeMaterialBlock[];
  122323. /**
  122324. * List of blocks that can provide a repeatable content
  122325. */
  122326. repeatableContentBlocks: NodeMaterialBlock[];
  122327. /**
  122328. * List of blocks that can provide a dynamic list of uniforms
  122329. */
  122330. dynamicUniformBlocks: NodeMaterialBlock[];
  122331. /**
  122332. * List of blocks that can block the isReady function for the material
  122333. */
  122334. blockingBlocks: NodeMaterialBlock[];
  122335. /**
  122336. * Gets the list of animated inputs
  122337. */
  122338. animatedInputs: InputBlock[];
  122339. /**
  122340. * Build Id used to avoid multiple recompilations
  122341. */
  122342. buildId: number;
  122343. /** List of emitted variables */
  122344. variableNames: {
  122345. [key: string]: number;
  122346. };
  122347. /** List of emitted defines */
  122348. defineNames: {
  122349. [key: string]: number;
  122350. };
  122351. /** Should emit comments? */
  122352. emitComments: boolean;
  122353. /** Emit build activity */
  122354. verbose: boolean;
  122355. /** Gets or sets the hosting scene */
  122356. scene: Scene;
  122357. /**
  122358. * Gets the compilation hints emitted at compilation time
  122359. */
  122360. hints: {
  122361. needWorldViewMatrix: boolean;
  122362. needWorldViewProjectionMatrix: boolean;
  122363. needAlphaBlending: boolean;
  122364. needAlphaTesting: boolean;
  122365. };
  122366. /**
  122367. * List of compilation checks
  122368. */
  122369. checks: {
  122370. emitVertex: boolean;
  122371. emitFragment: boolean;
  122372. notConnectedNonOptionalInputs: NodeMaterialConnectionPoint[];
  122373. };
  122374. /** Creates a new shared data */
  122375. constructor();
  122376. /**
  122377. * Emits console errors and exceptions if there is a failing check
  122378. */
  122379. emitErrors(): void;
  122380. }
  122381. }
  122382. declare module BABYLON {
  122383. /**
  122384. * Class used to store node based material build state
  122385. */
  122386. export class NodeMaterialBuildState {
  122387. /** Gets or sets a boolean indicating if the current state can emit uniform buffers */
  122388. supportUniformBuffers: boolean;
  122389. /**
  122390. * Gets the list of emitted attributes
  122391. */
  122392. attributes: string[];
  122393. /**
  122394. * Gets the list of emitted uniforms
  122395. */
  122396. uniforms: string[];
  122397. /**
  122398. * Gets the list of emitted constants
  122399. */
  122400. constants: string[];
  122401. /**
  122402. * Gets the list of emitted samplers
  122403. */
  122404. samplers: string[];
  122405. /**
  122406. * Gets the list of emitted functions
  122407. */
  122408. functions: {
  122409. [key: string]: string;
  122410. };
  122411. /**
  122412. * Gets the list of emitted extensions
  122413. */
  122414. extensions: {
  122415. [key: string]: string;
  122416. };
  122417. /**
  122418. * Gets the target of the compilation state
  122419. */
  122420. target: NodeMaterialBlockTargets;
  122421. /**
  122422. * Gets the list of emitted counters
  122423. */
  122424. counters: {
  122425. [key: string]: number;
  122426. };
  122427. /**
  122428. * Shared data between multiple NodeMaterialBuildState instances
  122429. */
  122430. sharedData: NodeMaterialBuildStateSharedData;
  122431. /** @hidden */
  122432. _vertexState: NodeMaterialBuildState;
  122433. /** @hidden */
  122434. _attributeDeclaration: string;
  122435. /** @hidden */
  122436. _uniformDeclaration: string;
  122437. /** @hidden */
  122438. _constantDeclaration: string;
  122439. /** @hidden */
  122440. _samplerDeclaration: string;
  122441. /** @hidden */
  122442. _varyingTransfer: string;
  122443. private _repeatableContentAnchorIndex;
  122444. /** @hidden */
  122445. _builtCompilationString: string;
  122446. /**
  122447. * Gets the emitted compilation strings
  122448. */
  122449. compilationString: string;
  122450. /**
  122451. * Finalize the compilation strings
  122452. * @param state defines the current compilation state
  122453. */
  122454. finalize(state: NodeMaterialBuildState): void;
  122455. /** @hidden */
  122456. readonly _repeatableContentAnchor: string;
  122457. /** @hidden */
  122458. _getFreeVariableName(prefix: string): string;
  122459. /** @hidden */
  122460. _getFreeDefineName(prefix: string): string;
  122461. /** @hidden */
  122462. _excludeVariableName(name: string): void;
  122463. /** @hidden */
  122464. _emit2DSampler(name: string): void;
  122465. /** @hidden */
  122466. _getGLType(type: NodeMaterialBlockConnectionPointTypes): string;
  122467. /** @hidden */
  122468. _emitExtension(name: string, extension: string): void;
  122469. /** @hidden */
  122470. _emitFunction(name: string, code: string, comments: string): void;
  122471. /** @hidden */
  122472. _emitCodeFromInclude(includeName: string, comments: string, options?: {
  122473. replaceStrings?: {
  122474. search: RegExp;
  122475. replace: string;
  122476. }[];
  122477. repeatKey?: string;
  122478. }): string;
  122479. /** @hidden */
  122480. _emitFunctionFromInclude(includeName: string, comments: string, options?: {
  122481. repeatKey?: string;
  122482. removeAttributes?: boolean;
  122483. removeUniforms?: boolean;
  122484. removeVaryings?: boolean;
  122485. removeIfDef?: boolean;
  122486. replaceStrings?: {
  122487. search: RegExp;
  122488. replace: string;
  122489. }[];
  122490. }, storeKey?: string): void;
  122491. /** @hidden */
  122492. _registerTempVariable(name: string): boolean;
  122493. /** @hidden */
  122494. _emitVaryingFromString(name: string, type: string, define?: string, notDefine?: boolean): boolean;
  122495. /** @hidden */
  122496. _emitUniformFromString(name: string, type: string, define?: string, notDefine?: boolean): void;
  122497. /** @hidden */
  122498. _emitFloat(value: number): string;
  122499. }
  122500. }
  122501. declare module BABYLON {
  122502. /**
  122503. * Defines a block that can be used inside a node based material
  122504. */
  122505. export class NodeMaterialBlock {
  122506. private _buildId;
  122507. private _buildTarget;
  122508. private _target;
  122509. private _isFinalMerger;
  122510. private _isInput;
  122511. protected _isUnique: boolean;
  122512. /** @hidden */
  122513. _codeVariableName: string;
  122514. /** @hidden */
  122515. _inputs: NodeMaterialConnectionPoint[];
  122516. /** @hidden */
  122517. _outputs: NodeMaterialConnectionPoint[];
  122518. /** @hidden */
  122519. _preparationId: number;
  122520. /**
  122521. * Gets or sets the name of the block
  122522. */
  122523. name: string;
  122524. /**
  122525. * Gets or sets the unique id of the node
  122526. */
  122527. uniqueId: number;
  122528. /**
  122529. * Gets a boolean indicating that this block can only be used once per NodeMaterial
  122530. */
  122531. readonly isUnique: boolean;
  122532. /**
  122533. * Gets a boolean indicating that this block is an end block (e.g. it is generating a system value)
  122534. */
  122535. readonly isFinalMerger: boolean;
  122536. /**
  122537. * Gets a boolean indicating that this block is an input (e.g. it sends data to the shader)
  122538. */
  122539. readonly isInput: boolean;
  122540. /**
  122541. * Gets or sets the build Id
  122542. */
  122543. buildId: number;
  122544. /**
  122545. * Gets or sets the target of the block
  122546. */
  122547. target: NodeMaterialBlockTargets;
  122548. /**
  122549. * Gets the list of input points
  122550. */
  122551. readonly inputs: NodeMaterialConnectionPoint[];
  122552. /** Gets the list of output points */
  122553. readonly outputs: NodeMaterialConnectionPoint[];
  122554. /**
  122555. * Find an input by its name
  122556. * @param name defines the name of the input to look for
  122557. * @returns the input or null if not found
  122558. */
  122559. getInputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  122560. /**
  122561. * Find an output by its name
  122562. * @param name defines the name of the outputto look for
  122563. * @returns the output or null if not found
  122564. */
  122565. getOutputByName(name: string): Nullable<NodeMaterialConnectionPoint>;
  122566. /**
  122567. * Creates a new NodeMaterialBlock
  122568. * @param name defines the block name
  122569. * @param target defines the target of that block (Vertex by default)
  122570. * @param isFinalMerger defines a boolean indicating that this block is an end block (e.g. it is generating a system value). Default is false
  122571. * @param isInput defines a boolean indicating that this block is an input (e.g. it sends data to the shader). Default is false
  122572. */
  122573. constructor(name: string, target?: NodeMaterialBlockTargets, isFinalMerger?: boolean, isInput?: boolean);
  122574. /**
  122575. * Initialize the block and prepare the context for build
  122576. * @param state defines the state that will be used for the build
  122577. */
  122578. initialize(state: NodeMaterialBuildState): void;
  122579. /**
  122580. * Bind data to effect. Will only be called for blocks with isBindable === true
  122581. * @param effect defines the effect to bind data to
  122582. * @param nodeMaterial defines the hosting NodeMaterial
  122583. * @param mesh defines the mesh that will be rendered
  122584. */
  122585. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  122586. protected _declareOutput(output: NodeMaterialConnectionPoint, state: NodeMaterialBuildState): string;
  122587. protected _writeVariable(currentPoint: NodeMaterialConnectionPoint): string;
  122588. protected _writeFloat(value: number): string;
  122589. /**
  122590. * Gets the current class name e.g. "NodeMaterialBlock"
  122591. * @returns the class name
  122592. */
  122593. getClassName(): string;
  122594. /**
  122595. * Register a new input. Must be called inside a block constructor
  122596. * @param name defines the connection point name
  122597. * @param type defines the connection point type
  122598. * @param isOptional defines a boolean indicating that this input can be omitted
  122599. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  122600. * @returns the current block
  122601. */
  122602. registerInput(name: string, type: NodeMaterialBlockConnectionPointTypes, isOptional?: boolean, target?: NodeMaterialBlockTargets): this;
  122603. /**
  122604. * Register a new output. Must be called inside a block constructor
  122605. * @param name defines the connection point name
  122606. * @param type defines the connection point type
  122607. * @param target defines the target to use to limit the connection point (will be VertexAndFragment by default)
  122608. * @returns the current block
  122609. */
  122610. registerOutput(name: string, type: NodeMaterialBlockConnectionPointTypes, target?: NodeMaterialBlockTargets): this;
  122611. /**
  122612. * Will return the first available input e.g. the first one which is not an uniform or an attribute
  122613. * @param forOutput defines an optional connection point to check compatibility with
  122614. * @returns the first available input or null
  122615. */
  122616. getFirstAvailableInput(forOutput?: Nullable<NodeMaterialConnectionPoint>): Nullable<NodeMaterialConnectionPoint>;
  122617. /**
  122618. * Will return the first available output e.g. the first one which is not yet connected and not a varying
  122619. * @param forBlock defines an optional block to check compatibility with
  122620. * @returns the first available input or null
  122621. */
  122622. getFirstAvailableOutput(forBlock?: Nullable<NodeMaterialBlock>): Nullable<NodeMaterialConnectionPoint>;
  122623. /**
  122624. * Gets the sibling of the given output
  122625. * @param current defines the current output
  122626. * @returns the next output in the list or null
  122627. */
  122628. getSiblingOutput(current: NodeMaterialConnectionPoint): Nullable<NodeMaterialConnectionPoint>;
  122629. /**
  122630. * Connect current block with another block
  122631. * @param other defines the block to connect with
  122632. * @param options define the various options to help pick the right connections
  122633. * @returns the current block
  122634. */
  122635. connectTo(other: NodeMaterialBlock, options?: {
  122636. input?: string;
  122637. output?: string;
  122638. outputSwizzle?: string;
  122639. }): this | undefined;
  122640. protected _buildBlock(state: NodeMaterialBuildState): void;
  122641. /**
  122642. * Add uniforms, samplers and uniform buffers at compilation time
  122643. * @param state defines the state to update
  122644. * @param nodeMaterial defines the node material requesting the update
  122645. * @param defines defines the material defines to update
  122646. * @param uniformBuffers defines the list of uniform buffer names
  122647. */
  122648. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  122649. /**
  122650. * Add potential fallbacks if shader compilation fails
  122651. * @param mesh defines the mesh to be rendered
  122652. * @param fallbacks defines the current prioritized list of fallbacks
  122653. */
  122654. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  122655. /**
  122656. * Initialize defines for shader compilation
  122657. * @param mesh defines the mesh to be rendered
  122658. * @param nodeMaterial defines the node material requesting the update
  122659. * @param defines defines the material defines to update
  122660. * @param useInstances specifies that instances should be used
  122661. */
  122662. initializeDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  122663. /**
  122664. * Update defines for shader compilation
  122665. * @param mesh defines the mesh to be rendered
  122666. * @param nodeMaterial defines the node material requesting the update
  122667. * @param defines defines the material defines to update
  122668. * @param useInstances specifies that instances should be used
  122669. */
  122670. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  122671. /**
  122672. * Lets the block try to connect some inputs automatically
  122673. * @param material defines the hosting NodeMaterial
  122674. */
  122675. autoConfigure(material: NodeMaterial): void;
  122676. /**
  122677. * Function called when a block is declared as repeatable content generator
  122678. * @param vertexShaderState defines the current compilation state for the vertex shader
  122679. * @param fragmentShaderState defines the current compilation state for the fragment shader
  122680. * @param mesh defines the mesh to be rendered
  122681. * @param defines defines the material defines to update
  122682. */
  122683. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  122684. /**
  122685. * Checks if the block is ready
  122686. * @param mesh defines the mesh to be rendered
  122687. * @param nodeMaterial defines the node material requesting the update
  122688. * @param defines defines the material defines to update
  122689. * @param useInstances specifies that instances should be used
  122690. * @returns true if the block is ready
  122691. */
  122692. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): boolean;
  122693. protected _linkConnectionTypes(inputIndex0: number, inputIndex1: number): void;
  122694. private _processBuild;
  122695. /**
  122696. * Compile the current node and generate the shader code
  122697. * @param state defines the current compilation state (uniforms, samplers, current string)
  122698. * @param activeBlocks defines the list of active blocks (i.e. blocks to compile)
  122699. * @returns true if already built
  122700. */
  122701. build(state: NodeMaterialBuildState, activeBlocks: NodeMaterialBlock[]): boolean;
  122702. protected _inputRename(name: string): string;
  122703. protected _outputRename(name: string): string;
  122704. protected _dumpPropertiesCode(): string;
  122705. /** @hidden */
  122706. _dumpCode(uniqueNames: string[], alreadyDumped: NodeMaterialBlock[]): string;
  122707. /** @hidden */
  122708. _dumpCodeForOutputConnections(alreadyDumped: NodeMaterialBlock[]): string;
  122709. /**
  122710. * Clone the current block to a new identical block
  122711. * @param scene defines the hosting scene
  122712. * @param rootUrl defines the root URL to use to load textures and relative dependencies
  122713. * @returns a copy of the current block
  122714. */
  122715. clone(scene: Scene, rootUrl?: string): Nullable<NodeMaterialBlock>;
  122716. /**
  122717. * Serializes this block in a JSON representation
  122718. * @returns the serialized block object
  122719. */
  122720. serialize(): any;
  122721. /** @hidden */
  122722. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  122723. /**
  122724. * Release resources
  122725. */
  122726. dispose(): void;
  122727. }
  122728. }
  122729. declare module BABYLON {
  122730. /**
  122731. * Enum defining the type of animations supported by InputBlock
  122732. */
  122733. export enum AnimatedInputBlockTypes {
  122734. /** No animation */
  122735. None = 0,
  122736. /** Time based animation. Will only work for floats */
  122737. Time = 1
  122738. }
  122739. }
  122740. declare module BABYLON {
  122741. /**
  122742. * Block used to expose an input value
  122743. */
  122744. export class InputBlock extends NodeMaterialBlock {
  122745. private _mode;
  122746. private _associatedVariableName;
  122747. private _storedValue;
  122748. private _valueCallback;
  122749. private _type;
  122750. private _animationType;
  122751. /** Gets or set a value used to limit the range of float values */
  122752. min: number;
  122753. /** Gets or set a value used to limit the range of float values */
  122754. max: number;
  122755. /** Gets or sets a value used by the Node Material editor to determine how to configure the current value if it is a matrix */
  122756. matrixMode: number;
  122757. /** @hidden */
  122758. _systemValue: Nullable<NodeMaterialSystemValues>;
  122759. /** Gets or sets a boolean indicating that this input can be edited in the Inspector (false by default) */
  122760. visibleInInspector: boolean;
  122761. /** Gets or sets a boolean indicating that the value of this input will not change after a build */
  122762. isConstant: boolean;
  122763. /**
  122764. * Gets or sets the connection point type (default is float)
  122765. */
  122766. readonly type: NodeMaterialBlockConnectionPointTypes;
  122767. /**
  122768. * Creates a new InputBlock
  122769. * @param name defines the block name
  122770. * @param target defines the target of that block (Vertex by default)
  122771. * @param type defines the type of the input (can be set to NodeMaterialBlockConnectionPointTypes.AutoDetect)
  122772. */
  122773. constructor(name: string, target?: NodeMaterialBlockTargets, type?: NodeMaterialBlockConnectionPointTypes);
  122774. /**
  122775. * Gets the output component
  122776. */
  122777. readonly output: NodeMaterialConnectionPoint;
  122778. /**
  122779. * Set the source of this connection point to a vertex attribute
  122780. * @param attributeName defines the attribute name (position, uv, normal, etc...). If not specified it will take the connection point name
  122781. * @returns the current connection point
  122782. */
  122783. setAsAttribute(attributeName?: string): InputBlock;
  122784. /**
  122785. * Set the source of this connection point to a system value
  122786. * @param value define the system value to use (world, view, etc...) or null to switch to manual value
  122787. * @returns the current connection point
  122788. */
  122789. setAsSystemValue(value: Nullable<NodeMaterialSystemValues>): InputBlock;
  122790. /**
  122791. * Gets or sets the value of that point.
  122792. * Please note that this value will be ignored if valueCallback is defined
  122793. */
  122794. value: any;
  122795. /**
  122796. * Gets or sets a callback used to get the value of that point.
  122797. * Please note that setting this value will force the connection point to ignore the value property
  122798. */
  122799. valueCallback: () => any;
  122800. /**
  122801. * Gets or sets the associated variable name in the shader
  122802. */
  122803. associatedVariableName: string;
  122804. /** Gets or sets the type of animation applied to the input */
  122805. animationType: AnimatedInputBlockTypes;
  122806. /**
  122807. * Gets a boolean indicating that this connection point not defined yet
  122808. */
  122809. readonly isUndefined: boolean;
  122810. /**
  122811. * Gets or sets a boolean indicating that this connection point is coming from an uniform.
  122812. * In this case the connection point name must be the name of the uniform to use.
  122813. * Can only be set on inputs
  122814. */
  122815. isUniform: boolean;
  122816. /**
  122817. * Gets or sets a boolean indicating that this connection point is coming from an attribute.
  122818. * In this case the connection point name must be the name of the attribute to use
  122819. * Can only be set on inputs
  122820. */
  122821. isAttribute: boolean;
  122822. /**
  122823. * Gets or sets a boolean indicating that this connection point is generating a varying variable.
  122824. * Can only be set on exit points
  122825. */
  122826. isVarying: boolean;
  122827. /**
  122828. * Gets a boolean indicating that the current connection point is a system value
  122829. */
  122830. readonly isSystemValue: boolean;
  122831. /**
  122832. * Gets or sets the current well known value or null if not defined as a system value
  122833. */
  122834. systemValue: Nullable<NodeMaterialSystemValues>;
  122835. /**
  122836. * Gets the current class name
  122837. * @returns the class name
  122838. */
  122839. getClassName(): string;
  122840. /**
  122841. * Animate the input if animationType !== None
  122842. * @param scene defines the rendering scene
  122843. */
  122844. animate(scene: Scene): void;
  122845. private _emitDefine;
  122846. initialize(state: NodeMaterialBuildState): void;
  122847. /**
  122848. * Set the input block to its default value (based on its type)
  122849. */
  122850. setDefaultValue(): void;
  122851. private _emitConstant;
  122852. private _emit;
  122853. /** @hidden */
  122854. _transmitWorld(effect: Effect, world: Matrix, worldView: Matrix, worldViewProjection: Matrix): void;
  122855. /** @hidden */
  122856. _transmit(effect: Effect, scene: Scene): void;
  122857. protected _buildBlock(state: NodeMaterialBuildState): void;
  122858. protected _dumpPropertiesCode(): string;
  122859. serialize(): any;
  122860. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  122861. }
  122862. }
  122863. declare module BABYLON {
  122864. /**
  122865. * Enum used to define the compatibility state between two connection points
  122866. */
  122867. export enum NodeMaterialConnectionPointCompatibilityStates {
  122868. /** Points are compatibles */
  122869. Compatible = 0,
  122870. /** Points are incompatible because of their types */
  122871. TypeIncompatible = 1,
  122872. /** Points are incompatible because of their targets (vertex vs fragment) */
  122873. TargetIncompatible = 2
  122874. }
  122875. /**
  122876. * Defines a connection point for a block
  122877. */
  122878. export class NodeMaterialConnectionPoint {
  122879. /** @hidden */
  122880. _ownerBlock: NodeMaterialBlock;
  122881. /** @hidden */
  122882. _connectedPoint: Nullable<NodeMaterialConnectionPoint>;
  122883. private _endpoints;
  122884. private _associatedVariableName;
  122885. /** @hidden */
  122886. _typeConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  122887. /** @hidden */
  122888. _linkedConnectionSource: Nullable<NodeMaterialConnectionPoint>;
  122889. private _type;
  122890. /** @hidden */
  122891. _enforceAssociatedVariableName: boolean;
  122892. /**
  122893. * Gets or sets the additional types supported by this connection point
  122894. */
  122895. acceptedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  122896. /**
  122897. * Gets or sets the additional types excluded by this connection point
  122898. */
  122899. excludedConnectionPointTypes: NodeMaterialBlockConnectionPointTypes[];
  122900. /**
  122901. * Observable triggered when this point is connected
  122902. */
  122903. onConnectionObservable: Observable<NodeMaterialConnectionPoint>;
  122904. /**
  122905. * Gets or sets the associated variable name in the shader
  122906. */
  122907. associatedVariableName: string;
  122908. /**
  122909. * Gets or sets the connection point type (default is float)
  122910. */
  122911. type: NodeMaterialBlockConnectionPointTypes;
  122912. /**
  122913. * Gets or sets the connection point name
  122914. */
  122915. name: string;
  122916. /**
  122917. * Gets or sets a boolean indicating that this connection point can be omitted
  122918. */
  122919. isOptional: boolean;
  122920. /**
  122921. * Gets or sets a string indicating that this uniform must be defined under a #ifdef
  122922. */
  122923. define: string;
  122924. /** @hidden */
  122925. _prioritizeVertex: boolean;
  122926. private _target;
  122927. /** Gets or sets the target of that connection point */
  122928. target: NodeMaterialBlockTargets;
  122929. /**
  122930. * Gets a boolean indicating that the current point is connected
  122931. */
  122932. readonly isConnected: boolean;
  122933. /**
  122934. * Gets a boolean indicating that the current point is connected to an input block
  122935. */
  122936. readonly isConnectedToInputBlock: boolean;
  122937. /**
  122938. * Gets a the connected input block (if any)
  122939. */
  122940. readonly connectInputBlock: Nullable<InputBlock>;
  122941. /** Get the other side of the connection (if any) */
  122942. readonly connectedPoint: Nullable<NodeMaterialConnectionPoint>;
  122943. /** Get the block that owns this connection point */
  122944. readonly ownerBlock: NodeMaterialBlock;
  122945. /** Get the block connected on the other side of this connection (if any) */
  122946. readonly sourceBlock: Nullable<NodeMaterialBlock>;
  122947. /** Get the block connected on the endpoints of this connection (if any) */
  122948. readonly connectedBlocks: Array<NodeMaterialBlock>;
  122949. /** Gets the list of connected endpoints */
  122950. readonly endpoints: NodeMaterialConnectionPoint[];
  122951. /** Gets a boolean indicating if that output point is connected to at least one input */
  122952. readonly hasEndpoints: boolean;
  122953. /** Gets a boolean indicating that this connection will be used in the vertex shader */
  122954. readonly isConnectedInVertexShader: boolean;
  122955. /** Gets a boolean indicating that this connection will be used in the fragment shader */
  122956. readonly isConnectedInFragmentShader: boolean;
  122957. /**
  122958. * Creates a new connection point
  122959. * @param name defines the connection point name
  122960. * @param ownerBlock defines the block hosting this connection point
  122961. */
  122962. constructor(name: string, ownerBlock: NodeMaterialBlock);
  122963. /**
  122964. * Gets the current class name e.g. "NodeMaterialConnectionPoint"
  122965. * @returns the class name
  122966. */
  122967. getClassName(): string;
  122968. /**
  122969. * Gets a boolean indicating if the current point can be connected to another point
  122970. * @param connectionPoint defines the other connection point
  122971. * @returns a boolean
  122972. */
  122973. canConnectTo(connectionPoint: NodeMaterialConnectionPoint): boolean;
  122974. /**
  122975. * Gets a number indicating if the current point can be connected to another point
  122976. * @param connectionPoint defines the other connection point
  122977. * @returns a number defining the compatibility state
  122978. */
  122979. checkCompatibilityState(connectionPoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPointCompatibilityStates;
  122980. /**
  122981. * Connect this point to another connection point
  122982. * @param connectionPoint defines the other connection point
  122983. * @param ignoreConstraints defines if the system will ignore connection type constraints (default is false)
  122984. * @returns the current connection point
  122985. */
  122986. connectTo(connectionPoint: NodeMaterialConnectionPoint, ignoreConstraints?: boolean): NodeMaterialConnectionPoint;
  122987. /**
  122988. * Disconnect this point from one of his endpoint
  122989. * @param endpoint defines the other connection point
  122990. * @returns the current connection point
  122991. */
  122992. disconnectFrom(endpoint: NodeMaterialConnectionPoint): NodeMaterialConnectionPoint;
  122993. /**
  122994. * Serializes this point in a JSON representation
  122995. * @returns the serialized point object
  122996. */
  122997. serialize(): any;
  122998. /**
  122999. * Release resources
  123000. */
  123001. dispose(): void;
  123002. }
  123003. }
  123004. declare module BABYLON {
  123005. /**
  123006. * Block used to add support for vertex skinning (bones)
  123007. */
  123008. export class BonesBlock extends NodeMaterialBlock {
  123009. /**
  123010. * Creates a new BonesBlock
  123011. * @param name defines the block name
  123012. */
  123013. constructor(name: string);
  123014. /**
  123015. * Initialize the block and prepare the context for build
  123016. * @param state defines the state that will be used for the build
  123017. */
  123018. initialize(state: NodeMaterialBuildState): void;
  123019. /**
  123020. * Gets the current class name
  123021. * @returns the class name
  123022. */
  123023. getClassName(): string;
  123024. /**
  123025. * Gets the matrix indices input component
  123026. */
  123027. readonly matricesIndices: NodeMaterialConnectionPoint;
  123028. /**
  123029. * Gets the matrix weights input component
  123030. */
  123031. readonly matricesWeights: NodeMaterialConnectionPoint;
  123032. /**
  123033. * Gets the extra matrix indices input component
  123034. */
  123035. readonly matricesIndicesExtra: NodeMaterialConnectionPoint;
  123036. /**
  123037. * Gets the extra matrix weights input component
  123038. */
  123039. readonly matricesWeightsExtra: NodeMaterialConnectionPoint;
  123040. /**
  123041. * Gets the world input component
  123042. */
  123043. readonly world: NodeMaterialConnectionPoint;
  123044. /**
  123045. * Gets the output component
  123046. */
  123047. readonly output: NodeMaterialConnectionPoint;
  123048. autoConfigure(material: NodeMaterial): void;
  123049. provideFallbacks(mesh: AbstractMesh, fallbacks: EffectFallbacks): void;
  123050. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  123051. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  123052. protected _buildBlock(state: NodeMaterialBuildState): this;
  123053. }
  123054. }
  123055. declare module BABYLON {
  123056. /**
  123057. * Block used to add support for instances
  123058. * @see https://doc.babylonjs.com/how_to/how_to_use_instances
  123059. */
  123060. export class InstancesBlock extends NodeMaterialBlock {
  123061. /**
  123062. * Creates a new InstancesBlock
  123063. * @param name defines the block name
  123064. */
  123065. constructor(name: string);
  123066. /**
  123067. * Gets the current class name
  123068. * @returns the class name
  123069. */
  123070. getClassName(): string;
  123071. /**
  123072. * Gets the first world row input component
  123073. */
  123074. readonly world0: NodeMaterialConnectionPoint;
  123075. /**
  123076. * Gets the second world row input component
  123077. */
  123078. readonly world1: NodeMaterialConnectionPoint;
  123079. /**
  123080. * Gets the third world row input component
  123081. */
  123082. readonly world2: NodeMaterialConnectionPoint;
  123083. /**
  123084. * Gets the forth world row input component
  123085. */
  123086. readonly world3: NodeMaterialConnectionPoint;
  123087. /**
  123088. * Gets the world input component
  123089. */
  123090. readonly world: NodeMaterialConnectionPoint;
  123091. /**
  123092. * Gets the output component
  123093. */
  123094. readonly output: NodeMaterialConnectionPoint;
  123095. autoConfigure(material: NodeMaterial): void;
  123096. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, useInstances?: boolean): void;
  123097. protected _buildBlock(state: NodeMaterialBuildState): this;
  123098. }
  123099. }
  123100. declare module BABYLON {
  123101. /**
  123102. * Block used to add morph targets support to vertex shader
  123103. */
  123104. export class MorphTargetsBlock extends NodeMaterialBlock {
  123105. private _repeatableContentAnchor;
  123106. private _repeatebleContentGenerated;
  123107. /**
  123108. * Create a new MorphTargetsBlock
  123109. * @param name defines the block name
  123110. */
  123111. constructor(name: string);
  123112. /**
  123113. * Gets the current class name
  123114. * @returns the class name
  123115. */
  123116. getClassName(): string;
  123117. /**
  123118. * Gets the position input component
  123119. */
  123120. readonly position: NodeMaterialConnectionPoint;
  123121. /**
  123122. * Gets the normal input component
  123123. */
  123124. readonly normal: NodeMaterialConnectionPoint;
  123125. /**
  123126. * Gets the tangent input component
  123127. */
  123128. readonly tangent: NodeMaterialConnectionPoint;
  123129. /**
  123130. * Gets the tangent input component
  123131. */
  123132. readonly uv: NodeMaterialConnectionPoint;
  123133. /**
  123134. * Gets the position output component
  123135. */
  123136. readonly positionOutput: NodeMaterialConnectionPoint;
  123137. /**
  123138. * Gets the normal output component
  123139. */
  123140. readonly normalOutput: NodeMaterialConnectionPoint;
  123141. /**
  123142. * Gets the tangent output component
  123143. */
  123144. readonly tangentOutput: NodeMaterialConnectionPoint;
  123145. /**
  123146. * Gets the tangent output component
  123147. */
  123148. readonly uvOutput: NodeMaterialConnectionPoint;
  123149. initialize(state: NodeMaterialBuildState): void;
  123150. autoConfigure(material: NodeMaterial): void;
  123151. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  123152. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  123153. replaceRepeatableContent(vertexShaderState: NodeMaterialBuildState, fragmentShaderState: NodeMaterialBuildState, mesh: AbstractMesh, defines: NodeMaterialDefines): void;
  123154. protected _buildBlock(state: NodeMaterialBuildState): this;
  123155. }
  123156. }
  123157. declare module BABYLON {
  123158. /**
  123159. * Block used to get data information from a light
  123160. */
  123161. export class LightInformationBlock extends NodeMaterialBlock {
  123162. private _lightDataUniformName;
  123163. private _lightColorUniformName;
  123164. private _lightTypeDefineName;
  123165. /**
  123166. * Gets or sets the light associated with this block
  123167. */
  123168. light: Nullable<Light>;
  123169. /**
  123170. * Creates a new LightInformationBlock
  123171. * @param name defines the block name
  123172. */
  123173. constructor(name: string);
  123174. /**
  123175. * Gets the current class name
  123176. * @returns the class name
  123177. */
  123178. getClassName(): string;
  123179. /**
  123180. * Gets the world position input component
  123181. */
  123182. readonly worldPosition: NodeMaterialConnectionPoint;
  123183. /**
  123184. * Gets the direction output component
  123185. */
  123186. readonly direction: NodeMaterialConnectionPoint;
  123187. /**
  123188. * Gets the direction output component
  123189. */
  123190. readonly color: NodeMaterialConnectionPoint;
  123191. /**
  123192. * Gets the direction output component
  123193. */
  123194. readonly intensity: NodeMaterialConnectionPoint;
  123195. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  123196. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  123197. protected _buildBlock(state: NodeMaterialBuildState): this;
  123198. serialize(): any;
  123199. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  123200. }
  123201. }
  123202. declare module BABYLON {
  123203. /**
  123204. * Block used to add image processing support to fragment shader
  123205. */
  123206. export class ImageProcessingBlock extends NodeMaterialBlock {
  123207. /**
  123208. * Create a new ImageProcessingBlock
  123209. * @param name defines the block name
  123210. */
  123211. constructor(name: string);
  123212. /**
  123213. * Gets the current class name
  123214. * @returns the class name
  123215. */
  123216. getClassName(): string;
  123217. /**
  123218. * Gets the color input component
  123219. */
  123220. readonly color: NodeMaterialConnectionPoint;
  123221. /**
  123222. * Gets the output component
  123223. */
  123224. readonly output: NodeMaterialConnectionPoint;
  123225. /**
  123226. * Initialize the block and prepare the context for build
  123227. * @param state defines the state that will be used for the build
  123228. */
  123229. initialize(state: NodeMaterialBuildState): void;
  123230. isReady(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): boolean;
  123231. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  123232. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  123233. protected _buildBlock(state: NodeMaterialBuildState): this;
  123234. }
  123235. }
  123236. declare module BABYLON {
  123237. /**
  123238. * Block used to pertub normals based on a normal map
  123239. */
  123240. export class PerturbNormalBlock extends NodeMaterialBlock {
  123241. private _tangentSpaceParameterName;
  123242. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  123243. invertX: boolean;
  123244. /** Gets or sets a boolean indicating that normal should be inverted on Y axis */
  123245. invertY: boolean;
  123246. /**
  123247. * Create a new PerturbNormalBlock
  123248. * @param name defines the block name
  123249. */
  123250. constructor(name: string);
  123251. /**
  123252. * Gets the current class name
  123253. * @returns the class name
  123254. */
  123255. getClassName(): string;
  123256. /**
  123257. * Gets the world position input component
  123258. */
  123259. readonly worldPosition: NodeMaterialConnectionPoint;
  123260. /**
  123261. * Gets the world normal input component
  123262. */
  123263. readonly worldNormal: NodeMaterialConnectionPoint;
  123264. /**
  123265. * Gets the uv input component
  123266. */
  123267. readonly uv: NodeMaterialConnectionPoint;
  123268. /**
  123269. * Gets the normal map color input component
  123270. */
  123271. readonly normalMapColor: NodeMaterialConnectionPoint;
  123272. /**
  123273. * Gets the strength input component
  123274. */
  123275. readonly strength: NodeMaterialConnectionPoint;
  123276. /**
  123277. * Gets the output component
  123278. */
  123279. readonly output: NodeMaterialConnectionPoint;
  123280. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  123281. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  123282. autoConfigure(material: NodeMaterial): void;
  123283. protected _buildBlock(state: NodeMaterialBuildState): this;
  123284. protected _dumpPropertiesCode(): string;
  123285. serialize(): any;
  123286. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  123287. }
  123288. }
  123289. declare module BABYLON {
  123290. /**
  123291. * Block used to discard a pixel if a value is smaller than a cutoff
  123292. */
  123293. export class DiscardBlock extends NodeMaterialBlock {
  123294. /**
  123295. * Create a new DiscardBlock
  123296. * @param name defines the block name
  123297. */
  123298. constructor(name: string);
  123299. /**
  123300. * Gets the current class name
  123301. * @returns the class name
  123302. */
  123303. getClassName(): string;
  123304. /**
  123305. * Gets the color input component
  123306. */
  123307. readonly value: NodeMaterialConnectionPoint;
  123308. /**
  123309. * Gets the cutoff input component
  123310. */
  123311. readonly cutoff: NodeMaterialConnectionPoint;
  123312. protected _buildBlock(state: NodeMaterialBuildState): this;
  123313. }
  123314. }
  123315. declare module BABYLON {
  123316. /**
  123317. * Block used to test if the fragment shader is front facing
  123318. */
  123319. export class FrontFacingBlock extends NodeMaterialBlock {
  123320. /**
  123321. * Creates a new FrontFacingBlock
  123322. * @param name defines the block name
  123323. */
  123324. constructor(name: string);
  123325. /**
  123326. * Gets the current class name
  123327. * @returns the class name
  123328. */
  123329. getClassName(): string;
  123330. /**
  123331. * Gets the output component
  123332. */
  123333. readonly output: NodeMaterialConnectionPoint;
  123334. protected _buildBlock(state: NodeMaterialBuildState): this;
  123335. }
  123336. }
  123337. declare module BABYLON {
  123338. /**
  123339. * Block used to add support for scene fog
  123340. */
  123341. export class FogBlock extends NodeMaterialBlock {
  123342. private _fogDistanceName;
  123343. private _fogParameters;
  123344. /**
  123345. * Create a new FogBlock
  123346. * @param name defines the block name
  123347. */
  123348. constructor(name: string);
  123349. /**
  123350. * Gets the current class name
  123351. * @returns the class name
  123352. */
  123353. getClassName(): string;
  123354. /**
  123355. * Gets the world position input component
  123356. */
  123357. readonly worldPosition: NodeMaterialConnectionPoint;
  123358. /**
  123359. * Gets the view input component
  123360. */
  123361. readonly view: NodeMaterialConnectionPoint;
  123362. /**
  123363. * Gets the color input component
  123364. */
  123365. readonly input: NodeMaterialConnectionPoint;
  123366. /**
  123367. * Gets the fog color input component
  123368. */
  123369. readonly fogColor: NodeMaterialConnectionPoint;
  123370. /**
  123371. * Gets the output component
  123372. */
  123373. readonly output: NodeMaterialConnectionPoint;
  123374. autoConfigure(material: NodeMaterial): void;
  123375. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  123376. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  123377. protected _buildBlock(state: NodeMaterialBuildState): this;
  123378. }
  123379. }
  123380. declare module BABYLON {
  123381. /**
  123382. * Block used to add light in the fragment shader
  123383. */
  123384. export class LightBlock extends NodeMaterialBlock {
  123385. private _lightId;
  123386. /**
  123387. * Gets or sets the light associated with this block
  123388. */
  123389. light: Nullable<Light>;
  123390. /**
  123391. * Create a new LightBlock
  123392. * @param name defines the block name
  123393. */
  123394. constructor(name: string);
  123395. /**
  123396. * Gets the current class name
  123397. * @returns the class name
  123398. */
  123399. getClassName(): string;
  123400. /**
  123401. * Gets the world position input component
  123402. */
  123403. readonly worldPosition: NodeMaterialConnectionPoint;
  123404. /**
  123405. * Gets the world normal input component
  123406. */
  123407. readonly worldNormal: NodeMaterialConnectionPoint;
  123408. /**
  123409. * Gets the camera (or eye) position component
  123410. */
  123411. readonly cameraPosition: NodeMaterialConnectionPoint;
  123412. /**
  123413. * Gets the glossiness component
  123414. */
  123415. readonly glossiness: NodeMaterialConnectionPoint;
  123416. /**
  123417. * Gets the glossinness power component
  123418. */
  123419. readonly glossPower: NodeMaterialConnectionPoint;
  123420. /**
  123421. * Gets the diffuse color component
  123422. */
  123423. readonly diffuseColor: NodeMaterialConnectionPoint;
  123424. /**
  123425. * Gets the specular color component
  123426. */
  123427. readonly specularColor: NodeMaterialConnectionPoint;
  123428. /**
  123429. * Gets the diffuse output component
  123430. */
  123431. readonly diffuseOutput: NodeMaterialConnectionPoint;
  123432. /**
  123433. * Gets the specular output component
  123434. */
  123435. readonly specularOutput: NodeMaterialConnectionPoint;
  123436. autoConfigure(material: NodeMaterial): void;
  123437. prepareDefines(mesh: AbstractMesh, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines): void;
  123438. updateUniformsAndSamples(state: NodeMaterialBuildState, nodeMaterial: NodeMaterial, defines: NodeMaterialDefines, uniformBuffers: string[]): void;
  123439. bind(effect: Effect, nodeMaterial: NodeMaterial, mesh?: Mesh): void;
  123440. private _injectVertexCode;
  123441. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  123442. serialize(): any;
  123443. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  123444. }
  123445. }
  123446. declare module BABYLON {
  123447. /**
  123448. * Block used to multiply 2 values
  123449. */
  123450. export class MultiplyBlock extends NodeMaterialBlock {
  123451. /**
  123452. * Creates a new MultiplyBlock
  123453. * @param name defines the block name
  123454. */
  123455. constructor(name: string);
  123456. /**
  123457. * Gets the current class name
  123458. * @returns the class name
  123459. */
  123460. getClassName(): string;
  123461. /**
  123462. * Gets the left operand input component
  123463. */
  123464. readonly left: NodeMaterialConnectionPoint;
  123465. /**
  123466. * Gets the right operand input component
  123467. */
  123468. readonly right: NodeMaterialConnectionPoint;
  123469. /**
  123470. * Gets the output component
  123471. */
  123472. readonly output: NodeMaterialConnectionPoint;
  123473. protected _buildBlock(state: NodeMaterialBuildState): this;
  123474. }
  123475. }
  123476. declare module BABYLON {
  123477. /**
  123478. * Block used to add 2 vectors
  123479. */
  123480. export class AddBlock extends NodeMaterialBlock {
  123481. /**
  123482. * Creates a new AddBlock
  123483. * @param name defines the block name
  123484. */
  123485. constructor(name: string);
  123486. /**
  123487. * Gets the current class name
  123488. * @returns the class name
  123489. */
  123490. getClassName(): string;
  123491. /**
  123492. * Gets the left operand input component
  123493. */
  123494. readonly left: NodeMaterialConnectionPoint;
  123495. /**
  123496. * Gets the right operand input component
  123497. */
  123498. readonly right: NodeMaterialConnectionPoint;
  123499. /**
  123500. * Gets the output component
  123501. */
  123502. readonly output: NodeMaterialConnectionPoint;
  123503. protected _buildBlock(state: NodeMaterialBuildState): this;
  123504. }
  123505. }
  123506. declare module BABYLON {
  123507. /**
  123508. * Block used to scale a vector by a float
  123509. */
  123510. export class ScaleBlock extends NodeMaterialBlock {
  123511. /**
  123512. * Creates a new ScaleBlock
  123513. * @param name defines the block name
  123514. */
  123515. constructor(name: string);
  123516. /**
  123517. * Gets the current class name
  123518. * @returns the class name
  123519. */
  123520. getClassName(): string;
  123521. /**
  123522. * Gets the input component
  123523. */
  123524. readonly input: NodeMaterialConnectionPoint;
  123525. /**
  123526. * Gets the factor input component
  123527. */
  123528. readonly factor: NodeMaterialConnectionPoint;
  123529. /**
  123530. * Gets the output component
  123531. */
  123532. readonly output: NodeMaterialConnectionPoint;
  123533. protected _buildBlock(state: NodeMaterialBuildState): this;
  123534. }
  123535. }
  123536. declare module BABYLON {
  123537. /**
  123538. * Block used to clamp a float
  123539. */
  123540. export class ClampBlock extends NodeMaterialBlock {
  123541. /** Gets or sets the minimum range */
  123542. minimum: number;
  123543. /** Gets or sets the maximum range */
  123544. maximum: number;
  123545. /**
  123546. * Creates a new ClampBlock
  123547. * @param name defines the block name
  123548. */
  123549. constructor(name: string);
  123550. /**
  123551. * Gets the current class name
  123552. * @returns the class name
  123553. */
  123554. getClassName(): string;
  123555. /**
  123556. * Gets the value input component
  123557. */
  123558. readonly value: NodeMaterialConnectionPoint;
  123559. /**
  123560. * Gets the output component
  123561. */
  123562. readonly output: NodeMaterialConnectionPoint;
  123563. protected _buildBlock(state: NodeMaterialBuildState): this;
  123564. protected _dumpPropertiesCode(): string;
  123565. serialize(): any;
  123566. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  123567. }
  123568. }
  123569. declare module BABYLON {
  123570. /**
  123571. * Block used to apply a cross product between 2 vectors
  123572. */
  123573. export class CrossBlock extends NodeMaterialBlock {
  123574. /**
  123575. * Creates a new CrossBlock
  123576. * @param name defines the block name
  123577. */
  123578. constructor(name: string);
  123579. /**
  123580. * Gets the current class name
  123581. * @returns the class name
  123582. */
  123583. getClassName(): string;
  123584. /**
  123585. * Gets the left operand input component
  123586. */
  123587. readonly left: NodeMaterialConnectionPoint;
  123588. /**
  123589. * Gets the right operand input component
  123590. */
  123591. readonly right: NodeMaterialConnectionPoint;
  123592. /**
  123593. * Gets the output component
  123594. */
  123595. readonly output: NodeMaterialConnectionPoint;
  123596. protected _buildBlock(state: NodeMaterialBuildState): this;
  123597. }
  123598. }
  123599. declare module BABYLON {
  123600. /**
  123601. * Block used to apply a dot product between 2 vectors
  123602. */
  123603. export class DotBlock extends NodeMaterialBlock {
  123604. /**
  123605. * Creates a new DotBlock
  123606. * @param name defines the block name
  123607. */
  123608. constructor(name: string);
  123609. /**
  123610. * Gets the current class name
  123611. * @returns the class name
  123612. */
  123613. getClassName(): string;
  123614. /**
  123615. * Gets the left operand input component
  123616. */
  123617. readonly left: NodeMaterialConnectionPoint;
  123618. /**
  123619. * Gets the right operand input component
  123620. */
  123621. readonly right: NodeMaterialConnectionPoint;
  123622. /**
  123623. * Gets the output component
  123624. */
  123625. readonly output: NodeMaterialConnectionPoint;
  123626. protected _buildBlock(state: NodeMaterialBuildState): this;
  123627. }
  123628. }
  123629. declare module BABYLON {
  123630. /**
  123631. * Block used to remap a float from a range to a new one
  123632. */
  123633. export class RemapBlock extends NodeMaterialBlock {
  123634. /**
  123635. * Gets or sets the source range
  123636. */
  123637. sourceRange: Vector2;
  123638. /**
  123639. * Gets or sets the target range
  123640. */
  123641. targetRange: Vector2;
  123642. /**
  123643. * Creates a new RemapBlock
  123644. * @param name defines the block name
  123645. */
  123646. constructor(name: string);
  123647. /**
  123648. * Gets the current class name
  123649. * @returns the class name
  123650. */
  123651. getClassName(): string;
  123652. /**
  123653. * Gets the input component
  123654. */
  123655. readonly input: NodeMaterialConnectionPoint;
  123656. /**
  123657. * Gets the source min input component
  123658. */
  123659. readonly sourceMin: NodeMaterialConnectionPoint;
  123660. /**
  123661. * Gets the source max input component
  123662. */
  123663. readonly sourceMax: NodeMaterialConnectionPoint;
  123664. /**
  123665. * Gets the target min input component
  123666. */
  123667. readonly targetMin: NodeMaterialConnectionPoint;
  123668. /**
  123669. * Gets the target max input component
  123670. */
  123671. readonly targetMax: NodeMaterialConnectionPoint;
  123672. /**
  123673. * Gets the output component
  123674. */
  123675. readonly output: NodeMaterialConnectionPoint;
  123676. protected _buildBlock(state: NodeMaterialBuildState): this;
  123677. protected _dumpPropertiesCode(): string;
  123678. serialize(): any;
  123679. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  123680. }
  123681. }
  123682. declare module BABYLON {
  123683. /**
  123684. * Block used to normalize a vector
  123685. */
  123686. export class NormalizeBlock extends NodeMaterialBlock {
  123687. /**
  123688. * Creates a new NormalizeBlock
  123689. * @param name defines the block name
  123690. */
  123691. constructor(name: string);
  123692. /**
  123693. * Gets the current class name
  123694. * @returns the class name
  123695. */
  123696. getClassName(): string;
  123697. /**
  123698. * Gets the input component
  123699. */
  123700. readonly input: NodeMaterialConnectionPoint;
  123701. /**
  123702. * Gets the output component
  123703. */
  123704. readonly output: NodeMaterialConnectionPoint;
  123705. protected _buildBlock(state: NodeMaterialBuildState): this;
  123706. }
  123707. }
  123708. declare module BABYLON {
  123709. /**
  123710. * Operations supported by the Trigonometry block
  123711. */
  123712. export enum TrigonometryBlockOperations {
  123713. /** Cos */
  123714. Cos = 0,
  123715. /** Sin */
  123716. Sin = 1,
  123717. /** Abs */
  123718. Abs = 2,
  123719. /** Exp */
  123720. Exp = 3,
  123721. /** Exp2 */
  123722. Exp2 = 4,
  123723. /** Round */
  123724. Round = 5,
  123725. /** Floor */
  123726. Floor = 6,
  123727. /** Ceiling */
  123728. Ceiling = 7,
  123729. /** Square root */
  123730. Sqrt = 8,
  123731. /** Log */
  123732. Log = 9,
  123733. /** Tangent */
  123734. Tan = 10,
  123735. /** Arc tangent */
  123736. ArcTan = 11,
  123737. /** Arc cosinus */
  123738. ArcCos = 12,
  123739. /** Arc sinus */
  123740. ArcSin = 13,
  123741. /** Fraction */
  123742. Fract = 14,
  123743. /** Sign */
  123744. Sign = 15,
  123745. /** To radians (from degrees) */
  123746. Radians = 16,
  123747. /** To degrees (from radians) */
  123748. Degrees = 17
  123749. }
  123750. /**
  123751. * Block used to apply trigonometry operation to floats
  123752. */
  123753. export class TrigonometryBlock extends NodeMaterialBlock {
  123754. /**
  123755. * Gets or sets the operation applied by the block
  123756. */
  123757. operation: TrigonometryBlockOperations;
  123758. /**
  123759. * Creates a new TrigonometryBlock
  123760. * @param name defines the block name
  123761. */
  123762. constructor(name: string);
  123763. /**
  123764. * Gets the current class name
  123765. * @returns the class name
  123766. */
  123767. getClassName(): string;
  123768. /**
  123769. * Gets the input component
  123770. */
  123771. readonly input: NodeMaterialConnectionPoint;
  123772. /**
  123773. * Gets the output component
  123774. */
  123775. readonly output: NodeMaterialConnectionPoint;
  123776. protected _buildBlock(state: NodeMaterialBuildState): this;
  123777. serialize(): any;
  123778. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  123779. protected _dumpPropertiesCode(): string;
  123780. }
  123781. }
  123782. declare module BABYLON {
  123783. /**
  123784. * Block used to create a Color3/4 out of individual inputs (one for each component)
  123785. */
  123786. export class ColorMergerBlock extends NodeMaterialBlock {
  123787. /**
  123788. * Create a new ColorMergerBlock
  123789. * @param name defines the block name
  123790. */
  123791. constructor(name: string);
  123792. /**
  123793. * Gets the current class name
  123794. * @returns the class name
  123795. */
  123796. getClassName(): string;
  123797. /**
  123798. * Gets the r component (input)
  123799. */
  123800. readonly r: NodeMaterialConnectionPoint;
  123801. /**
  123802. * Gets the g component (input)
  123803. */
  123804. readonly g: NodeMaterialConnectionPoint;
  123805. /**
  123806. * Gets the b component (input)
  123807. */
  123808. readonly b: NodeMaterialConnectionPoint;
  123809. /**
  123810. * Gets the a component (input)
  123811. */
  123812. readonly a: NodeMaterialConnectionPoint;
  123813. /**
  123814. * Gets the rgba component (output)
  123815. */
  123816. readonly rgba: NodeMaterialConnectionPoint;
  123817. /**
  123818. * Gets the rgb component (output)
  123819. */
  123820. readonly rgb: NodeMaterialConnectionPoint;
  123821. protected _buildBlock(state: NodeMaterialBuildState): this;
  123822. }
  123823. }
  123824. declare module BABYLON {
  123825. /**
  123826. * Block used to create a Vector2/3/4 out of individual inputs (one for each component)
  123827. */
  123828. export class VectorMergerBlock extends NodeMaterialBlock {
  123829. /**
  123830. * Create a new VectorMergerBlock
  123831. * @param name defines the block name
  123832. */
  123833. constructor(name: string);
  123834. /**
  123835. * Gets the current class name
  123836. * @returns the class name
  123837. */
  123838. getClassName(): string;
  123839. /**
  123840. * Gets the x component (input)
  123841. */
  123842. readonly x: NodeMaterialConnectionPoint;
  123843. /**
  123844. * Gets the y component (input)
  123845. */
  123846. readonly y: NodeMaterialConnectionPoint;
  123847. /**
  123848. * Gets the z component (input)
  123849. */
  123850. readonly z: NodeMaterialConnectionPoint;
  123851. /**
  123852. * Gets the w component (input)
  123853. */
  123854. readonly w: NodeMaterialConnectionPoint;
  123855. /**
  123856. * Gets the xyzw component (output)
  123857. */
  123858. readonly xyzw: NodeMaterialConnectionPoint;
  123859. /**
  123860. * Gets the xyz component (output)
  123861. */
  123862. readonly xyz: NodeMaterialConnectionPoint;
  123863. /**
  123864. * Gets the xy component (output)
  123865. */
  123866. readonly xy: NodeMaterialConnectionPoint;
  123867. protected _buildBlock(state: NodeMaterialBuildState): this;
  123868. }
  123869. }
  123870. declare module BABYLON {
  123871. /**
  123872. * Block used to expand a Color3/4 into 4 outputs (one for each component)
  123873. */
  123874. export class ColorSplitterBlock extends NodeMaterialBlock {
  123875. /**
  123876. * Create a new ColorSplitterBlock
  123877. * @param name defines the block name
  123878. */
  123879. constructor(name: string);
  123880. /**
  123881. * Gets the current class name
  123882. * @returns the class name
  123883. */
  123884. getClassName(): string;
  123885. /**
  123886. * Gets the rgba component (input)
  123887. */
  123888. readonly rgba: NodeMaterialConnectionPoint;
  123889. /**
  123890. * Gets the rgb component (input)
  123891. */
  123892. readonly rgbIn: NodeMaterialConnectionPoint;
  123893. /**
  123894. * Gets the rgb component (output)
  123895. */
  123896. readonly rgbOut: NodeMaterialConnectionPoint;
  123897. /**
  123898. * Gets the r component (output)
  123899. */
  123900. readonly r: NodeMaterialConnectionPoint;
  123901. /**
  123902. * Gets the g component (output)
  123903. */
  123904. readonly g: NodeMaterialConnectionPoint;
  123905. /**
  123906. * Gets the b component (output)
  123907. */
  123908. readonly b: NodeMaterialConnectionPoint;
  123909. /**
  123910. * Gets the a component (output)
  123911. */
  123912. readonly a: NodeMaterialConnectionPoint;
  123913. protected _inputRename(name: string): string;
  123914. protected _outputRename(name: string): string;
  123915. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  123916. }
  123917. }
  123918. declare module BABYLON {
  123919. /**
  123920. * Block used to expand a Vector3/4 into 4 outputs (one for each component)
  123921. */
  123922. export class VectorSplitterBlock extends NodeMaterialBlock {
  123923. /**
  123924. * Create a new VectorSplitterBlock
  123925. * @param name defines the block name
  123926. */
  123927. constructor(name: string);
  123928. /**
  123929. * Gets the current class name
  123930. * @returns the class name
  123931. */
  123932. getClassName(): string;
  123933. /**
  123934. * Gets the xyzw component (input)
  123935. */
  123936. readonly xyzw: NodeMaterialConnectionPoint;
  123937. /**
  123938. * Gets the xyz component (input)
  123939. */
  123940. readonly xyzIn: NodeMaterialConnectionPoint;
  123941. /**
  123942. * Gets the xy component (input)
  123943. */
  123944. readonly xyIn: NodeMaterialConnectionPoint;
  123945. /**
  123946. * Gets the xyz component (output)
  123947. */
  123948. readonly xyzOut: NodeMaterialConnectionPoint;
  123949. /**
  123950. * Gets the xy component (output)
  123951. */
  123952. readonly xyOut: NodeMaterialConnectionPoint;
  123953. /**
  123954. * Gets the x component (output)
  123955. */
  123956. readonly x: NodeMaterialConnectionPoint;
  123957. /**
  123958. * Gets the y component (output)
  123959. */
  123960. readonly y: NodeMaterialConnectionPoint;
  123961. /**
  123962. * Gets the z component (output)
  123963. */
  123964. readonly z: NodeMaterialConnectionPoint;
  123965. /**
  123966. * Gets the w component (output)
  123967. */
  123968. readonly w: NodeMaterialConnectionPoint;
  123969. protected _inputRename(name: string): string;
  123970. protected _outputRename(name: string): string;
  123971. protected _buildBlock(state: NodeMaterialBuildState): this;
  123972. }
  123973. }
  123974. declare module BABYLON {
  123975. /**
  123976. * Block used to lerp between 2 values
  123977. */
  123978. export class LerpBlock extends NodeMaterialBlock {
  123979. /**
  123980. * Creates a new LerpBlock
  123981. * @param name defines the block name
  123982. */
  123983. constructor(name: string);
  123984. /**
  123985. * Gets the current class name
  123986. * @returns the class name
  123987. */
  123988. getClassName(): string;
  123989. /**
  123990. * Gets the left operand input component
  123991. */
  123992. readonly left: NodeMaterialConnectionPoint;
  123993. /**
  123994. * Gets the right operand input component
  123995. */
  123996. readonly right: NodeMaterialConnectionPoint;
  123997. /**
  123998. * Gets the gradient operand input component
  123999. */
  124000. readonly gradient: NodeMaterialConnectionPoint;
  124001. /**
  124002. * Gets the output component
  124003. */
  124004. readonly output: NodeMaterialConnectionPoint;
  124005. protected _buildBlock(state: NodeMaterialBuildState): this;
  124006. }
  124007. }
  124008. declare module BABYLON {
  124009. /**
  124010. * Block used to divide 2 vectors
  124011. */
  124012. export class DivideBlock extends NodeMaterialBlock {
  124013. /**
  124014. * Creates a new DivideBlock
  124015. * @param name defines the block name
  124016. */
  124017. constructor(name: string);
  124018. /**
  124019. * Gets the current class name
  124020. * @returns the class name
  124021. */
  124022. getClassName(): string;
  124023. /**
  124024. * Gets the left operand input component
  124025. */
  124026. readonly left: NodeMaterialConnectionPoint;
  124027. /**
  124028. * Gets the right operand input component
  124029. */
  124030. readonly right: NodeMaterialConnectionPoint;
  124031. /**
  124032. * Gets the output component
  124033. */
  124034. readonly output: NodeMaterialConnectionPoint;
  124035. protected _buildBlock(state: NodeMaterialBuildState): this;
  124036. }
  124037. }
  124038. declare module BABYLON {
  124039. /**
  124040. * Block used to subtract 2 vectors
  124041. */
  124042. export class SubtractBlock extends NodeMaterialBlock {
  124043. /**
  124044. * Creates a new SubtractBlock
  124045. * @param name defines the block name
  124046. */
  124047. constructor(name: string);
  124048. /**
  124049. * Gets the current class name
  124050. * @returns the class name
  124051. */
  124052. getClassName(): string;
  124053. /**
  124054. * Gets the left operand input component
  124055. */
  124056. readonly left: NodeMaterialConnectionPoint;
  124057. /**
  124058. * Gets the right operand input component
  124059. */
  124060. readonly right: NodeMaterialConnectionPoint;
  124061. /**
  124062. * Gets the output component
  124063. */
  124064. readonly output: NodeMaterialConnectionPoint;
  124065. protected _buildBlock(state: NodeMaterialBuildState): this;
  124066. }
  124067. }
  124068. declare module BABYLON {
  124069. /**
  124070. * Block used to step a value
  124071. */
  124072. export class StepBlock extends NodeMaterialBlock {
  124073. /**
  124074. * Creates a new StepBlock
  124075. * @param name defines the block name
  124076. */
  124077. constructor(name: string);
  124078. /**
  124079. * Gets the current class name
  124080. * @returns the class name
  124081. */
  124082. getClassName(): string;
  124083. /**
  124084. * Gets the value operand input component
  124085. */
  124086. readonly value: NodeMaterialConnectionPoint;
  124087. /**
  124088. * Gets the edge operand input component
  124089. */
  124090. readonly edge: NodeMaterialConnectionPoint;
  124091. /**
  124092. * Gets the output component
  124093. */
  124094. readonly output: NodeMaterialConnectionPoint;
  124095. protected _buildBlock(state: NodeMaterialBuildState): this;
  124096. }
  124097. }
  124098. declare module BABYLON {
  124099. /**
  124100. * Block used to get the opposite (1 - x) of a value
  124101. */
  124102. export class OneMinusBlock extends NodeMaterialBlock {
  124103. /**
  124104. * Creates a new OneMinusBlock
  124105. * @param name defines the block name
  124106. */
  124107. constructor(name: string);
  124108. /**
  124109. * Gets the current class name
  124110. * @returns the class name
  124111. */
  124112. getClassName(): string;
  124113. /**
  124114. * Gets the input component
  124115. */
  124116. readonly input: NodeMaterialConnectionPoint;
  124117. /**
  124118. * Gets the output component
  124119. */
  124120. readonly output: NodeMaterialConnectionPoint;
  124121. protected _buildBlock(state: NodeMaterialBuildState): this;
  124122. }
  124123. }
  124124. declare module BABYLON {
  124125. /**
  124126. * Block used to get the view direction
  124127. */
  124128. export class ViewDirectionBlock extends NodeMaterialBlock {
  124129. /**
  124130. * Creates a new ViewDirectionBlock
  124131. * @param name defines the block name
  124132. */
  124133. constructor(name: string);
  124134. /**
  124135. * Gets the current class name
  124136. * @returns the class name
  124137. */
  124138. getClassName(): string;
  124139. /**
  124140. * Gets the world position component
  124141. */
  124142. readonly worldPosition: NodeMaterialConnectionPoint;
  124143. /**
  124144. * Gets the camera position component
  124145. */
  124146. readonly cameraPosition: NodeMaterialConnectionPoint;
  124147. /**
  124148. * Gets the output component
  124149. */
  124150. readonly output: NodeMaterialConnectionPoint;
  124151. autoConfigure(material: NodeMaterial): void;
  124152. protected _buildBlock(state: NodeMaterialBuildState): this;
  124153. }
  124154. }
  124155. declare module BABYLON {
  124156. /**
  124157. * Block used to compute fresnel value
  124158. */
  124159. export class FresnelBlock extends NodeMaterialBlock {
  124160. /**
  124161. * Create a new FresnelBlock
  124162. * @param name defines the block name
  124163. */
  124164. constructor(name: string);
  124165. /**
  124166. * Gets the current class name
  124167. * @returns the class name
  124168. */
  124169. getClassName(): string;
  124170. /**
  124171. * Gets the world normal input component
  124172. */
  124173. readonly worldNormal: NodeMaterialConnectionPoint;
  124174. /**
  124175. * Gets the view direction input component
  124176. */
  124177. readonly viewDirection: NodeMaterialConnectionPoint;
  124178. /**
  124179. * Gets the bias input component
  124180. */
  124181. readonly bias: NodeMaterialConnectionPoint;
  124182. /**
  124183. * Gets the camera (or eye) position component
  124184. */
  124185. readonly power: NodeMaterialConnectionPoint;
  124186. /**
  124187. * Gets the fresnel output component
  124188. */
  124189. readonly fresnel: NodeMaterialConnectionPoint;
  124190. autoConfigure(material: NodeMaterial): void;
  124191. protected _buildBlock(state: NodeMaterialBuildState): this;
  124192. }
  124193. }
  124194. declare module BABYLON {
  124195. /**
  124196. * Block used to get the max of 2 values
  124197. */
  124198. export class MaxBlock extends NodeMaterialBlock {
  124199. /**
  124200. * Creates a new MaxBlock
  124201. * @param name defines the block name
  124202. */
  124203. constructor(name: string);
  124204. /**
  124205. * Gets the current class name
  124206. * @returns the class name
  124207. */
  124208. getClassName(): string;
  124209. /**
  124210. * Gets the left operand input component
  124211. */
  124212. readonly left: NodeMaterialConnectionPoint;
  124213. /**
  124214. * Gets the right operand input component
  124215. */
  124216. readonly right: NodeMaterialConnectionPoint;
  124217. /**
  124218. * Gets the output component
  124219. */
  124220. readonly output: NodeMaterialConnectionPoint;
  124221. protected _buildBlock(state: NodeMaterialBuildState): this;
  124222. }
  124223. }
  124224. declare module BABYLON {
  124225. /**
  124226. * Block used to get the min of 2 values
  124227. */
  124228. export class MinBlock extends NodeMaterialBlock {
  124229. /**
  124230. * Creates a new MinBlock
  124231. * @param name defines the block name
  124232. */
  124233. constructor(name: string);
  124234. /**
  124235. * Gets the current class name
  124236. * @returns the class name
  124237. */
  124238. getClassName(): string;
  124239. /**
  124240. * Gets the left operand input component
  124241. */
  124242. readonly left: NodeMaterialConnectionPoint;
  124243. /**
  124244. * Gets the right operand input component
  124245. */
  124246. readonly right: NodeMaterialConnectionPoint;
  124247. /**
  124248. * Gets the output component
  124249. */
  124250. readonly output: NodeMaterialConnectionPoint;
  124251. protected _buildBlock(state: NodeMaterialBuildState): this;
  124252. }
  124253. }
  124254. declare module BABYLON {
  124255. /**
  124256. * Block used to get the distance between 2 values
  124257. */
  124258. export class DistanceBlock extends NodeMaterialBlock {
  124259. /**
  124260. * Creates a new DistanceBlock
  124261. * @param name defines the block name
  124262. */
  124263. constructor(name: string);
  124264. /**
  124265. * Gets the current class name
  124266. * @returns the class name
  124267. */
  124268. getClassName(): string;
  124269. /**
  124270. * Gets the left operand input component
  124271. */
  124272. readonly left: NodeMaterialConnectionPoint;
  124273. /**
  124274. * Gets the right operand input component
  124275. */
  124276. readonly right: NodeMaterialConnectionPoint;
  124277. /**
  124278. * Gets the output component
  124279. */
  124280. readonly output: NodeMaterialConnectionPoint;
  124281. protected _buildBlock(state: NodeMaterialBuildState): this;
  124282. }
  124283. }
  124284. declare module BABYLON {
  124285. /**
  124286. * Block used to get the length of a vector
  124287. */
  124288. export class LengthBlock extends NodeMaterialBlock {
  124289. /**
  124290. * Creates a new LengthBlock
  124291. * @param name defines the block name
  124292. */
  124293. constructor(name: string);
  124294. /**
  124295. * Gets the current class name
  124296. * @returns the class name
  124297. */
  124298. getClassName(): string;
  124299. /**
  124300. * Gets the value input component
  124301. */
  124302. readonly value: NodeMaterialConnectionPoint;
  124303. /**
  124304. * Gets the output component
  124305. */
  124306. readonly output: NodeMaterialConnectionPoint;
  124307. protected _buildBlock(state: NodeMaterialBuildState): this;
  124308. }
  124309. }
  124310. declare module BABYLON {
  124311. /**
  124312. * Block used to get negative version of a value (i.e. x * -1)
  124313. */
  124314. export class NegateBlock extends NodeMaterialBlock {
  124315. /**
  124316. * Creates a new NegateBlock
  124317. * @param name defines the block name
  124318. */
  124319. constructor(name: string);
  124320. /**
  124321. * Gets the current class name
  124322. * @returns the class name
  124323. */
  124324. getClassName(): string;
  124325. /**
  124326. * Gets the value input component
  124327. */
  124328. readonly value: NodeMaterialConnectionPoint;
  124329. /**
  124330. * Gets the output component
  124331. */
  124332. readonly output: NodeMaterialConnectionPoint;
  124333. protected _buildBlock(state: NodeMaterialBuildState): this;
  124334. }
  124335. }
  124336. declare module BABYLON {
  124337. /**
  124338. * Block used to get the value of the first parameter raised to the power of the second
  124339. */
  124340. export class PowBlock extends NodeMaterialBlock {
  124341. /**
  124342. * Creates a new PowBlock
  124343. * @param name defines the block name
  124344. */
  124345. constructor(name: string);
  124346. /**
  124347. * Gets the current class name
  124348. * @returns the class name
  124349. */
  124350. getClassName(): string;
  124351. /**
  124352. * Gets the value operand input component
  124353. */
  124354. readonly value: NodeMaterialConnectionPoint;
  124355. /**
  124356. * Gets the power operand input component
  124357. */
  124358. readonly power: NodeMaterialConnectionPoint;
  124359. /**
  124360. * Gets the output component
  124361. */
  124362. readonly output: NodeMaterialConnectionPoint;
  124363. protected _buildBlock(state: NodeMaterialBuildState): this;
  124364. }
  124365. }
  124366. declare module BABYLON {
  124367. /**
  124368. * Block used to get a random number
  124369. */
  124370. export class RandomNumberBlock extends NodeMaterialBlock {
  124371. /**
  124372. * Creates a new RandomNumberBlock
  124373. * @param name defines the block name
  124374. */
  124375. constructor(name: string);
  124376. /**
  124377. * Gets the current class name
  124378. * @returns the class name
  124379. */
  124380. getClassName(): string;
  124381. /**
  124382. * Gets the seed input component
  124383. */
  124384. readonly seed: NodeMaterialConnectionPoint;
  124385. /**
  124386. * Gets the output component
  124387. */
  124388. readonly output: NodeMaterialConnectionPoint;
  124389. protected _buildBlock(state: NodeMaterialBuildState): this;
  124390. }
  124391. }
  124392. declare module BABYLON {
  124393. /**
  124394. * Block used to compute arc tangent of 2 values
  124395. */
  124396. export class ArcTan2Block extends NodeMaterialBlock {
  124397. /**
  124398. * Creates a new ArcTan2Block
  124399. * @param name defines the block name
  124400. */
  124401. constructor(name: string);
  124402. /**
  124403. * Gets the current class name
  124404. * @returns the class name
  124405. */
  124406. getClassName(): string;
  124407. /**
  124408. * Gets the x operand input component
  124409. */
  124410. readonly x: NodeMaterialConnectionPoint;
  124411. /**
  124412. * Gets the y operand input component
  124413. */
  124414. readonly y: NodeMaterialConnectionPoint;
  124415. /**
  124416. * Gets the output component
  124417. */
  124418. readonly output: NodeMaterialConnectionPoint;
  124419. protected _buildBlock(state: NodeMaterialBuildState): this;
  124420. }
  124421. }
  124422. declare module BABYLON {
  124423. /**
  124424. * Block used to smooth step a value
  124425. */
  124426. export class SmoothStepBlock extends NodeMaterialBlock {
  124427. /**
  124428. * Creates a new SmoothStepBlock
  124429. * @param name defines the block name
  124430. */
  124431. constructor(name: string);
  124432. /**
  124433. * Gets the current class name
  124434. * @returns the class name
  124435. */
  124436. getClassName(): string;
  124437. /**
  124438. * Gets the value operand input component
  124439. */
  124440. readonly value: NodeMaterialConnectionPoint;
  124441. /**
  124442. * Gets the first edge operand input component
  124443. */
  124444. readonly edge0: NodeMaterialConnectionPoint;
  124445. /**
  124446. * Gets the second edge operand input component
  124447. */
  124448. readonly edge1: NodeMaterialConnectionPoint;
  124449. /**
  124450. * Gets the output component
  124451. */
  124452. readonly output: NodeMaterialConnectionPoint;
  124453. protected _buildBlock(state: NodeMaterialBuildState): this;
  124454. }
  124455. }
  124456. declare module BABYLON {
  124457. /**
  124458. * Block used to get the reciprocal (1 / x) of a value
  124459. */
  124460. export class ReciprocalBlock extends NodeMaterialBlock {
  124461. /**
  124462. * Creates a new ReciprocalBlock
  124463. * @param name defines the block name
  124464. */
  124465. constructor(name: string);
  124466. /**
  124467. * Gets the current class name
  124468. * @returns the class name
  124469. */
  124470. getClassName(): string;
  124471. /**
  124472. * Gets the input component
  124473. */
  124474. readonly input: NodeMaterialConnectionPoint;
  124475. /**
  124476. * Gets the output component
  124477. */
  124478. readonly output: NodeMaterialConnectionPoint;
  124479. protected _buildBlock(state: NodeMaterialBuildState): this;
  124480. }
  124481. }
  124482. declare module BABYLON {
  124483. /**
  124484. * Block used to replace a color by another one
  124485. */
  124486. export class ReplaceColorBlock extends NodeMaterialBlock {
  124487. /**
  124488. * Creates a new ReplaceColorBlock
  124489. * @param name defines the block name
  124490. */
  124491. constructor(name: string);
  124492. /**
  124493. * Gets the current class name
  124494. * @returns the class name
  124495. */
  124496. getClassName(): string;
  124497. /**
  124498. * Gets the value input component
  124499. */
  124500. readonly value: NodeMaterialConnectionPoint;
  124501. /**
  124502. * Gets the reference input component
  124503. */
  124504. readonly reference: NodeMaterialConnectionPoint;
  124505. /**
  124506. * Gets the distance input component
  124507. */
  124508. readonly distance: NodeMaterialConnectionPoint;
  124509. /**
  124510. * Gets the replacement input component
  124511. */
  124512. readonly replacement: NodeMaterialConnectionPoint;
  124513. /**
  124514. * Gets the output component
  124515. */
  124516. readonly output: NodeMaterialConnectionPoint;
  124517. protected _buildBlock(state: NodeMaterialBuildState): this;
  124518. }
  124519. }
  124520. declare module BABYLON {
  124521. /**
  124522. * Block used to posterize a value
  124523. * @see https://en.wikipedia.org/wiki/Posterization
  124524. */
  124525. export class PosterizeBlock extends NodeMaterialBlock {
  124526. /**
  124527. * Creates a new PosterizeBlock
  124528. * @param name defines the block name
  124529. */
  124530. constructor(name: string);
  124531. /**
  124532. * Gets the current class name
  124533. * @returns the class name
  124534. */
  124535. getClassName(): string;
  124536. /**
  124537. * Gets the value input component
  124538. */
  124539. readonly value: NodeMaterialConnectionPoint;
  124540. /**
  124541. * Gets the steps input component
  124542. */
  124543. readonly steps: NodeMaterialConnectionPoint;
  124544. /**
  124545. * Gets the output component
  124546. */
  124547. readonly output: NodeMaterialConnectionPoint;
  124548. protected _buildBlock(state: NodeMaterialBuildState): this;
  124549. }
  124550. }
  124551. declare module BABYLON {
  124552. /**
  124553. * Operations supported by the Wave block
  124554. */
  124555. export enum WaveBlockKind {
  124556. /** SawTooth */
  124557. SawTooth = 0,
  124558. /** Square */
  124559. Square = 1,
  124560. /** Triangle */
  124561. Triangle = 2
  124562. }
  124563. /**
  124564. * Block used to apply wave operation to floats
  124565. */
  124566. export class WaveBlock extends NodeMaterialBlock {
  124567. /**
  124568. * Gets or sets the kibnd of wave to be applied by the block
  124569. */
  124570. kind: WaveBlockKind;
  124571. /**
  124572. * Creates a new WaveBlock
  124573. * @param name defines the block name
  124574. */
  124575. constructor(name: string);
  124576. /**
  124577. * Gets the current class name
  124578. * @returns the class name
  124579. */
  124580. getClassName(): string;
  124581. /**
  124582. * Gets the input component
  124583. */
  124584. readonly input: NodeMaterialConnectionPoint;
  124585. /**
  124586. * Gets the output component
  124587. */
  124588. readonly output: NodeMaterialConnectionPoint;
  124589. protected _buildBlock(state: NodeMaterialBuildState): this;
  124590. serialize(): any;
  124591. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  124592. }
  124593. }
  124594. declare module BABYLON {
  124595. /**
  124596. * Class used to store a color step for the GradientBlock
  124597. */
  124598. export class GradientBlockColorStep {
  124599. /**
  124600. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  124601. */
  124602. step: number;
  124603. /**
  124604. * Gets or sets the color associated with this step
  124605. */
  124606. color: Color3;
  124607. /**
  124608. * Creates a new GradientBlockColorStep
  124609. * @param step defines a value indicating which step this color is associated with (between 0 and 1)
  124610. * @param color defines the color associated with this step
  124611. */
  124612. constructor(
  124613. /**
  124614. * Gets or sets a value indicating which step this color is associated with (between 0 and 1)
  124615. */
  124616. step: number,
  124617. /**
  124618. * Gets or sets the color associated with this step
  124619. */
  124620. color: Color3);
  124621. }
  124622. /**
  124623. * Block used to return a color from a gradient based on an input value between 0 and 1
  124624. */
  124625. export class GradientBlock extends NodeMaterialBlock {
  124626. /**
  124627. * Gets or sets the list of color steps
  124628. */
  124629. colorSteps: GradientBlockColorStep[];
  124630. /**
  124631. * Creates a new GradientBlock
  124632. * @param name defines the block name
  124633. */
  124634. constructor(name: string);
  124635. /**
  124636. * Gets the current class name
  124637. * @returns the class name
  124638. */
  124639. getClassName(): string;
  124640. /**
  124641. * Gets the gradient input component
  124642. */
  124643. readonly gradient: NodeMaterialConnectionPoint;
  124644. /**
  124645. * Gets the output component
  124646. */
  124647. readonly output: NodeMaterialConnectionPoint;
  124648. private _writeColorConstant;
  124649. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  124650. serialize(): any;
  124651. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  124652. protected _dumpPropertiesCode(): string;
  124653. }
  124654. }
  124655. declare module BABYLON {
  124656. /**
  124657. * Block used to normalize lerp between 2 values
  124658. */
  124659. export class NLerpBlock extends NodeMaterialBlock {
  124660. /**
  124661. * Creates a new NLerpBlock
  124662. * @param name defines the block name
  124663. */
  124664. constructor(name: string);
  124665. /**
  124666. * Gets the current class name
  124667. * @returns the class name
  124668. */
  124669. getClassName(): string;
  124670. /**
  124671. * Gets the left operand input component
  124672. */
  124673. readonly left: NodeMaterialConnectionPoint;
  124674. /**
  124675. * Gets the right operand input component
  124676. */
  124677. readonly right: NodeMaterialConnectionPoint;
  124678. /**
  124679. * Gets the gradient operand input component
  124680. */
  124681. readonly gradient: NodeMaterialConnectionPoint;
  124682. /**
  124683. * Gets the output component
  124684. */
  124685. readonly output: NodeMaterialConnectionPoint;
  124686. protected _buildBlock(state: NodeMaterialBuildState): this;
  124687. }
  124688. }
  124689. declare module BABYLON {
  124690. /**
  124691. * block used to Generate a Worley Noise 3D Noise Pattern
  124692. */
  124693. export class WorleyNoise3DBlock extends NodeMaterialBlock {
  124694. /** Gets or sets a boolean indicating that normal should be inverted on X axis */
  124695. manhattanDistance: boolean;
  124696. /**
  124697. * Creates a new WorleyNoise3DBlock
  124698. * @param name defines the block name
  124699. */
  124700. constructor(name: string);
  124701. /**
  124702. * Gets the current class name
  124703. * @returns the class name
  124704. */
  124705. getClassName(): string;
  124706. /**
  124707. * Gets the position input component
  124708. */
  124709. readonly position: NodeMaterialConnectionPoint;
  124710. /**
  124711. * Gets the jitter input component
  124712. */
  124713. readonly jitter: NodeMaterialConnectionPoint;
  124714. /**
  124715. * Gets the output component
  124716. */
  124717. readonly output: NodeMaterialConnectionPoint;
  124718. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  124719. /**
  124720. * Exposes the properties to the UI?
  124721. */
  124722. protected _dumpPropertiesCode(): string;
  124723. /**
  124724. * Exposes the properties to the Seralize?
  124725. */
  124726. serialize(): any;
  124727. /**
  124728. * Exposes the properties to the deseralize?
  124729. */
  124730. _deserialize(serializationObject: any, scene: Scene, rootUrl: string): void;
  124731. }
  124732. }
  124733. declare module BABYLON {
  124734. /**
  124735. * block used to Generate a Simplex Perlin 3d Noise Pattern
  124736. */
  124737. export class SimplexPerlin3DBlock extends NodeMaterialBlock {
  124738. /**
  124739. * Creates a new SimplexPerlin3DBlock
  124740. * @param name defines the block name
  124741. */
  124742. constructor(name: string);
  124743. /**
  124744. * Gets the current class name
  124745. * @returns the class name
  124746. */
  124747. getClassName(): string;
  124748. /**
  124749. * Gets the position operand input component
  124750. */
  124751. readonly position: NodeMaterialConnectionPoint;
  124752. /**
  124753. * Gets the output component
  124754. */
  124755. readonly output: NodeMaterialConnectionPoint;
  124756. protected _buildBlock(state: NodeMaterialBuildState): this | undefined;
  124757. }
  124758. }
  124759. declare module BABYLON {
  124760. /**
  124761. * Block used to blend normals
  124762. */
  124763. export class NormalBlendBlock extends NodeMaterialBlock {
  124764. /**
  124765. * Creates a new NormalBlendBlock
  124766. * @param name defines the block name
  124767. */
  124768. constructor(name: string);
  124769. /**
  124770. * Gets the current class name
  124771. * @returns the class name
  124772. */
  124773. getClassName(): string;
  124774. /**
  124775. * Gets the first input component
  124776. */
  124777. readonly input0: NodeMaterialConnectionPoint;
  124778. /**
  124779. * Gets the second input component
  124780. */
  124781. readonly input1: NodeMaterialConnectionPoint;
  124782. /**
  124783. * Gets the output component
  124784. */
  124785. readonly output: NodeMaterialConnectionPoint;
  124786. protected _buildBlock(state: NodeMaterialBuildState): this;
  124787. }
  124788. }
  124789. declare module BABYLON {
  124790. /**
  124791. * Effect Render Options
  124792. */
  124793. export interface IEffectRendererOptions {
  124794. /**
  124795. * Defines the vertices positions.
  124796. */
  124797. positions?: number[];
  124798. /**
  124799. * Defines the indices.
  124800. */
  124801. indices?: number[];
  124802. }
  124803. /**
  124804. * Helper class to render one or more effects
  124805. */
  124806. export class EffectRenderer {
  124807. private engine;
  124808. private static _DefaultOptions;
  124809. private _vertexBuffers;
  124810. private _indexBuffer;
  124811. private _ringBufferIndex;
  124812. private _ringScreenBuffer;
  124813. private _fullscreenViewport;
  124814. private _getNextFrameBuffer;
  124815. /**
  124816. * Creates an effect renderer
  124817. * @param engine the engine to use for rendering
  124818. * @param options defines the options of the effect renderer
  124819. */
  124820. constructor(engine: ThinEngine, options?: IEffectRendererOptions);
  124821. /**
  124822. * Sets the current viewport in normalized coordinates 0-1
  124823. * @param viewport Defines the viewport to set (defaults to 0 0 1 1)
  124824. */
  124825. setViewport(viewport?: Viewport): void;
  124826. /**
  124827. * Binds the embedded attributes buffer to the effect.
  124828. * @param effect Defines the effect to bind the attributes for
  124829. */
  124830. bindBuffers(effect: Effect): void;
  124831. /**
  124832. * Sets the current effect wrapper to use during draw.
  124833. * The effect needs to be ready before calling this api.
  124834. * This also sets the default full screen position attribute.
  124835. * @param effectWrapper Defines the effect to draw with
  124836. */
  124837. applyEffectWrapper(effectWrapper: EffectWrapper): void;
  124838. /**
  124839. * Draws a full screen quad.
  124840. */
  124841. draw(): void;
  124842. /**
  124843. * renders one or more effects to a specified texture
  124844. * @param effectWrappers list of effects to renderer
  124845. * @param outputTexture texture to draw to, if null it will render to the screen
  124846. */
  124847. render(effectWrappers: Array<EffectWrapper> | EffectWrapper, outputTexture?: Nullable<Texture>): void;
  124848. /**
  124849. * Disposes of the effect renderer
  124850. */
  124851. dispose(): void;
  124852. }
  124853. /**
  124854. * Options to create an EffectWrapper
  124855. */
  124856. interface EffectWrapperCreationOptions {
  124857. /**
  124858. * Engine to use to create the effect
  124859. */
  124860. engine: ThinEngine;
  124861. /**
  124862. * Fragment shader for the effect
  124863. */
  124864. fragmentShader: string;
  124865. /**
  124866. * Vertex shader for the effect
  124867. */
  124868. vertexShader?: string;
  124869. /**
  124870. * Attributes to use in the shader
  124871. */
  124872. attributeNames?: Array<string>;
  124873. /**
  124874. * Uniforms to use in the shader
  124875. */
  124876. uniformNames?: Array<string>;
  124877. /**
  124878. * Texture sampler names to use in the shader
  124879. */
  124880. samplerNames?: Array<string>;
  124881. /**
  124882. * The friendly name of the effect displayed in Spector.
  124883. */
  124884. name?: string;
  124885. }
  124886. /**
  124887. * Wraps an effect to be used for rendering
  124888. */
  124889. export class EffectWrapper {
  124890. /**
  124891. * Event that is fired right before the effect is drawn (should be used to update uniforms)
  124892. */
  124893. onApplyObservable: Observable<{}>;
  124894. /**
  124895. * The underlying effect
  124896. */
  124897. effect: Effect;
  124898. /**
  124899. * Creates an effect to be renderer
  124900. * @param creationOptions options to create the effect
  124901. */
  124902. constructor(creationOptions: EffectWrapperCreationOptions);
  124903. /**
  124904. * Disposes of the effect wrapper
  124905. */
  124906. dispose(): void;
  124907. }
  124908. }
  124909. declare module BABYLON {
  124910. /**
  124911. * Helper class to push actions to a pool of workers.
  124912. */
  124913. export class WorkerPool implements IDisposable {
  124914. private _workerInfos;
  124915. private _pendingActions;
  124916. /**
  124917. * Constructor
  124918. * @param workers Array of workers to use for actions
  124919. */
  124920. constructor(workers: Array<Worker>);
  124921. /**
  124922. * Terminates all workers and clears any pending actions.
  124923. */
  124924. dispose(): void;
  124925. /**
  124926. * Pushes an action to the worker pool. If all the workers are active, the action will be
  124927. * pended until a worker has completed its action.
  124928. * @param action The action to perform. Call onComplete when the action is complete.
  124929. */
  124930. push(action: (worker: Worker, onComplete: () => void) => void): void;
  124931. private _execute;
  124932. }
  124933. }
  124934. declare module BABYLON {
  124935. /**
  124936. * Configuration for Draco compression
  124937. */
  124938. export interface IDracoCompressionConfiguration {
  124939. /**
  124940. * Configuration for the decoder.
  124941. */
  124942. decoder: {
  124943. /**
  124944. * The url to the WebAssembly module.
  124945. */
  124946. wasmUrl?: string;
  124947. /**
  124948. * The url to the WebAssembly binary.
  124949. */
  124950. wasmBinaryUrl?: string;
  124951. /**
  124952. * The url to the fallback JavaScript module.
  124953. */
  124954. fallbackUrl?: string;
  124955. };
  124956. }
  124957. /**
  124958. * Draco compression (https://google.github.io/draco/)
  124959. *
  124960. * This class wraps the Draco module.
  124961. *
  124962. * **Encoder**
  124963. *
  124964. * The encoder is not currently implemented.
  124965. *
  124966. * **Decoder**
  124967. *
  124968. * 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.
  124969. *
  124970. * To update the configuration, use the following code:
  124971. * ```javascript
  124972. * DracoCompression.Configuration = {
  124973. * decoder: {
  124974. * wasmUrl: "<url to the WebAssembly library>",
  124975. * wasmBinaryUrl: "<url to the WebAssembly binary>",
  124976. * fallbackUrl: "<url to the fallback JavaScript library>",
  124977. * }
  124978. * };
  124979. * ```
  124980. *
  124981. * 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.
  124982. * Decoding will automatically fallback to the JavaScript version if WebAssembly version is not configured or if WebAssembly is not supported by the browser.
  124983. * Use `DracoCompression.DecoderAvailable` to determine if the decoder configuration is available for the current context.
  124984. *
  124985. * To decode Draco compressed data, get the default DracoCompression object and call decodeMeshAsync:
  124986. * ```javascript
  124987. * var vertexData = await DracoCompression.Default.decodeMeshAsync(data);
  124988. * ```
  124989. *
  124990. * @see https://www.babylonjs-playground.com/#N3EK4B#0
  124991. */
  124992. export class DracoCompression implements IDisposable {
  124993. private _workerPoolPromise?;
  124994. private _decoderModulePromise?;
  124995. /**
  124996. * The configuration. Defaults to the following urls:
  124997. * - wasmUrl: "https://preview.babylonjs.com/draco_wasm_wrapper_gltf.js"
  124998. * - wasmBinaryUrl: "https://preview.babylonjs.com/draco_decoder_gltf.wasm"
  124999. * - fallbackUrl: "https://preview.babylonjs.com/draco_decoder_gltf.js"
  125000. */
  125001. static Configuration: IDracoCompressionConfiguration;
  125002. /**
  125003. * Returns true if the decoder configuration is available.
  125004. */
  125005. static readonly DecoderAvailable: boolean;
  125006. /**
  125007. * Default number of workers to create when creating the draco compression object.
  125008. */
  125009. static DefaultNumWorkers: number;
  125010. private static GetDefaultNumWorkers;
  125011. private static _Default;
  125012. /**
  125013. * Default instance for the draco compression object.
  125014. */
  125015. static readonly Default: DracoCompression;
  125016. /**
  125017. * Constructor
  125018. * @param numWorkers The number of workers for async operations. Specify `0` to disable web workers and run synchronously in the current context.
  125019. */
  125020. constructor(numWorkers?: number);
  125021. /**
  125022. * Stop all async operations and release resources.
  125023. */
  125024. dispose(): void;
  125025. /**
  125026. * Returns a promise that resolves when ready. Call this manually to ensure draco compression is ready before use.
  125027. * @returns a promise that resolves when ready
  125028. */
  125029. whenReadyAsync(): Promise<void>;
  125030. /**
  125031. * Decode Draco compressed mesh data to vertex data.
  125032. * @param data The ArrayBuffer or ArrayBufferView for the Draco compression data
  125033. * @param attributes A map of attributes from vertex buffer kinds to Draco unique ids
  125034. * @returns A promise that resolves with the decoded vertex data
  125035. */
  125036. decodeMeshAsync(data: ArrayBuffer | ArrayBufferView, attributes?: {
  125037. [kind: string]: number;
  125038. }): Promise<VertexData>;
  125039. }
  125040. }
  125041. declare module BABYLON {
  125042. /**
  125043. * Class for building Constructive Solid Geometry
  125044. */
  125045. export class CSG {
  125046. private polygons;
  125047. /**
  125048. * The world matrix
  125049. */
  125050. matrix: Matrix;
  125051. /**
  125052. * Stores the position
  125053. */
  125054. position: Vector3;
  125055. /**
  125056. * Stores the rotation
  125057. */
  125058. rotation: Vector3;
  125059. /**
  125060. * Stores the rotation quaternion
  125061. */
  125062. rotationQuaternion: Nullable<Quaternion>;
  125063. /**
  125064. * Stores the scaling vector
  125065. */
  125066. scaling: Vector3;
  125067. /**
  125068. * Convert the Mesh to CSG
  125069. * @param mesh The Mesh to convert to CSG
  125070. * @returns A new CSG from the Mesh
  125071. */
  125072. static FromMesh(mesh: Mesh): CSG;
  125073. /**
  125074. * Construct a CSG solid from a list of `CSG.Polygon` instances.
  125075. * @param polygons Polygons used to construct a CSG solid
  125076. */
  125077. private static FromPolygons;
  125078. /**
  125079. * Clones, or makes a deep copy, of the CSG
  125080. * @returns A new CSG
  125081. */
  125082. clone(): CSG;
  125083. /**
  125084. * Unions this CSG with another CSG
  125085. * @param csg The CSG to union against this CSG
  125086. * @returns The unioned CSG
  125087. */
  125088. union(csg: CSG): CSG;
  125089. /**
  125090. * Unions this CSG with another CSG in place
  125091. * @param csg The CSG to union against this CSG
  125092. */
  125093. unionInPlace(csg: CSG): void;
  125094. /**
  125095. * Subtracts this CSG with another CSG
  125096. * @param csg The CSG to subtract against this CSG
  125097. * @returns A new CSG
  125098. */
  125099. subtract(csg: CSG): CSG;
  125100. /**
  125101. * Subtracts this CSG with another CSG in place
  125102. * @param csg The CSG to subtact against this CSG
  125103. */
  125104. subtractInPlace(csg: CSG): void;
  125105. /**
  125106. * Intersect this CSG with another CSG
  125107. * @param csg The CSG to intersect against this CSG
  125108. * @returns A new CSG
  125109. */
  125110. intersect(csg: CSG): CSG;
  125111. /**
  125112. * Intersects this CSG with another CSG in place
  125113. * @param csg The CSG to intersect against this CSG
  125114. */
  125115. intersectInPlace(csg: CSG): void;
  125116. /**
  125117. * Return a new CSG solid with solid and empty space switched. This solid is
  125118. * not modified.
  125119. * @returns A new CSG solid with solid and empty space switched
  125120. */
  125121. inverse(): CSG;
  125122. /**
  125123. * Inverses the CSG in place
  125124. */
  125125. inverseInPlace(): void;
  125126. /**
  125127. * This is used to keep meshes transformations so they can be restored
  125128. * when we build back a Babylon Mesh
  125129. * NB : All CSG operations are performed in world coordinates
  125130. * @param csg The CSG to copy the transform attributes from
  125131. * @returns This CSG
  125132. */
  125133. copyTransformAttributes(csg: CSG): CSG;
  125134. /**
  125135. * Build Raw mesh from CSG
  125136. * Coordinates here are in world space
  125137. * @param name The name of the mesh geometry
  125138. * @param scene The Scene
  125139. * @param keepSubMeshes Specifies if the submeshes should be kept
  125140. * @returns A new Mesh
  125141. */
  125142. buildMeshGeometry(name: string, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  125143. /**
  125144. * Build Mesh from CSG taking material and transforms into account
  125145. * @param name The name of the Mesh
  125146. * @param material The material of the Mesh
  125147. * @param scene The Scene
  125148. * @param keepSubMeshes Specifies if submeshes should be kept
  125149. * @returns The new Mesh
  125150. */
  125151. toMesh(name: string, material?: Nullable<Material>, scene?: Scene, keepSubMeshes?: boolean): Mesh;
  125152. }
  125153. }
  125154. declare module BABYLON {
  125155. /**
  125156. * Class used to create a trail following a mesh
  125157. */
  125158. export class TrailMesh extends Mesh {
  125159. private _generator;
  125160. private _autoStart;
  125161. private _running;
  125162. private _diameter;
  125163. private _length;
  125164. private _sectionPolygonPointsCount;
  125165. private _sectionVectors;
  125166. private _sectionNormalVectors;
  125167. private _beforeRenderObserver;
  125168. /**
  125169. * @constructor
  125170. * @param name The value used by scene.getMeshByName() to do a lookup.
  125171. * @param generator The mesh to generate a trail.
  125172. * @param scene The scene to add this mesh to.
  125173. * @param diameter Diameter of trailing mesh. Default is 1.
  125174. * @param length Length of trailing mesh. Default is 60.
  125175. * @param autoStart Automatically start trailing mesh. Default true.
  125176. */
  125177. constructor(name: string, generator: AbstractMesh, scene: Scene, diameter?: number, length?: number, autoStart?: boolean);
  125178. /**
  125179. * "TrailMesh"
  125180. * @returns "TrailMesh"
  125181. */
  125182. getClassName(): string;
  125183. private _createMesh;
  125184. /**
  125185. * Start trailing mesh.
  125186. */
  125187. start(): void;
  125188. /**
  125189. * Stop trailing mesh.
  125190. */
  125191. stop(): void;
  125192. /**
  125193. * Update trailing mesh geometry.
  125194. */
  125195. update(): void;
  125196. /**
  125197. * Returns a new TrailMesh object.
  125198. * @param name is a string, the name given to the new mesh
  125199. * @param newGenerator use new generator object for cloned trail mesh
  125200. * @returns a new mesh
  125201. */
  125202. clone(name: string | undefined, newGenerator: AbstractMesh): TrailMesh;
  125203. /**
  125204. * Serializes this trail mesh
  125205. * @param serializationObject object to write serialization to
  125206. */
  125207. serialize(serializationObject: any): void;
  125208. /**
  125209. * Parses a serialized trail mesh
  125210. * @param parsedMesh the serialized mesh
  125211. * @param scene the scene to create the trail mesh in
  125212. * @returns the created trail mesh
  125213. */
  125214. static Parse(parsedMesh: any, scene: Scene): TrailMesh;
  125215. }
  125216. }
  125217. declare module BABYLON {
  125218. /**
  125219. * Class containing static functions to help procedurally build meshes
  125220. */
  125221. export class TiledBoxBuilder {
  125222. /**
  125223. * Creates a box mesh
  125224. * 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)
  125225. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  125226. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  125227. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  125228. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  125229. * @param name defines the name of the mesh
  125230. * @param options defines the options used to create the mesh
  125231. * @param scene defines the hosting scene
  125232. * @returns the box mesh
  125233. */
  125234. static CreateTiledBox(name: string, options: {
  125235. pattern?: number;
  125236. width?: number;
  125237. height?: number;
  125238. depth?: number;
  125239. tileSize?: number;
  125240. tileWidth?: number;
  125241. tileHeight?: number;
  125242. alignHorizontal?: number;
  125243. alignVertical?: number;
  125244. faceUV?: Vector4[];
  125245. faceColors?: Color4[];
  125246. sideOrientation?: number;
  125247. updatable?: boolean;
  125248. }, scene?: Nullable<Scene>): Mesh;
  125249. }
  125250. }
  125251. declare module BABYLON {
  125252. /**
  125253. * Class containing static functions to help procedurally build meshes
  125254. */
  125255. export class TorusKnotBuilder {
  125256. /**
  125257. * Creates a torus knot mesh
  125258. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  125259. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  125260. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  125261. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  125262. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  125263. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  125264. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  125265. * @param name defines the name of the mesh
  125266. * @param options defines the options used to create the mesh
  125267. * @param scene defines the hosting scene
  125268. * @returns the torus knot mesh
  125269. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  125270. */
  125271. static CreateTorusKnot(name: string, options: {
  125272. radius?: number;
  125273. tube?: number;
  125274. radialSegments?: number;
  125275. tubularSegments?: number;
  125276. p?: number;
  125277. q?: number;
  125278. updatable?: boolean;
  125279. sideOrientation?: number;
  125280. frontUVs?: Vector4;
  125281. backUVs?: Vector4;
  125282. }, scene: any): Mesh;
  125283. }
  125284. }
  125285. declare module BABYLON {
  125286. /**
  125287. * Polygon
  125288. * @see https://doc.babylonjs.com/how_to/parametric_shapes#non-regular-polygon
  125289. */
  125290. export class Polygon {
  125291. /**
  125292. * Creates a rectangle
  125293. * @param xmin bottom X coord
  125294. * @param ymin bottom Y coord
  125295. * @param xmax top X coord
  125296. * @param ymax top Y coord
  125297. * @returns points that make the resulting rectation
  125298. */
  125299. static Rectangle(xmin: number, ymin: number, xmax: number, ymax: number): Vector2[];
  125300. /**
  125301. * Creates a circle
  125302. * @param radius radius of circle
  125303. * @param cx scale in x
  125304. * @param cy scale in y
  125305. * @param numberOfSides number of sides that make up the circle
  125306. * @returns points that make the resulting circle
  125307. */
  125308. static Circle(radius: number, cx?: number, cy?: number, numberOfSides?: number): Vector2[];
  125309. /**
  125310. * Creates a polygon from input string
  125311. * @param input Input polygon data
  125312. * @returns the parsed points
  125313. */
  125314. static Parse(input: string): Vector2[];
  125315. /**
  125316. * Starts building a polygon from x and y coordinates
  125317. * @param x x coordinate
  125318. * @param y y coordinate
  125319. * @returns the started path2
  125320. */
  125321. static StartingAt(x: number, y: number): Path2;
  125322. }
  125323. /**
  125324. * Builds a polygon
  125325. * @see https://doc.babylonjs.com/how_to/polygonmeshbuilder
  125326. */
  125327. export class PolygonMeshBuilder {
  125328. private _points;
  125329. private _outlinepoints;
  125330. private _holes;
  125331. private _name;
  125332. private _scene;
  125333. private _epoints;
  125334. private _eholes;
  125335. private _addToepoint;
  125336. /**
  125337. * Babylon reference to the earcut plugin.
  125338. */
  125339. bjsEarcut: any;
  125340. /**
  125341. * Creates a PolygonMeshBuilder
  125342. * @param name name of the builder
  125343. * @param contours Path of the polygon
  125344. * @param scene scene to add to when creating the mesh
  125345. * @param earcutInjection can be used to inject your own earcut reference
  125346. */
  125347. constructor(name: string, contours: Path2 | Vector2[] | any, scene?: Scene, earcutInjection?: any);
  125348. /**
  125349. * Adds a whole within the polygon
  125350. * @param hole Array of points defining the hole
  125351. * @returns this
  125352. */
  125353. addHole(hole: Vector2[]): PolygonMeshBuilder;
  125354. /**
  125355. * Creates the polygon
  125356. * @param updatable If the mesh should be updatable
  125357. * @param depth The depth of the mesh created
  125358. * @returns the created mesh
  125359. */
  125360. build(updatable?: boolean, depth?: number): Mesh;
  125361. /**
  125362. * Creates the polygon
  125363. * @param depth The depth of the mesh created
  125364. * @returns the created VertexData
  125365. */
  125366. buildVertexData(depth?: number): VertexData;
  125367. /**
  125368. * Adds a side to the polygon
  125369. * @param positions points that make the polygon
  125370. * @param normals normals of the polygon
  125371. * @param uvs uvs of the polygon
  125372. * @param indices indices of the polygon
  125373. * @param bounds bounds of the polygon
  125374. * @param points points of the polygon
  125375. * @param depth depth of the polygon
  125376. * @param flip flip of the polygon
  125377. */
  125378. private addSide;
  125379. }
  125380. }
  125381. declare module BABYLON {
  125382. /**
  125383. * Class containing static functions to help procedurally build meshes
  125384. */
  125385. export class PolygonBuilder {
  125386. /**
  125387. * Creates a polygon mesh
  125388. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  125389. * * 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
  125390. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  125391. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  125392. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  125393. * * Remember you can only change the shape positions, not their number when updating a polygon
  125394. * @param name defines the name of the mesh
  125395. * @param options defines the options used to create the mesh
  125396. * @param scene defines the hosting scene
  125397. * @param earcutInjection can be used to inject your own earcut reference
  125398. * @returns the polygon mesh
  125399. */
  125400. static CreatePolygon(name: string, options: {
  125401. shape: Vector3[];
  125402. holes?: Vector3[][];
  125403. depth?: number;
  125404. faceUV?: Vector4[];
  125405. faceColors?: Color4[];
  125406. updatable?: boolean;
  125407. sideOrientation?: number;
  125408. frontUVs?: Vector4;
  125409. backUVs?: Vector4;
  125410. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  125411. /**
  125412. * Creates an extruded polygon mesh, with depth in the Y direction.
  125413. * * 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)
  125414. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  125415. * @param name defines the name of the mesh
  125416. * @param options defines the options used to create the mesh
  125417. * @param scene defines the hosting scene
  125418. * @param earcutInjection can be used to inject your own earcut reference
  125419. * @returns the polygon mesh
  125420. */
  125421. static ExtrudePolygon(name: string, options: {
  125422. shape: Vector3[];
  125423. holes?: Vector3[][];
  125424. depth?: number;
  125425. faceUV?: Vector4[];
  125426. faceColors?: Color4[];
  125427. updatable?: boolean;
  125428. sideOrientation?: number;
  125429. frontUVs?: Vector4;
  125430. backUVs?: Vector4;
  125431. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  125432. }
  125433. }
  125434. declare module BABYLON {
  125435. /**
  125436. * Class containing static functions to help procedurally build meshes
  125437. */
  125438. export class LatheBuilder {
  125439. /**
  125440. * Creates lathe mesh.
  125441. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  125442. * * 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
  125443. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  125444. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  125445. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  125446. * * 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
  125447. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  125448. * * 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
  125449. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  125450. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  125451. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  125452. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  125453. * @param name defines the name of the mesh
  125454. * @param options defines the options used to create the mesh
  125455. * @param scene defines the hosting scene
  125456. * @returns the lathe mesh
  125457. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  125458. */
  125459. static CreateLathe(name: string, options: {
  125460. shape: Vector3[];
  125461. radius?: number;
  125462. tessellation?: number;
  125463. clip?: number;
  125464. arc?: number;
  125465. closed?: boolean;
  125466. updatable?: boolean;
  125467. sideOrientation?: number;
  125468. frontUVs?: Vector4;
  125469. backUVs?: Vector4;
  125470. cap?: number;
  125471. invertUV?: boolean;
  125472. }, scene?: Nullable<Scene>): Mesh;
  125473. }
  125474. }
  125475. declare module BABYLON {
  125476. /**
  125477. * Class containing static functions to help procedurally build meshes
  125478. */
  125479. export class TiledPlaneBuilder {
  125480. /**
  125481. * Creates a tiled plane mesh
  125482. * * The parameter `pattern` will, depending on value, do nothing or
  125483. * * * flip (reflect about central vertical) alternate tiles across and up
  125484. * * * flip every tile on alternate rows
  125485. * * * rotate (180 degs) alternate tiles across and up
  125486. * * * rotate every tile on alternate rows
  125487. * * * flip and rotate alternate tiles across and up
  125488. * * * flip and rotate every tile on alternate rows
  125489. * * The parameter `tileSize` sets the size (float) of each tile side (default 1)
  125490. * * You can set some different tile dimensions by using the parameters `tileWidth` and `tileHeight` (both by default have the same value of `tileSize`)
  125491. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  125492. * * sideOrientation optional and takes the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  125493. * * 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)
  125494. * * 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)
  125495. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  125496. * @param name defines the name of the mesh
  125497. * @param options defines the options used to create the mesh
  125498. * @param scene defines the hosting scene
  125499. * @returns the box mesh
  125500. */
  125501. static CreateTiledPlane(name: string, options: {
  125502. pattern?: number;
  125503. tileSize?: number;
  125504. tileWidth?: number;
  125505. tileHeight?: number;
  125506. size?: number;
  125507. width?: number;
  125508. height?: number;
  125509. alignHorizontal?: number;
  125510. alignVertical?: number;
  125511. sideOrientation?: number;
  125512. frontUVs?: Vector4;
  125513. backUVs?: Vector4;
  125514. updatable?: boolean;
  125515. }, scene?: Nullable<Scene>): Mesh;
  125516. }
  125517. }
  125518. declare module BABYLON {
  125519. /**
  125520. * Class containing static functions to help procedurally build meshes
  125521. */
  125522. export class TubeBuilder {
  125523. /**
  125524. * Creates a tube mesh.
  125525. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  125526. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  125527. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  125528. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  125529. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  125530. * * 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)
  125531. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  125532. * * 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
  125533. * * 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
  125534. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  125535. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  125536. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  125537. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  125538. * @param name defines the name of the mesh
  125539. * @param options defines the options used to create the mesh
  125540. * @param scene defines the hosting scene
  125541. * @returns the tube mesh
  125542. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  125543. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  125544. */
  125545. static CreateTube(name: string, options: {
  125546. path: Vector3[];
  125547. radius?: number;
  125548. tessellation?: number;
  125549. radiusFunction?: {
  125550. (i: number, distance: number): number;
  125551. };
  125552. cap?: number;
  125553. arc?: number;
  125554. updatable?: boolean;
  125555. sideOrientation?: number;
  125556. frontUVs?: Vector4;
  125557. backUVs?: Vector4;
  125558. instance?: Mesh;
  125559. invertUV?: boolean;
  125560. }, scene?: Nullable<Scene>): Mesh;
  125561. }
  125562. }
  125563. declare module BABYLON {
  125564. /**
  125565. * Class containing static functions to help procedurally build meshes
  125566. */
  125567. export class IcoSphereBuilder {
  125568. /**
  125569. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  125570. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  125571. * * 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`)
  125572. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  125573. * * 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
  125574. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  125575. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  125576. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  125577. * @param name defines the name of the mesh
  125578. * @param options defines the options used to create the mesh
  125579. * @param scene defines the hosting scene
  125580. * @returns the icosahedron mesh
  125581. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  125582. */
  125583. static CreateIcoSphere(name: string, options: {
  125584. radius?: number;
  125585. radiusX?: number;
  125586. radiusY?: number;
  125587. radiusZ?: number;
  125588. flat?: boolean;
  125589. subdivisions?: number;
  125590. sideOrientation?: number;
  125591. frontUVs?: Vector4;
  125592. backUVs?: Vector4;
  125593. updatable?: boolean;
  125594. }, scene?: Nullable<Scene>): Mesh;
  125595. }
  125596. }
  125597. declare module BABYLON {
  125598. /**
  125599. * Class containing static functions to help procedurally build meshes
  125600. */
  125601. export class DecalBuilder {
  125602. /**
  125603. * Creates a decal mesh.
  125604. * 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
  125605. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  125606. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  125607. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  125608. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  125609. * @param name defines the name of the mesh
  125610. * @param sourceMesh defines the mesh where the decal must be applied
  125611. * @param options defines the options used to create the mesh
  125612. * @param scene defines the hosting scene
  125613. * @returns the decal mesh
  125614. * @see https://doc.babylonjs.com/how_to/decals
  125615. */
  125616. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  125617. position?: Vector3;
  125618. normal?: Vector3;
  125619. size?: Vector3;
  125620. angle?: number;
  125621. }): Mesh;
  125622. }
  125623. }
  125624. declare module BABYLON {
  125625. /**
  125626. * Class containing static functions to help procedurally build meshes
  125627. */
  125628. export class MeshBuilder {
  125629. /**
  125630. * Creates a box mesh
  125631. * * The parameter `size` sets the size (float) of each box side (default 1)
  125632. * * You can set some different box dimensions by using the parameters `width`, `height` and `depth` (all by default have the same value of `size`)
  125633. * * 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)
  125634. * * Please read this tutorial : https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  125635. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  125636. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  125637. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  125638. * @see https://doc.babylonjs.com/how_to/set_shapes#box
  125639. * @param name defines the name of the mesh
  125640. * @param options defines the options used to create the mesh
  125641. * @param scene defines the hosting scene
  125642. * @returns the box mesh
  125643. */
  125644. static CreateBox(name: string, options: {
  125645. size?: number;
  125646. width?: number;
  125647. height?: number;
  125648. depth?: number;
  125649. faceUV?: Vector4[];
  125650. faceColors?: Color4[];
  125651. sideOrientation?: number;
  125652. frontUVs?: Vector4;
  125653. backUVs?: Vector4;
  125654. updatable?: boolean;
  125655. }, scene?: Nullable<Scene>): Mesh;
  125656. /**
  125657. * Creates a tiled box mesh
  125658. * * faceTiles sets the pattern, tile size and number of tiles for a face
  125659. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  125660. * @param name defines the name of the mesh
  125661. * @param options defines the options used to create the mesh
  125662. * @param scene defines the hosting scene
  125663. * @returns the tiled box mesh
  125664. */
  125665. static CreateTiledBox(name: string, options: {
  125666. pattern?: number;
  125667. size?: number;
  125668. width?: number;
  125669. height?: number;
  125670. depth: number;
  125671. tileSize?: number;
  125672. tileWidth?: number;
  125673. tileHeight?: number;
  125674. faceUV?: Vector4[];
  125675. faceColors?: Color4[];
  125676. alignHorizontal?: number;
  125677. alignVertical?: number;
  125678. sideOrientation?: number;
  125679. updatable?: boolean;
  125680. }, scene?: Nullable<Scene>): Mesh;
  125681. /**
  125682. * Creates a sphere mesh
  125683. * * The parameter `diameter` sets the diameter size (float) of the sphere (default 1)
  125684. * * 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`)
  125685. * * The parameter `segments` sets the sphere number of horizontal stripes (positive integer, default 32)
  125686. * * 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
  125687. * * 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)
  125688. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  125689. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  125690. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  125691. * @param name defines the name of the mesh
  125692. * @param options defines the options used to create the mesh
  125693. * @param scene defines the hosting scene
  125694. * @returns the sphere mesh
  125695. * @see https://doc.babylonjs.com/how_to/set_shapes#sphere
  125696. */
  125697. static CreateSphere(name: string, options: {
  125698. segments?: number;
  125699. diameter?: number;
  125700. diameterX?: number;
  125701. diameterY?: number;
  125702. diameterZ?: number;
  125703. arc?: number;
  125704. slice?: number;
  125705. sideOrientation?: number;
  125706. frontUVs?: Vector4;
  125707. backUVs?: Vector4;
  125708. updatable?: boolean;
  125709. }, scene?: Nullable<Scene>): Mesh;
  125710. /**
  125711. * Creates a plane polygonal mesh. By default, this is a disc
  125712. * * The parameter `radius` sets the radius size (float) of the polygon (default 0.5)
  125713. * * 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
  125714. * * 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
  125715. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  125716. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  125717. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  125718. * @param name defines the name of the mesh
  125719. * @param options defines the options used to create the mesh
  125720. * @param scene defines the hosting scene
  125721. * @returns the plane polygonal mesh
  125722. * @see https://doc.babylonjs.com/how_to/set_shapes#disc-or-regular-polygon
  125723. */
  125724. static CreateDisc(name: string, options: {
  125725. radius?: number;
  125726. tessellation?: number;
  125727. arc?: number;
  125728. updatable?: boolean;
  125729. sideOrientation?: number;
  125730. frontUVs?: Vector4;
  125731. backUVs?: Vector4;
  125732. }, scene?: Nullable<Scene>): Mesh;
  125733. /**
  125734. * Creates a sphere based upon an icosahedron with 20 triangular faces which can be subdivided
  125735. * * The parameter `radius` sets the radius size (float) of the icosphere (default 1)
  125736. * * 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`)
  125737. * * The parameter `subdivisions` sets the number of subdivisions (postive integer, default 4). The more subdivisions, the more faces on the icosphere whatever its size
  125738. * * 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
  125739. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  125740. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  125741. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  125742. * @param name defines the name of the mesh
  125743. * @param options defines the options used to create the mesh
  125744. * @param scene defines the hosting scene
  125745. * @returns the icosahedron mesh
  125746. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes#icosphere
  125747. */
  125748. static CreateIcoSphere(name: string, options: {
  125749. radius?: number;
  125750. radiusX?: number;
  125751. radiusY?: number;
  125752. radiusZ?: number;
  125753. flat?: boolean;
  125754. subdivisions?: number;
  125755. sideOrientation?: number;
  125756. frontUVs?: Vector4;
  125757. backUVs?: Vector4;
  125758. updatable?: boolean;
  125759. }, scene?: Nullable<Scene>): Mesh;
  125760. /**
  125761. * Creates a ribbon mesh. The ribbon is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  125762. * * The parameter `pathArray` is a required array of paths, what are each an array of successive Vector3. The pathArray parameter depicts the ribbon geometry
  125763. * * The parameter `closeArray` (boolean, default false) creates a seam between the first and the last paths of the path array
  125764. * * The parameter `closePath` (boolean, default false) creates a seam between the first and the last points of each path of the path array
  125765. * * 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
  125766. * * 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
  125767. * * 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
  125768. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  125769. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  125770. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  125771. * * 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
  125772. * * The parameters `colors` is an optional flat array of `Color4` to set/update each ribbon vertex with its own custom color values
  125773. * * 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
  125774. * * Moreover, you can use the parameter `color` with `instance` (to update the ribbon), only if you previously used it at creation time
  125775. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  125776. * @param name defines the name of the mesh
  125777. * @param options defines the options used to create the mesh
  125778. * @param scene defines the hosting scene
  125779. * @returns the ribbon mesh
  125780. * @see https://doc.babylonjs.com/how_to/ribbon_tutorial
  125781. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  125782. */
  125783. static CreateRibbon(name: string, options: {
  125784. pathArray: Vector3[][];
  125785. closeArray?: boolean;
  125786. closePath?: boolean;
  125787. offset?: number;
  125788. updatable?: boolean;
  125789. sideOrientation?: number;
  125790. frontUVs?: Vector4;
  125791. backUVs?: Vector4;
  125792. instance?: Mesh;
  125793. invertUV?: boolean;
  125794. uvs?: Vector2[];
  125795. colors?: Color4[];
  125796. }, scene?: Nullable<Scene>): Mesh;
  125797. /**
  125798. * Creates a cylinder or a cone mesh
  125799. * * The parameter `height` sets the height size (float) of the cylinder/cone (float, default 2).
  125800. * * The parameter `diameter` sets the diameter of the top and bottom cap at once (float, default 1).
  125801. * * 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.
  125802. * * The parameter `tessellation` sets the number of cylinder sides (positive integer, default 24). Set it to 3 to get a prism for instance.
  125803. * * The parameter `subdivisions` sets the number of rings along the cylinder height (positive integer, default 1).
  125804. * * The parameter `hasRings` (boolean, default false) makes the subdivisions independent from each other, so they become different faces.
  125805. * * The parameter `enclose` (boolean, default false) adds two extra faces per subdivision to a sliced cylinder to close it around its height axis.
  125806. * * 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).
  125807. * * The parameter `arc` (float, default 1) is the ratio (max 1) to apply to the circumference to slice the cylinder.
  125808. * * 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).
  125809. * * 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
  125810. * * Now, if the cylinder has 5 independent subdivisions (hasRings = true), n equals : top face + 5 stripe surfaces + bottom face = 2 + 5 = 7
  125811. * * 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
  125812. * * 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.
  125813. * * If `enclose` is false, a ring surface is one element.
  125814. * * If `enclose` is true, a ring surface is 3 successive elements in the array : the tubular surface, then the two closing faces.
  125815. * * 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
  125816. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  125817. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  125818. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  125819. * @param name defines the name of the mesh
  125820. * @param options defines the options used to create the mesh
  125821. * @param scene defines the hosting scene
  125822. * @returns the cylinder mesh
  125823. * @see https://doc.babylonjs.com/how_to/set_shapes#cylinder-or-cone
  125824. */
  125825. static CreateCylinder(name: string, options: {
  125826. height?: number;
  125827. diameterTop?: number;
  125828. diameterBottom?: number;
  125829. diameter?: number;
  125830. tessellation?: number;
  125831. subdivisions?: number;
  125832. arc?: number;
  125833. faceColors?: Color4[];
  125834. faceUV?: Vector4[];
  125835. updatable?: boolean;
  125836. hasRings?: boolean;
  125837. enclose?: boolean;
  125838. cap?: number;
  125839. sideOrientation?: number;
  125840. frontUVs?: Vector4;
  125841. backUVs?: Vector4;
  125842. }, scene?: Nullable<Scene>): Mesh;
  125843. /**
  125844. * Creates a torus mesh
  125845. * * The parameter `diameter` sets the diameter size (float) of the torus (default 1)
  125846. * * The parameter `thickness` sets the diameter size of the tube of the torus (float, default 0.5)
  125847. * * The parameter `tessellation` sets the number of torus sides (postive integer, default 16)
  125848. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  125849. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  125850. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  125851. * @param name defines the name of the mesh
  125852. * @param options defines the options used to create the mesh
  125853. * @param scene defines the hosting scene
  125854. * @returns the torus mesh
  125855. * @see https://doc.babylonjs.com/how_to/set_shapes#torus
  125856. */
  125857. static CreateTorus(name: string, options: {
  125858. diameter?: number;
  125859. thickness?: number;
  125860. tessellation?: number;
  125861. updatable?: boolean;
  125862. sideOrientation?: number;
  125863. frontUVs?: Vector4;
  125864. backUVs?: Vector4;
  125865. }, scene?: Nullable<Scene>): Mesh;
  125866. /**
  125867. * Creates a torus knot mesh
  125868. * * The parameter `radius` sets the global radius size (float) of the torus knot (default 2)
  125869. * * The parameter `radialSegments` sets the number of sides on each tube segments (positive integer, default 32)
  125870. * * The parameter `tubularSegments` sets the number of tubes to decompose the knot into (positive integer, default 32)
  125871. * * The parameters `p` and `q` are the number of windings on each axis (positive integers, default 2 and 3)
  125872. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  125873. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  125874. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  125875. * @param name defines the name of the mesh
  125876. * @param options defines the options used to create the mesh
  125877. * @param scene defines the hosting scene
  125878. * @returns the torus knot mesh
  125879. * @see https://doc.babylonjs.com/how_to/set_shapes#torus-knot
  125880. */
  125881. static CreateTorusKnot(name: string, options: {
  125882. radius?: number;
  125883. tube?: number;
  125884. radialSegments?: number;
  125885. tubularSegments?: number;
  125886. p?: number;
  125887. q?: number;
  125888. updatable?: boolean;
  125889. sideOrientation?: number;
  125890. frontUVs?: Vector4;
  125891. backUVs?: Vector4;
  125892. }, scene?: Nullable<Scene>): Mesh;
  125893. /**
  125894. * Creates a line system mesh. A line system is a pool of many lines gathered in a single mesh
  125895. * * 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
  125896. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineSystem to this static function
  125897. * * The parameter `lines` is an array of lines, each line being an array of successive Vector3
  125898. * * The optional parameter `instance` is an instance of an existing LineSystem object to be updated with the passed `lines` parameter
  125899. * * The optional parameter `colors` is an array of line colors, each line colors being an array of successive Color4, one per line point
  125900. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need the alpha blending (faster)
  125901. * * 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
  125902. * * When updating an instance, remember that only line point positions can change, not the number of points, neither the number of lines
  125903. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  125904. * @see https://doc.babylonjs.com/how_to/parametric_shapes#line-system
  125905. * @param name defines the name of the new line system
  125906. * @param options defines the options used to create the line system
  125907. * @param scene defines the hosting scene
  125908. * @returns a new line system mesh
  125909. */
  125910. static CreateLineSystem(name: string, options: {
  125911. lines: Vector3[][];
  125912. updatable?: boolean;
  125913. instance?: Nullable<LinesMesh>;
  125914. colors?: Nullable<Color4[][]>;
  125915. useVertexAlpha?: boolean;
  125916. }, scene: Nullable<Scene>): LinesMesh;
  125917. /**
  125918. * Creates a line mesh
  125919. * 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
  125920. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  125921. * * The parameter `points` is an array successive Vector3
  125922. * * 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
  125923. * * The optional parameter `colors` is an array of successive Color4, one per line point
  125924. * * The optional parameter `useVertexAlpha` is to be set to `false` (default `true`) when you don't need alpha blending (faster)
  125925. * * When updating an instance, remember that only point positions can change, not the number of points
  125926. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  125927. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lines
  125928. * @param name defines the name of the new line system
  125929. * @param options defines the options used to create the line system
  125930. * @param scene defines the hosting scene
  125931. * @returns a new line mesh
  125932. */
  125933. static CreateLines(name: string, options: {
  125934. points: Vector3[];
  125935. updatable?: boolean;
  125936. instance?: Nullable<LinesMesh>;
  125937. colors?: Color4[];
  125938. useVertexAlpha?: boolean;
  125939. }, scene?: Nullable<Scene>): LinesMesh;
  125940. /**
  125941. * Creates a dashed line mesh
  125942. * * 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
  125943. * * Like every other parametric shape, it is dynamically updatable by passing an existing instance of LineMesh to this static function
  125944. * * The parameter `points` is an array successive Vector3
  125945. * * The parameter `dashNb` is the intended total number of dashes (positive integer, default 200)
  125946. * * The parameter `dashSize` is the size of the dashes relatively the dash number (positive float, default 3)
  125947. * * The parameter `gapSize` is the size of the gap between two successive dashes relatively the dash number (positive float, default 1)
  125948. * * 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
  125949. * * When updating an instance, remember that only point positions can change, not the number of points
  125950. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  125951. * @param name defines the name of the mesh
  125952. * @param options defines the options used to create the mesh
  125953. * @param scene defines the hosting scene
  125954. * @returns the dashed line mesh
  125955. * @see https://doc.babylonjs.com/how_to/parametric_shapes#dashed-lines
  125956. */
  125957. static CreateDashedLines(name: string, options: {
  125958. points: Vector3[];
  125959. dashSize?: number;
  125960. gapSize?: number;
  125961. dashNb?: number;
  125962. updatable?: boolean;
  125963. instance?: LinesMesh;
  125964. }, scene?: Nullable<Scene>): LinesMesh;
  125965. /**
  125966. * 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.
  125967. * * 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.
  125968. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  125969. * * 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.
  125970. * * The parameter `scale` (float, default 1) is the value to scale the shape.
  125971. * * 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
  125972. * * 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
  125973. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape.
  125974. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  125975. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  125976. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture.
  125977. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  125978. * @param name defines the name of the mesh
  125979. * @param options defines the options used to create the mesh
  125980. * @param scene defines the hosting scene
  125981. * @returns the extruded shape mesh
  125982. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  125983. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  125984. */
  125985. static ExtrudeShape(name: string, options: {
  125986. shape: Vector3[];
  125987. path: Vector3[];
  125988. scale?: number;
  125989. rotation?: number;
  125990. cap?: number;
  125991. updatable?: boolean;
  125992. sideOrientation?: number;
  125993. frontUVs?: Vector4;
  125994. backUVs?: Vector4;
  125995. instance?: Mesh;
  125996. invertUV?: boolean;
  125997. }, scene?: Nullable<Scene>): Mesh;
  125998. /**
  125999. * Creates an custom extruded shape mesh.
  126000. * The custom extrusion is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters.
  126001. * * 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.
  126002. * * The parameter `path` is a required array of successive Vector3. This is the axis curve the shape is extruded along.
  126003. * * 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
  126004. * * It must returns a float value that will be the rotation in radians applied to the shape on each path point.
  126005. * * 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
  126006. * * It must returns a float value that will be the scale value applied to the shape on each path point
  126007. * * The parameter `ribbonClosePath` (boolean, default false) forces the extrusion underlying ribbon to close all the paths in its `pathArray`
  126008. * * The parameter `ribbonCloseArray` (boolean, default false) forces the extrusion underlying ribbon to close its `pathArray`
  126009. * * 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
  126010. * * 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
  126011. * * Remember you can only change the shape or path point positions, not their number when updating an extruded shape
  126012. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  126013. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  126014. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  126015. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  126016. * @param name defines the name of the mesh
  126017. * @param options defines the options used to create the mesh
  126018. * @param scene defines the hosting scene
  126019. * @returns the custom extruded shape mesh
  126020. * @see https://doc.babylonjs.com/how_to/parametric_shapes#custom-extruded-shapes
  126021. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  126022. * @see https://doc.babylonjs.com/how_to/parametric_shapes#extruded-shapes
  126023. */
  126024. static ExtrudeShapeCustom(name: string, options: {
  126025. shape: Vector3[];
  126026. path: Vector3[];
  126027. scaleFunction?: any;
  126028. rotationFunction?: any;
  126029. ribbonCloseArray?: boolean;
  126030. ribbonClosePath?: boolean;
  126031. cap?: number;
  126032. updatable?: boolean;
  126033. sideOrientation?: number;
  126034. frontUVs?: Vector4;
  126035. backUVs?: Vector4;
  126036. instance?: Mesh;
  126037. invertUV?: boolean;
  126038. }, scene?: Nullable<Scene>): Mesh;
  126039. /**
  126040. * Creates lathe mesh.
  126041. * The lathe is a shape with a symetry axis : a 2D model shape is rotated around this axis to design the lathe
  126042. * * 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
  126043. * * The parameter `radius` (positive float, default 1) is the radius value of the lathe
  126044. * * The parameter `tessellation` (positive integer, default 64) is the side number of the lathe
  126045. * * The parameter `clip` (positive integer, default 0) is the number of sides to not create without effecting the general shape of the sides
  126046. * * 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
  126047. * * The parameter `closed` (boolean, default true) opens/closes the lathe circumference. This should be set to false when used with the parameter "arc"
  126048. * * 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
  126049. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  126050. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  126051. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  126052. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  126053. * @param name defines the name of the mesh
  126054. * @param options defines the options used to create the mesh
  126055. * @param scene defines the hosting scene
  126056. * @returns the lathe mesh
  126057. * @see https://doc.babylonjs.com/how_to/parametric_shapes#lathe
  126058. */
  126059. static CreateLathe(name: string, options: {
  126060. shape: Vector3[];
  126061. radius?: number;
  126062. tessellation?: number;
  126063. clip?: number;
  126064. arc?: number;
  126065. closed?: boolean;
  126066. updatable?: boolean;
  126067. sideOrientation?: number;
  126068. frontUVs?: Vector4;
  126069. backUVs?: Vector4;
  126070. cap?: number;
  126071. invertUV?: boolean;
  126072. }, scene?: Nullable<Scene>): Mesh;
  126073. /**
  126074. * Creates a tiled plane mesh
  126075. * * You can set a limited pattern arrangement with the tiles
  126076. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  126077. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  126078. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  126079. * @param name defines the name of the mesh
  126080. * @param options defines the options used to create the mesh
  126081. * @param scene defines the hosting scene
  126082. * @returns the plane mesh
  126083. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  126084. */
  126085. static CreateTiledPlane(name: string, options: {
  126086. pattern?: number;
  126087. tileSize?: number;
  126088. tileWidth?: number;
  126089. tileHeight?: number;
  126090. size?: number;
  126091. width?: number;
  126092. height?: number;
  126093. alignHorizontal?: number;
  126094. alignVertical?: number;
  126095. sideOrientation?: number;
  126096. frontUVs?: Vector4;
  126097. backUVs?: Vector4;
  126098. updatable?: boolean;
  126099. }, scene?: Nullable<Scene>): Mesh;
  126100. /**
  126101. * Creates a plane mesh
  126102. * * The parameter `size` sets the size (float) of both sides of the plane at once (default 1)
  126103. * * You can set some different plane dimensions by using the parameters `width` and `height` (both by default have the same value of `size`)
  126104. * * The parameter `sourcePlane` is a Plane instance. It builds a mesh plane from a Math plane
  126105. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  126106. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  126107. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  126108. * @param name defines the name of the mesh
  126109. * @param options defines the options used to create the mesh
  126110. * @param scene defines the hosting scene
  126111. * @returns the plane mesh
  126112. * @see https://doc.babylonjs.com/how_to/set_shapes#plane
  126113. */
  126114. static CreatePlane(name: string, options: {
  126115. size?: number;
  126116. width?: number;
  126117. height?: number;
  126118. sideOrientation?: number;
  126119. frontUVs?: Vector4;
  126120. backUVs?: Vector4;
  126121. updatable?: boolean;
  126122. sourcePlane?: Plane;
  126123. }, scene?: Nullable<Scene>): Mesh;
  126124. /**
  126125. * Creates a ground mesh
  126126. * * The parameters `width` and `height` (floats, default 1) set the width and height sizes of the ground
  126127. * * The parameter `subdivisions` (positive integer) sets the number of subdivisions per side
  126128. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  126129. * @param name defines the name of the mesh
  126130. * @param options defines the options used to create the mesh
  126131. * @param scene defines the hosting scene
  126132. * @returns the ground mesh
  126133. * @see https://doc.babylonjs.com/how_to/set_shapes#ground
  126134. */
  126135. static CreateGround(name: string, options: {
  126136. width?: number;
  126137. height?: number;
  126138. subdivisions?: number;
  126139. subdivisionsX?: number;
  126140. subdivisionsY?: number;
  126141. updatable?: boolean;
  126142. }, scene?: Nullable<Scene>): Mesh;
  126143. /**
  126144. * Creates a tiled ground mesh
  126145. * * The parameters `xmin` and `xmax` (floats, default -1 and 1) set the ground minimum and maximum X coordinates
  126146. * * The parameters `zmin` and `zmax` (floats, default -1 and 1) set the ground minimum and maximum Z coordinates
  126147. * * 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
  126148. * * 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
  126149. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  126150. * @param name defines the name of the mesh
  126151. * @param options defines the options used to create the mesh
  126152. * @param scene defines the hosting scene
  126153. * @returns the tiled ground mesh
  126154. * @see https://doc.babylonjs.com/how_to/set_shapes#tiled-ground
  126155. */
  126156. static CreateTiledGround(name: string, options: {
  126157. xmin: number;
  126158. zmin: number;
  126159. xmax: number;
  126160. zmax: number;
  126161. subdivisions?: {
  126162. w: number;
  126163. h: number;
  126164. };
  126165. precision?: {
  126166. w: number;
  126167. h: number;
  126168. };
  126169. updatable?: boolean;
  126170. }, scene?: Nullable<Scene>): Mesh;
  126171. /**
  126172. * Creates a ground mesh from a height map
  126173. * * The parameter `url` sets the URL of the height map image resource.
  126174. * * The parameters `width` and `height` (positive floats, default 10) set the ground width and height sizes.
  126175. * * The parameter `subdivisions` (positive integer, default 1) sets the number of subdivision per side.
  126176. * * The parameter `minHeight` (float, default 0) is the minimum altitude on the ground.
  126177. * * The parameter `maxHeight` (float, default 1) is the maximum altitude on the ground.
  126178. * * 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.
  126179. * * 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).
  126180. * * The parameter `alphaFilter` will filter any data where the alpha channel is below this value, defaults 0 (all data visible)
  126181. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created.
  126182. * @param name defines the name of the mesh
  126183. * @param url defines the url to the height map
  126184. * @param options defines the options used to create the mesh
  126185. * @param scene defines the hosting scene
  126186. * @returns the ground mesh
  126187. * @see https://doc.babylonjs.com/babylon101/height_map
  126188. * @see https://doc.babylonjs.com/how_to/set_shapes#ground-from-a-height-map
  126189. */
  126190. static CreateGroundFromHeightMap(name: string, url: string, options: {
  126191. width?: number;
  126192. height?: number;
  126193. subdivisions?: number;
  126194. minHeight?: number;
  126195. maxHeight?: number;
  126196. colorFilter?: Color3;
  126197. alphaFilter?: number;
  126198. updatable?: boolean;
  126199. onReady?: (mesh: GroundMesh) => void;
  126200. }, scene?: Nullable<Scene>): GroundMesh;
  126201. /**
  126202. * Creates a polygon mesh
  126203. * The polygon's shape will depend on the input parameters and is constructed parallel to a ground mesh
  126204. * * 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
  126205. * * You can set the mesh side orientation with the values : Mesh.FRONTSIDE (default), Mesh.BACKSIDE or Mesh.DOUBLESIDE
  126206. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  126207. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4)
  126208. * * Remember you can only change the shape positions, not their number when updating a polygon
  126209. * @param name defines the name of the mesh
  126210. * @param options defines the options used to create the mesh
  126211. * @param scene defines the hosting scene
  126212. * @param earcutInjection can be used to inject your own earcut reference
  126213. * @returns the polygon mesh
  126214. */
  126215. static CreatePolygon(name: string, options: {
  126216. shape: Vector3[];
  126217. holes?: Vector3[][];
  126218. depth?: number;
  126219. faceUV?: Vector4[];
  126220. faceColors?: Color4[];
  126221. updatable?: boolean;
  126222. sideOrientation?: number;
  126223. frontUVs?: Vector4;
  126224. backUVs?: Vector4;
  126225. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  126226. /**
  126227. * Creates an extruded polygon mesh, with depth in the Y direction.
  126228. * * 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)
  126229. * @see https://doc.babylonjs.com/how_to/createbox_per_face_textures_and_colors
  126230. * @param name defines the name of the mesh
  126231. * @param options defines the options used to create the mesh
  126232. * @param scene defines the hosting scene
  126233. * @param earcutInjection can be used to inject your own earcut reference
  126234. * @returns the polygon mesh
  126235. */
  126236. static ExtrudePolygon(name: string, options: {
  126237. shape: Vector3[];
  126238. holes?: Vector3[][];
  126239. depth?: number;
  126240. faceUV?: Vector4[];
  126241. faceColors?: Color4[];
  126242. updatable?: boolean;
  126243. sideOrientation?: number;
  126244. frontUVs?: Vector4;
  126245. backUVs?: Vector4;
  126246. }, scene?: Nullable<Scene>, earcutInjection?: any): Mesh;
  126247. /**
  126248. * Creates a tube mesh.
  126249. * The tube is a parametric shape. It has no predefined shape. Its final shape will depend on the input parameters
  126250. * * The parameter `path` is a required array of successive Vector3. It is the curve used as the axis of the tube
  126251. * * The parameter `radius` (positive float, default 1) sets the tube radius size
  126252. * * The parameter `tessellation` (positive float, default 64) is the number of sides on the tubular surface
  126253. * * The parameter `radiusFunction` (javascript function, default null) is a vanilla javascript function. If it is not null, it overwrittes the parameter `radius`
  126254. * * 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)
  126255. * * The parameter `arc` (positive float, maximum 1, default 1) is the ratio to apply to the tube circumference : 2 x PI x arc
  126256. * * 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
  126257. * * 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
  126258. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  126259. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  126260. * * The optional parameter `invertUV` (boolean, default false) swaps in the geometry the U and V coordinates to apply a texture
  126261. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  126262. * @param name defines the name of the mesh
  126263. * @param options defines the options used to create the mesh
  126264. * @param scene defines the hosting scene
  126265. * @returns the tube mesh
  126266. * @see https://doc.babylonjs.com/how_to/parametric_shapes
  126267. * @see https://doc.babylonjs.com/how_to/set_shapes#tube
  126268. */
  126269. static CreateTube(name: string, options: {
  126270. path: Vector3[];
  126271. radius?: number;
  126272. tessellation?: number;
  126273. radiusFunction?: {
  126274. (i: number, distance: number): number;
  126275. };
  126276. cap?: number;
  126277. arc?: number;
  126278. updatable?: boolean;
  126279. sideOrientation?: number;
  126280. frontUVs?: Vector4;
  126281. backUVs?: Vector4;
  126282. instance?: Mesh;
  126283. invertUV?: boolean;
  126284. }, scene?: Nullable<Scene>): Mesh;
  126285. /**
  126286. * Creates a polyhedron mesh
  126287. * * 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
  126288. * * The parameter `size` (positive float, default 1) sets the polygon size
  126289. * * You can overwrite the `size` on each dimension bu using the parameters `sizeX`, `sizeY` or `sizeZ` (positive floats, default to `size` value)
  126290. * * 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`
  126291. * * 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
  126292. * * 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)`)
  126293. * * 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
  126294. * * 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
  126295. * * You can also set the mesh side orientation with the values : BABYLON.Mesh.FRONTSIDE (default), BABYLON.Mesh.BACKSIDE or BABYLON.Mesh.DOUBLESIDE
  126296. * * If you create a double-sided mesh, you can choose what parts of the texture image to crop and stick respectively on the front and the back sides with the parameters `frontUVs` and `backUVs` (Vector4). Detail here : https://doc.babylonjs.com/babylon101/discover_basic_elements#side-orientation
  126297. * * The mesh can be set to updatable with the boolean parameter `updatable` (default false) if its internal geometry is supposed to change once created
  126298. * @param name defines the name of the mesh
  126299. * @param options defines the options used to create the mesh
  126300. * @param scene defines the hosting scene
  126301. * @returns the polyhedron mesh
  126302. * @see https://doc.babylonjs.com/how_to/polyhedra_shapes
  126303. */
  126304. static CreatePolyhedron(name: string, options: {
  126305. type?: number;
  126306. size?: number;
  126307. sizeX?: number;
  126308. sizeY?: number;
  126309. sizeZ?: number;
  126310. custom?: any;
  126311. faceUV?: Vector4[];
  126312. faceColors?: Color4[];
  126313. flat?: boolean;
  126314. updatable?: boolean;
  126315. sideOrientation?: number;
  126316. frontUVs?: Vector4;
  126317. backUVs?: Vector4;
  126318. }, scene?: Nullable<Scene>): Mesh;
  126319. /**
  126320. * Creates a decal mesh.
  126321. * 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
  126322. * * The parameter `position` (Vector3, default `(0, 0, 0)`) sets the position of the decal in World coordinates
  126323. * * The parameter `normal` (Vector3, default `Vector3.Up`) sets the normal of the mesh where the decal is applied onto in World coordinates
  126324. * * The parameter `size` (Vector3, default `(1, 1, 1)`) sets the decal scaling
  126325. * * The parameter `angle` (float in radian, default 0) sets the angle to rotate the decal
  126326. * @param name defines the name of the mesh
  126327. * @param sourceMesh defines the mesh where the decal must be applied
  126328. * @param options defines the options used to create the mesh
  126329. * @param scene defines the hosting scene
  126330. * @returns the decal mesh
  126331. * @see https://doc.babylonjs.com/how_to/decals
  126332. */
  126333. static CreateDecal(name: string, sourceMesh: AbstractMesh, options: {
  126334. position?: Vector3;
  126335. normal?: Vector3;
  126336. size?: Vector3;
  126337. angle?: number;
  126338. }): Mesh;
  126339. }
  126340. }
  126341. declare module BABYLON {
  126342. /**
  126343. * A simplifier interface for future simplification implementations
  126344. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  126345. */
  126346. export interface ISimplifier {
  126347. /**
  126348. * Simplification of a given mesh according to the given settings.
  126349. * Since this requires computation, it is assumed that the function runs async.
  126350. * @param settings The settings of the simplification, including quality and distance
  126351. * @param successCallback A callback that will be called after the mesh was simplified.
  126352. * @param errorCallback in case of an error, this callback will be called. optional.
  126353. */
  126354. simplify(settings: ISimplificationSettings, successCallback: (simplifiedMeshes: Mesh) => void, errorCallback?: () => void): void;
  126355. }
  126356. /**
  126357. * Expected simplification settings.
  126358. * Quality should be between 0 and 1 (1 being 100%, 0 being 0%)
  126359. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  126360. */
  126361. export interface ISimplificationSettings {
  126362. /**
  126363. * Gets or sets the expected quality
  126364. */
  126365. quality: number;
  126366. /**
  126367. * Gets or sets the distance when this optimized version should be used
  126368. */
  126369. distance: number;
  126370. /**
  126371. * Gets an already optimized mesh
  126372. */
  126373. optimizeMesh?: boolean;
  126374. }
  126375. /**
  126376. * Class used to specify simplification options
  126377. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  126378. */
  126379. export class SimplificationSettings implements ISimplificationSettings {
  126380. /** expected quality */
  126381. quality: number;
  126382. /** distance when this optimized version should be used */
  126383. distance: number;
  126384. /** already optimized mesh */
  126385. optimizeMesh?: boolean | undefined;
  126386. /**
  126387. * Creates a SimplificationSettings
  126388. * @param quality expected quality
  126389. * @param distance distance when this optimized version should be used
  126390. * @param optimizeMesh already optimized mesh
  126391. */
  126392. constructor(
  126393. /** expected quality */
  126394. quality: number,
  126395. /** distance when this optimized version should be used */
  126396. distance: number,
  126397. /** already optimized mesh */
  126398. optimizeMesh?: boolean | undefined);
  126399. }
  126400. /**
  126401. * Interface used to define a simplification task
  126402. */
  126403. export interface ISimplificationTask {
  126404. /**
  126405. * Array of settings
  126406. */
  126407. settings: Array<ISimplificationSettings>;
  126408. /**
  126409. * Simplification type
  126410. */
  126411. simplificationType: SimplificationType;
  126412. /**
  126413. * Mesh to simplify
  126414. */
  126415. mesh: Mesh;
  126416. /**
  126417. * Callback called on success
  126418. */
  126419. successCallback?: () => void;
  126420. /**
  126421. * Defines if parallel processing can be used
  126422. */
  126423. parallelProcessing: boolean;
  126424. }
  126425. /**
  126426. * Queue used to order the simplification tasks
  126427. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  126428. */
  126429. export class SimplificationQueue {
  126430. private _simplificationArray;
  126431. /**
  126432. * Gets a boolean indicating that the process is still running
  126433. */
  126434. running: boolean;
  126435. /**
  126436. * Creates a new queue
  126437. */
  126438. constructor();
  126439. /**
  126440. * Adds a new simplification task
  126441. * @param task defines a task to add
  126442. */
  126443. addTask(task: ISimplificationTask): void;
  126444. /**
  126445. * Execute next task
  126446. */
  126447. executeNext(): void;
  126448. /**
  126449. * Execute a simplification task
  126450. * @param task defines the task to run
  126451. */
  126452. runSimplification(task: ISimplificationTask): void;
  126453. private getSimplifier;
  126454. }
  126455. /**
  126456. * The implemented types of simplification
  126457. * At the moment only Quadratic Error Decimation is implemented
  126458. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  126459. */
  126460. export enum SimplificationType {
  126461. /** Quadratic error decimation */
  126462. QUADRATIC = 0
  126463. }
  126464. }
  126465. declare module BABYLON {
  126466. interface Scene {
  126467. /** @hidden (Backing field) */
  126468. _simplificationQueue: SimplificationQueue;
  126469. /**
  126470. * Gets or sets the simplification queue attached to the scene
  126471. * @see http://doc.babylonjs.com/how_to/in-browser_mesh_simplification
  126472. */
  126473. simplificationQueue: SimplificationQueue;
  126474. }
  126475. interface Mesh {
  126476. /**
  126477. * Simplify the mesh according to the given array of settings.
  126478. * Function will return immediately and will simplify async
  126479. * @param settings a collection of simplification settings
  126480. * @param parallelProcessing should all levels calculate parallel or one after the other
  126481. * @param simplificationType the type of simplification to run
  126482. * @param successCallback optional success callback to be called after the simplification finished processing all settings
  126483. * @returns the current mesh
  126484. */
  126485. simplify(settings: Array<ISimplificationSettings>, parallelProcessing?: boolean, simplificationType?: SimplificationType, successCallback?: (mesh?: Mesh, submeshIndex?: number) => void): Mesh;
  126486. }
  126487. /**
  126488. * Defines the simplification queue scene component responsible to help scheduling the various simplification task
  126489. * created in a scene
  126490. */
  126491. export class SimplicationQueueSceneComponent implements ISceneComponent {
  126492. /**
  126493. * The component name helpfull to identify the component in the list of scene components.
  126494. */
  126495. readonly name: string;
  126496. /**
  126497. * The scene the component belongs to.
  126498. */
  126499. scene: Scene;
  126500. /**
  126501. * Creates a new instance of the component for the given scene
  126502. * @param scene Defines the scene to register the component in
  126503. */
  126504. constructor(scene: Scene);
  126505. /**
  126506. * Registers the component in a given scene
  126507. */
  126508. register(): void;
  126509. /**
  126510. * Rebuilds the elements related to this component in case of
  126511. * context lost for instance.
  126512. */
  126513. rebuild(): void;
  126514. /**
  126515. * Disposes the component and the associated ressources
  126516. */
  126517. dispose(): void;
  126518. private _beforeCameraUpdate;
  126519. }
  126520. }
  126521. declare module BABYLON {
  126522. /**
  126523. * Navigation plugin interface to add navigation constrained by a navigation mesh
  126524. */
  126525. export interface INavigationEnginePlugin {
  126526. /**
  126527. * plugin name
  126528. */
  126529. name: string;
  126530. /**
  126531. * Creates a navigation mesh
  126532. * @param meshes array of all the geometry used to compute the navigatio mesh
  126533. * @param parameters bunch of parameters used to filter geometry
  126534. */
  126535. createMavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  126536. /**
  126537. * Create a navigation mesh debug mesh
  126538. * @param scene is where the mesh will be added
  126539. * @returns debug display mesh
  126540. */
  126541. createDebugNavMesh(scene: Scene): Mesh;
  126542. /**
  126543. * Get a navigation mesh constrained position, closest to the parameter position
  126544. * @param position world position
  126545. * @returns the closest point to position constrained by the navigation mesh
  126546. */
  126547. getClosestPoint(position: Vector3): Vector3;
  126548. /**
  126549. * Get a navigation mesh constrained position, within a particular radius
  126550. * @param position world position
  126551. * @param maxRadius the maximum distance to the constrained world position
  126552. * @returns the closest point to position constrained by the navigation mesh
  126553. */
  126554. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  126555. /**
  126556. * Compute the final position from a segment made of destination-position
  126557. * @param position world position
  126558. * @param destination world position
  126559. * @returns the resulting point along the navmesh
  126560. */
  126561. moveAlong(position: Vector3, destination: Vector3): Vector3;
  126562. /**
  126563. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  126564. * @param start world position
  126565. * @param end world position
  126566. * @returns array containing world position composing the path
  126567. */
  126568. computePath(start: Vector3, end: Vector3): Vector3[];
  126569. /**
  126570. * If this plugin is supported
  126571. * @returns true if plugin is supported
  126572. */
  126573. isSupported(): boolean;
  126574. /**
  126575. * Create a new Crowd so you can add agents
  126576. * @param maxAgents the maximum agent count in the crowd
  126577. * @param maxAgentRadius the maximum radius an agent can have
  126578. * @param scene to attach the crowd to
  126579. * @returns the crowd you can add agents to
  126580. */
  126581. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  126582. /**
  126583. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  126584. * The queries will try to find a solution within those bounds
  126585. * default is (1,1,1)
  126586. * @param extent x,y,z value that define the extent around the queries point of reference
  126587. */
  126588. setDefaultQueryExtent(extent: Vector3): void;
  126589. /**
  126590. * Get the Bounding box extent specified by setDefaultQueryExtent
  126591. * @returns the box extent values
  126592. */
  126593. getDefaultQueryExtent(): Vector3;
  126594. /**
  126595. * Release all resources
  126596. */
  126597. dispose(): void;
  126598. }
  126599. /**
  126600. * Crowd Interface. A Crowd is a collection of moving agents constrained by a navigation mesh
  126601. */
  126602. export interface ICrowd {
  126603. /**
  126604. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  126605. * You can attach anything to that node. The node position is updated in the scene update tick.
  126606. * @param pos world position that will be constrained by the navigation mesh
  126607. * @param parameters agent parameters
  126608. * @param transform hooked to the agent that will be update by the scene
  126609. * @returns agent index
  126610. */
  126611. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  126612. /**
  126613. * Returns the agent position in world space
  126614. * @param index agent index returned by addAgent
  126615. * @returns world space position
  126616. */
  126617. getAgentPosition(index: number): Vector3;
  126618. /**
  126619. * Gets the agent velocity in world space
  126620. * @param index agent index returned by addAgent
  126621. * @returns world space velocity
  126622. */
  126623. getAgentVelocity(index: number): Vector3;
  126624. /**
  126625. * remove a particular agent previously created
  126626. * @param index agent index returned by addAgent
  126627. */
  126628. removeAgent(index: number): void;
  126629. /**
  126630. * get the list of all agents attached to this crowd
  126631. * @returns list of agent indices
  126632. */
  126633. getAgents(): number[];
  126634. /**
  126635. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  126636. * @param deltaTime in seconds
  126637. */
  126638. update(deltaTime: number): void;
  126639. /**
  126640. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  126641. * @param index agent index returned by addAgent
  126642. * @param destination targeted world position
  126643. */
  126644. agentGoto(index: number, destination: Vector3): void;
  126645. /**
  126646. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  126647. * The queries will try to find a solution within those bounds
  126648. * default is (1,1,1)
  126649. * @param extent x,y,z value that define the extent around the queries point of reference
  126650. */
  126651. setDefaultQueryExtent(extent: Vector3): void;
  126652. /**
  126653. * Get the Bounding box extent specified by setDefaultQueryExtent
  126654. * @returns the box extent values
  126655. */
  126656. getDefaultQueryExtent(): Vector3;
  126657. /**
  126658. * Release all resources
  126659. */
  126660. dispose(): void;
  126661. }
  126662. /**
  126663. * Configures an agent
  126664. */
  126665. export interface IAgentParameters {
  126666. /**
  126667. * Agent radius. [Limit: >= 0]
  126668. */
  126669. radius: number;
  126670. /**
  126671. * Agent height. [Limit: > 0]
  126672. */
  126673. height: number;
  126674. /**
  126675. * Maximum allowed acceleration. [Limit: >= 0]
  126676. */
  126677. maxAcceleration: number;
  126678. /**
  126679. * Maximum allowed speed. [Limit: >= 0]
  126680. */
  126681. maxSpeed: number;
  126682. /**
  126683. * Defines how close a collision element must be before it is considered for steering behaviors. [Limits: > 0]
  126684. */
  126685. collisionQueryRange: number;
  126686. /**
  126687. * The path visibility optimization range. [Limit: > 0]
  126688. */
  126689. pathOptimizationRange: number;
  126690. /**
  126691. * How aggresive the agent manager should be at avoiding collisions with this agent. [Limit: >= 0]
  126692. */
  126693. separationWeight: number;
  126694. }
  126695. /**
  126696. * Configures the navigation mesh creation
  126697. */
  126698. export interface INavMeshParameters {
  126699. /**
  126700. * The xz-plane cell size to use for fields. [Limit: > 0] [Units: wu]
  126701. */
  126702. cs: number;
  126703. /**
  126704. * The y-axis cell size to use for fields. [Limit: > 0] [Units: wu]
  126705. */
  126706. ch: number;
  126707. /**
  126708. * The maximum slope that is considered walkable. [Limits: 0 <= value < 90] [Units: Degrees]
  126709. */
  126710. walkableSlopeAngle: number;
  126711. /**
  126712. * Minimum floor to 'ceiling' height that will still allow the floor area to
  126713. * be considered walkable. [Limit: >= 3] [Units: vx]
  126714. */
  126715. walkableHeight: number;
  126716. /**
  126717. * Maximum ledge height that is considered to still be traversable. [Limit: >=0] [Units: vx]
  126718. */
  126719. walkableClimb: number;
  126720. /**
  126721. * The distance to erode/shrink the walkable area of the heightfield away from
  126722. * obstructions. [Limit: >=0] [Units: vx]
  126723. */
  126724. walkableRadius: number;
  126725. /**
  126726. * The maximum allowed length for contour edges along the border of the mesh. [Limit: >=0] [Units: vx]
  126727. */
  126728. maxEdgeLen: number;
  126729. /**
  126730. * The maximum distance a simplfied contour's border edges should deviate
  126731. * the original raw contour. [Limit: >=0] [Units: vx]
  126732. */
  126733. maxSimplificationError: number;
  126734. /**
  126735. * The minimum number of cells allowed to form isolated island areas. [Limit: >=0] [Units: vx]
  126736. */
  126737. minRegionArea: number;
  126738. /**
  126739. * Any regions with a span count smaller than this value will, if possible,
  126740. * be merged with larger regions. [Limit: >=0] [Units: vx]
  126741. */
  126742. mergeRegionArea: number;
  126743. /**
  126744. * The maximum number of vertices allowed for polygons generated during the
  126745. * contour to polygon conversion process. [Limit: >= 3]
  126746. */
  126747. maxVertsPerPoly: number;
  126748. /**
  126749. * Sets the sampling distance to use when generating the detail mesh.
  126750. * (For height detail only.) [Limits: 0 or >= 0.9] [Units: wu]
  126751. */
  126752. detailSampleDist: number;
  126753. /**
  126754. * The maximum distance the detail mesh surface should deviate from heightfield
  126755. * data. (For height detail only.) [Limit: >=0] [Units: wu]
  126756. */
  126757. detailSampleMaxError: number;
  126758. }
  126759. }
  126760. declare module BABYLON {
  126761. /**
  126762. * RecastJS navigation plugin
  126763. */
  126764. export class RecastJSPlugin implements INavigationEnginePlugin {
  126765. /**
  126766. * Reference to the Recast library
  126767. */
  126768. bjsRECAST: any;
  126769. /**
  126770. * plugin name
  126771. */
  126772. name: string;
  126773. /**
  126774. * the first navmesh created. We might extend this to support multiple navmeshes
  126775. */
  126776. navMesh: any;
  126777. /**
  126778. * Initializes the recastJS plugin
  126779. * @param recastInjection can be used to inject your own recast reference
  126780. */
  126781. constructor(recastInjection?: any);
  126782. /**
  126783. * Creates a navigation mesh
  126784. * @param meshes array of all the geometry used to compute the navigatio mesh
  126785. * @param parameters bunch of parameters used to filter geometry
  126786. */
  126787. createMavMesh(meshes: Array<Mesh>, parameters: INavMeshParameters): void;
  126788. /**
  126789. * Create a navigation mesh debug mesh
  126790. * @param scene is where the mesh will be added
  126791. * @returns debug display mesh
  126792. */
  126793. createDebugNavMesh(scene: Scene): Mesh;
  126794. /**
  126795. * Get a navigation mesh constrained position, closest to the parameter position
  126796. * @param position world position
  126797. * @returns the closest point to position constrained by the navigation mesh
  126798. */
  126799. getClosestPoint(position: Vector3): Vector3;
  126800. /**
  126801. * Get a navigation mesh constrained position, within a particular radius
  126802. * @param position world position
  126803. * @param maxRadius the maximum distance to the constrained world position
  126804. * @returns the closest point to position constrained by the navigation mesh
  126805. */
  126806. getRandomPointAround(position: Vector3, maxRadius: number): Vector3;
  126807. /**
  126808. * Compute the final position from a segment made of destination-position
  126809. * @param position world position
  126810. * @param destination world position
  126811. * @returns the resulting point along the navmesh
  126812. */
  126813. moveAlong(position: Vector3, destination: Vector3): Vector3;
  126814. /**
  126815. * Compute a navigation path from start to end. Returns an empty array if no path can be computed
  126816. * @param start world position
  126817. * @param end world position
  126818. * @returns array containing world position composing the path
  126819. */
  126820. computePath(start: Vector3, end: Vector3): Vector3[];
  126821. /**
  126822. * Create a new Crowd so you can add agents
  126823. * @param maxAgents the maximum agent count in the crowd
  126824. * @param maxAgentRadius the maximum radius an agent can have
  126825. * @param scene to attach the crowd to
  126826. * @returns the crowd you can add agents to
  126827. */
  126828. createCrowd(maxAgents: number, maxAgentRadius: number, scene: Scene): ICrowd;
  126829. /**
  126830. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  126831. * The queries will try to find a solution within those bounds
  126832. * default is (1,1,1)
  126833. * @param extent x,y,z value that define the extent around the queries point of reference
  126834. */
  126835. setDefaultQueryExtent(extent: Vector3): void;
  126836. /**
  126837. * Get the Bounding box extent specified by setDefaultQueryExtent
  126838. * @returns the box extent values
  126839. */
  126840. getDefaultQueryExtent(): Vector3;
  126841. /**
  126842. * Disposes
  126843. */
  126844. dispose(): void;
  126845. /**
  126846. * If this plugin is supported
  126847. * @returns true if plugin is supported
  126848. */
  126849. isSupported(): boolean;
  126850. }
  126851. /**
  126852. * Recast detour crowd implementation
  126853. */
  126854. export class RecastJSCrowd implements ICrowd {
  126855. /**
  126856. * Recast/detour plugin
  126857. */
  126858. bjsRECASTPlugin: RecastJSPlugin;
  126859. /**
  126860. * Link to the detour crowd
  126861. */
  126862. recastCrowd: any;
  126863. /**
  126864. * One transform per agent
  126865. */
  126866. transforms: TransformNode[];
  126867. /**
  126868. * All agents created
  126869. */
  126870. agents: number[];
  126871. /**
  126872. * Link to the scene is kept to unregister the crowd from the scene
  126873. */
  126874. private _scene;
  126875. /**
  126876. * Observer for crowd updates
  126877. */
  126878. private _onBeforeAnimationsObserver;
  126879. /**
  126880. * Constructor
  126881. * @param plugin recastJS plugin
  126882. * @param maxAgents the maximum agent count in the crowd
  126883. * @param maxAgentRadius the maximum radius an agent can have
  126884. * @param scene to attach the crowd to
  126885. * @returns the crowd you can add agents to
  126886. */
  126887. constructor(plugin: RecastJSPlugin, maxAgents: number, maxAgentRadius: number, scene: Scene);
  126888. /**
  126889. * Add a new agent to the crowd with the specified parameter a corresponding transformNode.
  126890. * You can attach anything to that node. The node position is updated in the scene update tick.
  126891. * @param pos world position that will be constrained by the navigation mesh
  126892. * @param parameters agent parameters
  126893. * @param transform hooked to the agent that will be update by the scene
  126894. * @returns agent index
  126895. */
  126896. addAgent(pos: Vector3, parameters: IAgentParameters, transform: TransformNode): number;
  126897. /**
  126898. * Returns the agent position in world space
  126899. * @param index agent index returned by addAgent
  126900. * @returns world space position
  126901. */
  126902. getAgentPosition(index: number): Vector3;
  126903. /**
  126904. * Returns the agent velocity in world space
  126905. * @param index agent index returned by addAgent
  126906. * @returns world space velocity
  126907. */
  126908. getAgentVelocity(index: number): Vector3;
  126909. /**
  126910. * Asks a particular agent to go to a destination. That destination is constrained by the navigation mesh
  126911. * @param index agent index returned by addAgent
  126912. * @param destination targeted world position
  126913. */
  126914. agentGoto(index: number, destination: Vector3): void;
  126915. /**
  126916. * remove a particular agent previously created
  126917. * @param index agent index returned by addAgent
  126918. */
  126919. removeAgent(index: number): void;
  126920. /**
  126921. * get the list of all agents attached to this crowd
  126922. * @returns list of agent indices
  126923. */
  126924. getAgents(): number[];
  126925. /**
  126926. * Tick update done by the Scene. Agent position/velocity/acceleration is updated by this function
  126927. * @param deltaTime in seconds
  126928. */
  126929. update(deltaTime: number): void;
  126930. /**
  126931. * Set the Bounding box extent for doing spatial queries (getClosestPoint, getRandomPointAround, ...)
  126932. * The queries will try to find a solution within those bounds
  126933. * default is (1,1,1)
  126934. * @param extent x,y,z value that define the extent around the queries point of reference
  126935. */
  126936. setDefaultQueryExtent(extent: Vector3): void;
  126937. /**
  126938. * Get the Bounding box extent specified by setDefaultQueryExtent
  126939. * @returns the box extent values
  126940. */
  126941. getDefaultQueryExtent(): Vector3;
  126942. /**
  126943. * Release all resources
  126944. */
  126945. dispose(): void;
  126946. }
  126947. }
  126948. declare module BABYLON {
  126949. /**
  126950. * Class used to enable access to IndexedDB
  126951. * @see http://doc.babylonjs.com/how_to/caching_resources_in_indexeddb
  126952. */
  126953. export class Database implements IOfflineProvider {
  126954. private _callbackManifestChecked;
  126955. private _currentSceneUrl;
  126956. private _db;
  126957. private _enableSceneOffline;
  126958. private _enableTexturesOffline;
  126959. private _manifestVersionFound;
  126960. private _mustUpdateRessources;
  126961. private _hasReachedQuota;
  126962. private _isSupported;
  126963. private _idbFactory;
  126964. /** Gets a boolean indicating if the user agent supports blob storage (this value will be updated after creating the first Database object) */
  126965. private static IsUASupportingBlobStorage;
  126966. /**
  126967. * Gets a boolean indicating if Database storate is enabled (off by default)
  126968. */
  126969. static IDBStorageEnabled: boolean;
  126970. /**
  126971. * Gets a boolean indicating if scene must be saved in the database
  126972. */
  126973. readonly enableSceneOffline: boolean;
  126974. /**
  126975. * Gets a boolean indicating if textures must be saved in the database
  126976. */
  126977. readonly enableTexturesOffline: boolean;
  126978. /**
  126979. * Creates a new Database
  126980. * @param urlToScene defines the url to load the scene
  126981. * @param callbackManifestChecked defines the callback to use when manifest is checked
  126982. * @param disableManifestCheck defines a boolean indicating that we want to skip the manifest validation (it will be considered validated and up to date)
  126983. */
  126984. constructor(urlToScene: string, callbackManifestChecked: (checked: boolean) => any, disableManifestCheck?: boolean);
  126985. private static _ParseURL;
  126986. private static _ReturnFullUrlLocation;
  126987. private _checkManifestFile;
  126988. /**
  126989. * Open the database and make it available
  126990. * @param successCallback defines the callback to call on success
  126991. * @param errorCallback defines the callback to call on error
  126992. */
  126993. open(successCallback: () => void, errorCallback: () => void): void;
  126994. /**
  126995. * Loads an image from the database
  126996. * @param url defines the url to load from
  126997. * @param image defines the target DOM image
  126998. */
  126999. loadImage(url: string, image: HTMLImageElement): void;
  127000. private _loadImageFromDBAsync;
  127001. private _saveImageIntoDBAsync;
  127002. private _checkVersionFromDB;
  127003. private _loadVersionFromDBAsync;
  127004. private _saveVersionIntoDBAsync;
  127005. /**
  127006. * Loads a file from database
  127007. * @param url defines the URL to load from
  127008. * @param sceneLoaded defines a callback to call on success
  127009. * @param progressCallBack defines a callback to call when progress changed
  127010. * @param errorCallback defines a callback to call on error
  127011. * @param useArrayBuffer defines a boolean to use array buffer instead of text string
  127012. */
  127013. loadFile(url: string, sceneLoaded: (data: any) => void, progressCallBack?: (data: any) => void, errorCallback?: () => void, useArrayBuffer?: boolean): void;
  127014. private _loadFileAsync;
  127015. private _saveFileAsync;
  127016. /**
  127017. * Validates if xhr data is correct
  127018. * @param xhr defines the request to validate
  127019. * @param dataType defines the expected data type
  127020. * @returns true if data is correct
  127021. */
  127022. private static _ValidateXHRData;
  127023. }
  127024. }
  127025. declare module BABYLON {
  127026. /** @hidden */
  127027. export var gpuUpdateParticlesPixelShader: {
  127028. name: string;
  127029. shader: string;
  127030. };
  127031. }
  127032. declare module BABYLON {
  127033. /** @hidden */
  127034. export var gpuUpdateParticlesVertexShader: {
  127035. name: string;
  127036. shader: string;
  127037. };
  127038. }
  127039. declare module BABYLON {
  127040. /** @hidden */
  127041. export var clipPlaneFragmentDeclaration2: {
  127042. name: string;
  127043. shader: string;
  127044. };
  127045. }
  127046. declare module BABYLON {
  127047. /** @hidden */
  127048. export var gpuRenderParticlesPixelShader: {
  127049. name: string;
  127050. shader: string;
  127051. };
  127052. }
  127053. declare module BABYLON {
  127054. /** @hidden */
  127055. export var clipPlaneVertexDeclaration2: {
  127056. name: string;
  127057. shader: string;
  127058. };
  127059. }
  127060. declare module BABYLON {
  127061. /** @hidden */
  127062. export var gpuRenderParticlesVertexShader: {
  127063. name: string;
  127064. shader: string;
  127065. };
  127066. }
  127067. declare module BABYLON {
  127068. /**
  127069. * This represents a GPU particle system in Babylon
  127070. * This is the fastest particle system in Babylon as it uses the GPU to update the individual particle data
  127071. * @see https://www.babylonjs-playground.com/#PU4WYI#4
  127072. */
  127073. export class GPUParticleSystem extends BaseParticleSystem implements IDisposable, IParticleSystem, IAnimatable {
  127074. /**
  127075. * The layer mask we are rendering the particles through.
  127076. */
  127077. layerMask: number;
  127078. private _capacity;
  127079. private _activeCount;
  127080. private _currentActiveCount;
  127081. private _accumulatedCount;
  127082. private _renderEffect;
  127083. private _updateEffect;
  127084. private _buffer0;
  127085. private _buffer1;
  127086. private _spriteBuffer;
  127087. private _updateVAO;
  127088. private _renderVAO;
  127089. private _targetIndex;
  127090. private _sourceBuffer;
  127091. private _targetBuffer;
  127092. private _engine;
  127093. private _currentRenderId;
  127094. private _started;
  127095. private _stopped;
  127096. private _timeDelta;
  127097. private _randomTexture;
  127098. private _randomTexture2;
  127099. private _attributesStrideSize;
  127100. private _updateEffectOptions;
  127101. private _randomTextureSize;
  127102. private _actualFrame;
  127103. private readonly _rawTextureWidth;
  127104. /**
  127105. * Gets a boolean indicating if the GPU particles can be rendered on current browser
  127106. */
  127107. static readonly IsSupported: boolean;
  127108. /**
  127109. * An event triggered when the system is disposed.
  127110. */
  127111. onDisposeObservable: Observable<GPUParticleSystem>;
  127112. /**
  127113. * Gets the maximum number of particles active at the same time.
  127114. * @returns The max number of active particles.
  127115. */
  127116. getCapacity(): number;
  127117. /**
  127118. * Forces the particle to write their depth information to the depth buffer. This can help preventing other draw calls
  127119. * to override the particles.
  127120. */
  127121. forceDepthWrite: boolean;
  127122. /**
  127123. * Gets or set the number of active particles
  127124. */
  127125. activeParticleCount: number;
  127126. private _preWarmDone;
  127127. /**
  127128. * Is this system ready to be used/rendered
  127129. * @return true if the system is ready
  127130. */
  127131. isReady(): boolean;
  127132. /**
  127133. * Gets if the system has been started. (Note: this will still be true after stop is called)
  127134. * @returns True if it has been started, otherwise false.
  127135. */
  127136. isStarted(): boolean;
  127137. /**
  127138. * Starts the particle system and begins to emit
  127139. * @param delay defines the delay in milliseconds before starting the system (this.startDelay by default)
  127140. */
  127141. start(delay?: number): void;
  127142. /**
  127143. * Stops the particle system.
  127144. */
  127145. stop(): void;
  127146. /**
  127147. * Remove all active particles
  127148. */
  127149. reset(): void;
  127150. /**
  127151. * Returns the string "GPUParticleSystem"
  127152. * @returns a string containing the class name
  127153. */
  127154. getClassName(): string;
  127155. private _colorGradientsTexture;
  127156. protected _removeGradientAndTexture(gradient: number, gradients: Nullable<IValueGradient[]>, texture: RawTexture): BaseParticleSystem;
  127157. /**
  127158. * Adds a new color gradient
  127159. * @param gradient defines the gradient to use (between 0 and 1)
  127160. * @param color1 defines the color to affect to the specified gradient
  127161. * @param color2 defines an additional color used to define a range ([color, color2]) with main color to pick the final color from
  127162. * @returns the current particle system
  127163. */
  127164. addColorGradient(gradient: number, color1: Color4, color2?: Color4): GPUParticleSystem;
  127165. /**
  127166. * Remove a specific color gradient
  127167. * @param gradient defines the gradient to remove
  127168. * @returns the current particle system
  127169. */
  127170. removeColorGradient(gradient: number): GPUParticleSystem;
  127171. private _angularSpeedGradientsTexture;
  127172. private _sizeGradientsTexture;
  127173. private _velocityGradientsTexture;
  127174. private _limitVelocityGradientsTexture;
  127175. private _dragGradientsTexture;
  127176. private _addFactorGradient;
  127177. /**
  127178. * Adds a new size gradient
  127179. * @param gradient defines the gradient to use (between 0 and 1)
  127180. * @param factor defines the size factor to affect to the specified gradient
  127181. * @returns the current particle system
  127182. */
  127183. addSizeGradient(gradient: number, factor: number): GPUParticleSystem;
  127184. /**
  127185. * Remove a specific size gradient
  127186. * @param gradient defines the gradient to remove
  127187. * @returns the current particle system
  127188. */
  127189. removeSizeGradient(gradient: number): GPUParticleSystem;
  127190. /**
  127191. * Adds a new angular speed gradient
  127192. * @param gradient defines the gradient to use (between 0 and 1)
  127193. * @param factor defines the angular speed to affect to the specified gradient
  127194. * @returns the current particle system
  127195. */
  127196. addAngularSpeedGradient(gradient: number, factor: number): GPUParticleSystem;
  127197. /**
  127198. * Remove a specific angular speed gradient
  127199. * @param gradient defines the gradient to remove
  127200. * @returns the current particle system
  127201. */
  127202. removeAngularSpeedGradient(gradient: number): GPUParticleSystem;
  127203. /**
  127204. * Adds a new velocity gradient
  127205. * @param gradient defines the gradient to use (between 0 and 1)
  127206. * @param factor defines the velocity to affect to the specified gradient
  127207. * @returns the current particle system
  127208. */
  127209. addVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  127210. /**
  127211. * Remove a specific velocity gradient
  127212. * @param gradient defines the gradient to remove
  127213. * @returns the current particle system
  127214. */
  127215. removeVelocityGradient(gradient: number): GPUParticleSystem;
  127216. /**
  127217. * Adds a new limit velocity gradient
  127218. * @param gradient defines the gradient to use (between 0 and 1)
  127219. * @param factor defines the limit velocity value to affect to the specified gradient
  127220. * @returns the current particle system
  127221. */
  127222. addLimitVelocityGradient(gradient: number, factor: number): GPUParticleSystem;
  127223. /**
  127224. * Remove a specific limit velocity gradient
  127225. * @param gradient defines the gradient to remove
  127226. * @returns the current particle system
  127227. */
  127228. removeLimitVelocityGradient(gradient: number): GPUParticleSystem;
  127229. /**
  127230. * Adds a new drag gradient
  127231. * @param gradient defines the gradient to use (between 0 and 1)
  127232. * @param factor defines the drag value to affect to the specified gradient
  127233. * @returns the current particle system
  127234. */
  127235. addDragGradient(gradient: number, factor: number): GPUParticleSystem;
  127236. /**
  127237. * Remove a specific drag gradient
  127238. * @param gradient defines the gradient to remove
  127239. * @returns the current particle system
  127240. */
  127241. removeDragGradient(gradient: number): GPUParticleSystem;
  127242. /**
  127243. * Not supported by GPUParticleSystem
  127244. * @param gradient defines the gradient to use (between 0 and 1)
  127245. * @param factor defines the emit rate value to affect to the specified gradient
  127246. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  127247. * @returns the current particle system
  127248. */
  127249. addEmitRateGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  127250. /**
  127251. * Not supported by GPUParticleSystem
  127252. * @param gradient defines the gradient to remove
  127253. * @returns the current particle system
  127254. */
  127255. removeEmitRateGradient(gradient: number): IParticleSystem;
  127256. /**
  127257. * Not supported by GPUParticleSystem
  127258. * @param gradient defines the gradient to use (between 0 and 1)
  127259. * @param factor defines the start size value to affect to the specified gradient
  127260. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  127261. * @returns the current particle system
  127262. */
  127263. addStartSizeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  127264. /**
  127265. * Not supported by GPUParticleSystem
  127266. * @param gradient defines the gradient to remove
  127267. * @returns the current particle system
  127268. */
  127269. removeStartSizeGradient(gradient: number): IParticleSystem;
  127270. /**
  127271. * Not supported by GPUParticleSystem
  127272. * @param gradient defines the gradient to use (between 0 and 1)
  127273. * @param min defines the color remap minimal range
  127274. * @param max defines the color remap maximal range
  127275. * @returns the current particle system
  127276. */
  127277. addColorRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  127278. /**
  127279. * Not supported by GPUParticleSystem
  127280. * @param gradient defines the gradient to remove
  127281. * @returns the current particle system
  127282. */
  127283. removeColorRemapGradient(): IParticleSystem;
  127284. /**
  127285. * Not supported by GPUParticleSystem
  127286. * @param gradient defines the gradient to use (between 0 and 1)
  127287. * @param min defines the alpha remap minimal range
  127288. * @param max defines the alpha remap maximal range
  127289. * @returns the current particle system
  127290. */
  127291. addAlphaRemapGradient(gradient: number, min: number, max: number): IParticleSystem;
  127292. /**
  127293. * Not supported by GPUParticleSystem
  127294. * @param gradient defines the gradient to remove
  127295. * @returns the current particle system
  127296. */
  127297. removeAlphaRemapGradient(): IParticleSystem;
  127298. /**
  127299. * Not supported by GPUParticleSystem
  127300. * @param gradient defines the gradient to use (between 0 and 1)
  127301. * @param color defines the color to affect to the specified gradient
  127302. * @returns the current particle system
  127303. */
  127304. addRampGradient(gradient: number, color: Color3): IParticleSystem;
  127305. /**
  127306. * Not supported by GPUParticleSystem
  127307. * @param gradient defines the gradient to remove
  127308. * @returns the current particle system
  127309. */
  127310. removeRampGradient(): IParticleSystem;
  127311. /**
  127312. * Not supported by GPUParticleSystem
  127313. * @returns the list of ramp gradients
  127314. */
  127315. getRampGradients(): Nullable<Array<Color3Gradient>>;
  127316. /**
  127317. * Not supported by GPUParticleSystem
  127318. * Gets or sets a boolean indicating that ramp gradients must be used
  127319. * @see http://doc.babylonjs.com/babylon101/particles#ramp-gradients
  127320. */
  127321. useRampGradients: boolean;
  127322. /**
  127323. * Not supported by GPUParticleSystem
  127324. * @param gradient defines the gradient to use (between 0 and 1)
  127325. * @param factor defines the life time factor to affect to the specified gradient
  127326. * @param factor2 defines an additional factor used to define a range ([factor, factor2]) with main value to pick the final value from
  127327. * @returns the current particle system
  127328. */
  127329. addLifeTimeGradient(gradient: number, factor: number, factor2?: number): IParticleSystem;
  127330. /**
  127331. * Not supported by GPUParticleSystem
  127332. * @param gradient defines the gradient to remove
  127333. * @returns the current particle system
  127334. */
  127335. removeLifeTimeGradient(gradient: number): IParticleSystem;
  127336. /**
  127337. * Instantiates a GPU particle system.
  127338. * 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.
  127339. * @param name The name of the particle system
  127340. * @param options The options used to create the system
  127341. * @param scene The scene the particle system belongs to
  127342. * @param isAnimationSheetEnabled Must be true if using a spritesheet to animate the particles texture
  127343. */
  127344. constructor(name: string, options: Partial<{
  127345. capacity: number;
  127346. randomTextureSize: number;
  127347. }>, scene: Scene, isAnimationSheetEnabled?: boolean);
  127348. protected _reset(): void;
  127349. private _createUpdateVAO;
  127350. private _createRenderVAO;
  127351. private _initialize;
  127352. /** @hidden */
  127353. _recreateUpdateEffect(): void;
  127354. /** @hidden */
  127355. _recreateRenderEffect(): void;
  127356. /**
  127357. * Animates the particle system for the current frame by emitting new particles and or animating the living ones.
  127358. * @param preWarm defines if we are in the pre-warmimg phase
  127359. */
  127360. animate(preWarm?: boolean): void;
  127361. private _createFactorGradientTexture;
  127362. private _createSizeGradientTexture;
  127363. private _createAngularSpeedGradientTexture;
  127364. private _createVelocityGradientTexture;
  127365. private _createLimitVelocityGradientTexture;
  127366. private _createDragGradientTexture;
  127367. private _createColorGradientTexture;
  127368. /**
  127369. * Renders the particle system in its current state
  127370. * @param preWarm defines if the system should only update the particles but not render them
  127371. * @returns the current number of particles
  127372. */
  127373. render(preWarm?: boolean): number;
  127374. /**
  127375. * Rebuilds the particle system
  127376. */
  127377. rebuild(): void;
  127378. private _releaseBuffers;
  127379. private _releaseVAOs;
  127380. /**
  127381. * Disposes the particle system and free the associated resources
  127382. * @param disposeTexture defines if the particule texture must be disposed as well (true by default)
  127383. */
  127384. dispose(disposeTexture?: boolean): void;
  127385. /**
  127386. * Clones the particle system.
  127387. * @param name The name of the cloned object
  127388. * @param newEmitter The new emitter to use
  127389. * @returns the cloned particle system
  127390. */
  127391. clone(name: string, newEmitter: any): GPUParticleSystem;
  127392. /**
  127393. * Serializes the particle system to a JSON object.
  127394. * @returns the JSON object
  127395. */
  127396. serialize(): any;
  127397. /**
  127398. * Parses a JSON object to create a GPU particle system.
  127399. * @param parsedParticleSystem The JSON object to parse
  127400. * @param scene The scene to create the particle system in
  127401. * @param rootUrl The root url to use to load external dependencies like texture
  127402. * @param doNotStart Ignore the preventAutoStart attribute and does not start
  127403. * @returns the parsed GPU particle system
  127404. */
  127405. static Parse(parsedParticleSystem: any, scene: Scene, rootUrl: string, doNotStart?: boolean): GPUParticleSystem;
  127406. }
  127407. }
  127408. declare module BABYLON {
  127409. /**
  127410. * Represents a set of particle systems working together to create a specific effect
  127411. */
  127412. export class ParticleSystemSet implements IDisposable {
  127413. /**
  127414. * Gets or sets base Assets URL
  127415. */
  127416. static BaseAssetsUrl: string;
  127417. private _emitterCreationOptions;
  127418. private _emitterNode;
  127419. /**
  127420. * Gets the particle system list
  127421. */
  127422. systems: IParticleSystem[];
  127423. /**
  127424. * Gets the emitter node used with this set
  127425. */
  127426. readonly emitterNode: Nullable<TransformNode>;
  127427. /**
  127428. * Creates a new emitter mesh as a sphere
  127429. * @param options defines the options used to create the sphere
  127430. * @param renderingGroupId defines the renderingGroupId to use for the sphere
  127431. * @param scene defines the hosting scene
  127432. */
  127433. setEmitterAsSphere(options: {
  127434. diameter: number;
  127435. segments: number;
  127436. color: Color3;
  127437. }, renderingGroupId: number, scene: Scene): void;
  127438. /**
  127439. * Starts all particle systems of the set
  127440. * @param emitter defines an optional mesh to use as emitter for the particle systems
  127441. */
  127442. start(emitter?: AbstractMesh): void;
  127443. /**
  127444. * Release all associated resources
  127445. */
  127446. dispose(): void;
  127447. /**
  127448. * Serialize the set into a JSON compatible object
  127449. * @returns a JSON compatible representation of the set
  127450. */
  127451. serialize(): any;
  127452. /**
  127453. * Parse a new ParticleSystemSet from a serialized source
  127454. * @param data defines a JSON compatible representation of the set
  127455. * @param scene defines the hosting scene
  127456. * @param gpu defines if we want GPU particles or CPU particles
  127457. * @returns a new ParticleSystemSet
  127458. */
  127459. static Parse(data: any, scene: Scene, gpu?: boolean): ParticleSystemSet;
  127460. }
  127461. }
  127462. declare module BABYLON {
  127463. /**
  127464. * This class is made for on one-liner static method to help creating particle system set.
  127465. */
  127466. export class ParticleHelper {
  127467. /**
  127468. * Gets or sets base Assets URL
  127469. */
  127470. static BaseAssetsUrl: string;
  127471. /**
  127472. * Create a default particle system that you can tweak
  127473. * @param emitter defines the emitter to use
  127474. * @param capacity defines the system capacity (default is 500 particles)
  127475. * @param scene defines the hosting scene
  127476. * @param useGPU defines if a GPUParticleSystem must be created (default is false)
  127477. * @returns the new Particle system
  127478. */
  127479. static CreateDefault(emitter: Nullable<AbstractMesh | Vector3>, capacity?: number, scene?: Scene, useGPU?: boolean): IParticleSystem;
  127480. /**
  127481. * This is the main static method (one-liner) of this helper to create different particle systems
  127482. * @param type This string represents the type to the particle system to create
  127483. * @param scene The scene where the particle system should live
  127484. * @param gpu If the system will use gpu
  127485. * @returns the ParticleSystemSet created
  127486. */
  127487. static CreateAsync(type: string, scene: Nullable<Scene>, gpu?: boolean): Promise<ParticleSystemSet>;
  127488. /**
  127489. * Static function used to export a particle system to a ParticleSystemSet variable.
  127490. * Please note that the emitter shape is not exported
  127491. * @param systems defines the particle systems to export
  127492. * @returns the created particle system set
  127493. */
  127494. static ExportSet(systems: IParticleSystem[]): ParticleSystemSet;
  127495. }
  127496. }
  127497. declare module BABYLON {
  127498. interface Engine {
  127499. /**
  127500. * Create an effect to use with particle systems.
  127501. * Please note that some parameters like animation sheets or not being billboard are not supported in this configuration
  127502. * @param fragmentName defines the base name of the effect (The name of file without .fragment.fx)
  127503. * @param uniformsNames defines a list of attribute names
  127504. * @param samplers defines an array of string used to represent textures
  127505. * @param defines defines the string containing the defines to use to compile the shaders
  127506. * @param fallbacks defines the list of potential fallbacks to use if shader conmpilation fails
  127507. * @param onCompiled defines a function to call when the effect creation is successful
  127508. * @param onError defines a function to call when the effect creation has failed
  127509. * @returns the new Effect
  127510. */
  127511. createEffectForParticles(fragmentName: string, uniformsNames: string[], samplers: string[], defines: string, fallbacks?: EffectFallbacks, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): Effect;
  127512. }
  127513. interface Mesh {
  127514. /**
  127515. * Returns an array populated with IParticleSystem objects whose the mesh is the emitter
  127516. * @returns an array of IParticleSystem
  127517. */
  127518. getEmittedParticleSystems(): IParticleSystem[];
  127519. /**
  127520. * Returns an array populated with IParticleSystem objects whose the mesh or its children are the emitter
  127521. * @returns an array of IParticleSystem
  127522. */
  127523. getHierarchyEmittedParticleSystems(): IParticleSystem[];
  127524. }
  127525. /**
  127526. * @hidden
  127527. */
  127528. export var _IDoNeedToBeInTheBuild: number;
  127529. }
  127530. declare module BABYLON {
  127531. /** Defines the 4 color options */
  127532. export enum PointColor {
  127533. /** color value */
  127534. Color = 2,
  127535. /** uv value */
  127536. UV = 1,
  127537. /** random value */
  127538. Random = 0,
  127539. /** stated value */
  127540. Stated = 3
  127541. }
  127542. /**
  127543. * The PointCloudSystem (PCS) is a single updatable mesh. The points corresponding to the vertices of this big mesh.
  127544. * 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.
  127545. * The PointCloudSytem is also a particle system, with each point being a particle. It provides some methods to manage the particles.
  127546. * However it is behavior agnostic. This means it has no emitter, no particle physics, no particle recycler. You have to implement your own behavior.
  127547. *
  127548. * Full documentation here : TO BE ENTERED
  127549. */
  127550. export class PointsCloudSystem implements IDisposable {
  127551. /**
  127552. * The PCS array of cloud point objects. Just access each particle as with any classic array.
  127553. * Example : var p = SPS.particles[i];
  127554. */
  127555. particles: CloudPoint[];
  127556. /**
  127557. * The PCS total number of particles. Read only. Use PCS.counter instead if you need to set your own value.
  127558. */
  127559. nbParticles: number;
  127560. /**
  127561. * This a counter for your own usage. It's not set by any SPS functions.
  127562. */
  127563. counter: number;
  127564. /**
  127565. * The PCS name. This name is also given to the underlying mesh.
  127566. */
  127567. name: string;
  127568. /**
  127569. * The PCS mesh. It's a standard BJS Mesh, so all the methods from the Mesh class are avalaible.
  127570. */
  127571. mesh: Mesh;
  127572. /**
  127573. * This empty object is intended to store some PCS specific or temporary values in order to lower the Garbage Collector activity.
  127574. * Please read :
  127575. */
  127576. vars: any;
  127577. /**
  127578. * @hidden
  127579. */
  127580. _size: number;
  127581. private _scene;
  127582. private _promises;
  127583. private _positions;
  127584. private _indices;
  127585. private _normals;
  127586. private _colors;
  127587. private _uvs;
  127588. private _indices32;
  127589. private _positions32;
  127590. private _colors32;
  127591. private _uvs32;
  127592. private _updatable;
  127593. private _isVisibilityBoxLocked;
  127594. private _alwaysVisible;
  127595. private _groups;
  127596. private _groupCounter;
  127597. private _computeParticleColor;
  127598. private _computeParticleTexture;
  127599. private _computeParticleRotation;
  127600. private _computeBoundingBox;
  127601. private _isReady;
  127602. /**
  127603. * Creates a PCS (Points Cloud System) object
  127604. * @param name (String) is the PCS name, this will be the underlying mesh name
  127605. * @param pointSize (number) is the size for each point
  127606. * @param scene (Scene) is the scene in which the PCS is added
  127607. * @param options defines the options of the PCS e.g.
  127608. * * updatable (optional boolean, default true) : if the PCS must be updatable or immutable
  127609. */
  127610. constructor(name: string, pointSize: number, scene: Scene, options?: {
  127611. updatable?: boolean;
  127612. });
  127613. /**
  127614. * Builds the PCS underlying mesh. Returns a standard Mesh.
  127615. * If no points were added to the PCS, the returned mesh is just a single point.
  127616. * @returns a promise for the created mesh
  127617. */
  127618. buildMeshAsync(): Promise<Mesh>;
  127619. /**
  127620. * @hidden
  127621. */
  127622. private _buildMesh;
  127623. private _addParticle;
  127624. private _randomUnitVector;
  127625. private _getColorIndicesForCoord;
  127626. private _setPointsColorOrUV;
  127627. private _colorFromTexture;
  127628. private _calculateDensity;
  127629. /**
  127630. * Adds points to the PCS in random positions within a unit sphere
  127631. * @param nb (positive integer) the number of particles to be created from this model
  127632. * @param pointFunction is an optional javascript function to be called for each particle on PCS creation
  127633. * @returns the number of groups in the system
  127634. */
  127635. addPoints(nb: number, pointFunction?: any): number;
  127636. /**
  127637. * Adds points to the PCS from the surface of the model shape
  127638. * @param mesh is any Mesh object that will be used as a surface model for the points
  127639. * @param nb (positive integer) the number of particles to be created from this model
  127640. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  127641. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  127642. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  127643. * @returns the number of groups in the system
  127644. */
  127645. addSurfacePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  127646. /**
  127647. * Adds points to the PCS inside the model shape
  127648. * @param mesh is any Mesh object that will be used as a surface model for the points
  127649. * @param nb (positive integer) the number of particles to be created from this model
  127650. * @param colorWith determines whether a point is colored using color (default), uv, random, stated or none (invisible)
  127651. * @param color (color4) to be used when colorWith is stated or color (number) when used to specify texture position
  127652. * @param range (number from 0 to 1) to determine the variation in shape and tone for a stated color
  127653. * @returns the number of groups in the system
  127654. */
  127655. addVolumePoints(mesh: Mesh, nb: number, colorWith?: number, color?: Color4 | number, range?: number): number;
  127656. /**
  127657. * Sets all the particles : this method actually really updates the mesh according to the particle positions, rotations, colors, textures, etc.
  127658. * This method calls `updateParticle()` for each particle of the SPS.
  127659. * For an animated SPS, it is usually called within the render loop.
  127660. * @param start The particle index in the particle array where to start to compute the particle property values _(default 0)_
  127661. * @param end The particle index in the particle array where to stop to compute the particle property values _(default nbParticle - 1)_
  127662. * @param update If the mesh must be finally updated on this call after all the particle computations _(default true)_
  127663. * @returns the PCS.
  127664. */
  127665. setParticles(start?: number, end?: number, update?: boolean): PointsCloudSystem;
  127666. /**
  127667. * Disposes the PCS.
  127668. */
  127669. dispose(): void;
  127670. /**
  127671. * Visibilty helper : Recomputes the visible size according to the mesh bounding box
  127672. * doc :
  127673. * @returns the PCS.
  127674. */
  127675. refreshVisibleSize(): PointsCloudSystem;
  127676. /**
  127677. * Visibility helper : Sets the size of a visibility box, this sets the underlying mesh bounding box.
  127678. * @param size the size (float) of the visibility box
  127679. * note : this doesn't lock the PCS mesh bounding box.
  127680. * doc :
  127681. */
  127682. setVisibilityBox(size: number): void;
  127683. /**
  127684. * Gets whether the PCS is always visible or not
  127685. * doc :
  127686. */
  127687. /**
  127688. * Sets the PCS as always visible or not
  127689. * doc :
  127690. */
  127691. isAlwaysVisible: boolean;
  127692. /**
  127693. * Tells to `setParticles()` to compute the particle rotations or not
  127694. * Default value : false. The PCS is faster when it's set to false
  127695. * Note : particle rotations are only applied to parent particles
  127696. * Note : the particle rotations aren't stored values, so setting `computeParticleRotation` to false will prevents the particle to rotate
  127697. */
  127698. computeParticleRotation: boolean;
  127699. /**
  127700. * Tells to `setParticles()` to compute the particle colors or not.
  127701. * Default value : true. The PCS is faster when it's set to false.
  127702. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  127703. */
  127704. /**
  127705. * Gets if `setParticles()` computes the particle colors or not.
  127706. * Default value : false. The PCS is faster when it's set to false.
  127707. * Note : the particle colors are stored values, so setting `computeParticleColor` to false will keep yet the last colors set.
  127708. */
  127709. computeParticleColor: boolean;
  127710. /**
  127711. * Gets if `setParticles()` computes the particle textures or not.
  127712. * Default value : false. The PCS is faster when it's set to false.
  127713. * Note : the particle textures are stored values, so setting `computeParticleTexture` to false will keep yet the last colors set.
  127714. */
  127715. computeParticleTexture: boolean;
  127716. /**
  127717. * Tells to `setParticles()` to compute or not the mesh bounding box when computing the particle positions.
  127718. */
  127719. /**
  127720. * Gets if `setParticles()` computes or not the mesh bounding box when computing the particle positions.
  127721. */
  127722. computeBoundingBox: boolean;
  127723. /**
  127724. * This function does nothing. It may be overwritten to set all the particle first values.
  127725. * The PCS doesn't call this function, you may have to call it by your own.
  127726. * doc :
  127727. */
  127728. initParticles(): void;
  127729. /**
  127730. * This function does nothing. It may be overwritten to recycle a particle
  127731. * The PCS doesn't call this function, you can to call it
  127732. * doc :
  127733. * @param particle The particle to recycle
  127734. * @returns the recycled particle
  127735. */
  127736. recycleParticle(particle: CloudPoint): CloudPoint;
  127737. /**
  127738. * Updates a particle : this function should be overwritten by the user.
  127739. * It is called on each particle by `setParticles()`. This is the place to code each particle behavior.
  127740. * doc :
  127741. * @example : just set a particle position or velocity and recycle conditions
  127742. * @param particle The particle to update
  127743. * @returns the updated particle
  127744. */
  127745. updateParticle(particle: CloudPoint): CloudPoint;
  127746. /**
  127747. * This will be called before any other treatment by `setParticles()` and will be passed three parameters.
  127748. * This does nothing and may be overwritten by the user.
  127749. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  127750. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  127751. * @param update the boolean update value actually passed to setParticles()
  127752. */
  127753. beforeUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  127754. /**
  127755. * This will be called by `setParticles()` after all the other treatments and just before the actual mesh update.
  127756. * This will be passed three parameters.
  127757. * This does nothing and may be overwritten by the user.
  127758. * @param start the particle index in the particle array where to start to iterate, same than the value passed to setParticle()
  127759. * @param stop the particle index in the particle array where to stop to iterate, same than the value passed to setParticle()
  127760. * @param update the boolean update value actually passed to setParticles()
  127761. */
  127762. afterUpdateParticles(start?: number, stop?: number, update?: boolean): void;
  127763. }
  127764. }
  127765. declare module BABYLON {
  127766. /**
  127767. * Represents one particle of a points cloud system.
  127768. */
  127769. export class CloudPoint {
  127770. /**
  127771. * particle global index
  127772. */
  127773. idx: number;
  127774. /**
  127775. * The color of the particle
  127776. */
  127777. color: Nullable<Color4>;
  127778. /**
  127779. * The world space position of the particle.
  127780. */
  127781. position: Vector3;
  127782. /**
  127783. * The world space rotation of the particle. (Not use if rotationQuaternion is set)
  127784. */
  127785. rotation: Vector3;
  127786. /**
  127787. * The world space rotation quaternion of the particle.
  127788. */
  127789. rotationQuaternion: Nullable<Quaternion>;
  127790. /**
  127791. * The uv of the particle.
  127792. */
  127793. uv: Nullable<Vector2>;
  127794. /**
  127795. * The current speed of the particle.
  127796. */
  127797. velocity: Vector3;
  127798. /**
  127799. * The pivot point in the particle local space.
  127800. */
  127801. pivot: Vector3;
  127802. /**
  127803. * Must the particle be translated from its pivot point in its local space ?
  127804. * In this case, the pivot point is set at the origin of the particle local space and the particle is translated.
  127805. * Default : false
  127806. */
  127807. translateFromPivot: boolean;
  127808. /**
  127809. * Index of this particle in the global "positions" array (Internal use)
  127810. * @hidden
  127811. */
  127812. _pos: number;
  127813. /**
  127814. * @hidden Index of this particle in the global "indices" array (Internal use)
  127815. */
  127816. _ind: number;
  127817. /**
  127818. * Group this particle belongs to
  127819. */
  127820. _group: PointsGroup;
  127821. /**
  127822. * Group id of this particle
  127823. */
  127824. groupId: number;
  127825. /**
  127826. * Index of the particle in its group id (Internal use)
  127827. */
  127828. idxInGroup: number;
  127829. /**
  127830. * @hidden Particle BoundingInfo object (Internal use)
  127831. */
  127832. _boundingInfo: BoundingInfo;
  127833. /**
  127834. * @hidden Reference to the PCS that the particle belongs to (Internal use)
  127835. */
  127836. _pcs: PointsCloudSystem;
  127837. /**
  127838. * @hidden Still set as invisible in order to skip useless computations (Internal use)
  127839. */
  127840. _stillInvisible: boolean;
  127841. /**
  127842. * @hidden Last computed particle rotation matrix
  127843. */
  127844. _rotationMatrix: number[];
  127845. /**
  127846. * Parent particle Id, if any.
  127847. * Default null.
  127848. */
  127849. parentId: Nullable<number>;
  127850. /**
  127851. * @hidden Internal global position in the PCS.
  127852. */
  127853. _globalPosition: Vector3;
  127854. /**
  127855. * Creates a Point Cloud object.
  127856. * Don't create particles manually, use instead the PCS internal tools like _addParticle()
  127857. * @param particleIndex (integer) is the particle index in the PCS pool. It's also the particle identifier.
  127858. * @param group (PointsGroup) is the group the particle belongs to
  127859. * @param groupId (integer) is the group identifier in the PCS.
  127860. * @param idxInGroup (integer) is the index of the particle in the current point group (ex: the 10th point of addPoints(30))
  127861. * @param pcs defines the PCS it is associated to
  127862. */
  127863. constructor(particleIndex: number, group: PointsGroup, groupId: number, idxInGroup: number, pcs: PointsCloudSystem);
  127864. /**
  127865. * get point size
  127866. */
  127867. /**
  127868. * Set point size
  127869. */
  127870. size: Vector3;
  127871. /**
  127872. * Legacy support, changed quaternion to rotationQuaternion
  127873. */
  127874. /**
  127875. * Legacy support, changed quaternion to rotationQuaternion
  127876. */
  127877. quaternion: Nullable<Quaternion>;
  127878. /**
  127879. * Returns a boolean. True if the particle intersects a mesh, else false
  127880. * The intersection is computed on the particle position and Axis Aligned Bounding Box (AABB) or Sphere
  127881. * @param target is the object (point or mesh) what the intersection is computed against
  127882. * @param isSphere is boolean flag when false (default) bounding box of mesh is used, when true the bouding sphere is used
  127883. * @returns true if it intersects
  127884. */
  127885. intersectsMesh(target: Mesh, isSphere: boolean): boolean;
  127886. /**
  127887. * get the rotation matrix of the particle
  127888. * @hidden
  127889. */
  127890. getRotationMatrix(m: Matrix): void;
  127891. }
  127892. /**
  127893. * Represents a group of points in a points cloud system
  127894. * * PCS internal tool, don't use it manually.
  127895. */
  127896. export class PointsGroup {
  127897. /**
  127898. * The group id
  127899. * @hidden
  127900. */
  127901. groupID: number;
  127902. /**
  127903. * image data for group (internal use)
  127904. * @hidden
  127905. */
  127906. _groupImageData: Nullable<ArrayBufferView>;
  127907. /**
  127908. * Image Width (internal use)
  127909. * @hidden
  127910. */
  127911. _groupImgWidth: number;
  127912. /**
  127913. * Image Height (internal use)
  127914. * @hidden
  127915. */
  127916. _groupImgHeight: number;
  127917. /**
  127918. * Custom position function (internal use)
  127919. * @hidden
  127920. */
  127921. _positionFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>;
  127922. /**
  127923. * density per facet for surface points
  127924. * @hidden
  127925. */
  127926. _groupDensity: number[];
  127927. /**
  127928. * Only when points are colored by texture carries pointer to texture list array
  127929. * @hidden
  127930. */
  127931. _textureNb: number;
  127932. /**
  127933. * Creates a points group object. This is an internal reference to produce particles for the PCS.
  127934. * PCS internal tool, don't use it manually.
  127935. * @hidden
  127936. */
  127937. constructor(id: number, posFunction: Nullable<(particle: CloudPoint, i?: number, s?: number) => void>);
  127938. }
  127939. }
  127940. declare module BABYLON {
  127941. interface Scene {
  127942. /** @hidden (Backing field) */
  127943. _physicsEngine: Nullable<IPhysicsEngine>;
  127944. /**
  127945. * Gets the current physics engine
  127946. * @returns a IPhysicsEngine or null if none attached
  127947. */
  127948. getPhysicsEngine(): Nullable<IPhysicsEngine>;
  127949. /**
  127950. * Enables physics to the current scene
  127951. * @param gravity defines the scene's gravity for the physics engine
  127952. * @param plugin defines the physics engine to be used. defaults to OimoJS.
  127953. * @return a boolean indicating if the physics engine was initialized
  127954. */
  127955. enablePhysics(gravity: Nullable<Vector3>, plugin?: IPhysicsEnginePlugin): boolean;
  127956. /**
  127957. * Disables and disposes the physics engine associated with the scene
  127958. */
  127959. disablePhysicsEngine(): void;
  127960. /**
  127961. * Gets a boolean indicating if there is an active physics engine
  127962. * @returns a boolean indicating if there is an active physics engine
  127963. */
  127964. isPhysicsEnabled(): boolean;
  127965. /**
  127966. * Deletes a physics compound impostor
  127967. * @param compound defines the compound to delete
  127968. */
  127969. deleteCompoundImpostor(compound: any): void;
  127970. /**
  127971. * An event triggered when physic simulation is about to be run
  127972. */
  127973. onBeforePhysicsObservable: Observable<Scene>;
  127974. /**
  127975. * An event triggered when physic simulation has been done
  127976. */
  127977. onAfterPhysicsObservable: Observable<Scene>;
  127978. }
  127979. interface AbstractMesh {
  127980. /** @hidden */
  127981. _physicsImpostor: Nullable<PhysicsImpostor>;
  127982. /**
  127983. * Gets or sets impostor used for physic simulation
  127984. * @see http://doc.babylonjs.com/features/physics_engine
  127985. */
  127986. physicsImpostor: Nullable<PhysicsImpostor>;
  127987. /**
  127988. * Gets the current physics impostor
  127989. * @see http://doc.babylonjs.com/features/physics_engine
  127990. * @returns a physics impostor or null
  127991. */
  127992. getPhysicsImpostor(): Nullable<PhysicsImpostor>;
  127993. /** Apply a physic impulse to the mesh
  127994. * @param force defines the force to apply
  127995. * @param contactPoint defines where to apply the force
  127996. * @returns the current mesh
  127997. * @see http://doc.babylonjs.com/how_to/using_the_physics_engine
  127998. */
  127999. applyImpulse(force: Vector3, contactPoint: Vector3): AbstractMesh;
  128000. /**
  128001. * Creates a physic joint between two meshes
  128002. * @param otherMesh defines the other mesh to use
  128003. * @param pivot1 defines the pivot to use on this mesh
  128004. * @param pivot2 defines the pivot to use on the other mesh
  128005. * @param options defines additional options (can be plugin dependent)
  128006. * @returns the current mesh
  128007. * @see https://www.babylonjs-playground.com/#0BS5U0#0
  128008. */
  128009. setPhysicsLinkWith(otherMesh: Mesh, pivot1: Vector3, pivot2: Vector3, options?: any): AbstractMesh;
  128010. /** @hidden */
  128011. _disposePhysicsObserver: Nullable<Observer<Node>>;
  128012. }
  128013. /**
  128014. * Defines the physics engine scene component responsible to manage a physics engine
  128015. */
  128016. export class PhysicsEngineSceneComponent implements ISceneComponent {
  128017. /**
  128018. * The component name helpful to identify the component in the list of scene components.
  128019. */
  128020. readonly name: string;
  128021. /**
  128022. * The scene the component belongs to.
  128023. */
  128024. scene: Scene;
  128025. /**
  128026. * Creates a new instance of the component for the given scene
  128027. * @param scene Defines the scene to register the component in
  128028. */
  128029. constructor(scene: Scene);
  128030. /**
  128031. * Registers the component in a given scene
  128032. */
  128033. register(): void;
  128034. /**
  128035. * Rebuilds the elements related to this component in case of
  128036. * context lost for instance.
  128037. */
  128038. rebuild(): void;
  128039. /**
  128040. * Disposes the component and the associated ressources
  128041. */
  128042. dispose(): void;
  128043. }
  128044. }
  128045. declare module BABYLON {
  128046. /**
  128047. * A helper for physics simulations
  128048. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  128049. */
  128050. export class PhysicsHelper {
  128051. private _scene;
  128052. private _physicsEngine;
  128053. /**
  128054. * Initializes the Physics helper
  128055. * @param scene Babylon.js scene
  128056. */
  128057. constructor(scene: Scene);
  128058. /**
  128059. * Applies a radial explosion impulse
  128060. * @param origin the origin of the explosion
  128061. * @param radiusOrEventOptions the radius or the options of radial explosion
  128062. * @param strength the explosion strength
  128063. * @param falloff possible options: Constant & Linear. Defaults to Constant
  128064. * @returns A physics radial explosion event, or null
  128065. */
  128066. applyRadialExplosionImpulse(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  128067. /**
  128068. * Applies a radial explosion force
  128069. * @param origin the origin of the explosion
  128070. * @param radiusOrEventOptions the radius or the options of radial explosion
  128071. * @param strength the explosion strength
  128072. * @param falloff possible options: Constant & Linear. Defaults to Constant
  128073. * @returns A physics radial explosion event, or null
  128074. */
  128075. applyRadialExplosionForce(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsRadialExplosionEvent>;
  128076. /**
  128077. * Creates a gravitational field
  128078. * @param origin the origin of the explosion
  128079. * @param radiusOrEventOptions the radius or the options of radial explosion
  128080. * @param strength the explosion strength
  128081. * @param falloff possible options: Constant & Linear. Defaults to Constant
  128082. * @returns A physics gravitational field event, or null
  128083. */
  128084. gravitationalField(origin: Vector3, radiusOrEventOptions: number | PhysicsRadialExplosionEventOptions, strength?: number, falloff?: PhysicsRadialImpulseFalloff): Nullable<PhysicsGravitationalFieldEvent>;
  128085. /**
  128086. * Creates a physics updraft event
  128087. * @param origin the origin of the updraft
  128088. * @param radiusOrEventOptions the radius or the options of the updraft
  128089. * @param strength the strength of the updraft
  128090. * @param height the height of the updraft
  128091. * @param updraftMode possible options: Center & Perpendicular. Defaults to Center
  128092. * @returns A physics updraft event, or null
  128093. */
  128094. updraft(origin: Vector3, radiusOrEventOptions: number | PhysicsUpdraftEventOptions, strength?: number, height?: number, updraftMode?: PhysicsUpdraftMode): Nullable<PhysicsUpdraftEvent>;
  128095. /**
  128096. * Creates a physics vortex event
  128097. * @param origin the of the vortex
  128098. * @param radiusOrEventOptions the radius or the options of the vortex
  128099. * @param strength the strength of the vortex
  128100. * @param height the height of the vortex
  128101. * @returns a Physics vortex event, or null
  128102. * A physics vortex event or null
  128103. */
  128104. vortex(origin: Vector3, radiusOrEventOptions: number | PhysicsVortexEventOptions, strength?: number, height?: number): Nullable<PhysicsVortexEvent>;
  128105. }
  128106. /**
  128107. * Represents a physics radial explosion event
  128108. */
  128109. class PhysicsRadialExplosionEvent {
  128110. private _scene;
  128111. private _options;
  128112. private _sphere;
  128113. private _dataFetched;
  128114. /**
  128115. * Initializes a radial explosioin event
  128116. * @param _scene BabylonJS scene
  128117. * @param _options The options for the vortex event
  128118. */
  128119. constructor(_scene: Scene, _options: PhysicsRadialExplosionEventOptions);
  128120. /**
  128121. * Returns the data related to the radial explosion event (sphere).
  128122. * @returns The radial explosion event data
  128123. */
  128124. getData(): PhysicsRadialExplosionEventData;
  128125. /**
  128126. * Returns the force and contact point of the impostor or false, if the impostor is not affected by the force/impulse.
  128127. * @param impostor A physics imposter
  128128. * @param origin the origin of the explosion
  128129. * @returns {Nullable<PhysicsHitData>} A physics force and contact point, or null
  128130. */
  128131. getImpostorHitData(impostor: PhysicsImpostor, origin: Vector3): Nullable<PhysicsHitData>;
  128132. /**
  128133. * Triggers affecterd impostors callbacks
  128134. * @param affectedImpostorsWithData defines the list of affected impostors (including associated data)
  128135. */
  128136. triggerAffectedImpostorsCallback(affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>): void;
  128137. /**
  128138. * Disposes the sphere.
  128139. * @param force Specifies if the sphere should be disposed by force
  128140. */
  128141. dispose(force?: boolean): void;
  128142. /*** Helpers ***/
  128143. private _prepareSphere;
  128144. private _intersectsWithSphere;
  128145. }
  128146. /**
  128147. * Represents a gravitational field event
  128148. */
  128149. class PhysicsGravitationalFieldEvent {
  128150. private _physicsHelper;
  128151. private _scene;
  128152. private _origin;
  128153. private _options;
  128154. private _tickCallback;
  128155. private _sphere;
  128156. private _dataFetched;
  128157. /**
  128158. * Initializes the physics gravitational field event
  128159. * @param _physicsHelper A physics helper
  128160. * @param _scene BabylonJS scene
  128161. * @param _origin The origin position of the gravitational field event
  128162. * @param _options The options for the vortex event
  128163. */
  128164. constructor(_physicsHelper: PhysicsHelper, _scene: Scene, _origin: Vector3, _options: PhysicsRadialExplosionEventOptions);
  128165. /**
  128166. * Returns the data related to the gravitational field event (sphere).
  128167. * @returns A gravitational field event
  128168. */
  128169. getData(): PhysicsGravitationalFieldEventData;
  128170. /**
  128171. * Enables the gravitational field.
  128172. */
  128173. enable(): void;
  128174. /**
  128175. * Disables the gravitational field.
  128176. */
  128177. disable(): void;
  128178. /**
  128179. * Disposes the sphere.
  128180. * @param force The force to dispose from the gravitational field event
  128181. */
  128182. dispose(force?: boolean): void;
  128183. private _tick;
  128184. }
  128185. /**
  128186. * Represents a physics updraft event
  128187. */
  128188. class PhysicsUpdraftEvent {
  128189. private _scene;
  128190. private _origin;
  128191. private _options;
  128192. private _physicsEngine;
  128193. private _originTop;
  128194. private _originDirection;
  128195. private _tickCallback;
  128196. private _cylinder;
  128197. private _cylinderPosition;
  128198. private _dataFetched;
  128199. /**
  128200. * Initializes the physics updraft event
  128201. * @param _scene BabylonJS scene
  128202. * @param _origin The origin position of the updraft
  128203. * @param _options The options for the updraft event
  128204. */
  128205. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsUpdraftEventOptions);
  128206. /**
  128207. * Returns the data related to the updraft event (cylinder).
  128208. * @returns A physics updraft event
  128209. */
  128210. getData(): PhysicsUpdraftEventData;
  128211. /**
  128212. * Enables the updraft.
  128213. */
  128214. enable(): void;
  128215. /**
  128216. * Disables the updraft.
  128217. */
  128218. disable(): void;
  128219. /**
  128220. * Disposes the cylinder.
  128221. * @param force Specifies if the updraft should be disposed by force
  128222. */
  128223. dispose(force?: boolean): void;
  128224. private getImpostorHitData;
  128225. private _tick;
  128226. /*** Helpers ***/
  128227. private _prepareCylinder;
  128228. private _intersectsWithCylinder;
  128229. }
  128230. /**
  128231. * Represents a physics vortex event
  128232. */
  128233. class PhysicsVortexEvent {
  128234. private _scene;
  128235. private _origin;
  128236. private _options;
  128237. private _physicsEngine;
  128238. private _originTop;
  128239. private _tickCallback;
  128240. private _cylinder;
  128241. private _cylinderPosition;
  128242. private _dataFetched;
  128243. /**
  128244. * Initializes the physics vortex event
  128245. * @param _scene The BabylonJS scene
  128246. * @param _origin The origin position of the vortex
  128247. * @param _options The options for the vortex event
  128248. */
  128249. constructor(_scene: Scene, _origin: Vector3, _options: PhysicsVortexEventOptions);
  128250. /**
  128251. * Returns the data related to the vortex event (cylinder).
  128252. * @returns The physics vortex event data
  128253. */
  128254. getData(): PhysicsVortexEventData;
  128255. /**
  128256. * Enables the vortex.
  128257. */
  128258. enable(): void;
  128259. /**
  128260. * Disables the cortex.
  128261. */
  128262. disable(): void;
  128263. /**
  128264. * Disposes the sphere.
  128265. * @param force
  128266. */
  128267. dispose(force?: boolean): void;
  128268. private getImpostorHitData;
  128269. private _tick;
  128270. /*** Helpers ***/
  128271. private _prepareCylinder;
  128272. private _intersectsWithCylinder;
  128273. }
  128274. /**
  128275. * Options fot the radial explosion event
  128276. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  128277. */
  128278. export class PhysicsRadialExplosionEventOptions {
  128279. /**
  128280. * The radius of the sphere for the radial explosion.
  128281. */
  128282. radius: number;
  128283. /**
  128284. * The strenth of the explosion.
  128285. */
  128286. strength: number;
  128287. /**
  128288. * The strenght of the force in correspondence to the distance of the affected object
  128289. */
  128290. falloff: PhysicsRadialImpulseFalloff;
  128291. /**
  128292. * Sphere options for the radial explosion.
  128293. */
  128294. sphere: {
  128295. segments: number;
  128296. diameter: number;
  128297. };
  128298. /**
  128299. * Sphere options for the radial explosion.
  128300. */
  128301. affectedImpostorsCallback: (affectedImpostorsWithData: Array<PhysicsAffectedImpostorWithData>) => void;
  128302. }
  128303. /**
  128304. * Options fot the updraft event
  128305. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  128306. */
  128307. export class PhysicsUpdraftEventOptions {
  128308. /**
  128309. * The radius of the cylinder for the vortex
  128310. */
  128311. radius: number;
  128312. /**
  128313. * The strenth of the updraft.
  128314. */
  128315. strength: number;
  128316. /**
  128317. * The height of the cylinder for the updraft.
  128318. */
  128319. height: number;
  128320. /**
  128321. * The mode for the the updraft.
  128322. */
  128323. updraftMode: PhysicsUpdraftMode;
  128324. }
  128325. /**
  128326. * Options fot the vortex event
  128327. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  128328. */
  128329. export class PhysicsVortexEventOptions {
  128330. /**
  128331. * The radius of the cylinder for the vortex
  128332. */
  128333. radius: number;
  128334. /**
  128335. * The strenth of the vortex.
  128336. */
  128337. strength: number;
  128338. /**
  128339. * The height of the cylinder for the vortex.
  128340. */
  128341. height: number;
  128342. /**
  128343. * At which distance, relative to the radius the centripetal forces should kick in? Range: 0-1
  128344. */
  128345. centripetalForceThreshold: number;
  128346. /**
  128347. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when below the treshold.
  128348. */
  128349. centripetalForceMultiplier: number;
  128350. /**
  128351. * This multiplier determines with how much force the objects will be pushed sideways/around the vortex, when above the treshold.
  128352. */
  128353. centrifugalForceMultiplier: number;
  128354. /**
  128355. * This multiplier determines with how much force the objects will be pushed upwards, when in the vortex.
  128356. */
  128357. updraftForceMultiplier: number;
  128358. }
  128359. /**
  128360. * The strenght of the force in correspondence to the distance of the affected object
  128361. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  128362. */
  128363. export enum PhysicsRadialImpulseFalloff {
  128364. /** Defines that impulse is constant in strength across it's whole radius */
  128365. Constant = 0,
  128366. /** Defines that impulse gets weaker if it's further from the origin */
  128367. Linear = 1
  128368. }
  128369. /**
  128370. * The strength of the force in correspondence to the distance of the affected object
  128371. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  128372. */
  128373. export enum PhysicsUpdraftMode {
  128374. /** Defines that the upstream forces will pull towards the top center of the cylinder */
  128375. Center = 0,
  128376. /** Defines that once a impostor is inside the cylinder, it will shoot out perpendicular from the ground of the cylinder */
  128377. Perpendicular = 1
  128378. }
  128379. /**
  128380. * Interface for a physics hit data
  128381. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  128382. */
  128383. export interface PhysicsHitData {
  128384. /**
  128385. * The force applied at the contact point
  128386. */
  128387. force: Vector3;
  128388. /**
  128389. * The contact point
  128390. */
  128391. contactPoint: Vector3;
  128392. /**
  128393. * The distance from the origin to the contact point
  128394. */
  128395. distanceFromOrigin: number;
  128396. }
  128397. /**
  128398. * Interface for radial explosion event data
  128399. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  128400. */
  128401. export interface PhysicsRadialExplosionEventData {
  128402. /**
  128403. * A sphere used for the radial explosion event
  128404. */
  128405. sphere: Mesh;
  128406. }
  128407. /**
  128408. * Interface for gravitational field event data
  128409. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  128410. */
  128411. export interface PhysicsGravitationalFieldEventData {
  128412. /**
  128413. * A sphere mesh used for the gravitational field event
  128414. */
  128415. sphere: Mesh;
  128416. }
  128417. /**
  128418. * Interface for updraft event data
  128419. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  128420. */
  128421. export interface PhysicsUpdraftEventData {
  128422. /**
  128423. * A cylinder used for the updraft event
  128424. */
  128425. cylinder: Mesh;
  128426. }
  128427. /**
  128428. * Interface for vortex event data
  128429. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  128430. */
  128431. export interface PhysicsVortexEventData {
  128432. /**
  128433. * A cylinder used for the vortex event
  128434. */
  128435. cylinder: Mesh;
  128436. }
  128437. /**
  128438. * Interface for an affected physics impostor
  128439. * @see https://doc.babylonjs.com/how_to/using_the_physics_engine#further-functionality-of-the-impostor-class
  128440. */
  128441. export interface PhysicsAffectedImpostorWithData {
  128442. /**
  128443. * The impostor affected by the effect
  128444. */
  128445. impostor: PhysicsImpostor;
  128446. /**
  128447. * The data about the hit/horce from the explosion
  128448. */
  128449. hitData: PhysicsHitData;
  128450. }
  128451. }
  128452. declare module BABYLON {
  128453. /** @hidden */
  128454. export var blackAndWhitePixelShader: {
  128455. name: string;
  128456. shader: string;
  128457. };
  128458. }
  128459. declare module BABYLON {
  128460. /**
  128461. * Post process used to render in black and white
  128462. */
  128463. export class BlackAndWhitePostProcess extends PostProcess {
  128464. /**
  128465. * Linear about to convert he result to black and white (default: 1)
  128466. */
  128467. degree: number;
  128468. /**
  128469. * Creates a black and white post process
  128470. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#black-and-white
  128471. * @param name The name of the effect.
  128472. * @param options The required width/height ratio to downsize to before computing the render pass.
  128473. * @param camera The camera to apply the render pass to.
  128474. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  128475. * @param engine The engine which the post process will be applied. (default: current engine)
  128476. * @param reusable If the post process can be reused on the same frame. (default: false)
  128477. */
  128478. constructor(name: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  128479. }
  128480. }
  128481. declare module BABYLON {
  128482. /**
  128483. * This represents a set of one or more post processes in Babylon.
  128484. * A post process can be used to apply a shader to a texture after it is rendered.
  128485. * @example https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  128486. */
  128487. export class PostProcessRenderEffect {
  128488. private _postProcesses;
  128489. private _getPostProcesses;
  128490. private _singleInstance;
  128491. private _cameras;
  128492. private _indicesForCamera;
  128493. /**
  128494. * Name of the effect
  128495. * @hidden
  128496. */
  128497. _name: string;
  128498. /**
  128499. * Instantiates a post process render effect.
  128500. * A post process can be used to apply a shader to a texture after it is rendered.
  128501. * @param engine The engine the effect is tied to
  128502. * @param name The name of the effect
  128503. * @param getPostProcesses A function that returns a set of post processes which the effect will run in order to be run.
  128504. * @param singleInstance False if this post process can be run on multiple cameras. (default: true)
  128505. */
  128506. constructor(engine: Engine, name: string, getPostProcesses: () => Nullable<PostProcess | Array<PostProcess>>, singleInstance?: boolean);
  128507. /**
  128508. * Checks if all the post processes in the effect are supported.
  128509. */
  128510. readonly isSupported: boolean;
  128511. /**
  128512. * Updates the current state of the effect
  128513. * @hidden
  128514. */
  128515. _update(): void;
  128516. /**
  128517. * Attaches the effect on cameras
  128518. * @param cameras The camera to attach to.
  128519. * @hidden
  128520. */
  128521. _attachCameras(cameras: Camera): void;
  128522. /**
  128523. * Attaches the effect on cameras
  128524. * @param cameras The camera to attach to.
  128525. * @hidden
  128526. */
  128527. _attachCameras(cameras: Camera[]): void;
  128528. /**
  128529. * Detaches the effect on cameras
  128530. * @param cameras The camera to detatch from.
  128531. * @hidden
  128532. */
  128533. _detachCameras(cameras: Camera): void;
  128534. /**
  128535. * Detatches the effect on cameras
  128536. * @param cameras The camera to detatch from.
  128537. * @hidden
  128538. */
  128539. _detachCameras(cameras: Camera[]): void;
  128540. /**
  128541. * Enables the effect on given cameras
  128542. * @param cameras The camera to enable.
  128543. * @hidden
  128544. */
  128545. _enable(cameras: Camera): void;
  128546. /**
  128547. * Enables the effect on given cameras
  128548. * @param cameras The camera to enable.
  128549. * @hidden
  128550. */
  128551. _enable(cameras: Nullable<Camera[]>): void;
  128552. /**
  128553. * Disables the effect on the given cameras
  128554. * @param cameras The camera to disable.
  128555. * @hidden
  128556. */
  128557. _disable(cameras: Camera): void;
  128558. /**
  128559. * Disables the effect on the given cameras
  128560. * @param cameras The camera to disable.
  128561. * @hidden
  128562. */
  128563. _disable(cameras: Nullable<Camera[]>): void;
  128564. /**
  128565. * Gets a list of the post processes contained in the effect.
  128566. * @param camera The camera to get the post processes on.
  128567. * @returns The list of the post processes in the effect.
  128568. */
  128569. getPostProcesses(camera?: Camera): Nullable<Array<PostProcess>>;
  128570. }
  128571. }
  128572. declare module BABYLON {
  128573. /** @hidden */
  128574. export var extractHighlightsPixelShader: {
  128575. name: string;
  128576. shader: string;
  128577. };
  128578. }
  128579. declare module BABYLON {
  128580. /**
  128581. * 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.
  128582. */
  128583. export class ExtractHighlightsPostProcess extends PostProcess {
  128584. /**
  128585. * The luminance threshold, pixels below this value will be set to black.
  128586. */
  128587. threshold: number;
  128588. /** @hidden */
  128589. _exposure: number;
  128590. /**
  128591. * Post process which has the input texture to be used when performing highlight extraction
  128592. * @hidden
  128593. */
  128594. _inputPostProcess: Nullable<PostProcess>;
  128595. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  128596. }
  128597. }
  128598. declare module BABYLON {
  128599. /** @hidden */
  128600. export var bloomMergePixelShader: {
  128601. name: string;
  128602. shader: string;
  128603. };
  128604. }
  128605. declare module BABYLON {
  128606. /**
  128607. * The BloomMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  128608. */
  128609. export class BloomMergePostProcess extends PostProcess {
  128610. /** Weight of the bloom to be added to the original input. */
  128611. weight: number;
  128612. /**
  128613. * Creates a new instance of @see BloomMergePostProcess
  128614. * @param name The name of the effect.
  128615. * @param originalFromInput Post process which's input will be used for the merge.
  128616. * @param blurred Blurred highlights post process which's output will be used.
  128617. * @param weight Weight of the bloom to be added to the original input.
  128618. * @param options The required width/height ratio to downsize to before computing the render pass.
  128619. * @param camera The camera to apply the render pass to.
  128620. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  128621. * @param engine The engine which the post process will be applied. (default: current engine)
  128622. * @param reusable If the post process can be reused on the same frame. (default: false)
  128623. * @param textureType Type of textures used when performing the post process. (default: 0)
  128624. * @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)
  128625. */
  128626. constructor(name: string, originalFromInput: PostProcess, blurred: PostProcess,
  128627. /** Weight of the bloom to be added to the original input. */
  128628. weight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  128629. }
  128630. }
  128631. declare module BABYLON {
  128632. /**
  128633. * The bloom effect spreads bright areas of an image to simulate artifacts seen in cameras
  128634. */
  128635. export class BloomEffect extends PostProcessRenderEffect {
  128636. private bloomScale;
  128637. /**
  128638. * @hidden Internal
  128639. */
  128640. _effects: Array<PostProcess>;
  128641. /**
  128642. * @hidden Internal
  128643. */
  128644. _downscale: ExtractHighlightsPostProcess;
  128645. private _blurX;
  128646. private _blurY;
  128647. private _merge;
  128648. /**
  128649. * The luminance threshold to find bright areas of the image to bloom.
  128650. */
  128651. threshold: number;
  128652. /**
  128653. * The strength of the bloom.
  128654. */
  128655. weight: number;
  128656. /**
  128657. * Specifies the size of the bloom blur kernel, relative to the final output size
  128658. */
  128659. kernel: number;
  128660. /**
  128661. * Creates a new instance of @see BloomEffect
  128662. * @param scene The scene the effect belongs to.
  128663. * @param bloomScale The ratio of the blur texture to the input texture that should be used to compute the bloom.
  128664. * @param bloomKernel The size of the kernel to be used when applying the blur.
  128665. * @param bloomWeight The the strength of bloom.
  128666. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  128667. * @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)
  128668. */
  128669. constructor(scene: Scene, bloomScale: number, bloomWeight: number, bloomKernel: number, pipelineTextureType?: number, blockCompilation?: boolean);
  128670. /**
  128671. * Disposes each of the internal effects for a given camera.
  128672. * @param camera The camera to dispose the effect on.
  128673. */
  128674. disposeEffects(camera: Camera): void;
  128675. /**
  128676. * @hidden Internal
  128677. */
  128678. _updateEffects(): void;
  128679. /**
  128680. * Internal
  128681. * @returns if all the contained post processes are ready.
  128682. * @hidden
  128683. */
  128684. _isReady(): boolean;
  128685. }
  128686. }
  128687. declare module BABYLON {
  128688. /** @hidden */
  128689. export var chromaticAberrationPixelShader: {
  128690. name: string;
  128691. shader: string;
  128692. };
  128693. }
  128694. declare module BABYLON {
  128695. /**
  128696. * The ChromaticAberrationPostProcess separates the rgb channels in an image to produce chromatic distortion around the edges of the screen
  128697. */
  128698. export class ChromaticAberrationPostProcess extends PostProcess {
  128699. /**
  128700. * The amount of seperation of rgb channels (default: 30)
  128701. */
  128702. aberrationAmount: number;
  128703. /**
  128704. * The amount the effect will increase for pixels closer to the edge of the screen. (default: 0)
  128705. */
  128706. radialIntensity: number;
  128707. /**
  128708. * 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))
  128709. */
  128710. direction: Vector2;
  128711. /**
  128712. * 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))
  128713. */
  128714. centerPosition: Vector2;
  128715. /**
  128716. * Creates a new instance ChromaticAberrationPostProcess
  128717. * @param name The name of the effect.
  128718. * @param screenWidth The width of the screen to apply the effect on.
  128719. * @param screenHeight The height of the screen to apply the effect on.
  128720. * @param options The required width/height ratio to downsize to before computing the render pass.
  128721. * @param camera The camera to apply the render pass to.
  128722. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  128723. * @param engine The engine which the post process will be applied. (default: current engine)
  128724. * @param reusable If the post process can be reused on the same frame. (default: false)
  128725. * @param textureType Type of textures used when performing the post process. (default: 0)
  128726. * @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)
  128727. */
  128728. constructor(name: string, screenWidth: number, screenHeight: number, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  128729. }
  128730. }
  128731. declare module BABYLON {
  128732. /** @hidden */
  128733. export var circleOfConfusionPixelShader: {
  128734. name: string;
  128735. shader: string;
  128736. };
  128737. }
  128738. declare module BABYLON {
  128739. /**
  128740. * The CircleOfConfusionPostProcess computes the circle of confusion value for each pixel given required lens parameters. See https://en.wikipedia.org/wiki/Circle_of_confusion
  128741. */
  128742. export class CircleOfConfusionPostProcess extends PostProcess {
  128743. /**
  128744. * 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.
  128745. */
  128746. lensSize: number;
  128747. /**
  128748. * F-Stop of the effect's camera. The diamater of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  128749. */
  128750. fStop: number;
  128751. /**
  128752. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  128753. */
  128754. focusDistance: number;
  128755. /**
  128756. * Focal length of the effect's camera in scene units/1000 (eg. millimeter). (default: 50)
  128757. */
  128758. focalLength: number;
  128759. private _depthTexture;
  128760. /**
  128761. * Creates a new instance CircleOfConfusionPostProcess
  128762. * @param name The name of the effect.
  128763. * @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.
  128764. * @param options The required width/height ratio to downsize to before computing the render pass.
  128765. * @param camera The camera to apply the render pass to.
  128766. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  128767. * @param engine The engine which the post process will be applied. (default: current engine)
  128768. * @param reusable If the post process can be reused on the same frame. (default: false)
  128769. * @param textureType Type of textures used when performing the post process. (default: 0)
  128770. * @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)
  128771. */
  128772. constructor(name: string, depthTexture: Nullable<RenderTargetTexture>, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  128773. /**
  128774. * 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.
  128775. */
  128776. depthTexture: RenderTargetTexture;
  128777. }
  128778. }
  128779. declare module BABYLON {
  128780. /** @hidden */
  128781. export var colorCorrectionPixelShader: {
  128782. name: string;
  128783. shader: string;
  128784. };
  128785. }
  128786. declare module BABYLON {
  128787. /**
  128788. *
  128789. * This post-process allows the modification of rendered colors by using
  128790. * a 'look-up table' (LUT). This effect is also called Color Grading.
  128791. *
  128792. * The object needs to be provided an url to a texture containing the color
  128793. * look-up table: the texture must be 256 pixels wide and 16 pixels high.
  128794. * Use an image editing software to tweak the LUT to match your needs.
  128795. *
  128796. * For an example of a color LUT, see here:
  128797. * @see http://udn.epicgames.com/Three/rsrc/Three/ColorGrading/RGBTable16x1.png
  128798. * For explanations on color grading, see here:
  128799. * @see http://udn.epicgames.com/Three/ColorGrading.html
  128800. *
  128801. */
  128802. export class ColorCorrectionPostProcess extends PostProcess {
  128803. private _colorTableTexture;
  128804. constructor(name: string, colorTableUrl: string, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  128805. }
  128806. }
  128807. declare module BABYLON {
  128808. /** @hidden */
  128809. export var convolutionPixelShader: {
  128810. name: string;
  128811. shader: string;
  128812. };
  128813. }
  128814. declare module BABYLON {
  128815. /**
  128816. * The ConvolutionPostProcess applies a 3x3 kernel to every pixel of the
  128817. * input texture to perform effects such as edge detection or sharpening
  128818. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  128819. */
  128820. export class ConvolutionPostProcess extends PostProcess {
  128821. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  128822. kernel: number[];
  128823. /**
  128824. * Creates a new instance ConvolutionPostProcess
  128825. * @param name The name of the effect.
  128826. * @param kernel Array of 9 values corresponding to the 3x3 kernel to be applied
  128827. * @param options The required width/height ratio to downsize to before computing the render pass.
  128828. * @param camera The camera to apply the render pass to.
  128829. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  128830. * @param engine The engine which the post process will be applied. (default: current engine)
  128831. * @param reusable If the post process can be reused on the same frame. (default: false)
  128832. * @param textureType Type of textures used when performing the post process. (default: 0)
  128833. */
  128834. constructor(name: string,
  128835. /** Array of 9 values corresponding to the 3x3 kernel to be applied */
  128836. kernel: number[], options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  128837. /**
  128838. * Edge detection 0 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  128839. */
  128840. static EdgeDetect0Kernel: number[];
  128841. /**
  128842. * Edge detection 1 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  128843. */
  128844. static EdgeDetect1Kernel: number[];
  128845. /**
  128846. * Edge detection 2 see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  128847. */
  128848. static EdgeDetect2Kernel: number[];
  128849. /**
  128850. * Kernel to sharpen an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  128851. */
  128852. static SharpenKernel: number[];
  128853. /**
  128854. * Kernel to emboss an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  128855. */
  128856. static EmbossKernel: number[];
  128857. /**
  128858. * Kernel to blur an image see https://en.wikipedia.org/wiki/Kernel_(image_processing)
  128859. */
  128860. static GaussianKernel: number[];
  128861. }
  128862. }
  128863. declare module BABYLON {
  128864. /**
  128865. * The DepthOfFieldBlurPostProcess applied a blur in a give direction.
  128866. * This blur differs from the standard BlurPostProcess as it attempts to avoid blurring pixels
  128867. * based on samples that have a large difference in distance than the center pixel.
  128868. * See section 2.6.2 http://fileadmin.cs.lth.se/cs/education/edan35/lectures/12dof.pdf
  128869. */
  128870. export class DepthOfFieldBlurPostProcess extends BlurPostProcess {
  128871. direction: Vector2;
  128872. /**
  128873. * Creates a new instance CircleOfConfusionPostProcess
  128874. * @param name The name of the effect.
  128875. * @param scene The scene the effect belongs to.
  128876. * @param direction The direction the blur should be applied.
  128877. * @param kernel The size of the kernel used to blur.
  128878. * @param options The required width/height ratio to downsize to before computing the render pass.
  128879. * @param camera The camera to apply the render pass to.
  128880. * @param circleOfConfusion The circle of confusion + depth map to be used to avoid blurring accross edges
  128881. * @param imageToBlur The image to apply the blur to (default: Current rendered frame)
  128882. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  128883. * @param engine The engine which the post process will be applied. (default: current engine)
  128884. * @param reusable If the post process can be reused on the same frame. (default: false)
  128885. * @param textureType Type of textures used when performing the post process. (default: 0)
  128886. * @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)
  128887. */
  128888. 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);
  128889. }
  128890. }
  128891. declare module BABYLON {
  128892. /** @hidden */
  128893. export var depthOfFieldMergePixelShader: {
  128894. name: string;
  128895. shader: string;
  128896. };
  128897. }
  128898. declare module BABYLON {
  128899. /**
  128900. * Options to be set when merging outputs from the default pipeline.
  128901. */
  128902. export class DepthOfFieldMergePostProcessOptions {
  128903. /**
  128904. * The original image to merge on top of
  128905. */
  128906. originalFromInput: PostProcess;
  128907. /**
  128908. * Parameters to perform the merge of the depth of field effect
  128909. */
  128910. depthOfField?: {
  128911. circleOfConfusion: PostProcess;
  128912. blurSteps: Array<PostProcess>;
  128913. };
  128914. /**
  128915. * Parameters to perform the merge of bloom effect
  128916. */
  128917. bloom?: {
  128918. blurred: PostProcess;
  128919. weight: number;
  128920. };
  128921. }
  128922. /**
  128923. * The DepthOfFieldMergePostProcess merges blurred images with the original based on the values of the circle of confusion.
  128924. */
  128925. export class DepthOfFieldMergePostProcess extends PostProcess {
  128926. private blurSteps;
  128927. /**
  128928. * Creates a new instance of DepthOfFieldMergePostProcess
  128929. * @param name The name of the effect.
  128930. * @param originalFromInput Post process which's input will be used for the merge.
  128931. * @param circleOfConfusion Circle of confusion post process which's output will be used to blur each pixel.
  128932. * @param blurSteps Blur post processes from low to high which will be mixed with the original image.
  128933. * @param options The required width/height ratio to downsize to before computing the render pass.
  128934. * @param camera The camera to apply the render pass to.
  128935. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  128936. * @param engine The engine which the post process will be applied. (default: current engine)
  128937. * @param reusable If the post process can be reused on the same frame. (default: false)
  128938. * @param textureType Type of textures used when performing the post process. (default: 0)
  128939. * @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)
  128940. */
  128941. 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);
  128942. /**
  128943. * Updates the effect with the current post process compile time values and recompiles the shader.
  128944. * @param defines Define statements that should be added at the beginning of the shader. (default: null)
  128945. * @param uniforms Set of uniform variables that will be passed to the shader. (default: null)
  128946. * @param samplers Set of Texture2D variables that will be passed to the shader. (default: null)
  128947. * @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
  128948. * @param onCompiled Called when the shader has been compiled.
  128949. * @param onError Called if there is an error when compiling a shader.
  128950. */
  128951. updateEffect(defines?: Nullable<string>, uniforms?: Nullable<string[]>, samplers?: Nullable<string[]>, indexParameters?: any, onCompiled?: (effect: Effect) => void, onError?: (effect: Effect, errors: string) => void): void;
  128952. }
  128953. }
  128954. declare module BABYLON {
  128955. /**
  128956. * Specifies the level of max blur that should be applied when using the depth of field effect
  128957. */
  128958. export enum DepthOfFieldEffectBlurLevel {
  128959. /**
  128960. * Subtle blur
  128961. */
  128962. Low = 0,
  128963. /**
  128964. * Medium blur
  128965. */
  128966. Medium = 1,
  128967. /**
  128968. * Large blur
  128969. */
  128970. High = 2
  128971. }
  128972. /**
  128973. * The depth of field effect applies a blur to objects that are closer or further from where the camera is focusing.
  128974. */
  128975. export class DepthOfFieldEffect extends PostProcessRenderEffect {
  128976. private _circleOfConfusion;
  128977. /**
  128978. * @hidden Internal, blurs from high to low
  128979. */
  128980. _depthOfFieldBlurX: Array<DepthOfFieldBlurPostProcess>;
  128981. private _depthOfFieldBlurY;
  128982. private _dofMerge;
  128983. /**
  128984. * @hidden Internal post processes in depth of field effect
  128985. */
  128986. _effects: Array<PostProcess>;
  128987. /**
  128988. * The focal the length of the camera used in the effect in scene units/1000 (eg. millimeter)
  128989. */
  128990. focalLength: number;
  128991. /**
  128992. * F-Stop of the effect's camera. The diameter of the resulting aperture can be computed by lensSize/fStop. (default: 1.4)
  128993. */
  128994. fStop: number;
  128995. /**
  128996. * Distance away from the camera to focus on in scene units/1000 (eg. millimeter). (default: 2000)
  128997. */
  128998. focusDistance: number;
  128999. /**
  129000. * 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.
  129001. */
  129002. lensSize: number;
  129003. /**
  129004. * Creates a new instance DepthOfFieldEffect
  129005. * @param scene The scene the effect belongs to.
  129006. * @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.
  129007. * @param pipelineTextureType The type of texture to be used when performing the post processing.
  129008. * @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)
  129009. */
  129010. constructor(scene: Scene, depthTexture: Nullable<RenderTargetTexture>, blurLevel?: DepthOfFieldEffectBlurLevel, pipelineTextureType?: number, blockCompilation?: boolean);
  129011. /**
  129012. * Get the current class name of the current effet
  129013. * @returns "DepthOfFieldEffect"
  129014. */
  129015. getClassName(): string;
  129016. /**
  129017. * 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.
  129018. */
  129019. depthTexture: RenderTargetTexture;
  129020. /**
  129021. * Disposes each of the internal effects for a given camera.
  129022. * @param camera The camera to dispose the effect on.
  129023. */
  129024. disposeEffects(camera: Camera): void;
  129025. /**
  129026. * @hidden Internal
  129027. */
  129028. _updateEffects(): void;
  129029. /**
  129030. * Internal
  129031. * @returns if all the contained post processes are ready.
  129032. * @hidden
  129033. */
  129034. _isReady(): boolean;
  129035. }
  129036. }
  129037. declare module BABYLON {
  129038. /** @hidden */
  129039. export var displayPassPixelShader: {
  129040. name: string;
  129041. shader: string;
  129042. };
  129043. }
  129044. declare module BABYLON {
  129045. /**
  129046. * DisplayPassPostProcess which produces an output the same as it's input
  129047. */
  129048. export class DisplayPassPostProcess extends PostProcess {
  129049. /**
  129050. * Creates the DisplayPassPostProcess
  129051. * @param name The name of the effect.
  129052. * @param options The required width/height ratio to downsize to before computing the render pass.
  129053. * @param camera The camera to apply the render pass to.
  129054. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  129055. * @param engine The engine which the post process will be applied. (default: current engine)
  129056. * @param reusable If the post process can be reused on the same frame. (default: false)
  129057. */
  129058. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  129059. }
  129060. }
  129061. declare module BABYLON {
  129062. /** @hidden */
  129063. export var filterPixelShader: {
  129064. name: string;
  129065. shader: string;
  129066. };
  129067. }
  129068. declare module BABYLON {
  129069. /**
  129070. * Applies a kernel filter to the image
  129071. */
  129072. export class FilterPostProcess extends PostProcess {
  129073. /** The matrix to be applied to the image */
  129074. kernelMatrix: Matrix;
  129075. /**
  129076. *
  129077. * @param name The name of the effect.
  129078. * @param kernelMatrix The matrix to be applied to the image
  129079. * @param options The required width/height ratio to downsize to before computing the render pass.
  129080. * @param camera The camera to apply the render pass to.
  129081. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  129082. * @param engine The engine which the post process will be applied. (default: current engine)
  129083. * @param reusable If the post process can be reused on the same frame. (default: false)
  129084. */
  129085. constructor(name: string,
  129086. /** The matrix to be applied to the image */
  129087. kernelMatrix: Matrix, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean);
  129088. }
  129089. }
  129090. declare module BABYLON {
  129091. /** @hidden */
  129092. export var fxaaPixelShader: {
  129093. name: string;
  129094. shader: string;
  129095. };
  129096. }
  129097. declare module BABYLON {
  129098. /** @hidden */
  129099. export var fxaaVertexShader: {
  129100. name: string;
  129101. shader: string;
  129102. };
  129103. }
  129104. declare module BABYLON {
  129105. /**
  129106. * Fxaa post process
  129107. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#fxaa
  129108. */
  129109. export class FxaaPostProcess extends PostProcess {
  129110. /** @hidden */
  129111. texelWidth: number;
  129112. /** @hidden */
  129113. texelHeight: number;
  129114. constructor(name: string, options: number | PostProcessOptions, camera?: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  129115. private _getDefines;
  129116. }
  129117. }
  129118. declare module BABYLON {
  129119. /** @hidden */
  129120. export var grainPixelShader: {
  129121. name: string;
  129122. shader: string;
  129123. };
  129124. }
  129125. declare module BABYLON {
  129126. /**
  129127. * The GrainPostProcess adds noise to the image at mid luminance levels
  129128. */
  129129. export class GrainPostProcess extends PostProcess {
  129130. /**
  129131. * The intensity of the grain added (default: 30)
  129132. */
  129133. intensity: number;
  129134. /**
  129135. * If the grain should be randomized on every frame
  129136. */
  129137. animated: boolean;
  129138. /**
  129139. * Creates a new instance of @see GrainPostProcess
  129140. * @param name The name of the effect.
  129141. * @param options The required width/height ratio to downsize to before computing the render pass.
  129142. * @param camera The camera to apply the render pass to.
  129143. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  129144. * @param engine The engine which the post process will be applied. (default: current engine)
  129145. * @param reusable If the post process can be reused on the same frame. (default: false)
  129146. * @param textureType Type of textures used when performing the post process. (default: 0)
  129147. * @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)
  129148. */
  129149. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  129150. }
  129151. }
  129152. declare module BABYLON {
  129153. /** @hidden */
  129154. export var highlightsPixelShader: {
  129155. name: string;
  129156. shader: string;
  129157. };
  129158. }
  129159. declare module BABYLON {
  129160. /**
  129161. * Extracts highlights from the image
  129162. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  129163. */
  129164. export class HighlightsPostProcess extends PostProcess {
  129165. /**
  129166. * Extracts highlights from the image
  129167. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses
  129168. * @param name The name of the effect.
  129169. * @param options The required width/height ratio to downsize to before computing the render pass.
  129170. * @param camera The camera to apply the render pass to.
  129171. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  129172. * @param engine The engine which the post process will be applied. (default: current engine)
  129173. * @param reusable If the post process can be reused on the same frame. (default: false)
  129174. * @param textureType Type of texture for the post process (default: Engine.TEXTURETYPE_UNSIGNED_INT)
  129175. */
  129176. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number);
  129177. }
  129178. }
  129179. declare module BABYLON {
  129180. /** @hidden */
  129181. export var mrtFragmentDeclaration: {
  129182. name: string;
  129183. shader: string;
  129184. };
  129185. }
  129186. declare module BABYLON {
  129187. /** @hidden */
  129188. export var geometryPixelShader: {
  129189. name: string;
  129190. shader: string;
  129191. };
  129192. }
  129193. declare module BABYLON {
  129194. /** @hidden */
  129195. export var geometryVertexShader: {
  129196. name: string;
  129197. shader: string;
  129198. };
  129199. }
  129200. declare module BABYLON {
  129201. /** @hidden */
  129202. interface ISavedTransformationMatrix {
  129203. world: Matrix;
  129204. viewProjection: Matrix;
  129205. }
  129206. /**
  129207. * This renderer is helpfull to fill one of the render target with a geometry buffer.
  129208. */
  129209. export class GeometryBufferRenderer {
  129210. /**
  129211. * Constant used to retrieve the position texture index in the G-Buffer textures array
  129212. * using getIndex(GeometryBufferRenderer.POSITION_TEXTURE_INDEX)
  129213. */
  129214. static readonly POSITION_TEXTURE_TYPE: number;
  129215. /**
  129216. * Constant used to retrieve the velocity texture index in the G-Buffer textures array
  129217. * using getIndex(GeometryBufferRenderer.VELOCITY_TEXTURE_INDEX)
  129218. */
  129219. static readonly VELOCITY_TEXTURE_TYPE: number;
  129220. /**
  129221. * Dictionary used to store the previous transformation matrices of each rendered mesh
  129222. * in order to compute objects velocities when enableVelocity is set to "true"
  129223. * @hidden
  129224. */
  129225. _previousTransformationMatrices: {
  129226. [index: number]: ISavedTransformationMatrix;
  129227. };
  129228. /**
  129229. * Dictionary used to store the previous bones transformation matrices of each rendered mesh
  129230. * in order to compute objects velocities when enableVelocity is set to "true"
  129231. * @hidden
  129232. */
  129233. _previousBonesTransformationMatrices: {
  129234. [index: number]: Float32Array;
  129235. };
  129236. /**
  129237. * Array used to store the ignored skinned meshes while computing velocity map (typically used by the motion blur post-process).
  129238. * Avoids computing bones velocities and computes only mesh's velocity itself (position, rotation, scaling).
  129239. */
  129240. excludedSkinnedMeshesFromVelocity: AbstractMesh[];
  129241. private _scene;
  129242. private _multiRenderTarget;
  129243. private _ratio;
  129244. private _enablePosition;
  129245. private _enableVelocity;
  129246. private _positionIndex;
  129247. private _velocityIndex;
  129248. protected _effect: Effect;
  129249. protected _cachedDefines: string;
  129250. /**
  129251. * Set the render list (meshes to be rendered) used in the G buffer.
  129252. */
  129253. renderList: Mesh[];
  129254. /**
  129255. * Gets wether or not G buffer are supported by the running hardware.
  129256. * This requires draw buffer supports
  129257. */
  129258. readonly isSupported: boolean;
  129259. /**
  129260. * Returns the index of the given texture type in the G-Buffer textures array
  129261. * @param textureType The texture type constant. For example GeometryBufferRenderer.POSITION_TEXTURE_INDEX
  129262. * @returns the index of the given texture type in the G-Buffer textures array
  129263. */
  129264. getTextureIndex(textureType: number): number;
  129265. /**
  129266. * Gets a boolean indicating if objects positions are enabled for the G buffer.
  129267. */
  129268. /**
  129269. * Sets whether or not objects positions are enabled for the G buffer.
  129270. */
  129271. enablePosition: boolean;
  129272. /**
  129273. * Gets a boolean indicating if objects velocities are enabled for the G buffer.
  129274. */
  129275. /**
  129276. * Sets wether or not objects velocities are enabled for the G buffer.
  129277. */
  129278. enableVelocity: boolean;
  129279. /**
  129280. * Gets the scene associated with the buffer.
  129281. */
  129282. readonly scene: Scene;
  129283. /**
  129284. * Gets the ratio used by the buffer during its creation.
  129285. * How big is the buffer related to the main canvas.
  129286. */
  129287. readonly ratio: number;
  129288. /** @hidden */
  129289. static _SceneComponentInitialization: (scene: Scene) => void;
  129290. /**
  129291. * Creates a new G Buffer for the scene
  129292. * @param scene The scene the buffer belongs to
  129293. * @param ratio How big is the buffer related to the main canvas.
  129294. */
  129295. constructor(scene: Scene, ratio?: number);
  129296. /**
  129297. * Checks wether everything is ready to render a submesh to the G buffer.
  129298. * @param subMesh the submesh to check readiness for
  129299. * @param useInstances is the mesh drawn using instance or not
  129300. * @returns true if ready otherwise false
  129301. */
  129302. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  129303. /**
  129304. * Gets the current underlying G Buffer.
  129305. * @returns the buffer
  129306. */
  129307. getGBuffer(): MultiRenderTarget;
  129308. /**
  129309. * Gets the number of samples used to render the buffer (anti aliasing).
  129310. */
  129311. /**
  129312. * Sets the number of samples used to render the buffer (anti aliasing).
  129313. */
  129314. samples: number;
  129315. /**
  129316. * Disposes the renderer and frees up associated resources.
  129317. */
  129318. dispose(): void;
  129319. protected _createRenderTargets(): void;
  129320. private _copyBonesTransformationMatrices;
  129321. }
  129322. }
  129323. declare module BABYLON {
  129324. interface Scene {
  129325. /** @hidden (Backing field) */
  129326. _geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  129327. /**
  129328. * Gets or Sets the current geometry buffer associated to the scene.
  129329. */
  129330. geometryBufferRenderer: Nullable<GeometryBufferRenderer>;
  129331. /**
  129332. * Enables a GeometryBufferRender and associates it with the scene
  129333. * @param ratio defines the scaling ratio to apply to the renderer (1 by default which means same resolution)
  129334. * @returns the GeometryBufferRenderer
  129335. */
  129336. enableGeometryBufferRenderer(ratio?: number): Nullable<GeometryBufferRenderer>;
  129337. /**
  129338. * Disables the GeometryBufferRender associated with the scene
  129339. */
  129340. disableGeometryBufferRenderer(): void;
  129341. }
  129342. /**
  129343. * Defines the Geometry Buffer scene component responsible to manage a G-Buffer useful
  129344. * in several rendering techniques.
  129345. */
  129346. export class GeometryBufferRendererSceneComponent implements ISceneComponent {
  129347. /**
  129348. * The component name helpful to identify the component in the list of scene components.
  129349. */
  129350. readonly name: string;
  129351. /**
  129352. * The scene the component belongs to.
  129353. */
  129354. scene: Scene;
  129355. /**
  129356. * Creates a new instance of the component for the given scene
  129357. * @param scene Defines the scene to register the component in
  129358. */
  129359. constructor(scene: Scene);
  129360. /**
  129361. * Registers the component in a given scene
  129362. */
  129363. register(): void;
  129364. /**
  129365. * Rebuilds the elements related to this component in case of
  129366. * context lost for instance.
  129367. */
  129368. rebuild(): void;
  129369. /**
  129370. * Disposes the component and the associated ressources
  129371. */
  129372. dispose(): void;
  129373. private _gatherRenderTargets;
  129374. }
  129375. }
  129376. declare module BABYLON {
  129377. /** @hidden */
  129378. export var motionBlurPixelShader: {
  129379. name: string;
  129380. shader: string;
  129381. };
  129382. }
  129383. declare module BABYLON {
  129384. /**
  129385. * The Motion Blur Post Process which blurs an image based on the objects velocity in scene.
  129386. * Velocity can be affected by each object's rotation, position and scale depending on the transformation speed.
  129387. * As an example, all you have to do is to create the post-process:
  129388. * var mb = new BABYLON.MotionBlurPostProcess(
  129389. * 'mb', // The name of the effect.
  129390. * scene, // The scene containing the objects to blur according to their velocity.
  129391. * 1.0, // The required width/height ratio to downsize to before computing the render pass.
  129392. * camera // The camera to apply the render pass to.
  129393. * );
  129394. * Then, all objects moving, rotating and/or scaling will be blurred depending on the transformation speed.
  129395. */
  129396. export class MotionBlurPostProcess extends PostProcess {
  129397. /**
  129398. * Defines how much the image is blurred by the movement. Default value is equal to 1
  129399. */
  129400. motionStrength: number;
  129401. /**
  129402. * Gets the number of iterations are used for motion blur quality. Default value is equal to 32
  129403. */
  129404. /**
  129405. * Sets the number of iterations to be used for motion blur quality
  129406. */
  129407. motionBlurSamples: number;
  129408. private _motionBlurSamples;
  129409. private _geometryBufferRenderer;
  129410. /**
  129411. * Creates a new instance MotionBlurPostProcess
  129412. * @param name The name of the effect.
  129413. * @param scene The scene containing the objects to blur according to their velocity.
  129414. * @param options The required width/height ratio to downsize to before computing the render pass.
  129415. * @param camera The camera to apply the render pass to.
  129416. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  129417. * @param engine The engine which the post process will be applied. (default: current engine)
  129418. * @param reusable If the post process can be reused on the same frame. (default: false)
  129419. * @param textureType Type of textures used when performing the post process. (default: 0)
  129420. * @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)
  129421. */
  129422. constructor(name: string, scene: Scene, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  129423. /**
  129424. * Excludes the given skinned mesh from computing bones velocities.
  129425. * 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.
  129426. * @param skinnedMesh The mesh containing the skeleton to ignore when computing the velocity map.
  129427. */
  129428. excludeSkinnedMesh(skinnedMesh: AbstractMesh): void;
  129429. /**
  129430. * Removes the given skinned mesh from the excluded meshes to integrate bones velocities while rendering the velocity map.
  129431. * @param skinnedMesh The mesh containing the skeleton that has been ignored previously.
  129432. * @see excludeSkinnedMesh to exclude a skinned mesh from bones velocity computation.
  129433. */
  129434. removeExcludedSkinnedMesh(skinnedMesh: AbstractMesh): void;
  129435. /**
  129436. * Disposes the post process.
  129437. * @param camera The camera to dispose the post process on.
  129438. */
  129439. dispose(camera?: Camera): void;
  129440. }
  129441. }
  129442. declare module BABYLON {
  129443. /** @hidden */
  129444. export var refractionPixelShader: {
  129445. name: string;
  129446. shader: string;
  129447. };
  129448. }
  129449. declare module BABYLON {
  129450. /**
  129451. * Post process which applies a refractin texture
  129452. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  129453. */
  129454. export class RefractionPostProcess extends PostProcess {
  129455. /** the base color of the refraction (used to taint the rendering) */
  129456. color: Color3;
  129457. /** simulated refraction depth */
  129458. depth: number;
  129459. /** the coefficient of the base color (0 to remove base color tainting) */
  129460. colorLevel: number;
  129461. private _refTexture;
  129462. private _ownRefractionTexture;
  129463. /**
  129464. * Gets or sets the refraction texture
  129465. * Please note that you are responsible for disposing the texture if you set it manually
  129466. */
  129467. refractionTexture: Texture;
  129468. /**
  129469. * Initializes the RefractionPostProcess
  129470. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocesses#refraction
  129471. * @param name The name of the effect.
  129472. * @param refractionTextureUrl Url of the refraction texture to use
  129473. * @param color the base color of the refraction (used to taint the rendering)
  129474. * @param depth simulated refraction depth
  129475. * @param colorLevel the coefficient of the base color (0 to remove base color tainting)
  129476. * @param camera The camera to apply the render pass to.
  129477. * @param options The required width/height ratio to downsize to before computing the render pass.
  129478. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  129479. * @param engine The engine which the post process will be applied. (default: current engine)
  129480. * @param reusable If the post process can be reused on the same frame. (default: false)
  129481. */
  129482. constructor(name: string, refractionTextureUrl: string,
  129483. /** the base color of the refraction (used to taint the rendering) */
  129484. color: Color3,
  129485. /** simulated refraction depth */
  129486. depth: number,
  129487. /** the coefficient of the base color (0 to remove base color tainting) */
  129488. colorLevel: number, options: number | PostProcessOptions, camera: Camera, samplingMode?: number, engine?: Engine, reusable?: boolean);
  129489. /**
  129490. * Disposes of the post process
  129491. * @param camera Camera to dispose post process on
  129492. */
  129493. dispose(camera: Camera): void;
  129494. }
  129495. }
  129496. declare module BABYLON {
  129497. /** @hidden */
  129498. export var sharpenPixelShader: {
  129499. name: string;
  129500. shader: string;
  129501. };
  129502. }
  129503. declare module BABYLON {
  129504. /**
  129505. * The SharpenPostProcess applies a sharpen kernel to every pixel
  129506. * See http://en.wikipedia.org/wiki/Kernel_(image_processing)
  129507. */
  129508. export class SharpenPostProcess extends PostProcess {
  129509. /**
  129510. * How much of the original color should be applied. Setting this to 0 will display edge detection. (default: 1)
  129511. */
  129512. colorAmount: number;
  129513. /**
  129514. * How much sharpness should be applied (default: 0.3)
  129515. */
  129516. edgeAmount: number;
  129517. /**
  129518. * Creates a new instance ConvolutionPostProcess
  129519. * @param name The name of the effect.
  129520. * @param options The required width/height ratio to downsize to before computing the render pass.
  129521. * @param camera The camera to apply the render pass to.
  129522. * @param samplingMode The sampling mode to be used when computing the pass. (default: 0)
  129523. * @param engine The engine which the post process will be applied. (default: current engine)
  129524. * @param reusable If the post process can be reused on the same frame. (default: false)
  129525. * @param textureType Type of textures used when performing the post process. (default: 0)
  129526. * @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)
  129527. */
  129528. constructor(name: string, options: number | PostProcessOptions, camera: Nullable<Camera>, samplingMode?: number, engine?: Engine, reusable?: boolean, textureType?: number, blockCompilation?: boolean);
  129529. }
  129530. }
  129531. declare module BABYLON {
  129532. /**
  129533. * PostProcessRenderPipeline
  129534. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  129535. */
  129536. export class PostProcessRenderPipeline {
  129537. private engine;
  129538. private _renderEffects;
  129539. private _renderEffectsForIsolatedPass;
  129540. /**
  129541. * List of inspectable custom properties (used by the Inspector)
  129542. * @see https://doc.babylonjs.com/how_to/debug_layer#extensibility
  129543. */
  129544. inspectableCustomProperties: IInspectable[];
  129545. /**
  129546. * @hidden
  129547. */
  129548. protected _cameras: Camera[];
  129549. /** @hidden */
  129550. _name: string;
  129551. /**
  129552. * Gets pipeline name
  129553. */
  129554. readonly name: string;
  129555. /** Gets the list of attached cameras */
  129556. readonly cameras: Camera[];
  129557. /**
  129558. * Initializes a PostProcessRenderPipeline
  129559. * @param engine engine to add the pipeline to
  129560. * @param name name of the pipeline
  129561. */
  129562. constructor(engine: Engine, name: string);
  129563. /**
  129564. * Gets the class name
  129565. * @returns "PostProcessRenderPipeline"
  129566. */
  129567. getClassName(): string;
  129568. /**
  129569. * If all the render effects in the pipeline are supported
  129570. */
  129571. readonly isSupported: boolean;
  129572. /**
  129573. * Adds an effect to the pipeline
  129574. * @param renderEffect the effect to add
  129575. */
  129576. addEffect(renderEffect: PostProcessRenderEffect): void;
  129577. /** @hidden */
  129578. _rebuild(): void;
  129579. /** @hidden */
  129580. _enableEffect(renderEffectName: string, cameras: Camera): void;
  129581. /** @hidden */
  129582. _enableEffect(renderEffectName: string, cameras: Camera[]): void;
  129583. /** @hidden */
  129584. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  129585. /** @hidden */
  129586. _disableEffect(renderEffectName: string, cameras: Nullable<Camera[]>): void;
  129587. /** @hidden */
  129588. _attachCameras(cameras: Camera, unique: boolean): void;
  129589. /** @hidden */
  129590. _attachCameras(cameras: Camera[], unique: boolean): void;
  129591. /** @hidden */
  129592. _detachCameras(cameras: Camera): void;
  129593. /** @hidden */
  129594. _detachCameras(cameras: Nullable<Camera[]>): void;
  129595. /** @hidden */
  129596. _update(): void;
  129597. /** @hidden */
  129598. _reset(): void;
  129599. protected _enableMSAAOnFirstPostProcess(sampleCount: number): boolean;
  129600. /**
  129601. * Disposes of the pipeline
  129602. */
  129603. dispose(): void;
  129604. }
  129605. }
  129606. declare module BABYLON {
  129607. /**
  129608. * PostProcessRenderPipelineManager class
  129609. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  129610. */
  129611. export class PostProcessRenderPipelineManager {
  129612. private _renderPipelines;
  129613. /**
  129614. * Initializes a PostProcessRenderPipelineManager
  129615. * @see https://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  129616. */
  129617. constructor();
  129618. /**
  129619. * Gets the list of supported render pipelines
  129620. */
  129621. readonly supportedPipelines: PostProcessRenderPipeline[];
  129622. /**
  129623. * Adds a pipeline to the manager
  129624. * @param renderPipeline The pipeline to add
  129625. */
  129626. addPipeline(renderPipeline: PostProcessRenderPipeline): void;
  129627. /**
  129628. * Attaches a camera to the pipeline
  129629. * @param renderPipelineName The name of the pipeline to attach to
  129630. * @param cameras the camera to attach
  129631. * @param unique if the camera can be attached multiple times to the pipeline
  129632. */
  129633. attachCamerasToRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera, unique?: boolean): void;
  129634. /**
  129635. * Detaches a camera from the pipeline
  129636. * @param renderPipelineName The name of the pipeline to detach from
  129637. * @param cameras the camera to detach
  129638. */
  129639. detachCamerasFromRenderPipeline(renderPipelineName: string, cameras: any | Camera[] | Camera): void;
  129640. /**
  129641. * Enables an effect by name on a pipeline
  129642. * @param renderPipelineName the name of the pipeline to enable the effect in
  129643. * @param renderEffectName the name of the effect to enable
  129644. * @param cameras the cameras that the effect should be enabled on
  129645. */
  129646. enableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  129647. /**
  129648. * Disables an effect by name on a pipeline
  129649. * @param renderPipelineName the name of the pipeline to disable the effect in
  129650. * @param renderEffectName the name of the effect to disable
  129651. * @param cameras the cameras that the effect should be disabled on
  129652. */
  129653. disableEffectInPipeline(renderPipelineName: string, renderEffectName: string, cameras: any | Camera[] | Camera): void;
  129654. /**
  129655. * Updates the state of all contained render pipelines and disposes of any non supported pipelines
  129656. */
  129657. update(): void;
  129658. /** @hidden */
  129659. _rebuild(): void;
  129660. /**
  129661. * Disposes of the manager and pipelines
  129662. */
  129663. dispose(): void;
  129664. }
  129665. }
  129666. declare module BABYLON {
  129667. interface Scene {
  129668. /** @hidden (Backing field) */
  129669. _postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  129670. /**
  129671. * Gets the postprocess render pipeline manager
  129672. * @see http://doc.babylonjs.com/how_to/how_to_use_postprocessrenderpipeline
  129673. * @see http://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  129674. */
  129675. readonly postProcessRenderPipelineManager: PostProcessRenderPipelineManager;
  129676. }
  129677. /**
  129678. * Defines the Render Pipeline scene component responsible to rendering pipelines
  129679. */
  129680. export class PostProcessRenderPipelineManagerSceneComponent implements ISceneComponent {
  129681. /**
  129682. * The component name helpfull to identify the component in the list of scene components.
  129683. */
  129684. readonly name: string;
  129685. /**
  129686. * The scene the component belongs to.
  129687. */
  129688. scene: Scene;
  129689. /**
  129690. * Creates a new instance of the component for the given scene
  129691. * @param scene Defines the scene to register the component in
  129692. */
  129693. constructor(scene: Scene);
  129694. /**
  129695. * Registers the component in a given scene
  129696. */
  129697. register(): void;
  129698. /**
  129699. * Rebuilds the elements related to this component in case of
  129700. * context lost for instance.
  129701. */
  129702. rebuild(): void;
  129703. /**
  129704. * Disposes the component and the associated ressources
  129705. */
  129706. dispose(): void;
  129707. private _gatherRenderTargets;
  129708. }
  129709. }
  129710. declare module BABYLON {
  129711. /**
  129712. * The default rendering pipeline can be added to a scene to apply common post processing effects such as anti-aliasing or depth of field.
  129713. * See https://doc.babylonjs.com/how_to/using_default_rendering_pipeline
  129714. */
  129715. export class DefaultRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  129716. private _scene;
  129717. private _camerasToBeAttached;
  129718. /**
  129719. * ID of the sharpen post process,
  129720. */
  129721. private readonly SharpenPostProcessId;
  129722. /**
  129723. * @ignore
  129724. * ID of the image processing post process;
  129725. */
  129726. readonly ImageProcessingPostProcessId: string;
  129727. /**
  129728. * @ignore
  129729. * ID of the Fast Approximate Anti-Aliasing post process;
  129730. */
  129731. readonly FxaaPostProcessId: string;
  129732. /**
  129733. * ID of the chromatic aberration post process,
  129734. */
  129735. private readonly ChromaticAberrationPostProcessId;
  129736. /**
  129737. * ID of the grain post process
  129738. */
  129739. private readonly GrainPostProcessId;
  129740. /**
  129741. * Sharpen post process which will apply a sharpen convolution to enhance edges
  129742. */
  129743. sharpen: SharpenPostProcess;
  129744. private _sharpenEffect;
  129745. private bloom;
  129746. /**
  129747. * Depth of field effect, applies a blur based on how far away objects are from the focus distance.
  129748. */
  129749. depthOfField: DepthOfFieldEffect;
  129750. /**
  129751. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  129752. */
  129753. fxaa: FxaaPostProcess;
  129754. /**
  129755. * Image post processing pass used to perform operations such as tone mapping or color grading.
  129756. */
  129757. imageProcessing: ImageProcessingPostProcess;
  129758. /**
  129759. * Chromatic aberration post process which will shift rgb colors in the image
  129760. */
  129761. chromaticAberration: ChromaticAberrationPostProcess;
  129762. private _chromaticAberrationEffect;
  129763. /**
  129764. * Grain post process which add noise to the image
  129765. */
  129766. grain: GrainPostProcess;
  129767. private _grainEffect;
  129768. /**
  129769. * Glow post process which adds a glow to emissive areas of the image
  129770. */
  129771. private _glowLayer;
  129772. /**
  129773. * Animations which can be used to tweak settings over a period of time
  129774. */
  129775. animations: Animation[];
  129776. private _imageProcessingConfigurationObserver;
  129777. private _sharpenEnabled;
  129778. private _bloomEnabled;
  129779. private _depthOfFieldEnabled;
  129780. private _depthOfFieldBlurLevel;
  129781. private _fxaaEnabled;
  129782. private _imageProcessingEnabled;
  129783. private _defaultPipelineTextureType;
  129784. private _bloomScale;
  129785. private _chromaticAberrationEnabled;
  129786. private _grainEnabled;
  129787. private _buildAllowed;
  129788. /**
  129789. * Gets active scene
  129790. */
  129791. readonly scene: Scene;
  129792. /**
  129793. * Enable or disable the sharpen process from the pipeline
  129794. */
  129795. sharpenEnabled: boolean;
  129796. private _resizeObserver;
  129797. private _hardwareScaleLevel;
  129798. private _bloomKernel;
  129799. /**
  129800. * Specifies the size of the bloom blur kernel, relative to the final output size
  129801. */
  129802. bloomKernel: number;
  129803. /**
  129804. * Specifies the weight of the bloom in the final rendering
  129805. */
  129806. private _bloomWeight;
  129807. /**
  129808. * Specifies the luma threshold for the area that will be blurred by the bloom
  129809. */
  129810. private _bloomThreshold;
  129811. private _hdr;
  129812. /**
  129813. * The strength of the bloom.
  129814. */
  129815. bloomWeight: number;
  129816. /**
  129817. * The strength of the bloom.
  129818. */
  129819. bloomThreshold: number;
  129820. /**
  129821. * The scale of the bloom, lower value will provide better performance.
  129822. */
  129823. bloomScale: number;
  129824. /**
  129825. * Enable or disable the bloom from the pipeline
  129826. */
  129827. bloomEnabled: boolean;
  129828. private _rebuildBloom;
  129829. /**
  129830. * If the depth of field is enabled.
  129831. */
  129832. depthOfFieldEnabled: boolean;
  129833. /**
  129834. * Blur level of the depth of field effect. (Higher blur will effect performance)
  129835. */
  129836. depthOfFieldBlurLevel: DepthOfFieldEffectBlurLevel;
  129837. /**
  129838. * If the anti aliasing is enabled.
  129839. */
  129840. fxaaEnabled: boolean;
  129841. private _samples;
  129842. /**
  129843. * MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  129844. */
  129845. samples: number;
  129846. /**
  129847. * If image processing is enabled.
  129848. */
  129849. imageProcessingEnabled: boolean;
  129850. /**
  129851. * If glow layer is enabled. (Adds a glow effect to emmissive materials)
  129852. */
  129853. glowLayerEnabled: boolean;
  129854. /**
  129855. * Gets the glow layer (or null if not defined)
  129856. */
  129857. readonly glowLayer: Nullable<GlowLayer>;
  129858. /**
  129859. * Enable or disable the chromaticAberration process from the pipeline
  129860. */
  129861. chromaticAberrationEnabled: boolean;
  129862. /**
  129863. * Enable or disable the grain process from the pipeline
  129864. */
  129865. grainEnabled: boolean;
  129866. /**
  129867. * @constructor
  129868. * @param name - The rendering pipeline name (default: "")
  129869. * @param hdr - If high dynamic range textures should be used (default: true)
  129870. * @param scene - The scene linked to this pipeline (default: the last created scene)
  129871. * @param cameras - The array of cameras that the rendering pipeline will be attached to (default: scene.cameras)
  129872. * @param automaticBuild - if false, you will have to manually call prepare() to update the pipeline (default: true)
  129873. */
  129874. constructor(name?: string, hdr?: boolean, scene?: Scene, cameras?: Camera[], automaticBuild?: boolean);
  129875. /**
  129876. * Get the class name
  129877. * @returns "DefaultRenderingPipeline"
  129878. */
  129879. getClassName(): string;
  129880. /**
  129881. * Force the compilation of the entire pipeline.
  129882. */
  129883. prepare(): void;
  129884. private _hasCleared;
  129885. private _prevPostProcess;
  129886. private _prevPrevPostProcess;
  129887. private _setAutoClearAndTextureSharing;
  129888. private _depthOfFieldSceneObserver;
  129889. private _buildPipeline;
  129890. private _disposePostProcesses;
  129891. /**
  129892. * Adds a camera to the pipeline
  129893. * @param camera the camera to be added
  129894. */
  129895. addCamera(camera: Camera): void;
  129896. /**
  129897. * Removes a camera from the pipeline
  129898. * @param camera the camera to remove
  129899. */
  129900. removeCamera(camera: Camera): void;
  129901. /**
  129902. * Dispose of the pipeline and stop all post processes
  129903. */
  129904. dispose(): void;
  129905. /**
  129906. * Serialize the rendering pipeline (Used when exporting)
  129907. * @returns the serialized object
  129908. */
  129909. serialize(): any;
  129910. /**
  129911. * Parse the serialized pipeline
  129912. * @param source Source pipeline.
  129913. * @param scene The scene to load the pipeline to.
  129914. * @param rootUrl The URL of the serialized pipeline.
  129915. * @returns An instantiated pipeline from the serialized object.
  129916. */
  129917. static Parse(source: any, scene: Scene, rootUrl: string): DefaultRenderingPipeline;
  129918. }
  129919. }
  129920. declare module BABYLON {
  129921. /** @hidden */
  129922. export var lensHighlightsPixelShader: {
  129923. name: string;
  129924. shader: string;
  129925. };
  129926. }
  129927. declare module BABYLON {
  129928. /** @hidden */
  129929. export var depthOfFieldPixelShader: {
  129930. name: string;
  129931. shader: string;
  129932. };
  129933. }
  129934. declare module BABYLON {
  129935. /**
  129936. * BABYLON.JS Chromatic Aberration GLSL Shader
  129937. * Author: Olivier Guyot
  129938. * Separates very slightly R, G and B colors on the edges of the screen
  129939. * Inspired by Francois Tarlier & Martins Upitis
  129940. */
  129941. export class LensRenderingPipeline extends PostProcessRenderPipeline {
  129942. /**
  129943. * @ignore
  129944. * The chromatic aberration PostProcess id in the pipeline
  129945. */
  129946. LensChromaticAberrationEffect: string;
  129947. /**
  129948. * @ignore
  129949. * The highlights enhancing PostProcess id in the pipeline
  129950. */
  129951. HighlightsEnhancingEffect: string;
  129952. /**
  129953. * @ignore
  129954. * The depth-of-field PostProcess id in the pipeline
  129955. */
  129956. LensDepthOfFieldEffect: string;
  129957. private _scene;
  129958. private _depthTexture;
  129959. private _grainTexture;
  129960. private _chromaticAberrationPostProcess;
  129961. private _highlightsPostProcess;
  129962. private _depthOfFieldPostProcess;
  129963. private _edgeBlur;
  129964. private _grainAmount;
  129965. private _chromaticAberration;
  129966. private _distortion;
  129967. private _highlightsGain;
  129968. private _highlightsThreshold;
  129969. private _dofDistance;
  129970. private _dofAperture;
  129971. private _dofDarken;
  129972. private _dofPentagon;
  129973. private _blurNoise;
  129974. /**
  129975. * @constructor
  129976. *
  129977. * Effect parameters are as follow:
  129978. * {
  129979. * chromatic_aberration: number; // from 0 to x (1 for realism)
  129980. * edge_blur: number; // from 0 to x (1 for realism)
  129981. * distortion: number; // from 0 to x (1 for realism)
  129982. * grain_amount: number; // from 0 to 1
  129983. * grain_texture: BABYLON.Texture; // texture to use for grain effect; if unset, use random B&W noise
  129984. * dof_focus_distance: number; // depth-of-field: focus distance; unset to disable (disabled by default)
  129985. * dof_aperture: number; // depth-of-field: focus blur bias (default: 1)
  129986. * dof_darken: number; // depth-of-field: darken that which is out of focus (from 0 to 1, disabled by default)
  129987. * dof_pentagon: boolean; // depth-of-field: makes a pentagon-like "bokeh" effect
  129988. * dof_gain: number; // depth-of-field: highlights gain; unset to disable (disabled by default)
  129989. * dof_threshold: number; // depth-of-field: highlights threshold (default: 1)
  129990. * blur_noise: boolean; // add a little bit of noise to the blur (default: true)
  129991. * }
  129992. * Note: if an effect parameter is unset, effect is disabled
  129993. *
  129994. * @param name The rendering pipeline name
  129995. * @param parameters - An object containing all parameters (see above)
  129996. * @param scene The scene linked to this pipeline
  129997. * @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)
  129998. * @param cameras The array of cameras that the rendering pipeline will be attached to
  129999. */
  130000. constructor(name: string, parameters: any, scene: Scene, ratio?: number, cameras?: Camera[]);
  130001. /**
  130002. * Get the class name
  130003. * @returns "LensRenderingPipeline"
  130004. */
  130005. getClassName(): string;
  130006. /**
  130007. * Gets associated scene
  130008. */
  130009. readonly scene: Scene;
  130010. /**
  130011. * Gets or sets the edge blur
  130012. */
  130013. edgeBlur: number;
  130014. /**
  130015. * Gets or sets the grain amount
  130016. */
  130017. grainAmount: number;
  130018. /**
  130019. * Gets or sets the chromatic aberration amount
  130020. */
  130021. chromaticAberration: number;
  130022. /**
  130023. * Gets or sets the depth of field aperture
  130024. */
  130025. dofAperture: number;
  130026. /**
  130027. * Gets or sets the edge distortion
  130028. */
  130029. edgeDistortion: number;
  130030. /**
  130031. * Gets or sets the depth of field distortion
  130032. */
  130033. dofDistortion: number;
  130034. /**
  130035. * Gets or sets the darken out of focus amount
  130036. */
  130037. darkenOutOfFocus: number;
  130038. /**
  130039. * Gets or sets a boolean indicating if blur noise is enabled
  130040. */
  130041. blurNoise: boolean;
  130042. /**
  130043. * Gets or sets a boolean indicating if pentagon bokeh is enabled
  130044. */
  130045. pentagonBokeh: boolean;
  130046. /**
  130047. * Gets or sets the highlight grain amount
  130048. */
  130049. highlightsGain: number;
  130050. /**
  130051. * Gets or sets the highlight threshold
  130052. */
  130053. highlightsThreshold: number;
  130054. /**
  130055. * Sets the amount of blur at the edges
  130056. * @param amount blur amount
  130057. */
  130058. setEdgeBlur(amount: number): void;
  130059. /**
  130060. * Sets edge blur to 0
  130061. */
  130062. disableEdgeBlur(): void;
  130063. /**
  130064. * Sets the amout of grain
  130065. * @param amount Amount of grain
  130066. */
  130067. setGrainAmount(amount: number): void;
  130068. /**
  130069. * Set grain amount to 0
  130070. */
  130071. disableGrain(): void;
  130072. /**
  130073. * Sets the chromatic aberration amount
  130074. * @param amount amount of chromatic aberration
  130075. */
  130076. setChromaticAberration(amount: number): void;
  130077. /**
  130078. * Sets chromatic aberration amount to 0
  130079. */
  130080. disableChromaticAberration(): void;
  130081. /**
  130082. * Sets the EdgeDistortion amount
  130083. * @param amount amount of EdgeDistortion
  130084. */
  130085. setEdgeDistortion(amount: number): void;
  130086. /**
  130087. * Sets edge distortion to 0
  130088. */
  130089. disableEdgeDistortion(): void;
  130090. /**
  130091. * Sets the FocusDistance amount
  130092. * @param amount amount of FocusDistance
  130093. */
  130094. setFocusDistance(amount: number): void;
  130095. /**
  130096. * Disables depth of field
  130097. */
  130098. disableDepthOfField(): void;
  130099. /**
  130100. * Sets the Aperture amount
  130101. * @param amount amount of Aperture
  130102. */
  130103. setAperture(amount: number): void;
  130104. /**
  130105. * Sets the DarkenOutOfFocus amount
  130106. * @param amount amount of DarkenOutOfFocus
  130107. */
  130108. setDarkenOutOfFocus(amount: number): void;
  130109. private _pentagonBokehIsEnabled;
  130110. /**
  130111. * Creates a pentagon bokeh effect
  130112. */
  130113. enablePentagonBokeh(): void;
  130114. /**
  130115. * Disables the pentagon bokeh effect
  130116. */
  130117. disablePentagonBokeh(): void;
  130118. /**
  130119. * Enables noise blur
  130120. */
  130121. enableNoiseBlur(): void;
  130122. /**
  130123. * Disables noise blur
  130124. */
  130125. disableNoiseBlur(): void;
  130126. /**
  130127. * Sets the HighlightsGain amount
  130128. * @param amount amount of HighlightsGain
  130129. */
  130130. setHighlightsGain(amount: number): void;
  130131. /**
  130132. * Sets the HighlightsThreshold amount
  130133. * @param amount amount of HighlightsThreshold
  130134. */
  130135. setHighlightsThreshold(amount: number): void;
  130136. /**
  130137. * Disables highlights
  130138. */
  130139. disableHighlights(): void;
  130140. /**
  130141. * Removes the internal pipeline assets and detaches the pipeline from the scene cameras
  130142. * @param disableDepthRender If the scens depth rendering should be disabled (default: false)
  130143. */
  130144. dispose(disableDepthRender?: boolean): void;
  130145. private _createChromaticAberrationPostProcess;
  130146. private _createHighlightsPostProcess;
  130147. private _createDepthOfFieldPostProcess;
  130148. private _createGrainTexture;
  130149. }
  130150. }
  130151. declare module BABYLON {
  130152. /** @hidden */
  130153. export var ssao2PixelShader: {
  130154. name: string;
  130155. shader: string;
  130156. };
  130157. }
  130158. declare module BABYLON {
  130159. /** @hidden */
  130160. export var ssaoCombinePixelShader: {
  130161. name: string;
  130162. shader: string;
  130163. };
  130164. }
  130165. declare module BABYLON {
  130166. /**
  130167. * Render pipeline to produce ssao effect
  130168. */
  130169. export class SSAO2RenderingPipeline extends PostProcessRenderPipeline {
  130170. /**
  130171. * @ignore
  130172. * The PassPostProcess id in the pipeline that contains the original scene color
  130173. */
  130174. SSAOOriginalSceneColorEffect: string;
  130175. /**
  130176. * @ignore
  130177. * The SSAO PostProcess id in the pipeline
  130178. */
  130179. SSAORenderEffect: string;
  130180. /**
  130181. * @ignore
  130182. * The horizontal blur PostProcess id in the pipeline
  130183. */
  130184. SSAOBlurHRenderEffect: string;
  130185. /**
  130186. * @ignore
  130187. * The vertical blur PostProcess id in the pipeline
  130188. */
  130189. SSAOBlurVRenderEffect: string;
  130190. /**
  130191. * @ignore
  130192. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  130193. */
  130194. SSAOCombineRenderEffect: string;
  130195. /**
  130196. * The output strength of the SSAO post-process. Default value is 1.0.
  130197. */
  130198. totalStrength: number;
  130199. /**
  130200. * Maximum depth value to still render AO. A smooth falloff makes the dimming more natural, so there will be no abrupt shading change.
  130201. */
  130202. maxZ: number;
  130203. /**
  130204. * In order to save performances, SSAO radius is clamped on close geometry. This ratio changes by how much
  130205. */
  130206. minZAspect: number;
  130207. private _samples;
  130208. /**
  130209. * Number of samples used for the SSAO calculations. Default value is 8
  130210. */
  130211. samples: number;
  130212. private _textureSamples;
  130213. /**
  130214. * Number of samples to use for antialiasing
  130215. */
  130216. textureSamples: number;
  130217. /**
  130218. * Ratio object used for SSAO ratio and blur ratio
  130219. */
  130220. private _ratio;
  130221. /**
  130222. * Dynamically generated sphere sampler.
  130223. */
  130224. private _sampleSphere;
  130225. /**
  130226. * Blur filter offsets
  130227. */
  130228. private _samplerOffsets;
  130229. private _expensiveBlur;
  130230. /**
  130231. * If bilateral blur should be used
  130232. */
  130233. expensiveBlur: boolean;
  130234. /**
  130235. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 2.0
  130236. */
  130237. radius: number;
  130238. /**
  130239. * The base color of the SSAO post-process
  130240. * The final result is "base + ssao" between [0, 1]
  130241. */
  130242. base: number;
  130243. /**
  130244. * Support test.
  130245. */
  130246. static readonly IsSupported: boolean;
  130247. private _scene;
  130248. private _depthTexture;
  130249. private _normalTexture;
  130250. private _randomTexture;
  130251. private _originalColorPostProcess;
  130252. private _ssaoPostProcess;
  130253. private _blurHPostProcess;
  130254. private _blurVPostProcess;
  130255. private _ssaoCombinePostProcess;
  130256. /**
  130257. * Gets active scene
  130258. */
  130259. readonly scene: Scene;
  130260. /**
  130261. * @constructor
  130262. * @param name The rendering pipeline name
  130263. * @param scene The scene linked to this pipeline
  130264. * @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 }
  130265. * @param cameras The array of cameras that the rendering pipeline will be attached to
  130266. */
  130267. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[]);
  130268. /**
  130269. * Get the class name
  130270. * @returns "SSAO2RenderingPipeline"
  130271. */
  130272. getClassName(): string;
  130273. /**
  130274. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  130275. */
  130276. dispose(disableGeometryBufferRenderer?: boolean): void;
  130277. private _createBlurPostProcess;
  130278. /** @hidden */
  130279. _rebuild(): void;
  130280. private _bits;
  130281. private _radicalInverse_VdC;
  130282. private _hammersley;
  130283. private _hemisphereSample_uniform;
  130284. private _generateHemisphere;
  130285. private _createSSAOPostProcess;
  130286. private _createSSAOCombinePostProcess;
  130287. private _createRandomTexture;
  130288. /**
  130289. * Serialize the rendering pipeline (Used when exporting)
  130290. * @returns the serialized object
  130291. */
  130292. serialize(): any;
  130293. /**
  130294. * Parse the serialized pipeline
  130295. * @param source Source pipeline.
  130296. * @param scene The scene to load the pipeline to.
  130297. * @param rootUrl The URL of the serialized pipeline.
  130298. * @returns An instantiated pipeline from the serialized object.
  130299. */
  130300. static Parse(source: any, scene: Scene, rootUrl: string): SSAO2RenderingPipeline;
  130301. }
  130302. }
  130303. declare module BABYLON {
  130304. /** @hidden */
  130305. export var ssaoPixelShader: {
  130306. name: string;
  130307. shader: string;
  130308. };
  130309. }
  130310. declare module BABYLON {
  130311. /**
  130312. * Render pipeline to produce ssao effect
  130313. */
  130314. export class SSAORenderingPipeline extends PostProcessRenderPipeline {
  130315. /**
  130316. * @ignore
  130317. * The PassPostProcess id in the pipeline that contains the original scene color
  130318. */
  130319. SSAOOriginalSceneColorEffect: string;
  130320. /**
  130321. * @ignore
  130322. * The SSAO PostProcess id in the pipeline
  130323. */
  130324. SSAORenderEffect: string;
  130325. /**
  130326. * @ignore
  130327. * The horizontal blur PostProcess id in the pipeline
  130328. */
  130329. SSAOBlurHRenderEffect: string;
  130330. /**
  130331. * @ignore
  130332. * The vertical blur PostProcess id in the pipeline
  130333. */
  130334. SSAOBlurVRenderEffect: string;
  130335. /**
  130336. * @ignore
  130337. * The PostProcess id in the pipeline that combines the SSAO-Blur output with the original scene color (SSAOOriginalSceneColorEffect)
  130338. */
  130339. SSAOCombineRenderEffect: string;
  130340. /**
  130341. * The output strength of the SSAO post-process. Default value is 1.0.
  130342. */
  130343. totalStrength: number;
  130344. /**
  130345. * The radius around the analyzed pixel used by the SSAO post-process. Default value is 0.0006
  130346. */
  130347. radius: number;
  130348. /**
  130349. * Related to fallOff, used to interpolate SSAO samples (first interpolate function input) based on the occlusion difference of each pixel
  130350. * Must not be equal to fallOff and superior to fallOff.
  130351. * Default value is 0.0075
  130352. */
  130353. area: number;
  130354. /**
  130355. * Related to area, used to interpolate SSAO samples (second interpolate function input) based on the occlusion difference of each pixel
  130356. * Must not be equal to area and inferior to area.
  130357. * Default value is 0.000001
  130358. */
  130359. fallOff: number;
  130360. /**
  130361. * The base color of the SSAO post-process
  130362. * The final result is "base + ssao" between [0, 1]
  130363. */
  130364. base: number;
  130365. private _scene;
  130366. private _depthTexture;
  130367. private _randomTexture;
  130368. private _originalColorPostProcess;
  130369. private _ssaoPostProcess;
  130370. private _blurHPostProcess;
  130371. private _blurVPostProcess;
  130372. private _ssaoCombinePostProcess;
  130373. private _firstUpdate;
  130374. /**
  130375. * Gets active scene
  130376. */
  130377. readonly scene: Scene;
  130378. /**
  130379. * @constructor
  130380. * @param name - The rendering pipeline name
  130381. * @param scene - The scene linked to this pipeline
  130382. * @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 }
  130383. * @param cameras - The array of cameras that the rendering pipeline will be attached to
  130384. */
  130385. constructor(name: string, scene: Scene, ratio: any, cameras?: Camera[]);
  130386. /**
  130387. * Get the class name
  130388. * @returns "SSAORenderingPipeline"
  130389. */
  130390. getClassName(): string;
  130391. /**
  130392. * Removes the internal pipeline assets and detatches the pipeline from the scene cameras
  130393. */
  130394. dispose(disableDepthRender?: boolean): void;
  130395. private _createBlurPostProcess;
  130396. /** @hidden */
  130397. _rebuild(): void;
  130398. private _createSSAOPostProcess;
  130399. private _createSSAOCombinePostProcess;
  130400. private _createRandomTexture;
  130401. }
  130402. }
  130403. declare module BABYLON {
  130404. /** @hidden */
  130405. export var standardPixelShader: {
  130406. name: string;
  130407. shader: string;
  130408. };
  130409. }
  130410. declare module BABYLON {
  130411. /**
  130412. * Standard rendering pipeline
  130413. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  130414. * @see https://doc.babylonjs.com/how_to/using_standard_rendering_pipeline
  130415. */
  130416. export class StandardRenderingPipeline extends PostProcessRenderPipeline implements IDisposable, IAnimatable {
  130417. /**
  130418. * Public members
  130419. */
  130420. /**
  130421. * Post-process which contains the original scene color before the pipeline applies all the effects
  130422. */
  130423. originalPostProcess: Nullable<PostProcess>;
  130424. /**
  130425. * Post-process used to down scale an image x4
  130426. */
  130427. downSampleX4PostProcess: Nullable<PostProcess>;
  130428. /**
  130429. * Post-process used to calculate the illuminated surfaces controlled by a threshold
  130430. */
  130431. brightPassPostProcess: Nullable<PostProcess>;
  130432. /**
  130433. * Post-process array storing all the horizontal blur post-processes used by the pipeline
  130434. */
  130435. blurHPostProcesses: PostProcess[];
  130436. /**
  130437. * Post-process array storing all the vertical blur post-processes used by the pipeline
  130438. */
  130439. blurVPostProcesses: PostProcess[];
  130440. /**
  130441. * Post-process used to add colors of 2 textures (typically brightness + real scene color)
  130442. */
  130443. textureAdderPostProcess: Nullable<PostProcess>;
  130444. /**
  130445. * Post-process used to create volumetric lighting effect
  130446. */
  130447. volumetricLightPostProcess: Nullable<PostProcess>;
  130448. /**
  130449. * Post-process used to smooth the previous volumetric light post-process on the X axis
  130450. */
  130451. volumetricLightSmoothXPostProcess: Nullable<BlurPostProcess>;
  130452. /**
  130453. * Post-process used to smooth the previous volumetric light post-process on the Y axis
  130454. */
  130455. volumetricLightSmoothYPostProcess: Nullable<BlurPostProcess>;
  130456. /**
  130457. * Post-process used to merge the volumetric light effect and the real scene color
  130458. */
  130459. volumetricLightMergePostProces: Nullable<PostProcess>;
  130460. /**
  130461. * Post-process used to store the final volumetric light post-process (attach/detach for debug purpose)
  130462. */
  130463. volumetricLightFinalPostProcess: Nullable<PostProcess>;
  130464. /**
  130465. * Base post-process used to calculate the average luminance of the final image for HDR
  130466. */
  130467. luminancePostProcess: Nullable<PostProcess>;
  130468. /**
  130469. * Post-processes used to create down sample post-processes in order to get
  130470. * the average luminance of the final image for HDR
  130471. * Array of length "StandardRenderingPipeline.LuminanceSteps"
  130472. */
  130473. luminanceDownSamplePostProcesses: PostProcess[];
  130474. /**
  130475. * Post-process used to create a HDR effect (light adaptation)
  130476. */
  130477. hdrPostProcess: Nullable<PostProcess>;
  130478. /**
  130479. * Post-process used to store the final texture adder post-process (attach/detach for debug purpose)
  130480. */
  130481. textureAdderFinalPostProcess: Nullable<PostProcess>;
  130482. /**
  130483. * Post-process used to store the final lens flare post-process (attach/detach for debug purpose)
  130484. */
  130485. lensFlareFinalPostProcess: Nullable<PostProcess>;
  130486. /**
  130487. * Post-process used to merge the final HDR post-process and the real scene color
  130488. */
  130489. hdrFinalPostProcess: Nullable<PostProcess>;
  130490. /**
  130491. * Post-process used to create a lens flare effect
  130492. */
  130493. lensFlarePostProcess: Nullable<PostProcess>;
  130494. /**
  130495. * Post-process that merges the result of the lens flare post-process and the real scene color
  130496. */
  130497. lensFlareComposePostProcess: Nullable<PostProcess>;
  130498. /**
  130499. * Post-process used to create a motion blur effect
  130500. */
  130501. motionBlurPostProcess: Nullable<PostProcess>;
  130502. /**
  130503. * Post-process used to create a depth of field effect
  130504. */
  130505. depthOfFieldPostProcess: Nullable<PostProcess>;
  130506. /**
  130507. * The Fast Approximate Anti-Aliasing post process which attemps to remove aliasing from an image.
  130508. */
  130509. fxaaPostProcess: Nullable<FxaaPostProcess>;
  130510. /**
  130511. * Represents the brightness threshold in order to configure the illuminated surfaces
  130512. */
  130513. brightThreshold: number;
  130514. /**
  130515. * Configures the blur intensity used for surexposed surfaces are highlighted surfaces (light halo)
  130516. */
  130517. blurWidth: number;
  130518. /**
  130519. * Sets if the blur for highlighted surfaces must be only horizontal
  130520. */
  130521. horizontalBlur: boolean;
  130522. /**
  130523. * Gets the overall exposure used by the pipeline
  130524. */
  130525. /**
  130526. * Sets the overall exposure used by the pipeline
  130527. */
  130528. exposure: number;
  130529. /**
  130530. * Texture used typically to simulate "dirty" on camera lens
  130531. */
  130532. lensTexture: Nullable<Texture>;
  130533. /**
  130534. * Represents the offset coefficient based on Rayleigh principle. Typically in interval [-0.2, 0.2]
  130535. */
  130536. volumetricLightCoefficient: number;
  130537. /**
  130538. * The overall power of volumetric lights, typically in interval [0, 10] maximum
  130539. */
  130540. volumetricLightPower: number;
  130541. /**
  130542. * Used the set the blur intensity to smooth the volumetric lights
  130543. */
  130544. volumetricLightBlurScale: number;
  130545. /**
  130546. * Light (spot or directional) used to generate the volumetric lights rays
  130547. * The source light must have a shadow generate so the pipeline can get its
  130548. * depth map
  130549. */
  130550. sourceLight: Nullable<SpotLight | DirectionalLight>;
  130551. /**
  130552. * For eye adaptation, represents the minimum luminance the eye can see
  130553. */
  130554. hdrMinimumLuminance: number;
  130555. /**
  130556. * For eye adaptation, represents the decrease luminance speed
  130557. */
  130558. hdrDecreaseRate: number;
  130559. /**
  130560. * For eye adaptation, represents the increase luminance speed
  130561. */
  130562. hdrIncreaseRate: number;
  130563. /**
  130564. * Gets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  130565. */
  130566. /**
  130567. * Sets wether or not the exposure of the overall pipeline should be automatically adjusted by the HDR post-process
  130568. */
  130569. hdrAutoExposure: boolean;
  130570. /**
  130571. * Lens color texture used by the lens flare effect. Mandatory if lens flare effect enabled
  130572. */
  130573. lensColorTexture: Nullable<Texture>;
  130574. /**
  130575. * The overall strengh for the lens flare effect
  130576. */
  130577. lensFlareStrength: number;
  130578. /**
  130579. * Dispersion coefficient for lens flare ghosts
  130580. */
  130581. lensFlareGhostDispersal: number;
  130582. /**
  130583. * Main lens flare halo width
  130584. */
  130585. lensFlareHaloWidth: number;
  130586. /**
  130587. * Based on the lens distortion effect, defines how much the lens flare result
  130588. * is distorted
  130589. */
  130590. lensFlareDistortionStrength: number;
  130591. /**
  130592. * Configures the blur intensity used for for lens flare (halo)
  130593. */
  130594. lensFlareBlurWidth: number;
  130595. /**
  130596. * Lens star texture must be used to simulate rays on the flares and is available
  130597. * in the documentation
  130598. */
  130599. lensStarTexture: Nullable<Texture>;
  130600. /**
  130601. * As the "lensTexture" (can be the same texture or different), it is used to apply the lens
  130602. * flare effect by taking account of the dirt texture
  130603. */
  130604. lensFlareDirtTexture: Nullable<Texture>;
  130605. /**
  130606. * Represents the focal length for the depth of field effect
  130607. */
  130608. depthOfFieldDistance: number;
  130609. /**
  130610. * Represents the blur intensity for the blurred part of the depth of field effect
  130611. */
  130612. depthOfFieldBlurWidth: number;
  130613. /**
  130614. * Gets how much the image is blurred by the movement while using the motion blur post-process
  130615. */
  130616. /**
  130617. * Sets how much the image is blurred by the movement while using the motion blur post-process
  130618. */
  130619. motionStrength: number;
  130620. /**
  130621. * Gets wether or not the motion blur post-process is object based or screen based.
  130622. */
  130623. /**
  130624. * Sets wether or not the motion blur post-process should be object based or screen based
  130625. */
  130626. objectBasedMotionBlur: boolean;
  130627. /**
  130628. * List of animations for the pipeline (IAnimatable implementation)
  130629. */
  130630. animations: Animation[];
  130631. /**
  130632. * Private members
  130633. */
  130634. private _scene;
  130635. private _currentDepthOfFieldSource;
  130636. private _basePostProcess;
  130637. private _fixedExposure;
  130638. private _currentExposure;
  130639. private _hdrAutoExposure;
  130640. private _hdrCurrentLuminance;
  130641. private _motionStrength;
  130642. private _isObjectBasedMotionBlur;
  130643. private _floatTextureType;
  130644. private _camerasToBeAttached;
  130645. private _ratio;
  130646. private _bloomEnabled;
  130647. private _depthOfFieldEnabled;
  130648. private _vlsEnabled;
  130649. private _lensFlareEnabled;
  130650. private _hdrEnabled;
  130651. private _motionBlurEnabled;
  130652. private _fxaaEnabled;
  130653. private _motionBlurSamples;
  130654. private _volumetricLightStepsCount;
  130655. private _samples;
  130656. /**
  130657. * @ignore
  130658. * Specifies if the bloom pipeline is enabled
  130659. */
  130660. BloomEnabled: boolean;
  130661. /**
  130662. * @ignore
  130663. * Specifies if the depth of field pipeline is enabed
  130664. */
  130665. DepthOfFieldEnabled: boolean;
  130666. /**
  130667. * @ignore
  130668. * Specifies if the lens flare pipeline is enabed
  130669. */
  130670. LensFlareEnabled: boolean;
  130671. /**
  130672. * @ignore
  130673. * Specifies if the HDR pipeline is enabled
  130674. */
  130675. HDREnabled: boolean;
  130676. /**
  130677. * @ignore
  130678. * Specifies if the volumetric lights scattering effect is enabled
  130679. */
  130680. VLSEnabled: boolean;
  130681. /**
  130682. * @ignore
  130683. * Specifies if the motion blur effect is enabled
  130684. */
  130685. MotionBlurEnabled: boolean;
  130686. /**
  130687. * Specifies if anti-aliasing is enabled
  130688. */
  130689. fxaaEnabled: boolean;
  130690. /**
  130691. * Specifies the number of steps used to calculate the volumetric lights
  130692. * Typically in interval [50, 200]
  130693. */
  130694. volumetricLightStepsCount: number;
  130695. /**
  130696. * Specifies the number of samples used for the motion blur effect
  130697. * Typically in interval [16, 64]
  130698. */
  130699. motionBlurSamples: number;
  130700. /**
  130701. * Specifies MSAA sample count, setting this to 4 will provide 4x anti aliasing. (default: 1)
  130702. */
  130703. samples: number;
  130704. /**
  130705. * Default pipeline should be used going forward but the standard pipeline will be kept for backwards compatibility.
  130706. * @constructor
  130707. * @param name The rendering pipeline name
  130708. * @param scene The scene linked to this pipeline
  130709. * @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)
  130710. * @param originalPostProcess the custom original color post-process. Must be "reusable". Can be null.
  130711. * @param cameras The array of cameras that the rendering pipeline will be attached to
  130712. */
  130713. constructor(name: string, scene: Scene, ratio: number, originalPostProcess?: Nullable<PostProcess>, cameras?: Camera[]);
  130714. private _buildPipeline;
  130715. private _createDownSampleX4PostProcess;
  130716. private _createBrightPassPostProcess;
  130717. private _createBlurPostProcesses;
  130718. private _createTextureAdderPostProcess;
  130719. private _createVolumetricLightPostProcess;
  130720. private _createLuminancePostProcesses;
  130721. private _createHdrPostProcess;
  130722. private _createLensFlarePostProcess;
  130723. private _createDepthOfFieldPostProcess;
  130724. private _createMotionBlurPostProcess;
  130725. private _getDepthTexture;
  130726. private _disposePostProcesses;
  130727. /**
  130728. * Dispose of the pipeline and stop all post processes
  130729. */
  130730. dispose(): void;
  130731. /**
  130732. * Serialize the rendering pipeline (Used when exporting)
  130733. * @returns the serialized object
  130734. */
  130735. serialize(): any;
  130736. /**
  130737. * Parse the serialized pipeline
  130738. * @param source Source pipeline.
  130739. * @param scene The scene to load the pipeline to.
  130740. * @param rootUrl The URL of the serialized pipeline.
  130741. * @returns An instantiated pipeline from the serialized object.
  130742. */
  130743. static Parse(source: any, scene: Scene, rootUrl: string): StandardRenderingPipeline;
  130744. /**
  130745. * Luminance steps
  130746. */
  130747. static LuminanceSteps: number;
  130748. }
  130749. }
  130750. declare module BABYLON {
  130751. /** @hidden */
  130752. export var tonemapPixelShader: {
  130753. name: string;
  130754. shader: string;
  130755. };
  130756. }
  130757. declare module BABYLON {
  130758. /** Defines operator used for tonemapping */
  130759. export enum TonemappingOperator {
  130760. /** Hable */
  130761. Hable = 0,
  130762. /** Reinhard */
  130763. Reinhard = 1,
  130764. /** HejiDawson */
  130765. HejiDawson = 2,
  130766. /** Photographic */
  130767. Photographic = 3
  130768. }
  130769. /**
  130770. * Defines a post process to apply tone mapping
  130771. */
  130772. export class TonemapPostProcess extends PostProcess {
  130773. private _operator;
  130774. /** Defines the required exposure adjustement */
  130775. exposureAdjustment: number;
  130776. /**
  130777. * Creates a new TonemapPostProcess
  130778. * @param name defines the name of the postprocess
  130779. * @param _operator defines the operator to use
  130780. * @param exposureAdjustment defines the required exposure adjustement
  130781. * @param camera defines the camera to use (can be null)
  130782. * @param samplingMode defines the required sampling mode (BABYLON.Texture.BILINEAR_SAMPLINGMODE by default)
  130783. * @param engine defines the hosting engine (can be ignore if camera is set)
  130784. * @param textureFormat defines the texture format to use (BABYLON.Engine.TEXTURETYPE_UNSIGNED_INT by default)
  130785. */
  130786. constructor(name: string, _operator: TonemappingOperator,
  130787. /** Defines the required exposure adjustement */
  130788. exposureAdjustment: number, camera: Camera, samplingMode?: number, engine?: Engine, textureFormat?: number);
  130789. }
  130790. }
  130791. declare module BABYLON {
  130792. /** @hidden */
  130793. export var depthVertexShader: {
  130794. name: string;
  130795. shader: string;
  130796. };
  130797. }
  130798. declare module BABYLON {
  130799. /** @hidden */
  130800. export var volumetricLightScatteringPixelShader: {
  130801. name: string;
  130802. shader: string;
  130803. };
  130804. }
  130805. declare module BABYLON {
  130806. /** @hidden */
  130807. export var volumetricLightScatteringPassVertexShader: {
  130808. name: string;
  130809. shader: string;
  130810. };
  130811. }
  130812. declare module BABYLON {
  130813. /** @hidden */
  130814. export var volumetricLightScatteringPassPixelShader: {
  130815. name: string;
  130816. shader: string;
  130817. };
  130818. }
  130819. declare module BABYLON {
  130820. /**
  130821. * Inspired by http://http.developer.nvidia.com/GPUGems3/gpugems3_ch13.html
  130822. */
  130823. export class VolumetricLightScatteringPostProcess extends PostProcess {
  130824. private _volumetricLightScatteringPass;
  130825. private _volumetricLightScatteringRTT;
  130826. private _viewPort;
  130827. private _screenCoordinates;
  130828. private _cachedDefines;
  130829. /**
  130830. * If not undefined, the mesh position is computed from the attached node position
  130831. */
  130832. attachedNode: {
  130833. position: Vector3;
  130834. };
  130835. /**
  130836. * Custom position of the mesh. Used if "useCustomMeshPosition" is set to "true"
  130837. */
  130838. customMeshPosition: Vector3;
  130839. /**
  130840. * Set if the post-process should use a custom position for the light source (true) or the internal mesh position (false)
  130841. */
  130842. useCustomMeshPosition: boolean;
  130843. /**
  130844. * If the post-process should inverse the light scattering direction
  130845. */
  130846. invert: boolean;
  130847. /**
  130848. * The internal mesh used by the post-process
  130849. */
  130850. mesh: Mesh;
  130851. /**
  130852. * @hidden
  130853. * VolumetricLightScatteringPostProcess.useDiffuseColor is no longer used, use the mesh material directly instead
  130854. */
  130855. useDiffuseColor: boolean;
  130856. /**
  130857. * Array containing the excluded meshes not rendered in the internal pass
  130858. */
  130859. excludedMeshes: AbstractMesh[];
  130860. /**
  130861. * Controls the overall intensity of the post-process
  130862. */
  130863. exposure: number;
  130864. /**
  130865. * Dissipates each sample's contribution in range [0, 1]
  130866. */
  130867. decay: number;
  130868. /**
  130869. * Controls the overall intensity of each sample
  130870. */
  130871. weight: number;
  130872. /**
  130873. * Controls the density of each sample
  130874. */
  130875. density: number;
  130876. /**
  130877. * @constructor
  130878. * @param name The post-process name
  130879. * @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)
  130880. * @param camera The camera that the post-process will be attached to
  130881. * @param mesh The mesh used to create the light scattering
  130882. * @param samples The post-process quality, default 100
  130883. * @param samplingModeThe post-process filtering mode
  130884. * @param engine The babylon engine
  130885. * @param reusable If the post-process is reusable
  130886. * @param scene The constructor needs a scene reference to initialize internal components. If "camera" is null a "scene" must be provided
  130887. */
  130888. constructor(name: string, ratio: any, camera: Camera, mesh?: Mesh, samples?: number, samplingMode?: number, engine?: Engine, reusable?: boolean, scene?: Scene);
  130889. /**
  130890. * Returns the string "VolumetricLightScatteringPostProcess"
  130891. * @returns "VolumetricLightScatteringPostProcess"
  130892. */
  130893. getClassName(): string;
  130894. private _isReady;
  130895. /**
  130896. * Sets the new light position for light scattering effect
  130897. * @param position The new custom light position
  130898. */
  130899. setCustomMeshPosition(position: Vector3): void;
  130900. /**
  130901. * Returns the light position for light scattering effect
  130902. * @return Vector3 The custom light position
  130903. */
  130904. getCustomMeshPosition(): Vector3;
  130905. /**
  130906. * Disposes the internal assets and detaches the post-process from the camera
  130907. */
  130908. dispose(camera: Camera): void;
  130909. /**
  130910. * Returns the render target texture used by the post-process
  130911. * @return the render target texture used by the post-process
  130912. */
  130913. getPass(): RenderTargetTexture;
  130914. private _meshExcluded;
  130915. private _createPass;
  130916. private _updateMeshScreenCoordinates;
  130917. /**
  130918. * Creates a default mesh for the Volumeric Light Scattering post-process
  130919. * @param name The mesh name
  130920. * @param scene The scene where to create the mesh
  130921. * @return the default mesh
  130922. */
  130923. static CreateDefaultMesh(name: string, scene: Scene): Mesh;
  130924. }
  130925. }
  130926. declare module BABYLON {
  130927. interface Scene {
  130928. /** @hidden (Backing field) */
  130929. _boundingBoxRenderer: BoundingBoxRenderer;
  130930. /** @hidden (Backing field) */
  130931. _forceShowBoundingBoxes: boolean;
  130932. /**
  130933. * Gets or sets a boolean indicating if all bounding boxes must be rendered
  130934. */
  130935. forceShowBoundingBoxes: boolean;
  130936. /**
  130937. * Gets the bounding box renderer associated with the scene
  130938. * @returns a BoundingBoxRenderer
  130939. */
  130940. getBoundingBoxRenderer(): BoundingBoxRenderer;
  130941. }
  130942. interface AbstractMesh {
  130943. /** @hidden (Backing field) */
  130944. _showBoundingBox: boolean;
  130945. /**
  130946. * Gets or sets a boolean indicating if the bounding box must be rendered as well (false by default)
  130947. */
  130948. showBoundingBox: boolean;
  130949. }
  130950. /**
  130951. * Component responsible of rendering the bounding box of the meshes in a scene.
  130952. * This is usually used through the mesh.showBoundingBox or the scene.forceShowBoundingBoxes properties
  130953. */
  130954. export class BoundingBoxRenderer implements ISceneComponent {
  130955. /**
  130956. * The component name helpfull to identify the component in the list of scene components.
  130957. */
  130958. readonly name: string;
  130959. /**
  130960. * The scene the component belongs to.
  130961. */
  130962. scene: Scene;
  130963. /**
  130964. * Color of the bounding box lines placed in front of an object
  130965. */
  130966. frontColor: Color3;
  130967. /**
  130968. * Color of the bounding box lines placed behind an object
  130969. */
  130970. backColor: Color3;
  130971. /**
  130972. * Defines if the renderer should show the back lines or not
  130973. */
  130974. showBackLines: boolean;
  130975. /**
  130976. * @hidden
  130977. */
  130978. renderList: SmartArray<BoundingBox>;
  130979. private _colorShader;
  130980. private _vertexBuffers;
  130981. private _indexBuffer;
  130982. private _fillIndexBuffer;
  130983. private _fillIndexData;
  130984. /**
  130985. * Instantiates a new bounding box renderer in a scene.
  130986. * @param scene the scene the renderer renders in
  130987. */
  130988. constructor(scene: Scene);
  130989. /**
  130990. * Registers the component in a given scene
  130991. */
  130992. register(): void;
  130993. private _evaluateSubMesh;
  130994. private _activeMesh;
  130995. private _prepareRessources;
  130996. private _createIndexBuffer;
  130997. /**
  130998. * Rebuilds the elements related to this component in case of
  130999. * context lost for instance.
  131000. */
  131001. rebuild(): void;
  131002. /**
  131003. * @hidden
  131004. */
  131005. reset(): void;
  131006. /**
  131007. * Render the bounding boxes of a specific rendering group
  131008. * @param renderingGroupId defines the rendering group to render
  131009. */
  131010. render(renderingGroupId: number): void;
  131011. /**
  131012. * In case of occlusion queries, we can render the occlusion bounding box through this method
  131013. * @param mesh Define the mesh to render the occlusion bounding box for
  131014. */
  131015. renderOcclusionBoundingBox(mesh: AbstractMesh): void;
  131016. /**
  131017. * Dispose and release the resources attached to this renderer.
  131018. */
  131019. dispose(): void;
  131020. }
  131021. }
  131022. declare module BABYLON {
  131023. /** @hidden */
  131024. export var depthPixelShader: {
  131025. name: string;
  131026. shader: string;
  131027. };
  131028. }
  131029. declare module BABYLON {
  131030. /**
  131031. * This represents a depth renderer in Babylon.
  131032. * A depth renderer will render to it's depth map every frame which can be displayed or used in post processing
  131033. */
  131034. export class DepthRenderer {
  131035. private _scene;
  131036. private _depthMap;
  131037. private _effect;
  131038. private readonly _storeNonLinearDepth;
  131039. private readonly _clearColor;
  131040. /** Get if the depth renderer is using packed depth or not */
  131041. readonly isPacked: boolean;
  131042. private _cachedDefines;
  131043. private _camera;
  131044. /**
  131045. * Specifiess that the depth renderer will only be used within
  131046. * the camera it is created for.
  131047. * This can help forcing its rendering during the camera processing.
  131048. */
  131049. useOnlyInActiveCamera: boolean;
  131050. /** @hidden */
  131051. static _SceneComponentInitialization: (scene: Scene) => void;
  131052. /**
  131053. * Instantiates a depth renderer
  131054. * @param scene The scene the renderer belongs to
  131055. * @param type The texture type of the depth map (default: Engine.TEXTURETYPE_FLOAT)
  131056. * @param camera The camera to be used to render the depth map (default: scene's active camera)
  131057. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  131058. */
  131059. constructor(scene: Scene, type?: number, camera?: Nullable<Camera>, storeNonLinearDepth?: boolean);
  131060. /**
  131061. * Creates the depth rendering effect and checks if the effect is ready.
  131062. * @param subMesh The submesh to be used to render the depth map of
  131063. * @param useInstances If multiple world instances should be used
  131064. * @returns if the depth renderer is ready to render the depth map
  131065. */
  131066. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  131067. /**
  131068. * Gets the texture which the depth map will be written to.
  131069. * @returns The depth map texture
  131070. */
  131071. getDepthMap(): RenderTargetTexture;
  131072. /**
  131073. * Disposes of the depth renderer.
  131074. */
  131075. dispose(): void;
  131076. }
  131077. }
  131078. declare module BABYLON {
  131079. interface Scene {
  131080. /** @hidden (Backing field) */
  131081. _depthRenderer: {
  131082. [id: string]: DepthRenderer;
  131083. };
  131084. /**
  131085. * Creates a depth renderer a given camera which contains a depth map which can be used for post processing.
  131086. * @param camera The camera to create the depth renderer on (default: scene's active camera)
  131087. * @param storeNonLinearDepth Defines whether the depth is stored linearly like in Babylon Shadows or directly like glFragCoord.z
  131088. * @returns the created depth renderer
  131089. */
  131090. enableDepthRenderer(camera?: Nullable<Camera>, storeNonLinearDepth?: boolean): DepthRenderer;
  131091. /**
  131092. * Disables a depth renderer for a given camera
  131093. * @param camera The camera to disable the depth renderer on (default: scene's active camera)
  131094. */
  131095. disableDepthRenderer(camera?: Nullable<Camera>): void;
  131096. }
  131097. /**
  131098. * Defines the Depth Renderer scene component responsible to manage a depth buffer useful
  131099. * in several rendering techniques.
  131100. */
  131101. export class DepthRendererSceneComponent implements ISceneComponent {
  131102. /**
  131103. * The component name helpfull to identify the component in the list of scene components.
  131104. */
  131105. readonly name: string;
  131106. /**
  131107. * The scene the component belongs to.
  131108. */
  131109. scene: Scene;
  131110. /**
  131111. * Creates a new instance of the component for the given scene
  131112. * @param scene Defines the scene to register the component in
  131113. */
  131114. constructor(scene: Scene);
  131115. /**
  131116. * Registers the component in a given scene
  131117. */
  131118. register(): void;
  131119. /**
  131120. * Rebuilds the elements related to this component in case of
  131121. * context lost for instance.
  131122. */
  131123. rebuild(): void;
  131124. /**
  131125. * Disposes the component and the associated ressources
  131126. */
  131127. dispose(): void;
  131128. private _gatherRenderTargets;
  131129. private _gatherActiveCameraRenderTargets;
  131130. }
  131131. }
  131132. declare module BABYLON {
  131133. /** @hidden */
  131134. export var outlinePixelShader: {
  131135. name: string;
  131136. shader: string;
  131137. };
  131138. }
  131139. declare module BABYLON {
  131140. /** @hidden */
  131141. export var outlineVertexShader: {
  131142. name: string;
  131143. shader: string;
  131144. };
  131145. }
  131146. declare module BABYLON {
  131147. interface Scene {
  131148. /** @hidden */
  131149. _outlineRenderer: OutlineRenderer;
  131150. /**
  131151. * Gets the outline renderer associated with the scene
  131152. * @returns a OutlineRenderer
  131153. */
  131154. getOutlineRenderer(): OutlineRenderer;
  131155. }
  131156. interface AbstractMesh {
  131157. /** @hidden (Backing field) */
  131158. _renderOutline: boolean;
  131159. /**
  131160. * Gets or sets a boolean indicating if the outline must be rendered as well
  131161. * @see https://www.babylonjs-playground.com/#10WJ5S#3
  131162. */
  131163. renderOutline: boolean;
  131164. /** @hidden (Backing field) */
  131165. _renderOverlay: boolean;
  131166. /**
  131167. * Gets or sets a boolean indicating if the overlay must be rendered as well
  131168. * @see https://www.babylonjs-playground.com/#10WJ5S#2
  131169. */
  131170. renderOverlay: boolean;
  131171. }
  131172. /**
  131173. * This class is responsible to draw bothe outline/overlay of meshes.
  131174. * It should not be used directly but through the available method on mesh.
  131175. */
  131176. export class OutlineRenderer implements ISceneComponent {
  131177. /**
  131178. * Stencil value used to avoid outline being seen within the mesh when the mesh is transparent
  131179. */
  131180. private static _StencilReference;
  131181. /**
  131182. * The name of the component. Each component must have a unique name.
  131183. */
  131184. name: string;
  131185. /**
  131186. * The scene the component belongs to.
  131187. */
  131188. scene: Scene;
  131189. /**
  131190. * Defines a zOffset to prevent zFighting between the overlay and the mesh.
  131191. */
  131192. zOffset: number;
  131193. private _engine;
  131194. private _effect;
  131195. private _cachedDefines;
  131196. private _savedDepthWrite;
  131197. /**
  131198. * Instantiates a new outline renderer. (There could be only one per scene).
  131199. * @param scene Defines the scene it belongs to
  131200. */
  131201. constructor(scene: Scene);
  131202. /**
  131203. * Register the component to one instance of a scene.
  131204. */
  131205. register(): void;
  131206. /**
  131207. * Rebuilds the elements related to this component in case of
  131208. * context lost for instance.
  131209. */
  131210. rebuild(): void;
  131211. /**
  131212. * Disposes the component and the associated ressources.
  131213. */
  131214. dispose(): void;
  131215. /**
  131216. * Renders the outline in the canvas.
  131217. * @param subMesh Defines the sumesh to render
  131218. * @param batch Defines the batch of meshes in case of instances
  131219. * @param useOverlay Defines if the rendering is for the overlay or the outline
  131220. */
  131221. render(subMesh: SubMesh, batch: _InstancesBatch, useOverlay?: boolean): void;
  131222. /**
  131223. * Returns whether or not the outline renderer is ready for a given submesh.
  131224. * All the dependencies e.g. submeshes, texture, effect... mus be ready
  131225. * @param subMesh Defines the submesh to check readyness for
  131226. * @param useInstances Defines wheter wee are trying to render instances or not
  131227. * @returns true if ready otherwise false
  131228. */
  131229. isReady(subMesh: SubMesh, useInstances: boolean): boolean;
  131230. private _beforeRenderingMesh;
  131231. private _afterRenderingMesh;
  131232. }
  131233. }
  131234. declare module BABYLON {
  131235. /**
  131236. * Class used to manage multiple sprites of different sizes on the same spritesheet
  131237. * @see http://doc.babylonjs.com/babylon101/sprites
  131238. */
  131239. export class SpritePackedManager extends SpriteManager {
  131240. /** defines the packed manager's name */
  131241. name: string;
  131242. /**
  131243. * Creates a new sprite manager from a packed sprite sheet
  131244. * @param name defines the manager's name
  131245. * @param imgUrl defines the sprite sheet url
  131246. * @param capacity defines the maximum allowed number of sprites
  131247. * @param scene defines the hosting scene
  131248. * @param spriteJSON null otherwise a JSON object defining sprite sheet data
  131249. * @param epsilon defines the epsilon value to align texture (0.01 by default)
  131250. * @param samplingMode defines the smapling mode to use with spritesheet
  131251. * @param fromPacked set to true; do not alter
  131252. */
  131253. constructor(
  131254. /** defines the packed manager's name */
  131255. name: string, imgUrl: string, capacity: number, scene: Scene, spriteJSON?: string | null, epsilon?: number, samplingMode?: number);
  131256. }
  131257. }
  131258. declare module BABYLON {
  131259. /**
  131260. * Defines the list of states available for a task inside a AssetsManager
  131261. */
  131262. export enum AssetTaskState {
  131263. /**
  131264. * Initialization
  131265. */
  131266. INIT = 0,
  131267. /**
  131268. * Running
  131269. */
  131270. RUNNING = 1,
  131271. /**
  131272. * Done
  131273. */
  131274. DONE = 2,
  131275. /**
  131276. * Error
  131277. */
  131278. ERROR = 3
  131279. }
  131280. /**
  131281. * Define an abstract asset task used with a AssetsManager class to load assets into a scene
  131282. */
  131283. export abstract class AbstractAssetTask {
  131284. /**
  131285. * Task name
  131286. */ name: string;
  131287. /**
  131288. * Callback called when the task is successful
  131289. */
  131290. onSuccess: (task: any) => void;
  131291. /**
  131292. * Callback called when the task is not successful
  131293. */
  131294. onError: (task: any, message?: string, exception?: any) => void;
  131295. /**
  131296. * Creates a new AssetsManager
  131297. * @param name defines the name of the task
  131298. */
  131299. constructor(
  131300. /**
  131301. * Task name
  131302. */ name: string);
  131303. private _isCompleted;
  131304. private _taskState;
  131305. private _errorObject;
  131306. /**
  131307. * Get if the task is completed
  131308. */
  131309. readonly isCompleted: boolean;
  131310. /**
  131311. * Gets the current state of the task
  131312. */
  131313. readonly taskState: AssetTaskState;
  131314. /**
  131315. * Gets the current error object (if task is in error)
  131316. */
  131317. readonly errorObject: {
  131318. message?: string;
  131319. exception?: any;
  131320. };
  131321. /**
  131322. * Internal only
  131323. * @hidden
  131324. */
  131325. _setErrorObject(message?: string, exception?: any): void;
  131326. /**
  131327. * Execute the current task
  131328. * @param scene defines the scene where you want your assets to be loaded
  131329. * @param onSuccess is a callback called when the task is successfully executed
  131330. * @param onError is a callback called if an error occurs
  131331. */
  131332. run(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  131333. /**
  131334. * Execute the current task
  131335. * @param scene defines the scene where you want your assets to be loaded
  131336. * @param onSuccess is a callback called when the task is successfully executed
  131337. * @param onError is a callback called if an error occurs
  131338. */
  131339. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  131340. /**
  131341. * Reset will set the task state back to INIT, so the next load call of the assets manager will execute this task again.
  131342. * This can be used with failed tasks that have the reason for failure fixed.
  131343. */
  131344. reset(): void;
  131345. private onErrorCallback;
  131346. private onDoneCallback;
  131347. }
  131348. /**
  131349. * Define the interface used by progress events raised during assets loading
  131350. */
  131351. export interface IAssetsProgressEvent {
  131352. /**
  131353. * Defines the number of remaining tasks to process
  131354. */
  131355. remainingCount: number;
  131356. /**
  131357. * Defines the total number of tasks
  131358. */
  131359. totalCount: number;
  131360. /**
  131361. * Defines the task that was just processed
  131362. */
  131363. task: AbstractAssetTask;
  131364. }
  131365. /**
  131366. * Class used to share progress information about assets loading
  131367. */
  131368. export class AssetsProgressEvent implements IAssetsProgressEvent {
  131369. /**
  131370. * Defines the number of remaining tasks to process
  131371. */
  131372. remainingCount: number;
  131373. /**
  131374. * Defines the total number of tasks
  131375. */
  131376. totalCount: number;
  131377. /**
  131378. * Defines the task that was just processed
  131379. */
  131380. task: AbstractAssetTask;
  131381. /**
  131382. * Creates a AssetsProgressEvent
  131383. * @param remainingCount defines the number of remaining tasks to process
  131384. * @param totalCount defines the total number of tasks
  131385. * @param task defines the task that was just processed
  131386. */
  131387. constructor(remainingCount: number, totalCount: number, task: AbstractAssetTask);
  131388. }
  131389. /**
  131390. * Define a task used by AssetsManager to load meshes
  131391. */
  131392. export class MeshAssetTask extends AbstractAssetTask {
  131393. /**
  131394. * Defines the name of the task
  131395. */
  131396. name: string;
  131397. /**
  131398. * Defines the list of mesh's names you want to load
  131399. */
  131400. meshesNames: any;
  131401. /**
  131402. * Defines the root url to use as a base to load your meshes and associated resources
  131403. */
  131404. rootUrl: string;
  131405. /**
  131406. * Defines the filename of the scene to load from
  131407. */
  131408. sceneFilename: string;
  131409. /**
  131410. * Gets the list of loaded meshes
  131411. */
  131412. loadedMeshes: Array<AbstractMesh>;
  131413. /**
  131414. * Gets the list of loaded particle systems
  131415. */
  131416. loadedParticleSystems: Array<IParticleSystem>;
  131417. /**
  131418. * Gets the list of loaded skeletons
  131419. */
  131420. loadedSkeletons: Array<Skeleton>;
  131421. /**
  131422. * Gets the list of loaded animation groups
  131423. */
  131424. loadedAnimationGroups: Array<AnimationGroup>;
  131425. /**
  131426. * Callback called when the task is successful
  131427. */
  131428. onSuccess: (task: MeshAssetTask) => void;
  131429. /**
  131430. * Callback called when the task is successful
  131431. */
  131432. onError: (task: MeshAssetTask, message?: string, exception?: any) => void;
  131433. /**
  131434. * Creates a new MeshAssetTask
  131435. * @param name defines the name of the task
  131436. * @param meshesNames defines the list of mesh's names you want to load
  131437. * @param rootUrl defines the root url to use as a base to load your meshes and associated resources
  131438. * @param sceneFilename defines the filename of the scene to load from
  131439. */
  131440. constructor(
  131441. /**
  131442. * Defines the name of the task
  131443. */
  131444. name: string,
  131445. /**
  131446. * Defines the list of mesh's names you want to load
  131447. */
  131448. meshesNames: any,
  131449. /**
  131450. * Defines the root url to use as a base to load your meshes and associated resources
  131451. */
  131452. rootUrl: string,
  131453. /**
  131454. * Defines the filename of the scene to load from
  131455. */
  131456. sceneFilename: string);
  131457. /**
  131458. * Execute the current task
  131459. * @param scene defines the scene where you want your assets to be loaded
  131460. * @param onSuccess is a callback called when the task is successfully executed
  131461. * @param onError is a callback called if an error occurs
  131462. */
  131463. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  131464. }
  131465. /**
  131466. * Define a task used by AssetsManager to load text content
  131467. */
  131468. export class TextFileAssetTask extends AbstractAssetTask {
  131469. /**
  131470. * Defines the name of the task
  131471. */
  131472. name: string;
  131473. /**
  131474. * Defines the location of the file to load
  131475. */
  131476. url: string;
  131477. /**
  131478. * Gets the loaded text string
  131479. */
  131480. text: string;
  131481. /**
  131482. * Callback called when the task is successful
  131483. */
  131484. onSuccess: (task: TextFileAssetTask) => void;
  131485. /**
  131486. * Callback called when the task is successful
  131487. */
  131488. onError: (task: TextFileAssetTask, message?: string, exception?: any) => void;
  131489. /**
  131490. * Creates a new TextFileAssetTask object
  131491. * @param name defines the name of the task
  131492. * @param url defines the location of the file to load
  131493. */
  131494. constructor(
  131495. /**
  131496. * Defines the name of the task
  131497. */
  131498. name: string,
  131499. /**
  131500. * Defines the location of the file to load
  131501. */
  131502. url: string);
  131503. /**
  131504. * Execute the current task
  131505. * @param scene defines the scene where you want your assets to be loaded
  131506. * @param onSuccess is a callback called when the task is successfully executed
  131507. * @param onError is a callback called if an error occurs
  131508. */
  131509. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  131510. }
  131511. /**
  131512. * Define a task used by AssetsManager to load binary data
  131513. */
  131514. export class BinaryFileAssetTask extends AbstractAssetTask {
  131515. /**
  131516. * Defines the name of the task
  131517. */
  131518. name: string;
  131519. /**
  131520. * Defines the location of the file to load
  131521. */
  131522. url: string;
  131523. /**
  131524. * Gets the lodaded data (as an array buffer)
  131525. */
  131526. data: ArrayBuffer;
  131527. /**
  131528. * Callback called when the task is successful
  131529. */
  131530. onSuccess: (task: BinaryFileAssetTask) => void;
  131531. /**
  131532. * Callback called when the task is successful
  131533. */
  131534. onError: (task: BinaryFileAssetTask, message?: string, exception?: any) => void;
  131535. /**
  131536. * Creates a new BinaryFileAssetTask object
  131537. * @param name defines the name of the new task
  131538. * @param url defines the location of the file to load
  131539. */
  131540. constructor(
  131541. /**
  131542. * Defines the name of the task
  131543. */
  131544. name: string,
  131545. /**
  131546. * Defines the location of the file to load
  131547. */
  131548. url: string);
  131549. /**
  131550. * Execute the current task
  131551. * @param scene defines the scene where you want your assets to be loaded
  131552. * @param onSuccess is a callback called when the task is successfully executed
  131553. * @param onError is a callback called if an error occurs
  131554. */
  131555. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  131556. }
  131557. /**
  131558. * Define a task used by AssetsManager to load images
  131559. */
  131560. export class ImageAssetTask extends AbstractAssetTask {
  131561. /**
  131562. * Defines the name of the task
  131563. */
  131564. name: string;
  131565. /**
  131566. * Defines the location of the image to load
  131567. */
  131568. url: string;
  131569. /**
  131570. * Gets the loaded images
  131571. */
  131572. image: HTMLImageElement;
  131573. /**
  131574. * Callback called when the task is successful
  131575. */
  131576. onSuccess: (task: ImageAssetTask) => void;
  131577. /**
  131578. * Callback called when the task is successful
  131579. */
  131580. onError: (task: ImageAssetTask, message?: string, exception?: any) => void;
  131581. /**
  131582. * Creates a new ImageAssetTask
  131583. * @param name defines the name of the task
  131584. * @param url defines the location of the image to load
  131585. */
  131586. constructor(
  131587. /**
  131588. * Defines the name of the task
  131589. */
  131590. name: string,
  131591. /**
  131592. * Defines the location of the image to load
  131593. */
  131594. url: string);
  131595. /**
  131596. * Execute the current task
  131597. * @param scene defines the scene where you want your assets to be loaded
  131598. * @param onSuccess is a callback called when the task is successfully executed
  131599. * @param onError is a callback called if an error occurs
  131600. */
  131601. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  131602. }
  131603. /**
  131604. * Defines the interface used by texture loading tasks
  131605. */
  131606. export interface ITextureAssetTask<TEX extends BaseTexture> {
  131607. /**
  131608. * Gets the loaded texture
  131609. */
  131610. texture: TEX;
  131611. }
  131612. /**
  131613. * Define a task used by AssetsManager to load 2D textures
  131614. */
  131615. export class TextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<Texture> {
  131616. /**
  131617. * Defines the name of the task
  131618. */
  131619. name: string;
  131620. /**
  131621. * Defines the location of the file to load
  131622. */
  131623. url: string;
  131624. /**
  131625. * Defines if mipmap should not be generated (default is false)
  131626. */
  131627. noMipmap?: boolean | undefined;
  131628. /**
  131629. * Defines if texture must be inverted on Y axis (default is false)
  131630. */
  131631. invertY?: boolean | undefined;
  131632. /**
  131633. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  131634. */
  131635. samplingMode: number;
  131636. /**
  131637. * Gets the loaded texture
  131638. */
  131639. texture: Texture;
  131640. /**
  131641. * Callback called when the task is successful
  131642. */
  131643. onSuccess: (task: TextureAssetTask) => void;
  131644. /**
  131645. * Callback called when the task is successful
  131646. */
  131647. onError: (task: TextureAssetTask, message?: string, exception?: any) => void;
  131648. /**
  131649. * Creates a new TextureAssetTask object
  131650. * @param name defines the name of the task
  131651. * @param url defines the location of the file to load
  131652. * @param noMipmap defines if mipmap should not be generated (default is false)
  131653. * @param invertY defines if texture must be inverted on Y axis (default is false)
  131654. * @param samplingMode defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  131655. */
  131656. constructor(
  131657. /**
  131658. * Defines the name of the task
  131659. */
  131660. name: string,
  131661. /**
  131662. * Defines the location of the file to load
  131663. */
  131664. url: string,
  131665. /**
  131666. * Defines if mipmap should not be generated (default is false)
  131667. */
  131668. noMipmap?: boolean | undefined,
  131669. /**
  131670. * Defines if texture must be inverted on Y axis (default is false)
  131671. */
  131672. invertY?: boolean | undefined,
  131673. /**
  131674. * Defines the sampling mode to use (default is Texture.TRILINEAR_SAMPLINGMODE)
  131675. */
  131676. samplingMode?: number);
  131677. /**
  131678. * Execute the current task
  131679. * @param scene defines the scene where you want your assets to be loaded
  131680. * @param onSuccess is a callback called when the task is successfully executed
  131681. * @param onError is a callback called if an error occurs
  131682. */
  131683. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  131684. }
  131685. /**
  131686. * Define a task used by AssetsManager to load cube textures
  131687. */
  131688. export class CubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<CubeTexture> {
  131689. /**
  131690. * Defines the name of the task
  131691. */
  131692. name: string;
  131693. /**
  131694. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  131695. */
  131696. url: string;
  131697. /**
  131698. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  131699. */
  131700. extensions?: string[] | undefined;
  131701. /**
  131702. * Defines if mipmaps should not be generated (default is false)
  131703. */
  131704. noMipmap?: boolean | undefined;
  131705. /**
  131706. * Defines the explicit list of files (undefined by default)
  131707. */
  131708. files?: string[] | undefined;
  131709. /**
  131710. * Gets the loaded texture
  131711. */
  131712. texture: CubeTexture;
  131713. /**
  131714. * Callback called when the task is successful
  131715. */
  131716. onSuccess: (task: CubeTextureAssetTask) => void;
  131717. /**
  131718. * Callback called when the task is successful
  131719. */
  131720. onError: (task: CubeTextureAssetTask, message?: string, exception?: any) => void;
  131721. /**
  131722. * Creates a new CubeTextureAssetTask
  131723. * @param name defines the name of the task
  131724. * @param url defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  131725. * @param extensions defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  131726. * @param noMipmap defines if mipmaps should not be generated (default is false)
  131727. * @param files defines the explicit list of files (undefined by default)
  131728. */
  131729. constructor(
  131730. /**
  131731. * Defines the name of the task
  131732. */
  131733. name: string,
  131734. /**
  131735. * Defines the location of the files to load (You have to specify the folder where the files are + filename with no extension)
  131736. */
  131737. url: string,
  131738. /**
  131739. * Defines the extensions to use to load files (["_px", "_py", "_pz", "_nx", "_ny", "_nz"] by default)
  131740. */
  131741. extensions?: string[] | undefined,
  131742. /**
  131743. * Defines if mipmaps should not be generated (default is false)
  131744. */
  131745. noMipmap?: boolean | undefined,
  131746. /**
  131747. * Defines the explicit list of files (undefined by default)
  131748. */
  131749. files?: string[] | undefined);
  131750. /**
  131751. * Execute the current task
  131752. * @param scene defines the scene where you want your assets to be loaded
  131753. * @param onSuccess is a callback called when the task is successfully executed
  131754. * @param onError is a callback called if an error occurs
  131755. */
  131756. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  131757. }
  131758. /**
  131759. * Define a task used by AssetsManager to load HDR cube textures
  131760. */
  131761. export class HDRCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<HDRCubeTexture> {
  131762. /**
  131763. * Defines the name of the task
  131764. */
  131765. name: string;
  131766. /**
  131767. * Defines the location of the file to load
  131768. */
  131769. url: string;
  131770. /**
  131771. * Defines the desired size (the more it increases the longer the generation will be)
  131772. */
  131773. size: number;
  131774. /**
  131775. * Defines if mipmaps should not be generated (default is false)
  131776. */
  131777. noMipmap: boolean;
  131778. /**
  131779. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  131780. */
  131781. generateHarmonics: boolean;
  131782. /**
  131783. * 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)
  131784. */
  131785. gammaSpace: boolean;
  131786. /**
  131787. * Internal Use Only
  131788. */
  131789. reserved: boolean;
  131790. /**
  131791. * Gets the loaded texture
  131792. */
  131793. texture: HDRCubeTexture;
  131794. /**
  131795. * Callback called when the task is successful
  131796. */
  131797. onSuccess: (task: HDRCubeTextureAssetTask) => void;
  131798. /**
  131799. * Callback called when the task is successful
  131800. */
  131801. onError: (task: HDRCubeTextureAssetTask, message?: string, exception?: any) => void;
  131802. /**
  131803. * Creates a new HDRCubeTextureAssetTask object
  131804. * @param name defines the name of the task
  131805. * @param url defines the location of the file to load
  131806. * @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.
  131807. * @param noMipmap defines if mipmaps should not be generated (default is false)
  131808. * @param generateHarmonics specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  131809. * @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)
  131810. * @param reserved Internal use only
  131811. */
  131812. constructor(
  131813. /**
  131814. * Defines the name of the task
  131815. */
  131816. name: string,
  131817. /**
  131818. * Defines the location of the file to load
  131819. */
  131820. url: string,
  131821. /**
  131822. * Defines the desired size (the more it increases the longer the generation will be)
  131823. */
  131824. size: number,
  131825. /**
  131826. * Defines if mipmaps should not be generated (default is false)
  131827. */
  131828. noMipmap?: boolean,
  131829. /**
  131830. * Specifies whether you want to extract the polynomial harmonics during the generation process (default is true)
  131831. */
  131832. generateHarmonics?: boolean,
  131833. /**
  131834. * 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)
  131835. */
  131836. gammaSpace?: boolean,
  131837. /**
  131838. * Internal Use Only
  131839. */
  131840. reserved?: boolean);
  131841. /**
  131842. * Execute the current task
  131843. * @param scene defines the scene where you want your assets to be loaded
  131844. * @param onSuccess is a callback called when the task is successfully executed
  131845. * @param onError is a callback called if an error occurs
  131846. */
  131847. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  131848. }
  131849. /**
  131850. * Define a task used by AssetsManager to load Equirectangular cube textures
  131851. */
  131852. export class EquiRectangularCubeTextureAssetTask extends AbstractAssetTask implements ITextureAssetTask<EquiRectangularCubeTexture> {
  131853. /**
  131854. * Defines the name of the task
  131855. */
  131856. name: string;
  131857. /**
  131858. * Defines the location of the file to load
  131859. */
  131860. url: string;
  131861. /**
  131862. * Defines the desired size (the more it increases the longer the generation will be)
  131863. */
  131864. size: number;
  131865. /**
  131866. * Defines if mipmaps should not be generated (default is false)
  131867. */
  131868. noMipmap: boolean;
  131869. /**
  131870. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  131871. * but the standard material would require them in Gamma space) (default is true)
  131872. */
  131873. gammaSpace: boolean;
  131874. /**
  131875. * Gets the loaded texture
  131876. */
  131877. texture: EquiRectangularCubeTexture;
  131878. /**
  131879. * Callback called when the task is successful
  131880. */
  131881. onSuccess: (task: EquiRectangularCubeTextureAssetTask) => void;
  131882. /**
  131883. * Callback called when the task is successful
  131884. */
  131885. onError: (task: EquiRectangularCubeTextureAssetTask, message?: string, exception?: any) => void;
  131886. /**
  131887. * Creates a new EquiRectangularCubeTextureAssetTask object
  131888. * @param name defines the name of the task
  131889. * @param url defines the location of the file to load
  131890. * @param size defines the desired size (the more it increases the longer the generation will be)
  131891. * If the size is omitted this implies you are using a preprocessed cubemap.
  131892. * @param noMipmap defines if mipmaps should not be generated (default is false)
  131893. * @param gammaSpace specifies if the texture will be used in gamma or linear space
  131894. * (the PBR material requires those texture in linear space, but the standard material would require them in Gamma space)
  131895. * (default is true)
  131896. */
  131897. constructor(
  131898. /**
  131899. * Defines the name of the task
  131900. */
  131901. name: string,
  131902. /**
  131903. * Defines the location of the file to load
  131904. */
  131905. url: string,
  131906. /**
  131907. * Defines the desired size (the more it increases the longer the generation will be)
  131908. */
  131909. size: number,
  131910. /**
  131911. * Defines if mipmaps should not be generated (default is false)
  131912. */
  131913. noMipmap?: boolean,
  131914. /**
  131915. * Specifies if the texture will be use in gamma or linear space (the PBR material requires those texture in linear space,
  131916. * but the standard material would require them in Gamma space) (default is true)
  131917. */
  131918. gammaSpace?: boolean);
  131919. /**
  131920. * Execute the current task
  131921. * @param scene defines the scene where you want your assets to be loaded
  131922. * @param onSuccess is a callback called when the task is successfully executed
  131923. * @param onError is a callback called if an error occurs
  131924. */
  131925. runTask(scene: Scene, onSuccess: () => void, onError: (message?: string, exception?: any) => void): void;
  131926. }
  131927. /**
  131928. * This class can be used to easily import assets into a scene
  131929. * @see http://doc.babylonjs.com/how_to/how_to_use_assetsmanager
  131930. */
  131931. export class AssetsManager {
  131932. private _scene;
  131933. private _isLoading;
  131934. protected _tasks: AbstractAssetTask[];
  131935. protected _waitingTasksCount: number;
  131936. protected _totalTasksCount: number;
  131937. /**
  131938. * Callback called when all tasks are processed
  131939. */
  131940. onFinish: (tasks: AbstractAssetTask[]) => void;
  131941. /**
  131942. * Callback called when a task is successful
  131943. */
  131944. onTaskSuccess: (task: AbstractAssetTask) => void;
  131945. /**
  131946. * Callback called when a task had an error
  131947. */
  131948. onTaskError: (task: AbstractAssetTask) => void;
  131949. /**
  131950. * Callback called when a task is done (whatever the result is)
  131951. */
  131952. onProgress: (remainingCount: number, totalCount: number, task: AbstractAssetTask) => void;
  131953. /**
  131954. * Observable called when all tasks are processed
  131955. */
  131956. onTaskSuccessObservable: Observable<AbstractAssetTask>;
  131957. /**
  131958. * Observable called when a task had an error
  131959. */
  131960. onTaskErrorObservable: Observable<AbstractAssetTask>;
  131961. /**
  131962. * Observable called when all tasks were executed
  131963. */
  131964. onTasksDoneObservable: Observable<AbstractAssetTask[]>;
  131965. /**
  131966. * Observable called when a task is done (whatever the result is)
  131967. */
  131968. onProgressObservable: Observable<IAssetsProgressEvent>;
  131969. /**
  131970. * Gets or sets a boolean defining if the AssetsManager should use the default loading screen
  131971. * @see http://doc.babylonjs.com/how_to/creating_a_custom_loading_screen
  131972. */
  131973. useDefaultLoadingScreen: boolean;
  131974. /**
  131975. * Gets or sets a boolean defining if the AssetsManager should automatically hide the loading screen
  131976. * when all assets have been downloaded.
  131977. * If set to false, you need to manually call in hideLoadingUI() once your scene is ready.
  131978. */
  131979. autoHideLoadingUI: boolean;
  131980. /**
  131981. * Creates a new AssetsManager
  131982. * @param scene defines the scene to work on
  131983. */
  131984. constructor(scene: Scene);
  131985. /**
  131986. * Add a MeshAssetTask to the list of active tasks
  131987. * @param taskName defines the name of the new task
  131988. * @param meshesNames defines the name of meshes to load
  131989. * @param rootUrl defines the root url to use to locate files
  131990. * @param sceneFilename defines the filename of the scene file
  131991. * @returns a new MeshAssetTask object
  131992. */
  131993. addMeshTask(taskName: string, meshesNames: any, rootUrl: string, sceneFilename: string): MeshAssetTask;
  131994. /**
  131995. * Add a TextFileAssetTask to the list of active tasks
  131996. * @param taskName defines the name of the new task
  131997. * @param url defines the url of the file to load
  131998. * @returns a new TextFileAssetTask object
  131999. */
  132000. addTextFileTask(taskName: string, url: string): TextFileAssetTask;
  132001. /**
  132002. * Add a BinaryFileAssetTask to the list of active tasks
  132003. * @param taskName defines the name of the new task
  132004. * @param url defines the url of the file to load
  132005. * @returns a new BinaryFileAssetTask object
  132006. */
  132007. addBinaryFileTask(taskName: string, url: string): BinaryFileAssetTask;
  132008. /**
  132009. * Add a ImageAssetTask to the list of active tasks
  132010. * @param taskName defines the name of the new task
  132011. * @param url defines the url of the file to load
  132012. * @returns a new ImageAssetTask object
  132013. */
  132014. addImageTask(taskName: string, url: string): ImageAssetTask;
  132015. /**
  132016. * Add a TextureAssetTask to the list of active tasks
  132017. * @param taskName defines the name of the new task
  132018. * @param url defines the url of the file to load
  132019. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  132020. * @param invertY defines if you want to invert Y axis of the loaded texture (false by default)
  132021. * @param samplingMode defines the sampling mode to use (Texture.TRILINEAR_SAMPLINGMODE by default)
  132022. * @returns a new TextureAssetTask object
  132023. */
  132024. addTextureTask(taskName: string, url: string, noMipmap?: boolean, invertY?: boolean, samplingMode?: number): TextureAssetTask;
  132025. /**
  132026. * Add a CubeTextureAssetTask to the list of active tasks
  132027. * @param taskName defines the name of the new task
  132028. * @param url defines the url of the file to load
  132029. * @param extensions defines the extension to use to load the cube map (can be null)
  132030. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  132031. * @param files defines the list of files to load (can be null)
  132032. * @returns a new CubeTextureAssetTask object
  132033. */
  132034. addCubeTextureTask(taskName: string, url: string, extensions?: string[], noMipmap?: boolean, files?: string[]): CubeTextureAssetTask;
  132035. /**
  132036. *
  132037. * Add a HDRCubeTextureAssetTask to the list of active tasks
  132038. * @param taskName defines the name of the new task
  132039. * @param url defines the url of the file to load
  132040. * @param size defines the size you want for the cubemap (can be null)
  132041. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  132042. * @param generateHarmonics defines if you want to automatically generate (true by default)
  132043. * @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)
  132044. * @param reserved Internal use only
  132045. * @returns a new HDRCubeTextureAssetTask object
  132046. */
  132047. addHDRCubeTextureTask(taskName: string, url: string, size: number, noMipmap?: boolean, generateHarmonics?: boolean, gammaSpace?: boolean, reserved?: boolean): HDRCubeTextureAssetTask;
  132048. /**
  132049. *
  132050. * Add a EquiRectangularCubeTextureAssetTask to the list of active tasks
  132051. * @param taskName defines the name of the new task
  132052. * @param url defines the url of the file to load
  132053. * @param size defines the size you want for the cubemap (can be null)
  132054. * @param noMipmap defines if the texture must not receive mipmaps (false by default)
  132055. * @param gammaSpace Specifies if the texture will be used in gamma or linear space
  132056. * (the PBR material requires those textures in linear space, but the standard material would require them in Gamma space)
  132057. * @returns a new EquiRectangularCubeTextureAssetTask object
  132058. */
  132059. addEquiRectangularCubeTextureAssetTask(taskName: string, url: string, size: number, noMipmap?: boolean, gammaSpace?: boolean): EquiRectangularCubeTextureAssetTask;
  132060. /**
  132061. * Remove a task from the assets manager.
  132062. * @param task the task to remove
  132063. */
  132064. removeTask(task: AbstractAssetTask): void;
  132065. private _decreaseWaitingTasksCount;
  132066. private _runTask;
  132067. /**
  132068. * Reset the AssetsManager and remove all tasks
  132069. * @return the current instance of the AssetsManager
  132070. */
  132071. reset(): AssetsManager;
  132072. /**
  132073. * Start the loading process
  132074. * @return the current instance of the AssetsManager
  132075. */
  132076. load(): AssetsManager;
  132077. /**
  132078. * Start the loading process as an async operation
  132079. * @return a promise returning the list of failed tasks
  132080. */
  132081. loadAsync(): Promise<void>;
  132082. }
  132083. }
  132084. declare module BABYLON {
  132085. /**
  132086. * Wrapper class for promise with external resolve and reject.
  132087. */
  132088. export class Deferred<T> {
  132089. /**
  132090. * The promise associated with this deferred object.
  132091. */
  132092. readonly promise: Promise<T>;
  132093. private _resolve;
  132094. private _reject;
  132095. /**
  132096. * The resolve method of the promise associated with this deferred object.
  132097. */
  132098. readonly resolve: (value?: T | PromiseLike<T> | undefined) => void;
  132099. /**
  132100. * The reject method of the promise associated with this deferred object.
  132101. */
  132102. readonly reject: (reason?: any) => void;
  132103. /**
  132104. * Constructor for this deferred object.
  132105. */
  132106. constructor();
  132107. }
  132108. }
  132109. declare module BABYLON {
  132110. /**
  132111. * Class used to explode meshes (ie. to have a center and move them away from that center to better see the overall organization)
  132112. */
  132113. export class MeshExploder {
  132114. private _centerMesh;
  132115. private _meshes;
  132116. private _meshesOrigins;
  132117. private _toCenterVectors;
  132118. private _scaledDirection;
  132119. private _newPosition;
  132120. private _centerPosition;
  132121. /**
  132122. * Explodes meshes from a center mesh.
  132123. * @param meshes The meshes to explode.
  132124. * @param centerMesh The mesh to be center of explosion.
  132125. */
  132126. constructor(meshes: Array<Mesh>, centerMesh?: Mesh);
  132127. private _setCenterMesh;
  132128. /**
  132129. * Get class name
  132130. * @returns "MeshExploder"
  132131. */
  132132. getClassName(): string;
  132133. /**
  132134. * "Exploded meshes"
  132135. * @returns Array of meshes with the centerMesh at index 0.
  132136. */
  132137. getMeshes(): Array<Mesh>;
  132138. /**
  132139. * Explodes meshes giving a specific direction
  132140. * @param direction Number to multiply distance of each mesh's origin from center. Use a negative number to implode, or zero to reset.
  132141. */
  132142. explode(direction?: number): void;
  132143. }
  132144. }
  132145. declare module BABYLON {
  132146. /**
  132147. * Class used to help managing file picking and drag'n'drop
  132148. */
  132149. export class FilesInput {
  132150. /**
  132151. * List of files ready to be loaded
  132152. */
  132153. static readonly FilesToLoad: {
  132154. [key: string]: File;
  132155. };
  132156. /**
  132157. * Callback called when a file is processed
  132158. */
  132159. onProcessFileCallback: (file: File, name: string, extension: string) => true;
  132160. private _engine;
  132161. private _currentScene;
  132162. private _sceneLoadedCallback;
  132163. private _progressCallback;
  132164. private _additionalRenderLoopLogicCallback;
  132165. private _textureLoadingCallback;
  132166. private _startingProcessingFilesCallback;
  132167. private _onReloadCallback;
  132168. private _errorCallback;
  132169. private _elementToMonitor;
  132170. private _sceneFileToLoad;
  132171. private _filesToLoad;
  132172. /**
  132173. * Creates a new FilesInput
  132174. * @param engine defines the rendering engine
  132175. * @param scene defines the hosting scene
  132176. * @param sceneLoadedCallback callback called when scene is loaded
  132177. * @param progressCallback callback called to track progress
  132178. * @param additionalRenderLoopLogicCallback callback called to add user logic to the rendering loop
  132179. * @param textureLoadingCallback callback called when a texture is loading
  132180. * @param startingProcessingFilesCallback callback called when the system is about to process all files
  132181. * @param onReloadCallback callback called when a reload is requested
  132182. * @param errorCallback callback call if an error occurs
  132183. */
  132184. 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);
  132185. private _dragEnterHandler;
  132186. private _dragOverHandler;
  132187. private _dropHandler;
  132188. /**
  132189. * Calls this function to listen to drag'n'drop events on a specific DOM element
  132190. * @param elementToMonitor defines the DOM element to track
  132191. */
  132192. monitorElementForDragNDrop(elementToMonitor: HTMLElement): void;
  132193. /**
  132194. * Release all associated resources
  132195. */
  132196. dispose(): void;
  132197. private renderFunction;
  132198. private drag;
  132199. private drop;
  132200. private _traverseFolder;
  132201. private _processFiles;
  132202. /**
  132203. * Load files from a drop event
  132204. * @param event defines the drop event to use as source
  132205. */
  132206. loadFiles(event: any): void;
  132207. private _processReload;
  132208. /**
  132209. * Reload the current scene from the loaded files
  132210. */
  132211. reload(): void;
  132212. }
  132213. }
  132214. declare module BABYLON {
  132215. /**
  132216. * Defines the root class used to create scene optimization to use with SceneOptimizer
  132217. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  132218. */
  132219. export class SceneOptimization {
  132220. /**
  132221. * Defines the priority of this optimization (0 by default which means first in the list)
  132222. */
  132223. priority: number;
  132224. /**
  132225. * Gets a string describing the action executed by the current optimization
  132226. * @returns description string
  132227. */
  132228. getDescription(): string;
  132229. /**
  132230. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  132231. * @param scene defines the current scene where to apply this optimization
  132232. * @param optimizer defines the current optimizer
  132233. * @returns true if everything that can be done was applied
  132234. */
  132235. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  132236. /**
  132237. * Creates the SceneOptimization object
  132238. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  132239. * @param desc defines the description associated with the optimization
  132240. */
  132241. constructor(
  132242. /**
  132243. * Defines the priority of this optimization (0 by default which means first in the list)
  132244. */
  132245. priority?: number);
  132246. }
  132247. /**
  132248. * Defines an optimization used to reduce the size of render target textures
  132249. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  132250. */
  132251. export class TextureOptimization extends SceneOptimization {
  132252. /**
  132253. * Defines the priority of this optimization (0 by default which means first in the list)
  132254. */
  132255. priority: number;
  132256. /**
  132257. * 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
  132258. */
  132259. maximumSize: number;
  132260. /**
  132261. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  132262. */
  132263. step: number;
  132264. /**
  132265. * Gets a string describing the action executed by the current optimization
  132266. * @returns description string
  132267. */
  132268. getDescription(): string;
  132269. /**
  132270. * Creates the TextureOptimization object
  132271. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  132272. * @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
  132273. * @param step defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  132274. */
  132275. constructor(
  132276. /**
  132277. * Defines the priority of this optimization (0 by default which means first in the list)
  132278. */
  132279. priority?: number,
  132280. /**
  132281. * 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
  132282. */
  132283. maximumSize?: number,
  132284. /**
  132285. * Defines the factor (0.5 by default) used to scale down textures bigger than maximum sized allowed.
  132286. */
  132287. step?: number);
  132288. /**
  132289. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  132290. * @param scene defines the current scene where to apply this optimization
  132291. * @param optimizer defines the current optimizer
  132292. * @returns true if everything that can be done was applied
  132293. */
  132294. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  132295. }
  132296. /**
  132297. * Defines an optimization used to increase or decrease the rendering resolution
  132298. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  132299. */
  132300. export class HardwareScalingOptimization extends SceneOptimization {
  132301. /**
  132302. * Defines the priority of this optimization (0 by default which means first in the list)
  132303. */
  132304. priority: number;
  132305. /**
  132306. * Defines the maximum scale to use (2 by default)
  132307. */
  132308. maximumScale: number;
  132309. /**
  132310. * Defines the step to use between two passes (0.5 by default)
  132311. */
  132312. step: number;
  132313. private _currentScale;
  132314. private _directionOffset;
  132315. /**
  132316. * Gets a string describing the action executed by the current optimization
  132317. * @return description string
  132318. */
  132319. getDescription(): string;
  132320. /**
  132321. * Creates the HardwareScalingOptimization object
  132322. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  132323. * @param maximumScale defines the maximum scale to use (2 by default)
  132324. * @param step defines the step to use between two passes (0.5 by default)
  132325. */
  132326. constructor(
  132327. /**
  132328. * Defines the priority of this optimization (0 by default which means first in the list)
  132329. */
  132330. priority?: number,
  132331. /**
  132332. * Defines the maximum scale to use (2 by default)
  132333. */
  132334. maximumScale?: number,
  132335. /**
  132336. * Defines the step to use between two passes (0.5 by default)
  132337. */
  132338. step?: number);
  132339. /**
  132340. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  132341. * @param scene defines the current scene where to apply this optimization
  132342. * @param optimizer defines the current optimizer
  132343. * @returns true if everything that can be done was applied
  132344. */
  132345. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  132346. }
  132347. /**
  132348. * Defines an optimization used to remove shadows
  132349. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  132350. */
  132351. export class ShadowsOptimization extends SceneOptimization {
  132352. /**
  132353. * Gets a string describing the action executed by the current optimization
  132354. * @return description string
  132355. */
  132356. getDescription(): string;
  132357. /**
  132358. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  132359. * @param scene defines the current scene where to apply this optimization
  132360. * @param optimizer defines the current optimizer
  132361. * @returns true if everything that can be done was applied
  132362. */
  132363. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  132364. }
  132365. /**
  132366. * Defines an optimization used to turn post-processes off
  132367. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  132368. */
  132369. export class PostProcessesOptimization extends SceneOptimization {
  132370. /**
  132371. * Gets a string describing the action executed by the current optimization
  132372. * @return description string
  132373. */
  132374. getDescription(): string;
  132375. /**
  132376. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  132377. * @param scene defines the current scene where to apply this optimization
  132378. * @param optimizer defines the current optimizer
  132379. * @returns true if everything that can be done was applied
  132380. */
  132381. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  132382. }
  132383. /**
  132384. * Defines an optimization used to turn lens flares off
  132385. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  132386. */
  132387. export class LensFlaresOptimization extends SceneOptimization {
  132388. /**
  132389. * Gets a string describing the action executed by the current optimization
  132390. * @return description string
  132391. */
  132392. getDescription(): string;
  132393. /**
  132394. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  132395. * @param scene defines the current scene where to apply this optimization
  132396. * @param optimizer defines the current optimizer
  132397. * @returns true if everything that can be done was applied
  132398. */
  132399. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  132400. }
  132401. /**
  132402. * Defines an optimization based on user defined callback.
  132403. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  132404. */
  132405. export class CustomOptimization extends SceneOptimization {
  132406. /**
  132407. * Callback called to apply the custom optimization.
  132408. */
  132409. onApply: (scene: Scene, optimizer: SceneOptimizer) => boolean;
  132410. /**
  132411. * Callback called to get custom description
  132412. */
  132413. onGetDescription: () => string;
  132414. /**
  132415. * Gets a string describing the action executed by the current optimization
  132416. * @returns description string
  132417. */
  132418. getDescription(): string;
  132419. /**
  132420. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  132421. * @param scene defines the current scene where to apply this optimization
  132422. * @param optimizer defines the current optimizer
  132423. * @returns true if everything that can be done was applied
  132424. */
  132425. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  132426. }
  132427. /**
  132428. * Defines an optimization used to turn particles off
  132429. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  132430. */
  132431. export class ParticlesOptimization extends SceneOptimization {
  132432. /**
  132433. * Gets a string describing the action executed by the current optimization
  132434. * @return description string
  132435. */
  132436. getDescription(): string;
  132437. /**
  132438. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  132439. * @param scene defines the current scene where to apply this optimization
  132440. * @param optimizer defines the current optimizer
  132441. * @returns true if everything that can be done was applied
  132442. */
  132443. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  132444. }
  132445. /**
  132446. * Defines an optimization used to turn render targets off
  132447. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  132448. */
  132449. export class RenderTargetsOptimization extends SceneOptimization {
  132450. /**
  132451. * Gets a string describing the action executed by the current optimization
  132452. * @return description string
  132453. */
  132454. getDescription(): string;
  132455. /**
  132456. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  132457. * @param scene defines the current scene where to apply this optimization
  132458. * @param optimizer defines the current optimizer
  132459. * @returns true if everything that can be done was applied
  132460. */
  132461. apply(scene: Scene, optimizer: SceneOptimizer): boolean;
  132462. }
  132463. /**
  132464. * Defines an optimization used to merge meshes with compatible materials
  132465. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  132466. */
  132467. export class MergeMeshesOptimization extends SceneOptimization {
  132468. private static _UpdateSelectionTree;
  132469. /**
  132470. * Gets or sets a boolean which defines if optimization octree has to be updated
  132471. */
  132472. /**
  132473. * Gets or sets a boolean which defines if optimization octree has to be updated
  132474. */
  132475. static UpdateSelectionTree: boolean;
  132476. /**
  132477. * Gets a string describing the action executed by the current optimization
  132478. * @return description string
  132479. */
  132480. getDescription(): string;
  132481. private _canBeMerged;
  132482. /**
  132483. * This function will be called by the SceneOptimizer when its priority is reached in order to apply the change required by the current optimization
  132484. * @param scene defines the current scene where to apply this optimization
  132485. * @param optimizer defines the current optimizer
  132486. * @param updateSelectionTree defines that the selection octree has to be updated (false by default)
  132487. * @returns true if everything that can be done was applied
  132488. */
  132489. apply(scene: Scene, optimizer: SceneOptimizer, updateSelectionTree?: boolean): boolean;
  132490. }
  132491. /**
  132492. * Defines a list of options used by SceneOptimizer
  132493. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  132494. */
  132495. export class SceneOptimizerOptions {
  132496. /**
  132497. * Defines the target frame rate to reach (60 by default)
  132498. */
  132499. targetFrameRate: number;
  132500. /**
  132501. * Defines the interval between two checkes (2000ms by default)
  132502. */
  132503. trackerDuration: number;
  132504. /**
  132505. * Gets the list of optimizations to apply
  132506. */
  132507. optimizations: SceneOptimization[];
  132508. /**
  132509. * Creates a new list of options used by SceneOptimizer
  132510. * @param targetFrameRate defines the target frame rate to reach (60 by default)
  132511. * @param trackerDuration defines the interval between two checkes (2000ms by default)
  132512. */
  132513. constructor(
  132514. /**
  132515. * Defines the target frame rate to reach (60 by default)
  132516. */
  132517. targetFrameRate?: number,
  132518. /**
  132519. * Defines the interval between two checkes (2000ms by default)
  132520. */
  132521. trackerDuration?: number);
  132522. /**
  132523. * Add a new optimization
  132524. * @param optimization defines the SceneOptimization to add to the list of active optimizations
  132525. * @returns the current SceneOptimizerOptions
  132526. */
  132527. addOptimization(optimization: SceneOptimization): SceneOptimizerOptions;
  132528. /**
  132529. * Add a new custom optimization
  132530. * @param onApply defines the callback called to apply the custom optimization (true if everything that can be done was applied)
  132531. * @param onGetDescription defines the callback called to get the description attached with the optimization.
  132532. * @param priority defines the priority of this optimization (0 by default which means first in the list)
  132533. * @returns the current SceneOptimizerOptions
  132534. */
  132535. addCustomOptimization(onApply: (scene: Scene) => boolean, onGetDescription: () => string, priority?: number): SceneOptimizerOptions;
  132536. /**
  132537. * Creates a list of pre-defined optimizations aimed to reduce the visual impact on the scene
  132538. * @param targetFrameRate defines the target frame rate (60 by default)
  132539. * @returns a SceneOptimizerOptions object
  132540. */
  132541. static LowDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  132542. /**
  132543. * Creates a list of pre-defined optimizations aimed to have a moderate impact on the scene visual
  132544. * @param targetFrameRate defines the target frame rate (60 by default)
  132545. * @returns a SceneOptimizerOptions object
  132546. */
  132547. static ModerateDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  132548. /**
  132549. * Creates a list of pre-defined optimizations aimed to have a big impact on the scene visual
  132550. * @param targetFrameRate defines the target frame rate (60 by default)
  132551. * @returns a SceneOptimizerOptions object
  132552. */
  132553. static HighDegradationAllowed(targetFrameRate?: number): SceneOptimizerOptions;
  132554. }
  132555. /**
  132556. * Class used to run optimizations in order to reach a target frame rate
  132557. * @description More details at http://doc.babylonjs.com/how_to/how_to_use_sceneoptimizer
  132558. */
  132559. export class SceneOptimizer implements IDisposable {
  132560. private _isRunning;
  132561. private _options;
  132562. private _scene;
  132563. private _currentPriorityLevel;
  132564. private _targetFrameRate;
  132565. private _trackerDuration;
  132566. private _currentFrameRate;
  132567. private _sceneDisposeObserver;
  132568. private _improvementMode;
  132569. /**
  132570. * Defines an observable called when the optimizer reaches the target frame rate
  132571. */
  132572. onSuccessObservable: Observable<SceneOptimizer>;
  132573. /**
  132574. * Defines an observable called when the optimizer enables an optimization
  132575. */
  132576. onNewOptimizationAppliedObservable: Observable<SceneOptimization>;
  132577. /**
  132578. * Defines an observable called when the optimizer is not able to reach the target frame rate
  132579. */
  132580. onFailureObservable: Observable<SceneOptimizer>;
  132581. /**
  132582. * Gets a boolean indicating if the optimizer is in improvement mode
  132583. */
  132584. readonly isInImprovementMode: boolean;
  132585. /**
  132586. * Gets the current priority level (0 at start)
  132587. */
  132588. readonly currentPriorityLevel: number;
  132589. /**
  132590. * Gets the current frame rate checked by the SceneOptimizer
  132591. */
  132592. readonly currentFrameRate: number;
  132593. /**
  132594. * Gets or sets the current target frame rate (60 by default)
  132595. */
  132596. /**
  132597. * Gets or sets the current target frame rate (60 by default)
  132598. */
  132599. targetFrameRate: number;
  132600. /**
  132601. * Gets or sets the current interval between two checks (every 2000ms by default)
  132602. */
  132603. /**
  132604. * Gets or sets the current interval between two checks (every 2000ms by default)
  132605. */
  132606. trackerDuration: number;
  132607. /**
  132608. * Gets the list of active optimizations
  132609. */
  132610. readonly optimizations: SceneOptimization[];
  132611. /**
  132612. * Creates a new SceneOptimizer
  132613. * @param scene defines the scene to work on
  132614. * @param options defines the options to use with the SceneOptimizer
  132615. * @param autoGeneratePriorities defines if priorities must be generated and not read from SceneOptimization property (true by default)
  132616. * @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)
  132617. */
  132618. constructor(scene: Scene, options?: SceneOptimizerOptions, autoGeneratePriorities?: boolean, improvementMode?: boolean);
  132619. /**
  132620. * Stops the current optimizer
  132621. */
  132622. stop(): void;
  132623. /**
  132624. * Reset the optimizer to initial step (current priority level = 0)
  132625. */
  132626. reset(): void;
  132627. /**
  132628. * Start the optimizer. By default it will try to reach a specific framerate
  132629. * but if the optimizer is set with improvementMode === true then it will run all optimiatiation while frame rate is above the target frame rate
  132630. */
  132631. start(): void;
  132632. private _checkCurrentState;
  132633. /**
  132634. * Release all resources
  132635. */
  132636. dispose(): void;
  132637. /**
  132638. * Helper function to create a SceneOptimizer with one single line of code
  132639. * @param scene defines the scene to work on
  132640. * @param options defines the options to use with the SceneOptimizer
  132641. * @param onSuccess defines a callback to call on success
  132642. * @param onFailure defines a callback to call on failure
  132643. * @returns the new SceneOptimizer object
  132644. */
  132645. static OptimizeAsync(scene: Scene, options?: SceneOptimizerOptions, onSuccess?: () => void, onFailure?: () => void): SceneOptimizer;
  132646. }
  132647. }
  132648. declare module BABYLON {
  132649. /**
  132650. * Class used to serialize a scene into a string
  132651. */
  132652. export class SceneSerializer {
  132653. /**
  132654. * Clear cache used by a previous serialization
  132655. */
  132656. static ClearCache(): void;
  132657. /**
  132658. * Serialize a scene into a JSON compatible object
  132659. * @param scene defines the scene to serialize
  132660. * @returns a JSON compatible object
  132661. */
  132662. static Serialize(scene: Scene): any;
  132663. /**
  132664. * Serialize a mesh into a JSON compatible object
  132665. * @param toSerialize defines the mesh to serialize
  132666. * @param withParents defines if parents must be serialized as well
  132667. * @param withChildren defines if children must be serialized as well
  132668. * @returns a JSON compatible object
  132669. */
  132670. static SerializeMesh(toSerialize: any, withParents?: boolean, withChildren?: boolean): any;
  132671. }
  132672. }
  132673. declare module BABYLON {
  132674. /**
  132675. * Class used to host texture specific utilities
  132676. */
  132677. export class TextureTools {
  132678. /**
  132679. * Uses the GPU to create a copy texture rescaled at a given size
  132680. * @param texture Texture to copy from
  132681. * @param width defines the desired width
  132682. * @param height defines the desired height
  132683. * @param useBilinearMode defines if bilinear mode has to be used
  132684. * @return the generated texture
  132685. */
  132686. static CreateResizedCopy(texture: Texture, width: number, height: number, useBilinearMode?: boolean): Texture;
  132687. }
  132688. }
  132689. declare module BABYLON {
  132690. /**
  132691. * This represents the different options available for the video capture.
  132692. */
  132693. export interface VideoRecorderOptions {
  132694. /** Defines the mime type of the video. */
  132695. mimeType: string;
  132696. /** Defines the FPS the video should be recorded at. */
  132697. fps: number;
  132698. /** Defines the chunk size for the recording data. */
  132699. recordChunckSize: number;
  132700. /** The audio tracks to attach to the recording. */
  132701. audioTracks?: MediaStreamTrack[];
  132702. }
  132703. /**
  132704. * This can help with recording videos from BabylonJS.
  132705. * This is based on the available WebRTC functionalities of the browser.
  132706. *
  132707. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_video
  132708. */
  132709. export class VideoRecorder {
  132710. private static readonly _defaultOptions;
  132711. /**
  132712. * Returns whether or not the VideoRecorder is available in your browser.
  132713. * @param engine Defines the Babylon Engine.
  132714. * @returns true if supported otherwise false.
  132715. */
  132716. static IsSupported(engine: Engine): boolean;
  132717. private readonly _options;
  132718. private _canvas;
  132719. private _mediaRecorder;
  132720. private _recordedChunks;
  132721. private _fileName;
  132722. private _resolve;
  132723. private _reject;
  132724. /**
  132725. * True when a recording is already in progress.
  132726. */
  132727. readonly isRecording: boolean;
  132728. /**
  132729. * Create a new VideoCapture object which can help converting what you see in Babylon to a video file.
  132730. * @param engine Defines the BabylonJS Engine you wish to record.
  132731. * @param options Defines options that can be used to customize the capture.
  132732. */
  132733. constructor(engine: Engine, options?: Nullable<VideoRecorderOptions>);
  132734. /**
  132735. * Stops the current recording before the default capture timeout passed in the startRecording function.
  132736. */
  132737. stopRecording(): void;
  132738. /**
  132739. * Starts recording the canvas for a max duration specified in parameters.
  132740. * @param fileName Defines the name of the file to be downloaded when the recording stop.
  132741. * If null no automatic download will start and you can rely on the promise to get the data back.
  132742. * @param maxDuration Defines the maximum recording time in seconds.
  132743. * It defaults to 7 seconds. A value of zero will not stop automatically, you would need to call stopRecording manually.
  132744. * @return A promise callback at the end of the recording with the video data in Blob.
  132745. */
  132746. startRecording(fileName?: Nullable<string>, maxDuration?: number): Promise<Blob>;
  132747. /**
  132748. * Releases internal resources used during the recording.
  132749. */
  132750. dispose(): void;
  132751. private _handleDataAvailable;
  132752. private _handleError;
  132753. private _handleStop;
  132754. }
  132755. }
  132756. declare module BABYLON {
  132757. /**
  132758. * Class containing a set of static utilities functions for screenshots
  132759. */
  132760. export class ScreenshotTools {
  132761. /**
  132762. * Captures a screenshot of the current rendering
  132763. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  132764. * @param engine defines the rendering engine
  132765. * @param camera defines the source camera
  132766. * @param size This parameter can be set to a single number or to an object with the
  132767. * following (optional) properties: precision, width, height. If a single number is passed,
  132768. * it will be used for both width and height. If an object is passed, the screenshot size
  132769. * will be derived from the parameters. The precision property is a multiplier allowing
  132770. * rendering at a higher or lower resolution
  132771. * @param successCallback defines the callback receives a single parameter which contains the
  132772. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  132773. * src parameter of an <img> to display it
  132774. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  132775. * Check your browser for supported MIME types
  132776. */
  132777. static CreateScreenshot(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string): void;
  132778. /**
  132779. * Captures a screenshot of the current rendering
  132780. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  132781. * @param engine defines the rendering engine
  132782. * @param camera defines the source camera
  132783. * @param size This parameter can be set to a single number or to an object with the
  132784. * following (optional) properties: precision, width, height. If a single number is passed,
  132785. * it will be used for both width and height. If an object is passed, the screenshot size
  132786. * will be derived from the parameters. The precision property is a multiplier allowing
  132787. * rendering at a higher or lower resolution
  132788. * @param mimeType defines the MIME type of the screenshot image (default: image/png).
  132789. * Check your browser for supported MIME types
  132790. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  132791. * to the src parameter of an <img> to display it
  132792. */
  132793. static CreateScreenshotAsync(engine: Engine, camera: Camera, size: any, mimeType?: string): Promise<string>;
  132794. /**
  132795. * Generates an image screenshot from the specified camera.
  132796. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  132797. * @param engine The engine to use for rendering
  132798. * @param camera The camera to use for rendering
  132799. * @param size This parameter can be set to a single number or to an object with the
  132800. * following (optional) properties: precision, width, height. If a single number is passed,
  132801. * it will be used for both width and height. If an object is passed, the screenshot size
  132802. * will be derived from the parameters. The precision property is a multiplier allowing
  132803. * rendering at a higher or lower resolution
  132804. * @param successCallback The callback receives a single parameter which contains the
  132805. * screenshot as a string of base64-encoded characters. This string can be assigned to the
  132806. * src parameter of an <img> to display it
  132807. * @param mimeType The MIME type of the screenshot image (default: image/png).
  132808. * Check your browser for supported MIME types
  132809. * @param samples Texture samples (default: 1)
  132810. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  132811. * @param fileName A name for for the downloaded file.
  132812. */
  132813. static CreateScreenshotUsingRenderTarget(engine: Engine, camera: Camera, size: IScreenshotSize | number, successCallback?: (data: string) => void, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): void;
  132814. /**
  132815. * Generates an image screenshot from the specified camera.
  132816. * @see http://doc.babylonjs.com/how_to/render_scene_on_a_png
  132817. * @param engine The engine to use for rendering
  132818. * @param camera The camera to use for rendering
  132819. * @param size This parameter can be set to a single number or to an object with the
  132820. * following (optional) properties: precision, width, height. If a single number is passed,
  132821. * it will be used for both width and height. If an object is passed, the screenshot size
  132822. * will be derived from the parameters. The precision property is a multiplier allowing
  132823. * rendering at a higher or lower resolution
  132824. * @param mimeType The MIME type of the screenshot image (default: image/png).
  132825. * Check your browser for supported MIME types
  132826. * @param samples Texture samples (default: 1)
  132827. * @param antialiasing Whether antialiasing should be turned on or not (default: false)
  132828. * @param fileName A name for for the downloaded file.
  132829. * @returns screenshot as a string of base64-encoded characters. This string can be assigned
  132830. * to the src parameter of an <img> to display it
  132831. */
  132832. static CreateScreenshotUsingRenderTargetAsync(engine: Engine, camera: Camera, size: any, mimeType?: string, samples?: number, antialiasing?: boolean, fileName?: string): Promise<string>;
  132833. /**
  132834. * Gets height and width for screenshot size
  132835. * @private
  132836. */
  132837. private static _getScreenshotSize;
  132838. }
  132839. }
  132840. declare module BABYLON {
  132841. /**
  132842. * Interface for a data buffer
  132843. */
  132844. export interface IDataBuffer {
  132845. /**
  132846. * Reads bytes from the data buffer.
  132847. * @param byteOffset The byte offset to read
  132848. * @param byteLength The byte length to read
  132849. * @returns A promise that resolves when the bytes are read
  132850. */
  132851. readAsync(byteOffset: number, byteLength: number): Promise<ArrayBufferView>;
  132852. /**
  132853. * The byte length of the buffer.
  132854. */
  132855. readonly byteLength: number;
  132856. }
  132857. /**
  132858. * Utility class for reading from a data buffer
  132859. */
  132860. export class DataReader {
  132861. /**
  132862. * The data buffer associated with this data reader.
  132863. */
  132864. readonly buffer: IDataBuffer;
  132865. /**
  132866. * The current byte offset from the beginning of the data buffer.
  132867. */
  132868. byteOffset: number;
  132869. private _dataView;
  132870. private _dataByteOffset;
  132871. /**
  132872. * Constructor
  132873. * @param buffer The buffer to read
  132874. */
  132875. constructor(buffer: IDataBuffer);
  132876. /**
  132877. * Loads the given byte length.
  132878. * @param byteLength The byte length to load
  132879. * @returns A promise that resolves when the load is complete
  132880. */
  132881. loadAsync(byteLength: number): Promise<void>;
  132882. /**
  132883. * Read a unsigned 32-bit integer from the currently loaded data range.
  132884. * @returns The 32-bit integer read
  132885. */
  132886. readUint32(): number;
  132887. /**
  132888. * Read a byte array from the currently loaded data range.
  132889. * @param byteLength The byte length to read
  132890. * @returns The byte array read
  132891. */
  132892. readUint8Array(byteLength: number): Uint8Array;
  132893. /**
  132894. * Read a string from the currently loaded data range.
  132895. * @param byteLength The byte length to read
  132896. * @returns The string read
  132897. */
  132898. readString(byteLength: number): string;
  132899. /**
  132900. * Skips the given byte length the currently loaded data range.
  132901. * @param byteLength The byte length to skip
  132902. */
  132903. skipBytes(byteLength: number): void;
  132904. }
  132905. }
  132906. declare module BABYLON {
  132907. /**
  132908. * A cursor which tracks a point on a path
  132909. */
  132910. export class PathCursor {
  132911. private path;
  132912. /**
  132913. * Stores path cursor callbacks for when an onchange event is triggered
  132914. */
  132915. private _onchange;
  132916. /**
  132917. * The value of the path cursor
  132918. */
  132919. value: number;
  132920. /**
  132921. * The animation array of the path cursor
  132922. */
  132923. animations: Animation[];
  132924. /**
  132925. * Initializes the path cursor
  132926. * @param path The path to track
  132927. */
  132928. constructor(path: Path2);
  132929. /**
  132930. * Gets the cursor point on the path
  132931. * @returns A point on the path cursor at the cursor location
  132932. */
  132933. getPoint(): Vector3;
  132934. /**
  132935. * Moves the cursor ahead by the step amount
  132936. * @param step The amount to move the cursor forward
  132937. * @returns This path cursor
  132938. */
  132939. moveAhead(step?: number): PathCursor;
  132940. /**
  132941. * Moves the cursor behind by the step amount
  132942. * @param step The amount to move the cursor back
  132943. * @returns This path cursor
  132944. */
  132945. moveBack(step?: number): PathCursor;
  132946. /**
  132947. * Moves the cursor by the step amount
  132948. * If the step amount is greater than one, an exception is thrown
  132949. * @param step The amount to move the cursor
  132950. * @returns This path cursor
  132951. */
  132952. move(step: number): PathCursor;
  132953. /**
  132954. * Ensures that the value is limited between zero and one
  132955. * @returns This path cursor
  132956. */
  132957. private ensureLimits;
  132958. /**
  132959. * Runs onchange callbacks on change (used by the animation engine)
  132960. * @returns This path cursor
  132961. */
  132962. private raiseOnChange;
  132963. /**
  132964. * Executes a function on change
  132965. * @param f A path cursor onchange callback
  132966. * @returns This path cursor
  132967. */
  132968. onchange(f: (cursor: PathCursor) => void): PathCursor;
  132969. }
  132970. }
  132971. declare module BABYLON {
  132972. /** @hidden */
  132973. export var blurPixelShader: {
  132974. name: string;
  132975. shader: string;
  132976. };
  132977. }
  132978. declare module BABYLON {
  132979. /** @hidden */
  132980. export var pointCloudVertexDeclaration: {
  132981. name: string;
  132982. shader: string;
  132983. };
  132984. }
  132985. // Mixins
  132986. interface Window {
  132987. mozIndexedDB: IDBFactory;
  132988. webkitIndexedDB: IDBFactory;
  132989. msIndexedDB: IDBFactory;
  132990. webkitURL: typeof URL;
  132991. mozRequestAnimationFrame(callback: FrameRequestCallback): number;
  132992. oRequestAnimationFrame(callback: FrameRequestCallback): number;
  132993. WebGLRenderingContext: WebGLRenderingContext;
  132994. MSGesture: MSGesture;
  132995. CANNON: any;
  132996. AudioContext: AudioContext;
  132997. webkitAudioContext: AudioContext;
  132998. PointerEvent: any;
  132999. Math: Math;
  133000. Uint8Array: Uint8ArrayConstructor;
  133001. Float32Array: Float32ArrayConstructor;
  133002. mozURL: typeof URL;
  133003. msURL: typeof URL;
  133004. VRFrameData: any; // WebVR, from specs 1.1
  133005. DracoDecoderModule: any;
  133006. setImmediate(handler: (...args: any[]) => void): number;
  133007. }
  133008. interface HTMLCanvasElement {
  133009. requestPointerLock(): void;
  133010. msRequestPointerLock?(): void;
  133011. mozRequestPointerLock?(): void;
  133012. webkitRequestPointerLock?(): void;
  133013. /** Track wether a record is in progress */
  133014. isRecording: boolean;
  133015. /** Capture Stream method defined by some browsers */
  133016. captureStream(fps?: number): MediaStream;
  133017. }
  133018. interface CanvasRenderingContext2D {
  133019. msImageSmoothingEnabled: boolean;
  133020. }
  133021. interface MouseEvent {
  133022. mozMovementX: number;
  133023. mozMovementY: number;
  133024. webkitMovementX: number;
  133025. webkitMovementY: number;
  133026. msMovementX: number;
  133027. msMovementY: number;
  133028. }
  133029. interface Navigator {
  133030. mozGetVRDevices: (any: any) => any;
  133031. webkitGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  133032. mozGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  133033. msGetUserMedia(constraints: MediaStreamConstraints, successCallback: NavigatorUserMediaSuccessCallback, errorCallback: NavigatorUserMediaErrorCallback): void;
  133034. webkitGetGamepads(): Gamepad[];
  133035. msGetGamepads(): Gamepad[];
  133036. webkitGamepads(): Gamepad[];
  133037. }
  133038. interface HTMLVideoElement {
  133039. mozSrcObject: any;
  133040. }
  133041. interface Math {
  133042. fround(x: number): number;
  133043. imul(a: number, b: number): number;
  133044. }
  133045. interface WebGLRenderingContext {
  133046. drawArraysInstanced(mode: number, first: number, count: number, primcount: number): void;
  133047. drawElementsInstanced(mode: number, count: number, type: number, offset: number, primcount: number): void;
  133048. vertexAttribDivisor(index: number, divisor: number): void;
  133049. createVertexArray(): any;
  133050. bindVertexArray(vao?: WebGLVertexArrayObject | null): void;
  133051. deleteVertexArray(vao: WebGLVertexArrayObject): void;
  133052. blitFramebuffer(srcX0: number, srcY0: number, srcX1: number, srcY1: number, dstX0: number, dstY0: number, dstX1: number, dstY1: number, mask: number, filter: number): void;
  133053. renderbufferStorageMultisample(target: number, samples: number, internalformat: number, width: number, height: number): void;
  133054. bindBufferBase(target: number, index: number, buffer: WebGLBuffer | null): void;
  133055. getUniformBlockIndex(program: WebGLProgram, uniformBlockName: string): number;
  133056. uniformBlockBinding(program: WebGLProgram, uniformBlockIndex: number, uniformBlockBinding: number): void;
  133057. // Queries
  133058. createQuery(): WebGLQuery;
  133059. deleteQuery(query: WebGLQuery): void;
  133060. beginQuery(target: number, query: WebGLQuery): void;
  133061. endQuery(target: number): void;
  133062. getQueryParameter(query: WebGLQuery, pname: number): any;
  133063. getQuery(target: number, pname: number): any;
  133064. MAX_SAMPLES: number;
  133065. RGBA8: number;
  133066. READ_FRAMEBUFFER: number;
  133067. DRAW_FRAMEBUFFER: number;
  133068. UNIFORM_BUFFER: number;
  133069. HALF_FLOAT_OES: number;
  133070. RGBA16F: number;
  133071. RGBA32F: number;
  133072. R32F: number;
  133073. RG32F: number;
  133074. RGB32F: number;
  133075. R16F: number;
  133076. RG16F: number;
  133077. RGB16F: number;
  133078. RED: number;
  133079. RG: number;
  133080. R8: number;
  133081. RG8: number;
  133082. UNSIGNED_INT_24_8: number;
  133083. DEPTH24_STENCIL8: number;
  133084. MIN: number;
  133085. MAX: number;
  133086. /* Multiple Render Targets */
  133087. drawBuffers(buffers: number[]): void;
  133088. readBuffer(src: number): void;
  133089. readonly COLOR_ATTACHMENT0: number; // 0x8CE1
  133090. readonly COLOR_ATTACHMENT1: number; // 0x8CE2
  133091. readonly COLOR_ATTACHMENT2: number; // 0x8CE3
  133092. readonly COLOR_ATTACHMENT3: number; // 0x8CE4
  133093. // Occlusion Query
  133094. ANY_SAMPLES_PASSED_CONSERVATIVE: number;
  133095. ANY_SAMPLES_PASSED: number;
  133096. QUERY_RESULT_AVAILABLE: number;
  133097. QUERY_RESULT: number;
  133098. }
  133099. interface WebGLProgram {
  133100. __SPECTOR_rebuildProgram?: ((vertexSourceCode: string, fragmentSourceCode: string, onCompiled: (program: WebGLProgram) => void, onError: (message: string) => void) => void) | null;
  133101. }
  133102. interface EXT_disjoint_timer_query {
  133103. QUERY_COUNTER_BITS_EXT: number;
  133104. TIME_ELAPSED_EXT: number;
  133105. TIMESTAMP_EXT: number;
  133106. GPU_DISJOINT_EXT: number;
  133107. QUERY_RESULT_EXT: number;
  133108. QUERY_RESULT_AVAILABLE_EXT: number;
  133109. queryCounterEXT(query: WebGLQuery, target: number): void;
  133110. createQueryEXT(): WebGLQuery;
  133111. beginQueryEXT(target: number, query: WebGLQuery): void;
  133112. endQueryEXT(target: number): void;
  133113. getQueryObjectEXT(query: WebGLQuery, target: number): any;
  133114. deleteQueryEXT(query: WebGLQuery): void;
  133115. }
  133116. interface WebGLUniformLocation {
  133117. _currentState: any;
  133118. }
  133119. // Type definitions for WebGL 2, Editor's Draft Fri Feb 24 16:10:18 2017 -0800
  133120. // Project: https://www.khronos.org/registry/webgl/specs/latest/2.0/
  133121. // Definitions by: Nico Kemnitz <https://github.com/nkemnitz/>
  133122. // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
  133123. interface WebGLRenderingContext {
  133124. readonly RASTERIZER_DISCARD: number;
  133125. readonly DEPTH_COMPONENT24: number;
  133126. readonly TEXTURE_3D: number;
  133127. readonly TEXTURE_2D_ARRAY: number;
  133128. readonly TEXTURE_COMPARE_FUNC: number;
  133129. readonly TEXTURE_COMPARE_MODE: number;
  133130. readonly COMPARE_REF_TO_TEXTURE: number;
  133131. readonly TEXTURE_WRAP_R: number;
  133132. readonly HALF_FLOAT: number;
  133133. readonly RGB8: number;
  133134. readonly RED_INTEGER: number;
  133135. readonly RG_INTEGER: number;
  133136. readonly RGB_INTEGER: number;
  133137. readonly RGBA_INTEGER: number;
  133138. readonly R8_SNORM: number;
  133139. readonly RG8_SNORM: number;
  133140. readonly RGB8_SNORM: number;
  133141. readonly RGBA8_SNORM: number;
  133142. readonly R8I: number;
  133143. readonly RG8I: number;
  133144. readonly RGB8I: number;
  133145. readonly RGBA8I: number;
  133146. readonly R8UI: number;
  133147. readonly RG8UI: number;
  133148. readonly RGB8UI: number;
  133149. readonly RGBA8UI: number;
  133150. readonly R16I: number;
  133151. readonly RG16I: number;
  133152. readonly RGB16I: number;
  133153. readonly RGBA16I: number;
  133154. readonly R16UI: number;
  133155. readonly RG16UI: number;
  133156. readonly RGB16UI: number;
  133157. readonly RGBA16UI: number;
  133158. readonly R32I: number;
  133159. readonly RG32I: number;
  133160. readonly RGB32I: number;
  133161. readonly RGBA32I: number;
  133162. readonly R32UI: number;
  133163. readonly RG32UI: number;
  133164. readonly RGB32UI: number;
  133165. readonly RGBA32UI: number;
  133166. readonly RGB10_A2UI: number;
  133167. readonly R11F_G11F_B10F: number;
  133168. readonly RGB9_E5: number;
  133169. readonly RGB10_A2: number;
  133170. readonly UNSIGNED_INT_2_10_10_10_REV: number;
  133171. readonly UNSIGNED_INT_10F_11F_11F_REV: number;
  133172. readonly UNSIGNED_INT_5_9_9_9_REV: number;
  133173. readonly FLOAT_32_UNSIGNED_INT_24_8_REV: number;
  133174. texImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, format: number, type: number, pixels: ArrayBufferView | null): void;
  133175. texImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, format: number, type: number, pixels: ArrayBufferView, offset: number): void;
  133176. 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;
  133177. compressedTexImage3D(target: number, level: number, internalformat: number, width: number, height: number, depth: number, border: number, data: ArrayBufferView, offset?: number, length?: number): void;
  133178. readonly TRANSFORM_FEEDBACK: number;
  133179. readonly INTERLEAVED_ATTRIBS: number;
  133180. readonly TRANSFORM_FEEDBACK_BUFFER: number;
  133181. createTransformFeedback(): WebGLTransformFeedback;
  133182. deleteTransformFeedback(transformFeedbac: WebGLTransformFeedback): void;
  133183. bindTransformFeedback(target: number, transformFeedback: WebGLTransformFeedback | null): void;
  133184. beginTransformFeedback(primitiveMode: number): void;
  133185. endTransformFeedback(): void;
  133186. transformFeedbackVaryings(program: WebGLProgram, varyings: string[], bufferMode: number): void;
  133187. clearBufferfv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  133188. clearBufferiv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  133189. clearBufferuiv(buffer: number, drawbuffer: number, values: ArrayBufferView, srcOffset: number | null): void;
  133190. clearBufferfi(buffer: number, drawbuffer: number, depth: number, stencil: number): void;
  133191. }
  133192. interface ImageBitmap {
  133193. readonly width: number;
  133194. readonly height: number;
  133195. close(): void;
  133196. }
  133197. interface WebGLQuery extends WebGLObject {
  133198. }
  133199. declare var WebGLQuery: {
  133200. prototype: WebGLQuery;
  133201. new(): WebGLQuery;
  133202. };
  133203. interface WebGLSampler extends WebGLObject {
  133204. }
  133205. declare var WebGLSampler: {
  133206. prototype: WebGLSampler;
  133207. new(): WebGLSampler;
  133208. };
  133209. interface WebGLSync extends WebGLObject {
  133210. }
  133211. declare var WebGLSync: {
  133212. prototype: WebGLSync;
  133213. new(): WebGLSync;
  133214. };
  133215. interface WebGLTransformFeedback extends WebGLObject {
  133216. }
  133217. declare var WebGLTransformFeedback: {
  133218. prototype: WebGLTransformFeedback;
  133219. new(): WebGLTransformFeedback;
  133220. };
  133221. interface WebGLVertexArrayObject extends WebGLObject {
  133222. }
  133223. declare var WebGLVertexArrayObject: {
  133224. prototype: WebGLVertexArrayObject;
  133225. new(): WebGLVertexArrayObject;
  133226. };
  133227. // Type definitions for WebVR API
  133228. // Project: https://w3c.github.io/webvr/
  133229. // Definitions by: six a <https://github.com/lostfictions>
  133230. // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
  133231. interface VRDisplay extends EventTarget {
  133232. /**
  133233. * Dictionary of capabilities describing the VRDisplay.
  133234. */
  133235. readonly capabilities: VRDisplayCapabilities;
  133236. /**
  133237. * z-depth defining the far plane of the eye view frustum
  133238. * enables mapping of values in the render target depth
  133239. * attachment to scene coordinates. Initially set to 10000.0.
  133240. */
  133241. depthFar: number;
  133242. /**
  133243. * z-depth defining the near plane of the eye view frustum
  133244. * enables mapping of values in the render target depth
  133245. * attachment to scene coordinates. Initially set to 0.01.
  133246. */
  133247. depthNear: number;
  133248. /**
  133249. * An identifier for this distinct VRDisplay. Used as an
  133250. * association point in the Gamepad API.
  133251. */
  133252. readonly displayId: number;
  133253. /**
  133254. * A display name, a user-readable name identifying it.
  133255. */
  133256. readonly displayName: string;
  133257. readonly isConnected: boolean;
  133258. readonly isPresenting: boolean;
  133259. /**
  133260. * If this VRDisplay supports room-scale experiences, the optional
  133261. * stage attribute contains details on the room-scale parameters.
  133262. */
  133263. readonly stageParameters: VRStageParameters | null;
  133264. /**
  133265. * Passing the value returned by `requestAnimationFrame` to
  133266. * `cancelAnimationFrame` will unregister the callback.
  133267. * @param handle Define the hanle of the request to cancel
  133268. */
  133269. cancelAnimationFrame(handle: number): void;
  133270. /**
  133271. * Stops presenting to the VRDisplay.
  133272. * @returns a promise to know when it stopped
  133273. */
  133274. exitPresent(): Promise<void>;
  133275. /**
  133276. * Return the current VREyeParameters for the given eye.
  133277. * @param whichEye Define the eye we want the parameter for
  133278. * @returns the eye parameters
  133279. */
  133280. getEyeParameters(whichEye: string): VREyeParameters;
  133281. /**
  133282. * Populates the passed VRFrameData with the information required to render
  133283. * the current frame.
  133284. * @param frameData Define the data structure to populate
  133285. * @returns true if ok otherwise false
  133286. */
  133287. getFrameData(frameData: VRFrameData): boolean;
  133288. /**
  133289. * Get the layers currently being presented.
  133290. * @returns the list of VR layers
  133291. */
  133292. getLayers(): VRLayer[];
  133293. /**
  133294. * Return a VRPose containing the future predicted pose of the VRDisplay
  133295. * when the current frame will be presented. The value returned will not
  133296. * change until JavaScript has returned control to the browser.
  133297. *
  133298. * The VRPose will contain the position, orientation, velocity,
  133299. * and acceleration of each of these properties.
  133300. * @returns the pose object
  133301. */
  133302. getPose(): VRPose;
  133303. /**
  133304. * Return the current instantaneous pose of the VRDisplay, with no
  133305. * prediction applied.
  133306. * @returns the current instantaneous pose
  133307. */
  133308. getImmediatePose(): VRPose;
  133309. /**
  133310. * The callback passed to `requestAnimationFrame` will be called
  133311. * any time a new frame should be rendered. When the VRDisplay is
  133312. * presenting the callback will be called at the native refresh
  133313. * rate of the HMD. When not presenting this function acts
  133314. * identically to how window.requestAnimationFrame acts. Content should
  133315. * make no assumptions of frame rate or vsync behavior as the HMD runs
  133316. * asynchronously from other displays and at differing refresh rates.
  133317. * @param callback Define the eaction to run next frame
  133318. * @returns the request handle it
  133319. */
  133320. requestAnimationFrame(callback: FrameRequestCallback): number;
  133321. /**
  133322. * Begin presenting to the VRDisplay. Must be called in response to a user gesture.
  133323. * Repeat calls while already presenting will update the VRLayers being displayed.
  133324. * @param layers Define the list of layer to present
  133325. * @returns a promise to know when the request has been fulfilled
  133326. */
  133327. requestPresent(layers: VRLayer[]): Promise<void>;
  133328. /**
  133329. * Reset the pose for this display, treating its current position and
  133330. * orientation as the "origin/zero" values. VRPose.position,
  133331. * VRPose.orientation, and VRStageParameters.sittingToStandingTransform may be
  133332. * updated when calling resetPose(). This should be called in only
  133333. * sitting-space experiences.
  133334. */
  133335. resetPose(): void;
  133336. /**
  133337. * The VRLayer provided to the VRDisplay will be captured and presented
  133338. * in the HMD. Calling this function has the same effect on the source
  133339. * canvas as any other operation that uses its source image, and canvases
  133340. * created without preserveDrawingBuffer set to true will be cleared.
  133341. * @param pose Define the pose to submit
  133342. */
  133343. submitFrame(pose?: VRPose): void;
  133344. }
  133345. declare var VRDisplay: {
  133346. prototype: VRDisplay;
  133347. new(): VRDisplay;
  133348. };
  133349. interface VRLayer {
  133350. leftBounds?: number[] | Float32Array | null;
  133351. rightBounds?: number[] | Float32Array | null;
  133352. source?: HTMLCanvasElement | null;
  133353. }
  133354. interface VRDisplayCapabilities {
  133355. readonly canPresent: boolean;
  133356. readonly hasExternalDisplay: boolean;
  133357. readonly hasOrientation: boolean;
  133358. readonly hasPosition: boolean;
  133359. readonly maxLayers: number;
  133360. }
  133361. interface VREyeParameters {
  133362. /** @deprecated */
  133363. readonly fieldOfView: VRFieldOfView;
  133364. readonly offset: Float32Array;
  133365. readonly renderHeight: number;
  133366. readonly renderWidth: number;
  133367. }
  133368. interface VRFieldOfView {
  133369. readonly downDegrees: number;
  133370. readonly leftDegrees: number;
  133371. readonly rightDegrees: number;
  133372. readonly upDegrees: number;
  133373. }
  133374. interface VRFrameData {
  133375. readonly leftProjectionMatrix: Float32Array;
  133376. readonly leftViewMatrix: Float32Array;
  133377. readonly pose: VRPose;
  133378. readonly rightProjectionMatrix: Float32Array;
  133379. readonly rightViewMatrix: Float32Array;
  133380. readonly timestamp: number;
  133381. }
  133382. interface VRPose {
  133383. readonly angularAcceleration: Float32Array | null;
  133384. readonly angularVelocity: Float32Array | null;
  133385. readonly linearAcceleration: Float32Array | null;
  133386. readonly linearVelocity: Float32Array | null;
  133387. readonly orientation: Float32Array | null;
  133388. readonly position: Float32Array | null;
  133389. readonly timestamp: number;
  133390. }
  133391. interface VRStageParameters {
  133392. sittingToStandingTransform?: Float32Array;
  133393. sizeX?: number;
  133394. sizeY?: number;
  133395. }
  133396. interface Navigator {
  133397. getVRDisplays(): Promise<VRDisplay[]>;
  133398. readonly activeVRDisplays: ReadonlyArray<VRDisplay>;
  133399. }
  133400. interface Window {
  133401. onvrdisplayconnected: ((this: Window, ev: Event) => any) | null;
  133402. onvrdisplaydisconnected: ((this: Window, ev: Event) => any) | null;
  133403. onvrdisplaypresentchange: ((this: Window, ev: Event) => any) | null;
  133404. addEventListener(type: "vrdisplayconnected", listener: (ev: Event) => any, useCapture?: boolean): void;
  133405. addEventListener(type: "vrdisplaydisconnected", listener: (ev: Event) => any, useCapture?: boolean): void;
  133406. addEventListener(type: "vrdisplaypresentchange", listener: (ev: Event) => any, useCapture?: boolean): void;
  133407. }
  133408. interface Gamepad {
  133409. readonly displayId: number;
  133410. }
  133411. type XRSessionMode =
  133412. | "inline"
  133413. | "immersive-vr"
  133414. | "immersive-ar";
  133415. type XRReferenceSpaceType =
  133416. | "viewer"
  133417. | "local"
  133418. | "local-floor"
  133419. | "bounded-floor"
  133420. | "unbounded";
  133421. type XREnvironmentBlendMode =
  133422. | "opaque"
  133423. | "additive"
  133424. | "alpha-blend";
  133425. type XRVisibilityState =
  133426. | "visible"
  133427. | "visible-blurred"
  133428. | "hidden";
  133429. type XRHandedness =
  133430. | "none"
  133431. | "left"
  133432. | "right";
  133433. type XRTargetRayMode =
  133434. | "gaze"
  133435. | "tracked-pointer"
  133436. | "screen";
  133437. type XREye =
  133438. | "none"
  133439. | "left"
  133440. | "right";
  133441. interface XRSpace extends EventTarget {
  133442. }
  133443. interface XRRenderState {
  133444. depthNear?: number;
  133445. depthFar?: number;
  133446. inlineVerticalFieldOfView?: number;
  133447. baseLayer?: XRWebGLLayer;
  133448. }
  133449. interface XRInputSource {
  133450. handedness: XRHandedness;
  133451. targetRayMode: XRTargetRayMode;
  133452. targetRaySpace: XRSpace;
  133453. gripSpace: XRSpace | undefined;
  133454. gamepad: Gamepad | undefined;
  133455. profiles: Array<string>;
  133456. }
  133457. interface XRSession {
  133458. addEventListener: Function;
  133459. requestReferenceSpace(type: XRReferenceSpaceType): Promise<XRReferenceSpace>;
  133460. updateRenderState(XRRenderStateInit: XRRenderState): Promise<void>;
  133461. requestAnimationFrame: Function;
  133462. end(): Promise<void>;
  133463. renderState: XRRenderState;
  133464. inputSources: Array<XRInputSource>;
  133465. }
  133466. interface XRReferenceSpace extends XRSpace {
  133467. getOffsetReferenceSpace(originOffset: XRRigidTransform): XRReferenceSpace;
  133468. onreset: any;
  133469. }
  133470. interface XRFrame {
  133471. session: XRSession;
  133472. getViewerPose(referenceSpace: XRReferenceSpace): XRViewerPose | undefined;
  133473. getPose(space: XRSpace, baseSpace: XRSpace): XRPose | undefined;
  133474. }
  133475. interface XRViewerPose extends XRPose {
  133476. views: Array<XRView>;
  133477. }
  133478. interface XRPose {
  133479. transform: XRRigidTransform;
  133480. emulatedPosition: boolean;
  133481. }
  133482. interface XRWebGLLayerOptions {
  133483. antialias ?: boolean;
  133484. depth ?: boolean;
  133485. stencil ?: boolean;
  133486. alpha ?: boolean;
  133487. multiview ?: boolean;
  133488. framebufferScaleFactor ?: number;
  133489. }
  133490. declare var XRWebGLLayer: {
  133491. prototype: XRWebGLLayer;
  133492. new(session: XRSession, context: WebGLRenderingContext | undefined, options?: XRWebGLLayerOptions): XRWebGLLayer;
  133493. };
  133494. interface XRWebGLLayer {
  133495. framebuffer: WebGLFramebuffer;
  133496. framebufferWidth: number;
  133497. framebufferHeight: number;
  133498. getViewport: Function;
  133499. }
  133500. interface XRRigidTransform {
  133501. position: DOMPointReadOnly;
  133502. orientation: DOMPointReadOnly;
  133503. matrix: Float32Array;
  133504. inverse: XRRigidTransform;
  133505. }
  133506. interface XRView {
  133507. eye: XREye;
  133508. projectionMatrix: Float32Array;
  133509. transform: XRRigidTransform;
  133510. }
  133511. interface XRInputSourceChangeEvent {
  133512. session: XRSession;
  133513. removed: Array<XRInputSource>;
  133514. added: Array<XRInputSource>;
  133515. }